feat: ApiSubscriber (#444)

feloy · web-flow · commit df49d8357cd4 · 2025-11-06T15:33:58.000+01:00
Signed-off-by: Philippe Martin &lt;phmartin@redhat.com&gt;
diff --git a/packages/extension/src/dashboard-extension.ts b/packages/extension/src/dashboard-extension.ts
@@ -45,7 +45,7 @@ import { PodLogsApiImpl } from './manager/pod-logs-api-impl';
 import { PodTerminalsApiImpl } from './manager/pod-terminals-api-impl';
 import { NavigationApiImpl } from '/@/manager/navigation-api';
 import { KubernetesProvidersManager } from '/@/manager/kubernetes-providers';
-import { ChannelSubscriber } from '/@/types/channel-subscriber';
+import { ChannelSubscriber } from '/@/subscriber/channel-subscriber';
 
 export class DashboardExtension {
   #container: Container | undefined;
diff --git a/packages/extension/src/dispatcher/active-resources-count-dispatcher.ts b/packages/extension/src/dispatcher/active-resources-count-dispatcher.ts
@@ -20,7 +20,6 @@ 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 { RpcExtension } from '@kubernetes-dashboard/rpc';
 import { ACTIVE_RESOURCES_COUNT, type ActiveResourcesCountInfo } from '@kubernetes-dashboard/channels';
 
 @injectable()
@@ -31,8 +30,8 @@ export class ActiveResourcesCountDispatcher
   @inject(ContextsManager)
   private manager: ContextsManager;
 
-  constructor(@inject(RpcExtension) rpcExtension: RpcExtension) {
-    super(rpcExtension, ACTIVE_RESOURCES_COUNT);
+  constructor() {
+    super(ACTIVE_RESOURCES_COUNT);
   }
 
   getData(): ActiveResourcesCountInfo {
diff --git a/packages/extension/src/dispatcher/available-contexts-dispatcher.ts b/packages/extension/src/dispatcher/available-contexts-dispatcher.ts
@@ -19,20 +19,16 @@
 import { inject, injectable } from 'inversify';
 import type { DispatcherObject } from './util/dispatcher-object';
 import { AbsDispatcherObjectImpl } from './util/dispatcher-object';
-import { type AvailableContextsInfo, AVAILABLE_CONTEXTS } from '@kubernetes-dashboard/channels';
-import { RpcExtension } from '@kubernetes-dashboard/rpc';
+import { AVAILABLE_CONTEXTS, AvailableContextsInfo } from '@kubernetes-dashboard/channels';
 import { ContextsManager } from '/@/manager/contexts-manager';
 
 @injectable()
 export class AvailableContextsDispatcher
   extends AbsDispatcherObjectImpl<void, AvailableContextsInfo>
   implements DispatcherObject<void>
 {
-  constructor(
-    @inject(RpcExtension) rpcExtension: RpcExtension,
-    @inject(ContextsManager) private manager: ContextsManager,
-  ) {
-    super(rpcExtension, AVAILABLE_CONTEXTS);
+  constructor(@inject(ContextsManager) private manager: ContextsManager) {
+    super(AVAILABLE_CONTEXTS);
   }
 
   getData(): AvailableContextsInfo {
diff --git a/packages/extension/src/dispatcher/contexts-healths-dispatcher.ts b/packages/extension/src/dispatcher/contexts-healths-dispatcher.ts
@@ -21,18 +21,14 @@ import type { DispatcherObject } from './util/dispatcher-object';
 import { AbsDispatcherObjectImpl } from './util/dispatcher-object';
 import { ContextsManager } from '/@/manager/contexts-manager';
 import { CONTEXTS_HEALTHS, type ContextHealth, type ContextsHealthsInfo } from '@kubernetes-dashboard/channels';
-import { RpcExtension } from '@kubernetes-dashboard/rpc';
 
 @injectable()
 export class ContextsHealthsDispatcher
   extends AbsDispatcherObjectImpl<void, ContextsHealthsInfo>
   implements DispatcherObject<void>
 {
-  constructor(
-    @inject(RpcExtension) rpcExtension: RpcExtension,
-    @inject(ContextsManager) private manager: ContextsManager,
-  ) {
-    super(rpcExtension, CONTEXTS_HEALTHS);
+  constructor(@inject(ContextsManager) private manager: ContextsManager) {
+    super(CONTEXTS_HEALTHS);
   }
 
   getData(): ContextsHealthsInfo {
diff --git a/packages/extension/src/dispatcher/contexts-permissions-dispatcher.ts b/packages/extension/src/dispatcher/contexts-permissions-dispatcher.ts
@@ -21,18 +21,14 @@ import type { DispatcherObject } from './util/dispatcher-object';
 import { AbsDispatcherObjectImpl } from './util/dispatcher-object';
 import { ContextsManager } from '/@/manager/contexts-manager';
 import { CONTEXTS_PERMISSIONS, type ContextsPermissionsInfo } from '@kubernetes-dashboard/channels';
-import { RpcExtension } from '@kubernetes-dashboard/rpc';
 
 @injectable()
 export class ContextsPermissionsDispatcher
   extends AbsDispatcherObjectImpl<void, ContextsPermissionsInfo>
   implements DispatcherObject<void>
 {
-  constructor(
-    @inject(RpcExtension) rpcExtension: RpcExtension,
-    @inject(ContextsManager) private manager: ContextsManager,
-  ) {
-    super(rpcExtension, CONTEXTS_PERMISSIONS);
+  constructor(@inject(ContextsManager) private manager: ContextsManager) {
+    super(CONTEXTS_PERMISSIONS);
   }
 
   getData(): ContextsPermissionsInfo {
diff --git a/packages/extension/src/dispatcher/current-context-dispatcher.ts b/packages/extension/src/dispatcher/current-context-dispatcher.ts
@@ -19,20 +19,16 @@
 import { inject, injectable } from 'inversify';
 import type { DispatcherObject } from './util/dispatcher-object';
 import { AbsDispatcherObjectImpl } from './util/dispatcher-object';
-import { CURRENT_CONTEXT, type CurrentContextInfo } from '@kubernetes-dashboard/channels';
-import { RpcExtension } from '@kubernetes-dashboard/rpc';
+import { CURRENT_CONTEXT, CurrentContextInfo } from '@kubernetes-dashboard/channels';
 import { ContextsManager } from '/@/manager/contexts-manager';
 
 @injectable()
 export class CurrentContextDispatcher
   extends AbsDispatcherObjectImpl<void, CurrentContextInfo>
   implements DispatcherObject<void>
 {
-  constructor(
-    @inject(RpcExtension) rpcExtension: RpcExtension,
-    @inject(ContextsManager) private manager: ContextsManager,
-  ) {
-    super(rpcExtension, CURRENT_CONTEXT);
+  constructor(@inject(ContextsManager) private manager: ContextsManager) {
+    super(CURRENT_CONTEXT);
   }
 
   getData(): CurrentContextInfo {
diff --git a/packages/extension/src/dispatcher/endpoints-dispatcher.ts b/packages/extension/src/dispatcher/endpoints-dispatcher.ts
@@ -21,18 +21,14 @@ import type { DispatcherObject } from './util/dispatcher-object';
 import { AbsDispatcherObjectImpl } from './util/dispatcher-object';
 import { ContextsManager } from '/@/manager/contexts-manager';
 import { ENDPOINTS, type EndpointsOptions, type EndpointsInfo } from '@kubernetes-dashboard/channels';
-import { RpcExtension } from '@kubernetes-dashboard/rpc';
 
 @injectable()
 export class EndpointsDispatcher
   extends AbsDispatcherObjectImpl<EndpointsOptions[], EndpointsInfo>
   implements DispatcherObject<EndpointsOptions[]>
 {
-  constructor(
-    @inject(RpcExtension) rpcExtension: RpcExtension,
-    @inject(ContextsManager) private manager: ContextsManager,
-  ) {
-    super(rpcExtension, ENDPOINTS);
+  constructor(@inject(ContextsManager) private manager: ContextsManager) {
+    super(ENDPOINTS);
   }
 
   getData(options: EndpointsOptions[]): EndpointsInfo {
diff --git a/packages/extension/src/dispatcher/kubernetes-providers-dispatcher.ts b/packages/extension/src/dispatcher/kubernetes-providers-dispatcher.ts
@@ -21,7 +21,6 @@ import type { DispatcherObject } from './util/dispatcher-object';
 import { AbsDispatcherObjectImpl } from './util/dispatcher-object';
 import { ContextsManager } from '/@/manager/contexts-manager';
 import { KubernetesProvidersInfo } from '@kubernetes-dashboard/channels/dist/model/kubernetes-providers-info';
-import { RpcExtension } from '@kubernetes-dashboard/rpc';
 import { KUBERNETES_PROVIDERS } from '@kubernetes-dashboard/channels';
 import { KubernetesProvidersManager } from '/@/manager/kubernetes-providers';
 
@@ -31,11 +30,10 @@ export class KubernetesProvidersDispatcher
   implements DispatcherObject<void>
 {
   constructor(
-    @inject(RpcExtension) rpcExtension: RpcExtension,
     @inject(ContextsManager) private manager: ContextsManager,
     @inject(KubernetesProvidersManager) private kubernetesProvidersManager: KubernetesProvidersManager,
   ) {
-    super(rpcExtension, KUBERNETES_PROVIDERS);
+    super(KUBERNETES_PROVIDERS);
   }
 
   getData(): KubernetesProvidersInfo {
diff --git a/packages/extension/src/dispatcher/port-forwards-dispatcher.ts b/packages/extension/src/dispatcher/port-forwards-dispatcher.ts
@@ -20,19 +20,15 @@ import { inject, injectable } from 'inversify';
 import type { DispatcherObject } from './util/dispatcher-object';
 import { AbsDispatcherObjectImpl } from './util/dispatcher-object';
 import { PORT_FORWARDS, type PortForwardsInfo } from '@kubernetes-dashboard/channels';
-import { RpcExtension } from '@kubernetes-dashboard/rpc';
 import { PortForwardApiImpl } from '/@/manager/port-forward-api-impl';
 
 @injectable()
 export class PortForwardsDispatcher
   extends AbsDispatcherObjectImpl<void, PortForwardsInfo>
   implements DispatcherObject<void>
 {
-  constructor(
-    @inject(RpcExtension) rpcExtension: RpcExtension,
-    @inject(PortForwardApiImpl) private portForwardManager: PortForwardApiImpl,
-  ) {
-    super(rpcExtension, PORT_FORWARDS);
+  constructor(@inject(PortForwardApiImpl) private portForwardManager: PortForwardApiImpl) {
+    super(PORT_FORWARDS);
   }
 
   getData(): PortForwardsInfo {
diff --git a/packages/extension/src/dispatcher/resource-details-dispatcher.ts b/packages/extension/src/dispatcher/resource-details-dispatcher.ts
@@ -25,18 +25,14 @@ import {
   type ResourceDetailsInfo,
   type ResourceDetailsOptions,
 } from '@kubernetes-dashboard/channels';
-import { RpcExtension } from '@kubernetes-dashboard/rpc';
 
 @injectable()
 export class ResourceDetailsDispatcher
   extends AbsDispatcherObjectImpl<ResourceDetailsOptions[], ResourceDetailsInfo>
   implements DispatcherObject<ResourceDetailsOptions[]>
 {
-  constructor(
-    @inject(RpcExtension) rpcExtension: RpcExtension,
-    @inject(ContextsManager) private manager: ContextsManager,
-  ) {
-    super(rpcExtension, RESOURCE_DETAILS);
+  constructor(@inject(ContextsManager) private manager: ContextsManager) {
+    super(RESOURCE_DETAILS);
   }
 
   getData(options: ResourceDetailsOptions[]): ResourceDetailsInfo {
diff --git a/packages/extension/src/dispatcher/resource-events-dispatcher.ts b/packages/extension/src/dispatcher/resource-events-dispatcher.ts
@@ -21,18 +21,14 @@ import type { DispatcherObject } from './util/dispatcher-object';
 import { AbsDispatcherObjectImpl } from './util/dispatcher-object';
 import { ContextsManager } from '/@/manager/contexts-manager';
 import { RESOURCE_EVENTS, type ResourceEventsOptions, type ResourceEventsInfo } from '@kubernetes-dashboard/channels';
-import { RpcExtension } from '@kubernetes-dashboard/rpc';
 
 @injectable()
 export class ResourceEventsDispatcher
   extends AbsDispatcherObjectImpl<ResourceEventsOptions[], ResourceEventsInfo>
   implements DispatcherObject<ResourceEventsOptions[]>
 {
-  constructor(
-    @inject(RpcExtension) rpcExtension: RpcExtension,
-    @inject(ContextsManager) private manager: ContextsManager,
-  ) {
-    super(rpcExtension, RESOURCE_EVENTS);
+  constructor(@inject(ContextsManager) private manager: ContextsManager) {
+    super(RESOURCE_EVENTS);
   }
 
   getData(options: ResourceEventsOptions[]): ResourceEventsInfo {
diff --git a/packages/extension/src/dispatcher/resources-count-dispatcher.ts b/packages/extension/src/dispatcher/resources-count-dispatcher.ts
@@ -21,18 +21,14 @@ import type { DispatcherObject } from './util/dispatcher-object';
 import { AbsDispatcherObjectImpl } from './util/dispatcher-object';
 import { ContextsManager } from '/@/manager/contexts-manager';
 import { RESOURCES_COUNT, type ResourcesCountInfo } from '@kubernetes-dashboard/channels';
-import { RpcExtension } from '@kubernetes-dashboard/rpc';
 
 @injectable()
 export class ResourcesCountDispatcher
   extends AbsDispatcherObjectImpl<void, ResourcesCountInfo>
   implements DispatcherObject<void>
 {
-  constructor(
-    @inject(RpcExtension) rpcExtension: RpcExtension,
-    @inject(ContextsManager) private manager: ContextsManager,
-  ) {
-    super(rpcExtension, RESOURCES_COUNT);
+  constructor(@inject(ContextsManager) private manager: ContextsManager) {
+    super(RESOURCES_COUNT);
   }
 
   getData(): ResourcesCountInfo {
diff --git a/packages/extension/src/dispatcher/update-resource-dispatcher.spec.ts b/packages/extension/src/dispatcher/update-resource-dispatcher.spec.ts
@@ -17,14 +17,9 @@
  ***********************************************************************/
 
 import { beforeEach, expect, test, vi } from 'vitest';
-import type { RpcExtension } from '@kubernetes-dashboard/rpc';
 import type { ContextsManager } from '/@/manager/contexts-manager';
 import { UpdateResourceDispatcher } from '/@/dispatcher/update-resource-dispatcher';
 
-const rpcExtension = {
-  fire: vi.fn(),
-} as unknown as RpcExtension;
-
 const contextsManager = {
   getResources: vi.fn(),
 } as unknown as ContextsManager;
@@ -34,7 +29,7 @@ beforeEach(() => {
 });
 
 test('getData with explicit context names', () => {
-  const dispatcher = new UpdateResourceDispatcher(rpcExtension, contextsManager);
+  const dispatcher = new UpdateResourceDispatcher(contextsManager);
   dispatcher.getData([
     { resourceName: 'resource1', contextName: 'context1' },
     { resourceName: 'resource2', contextName: 'context2' },
@@ -45,7 +40,7 @@ test('getData with explicit context names', () => {
 });
 
 test('getData with implicit context name', () => {
-  const dispatcher = new UpdateResourceDispatcher(rpcExtension, contextsManager);
+  const dispatcher = new UpdateResourceDispatcher(contextsManager);
   dispatcher.getData([{ resourceName: 'resource1' }, { resourceName: 'resource2' }]);
   expect(contextsManager.getResources).toHaveBeenCalledTimes(2);
   expect(contextsManager.getResources).toHaveBeenCalledWith('resource1', undefined);
diff --git a/packages/extension/src/dispatcher/update-resource-dispatcher.ts b/packages/extension/src/dispatcher/update-resource-dispatcher.ts
@@ -21,18 +21,14 @@ import type { DispatcherObject } from './util/dispatcher-object';
 import { AbsDispatcherObjectImpl } from './util/dispatcher-object';
 import { ContextsManager } from '/@/manager/contexts-manager';
 import { UPDATE_RESOURCE, type UpdateResourceInfo, type UpdateResourceOptions } from '@kubernetes-dashboard/channels';
-import { RpcExtension } from '@kubernetes-dashboard/rpc';
 
 @injectable()
 export class UpdateResourceDispatcher
   extends AbsDispatcherObjectImpl<UpdateResourceOptions[], UpdateResourceInfo>
   implements DispatcherObject<UpdateResourceOptions[]>
 {
-  constructor(
-    @inject(RpcExtension) rpcExtension: RpcExtension,
-    @inject(ContextsManager) private manager: ContextsManager,
-  ) {
-    super(rpcExtension, UPDATE_RESOURCE);
+  constructor(@inject(ContextsManager) private manager: ContextsManager) {
+    super(UPDATE_RESOURCE);
   }
 
   getData(options: UpdateResourceOptions[]): UpdateResourceInfo {
diff --git a/packages/extension/src/dispatcher/util/dispatcher-object.ts b/packages/extension/src/dispatcher/util/dispatcher-object.ts
@@ -16,12 +16,13 @@
  * SPDX-License-Identifier: Apache-2.0
  ***********************************************************************/
 
-import type { RpcChannel, RpcExtension } from '@kubernetes-dashboard/rpc';
+import type { RpcChannel } from '@kubernetes-dashboard/rpc';
+import type { StateSubscriber } from '/@/subscriber/state-subscriber';
 
 export const DispatcherObject = Symbol.for('DispatcherObject');
 export interface DispatcherObject<T> {
   get channelName(): string;
-  dispatch(options?: T): Promise<void>;
+  dispatch(subscriber: StateSubscriber, options?: T): Promise<void>;
 }
 
 // Allow to receive event for a given object
@@ -33,10 +34,7 @@ export abstract class AbsDispatcherObjectImpl<T, U> implements DispatcherObject<
   #debounceTimer: NodeJS.Timeout | undefined;
   #throttleTimer: NodeJS.Timeout | undefined;
 
-  constructor(
-    private rpcExtension: RpcExtension,
-    channel: RpcChannel<U>,
-  ) {
+  constructor(channel: RpcChannel<U>) {
     this.#channel = channel;
     this.#debounceTimeout = 100;
     this.#throttleTimeout = 200;
@@ -46,9 +44,9 @@ export abstract class AbsDispatcherObjectImpl<T, U> implements DispatcherObject<
     return this.#channel.name;
   }
 
-  async dispatch(options?: T): Promise<void> {
-    const doDispatch = (): Promise<boolean> => {
-      return this.rpcExtension.fire(this.#channel, this.getData(options));
+  async dispatch(subscriber: StateSubscriber, options?: T): Promise<void> {
+    const doDispatch = (): Promise<void> => {
+      return subscriber.dispatch(this.#channel, this.getData(options));
     };
 
     if (this.#debounceTimer) {
diff --git a/packages/extension/src/inject/inversify-binding.ts b/packages/extension/src/inject/inversify-binding.ts
@@ -26,7 +26,7 @@ import { RpcExtension } from '@kubernetes-dashboard/rpc';
 import { managersModule } from '/@/manager/_manager-module';
 import { dispatchersModule } from '/@/dispatcher/_dispatcher-module';
 import { portForwardModule } from '/@/port-forward/_port-forward-module';
-import { typesModule } from '/@/types/_types_modules';
+import { subscriberModule } from '/@/subscriber/_subscriber_modules.js';
 
 export class InversifyBinding {
   #container: Container | undefined;
@@ -57,7 +57,7 @@ export class InversifyBinding {
     await this.#container.load(managersModule);
     await this.#container.load(dispatchersModule);
     await this.#container.load(portForwardModule);
-    await this.#container.load(typesModule);
+    await this.#container.load(subscriberModule);
 
     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
@@ -47,7 +47,7 @@ import {
   UPDATE_RESOURCE,
 } from '@kubernetes-dashboard/channels';
 import { KubernetesProvidersManager } from '/@/manager/kubernetes-providers.js';
-import { ChannelSubscriber } from '/@/types/channel-subscriber.js';
+import { ChannelSubscriber } from '/@/subscriber/channel-subscriber.js';
 
 let container: Container;
 const contextsManagerMock: ContextsManager = {
diff --git a/packages/extension/src/manager/contexts-states-dispatcher.ts b/packages/extension/src/manager/contexts-states-dispatcher.ts
diff --git a/packages/extension/src/subscriber/_subscriber_modules.ts b/packages/extension/src/subscriber/_subscriber_modules.ts
diff --git a/packages/extension/src/subscriber/api-subscriber.spec.ts b/packages/extension/src/subscriber/api-subscriber.spec.ts
diff --git a/packages/extension/src/subscriber/api-subscriber.ts b/packages/extension/src/subscriber/api-subscriber.ts
diff --git a/packages/extension/src/subscriber/channel-subscriber.spec.ts b/packages/extension/src/subscriber/channel-subscriber.spec.ts
diff --git a/packages/extension/src/subscriber/channel-subscriber.ts b/packages/extension/src/subscriber/channel-subscriber.ts
diff --git a/packages/extension/src/subscriber/state-subscriber.ts b/packages/extension/src/subscriber/state-subscriber.ts
