refactor: use Disposable from podman desktop api (#421)

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

Author: feloy

__mocks__/@podman-desktop/api.js

@@ -80,7 +80,10 @@ const plugin = {
   kubernetes: {
     onDidUpdateKubeconfig: vi.fn(),
     getKubeconfig: vi.fn(),
-  }
+  },
+  Disposable: {
+    create: (func) => ({ dispose: func }),
+  },
 };
 
 module.exports = plugin;

packages/channels/src/index.ts

@@ -16,9 +16,9 @@
  * SPDX-License-Identifier: Apache-2.0
  ***********************************************************************/
 
-import { IDisposable, Disposable } from './types/disposable';
+import { IDisposable } from './types/disposable';
 
-export { IDisposable, Disposable };
+export { IDisposable };
 export * from './interface';
 export * from './model';
 export * from './channels';

packages/channels/src/types/disposable.ts

@@ -20,40 +20,3 @@ export const IDisposable = Symbol.for('IDisposable');
 export interface IDisposable {
   dispose(): void;
 }
-
-export class Disposable implements IDisposable {
-  private disposable: undefined | (() => void);
-
-  static from(...disposables: { dispose(): unknown }[]): Disposable {
-    return new Disposable(() => {
-      if (disposables) {
-        for (const disposable of disposables) {
-          if (disposable && typeof disposable.dispose === 'function') {
-            disposable.dispose();
-          }
-        }
-      }
-    });
-  }
-
-  constructor(func: () => void) {
-    this.disposable = func;
-  }
-  /**
-   * Dispose this object.
-   */
-  dispose(): void {
-    if (this.disposable) {
-      this.disposable();
-      this.disposable = undefined;
-    }
-  }
-
-  static create(func: () => void): Disposable {
-    return new Disposable(func);
-  }
-
-  static noop(): Disposable {
-    return Disposable.from();
-  }
-}

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

@@ -18,7 +18,7 @@
 
 import type { Cluster, CoreV1Event, KubernetesObject, ObjectCache, V1Status } from '@kubernetes/client-node';
 import { ApiException, KubeConfig } from '@kubernetes/client-node';
-import type { Uri } from '@podman-desktop/api';
+import { type Uri, Disposable } from '@podman-desktop/api';
 import { afterEach, assert, beforeEach, describe, expect, test, vi } from 'vitest';
 import { kubernetes, window } from '@podman-desktop/api';
 
@@ -35,7 +35,6 @@ import type { ResourceFactory } from '/@/resources/resource-factory.js';
 import { ResourceFactoryBase } from '/@/resources/resource-factory.js';
 import type { CacheUpdatedEvent, ObjectDeletedEvent, ResourceInformer } from '/@/types/resource-informer.js';
 import { vol } from 'memfs';
-import { Disposable } from '@kubernetes-dashboard/channels';
 
 const resource4DeleteObjectMock = vi.fn();
 const resource4SearchBySelectorMock = vi.fn();

packages/extension/src/manager/kubernetes-providers.spec.ts

@@ -18,9 +18,8 @@
 
 import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest';
 import { KubernetesProvidersManager } from '/@/manager/kubernetes-providers';
-import type { ConnectionFactory, ConnectionFactoryDetails } from '@podman-desktop/api';
+import { type ConnectionFactory, type ConnectionFactoryDetails, Disposable } from '@podman-desktop/api';
 import { provider } from '@podman-desktop/api';
-import { Disposable } from '@kubernetes-dashboard/channels';
 
 let manager: KubernetesProvidersManager;
 let onDidSetDisposable: Disposable;

packages/extension/src/port-forward/port-forward-connection.ts

@@ -19,13 +19,13 @@ import net from 'node:net';
 
 import type { KubeConfig, V1Deployment, V1Pod, V1Service } from '@kubernetes/client-node';
 import { PortForward } from '@kubernetes/client-node';
+import { Disposable } from '@podman-desktop/api';
 import {
   type ForwardConfig,
   type PortForwardableResource,
   type PortMapping,
   WorkloadKind,
   type IDisposable,
-  Disposable,
 } from '@kubernetes-dashboard/channels';
 import type { ForwardConfigRequirements } from './port-forward-validation';
 import type { ContextsManager } from '/@/manager/contexts-manager';

packages/extension/src/port-forward/port-forward-service.ts

