feat: kubernetes providers state (#376)

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

Author: feloy

__mocks__/@podman-desktop/api.js

@@ -40,6 +40,9 @@ const plugin = {
     onDidUpdateContainerConnection: vi.fn(),
     onDidRegisterContainerConnection: vi.fn(),
     onDidUnregisterContainerConnection: vi.fn(),
+    onDidSetConnectionFactory: vi.fn(),
+    onDidUnsetConnectionFactory: vi.fn(),
+    getConnectionFactories: vi.fn(),
   },
   containerEngine: {
     onEvent: vi.fn(),

packages/channels/src/channels.ts

@@ -29,6 +29,7 @@ import type { ContextsHealthsInfo } from './model/contexts-healths-info';
 import type { ContextsPermissionsInfo } from './model/contexts-permissions-info';
 import type { CurrentContextInfo } from './model/current-context-info';
 import type { EndpointsInfo } from './model/endpoints-info';
+import type { KubernetesProvidersInfo } from './model/kubernetes-providers-info';
 import type { PodLogsChunk } from './model/pod-logs-chunk';
 import type { PodTerminalChunk } from './model/pod-terminal-chunk';
 import type { PortForwardsInfo } from './model/port-forward-info';
@@ -57,6 +58,7 @@ export const RESOURCE_DETAILS = createRpcChannel<ResourceDetailsInfo>('ResourceD
 export const RESOURCE_EVENTS = createRpcChannel<ResourceEventsInfo>('ResourceEvents');
 export const PORT_FORWARDS = createRpcChannel<PortForwardsInfo>('PortForwards');
 export const ENDPOINTS = createRpcChannel<EndpointsInfo>('Endpoints');
+export const KUBERNETES_PROVIDERS = createRpcChannel<KubernetesProvidersInfo>('KubernetesProviders');
 
 // Channels fot streams
 export const API_POD_LOGS = createRpcChannel<PodLogsApi>('PodLogsApi');

packages/channels/src/model/index.ts

@@ -29,6 +29,7 @@ export * from './endpoints-info';
 export * from './endpoints-options';
 export * from './kubernetes-contexts-healths';
 export * from './kubernetes-contexts-permissions';
+export * from './kubernetes-providers-info';
 export * from './kubernetes-resource-count';
 export * from './kubernetes-troubleshooting';
 export * from './openshift-types';

packages/channels/src/model/kubernetes-providers-info.ts

@@ -0,0 +1,31 @@
+/**********************************************************************
+ * 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 { ProviderImages } from '@podman-desktop/api';
+
+export interface KubernetesProvider {
+  id: string;
+  creationDisplayName?: string;
+  creationButtonTitle?: string;
+  emptyConnectionMarkdownDescription?: string;
+  images?: ProviderImages;
+}
+
+export interface KubernetesProvidersInfo {
+  providers: KubernetesProvider[];
+}

packages/extension/src/dashboard-extension.ts

@@ -44,6 +44,7 @@ import { PortForwardServiceProvider } from './port-forward/port-forward-service'
 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';
 
 export class DashboardExtension {
   #container: Container | undefined;
@@ -59,6 +60,7 @@ export class DashboardExtension {
   #podLogsApiImpl: PodLogsApiImpl;
   #podTerminalsApiImpl: PodTerminalsApiImpl;
   #navigationApiImpl: NavigationApiImpl;
+  #kubernetesProvidersManager: KubernetesProvidersManager;
 
   constructor(readonly extensionContext: ExtensionContext) {
     this.#extensionContext = extensionContext;
@@ -86,6 +88,9 @@ export class DashboardExtension {
     this.#podLogsApiImpl = await this.#container.getAsync(PodLogsApiImpl);
     this.#podTerminalsApiImpl = await this.#container.getAsync(PodTerminalsApiImpl);
     this.#navigationApiImpl = await this.#container.getAsync(NavigationApiImpl);
+    this.#kubernetesProvidersManager = await this.#container.getAsync(KubernetesProvidersManager);
+
+    this.#kubernetesProvidersManager.init();
 
     const afterFirst = performance.now();
 

packages/extension/src/dispatcher/_dispatcher-module.ts

@@ -29,6 +29,7 @@ import { ResourceEventsDispatcher } from './resource-events-dispatcher';
 import { PortForwardsDispatcher } from './port-forwards-dispatcher';
 import { EndpointsDispatcher } from './endpoints-dispatcher';
 import { AvailableContextsDispatcher } from './available-contexts-dispatcher';
+import { KubernetesProvidersDispatcher } from './kubernetes-providers-dispatcher';
 
 const dispatchersModule = new ContainerModule(options => {
   options.bind<ActiveResourcesCountDispatcher>(ActiveResourcesCountDispatcher).toSelf().inSingletonScope();
@@ -63,6 +64,9 @@ const dispatchersModule = new ContainerModule(options => {
 
   options.bind<EndpointsDispatcher>(EndpointsDispatcher).toSelf().inSingletonScope();
   options.bind(DispatcherObject).toService(EndpointsDispatcher);
+
+  options.bind<KubernetesProvidersDispatcher>(KubernetesProvidersDispatcher).toSelf().inSingletonScope();
+  options.bind(DispatcherObject).toService(KubernetesProvidersDispatcher);
 });
 
 export { dispatchersModule };

packages/extension/src/dispatcher/kubernetes-providers-dispatcher.ts

@@ -0,0 +1,46 @@
+/**********************************************************************
+ * 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 { 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';
+
+@injectable()
+export class KubernetesProvidersDispatcher
+  extends AbsDispatcherObjectImpl<void, KubernetesProvidersInfo>
+  implements DispatcherObject<void>
+{
+  constructor(
+    @inject(RpcExtension) rpcExtension: RpcExtension,
+    @inject(ContextsManager) private manager: ContextsManager,
+    @inject(KubernetesProvidersManager) private kubernetesProvidersManager: KubernetesProvidersManager,
+  ) {
+    super(rpcExtension, KUBERNETES_PROVIDERS);
+  }
+
+  getData(): KubernetesProvidersInfo {
+    return {
+      providers: this.kubernetesProvidersManager.getKubernetesProviders(),
+    };
+  }
+}

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

@@ -26,6 +26,7 @@ import { PodLogsApiImpl } from './pod-logs-api-impl';
 import { IDisposable } from '@kubernetes-dashboard/channels';
 import { PodTerminalsApiImpl } from './pod-terminals-api-impl';
 import { NavigationApiImpl } from '/@/manager/navigation-api';
+import { KubernetesProvidersManager } from '/@/manager/kubernetes-providers';
 
 const managersModule = new ContainerModule(options => {
   options.bind<ContextsManager>(ContextsManager).toSelf().inSingletonScope();
@@ -35,10 +36,12 @@ const managersModule = new ContainerModule(options => {
   options.bind<PodLogsApiImpl>(PodLogsApiImpl).toSelf().inSingletonScope();
   options.bind<PodTerminalsApiImpl>(PodTerminalsApiImpl).toSelf().inSingletonScope();
   options.bind<NavigationApiImpl>(NavigationApiImpl).toSelf().inSingletonScope();
+  options.bind<KubernetesProvidersManager>(KubernetesProvidersManager).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)
   options.bind(IDisposable).toService(PodLogsApiImpl);
+  options.bind(IDisposable).toService(KubernetesProvidersManager);
 });
 
 export { managersModule };

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

@@ -40,11 +40,13 @@ import {
   CONTEXTS_PERMISSIONS,
   CURRENT_CONTEXT,
   ENDPOINTS,
+  KUBERNETES_PROVIDERS,
   RESOURCE_DETAILS,
   RESOURCE_EVENTS,
   RESOURCES_COUNT,
   UPDATE_RESOURCE,
 } from '@kubernetes-dashboard/channels';
+import { KubernetesProvidersManager } from '/@/manager/kubernetes-providers.js';
 
 let container: Container;
 const contextsManagerMock: ContextsManager = {
@@ -80,6 +82,10 @@ const contextsHealthsDispatcher = {
 const contextsPermissionsDispatcher = {
   dispatch: vi.fn(),
 } as unknown as ContextsPermissionsDispatcher;
+const kubernetesProvidersManagerMock = {
+  onKubernetesProvidersChange: vi.fn(),
+  getKubernetesProviders: vi.fn(),
+} as unknown as KubernetesProvidersManager;
 
 beforeAll(async () => {
   const inversifyBinding = new InversifyBinding(rpcExtension, extensionContext, telemetryLogger);
@@ -89,6 +95,7 @@ beforeAll(async () => {
   (await container.rebind(ActiveResourcesCountDispatcher)).toConstantValue(activeResourcesCountDispatcher);
   (await container.rebind(ContextsHealthsDispatcher)).toConstantValue(contextsHealthsDispatcher);
   (await container.rebind(ContextsPermissionsDispatcher)).toConstantValue(contextsPermissionsDispatcher);
+  (await container.rebind(KubernetesProvidersManager)).toConstantValue(kubernetesProvidersManagerMock);
 });
 
 beforeEach(() => {
@@ -216,3 +223,16 @@ test('ContextsStatesDispatcher should dispatch ENDPOINTS when onEndpointsChange
   });
   expect(dispatcherSpy).toHaveBeenCalledWith(ENDPOINTS);
 });
+
+test('ContextsStatesDispatcher should dispatch KUBERNETES_PROVIDERS when onKubernetesProvidersChange event is fired', async () => {
+  const dispatcherSpy = vi.spyOn(dispatcher, 'dispatch').mockResolvedValue();
+  dispatcher.init();
+  expect(dispatcherSpy).not.toHaveBeenCalled();
+
+  vi.mocked(kubernetesProvidersManagerMock.onKubernetesProvidersChange).mockImplementation(f => f() as IDisposable);
+  dispatcher.init();
+  await vi.waitFor(() => {
+    expect(dispatcherSpy).toHaveBeenCalledTimes(1);
+  });
+  expect(dispatcherSpy).toHaveBeenCalledWith(KUBERNETES_PROVIDERS);
+});

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

@@ -30,6 +30,7 @@ import {
   RESOURCES_COUNT,
   UPDATE_RESOURCE,
   SubscribeApi,
+  KUBERNETES_PROVIDERS,
 } from '@kubernetes-dashboard/channels';
 
 import type { ContextHealthState } from './context-health-checker.js';
@@ -41,6 +42,7 @@ import { inject, injectable, multiInject } from 'inversify';
 import { DispatcherObject } from '/@/dispatcher/util/dispatcher-object.js';
 import { ChannelSubscriber } from '/@/types/channel-subscriber.js';
 import { PortForwardServiceProvider } from '/@/port-forward/port-forward-service.js';
+import { KubernetesProvidersManager } from '/@/manager/kubernetes-providers.js';
 
 @injectable()
 export class ContextsStatesDispatcher extends ChannelSubscriber implements SubscribeApi {
@@ -50,6 +52,9 @@ export class ContextsStatesDispatcher extends ChannelSubscriber implements Subsc
   @inject(PortForwardServiceProvider)
   private portForwardServiceProvider: PortForwardServiceProvider;
 
+  @inject(KubernetesProvidersManager)
+  private kubernetesProvidersManager: KubernetesProvidersManager;
+
   #dispatchers: Map<string, DispatcherObject<unknown>> = new Map();
 
   constructor(@multiInject(DispatcherObject) dispatchers: DispatcherObject<unknown>[]) {
@@ -99,6 +104,9 @@ export class ContextsStatesDispatcher extends ChannelSubscriber implements Subsc
       await this.dispatch(ENDPOINTS);
     });
     this.onSubscribe(channelName => this.dispatchByChannelName(channelName));
+    this.kubernetesProvidersManager.onKubernetesProvidersChange(async () => {
+      await this.dispatch(KUBERNETES_PROVIDERS);
+    });
   }
 
   // TODO replace this with an event