feat: add onContextsHealth to api

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

Author: feloy

packages/api/src/kubernetes-dashboard-extension-api.d.ts

@@ -18,6 +18,24 @@
 
 import type { Disposable } from '@podman-desktop/api';
 
+export interface ContextHealth {
+  contextName: string;
+  // is the health of the cluster being checked?
+  checking: boolean;
+  // was the health check successful?
+  reachable: boolean;
+  // is one of the informers marked offline (disconnect after being connected, the cache still being populated)
+  offline: boolean;
+  // description in case of error (other than health check)
+  // currently detected errors:
+  // - user.exec.command not found
+  errorMessage?: string;
+}
+
+export interface ContextsHealthsInfo {
+  healths: ContextHealth[];
+}
+
 export interface AvailableContextsInfo {
   contextNames: string[];
 }
@@ -31,6 +49,7 @@ export interface CurrentContextInfo {
  * The subscriber for the events emitted by the Kubernetes Dashboard extension.
  */
 export interface KubernetesDashboardSubscriber {
+  onContextsHealth(listener: (event: ContextsHealthsInfo) => void): Disposable;
   onAvailableContexts(listener: (event: AvailableContextsInfo) => void): Disposable;
   onCurrentContext(listener: (event: CurrentContextInfo) => void): Disposable;
   /**

packages/channels/src/channels.ts

@@ -24,7 +24,6 @@ import type { PortForwardApi } from './interface/port-forward-api';
 import type { SubscribeApi } from './interface/subscribe-api';
 import type { SystemApi } from './interface/system-api';
 import type { ActiveResourcesCountInfo } from './model/active-resources-count-info';
-import type { ContextsHealthsInfo } from './model/contexts-healths-info';
 import type { ContextsPermissionsInfo } from './model/contexts-permissions-info';
 import type { EndpointsInfo } from './model/endpoints-info';
 import type { KubernetesProvidersInfo } from './model/kubernetes-providers-info';
@@ -36,7 +35,11 @@ import type { ResourceEventsInfo } from './model/resource-events-info';
 import type { ResourcesCountInfo } from './model/resources-count-info';
 import type { UpdateResourceInfo } from './model/update-resource-info';
 import { createRpcChannel } from '@kubernetes-dashboard/rpc';
-import type { AvailableContextsInfo, CurrentContextInfo } from '@podman-desktop/kubernetes-dashboard-extension-api';
+import type {
+  AvailableContextsInfo,
+  ContextsHealthsInfo,
+  CurrentContextInfo,
+} from '@podman-desktop/kubernetes-dashboard-extension-api';
 
 // RPC channels (used by the webview to send requests to the extension)
 export const API_CONTEXTS = createRpcChannel<ContextsApi>('ContextsApi');

packages/channels/src/model/contexts-healths-info.ts

@@ -20,12 +20,10 @@ export * from './active-resources-count-info';
 export * from './context-resource-events';
 export * from './context-resources-details';
 export * from './context-resources-items';
-export * from './contexts-healths-info';
 export * from './contexts-permissions-info';
 export * from './endpoint';
 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';

packages/channels/src/model/index.ts

@@ -37,6 +37,7 @@ import {
   API_SUBSCRIBE,
   API_SYSTEM,
   AVAILABLE_CONTEXTS,
+  CONTEXTS_HEALTHS,
   CURRENT_CONTEXT,
   IDisposable,
 } from '@kubernetes-dashboard/channels';
@@ -50,6 +51,7 @@ import { KubernetesProvidersManager } from '/@/manager/kubernetes-providers';
 import { ChannelSubscriber } from '/@/subscriber/channel-subscriber';
 import type {
   AvailableContextsInfo,
+  ContextsHealthsInfo,
   CurrentContextInfo,
   KubernetesDashboardExtensionApi,
   KubernetesDashboardSubscriber,
@@ -135,6 +137,9 @@ export class DashboardExtension {
         const subscriber = new ApiSubscriber();
         this.#contextsStatesDispatcher.addSubscriber(subscriber);
         return {
+          onContextsHealth: (listener: (event: ContextsHealthsInfo) => void): IDisposable => {
+            return subscriber.subscribe(CONTEXTS_HEALTHS, undefined, listener);
+          },
           onAvailableContexts: (listener: (event: AvailableContextsInfo) => void): IDisposable => {
             return subscriber.subscribe(AVAILABLE_CONTEXTS, undefined, listener);
           },

packages/channels/src/model/kubernetes-contexts-healths.ts

@@ -20,7 +20,8 @@ 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, type ContextHealth, type ContextsHealthsInfo } from '@kubernetes-dashboard/channels';
+import { CONTEXTS_HEALTHS } from '@kubernetes-dashboard/channels';
+import { ContextHealth, ContextsHealthsInfo } from '@podman-desktop/kubernetes-dashboard-extension-api';
 
 @injectable()
 export class ContextsHealthsDispatcher

packages/extension/src/dashboard-extension.ts

@@ -23,11 +23,11 @@ import { assert, beforeEach, expect, test, vi } from 'vitest';
 
 import { StatesMocks } from '/@/tests/state-mocks';
 import { FakeStateObject } from '/@/state/util/fake-state-object.svelte';
-import { type ContextsHealthsInfo, API_CONTEXTS, type ContextsApi } from '@kubernetes-dashboard/channels';
+import { API_CONTEXTS, type ContextsApi } from '@kubernetes-dashboard/channels';
 import CheckConnection from './CheckConnection.svelte';
 import userEvent from '@testing-library/user-event';
 import { RemoteMocks } from '/@/tests/remote-mocks';
-import type { CurrentContextInfo } from '@podman-desktop/kubernetes-dashboard-extension-api';
+import type { ContextsHealthsInfo, CurrentContextInfo } from '@podman-desktop/kubernetes-dashboard-extension-api';
 
 const statesMocks = new StatesMocks();
 const remoteMocks = new RemoteMocks();

packages/extension/src/dispatcher/contexts-healths-dispatcher.ts

@@ -21,11 +21,10 @@ import '@testing-library/jest-dom/vitest';
 import { render, screen } from '@testing-library/svelte';
 import { tick } from 'svelte';
 import { beforeEach, describe, expect, test, vi } from 'vitest';
-import type { ContextsHealthsInfo } from '@kubernetes-dashboard/channels';
 import { StatesMocks } from '/@/tests/state-mocks';
 import { FakeStateObject } from '/@/state/util/fake-state-object.svelte';
 import CurrentContextConnectionBadge from './CurrentContextConnectionBadge.svelte';
-import type { CurrentContextInfo } from '@podman-desktop/kubernetes-dashboard-extension-api';
+import type { ContextsHealthsInfo, CurrentContextInfo } from '@podman-desktop/kubernetes-dashboard-extension-api';
 
 const statesMocks = new StatesMocks();
 

packages/webview/src/component/connection/CheckConnection.spec.ts

@@ -4,8 +4,8 @@ import type { Unsubscriber } from 'svelte/store';
 
 import Label from '/@/component/label/Label.svelte';
 import { States } from '/@/state/states';
-import type { ContextHealth } from '@kubernetes-dashboard/channels';
 import { Spinner } from '@podman-desktop/ui-svelte';
+import type { ContextHealth } from '@podman-desktop/kubernetes-dashboard-extension-api';
 
 const states = getContext<States>(States);
 const currentContext = states.stateCurrentContextInfoUI;