feat: add onResourcesCount to API (#456)

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

Author: feloy

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

@@ -58,6 +58,16 @@ export interface ContextsPermissionsInfo {
   permissions: ContextPermission[];
 }
 
+export interface ResourceCount {
+  contextName: string;
+  resourceName: string;
+  count: number;
+}
+
+export interface ResourcesCountInfo {
+  counts: ResourceCount[];
+}
+
 /**
  * The subscriber for the events emitted by the Kubernetes Dashboard extension.
  */
@@ -66,10 +76,17 @@ export interface KubernetesDashboardSubscriber {
    * Subscribes to the events emitted every time the health of the contexts changes.
    */
   onContextsHealth(listener: (event: ContextsHealthsInfo) => void): Disposable;
+
   /**
    * Subscribes to the events emitted every time the permissions of the contexts change.
    */
   onContextsPermissions(listener: (event: ContextsPermissionsInfo) => void): Disposable;
+
+  /**
+   * Subscribes to the events emitted every time the resources count changes.
+   */
+  onResourcesCount(listener: (event: ResourcesCountInfo) => void): Disposable;
+
   /**
    * Disposes the subscriber and unsubscribes from all the events emitted by the Kubernetes Dashboard extension.
    */

packages/channels/src/channels.ts

@@ -33,10 +33,13 @@ import type { PodTerminalChunk } from './model/pod-terminal-chunk';
 import type { PortForwardsInfo } from './model/port-forward-info';
 import type { ResourceDetailsInfo } from './model/resource-details-info';
 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 { ContextsHealthsInfo, ContextsPermissionsInfo } from '@podman-desktop/kubernetes-dashboard-extension-api';
+import type {
+  ContextsHealthsInfo,
+  ContextsPermissionsInfo,
+  ResourcesCountInfo,
+} 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/active-resources-count-info.ts

@@ -16,7 +16,7 @@
  * SPDX-License-Identifier: Apache-2.0
  ***********************************************************************/
 
-import type { ResourceCount } from './kubernetes-resource-count';
+import type { ResourceCount } from '@podman-desktop/kubernetes-dashboard-extension-api';
 
 export interface ActiveResourcesCountInfo {
   counts: ResourceCount[];

packages/channels/src/model/index.ts

@@ -26,7 +26,6 @@ export * from './endpoint';
 export * from './endpoints-info';
 export * from './endpoints-options';
 export * from './kubernetes-providers-info';
-export * from './kubernetes-resource-count';
 export * from './kubernetes-troubleshooting';
 export * from './openshift-types';
 export * from './pod-logs-chunk';
@@ -37,7 +36,6 @@ export * from './resource-details-info';
 export * from './resource-details-options';
 export * from './resource-events-info';
 export * from './resource-events-options';
-export * from './resources-count-info';
 export * from './target-ref';
 export * from './update-resource-info';
 export * from './update-resource-options';

packages/channels/src/model/kubernetes-resource-count.ts

@@ -39,6 +39,7 @@ import {
   CONTEXTS_HEALTHS,
   CONTEXTS_PERMISSIONS,
   IDisposable,
+  RESOURCES_COUNT,
 } from '@kubernetes-dashboard/channels';
 import { SystemApiImpl } from './manager/system-api';
 import { PortForwardApiImpl } from './manager/port-forward-api-impl';
@@ -53,6 +54,7 @@ import type {
   ContextsPermissionsInfo,
   KubernetesDashboardExtensionApi,
   KubernetesDashboardSubscriber,
+  ResourcesCountInfo,
 } from '@podman-desktop/kubernetes-dashboard-extension-api';
 import { ApiSubscriber } from '/@/subscriber/api-subscriber';
 
@@ -141,6 +143,9 @@ export class DashboardExtension {
           onContextsPermissions: (listener: (event: ContextsPermissionsInfo) => void): IDisposable => {
             return subscriber.subscribe(CONTEXTS_PERMISSIONS, undefined, listener);
           },
+          onResourcesCount: (listener: (event: ResourcesCountInfo) => void): IDisposable => {
+            return subscriber.subscribe(RESOURCES_COUNT, undefined, listener);
+          },
           dispose: () => {
             subscriber.dispose();
           },

packages/channels/src/model/resources-count-info.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 { RESOURCES_COUNT, type ResourcesCountInfo } from '@kubernetes-dashboard/channels';
+import { RESOURCES_COUNT } from '@kubernetes-dashboard/channels';
+import type { ResourcesCountInfo } from '@podman-desktop/kubernetes-dashboard-extension-api';
 
 @injectable()
 export class ResourcesCountDispatcher

packages/extension/src/dashboard-extension.ts

@@ -34,7 +34,6 @@ import type {
   TargetRef,
   Endpoint,
   V1Route,
-  ResourceCount,
   KubernetesTroubleshootingInformation,
 } from '@kubernetes-dashboard/channels';
 import { kubernetes, window } from '@podman-desktop/api';
@@ -75,7 +74,7 @@ import { NamespacesResourceFactory } from '/@/resources/namespaces-resource-fact
 import { EndpointSlicesResourceFactory } from '/@/resources/endpoint-slices-resource-factory.js';
 import { parseAllDocuments, stringify, type Tags } from 'yaml';
 import { writeFile } from 'node:fs/promises';
-import { ContextPermission } from '@podman-desktop/kubernetes-dashboard-extension-api';
+import { ContextPermission, ResourceCount } from '@podman-desktop/kubernetes-dashboard-extension-api';
 
 const HEALTH_CHECK_TIMEOUT_MS = 5_000;
 const DEFAULT_NAMESPACE = 'default';

packages/extension/src/dispatcher/resources-count-dispatcher.ts

@@ -24,11 +24,11 @@ import { beforeEach, describe, expect, test, vi } from 'vitest';
 
 import KubernetesDashboardResourceCard from './DashboardResourceCard.svelte';
 import { FakeStateObject } from '/@/state/util/fake-state-object.svelte';
-import type { CurrentContextInfo, ActiveResourcesCountInfo, ResourcesCountInfo } from '@kubernetes-dashboard/channels';
+import type { CurrentContextInfo, ActiveResourcesCountInfo } from '@kubernetes-dashboard/channels';
 import { StatesMocks } from '/@/tests/state-mocks';
 import { DependencyMocks } from '/@/tests/dependency-mocks';
 import { Navigator } from '/@/navigation/navigator';
-import type { ContextsPermissionsInfo } from '@podman-desktop/kubernetes-dashboard-extension-api';
+import type { ContextsPermissionsInfo, ResourcesCountInfo } from '@podman-desktop/kubernetes-dashboard-extension-api';
 
 const statesMocks = new StatesMocks();
 const dependencyMocks = new DependencyMocks();