[vscode] Support TerminalExitReason

packages/plugin-ext/src/plugin/plugin-context.ts

@@ -157,6 +157,7 @@ import {
     InputBoxValidationSeverity,
     TerminalLink,
     TerminalLocation,
+    TerminalExitReason,
     TerminalProfile,
     InlayHint,
     InlayHintKind,
@@ -1306,7 +1307,8 @@ export function createAPIFactory(
             TabInputNotebookDiff: NotebookDiffEditorTabInput,
             TabInputWebview: WebviewEditorTabInput,
             TabInputTerminal: TerminalEditorTabInput,
-            TerminalLocation
+            TerminalLocation,
+            TerminalExitReason
         };
     };
 }

packages/plugin-ext/src/plugin/terminal-ext.ts

@@ -20,7 +20,7 @@ import { RPCProtocol } from '../common/rpc-protocol';
 import { Event, Emitter } from '@theia/core/lib/common/event';
 import { Deferred } from '@theia/core/lib/common/promise-util';
 import * as theia from '@theia/plugin';
-import { Disposable, EnvironmentVariableMutatorType, ThemeIcon } from './types-impl';
+import { Disposable, EnvironmentVariableMutatorType, TerminalExitReason, ThemeIcon } from './types-impl';
 import { SerializableEnvironmentVariableCollection } from '@theia/terminal/lib/common/base-terminal-protocol';
 import { ProvidedTerminalLink } from '../common/plugin-api-rpc-model';
 import { ThemeIcon as MonacoThemeIcon } from '@theia/monaco-editor-core/esm/vs/platform/theme/common/themeService';
