refactor: introduce DashboardApiManager (#216)

Signed-off-by: Philippe Martin <phmartin@redhat.com>

Author: feloy

packages/extension/src/manager/_manager-module.ts

@@ -1,5 +1,5 @@
 /**********************************************************************
- * Copyright (C) 2025 Red Hat, Inc.
+ * Copyright (C) 2025 - 2026 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.
@@ -23,13 +23,15 @@ import { ChannelSubscriber } from '/@/manager/channel-subscriber';
 import { Dispatcher } from '/@/manager/dispatcher';
 import { DashboardStatesManager } from './dashboard-states-manager';
 import { OpenDialogApiImpl } from '/@/manager/open-dialog-api';
+import { DashboardApiManager } from '/@/manager/dashboard-api-manager';
 
 const managersModule = new ContainerModule(options => {
   options.bind<ContextsManager>(ContextsManager).toSelf().inSingletonScope();
   options.bind<ContextsManager>(ChannelSubscriber).toSelf().inSingletonScope();
   options.bind<Dispatcher>(Dispatcher).toSelf().inSingletonScope();
   options.bind<DashboardStatesManager>(DashboardStatesManager).toSelf().inSingletonScope();
   options.bind<OpenDialogApiImpl>(OpenDialogApiImpl).toSelf().inSingletonScope();
+  options.bind<DashboardApiManager>(DashboardApiManager).toSelf().inSingletonScope();
 
   // Bind IDisposable to services which need to clear data/stop connection/etc when the panel is left
   // (the onDestroy are not called from components when the panel is left, which may introduce memory leaks if not disposed here)

packages/extension/src/manager/dashboard-api-manager.ts

@@ -0,0 +1,31 @@
+/**********************************************************************
+ * Copyright (C) 2026 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 { KubernetesDashboardExtensionApi } from '@podman-desktop/kubernetes-dashboard-extension-api';
+import { extensions } from '@podman-desktop/api';
+import { injectable } from 'inversify';
+
+@injectable()
+export class DashboardApiManager {
+  /**
+   * @returns The Kubernetes Dashboard extension API or undefined if the extension is not installed
+   */
+  getApi(): KubernetesDashboardExtensionApi | undefined {
+    return extensions.getExtension<KubernetesDashboardExtensionApi>('podman-desktop.kubernetes-dashboard')?.exports;
+  }
+}

packages/extension/src/manager/dashboard-states-manager.spec.ts

@@ -18,17 +18,32 @@
 
 import { afterEach, assert, beforeEach, describe, expect, test, vi } from 'vitest';
 import { DashboardStatesManager } from './dashboard-states-manager';
-import { type Disposable, type Extension, extensions } from '@podman-desktop/api';
+import type { Disposable, ExtensionContext, TelemetryLogger } from '@podman-desktop/api';
+import { extensions } from '@podman-desktop/api';
 import {
   type ResourcesCountInfo,
   type ContextsHealthsInfo,
   type KubernetesDashboardExtensionApi,
   type KubernetesDashboardSubscriber,
   type ContextsPermissionsInfo,
 } from '@podman-desktop/kubernetes-dashboard-extension-api';
+import { InversifyBinding } from '/@/inject/inversify-binding';
+import type { RpcExtension } from '@kubernetes-contexts/rpc';
+import type { Container } from 'inversify';
+import { DashboardApiManager } from '/@/manager/dashboard-api-manager';
 
