@theia/debug 1.19.0 → 1.21.0-next.14

package/src/node/debug-model.ts

@@ -22,12 +22,11 @@
 // Some entities copied and modified from https://github.com/Microsoft/vscode/blob/master/src/vs/vscode.d.ts
 // Some entities copied and modified from https://github.com/Microsoft/vscode/blob/master/src/vs/workbench/parts/debug/common/debug.ts
 
-import { WebSocketChannel } from '@theia/core/lib/common/messaging/web-socket-channel';
 import { DebugConfiguration } from '../common/debug-configuration';
 import { IJSONSchema, IJSONSchemaSnippet } from '@theia/core/lib/common/json-schema';
-import { Disposable } from '@theia/core/lib/common/disposable';
 import { MaybePromise } from '@theia/core/lib/common/types';
 import { Event } from '@theia/core/lib/common/event';
+import { Channel } from '../common/debug-service';
 
 // FIXME: break down this file to debug adapter and debug adapter contribution (see Theia file naming conventions)
 
@@ -37,12 +36,14 @@ import { Event } from '@theia/core/lib/common/event';
 export const DebugAdapterSession = Symbol('DebugAdapterSession');
 
 /**
- * The debug adapter session.
+ * The debug adapter session. The debug adapter session manages the lifecycle of a
+ * debug session: the debug session should be discarded if and only if the debug adapter
+ * session is stopped.
  */
 export interface DebugAdapterSession {
     id: string;
     parentSession?: DebugAdapterSession;
-    start(channel: WebSocketChannel): Promise<void>
+    start(channel: Channel): Promise<void>
     stop(): Promise<void>
 }
 
