feat: pod terminal (#292)

* feat: terminal api

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

* feat: terminal webview

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

* fix: save state in case user leaves webview

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

* fix: setting size on stdout

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

* fix: format

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

* fix: linter

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

---------

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

Author: feloy

packages/common/src/channels.ts

@@ -18,6 +18,7 @@
 
 import type { ContextsApi } from './interface/contexts-api';
 import type { PodLogsApi } from './interface/pod-logs-api';
+import type { PodTerminalsApi } from './interface/pod-terminals-api';
 import type { PortForwardApi } from './interface/port-forward-api';
 import type { SubscribeApi } from './interface/subscribe-api';
 import type { SystemApi } from './interface/system-api';
@@ -27,6 +28,7 @@ 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 { PodLogsChunk } from './model/pod-logs-chunk';
+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';
@@ -56,3 +58,6 @@ export const ENDPOINTS = createRpcChannel<EndpointsInfo>('Endpoints');
 // Channels fot streams
 export const API_POD_LOGS = createRpcChannel<PodLogsApi>('PodLogsApi');
 export const POD_LOGS = createRpcChannel<PodLogsChunk>('PodLogs');
+
+export const API_POD_TERMINALS = createRpcChannel<PodTerminalsApi>('PodTerminalsApi');
+export const POD_TERMINAL_DATA = createRpcChannel<PodTerminalChunk>('PodTerminalData');

packages/common/src/interface/pod-terminals-api.ts

@@ -0,0 +1,27 @@
+/**********************************************************************
+ * 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
+ ***********************************************************************/
+
+export const PodTerminalsApi = Symbol.for('PodTerminalsApi');
+
+export interface PodTerminalsApi {
+  startTerminal(podName: string, namespace: string, containerName: string): Promise<void>;
+  sendData(podName: string, namespace: string, containerName: string, data: string): Promise<void>;
+  resizeTerminal(podName: string, namespace: string, containerName: string, cols: number, rows: number): Promise<void>;
+  saveState(podName: string, namespace: string, containerName: string, state: string): Promise<void>;
+  getState(podName: string, namespace: string, containerName: string): Promise<string>;
+}

packages/common/src/model/pod-terminal-chunk.ts

@@ -0,0 +1,25 @@
+/**********************************************************************
+ * 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
+ ***********************************************************************/
+
+export interface PodTerminalChunk {
+  podName: string;
+  namespace: string;
+  containerName: string;
+  channel: 'stdout' | 'stderr';
+  data: Buffer;
+}

packages/extension/package.json

@@ -38,7 +38,9 @@
     "prettier": "^3.6.1",
     "typescript": "5.9.2",
     "vite": "^7.1",
-    "vitest": "^3.1"
+    "vitest": "^3.1",
+    "isomorphic-ws": "^5.0.0",
+    "@types/ws": "^8.18.0"
   },
   "dependencies": {
     "@kubernetes/client-node": "^1.3.0",

packages/extension/src/dashboard-extension.ts

@@ -28,12 +28,20 @@ import { KubeConfig } from '@kubernetes/client-node';
 import { ContextsStatesDispatcher } from '/@/manager/contexts-states-dispatcher';
 import { InversifyBinding } from '/@/inject/inversify-binding';
 import type { Container } from 'inversify';
-import { API_CONTEXTS, API_POD_LOGS, API_PORT_FORWARD, API_SUBSCRIBE, API_SYSTEM } from '/@common/channels';
+import {
+  API_CONTEXTS,
+  API_POD_LOGS,
+  API_POD_TERMINALS,
+  API_PORT_FORWARD,
+  API_SUBSCRIBE,
+  API_SYSTEM,
+} from '/@common/channels';
 import { SystemApiImpl } from './manager/system-api';
 import { PortForwardApiImpl } from './manager/port-forward-api-impl';
 import { PortForwardServiceProvider } from './port-forward/port-forward-service';
 import { PodLogsApiImpl } from './manager/pod-logs-api-impl';
 import { IDisposable } from '/@common/types/disposable';
+import { PodTerminalsApiImpl } from './manager/pod-terminals-api-impl';
 
 export class DashboardExtension {
   #container: Container | undefined;
@@ -47,6 +55,7 @@ export class DashboardExtension {
   #portForwardApiImpl: PortForwardApiImpl;
   #portForwardServiceProvider: PortForwardServiceProvider;
   #podLogsApiImpl: PodLogsApiImpl;
+  #podTerminalsApiImpl: PodTerminalsApiImpl;
 
   constructor(readonly extensionContext: ExtensionContext) {
     this.#extensionContext = extensionContext;
@@ -72,6 +81,7 @@ export class DashboardExtension {
     this.#portForwardApiImpl = await this.#container.getAsync(PortForwardApiImpl);
     this.#portForwardServiceProvider = await this.#container.getAsync(PortForwardServiceProvider);
     this.#podLogsApiImpl = await this.#container.getAsync(PodLogsApiImpl);
+    this.#podTerminalsApiImpl = await this.#container.getAsync(PodTerminalsApiImpl);
 
     const afterFirst = performance.now();
 
@@ -82,6 +92,7 @@ export class DashboardExtension {
     rpcExtension.registerInstance(API_SYSTEM, this.#systemApiImpl);
     rpcExtension.registerInstance(API_PORT_FORWARD, this.#portForwardApiImpl);
     rpcExtension.registerInstance(API_POD_LOGS, this.#podLogsApiImpl);
+    rpcExtension.registerInstance(API_POD_TERMINALS, this.#podTerminalsApiImpl);
 
     await this.listenMonitoring();
     await this.startMonitoring();

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

@@ -24,13 +24,15 @@ import { SystemApiImpl } from './system-api';
 import { PortForwardApiImpl } from './port-forward-api-impl';
 import { PodLogsApiImpl } from './pod-logs-api-impl';
 import { IDisposable } from '/@common/types/disposable';
+import { PodTerminalsApiImpl } from './pod-terminals-api-impl';
 
 const managersModule = new ContainerModule(options => {
   options.bind<ContextsManager>(ContextsManager).toSelf().inSingletonScope();
   options.bind<ContextsStatesDispatcher>(ContextsStatesDispatcher).toSelf().inSingletonScope();
   options.bind<SystemApiImpl>(SystemApiImpl).toSelf().inSingletonScope();
   options.bind<PortForwardApiImpl>(PortForwardApiImpl).toSelf().inSingletonScope();
   options.bind<PodLogsApiImpl>(PodLogsApiImpl).toSelf().inSingletonScope();
+  options.bind<PodTerminalsApiImpl>(PodTerminalsApiImpl).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/pod-terminals-api-impl.ts

@@ -0,0 +1,113 @@
+/**********************************************************************
+ * 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 { IDisposable } from '/@common/types/disposable';
+import { PodTerminalsApi } from '/@common/interface/pod-terminals-api';
+import { PodTerminalService } from '../pod-terminal/pod-terminal-service';
+import { ContextsManager } from './contexts-manager';
+import { RpcExtension } from '/@common/rpc/rpc';
+
+type PodTerminalInstance = {
+  service: PodTerminalService;
+  connected: boolean;
+};
+
+@injectable()
+export class PodTerminalsApiImpl implements PodTerminalsApi, IDisposable {
+  #instances: Map<string, PodTerminalInstance> = new Map();
+
+  constructor(
+    @inject(ContextsManager) private contextsManager: ContextsManager,
+    @inject(RpcExtension) private rpcExtension: RpcExtension,
+  ) {}
+
+  async startTerminal(podName: string, namespace: string, containerName: string): Promise<void> {
+    if (!this.contextsManager.currentContext) {
+      throw new Error('No current context found');
+    }
+    let instance: PodTerminalInstance | undefined = this.#instances.get(this.getKey(podName, namespace, containerName));
+
+    if (!instance) {
+      instance = {
+        service: new PodTerminalService(
+          this.contextsManager.currentContext,
+          this.rpcExtension,
+          podName,
+          namespace,
+          containerName,
+        ),
+        connected: false,
+      };
+      this.#instances.set(this.getKey(podName, namespace, containerName), instance);
+    }
+
+    if (!instance.connected) {
+      await instance.service.startTerminal(async (): Promise<void> => {
+        if (instance) {
+          instance.connected = false;
+        }
+      });
+      instance.connected = true;
+    }
+  }
+
+  async sendData(podName: string, namespace: string, containerName: string, data: string): Promise<void> {
+    const instance = this.#instances.get(this.getKey(podName, namespace, containerName));
+    if (instance) {
+      await instance.service.sendData(data);
+    }
+  }
+
+  async resizeTerminal(
+    podName: string,
+    namespace: string,
+    containerName: string,
+    cols: number,
+    rows: number,
+  ): Promise<void> {
+    const instance = this.#instances.get(this.getKey(podName, namespace, containerName));
+    if (instance) {
+      await instance.service.resizeTerminal(cols, rows);
+    }
+  }
+
+  async saveState(podName: string, namespace: string, containerName: string, state: string): Promise<void> {
+    const instance = this.#instances.get(this.getKey(podName, namespace, containerName));
+    if (instance) {
+      await instance.service.saveState(state);
+    }
+  }
+
+  async getState(podName: string, namespace: string, containerName: string): Promise<string> {
+    const instance = this.#instances.get(this.getKey(podName, namespace, containerName));
+    if (instance) {
+      return await instance.service.getState();
+    }
+    return '';
+  }
+
+  getKey(podName: string, namespace: string, containerName: string): string {
+    return `${podName}|${namespace}|${containerName}`;
+  }
+
+  dispose(): void {
+    this.#instances.forEach(instance => instance.service.stopTerminal());
+    this.#instances.clear();
+  }
+}

packages/extension/src/pod-terminal/exec-transmitter.spec.ts

@@ -0,0 +1,65 @@
+/**********************************************************************
+ * Copyright (C) 2024 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 { expect, test } from 'vitest';
+
+import type { TerminalSize } from './exec-transmitter.js';
+import {
+  BufferedStreamWriter,
+  DEFAULT_COLUMNS,
+  DEFAULT_ROWS,
+  ResizableTerminalWriter,
+  StringLineReader,
+} from './exec-transmitter.js';
+
+test('Test should verify string line reader', () => {
+  const reader = new StringLineReader();
+
+  reader.on('data', chunk => {
+    expect(chunk.toString()).toEqual('foo');
+  });
+
+  reader.push('foo');
+});
+
+test('Test should verify buffered stream writer', () => {
+  const writer = new BufferedStreamWriter((data: Buffer) => {
+    expect(data.toString()).toEqual('foo');
+  });
+
+  writer.write(Buffer.from('foo'));
+});
+
+test('Test should verify resizable terminal writer', () => {
+  const writer = new ResizableTerminalWriter(
+    new BufferedStreamWriter((data: Buffer) => {
+      expect(data.toString()).toEqual('foo');
+    }),
+  );
+
+  writer.on('resize', () => {
+    const dimension = writer.getDimension();
+    expect(dimension).toEqual({ width: 1, height: 1 } as TerminalSize);
+  });
+
+  writer.write(Buffer.from('foo'));
+
+  expect(writer.getDimension()).toEqual({ width: DEFAULT_COLUMNS, height: DEFAULT_ROWS } as TerminalSize);
+  writer.resize({ width: 1, height: 1 } as TerminalSize);
+  expect(writer.getDimension()).toEqual({ width: 1, height: 1 } as TerminalSize);
+});