refactor: extension dispatcher

feloy · feloy · commit 1b31990eb5a5 · 2025-07-02T15:26:10.000+02:00
Signed-off-by: Philippe Martin &lt;phmartin@redhat.com&gt;
diff --git a/packages/extension/src/dispatcher/_dispatcher-module.ts b/packages/extension/src/dispatcher/_dispatcher-module.ts
@@ -0,0 +1,32 @@
+/**********************************************************************
+ * Copyright (C) 2025 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ***********************************************************************/
+
+import { ContainerModule } from 'inversify';
+import { ActiveResourcesCountDispatcher } from './active-resources-count-dispatcher';
+import { ContextsHealthsDispatcher } from './contexts-healths-dispatcher';
+import { ContextsPermissionsDispatcher } from './contexts-permissions-dispatcher';
+import { ResourcesCountDispatcher } from './resources-count-dispatcher';
+
+const dispatchersModule = new ContainerModule(options => {
+  options.bind<ActiveResourcesCountDispatcher>(ActiveResourcesCountDispatcher).toSelf().inSingletonScope();
+  options.bind<ContextsHealthsDispatcher>(ContextsHealthsDispatcher).toSelf().inSingletonScope();
+  options.bind<ContextsPermissionsDispatcher>(ContextsPermissionsDispatcher).toSelf().inSingletonScope();
+  options.bind<ResourcesCountDispatcher>(ResourcesCountDispatcher).toSelf().inSingletonScope();
+});
+
+export { dispatchersModule };
diff --git a/packages/extension/src/dispatcher/active-resources-count-dispatcher.ts b/packages/extension/src/dispatcher/active-resources-count-dispatcher.ts
@@ -0,0 +1,44 @@
+/**********************************************************************
+ * Copyright (C) 2025 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ***********************************************************************/
+
+import { inject, injectable } from 'inversify';
+import type { DispatcherObject } from './util/dispatcher-object';
+import { AbsDispatcherObjectImpl } from './util/dispatcher-object';
+import { ContextsManager } from '../manager/contexts-manager';
+import { ACTIVE_RESOURCES_COUNT } from '/@common/channels';
+import { RpcExtension } from '/@common/rpc/rpc';
+import { ActiveResourcesCountInfo } from '/@common/model/active-resources-count-info';
+
+@injectable()
+export class ActiveResourcesCountDispatcher
+  extends AbsDispatcherObjectImpl<void, ActiveResourcesCountInfo>
+  implements DispatcherObject<void>
+{
+  @inject(ContextsManager)
+  private manager: ContextsManager;
+
+  constructor(@inject(RpcExtension) rpcExtension: RpcExtension) {
+    super(rpcExtension, ACTIVE_RESOURCES_COUNT);
+  }
+
+  getData(): ActiveResourcesCountInfo {
+    return {
+      counts: this.manager.getActiveResourcesCount(),
+    };
+  }
+}
diff --git a/packages/extension/src/dispatcher/contexts-healths-dispatcher.spec.ts b/packages/extension/src/dispatcher/contexts-healths-dispatcher.spec.ts
@@ -0,0 +1,67 @@
+/**********************************************************************
+ * Copyright (C) 2025 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ***********************************************************************/
+
+import { beforeAll, expect, test, vi } from 'vitest';
+import type { ContextHealthState } from '../manager/context-health-checker';
+import type { KubeConfigSingleContext } from '../types/kubeconfig-single-context';
+import { ContextsHealthsDispatcher } from './contexts-healths-dispatcher';
+import { InversifyBinding } from '../inject/inversify-binding';
+import type { ExtensionContext, TelemetryLogger } from '@podman-desktop/api';
+import type { RpcExtension } from '/@common/rpc/rpc';
+import type { Container } from 'inversify';
+import { ContextsManager } from '../manager/contexts-manager';
+
+let container: Container;
+const contextsManagerMock = {
+  getHealthCheckersStates: vi.fn(),
+  isContextOffline: vi.fn(),
+} as unknown as ContextsManager;
+
+beforeAll(async () => {
+  const inversifyBinding = new InversifyBinding({} as RpcExtension, {} as ExtensionContext, {} as TelemetryLogger);
+  container = await inversifyBinding.initBindings();
+  (await container.rebind(ContextsManager)).toConstantValue(contextsManagerMock);
+});
+
+test('getData should return the values of the map returned by manager.getHealthCheckersStates without kubeConfig', () => {
+  const dispatcher = container.get<ContextsHealthsDispatcher>(ContextsHealthsDispatcher);
+  const context1State = {
+    contextName: 'context1',
+    checking: true,
+    reachable: false,
+  };
+  const context2State = {
+    contextName: 'context2',
+    checking: false,
+    reachable: true,
+  };
+  const context3State = {
+    contextName: 'context3',
+    checking: false,
+    reachable: false,
+    errorMessage: 'an error',
+  };
+  const value = new Map<string, ContextHealthState>([
+    ['context1', { ...context1State, kubeConfig: {} as unknown as KubeConfigSingleContext }],
+    ['context2', { ...context2State, kubeConfig: {} as unknown as KubeConfigSingleContext }],
+    ['context3', { ...context3State, kubeConfig: {} as unknown as KubeConfigSingleContext }],
+  ]);
+  vi.mocked(contextsManagerMock.getHealthCheckersStates).mockReturnValue(value);
+  const result = dispatcher.getData();
+  expect(result).toEqual({ healths: [context1State, context2State, context3State] });
+});
diff --git a/packages/extension/src/dispatcher/contexts-healths-dispatcher.ts b/packages/extension/src/dispatcher/contexts-healths-dispatcher.ts
@@ -0,0 +1,55 @@
+/**********************************************************************
+ * Copyright (C) 2025 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ***********************************************************************/
+
+import { inject, injectable } from 'inversify';
+import type { DispatcherObject } from './util/dispatcher-object';
+import { AbsDispatcherObjectImpl } from './util/dispatcher-object';
+import { ContextsManager } from '../manager/contexts-manager';
+import { CONTEXTS_HEALTHS } from '/@common/channels';
+import { ContextHealth } from '/@common/model/kubernetes-contexts-healths';
+import { RpcExtension } from '/@common/rpc/rpc';
+import { ContextsHealthsInfo } from '/@common/model/contexts-healths-info';
+
+@injectable()
+export class ContextsHealthsDispatcher
+  extends AbsDispatcherObjectImpl<void, ContextsHealthsInfo>
+  implements DispatcherObject<void>
+{
+  @inject(ContextsManager)
+  private manager: ContextsManager;
+
+  constructor(@inject(RpcExtension) rpcExtension: RpcExtension) {
+    super(rpcExtension, CONTEXTS_HEALTHS);
+  }
+
+  getData(): ContextsHealthsInfo {
+    const value: ContextHealth[] = [];
+    for (const [contextName, health] of this.manager.getHealthCheckersStates()) {
+      value.push({
+        contextName,
+        checking: health.checking,
+        reachable: health.reachable,
+        offline: this.manager.isContextOffline(contextName),
+        errorMessage: health.errorMessage,
+      });
+    }
+    return {
+      healths: value,
+    };
+  }
+}
diff --git a/packages/extension/src/dispatcher/contexts-permissions-dispatcher.ts b/packages/extension/src/dispatcher/contexts-permissions-dispatcher.ts
@@ -0,0 +1,44 @@
+/**********************************************************************
+ * Copyright (C) 2025 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ***********************************************************************/
+
+import { inject, injectable } from 'inversify';
+import type { DispatcherObject } from './util/dispatcher-object';
+import { AbsDispatcherObjectImpl } from './util/dispatcher-object';
+import { ContextsManager } from '../manager/contexts-manager';
+import { CONTEXTS_PERMISSIONS } from '/@common/channels';
+import { RpcExtension } from '/@common/rpc/rpc';
+import { ContextsPermissionsInfo } from '/@common/model/contexts-permissions-info';
+
+@injectable()
+export class ContextsPermissionsDispatcher
+  extends AbsDispatcherObjectImpl<void, ContextsPermissionsInfo>
+  implements DispatcherObject<void>
+{
+  @inject(ContextsManager)
+  private manager: ContextsManager;
+
+  constructor(@inject(RpcExtension) rpcExtension: RpcExtension) {
+    super(rpcExtension, CONTEXTS_PERMISSIONS);
+  }
+
+  getData(): ContextsPermissionsInfo {
+    return {
+      permissions: this.manager.getPermissions(),
+    };
+  }
+}
diff --git a/packages/extension/src/dispatcher/resources-count-dispatcher.ts b/packages/extension/src/dispatcher/resources-count-dispatcher.ts
@@ -0,0 +1,44 @@
+/**********************************************************************
+ * Copyright (C) 2025 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ***********************************************************************/
+
+import { inject, injectable } from 'inversify';
+import type { DispatcherObject } from './util/dispatcher-object';
+import { AbsDispatcherObjectImpl } from './util/dispatcher-object';
+import { ContextsManager } from '../manager/contexts-manager';
+import { RESOURCES_COUNT } from '/@common/channels';
+import { RpcExtension } from '/@common/rpc/rpc';
+import { ResourcesCountInfo } from '/@common/model/resources-count-info';
+
+@injectable()
+export class ResourcesCountDispatcher
+  extends AbsDispatcherObjectImpl<void, ResourcesCountInfo>
+  implements DispatcherObject<void>
+{
+  @inject(ContextsManager)
+  private manager: ContextsManager;
+
+  constructor(@inject(RpcExtension) rpcExtension: RpcExtension) {
+    super(rpcExtension, RESOURCES_COUNT);
+  }
+
+  getData(): ResourcesCountInfo {
+    return {
+      counts: this.manager.getResourcesCount(),
+    };
+  }
+}
diff --git a/packages/extension/src/dispatcher/util/dispatcher-object.ts b/packages/extension/src/dispatcher/util/dispatcher-object.ts
@@ -0,0 +1,42 @@
+/**********************************************************************
+ * Copyright (C) 2025 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ***********************************************************************/
+
+import type { RpcChannel } from '/@common/rpc';
+import type { RpcExtension } from '/@common/rpc/rpc';
+
+export interface DispatcherObject<T> {
+  dispatch(options: T): Promise<void>;
+}
+
+// Allow to receive event for a given object
+export abstract class AbsDispatcherObjectImpl<T, U> implements DispatcherObject<T> {
+  #channel: RpcChannel<U>;
+
+  constructor(
+    private rpcExtension: RpcExtension,
+    channel: RpcChannel<U>,
+  ) {
+    this.#channel = channel;
+  }
+
+  async dispatch(options?: T): Promise<void> {
+    await this.rpcExtension.fire(this.#channel, this.getData(options));
+  }
+
+  abstract getData(options?: T): U;
+}
diff --git a/packages/extension/src/inject/inversify-binding.ts b/packages/extension/src/inject/inversify-binding.ts
@@ -24,6 +24,7 @@ import { Container } from 'inversify';
 import { ExtensionContextSymbol, TelemetryLoggerSymbol } from '/@/inject/symbol';
 import { RpcExtension } from '/@common/rpc/rpc';
 import { managersModule } from '/@/manager/_manager-module';
+import { dispatchersModule } from '/@/dispatcher/_dispatcher-module';
 
 export class InversifyBinding {
   #container: Container | undefined;
@@ -52,6 +53,7 @@ export class InversifyBinding {
     this.#container.bind(TelemetryLoggerSymbol).toConstantValue(this.#telemetryLogger);
 
     await this.#container.load(managersModule);
+    await this.#container.load(dispatchersModule);
 
     return this.#container;
   }
diff --git a/packages/extension/src/manager/contexts-states-dispatcher.spec.ts b/packages/extension/src/manager/contexts-states-dispatcher.spec.ts
diff --git a/packages/extension/src/manager/contexts-states-dispatcher.ts b/packages/extension/src/manager/contexts-states-dispatcher.ts