@@ -55,7 +56,7 @@ export const DebugAdapterSessionFactory = Symbol('DebugAdapterSessionFactory');
  * The [debug session](#DebugSession) factory.
  */
 export interface DebugAdapterSessionFactory {
-    get(sessionId: string, communicationProvider: CommunicationProvider): DebugAdapterSession;
+    get(sessionId: string, debugAdapter: DebugAdapter): DebugAdapterSession;
 }
 
 /**
@@ -88,18 +89,35 @@ export interface DebugAdapterForkExecutable {
 export type DebugAdapterExecutable = DebugAdapterSpawnExecutable | DebugAdapterForkExecutable;
 
 /**
- * Provides some way we can communicate with the running debug adapter. In general there is
- * no obligation as of how to launch/initialize local or remote debug adapter
- * process/server, it can be done separately and it is not required that this interface covers the
- * procedure, however it is also not disallowed.
- *
- * TODO: the better name is DebugStreamConnection + handling on error and close
+ * Implementers stand for the various types of debug adapters the system can talk to.
+ * Creation of debug adapters is not covered in this interface, but handling communication
+ * and the end of life is.
  */
-export interface CommunicationProvider extends Disposable {
+
+export interface DebugAdapter {
+    /**
+     * A DAP protocol message has been received from the debug adapter
+     */
     onMessageReceived: Event<string>;
+    /**
+     * Send a DAP message to the debug adapter
+     * @param message the JSON-encoded DAP message
+     */
+    send(message: string): void;
+    /**
+     * An error has occured communicating with the debug adapter. This does not meant the debug adapter
+     * has terminated.
+     */
     onError: Event<Error>;
+    /**
+     * The connection to the debug adapter has been lost. This signals the end of life for this
+     * debug adapter instance.
+     */
     onClose: Event<void>;
-    send(message: string): void;
+    /**
+     * Terminate the connection to the debug adapter.
+     */
+    stop(): Promise<void>;
 }
 
 /**
@@ -111,8 +129,8 @@ export const DebugAdapterFactory = Symbol('DebugAdapterFactory');
  * Factory to start debug adapter.
  */
 export interface DebugAdapterFactory {
-    start(executable: DebugAdapterExecutable): CommunicationProvider;
-    connect(debugServerPort: number): CommunicationProvider;
+    start(executable: DebugAdapterExecutable): DebugAdapter;
+    connect(debugServerPort: number): DebugAdapter;
 }
 
 /**

package/src/node/{inline-communication-provider.ts → inline-debug-adapter.ts}

@@ -15,13 +15,13 @@
  ********************************************************************************/
 
 import { Emitter, Event } from '@theia/core/lib/common/event';
-import { CommunicationProvider } from './debug-model';
+import { DebugAdapter } from './debug-model';
 import * as theia from '@theia/plugin';
 
 /**
- * A communication provider for using the inline implementation of a debug adapter.
+ * A debug adapter for using the inline implementation from a plugin.
  */
-export class InlineCommunicationProvider implements CommunicationProvider {
+export class InlineDebugAdapter implements DebugAdapter {
     private messageReceivedEmitter = new Emitter<string>();
     onMessageReceived: Event<string> = this.messageReceivedEmitter.event;
     onError: Event<Error> = Event.None;
@@ -34,11 +34,14 @@ export class InlineCommunicationProvider implements CommunicationProvider {
         });
     }
 
+    async start(): Promise<void> {
+    }
+
     send(message: string): void {
         this.debugAdapter.handleMessage(JSON.parse(message));
     }
 
-    dispose(): void {
+    async stop(): Promise<void> {
         this.debugAdapter.dispose();
     }
 }

package/src/node/{stream-communication-provider.ts → stream-debug-adapter.ts}

@@ -16,10 +16,12 @@
 
 import { DisposableCollection } from '@theia/core/lib/common/disposable';
 import { Emitter, Event } from '@theia/core/lib/common/event';
+import { ChildProcess } from 'child_process';
 import * as stream from 'stream';
-import { CommunicationProvider } from './debug-model';
+import * as net from 'net';
+import { DebugAdapter } from './debug-model';
 
-export class StreamCommunicationProvider extends DisposableCollection implements CommunicationProvider {
+abstract class StreamDebugAdapter extends DisposableCollection {
     private messageReceivedEmitter = new Emitter<string>();
     onMessageReceived: Event<string> = this.messageReceivedEmitter.event;
     private errorEmitter = new Emitter<Error>();
@@ -37,13 +39,17 @@ export class StreamCommunicationProvider extends DisposableCollection implements
         super();
 
         this.fromAdapter.on('data', (data: Buffer) => this.handleData(data));
-        this.fromAdapter.on('close', () => this.closeEmitter.fire()); // FIXME pass a proper exit code
+        this.fromAdapter.on('close', () => this.handleClosed()); // FIXME pass a proper exit code
         this.fromAdapter.on('error', error => this.errorEmitter.fire(error));
         this.toAdapter.on('error', error => this.errorEmitter.fire(error));
-    };
+    }
+
+    handleClosed(): void {
+        this.closeEmitter.fire();
+    }
 
     send(message: string): void {
-        const msg = `${StreamCommunicationProvider.CONTENT_LENGTH}: ${Buffer.byteLength(message, 'utf8')}${StreamCommunicationProvider.TWO_CRLF}${message}`;
+        const msg = `${StreamDebugAdapter.CONTENT_LENGTH}: ${Buffer.byteLength(message, 'utf8')}${StreamDebugAdapter.TWO_CRLF}${message}`;
 
         this.toAdapter.write(msg, 'utf8');
     }
@@ -64,7 +70,7 @@ export class StreamCommunicationProvider extends DisposableCollection implements
                     continue; // there may be more complete messages to process
                 }
             } else {
-                let idx = this.buffer.indexOf(StreamCommunicationProvider.CONTENT_LENGTH);
+                let idx = this.buffer.indexOf(StreamDebugAdapter.CONTENT_LENGTH);
                 if (idx > 0) {
                     // log unrecognized output
                     const output = this.buffer.slice(0, idx);
@@ -73,17 +79,17 @@ export class StreamCommunicationProvider extends DisposableCollection implements
                     this.buffer = this.buffer.slice(idx);
                 }
 
-                idx = this.buffer.indexOf(StreamCommunicationProvider.TWO_CRLF);
+                idx = this.buffer.indexOf(StreamDebugAdapter.TWO_CRLF);
                 if (idx !== -1) {
                     const header = this.buffer.toString('utf8', 0, idx);
                     const lines = header.split('\r\n');
                     for (let i = 0; i < lines.length; i++) {
                         const pair = lines[i].split(/: +/);
-                        if (pair[0] === StreamCommunicationProvider.CONTENT_LENGTH) {
+                        if (pair[0] === StreamDebugAdapter.CONTENT_LENGTH) {
                             this.contentLength = +pair[1];
                         }
                     }
-                    this.buffer = this.buffer.slice(idx + StreamCommunicationProvider.TWO_CRLF.length);
+                    this.buffer = this.buffer.slice(idx + StreamDebugAdapter.TWO_CRLF.length);
                     continue;
                 }
             }
@@ -91,3 +97,30 @@ export class StreamCommunicationProvider extends DisposableCollection implements
         }
     }
 }
+
+export class ProcessDebugAdapter extends StreamDebugAdapter implements DebugAdapter {
+    protected readonly process: ChildProcess;
+    constructor(process: ChildProcess) {
+        super(process.stdout!, process.stdin!);
+        this.process = process;
+    }
+
+    async stop(): Promise<void> {
+        this.process.kill();
+        this.process.stdin?.end();
+    }
+}
+
+export class SocketDebugAdapter extends StreamDebugAdapter implements DebugAdapter {
+    private readonly socket: net.Socket;
+    constructor(socket: net.Socket) {
+        super(socket, socket);
+        this.socket = socket;
+    }
+
+    stop(): Promise<void> {
+        return new Promise<void>(resolve => {
+            this.socket.end(() => resolve());
+        });
+    }
+}

package/lib/node/inline-communication-provider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"inline-communication-provider.d.ts","sourceRoot":"","sources":["../../src/node/inline-communication-provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;kFAckF;AAElF,OAAO,EAAW,KAAK,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,KAAK,KAAK,MAAM,eAAe,CAAC;AAEvC;;GAEG;AACH,qBAAa,2BAA4B,YAAW,qBAAqB;IAOzD,OAAO,CAAC,YAAY;IANhC,OAAO,CAAC,sBAAsB,CAAyB;IACvD,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAqC;IACrE,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAc;IACnC,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAA2B;gBAE3B,YAAY,EAAE,KAAK,CAAC,YAAY;IAMpD,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI3B,OAAO,IAAI,IAAI;CAGlB"}

