@theia/terminal 1.45.0 → 1.46.0-next.72

package/src/common/terminal-watcher.ts

@@ -1,69 +1,69 @@
-// *****************************************************************************
-// Copyright (C) 2017 Ericsson and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { injectable } from '@theia/core/shared/inversify';
-import { Emitter, Event } from '@theia/core/lib/common/event';
-import {
-    IBaseTerminalClient,
-    IBaseTerminalExitEvent,
-    IBaseTerminalErrorEvent
-} from './base-terminal-protocol';
-
-@injectable()
-export class TerminalWatcher {
-
-    getTerminalClient(): IBaseTerminalClient {
-        const exitEmitter = this.onTerminalExitEmitter;
-        const errorEmitter = this.onTerminalErrorEmitter;
-        const storeTerminalEnvVariablesEmitter = this.onStoreTerminalEnvVariablesRequestedEmitter;
-        const updateTerminalEnvVariablesEmitter = this.onUpdateTerminalEnvVariablesRequestedEmitter;
-        return {
-            storeTerminalEnvVariables(data: string): void {
-                storeTerminalEnvVariablesEmitter.fire(data);
-            },
-            updateTerminalEnvVariables(): void {
-                updateTerminalEnvVariablesEmitter.fire(undefined);
-            },
-            onTerminalExitChanged(event: IBaseTerminalExitEvent): void {
-                exitEmitter.fire(event);
-            },
-            onTerminalError(event: IBaseTerminalErrorEvent): void {
-                errorEmitter.fire(event);
-            }
-        };
-    }
-
-    private onTerminalExitEmitter = new Emitter<IBaseTerminalExitEvent>();
-    private onTerminalErrorEmitter = new Emitter<IBaseTerminalErrorEvent>();
-    private onStoreTerminalEnvVariablesRequestedEmitter = new Emitter<string>();
-    private onUpdateTerminalEnvVariablesRequestedEmitter = new Emitter<undefined>();
-
-    get onTerminalExit(): Event<IBaseTerminalExitEvent> {
-        return this.onTerminalExitEmitter.event;
-    }
-
-    get onTerminalError(): Event<IBaseTerminalErrorEvent> {
-        return this.onTerminalErrorEmitter.event;
-    }
-
-    get onStoreTerminalEnvVariablesRequested(): Event<string> {
-        return this.onStoreTerminalEnvVariablesRequestedEmitter.event;
-    }
-
-    get onUpdateTerminalEnvVariablesRequested(): Event<undefined> {
-        return this.onUpdateTerminalEnvVariablesRequestedEmitter.event;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2017 Ericsson and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { injectable } from '@theia/core/shared/inversify';
+import { Emitter, Event } from '@theia/core/lib/common/event';
+import {
+    IBaseTerminalClient,
+    IBaseTerminalExitEvent,
+    IBaseTerminalErrorEvent
+} from './base-terminal-protocol';
+
+@injectable()
+export class TerminalWatcher {
+
+    getTerminalClient(): IBaseTerminalClient {
+        const exitEmitter = this.onTerminalExitEmitter;
+        const errorEmitter = this.onTerminalErrorEmitter;
+        const storeTerminalEnvVariablesEmitter = this.onStoreTerminalEnvVariablesRequestedEmitter;
+        const updateTerminalEnvVariablesEmitter = this.onUpdateTerminalEnvVariablesRequestedEmitter;
+        return {
+            storeTerminalEnvVariables(data: string): void {
+                storeTerminalEnvVariablesEmitter.fire(data);
+            },
+            updateTerminalEnvVariables(): void {
+                updateTerminalEnvVariablesEmitter.fire(undefined);
+            },
+            onTerminalExitChanged(event: IBaseTerminalExitEvent): void {
+                exitEmitter.fire(event);
+            },
+            onTerminalError(event: IBaseTerminalErrorEvent): void {
+                errorEmitter.fire(event);
+            }
+        };
+    }
+
+    private onTerminalExitEmitter = new Emitter<IBaseTerminalExitEvent>();
+    private onTerminalErrorEmitter = new Emitter<IBaseTerminalErrorEvent>();
+    private onStoreTerminalEnvVariablesRequestedEmitter = new Emitter<string>();
+    private onUpdateTerminalEnvVariablesRequestedEmitter = new Emitter<undefined>();
+
+    get onTerminalExit(): Event<IBaseTerminalExitEvent> {
+        return this.onTerminalExitEmitter.event;
+    }
+
+    get onTerminalError(): Event<IBaseTerminalErrorEvent> {
+        return this.onTerminalErrorEmitter.event;
+    }
+
+    get onStoreTerminalEnvVariablesRequested(): Event<string> {
+        return this.onStoreTerminalEnvVariablesRequestedEmitter.event;
+    }
+
+    get onUpdateTerminalEnvVariablesRequested(): Event<undefined> {
+        return this.onUpdateTerminalEnvVariablesRequestedEmitter.event;
+    }
+}

package/src/node/base-terminal-server.ts

@@ -1,173 +1,173 @@
-// *****************************************************************************
-// Copyright (C) 2017 Ericsson and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { inject, injectable, named } from '@theia/core/shared/inversify';
-import { ILogger, DisposableCollection } from '@theia/core/lib/common';
-import {
-    IBaseTerminalServer,
-    IBaseTerminalServerOptions,
-    IBaseTerminalClient,
-    TerminalProcessInfo,
-    TerminalExitReason
-} from '../common/base-terminal-protocol';
-import { TerminalProcess, ProcessManager, TaskTerminalProcess } from '@theia/process/lib/node';
-import { ShellProcess } from './shell-process';
-
-@injectable()
-export abstract class BaseTerminalServer implements IBaseTerminalServer {
-    protected client: IBaseTerminalClient | undefined = undefined;
-    protected terminalToDispose = new Map<number, DisposableCollection>();
-
-    constructor(
-        @inject(ProcessManager) protected readonly processManager: ProcessManager,
-        @inject(ILogger) @named('terminal') protected readonly logger: ILogger
-    ) {
-        processManager.onDelete(id => {
-            const toDispose = this.terminalToDispose.get(id);
-            if (toDispose !== undefined) {
-                toDispose.dispose();
-                this.terminalToDispose.delete(id);
-            }
-        });
-    }
-
-    abstract create(options: IBaseTerminalServerOptions): Promise<number>;
-
-    async attach(id: number): Promise<number> {
-        const term = this.processManager.get(id);
-
-        if (term && term instanceof TerminalProcess) {
-            return term.id;
-        } else {
-            this.logger.warn(`Couldn't attach - can't find terminal with id: ${id} `);
-            return -1;
-        }
-    }
-
-    async onAttachAttempted(id: number): Promise<void> {
-        const terminal = this.processManager.get(id);
-        if (terminal instanceof TaskTerminalProcess) {
-            terminal.attachmentAttempted = true;
-            if (terminal.exited) {
-                // Didn't execute `unregisterProcess` on terminal `exit` event to enable attaching task output to terminal,
-                // Fixes https://github.com/eclipse-theia/theia/issues/2961
-                terminal.unregisterProcess();
-            } else {
-                this.postAttachAttempted(terminal);
-            }
-        }
-    }
-
-    async getProcessId(id: number): Promise<number> {
-        const terminal = this.processManager.get(id);
-        if (!(terminal instanceof TerminalProcess)) {
-            throw new Error(`terminal "${id}" does not exist`);
-        }
-        return terminal.pid;
-    }
-
-    async getProcessInfo(id: number): Promise<TerminalProcessInfo> {
-        const terminal = this.processManager.get(id);
-        if (!(terminal instanceof TerminalProcess)) {
-            throw new Error(`terminal "${id}" does not exist`);
-        }
-        return {
-            executable: terminal.executable,
-            arguments: terminal.arguments,
-        };
-    }
-
-    async getCwdURI(id: number): Promise<string> {
-        const terminal = this.processManager.get(id);
-        if (!(terminal instanceof TerminalProcess)) {
-            throw new Error(`terminal "${id}" does not exist`);
-        }
-        return terminal.getCwdURI();
-    }
-
-    async close(id: number): Promise<void> {
-        const term = this.processManager.get(id);
-
-        if (term instanceof TerminalProcess) {
-            term.kill();
-        }
-    }
-
-    async getDefaultShell(): Promise<string> {
-        return ShellProcess.getShellExecutablePath();
-    }
-
-    dispose(): void {
-        // noop
-    }
-
-    async resize(id: number, cols: number, rows: number): Promise<void> {
-        const term = this.processManager.get(id);
-        if (term && term instanceof TerminalProcess) {
-            term.resize(cols, rows);
-        } else {
-            console.warn("Couldn't resize terminal " + id + ", because it doesn't exist.");
-        }
-    }
-
-    /* Set the client to receive notifications on.  */
-    setClient(client: IBaseTerminalClient | undefined): void {
-        this.client = client;
-        if (!this.client) {
-            return;
-        }
-        this.client.updateTerminalEnvVariables();
-    }
-
-    protected notifyClientOnExit(term: TerminalProcess): DisposableCollection {
-        const toDispose = new DisposableCollection();
-
-        toDispose.push(term.onError(error => {
-            this.logger.error(`Terminal pid: ${term.pid} error: ${error}, closing it.`);
-
-            if (this.client !== undefined) {
-                this.client.onTerminalError({
-                    terminalId: term.id,
-                    error: new Error(`Failed to execute terminal process (${error.code})`),
-                    attached: term instanceof TaskTerminalProcess && term.attachmentAttempted
-                });
-            }
-        }));
-
-        toDispose.push(term.onExit(event => {
-            if (this.client !== undefined) {
-                this.client.onTerminalExitChanged({
-                    terminalId: term.id,
-                    code: event.code,
-                    reason: TerminalExitReason.Process,
-                    signal: event.signal,
-                    attached: term instanceof TaskTerminalProcess && term.attachmentAttempted
-                });
-            }
-        }));
-        return toDispose;
-    }
-
-    protected postCreate(term: TerminalProcess): void {
-        const toDispose = this.notifyClientOnExit(term);
-        this.terminalToDispose.set(term.id, toDispose);
-    }
-
-    protected postAttachAttempted(term: TaskTerminalProcess): void {
-        const toDispose = this.notifyClientOnExit(term);
-        this.terminalToDispose.set(term.id, toDispose);
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2017 Ericsson and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { inject, injectable, named } from '@theia/core/shared/inversify';
+import { ILogger, DisposableCollection } from '@theia/core/lib/common';
+import {
+    IBaseTerminalServer,
+    IBaseTerminalServerOptions,
+    IBaseTerminalClient,
+    TerminalProcessInfo,
+    TerminalExitReason
+} from '../common/base-terminal-protocol';
+import { TerminalProcess, ProcessManager, TaskTerminalProcess } from '@theia/process/lib/node';
+import { ShellProcess } from './shell-process';
+
+@injectable()
+export abstract class BaseTerminalServer implements IBaseTerminalServer {
+    protected client: IBaseTerminalClient | undefined = undefined;
+    protected terminalToDispose = new Map<number, DisposableCollection>();
+
+    constructor(
+        @inject(ProcessManager) protected readonly processManager: ProcessManager,
+        @inject(ILogger) @named('terminal') protected readonly logger: ILogger
+    ) {
+        processManager.onDelete(id => {
+            const toDispose = this.terminalToDispose.get(id);
+            if (toDispose !== undefined) {
+                toDispose.dispose();
+                this.terminalToDispose.delete(id);
+            }
+        });
+    }
+
+    abstract create(options: IBaseTerminalServerOptions): Promise<number>;
+
+    async attach(id: number): Promise<number> {
+        const term = this.processManager.get(id);
+
+        if (term && term instanceof TerminalProcess) {
+            return term.id;
+        } else {
+            this.logger.warn(`Couldn't attach - can't find terminal with id: ${id} `);
+            return -1;
+        }
+    }
+
+    async onAttachAttempted(id: number): Promise<void> {
+        const terminal = this.processManager.get(id);
+        if (terminal instanceof TaskTerminalProcess) {
+            terminal.attachmentAttempted = true;
+            if (terminal.exited) {
+                // Didn't execute `unregisterProcess` on terminal `exit` event to enable attaching task output to terminal,
+                // Fixes https://github.com/eclipse-theia/theia/issues/2961
+                terminal.unregisterProcess();
+            } else {
+                this.postAttachAttempted(terminal);
+            }
+        }
+    }
+
+    async getProcessId(id: number): Promise<number> {
+        const terminal = this.processManager.get(id);
+        if (!(terminal instanceof TerminalProcess)) {
+            throw new Error(`terminal "${id}" does not exist`);
+        }
+        return terminal.pid;
+    }
+
+    async getProcessInfo(id: number): Promise<TerminalProcessInfo> {
+        const terminal = this.processManager.get(id);
+        if (!(terminal instanceof TerminalProcess)) {
+            throw new Error(`terminal "${id}" does not exist`);
+        }
+        return {
+            executable: terminal.executable,
+            arguments: terminal.arguments,
+        };
+    }
+
+    async getCwdURI(id: number): Promise<string> {
+        const terminal = this.processManager.get(id);
+        if (!(terminal instanceof TerminalProcess)) {
+            throw new Error(`terminal "${id}" does not exist`);
+        }
+        return terminal.getCwdURI();
+    }
+
+    async close(id: number): Promise<void> {
+        const term = this.processManager.get(id);
+
+        if (term instanceof TerminalProcess) {
+            term.kill();
+        }
+    }
+
+    async getDefaultShell(): Promise<string> {
+        return ShellProcess.getShellExecutablePath();
+    }
+
+    dispose(): void {
+        // noop
+    }
+
+    async resize(id: number, cols: number, rows: number): Promise<void> {
+        const term = this.processManager.get(id);
+        if (term && term instanceof TerminalProcess) {
+            term.resize(cols, rows);
+        } else {
+            console.warn("Couldn't resize terminal " + id + ", because it doesn't exist.");
+        }
+    }
+
+    /* Set the client to receive notifications on.  */
+    setClient(client: IBaseTerminalClient | undefined): void {
+        this.client = client;
+        if (!this.client) {
+            return;
+        }
+        this.client.updateTerminalEnvVariables();
+    }
+
+    protected notifyClientOnExit(term: TerminalProcess): DisposableCollection {
+        const toDispose = new DisposableCollection();
+
+        toDispose.push(term.onError(error => {
+            this.logger.error(`Terminal pid: ${term.pid} error: ${error}, closing it.`);
+
+            if (this.client !== undefined) {
+                this.client.onTerminalError({
+                    terminalId: term.id,
+                    error: new Error(`Failed to execute terminal process (${error.code})`),
+                    attached: term instanceof TaskTerminalProcess && term.attachmentAttempted
+                });
+            }
+        }));
+
+        toDispose.push(term.onExit(event => {
+            if (this.client !== undefined) {
+                this.client.onTerminalExitChanged({
+                    terminalId: term.id,
+                    code: event.code,
+                    reason: TerminalExitReason.Process,
+                    signal: event.signal,
+                    attached: term instanceof TaskTerminalProcess && term.attachmentAttempted
+                });
+            }
+        }));
+        return toDispose;
+    }
+
+    protected postCreate(term: TerminalProcess): void {
+        const toDispose = this.notifyClientOnExit(term);
+        this.terminalToDispose.set(term.id, toDispose);
+    }
+
+    protected postAttachAttempted(term: TaskTerminalProcess): void {
+        const toDispose = this.notifyClientOnExit(term);
+        this.terminalToDispose.set(term.id, toDispose);
+    }
+}

package/src/node/buffering-stream.spec.ts

@@ -1,46 +1,46 @@
-// *****************************************************************************
-// Copyright (C) 2022 Ericsson and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { wait } from '@theia/core/lib/common/promise-util';
-import { expect } from 'chai';
-import { BufferBufferingStream } from './buffering-stream';
-
-describe('BufferringStream', () => {
-
-    it('should emit whatever data was buffered before the timeout', async () => {
-        const buffer = new BufferBufferingStream({ emitInterval: 1000 });
-        const chunkPromise = waitForChunk(buffer);
-        buffer.push(Buffer.from([0]));
-        await wait(100);
-        buffer.push(Buffer.from([1]));
-        await wait(100);
-        buffer.push(Buffer.from([2, 3, 4]));
-        const chunk = await chunkPromise;
-        expect(chunk).deep.eq(Buffer.from([0, 1, 2, 3, 4]));
-    });
-
-    it('should not emit chunks bigger than maxChunkSize', async () => {
-        const buffer = new BufferBufferingStream({ maxChunkSize: 2 });
-        buffer.push(Buffer.from([0, 1, 2, 3, 4, 5]));
-        expect(await waitForChunk(buffer)).deep.eq(Buffer.from([0, 1]));
-        expect(await waitForChunk(buffer)).deep.eq(Buffer.from([2, 3]));
-        expect(await waitForChunk(buffer)).deep.eq(Buffer.from([4, 5]));
-    });
-
-    function waitForChunk(buffer: BufferBufferingStream): Promise<Buffer> {
-        return new Promise(resolve => buffer.onData(resolve));
-    }
-});
+// *****************************************************************************
+// Copyright (C) 2022 Ericsson and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { wait } from '@theia/core/lib/common/promise-util';
+import { expect } from 'chai';
+import { BufferBufferingStream } from './buffering-stream';
+
+describe('BufferringStream', () => {
+
+    it('should emit whatever data was buffered before the timeout', async () => {
+        const buffer = new BufferBufferingStream({ emitInterval: 1000 });
+        const chunkPromise = waitForChunk(buffer);
+        buffer.push(Buffer.from([0]));
+        await wait(100);
+        buffer.push(Buffer.from([1]));
+        await wait(100);
+        buffer.push(Buffer.from([2, 3, 4]));
+        const chunk = await chunkPromise;
+        expect(chunk).deep.eq(Buffer.from([0, 1, 2, 3, 4]));
+    });
+
+    it('should not emit chunks bigger than maxChunkSize', async () => {
+        const buffer = new BufferBufferingStream({ maxChunkSize: 2 });
+        buffer.push(Buffer.from([0, 1, 2, 3, 4, 5]));
+        expect(await waitForChunk(buffer)).deep.eq(Buffer.from([0, 1]));
+        expect(await waitForChunk(buffer)).deep.eq(Buffer.from([2, 3]));
+        expect(await waitForChunk(buffer)).deep.eq(Buffer.from([4, 5]));
+    });
+
+    function waitForChunk(buffer: BufferBufferingStream): Promise<Buffer> {
+        return new Promise(resolve => buffer.onData(resolve));
+    }
+});