@@ -21,7 +21,6 @@ import { PortForwardConnectionService } from './port-forward-connection';
 import { ForwardConfigRequirements } from './port-forward-validation';
 import { ConfigManagementService, MemoryBasedStorage } from './port-forward-storage';
 import {
-  Disposable,
   type IDisposable,
   type ForwardConfig,
   type ForwardOptions,
@@ -31,7 +30,7 @@ import { ContextsManager } from '/@/manager/contexts-manager';
 import { inject, injectable } from 'inversify';
 import { Emitter, Event } from '/@/types/emitter';
 import { SystemApiImpl } from '/@/manager/system-api';
-import { window } from '@podman-desktop/api';
+import { Disposable, window } from '@podman-desktop/api';
 
 /**
  * Service provider for Kubernetes port forwarding.

packages/webview/src/component/pods/PodTerminal.spec.ts

@@ -23,7 +23,7 @@ import {
   API_POD_TERMINALS,
   type PodTerminalsApi,
   type PodTerminalChunk,
-  Disposable,
+  type IDisposable,
 } from '@kubernetes-dashboard/channels';
 import { StreamsMocks } from '/@/tests/stream-mocks';
 import { Terminal } from '@xterm/xterm';
@@ -63,7 +63,7 @@ const terminalMock = {
 beforeEach(() => {
   vi.resetAllMocks();
   vi.mocked(Terminal).mockReturnValue(terminalMock);
-  vi.mocked(terminalMock.onData).mockReturnValue(Disposable.create(() => {}));
+  vi.mocked(terminalMock.onData).mockReturnValue({ dispose: () => {} } as IDisposable);
   streamMocks.reset();
   streamMocks.mock<PodTerminalChunk>('streamPodTerminals', streamPodTerminalsMock);
 

packages/webview/src/component/pods/PodTerminal.svelte

@@ -8,7 +8,7 @@ import { getTerminalTheme } from '/@/component/terminal/terminal-theme';
 import { FitAddon } from '@xterm/addon-fit';
 import { SerializeAddon } from '@xterm/addon-serialize';
 import { Remote } from '/@/remote/remote';
-import { API_POD_TERMINALS, Disposable } from '@kubernetes-dashboard/channels';
+import { API_POD_TERMINALS } from '@kubernetes-dashboard/channels';
 
 interface Props {
   object: V1Pod;
@@ -47,7 +47,7 @@ async function initializeNewTerminal(
   containerName: string,
 ): Promise<IDisposable> {
   if (!container) {
-    return Disposable.create(() => {});
+    return { dispose: () => {} } as IDisposable;
   }
   shellTerminal = new Terminal({
     fontSize: 10,
@@ -86,14 +86,16 @@ async function initializeNewTerminal(
   window.addEventListener('resize', onResize);
   await resize();
 
-  return Disposable.create(() => {
-    const terminalContent = serializeAddon.serialize();
-    podTerminalsApi.saveState(podName, namespace, containerName, terminalContent).catch(console.error);
-    window.removeEventListener('resize', onResize);
-    shellTerminal.dispose();
-    fitAddon.dispose();
-    serializeAddon.dispose();
-  });
+  return {
+    dispose: () => {
+      const terminalContent = serializeAddon.serialize();
+      podTerminalsApi.saveState(podName, namespace, containerName, terminalContent).catch(console.error);
+      window.removeEventListener('resize', onResize);
+      shellTerminal.dispose();
+      fitAddon.dispose();
+      serializeAddon.dispose();
+    },
+  } as IDisposable;
 }
 
 onDestroy(() => {

packages/webview/src/stream/pod-logs.ts

@@ -23,7 +23,6 @@ import {
   POD_LOGS,
   type PodLogsApi,
   type PodLogsChunk,
-  Disposable,
   type IDisposable,
 } from '@kubernetes-dashboard/channels';
 import { RpcBrowser } from '@kubernetes-dashboard/rpc';
@@ -51,9 +50,11 @@ export class StreamPodLogs implements StreamObject<PodLogsChunk> {
       callback(chunk);
     });
     await this.#podLogsApi.streamPodLogs(podName, namespace, containerName);
-    return Disposable.create(() => {
-      disposable.dispose();
-      this.#podLogsApi.stopStreamPodLogs(podName, namespace, containerName).catch(console.error);
-    });
+    return {
+      dispose: () => {
+        disposable.dispose();
+        this.#podLogsApi.stopStreamPodLogs(podName, namespace, containerName).catch(console.error);
+      },
+    } as IDisposable;
   }
 }