package/lib/node/inline-communication-provider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"inline-communication-provider.js","sourceRoot":"","sources":["../../src/node/inline-communication-provider.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;kFAckF;;;AAElF,wDAA8D;AAI9D;;GAEG;AACH,MAAa,2BAA2B;IAOpC,YAAoB,YAAgC;QAAhC,iBAAY,GAAZ,YAAY,CAAoB;QAN5C,2BAAsB,GAAG,IAAI,eAAO,EAAU,CAAC;QACvD,sBAAiB,GAAkB,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC;QACrE,YAAO,GAAiB,aAAK,CAAC,IAAI,CAAC;QAC3B,iBAAY,GAAG,IAAI,eAAO,EAAQ,CAAC;QAC3C,YAAO,GAAgB,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;QAG3C,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE;YACrC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACP,CAAC;IAED,IAAI,CAAC,OAAe;QAChB,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IACzD,CAAC;IAED,OAAO;QACH,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;IAChC,CAAC;CACJ;AApBD,kEAoBC"}

package/lib/node/stream-communication-provider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"stream-communication-provider.d.ts","sourceRoot":"","sources":["../../src/node/stream-communication-provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;kFAckF;;AAElF,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,EAAW,KAAK,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,2BAA4B,SAAQ,oBAAqB,YAAW,qBAAqB;IActF,OAAO,CAAC,WAAW;IAAmB,OAAO,CAAC,SAAS;IAbnE,OAAO,CAAC,sBAAsB,CAAyB;IACvD,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAqC;IACrE,OAAO,CAAC,YAAY,CAAwB;IAC5C,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAA2B;IAChD,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAA2B;IAG/C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAc;IACrC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAoB;IACjD,OAAO,CAAC,aAAa,CAAc;IACnC,OAAO,CAAC,MAAM,CAA2B;gBAErB,WAAW,EAAE,MAAM,CAAC,QAAQ,EAAU,SAAS,EAAE,MAAM,CAAC,QAAQ;IASpF,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAM3B,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;CA0C3C"}

package/lib/node/stream-communication-provider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"stream-communication-provider.js","sourceRoot":"","sources":["../../src/node/stream-communication-provider.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;kFAckF;;;AAElF,kEAAyE;AACzE,wDAA8D;AAI9D,MAAa,2BAA4B,SAAQ,iCAAoB;IAcjE,YAAoB,WAA4B,EAAU,SAA0B;QAChF,KAAK,EAAE,CAAC;QADQ,gBAAW,GAAX,WAAW,CAAiB;QAAU,cAAS,GAAT,SAAS,CAAiB;QAb5E,2BAAsB,GAAG,IAAI,eAAO,EAAU,CAAC;QACvD,sBAAiB,GAAkB,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC;QAC7D,iBAAY,GAAG,IAAI,eAAO,EAAS,CAAC;QAC5C,YAAO,GAAiB,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;QACxC,iBAAY,GAAG,IAAI,eAAO,EAAQ,CAAC;QAC3C,YAAO,GAAgB,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;QAKvC,kBAAa,GAAW,CAAC,CAAC,CAAC;QAC3B,WAAM,GAAW,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAKrC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;QACrE,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,gCAAgC;QAC9F,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QACrE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACvE,CAAC;IAAA,CAAC;IAEF,IAAI,CAAC,OAAe;QAChB,MAAM,GAAG,GAAG,GAAG,2BAA2B,CAAC,cAAc,KAAK,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,2BAA2B,CAAC,QAAQ,GAAG,OAAO,EAAE,CAAC;QAEpJ,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAES,UAAU,CAAC,IAAY;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;QAEjD,OAAO,IAAI,EAAE;YACT,IAAI,IAAI,CAAC,aAAa,IAAI,CAAC,EAAE;gBACzB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,aAAa,EAAE;oBAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;oBACpE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;oBACpD,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC;oBAExB,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;wBACpB,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;qBAC7C;oBACD,SAAS,CAAC,iDAAiD;iBAC9D;aACJ;iBAAM;gBACH,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,2BAA2B,CAAC,cAAc,CAAC,CAAC;gBAC1E,IAAI,GAAG,GAAG,CAAC,EAAE;oBACT,0BAA0B;oBAC1B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;oBACzC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;oBAEtC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;iBACxC;gBAED,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAC;gBAChE,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE;oBACZ,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;oBACpD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;oBACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;wBACnC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;wBACnC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,2BAA2B,CAAC,cAAc,EAAE;4BACxD,IAAI,CAAC,aAAa,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;yBACjC;qBACJ;oBACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,2BAA2B,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;oBACnF,SAAS;iBACZ;aACJ;YACD,MAAM;SACT;IACL,CAAC;;AAtEL,kEAuEC;AA/DG,2HAA2H;AAC5G,oCAAQ,GAAG,UAAU,CAAC;AACtB,0CAAc,GAAG,gBAAgB,CAAC"}