refactor: move single channelSubscriber as the first subscriber

Signed-off-by: Philippe Martin <[email protected]>

Author: feloy

packages/extension/src/dashboard-extension.ts

@@ -45,6 +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';
 
 export class DashboardExtension {
   #container: Container | undefined;
@@ -61,6 +62,7 @@ export class DashboardExtension {
   #podTerminalsApiImpl: PodTerminalsApiImpl;
   #navigationApiImpl: NavigationApiImpl;
   #kubernetesProvidersManager: KubernetesProvidersManager;
+  #webviewSubscriber: ChannelSubscriber;
 
   constructor(readonly extensionContext: ExtensionContext) {
     this.#extensionContext = extensionContext;
@@ -89,14 +91,15 @@ export class DashboardExtension {
     this.#podTerminalsApiImpl = await this.#container.getAsync(PodTerminalsApiImpl);
     this.#navigationApiImpl = await this.#container.getAsync(NavigationApiImpl);
     this.#kubernetesProvidersManager = await this.#container.getAsync(KubernetesProvidersManager);
+    this.#webviewSubscriber = await this.#container.getAsync(ChannelSubscriber);
 
     this.#kubernetesProvidersManager.init();
 
     const afterFirst = performance.now();
 
     console.log('activation time:', afterFirst - now);
 
-    rpcExtension.registerInstance(API_SUBSCRIBE, this.#contextsStatesDispatcher);
+    rpcExtension.registerInstance(API_SUBSCRIBE, this.#webviewSubscriber);
     rpcExtension.registerInstance(API_CONTEXTS, this.#contextsManager);
     rpcExtension.registerInstance(API_SYSTEM, this.#systemApiImpl);
     rpcExtension.registerInstance(API_PORT_FORWARD, this.#portForwardApiImpl);

packages/extension/src/inject/inversify-binding.ts

@@ -26,6 +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';
 
 export class InversifyBinding {
   #container: Container | undefined;
@@ -56,6 +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);
 
     return this.#container;
   }

packages/extension/src/manager/contexts-states-dispatcher.spec.ts

@@ -47,6 +47,7 @@ import {
   UPDATE_RESOURCE,
 } from '@kubernetes-dashboard/channels';
 import { KubernetesProvidersManager } from '/@/manager/kubernetes-providers.js';
+import { ChannelSubscriber } from '/@/types/channel-subscriber.js';
 
 let container: Container;
 const contextsManagerMock: ContextsManager = {
@@ -86,7 +87,11 @@ const kubernetesProvidersManagerMock = {
   onKubernetesProvidersChange: vi.fn(),
   getKubernetesProviders: vi.fn(),
 } as unknown as KubernetesProvidersManager;
-
+const webviewSubscriberMock = {
+  onSubscribe: vi.fn(),
+  hasSubscribers: vi.fn(),
+  getSubscriptions: vi.fn(),
+} as unknown as ChannelSubscriber;
 beforeAll(async () => {
   const inversifyBinding = new InversifyBinding(rpcExtension, extensionContext, telemetryLogger);
   container = await inversifyBinding.initBindings();
@@ -96,6 +101,7 @@ beforeAll(async () => {
   (await container.rebind(ContextsHealthsDispatcher)).toConstantValue(contextsHealthsDispatcher);
   (await container.rebind(ContextsPermissionsDispatcher)).toConstantValue(contextsPermissionsDispatcher);
   (await container.rebind(KubernetesProvidersManager)).toConstantValue(kubernetesProvidersManagerMock);
+  (await container.rebind(ChannelSubscriber)).toConstantValue(webviewSubscriberMock);
 });
 
 beforeEach(() => {
@@ -206,9 +212,9 @@ test('ContextsStatesDispatcher should dispatch CURRENT_CONTEXT when onCurrentCon
 test('dispatchByChannelName is called when onSubscribe emits an event', async () => {
   const dispatchByChannelNameSpy = vi.spyOn(dispatcher, 'dispatchByChannelName').mockResolvedValue();
 
-  vi.spyOn(dispatcher, 'onSubscribe').mockImplementation(f => f('channel1') as IDisposable);
+  vi.mocked(webviewSubscriberMock.onSubscribe).mockImplementation(f => f('channel1') as IDisposable);
   dispatcher.init();
-  expect(dispatchByChannelNameSpy).toHaveBeenCalledWith('channel1');
+  expect(dispatchByChannelNameSpy).toHaveBeenCalledWith(webviewSubscriberMock, 'channel1');
 });
 
 test('ContextsStatesDispatcher should dispatch ENDPOINTS when onEndpointsChange event is fired', async () => {

packages/extension/src/manager/contexts-states-dispatcher.ts

@@ -29,7 +29,6 @@ import {
   RESOURCE_EVENTS,
   RESOURCES_COUNT,
   UPDATE_RESOURCE,
-  SubscribeApi,
   KUBERNETES_PROVIDERS,
 } from '@kubernetes-dashboard/channels';
 
@@ -45,7 +44,7 @@ import { PortForwardServiceProvider } from '/@/port-forward/port-forward-service
 import { KubernetesProvidersManager } from '/@/manager/kubernetes-providers.js';
 
 @injectable()
-export class ContextsStatesDispatcher extends ChannelSubscriber implements SubscribeApi {
+export class ContextsStatesDispatcher {
   @inject(ContextsManager)
   private manager: ContextsManager;
 
@@ -55,10 +54,12 @@ export class ContextsStatesDispatcher extends ChannelSubscriber implements Subsc
   @inject(KubernetesProvidersManager)
   private kubernetesProvidersManager: KubernetesProvidersManager;
 
+  @inject(ChannelSubscriber)
+  private webviewSubscriber: ChannelSubscriber;
+
   #dispatchers: Map<string, DispatcherObject<unknown>> = new Map();
 
   constructor(@multiInject(DispatcherObject) dispatchers: DispatcherObject<unknown>[]) {
-    super();
     dispatchers.forEach(dispatcher => {
       this.#dispatchers.set(dispatcher.channelName, dispatcher);
     });
@@ -103,10 +104,12 @@ export class ContextsStatesDispatcher extends ChannelSubscriber implements Subsc
     this.manager.onEndpointsChange(async () => {
       await this.dispatch(ENDPOINTS);
     });
-    this.onSubscribe(channelName => this.dispatchByChannelName(channelName));
     this.kubernetesProvidersManager.onKubernetesProvidersChange(async () => {
       await this.dispatch(KUBERNETES_PROVIDERS);
     });
+
+    this.webviewSubscriber.onSubscribe(channelName => this.dispatchByChannelName(this.webviewSubscriber, channelName));
+    // TODO onSubscribe on other subscribers
   }
 
   // TODO replace this with an event
@@ -115,14 +118,15 @@ export class ContextsStatesDispatcher extends ChannelSubscriber implements Subsc
   }
 
   async dispatch(channel: RpcChannel<unknown>): Promise<void> {
-    return this.dispatchByChannelName(channel.name);
+    return this.dispatchByChannelName(this.webviewSubscriber, channel.name);
+    // TODO dispatch to other subscribers
   }
 
-  async dispatchByChannelName(channelName: string): Promise<void> {
-    if (!this.hasSubscribers(channelName)) {
+  async dispatchByChannelName(subscriber: ChannelSubscriber, channelName: string): Promise<void> {
+    if (!subscriber.hasSubscribers(channelName)) {
       return;
     }
-    const subscriptions = this.getSubscriptions(channelName);
+    const subscriptions = subscriber.getSubscriptions(channelName);
 
     const dispatcher = this.#dispatchers.get(channelName);
     if (!dispatcher) {

packages/extension/src/types/_types_modules.ts

@@ -0,0 +1,26 @@
+/**********************************************************************
+ * 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 { ChannelSubscriber } from '/@/types/channel-subscriber';
+
+const typesModule = new ContainerModule(options => {
+  options.bind<ChannelSubscriber>(ChannelSubscriber).toSelf().inSingletonScope();
+});
+
+export { typesModule };