@@ -198,7 +198,7 @@ export class TerminalServiceExtImpl implements TerminalServiceExt {
     $terminalClosed(id: string, exitStatus: theia.TerminalExitStatus | undefined): void {
         const terminal = this._terminals.get(id);
         if (terminal) {
-            terminal.exitStatus = exitStatus ?? { code: undefined };
+            terminal.exitStatus = exitStatus ?? { code: undefined, reason: TerminalExitReason.Unknown };
             this.onDidCloseTerminalEmitter.fire(terminal);
             this._terminals.delete(id);
         }

packages/plugin-ext/src/plugin/types-impl.ts

@@ -2046,6 +2046,14 @@ export class TerminalProfile {
     }
 }
 
+export enum TerminalExitReason {
+    Unknown = 0,
+    Shutdown = 1,
+    Process = 2,
+    User = 3,
+    Extension = 4,
+}
+
 @es5ClassCompat
 export class FileDecoration {
 

packages/plugin/src/theia.d.ts

@@ -3058,6 +3058,41 @@ export module '@theia/plugin' {
          *   without providing an exit code.
          */
         readonly code: number | undefined;
+
+        /**
+         * The reason that triggered the exit of a terminal.
+         */
+        readonly reason: TerminalExitReason;
+    }
+
+    /**
+     * Terminal exit reason kind.
+     */
+    export enum TerminalExitReason {
+        /**
+         * Unknown reason.
+         */
+        Unknown = 0,
+
+        /**
+         * The window closed/reloaded.
+         */
+        Shutdown = 1,
+
+        /**
+         * The shell process exited.
+         */
+        Process = 2,
+
+        /**
+         * The user closed the terminal.
+         */
+        User = 3,
+
+        /**
+         * An extension disposed the terminal.
+         */
+        Extension = 4
     }
 
     /**

packages/terminal/src/browser/base/terminal-widget.ts

@@ -18,7 +18,7 @@ import { Event, ViewColumn } from '@theia/core';
 import { BaseWidget } from '@theia/core/lib/browser';
 import { CommandLineOptions } from '@theia/process/lib/common/shell-command-builder';
 import { TerminalSearchWidget } from '../search/terminal-search-widget';
-import { TerminalProcessInfo } from '../../common/base-terminal-protocol';
+import { TerminalProcessInfo, TerminalExitReason } from '../../common/base-terminal-protocol';
 import URI from '@theia/core/lib/common/uri';
 
 export interface TerminalDimensions {
@@ -28,6 +28,7 @@ export interface TerminalDimensions {
 
 export interface TerminalExitStatus {
     readonly code: number | undefined;
+    readonly reason: TerminalExitReason;
 }
 
 export type TerminalLocationOptions = TerminalLocation | TerminalEditorLocation | TerminalSplitLocation;

packages/terminal/src/browser/terminal-widget-impl.ts

@@ -23,9 +23,12 @@ import { isOSX } from '@theia/core/lib/common';
 import { WorkspaceService } from '@theia/workspace/lib/browser';
 import { ShellTerminalServerProxy, IShellTerminalPreferences } from '../common/shell-terminal-protocol';
 import { terminalsPath } from '../common/terminal-protocol';
-import { IBaseTerminalServer, TerminalProcessInfo } from '../common/base-terminal-protocol';
+import { IBaseTerminalServer, TerminalProcessInfo, TerminalExitReason } from '../common/base-terminal-protocol';
 import { TerminalWatcher } from '../common/terminal-watcher';
-import { TerminalWidgetOptions, TerminalWidget, TerminalDimensions, TerminalExitStatus, TerminalLocationOptions, TerminalLocation } from './base/terminal-widget';
+import {
+    TerminalWidgetOptions, TerminalWidget, TerminalDimensions, TerminalExitStatus, TerminalLocationOptions,
+    TerminalLocation
+} from './base/terminal-widget';
 import { Deferred } from '@theia/core/lib/common/promise-util';
 import { TerminalPreferences, TerminalRendererType, isTerminalRendererType, DEFAULT_TERMINAL_RENDERER_TYPE, CursorStyle } from './terminal-preferences';
 import URI from '@theia/core/lib/common/uri';
@@ -200,14 +203,18 @@ export class TerminalWidgetImpl extends TerminalWidget implements StatefulWidget
 
         this.toDispose.push(this.terminalWatcher.onTerminalError(({ terminalId, error }) => {
             if (terminalId === this.terminalId) {
-                this.exitStatus = { code: undefined };
+                this.exitStatus = { code: undefined, reason: TerminalExitReason.Process };
                 this.dispose();
                 this.logger.error(`The terminal process terminated. Cause: ${error}`);
             }
         }));
-        this.toDispose.push(this.terminalWatcher.onTerminalExit(({ terminalId, code }) => {
+        this.toDispose.push(this.terminalWatcher.onTerminalExit(({ terminalId, code, reason }) => {
             if (terminalId === this.terminalId) {
-                this.exitStatus = { code };
+                if (reason) {
+                    this.exitStatus = { code, reason };
+                } else {
+                    this.exitStatus = { code, reason: TerminalExitReason.Process };
+                }
                 this.dispose();
             }
         }));
@@ -362,6 +369,11 @@ export class TerminalWidgetImpl extends TerminalWidget implements StatefulWidget
         return this.searchBox;
     }
 
+    protected override onCloseRequest(msg: Message): void {
+        this.exitStatus = { code: undefined, reason: TerminalExitReason.User };
+        super.onCloseRequest(msg);
+    }
+
     get dimensions(): TerminalDimensions {
         return {
             cols: this.term.cols,
@@ -721,7 +733,8 @@ export class TerminalWidgetImpl extends TerminalWidget implements StatefulWidget
             // Close the backend terminal only when explicitly closing the terminal
             // a refresh for example won't close it.
             this.shellTerminalServer.close(this.terminalId);
-            this.exitStatus = { code: undefined };
+            // Exit status is set when terminal is closed by user or by process, so most likely an extension closed it.
+            this.exitStatus = { code: undefined, reason: TerminalExitReason.Extension };
         }
         if (this.exitStatus) {
             this.onTermDidClose.fire(this);

packages/terminal/src/common/base-terminal-protocol.ts

@@ -63,11 +63,20 @@ export namespace IBaseTerminalServer {
 export interface IBaseTerminalExitEvent {
     terminalId: number;
 
-    // Exactly one of code and signal will be set.
+    // Either code and reason will be set or signal.
     code?: number;
+    reason?: TerminalExitReason;
     signal?: string;
 }
 
+export enum TerminalExitReason {
+    Unknown = 0,
+    Shutdown = 1,
+    Process = 2,
+    User = 3,
+    Extension = 4,
+}
+
 export interface IBaseTerminalErrorEvent {
     terminalId: number;
     error: Error

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

@@ -28,7 +28,8 @@ import {
     ExtensionOwnedEnvironmentVariableMutator,
     EnvironmentVariableMutatorType,
     EnvironmentVariableCollectionWithPersistence,
-    SerializableExtensionEnvironmentVariableCollection
+    SerializableExtensionEnvironmentVariableCollection,
+    TerminalExitReason
 } from '../common/base-terminal-protocol';
 import { TerminalProcess, ProcessManager, TaskTerminalProcess } from '@theia/process/lib/node';
 import { ShellProcess } from './shell-process';
@@ -160,6 +161,7 @@ export abstract class BaseTerminalServer implements IBaseTerminalServer {
                 this.client.onTerminalExitChanged({
                     'terminalId': term.id,
                     'code': event.code,
+                    'reason': TerminalExitReason.Process,
                     'signal': event.signal
                 });
             }