-beforeEach(() => {
+let container: Container;
+
+const dashboardApiManagerMock: DashboardApiManager = {
+  getApi: vi.fn(),
+} as unknown as DashboardApiManager;
+
+beforeEach(async () => {
   vi.resetAllMocks();
+
+  const inversifyBinding = new InversifyBinding({} as RpcExtension, {} as ExtensionContext, {} as TelemetryLogger);
+  container = await inversifyBinding.initBindings();
+  (await container.rebind(DashboardApiManager)).toConstantValue(dashboardApiManagerMock);
 });
 
 describe('dashboard extension is not installed', () => {
@@ -39,20 +54,21 @@ describe('dashboard extension is not installed', () => {
     vi.mocked(extensions.onDidChange).mockReturnValue({
       dispose: onDidChangeDisposable,
     } as unknown as Disposable);
+    vi.mocked(dashboardApiManagerMock.getApi).mockReturnValue(undefined);
   });
 
   afterEach(() => {
     manager?.dispose();
   });
 
   test('subscriber is undefined', () => {
-    manager = new DashboardStatesManager();
+    manager = container.get(DashboardStatesManager);
     manager.init();
     expect(manager.getSubscriber()).toBeUndefined();
   });
 
   test('onDidChangeDisposable is called', () => {
-    manager = new DashboardStatesManager();
+    manager = container.get(DashboardStatesManager);
     manager.init();
     manager.dispose();
     expect(onDidChangeDisposable).toHaveBeenCalled();
@@ -77,62 +93,55 @@ describe('dashboard extension is installed', () => {
         dispose: onDidChangeDisposable,
       } as unknown as Disposable;
     });
-    vi.mocked(extensions.getExtension).mockImplementation(id => {
-      vi.mocked(subscriber).mockReturnValue({
-        onContextsHealth: onContextsHealth,
-        onResourcesCount: onResourcesCount,
-        onContextsPermissions: onContextsPermissions,
-        dispose: disposeSubscriber,
-      } as unknown as KubernetesDashboardSubscriber);
-      if (id === 'podman-desktop.kubernetes-dashboard') {
-        return {
-          exports: {
-            getSubscriber: subscriber,
-          },
-        } as unknown as Extension<KubernetesDashboardExtensionApi>;
-      }
-      return undefined;
-    });
+    vi.mocked(subscriber).mockReturnValue({
+      onContextsHealth: onContextsHealth,
+      onResourcesCount: onResourcesCount,
+      onContextsPermissions: onContextsPermissions,
+      dispose: disposeSubscriber,
+    } as unknown as KubernetesDashboardSubscriber);
+    vi.mocked(dashboardApiManagerMock.getApi).mockReturnValue({
+      getSubscriber: subscriber,
+    } as unknown as KubernetesDashboardExtensionApi);
   });
 
   afterEach(() => {
     manager?.dispose();
   });
 
   test('subscriber is eventually defined', async () => {
-    manager = new DashboardStatesManager();
+    manager = container.get(DashboardStatesManager);
     manager.init();
     await vi.waitFor(() => {
       expect(manager.getSubscriber()).toBeDefined();
     });
   });
 
   test('onContextsHealth is eventually called on subscriber', async () => {
-    manager = new DashboardStatesManager();
+    manager = container.get(DashboardStatesManager);
     manager.init();
     await vi.waitFor(() => {
       expect(onContextsHealth).toHaveBeenCalled();
     });
   });
 
   test('onResourcesCount is eventually called on subscriber', async () => {
-    manager = new DashboardStatesManager();
+    manager = container.get(DashboardStatesManager);
     manager.init();
     await vi.waitFor(() => {
       expect(onResourcesCount).toHaveBeenCalled();
     });
   });
 
   test('onContextsPermissions is eventually called on subscriber', async () => {
-    manager = new DashboardStatesManager();
+    manager = container.get(DashboardStatesManager);
     manager.init();
     await vi.waitFor(() => {
       expect(onContextsPermissions).toHaveBeenCalled();
     });
   });
 
   test('when contextsHealth callback is called, onContextsHealthChange is fired', async () => {
-    manager = new DashboardStatesManager();
+    manager = container.get(DashboardStatesManager);
     const onContextsHealthChangeCallback: () => void = vi.fn();
     manager.onContextsHealthChange(onContextsHealthChangeCallback);
 
@@ -158,7 +167,7 @@ describe('dashboard extension is installed', () => {
   });
 
   test('when resourcesCount callback is called, onResourcesCountChange is fired', async () => {
-    manager = new DashboardStatesManager();
+    manager = container.get(DashboardStatesManager);
     const onResourcesCountChangeCallback: () => void = vi.fn();
     manager.onResourcesCountChange(onResourcesCountChangeCallback);
 
@@ -183,7 +192,7 @@ describe('dashboard extension is installed', () => {
   });
 
   test('when contextsPermissions callback is called, onContextsPermissionsChange is fired', async () => {
-    manager = new DashboardStatesManager();
+    manager = container.get(DashboardStatesManager);
     const onContextsPermissionsChangeCallback: () => void = vi.fn();
     manager.onContextsPermissionsChange(onContextsPermissionsChangeCallback);
 
@@ -208,7 +217,7 @@ describe('dashboard extension is installed', () => {
   });
 
   test('when contextsHealth callback is called, getContextsHealths returns the correct value', async () => {
-    manager = new DashboardStatesManager();
+    manager = container.get(DashboardStatesManager);
     const onContextsHealthChangeCallback: () => void = vi.fn();
     manager.onContextsHealthChange(onContextsHealthChangeCallback);
 
@@ -235,7 +244,7 @@ describe('dashboard extension is installed', () => {
   });
 
   test('when resourcesCount callback is called, getResourcesCount returns the correct value', async () => {
-    manager = new DashboardStatesManager();
+    manager = container.get(DashboardStatesManager);
     const onResourcesCountChangeCallback: () => void = vi.fn();
     manager.onResourcesCountChange(onResourcesCountChangeCallback);
 
@@ -261,7 +270,7 @@ describe('dashboard extension is installed', () => {
   });
 
   test('when contextsPermissions callback is called, getContextsPermissions returns the correct value', async () => {
-    manager = new DashboardStatesManager();
+    manager = container.get(DashboardStatesManager);
     const onContextsPermissionsChangeCallback: () => void = vi.fn();
     manager.onContextsPermissionsChange(onContextsPermissionsChangeCallback);
 
@@ -287,14 +296,14 @@ describe('dashboard extension is installed', () => {
   });
 
   test('onDidChangeDisposable is called', () => {
-    manager = new DashboardStatesManager();
+    manager = container.get(DashboardStatesManager);
     manager.init();
     manager.dispose();
     expect(onDidChangeDisposable).toHaveBeenCalled();
   });
 
   test('subscriber is disposed on dispose', async () => {
-    manager = new DashboardStatesManager();
+    manager = container.get(DashboardStatesManager);
     manager.init();
     await vi.waitFor(() => {
       expect(manager.getSubscriber()).toBeDefined();

packages/extension/src/manager/dashboard-states-manager.ts

@@ -20,12 +20,12 @@ import { Disposable, extensions } from '@podman-desktop/api';
 import {
   ContextsHealthsInfo,
   ResourcesCountInfo,
-  KubernetesDashboardExtensionApi,
   KubernetesDashboardSubscriber,
   ContextsPermissionsInfo,
 } from '@podman-desktop/kubernetes-dashboard-extension-api';
-import { injectable } from 'inversify';
+import { inject, injectable } from 'inversify';
 import { Emitter, Event } from '/@/types/emitter';
+import { DashboardApiManager } from '/@/manager/dashboard-api-manager';
 
 @injectable()
 export class DashboardStatesManager implements Disposable {
@@ -45,11 +45,12 @@ export class DashboardStatesManager implements Disposable {
   #resourcesCount: ResourcesCountInfo = { counts: [] };
   #contextsPermissions: ContextsPermissionsInfo = { permissions: [] };
 
+  @inject(DashboardApiManager)
+  protected dashboardApiManager: DashboardApiManager;
+
   init(): void {
     const didChangeSubscription = extensions.onDidChange(() => {
-      const api = extensions.getExtension<KubernetesDashboardExtensionApi>(
-        'podman-desktop.kubernetes-dashboard',
-      )?.exports;
+      const api = this.dashboardApiManager.getApi();
       if (api) {
         this.#subscriber = api.getSubscriber();
         // dispose the subscriber when the extension is deactivated