@theia/plugin-ext 1.18.0-next.88 → 1.18.0-next.89

package/src/plugin/node/debug/plugin-debug-adapter-session.ts

@@ -14,23 +14,23 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { CommunicationProvider } from '@theia/debug/lib/common/debug-model';
 import { DebugAdapterSessionImpl } from '@theia/debug/lib/node/debug-adapter-session';
 import * as theia from '@theia/plugin';
 import { IWebSocket } from '@theia/core/shared/vscode-ws-jsonrpc';
+import { CommunicationProvider, DebugAdapterSession } from '@theia/debug/lib/node/debug-model';
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
 /**
  * Server debug adapter session.
  */
-export class PluginDebugAdapterSession extends DebugAdapterSessionImpl implements theia.DebugSession {
+export class PluginDebugAdapterSession extends DebugAdapterSessionImpl implements theia.DebugSession, DebugAdapterSession {
     readonly type: string;
     readonly name: string;
     readonly configuration: theia.DebugConfiguration;
 
     constructor(
-        protected readonly communicationProvider: CommunicationProvider,
+        readonly communicationProvider: CommunicationProvider,
         protected readonly tracker: theia.DebugAdapterTracker,
         protected readonly theiaSession: theia.DebugSession) {
 

package/src/plugin/node/debug/plugin-debug-adapter-starter.ts

@@ -15,15 +15,18 @@
  ********************************************************************************/
 
 import * as net from 'net';
-import * as theia from '@theia/plugin';
-import { CommunicationProvider } from '@theia/debug/lib/common/debug-model';
 import { ChildProcess, spawn, fork, ForkOptions } from 'child_process';
+import { CommunicationProvider } from '@theia/debug/lib/node/debug-model';
+import { StreamCommunicationProvider } from '@theia/debug/lib/node/stream-communication-provider';
+import { Disposable } from '@theia/core/lib/common/disposable';
+import { DebugAdapterExecutable, DebugAdapterInlineImplementation, DebugAdapterNamedPipeServer, DebugAdapterServer } from '../../types-impl';
+import { InlineCommunicationProvider } from '@theia/debug/lib/node/inline-communication-provider';
 const isElectron = require('is-electron');
 
 /**
  * Starts debug adapter process.
  */
-export function startDebugAdapter(executable: theia.DebugAdapterExecutable): CommunicationProvider {
+export function startDebugAdapter(executable: DebugAdapterExecutable): CommunicationProvider {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const options: any = { stdio: ['pipe', 'pipe', 2] };
 
@@ -63,21 +66,28 @@ export function startDebugAdapter(executable: theia.DebugAdapterExecutable): Com
         childProcess = spawn(command, args, options);
     }
 
-    return {
-        input: childProcess.stdin!,
-        output: childProcess.stdout!,
-        dispose: () => childProcess.kill()
-    };
+    const provider = new StreamCommunicationProvider(childProcess.stdout!, childProcess.stdin!);
+    provider.push(Disposable.create(() => childProcess.kill()));
+    return provider;
 }
 
 /**
  * Connects to a remote debug server.
  */
-export function connectDebugAdapter(server: theia.DebugAdapterServer): CommunicationProvider {
+export function connectSocketDebugAdapter(server: DebugAdapterServer): CommunicationProvider {
     const socket = net.createConnection(server.port, server.host);
-    return {
-        input: socket,
-        output: socket,
-        dispose: () => socket.end()
-    };
+    const provider = new StreamCommunicationProvider(socket, socket);
+    provider.push(Disposable.create(() => socket.end()));
+    return provider;
+}
+
+export function connectPipeDebugAdapter(adapter: DebugAdapterNamedPipeServer): CommunicationProvider {
+    const socket = net.createConnection(adapter.path);
+    const provider = new StreamCommunicationProvider(socket, socket);
+    provider.push(Disposable.create(() => socket.end()));
+    return provider;
+}
+
+export function connectInlineDebugAdapter(adapter: DebugAdapterInlineImplementation): CommunicationProvider {
+    return new InlineCommunicationProvider(adapter.implementation);
 }

package/src/plugin/plugin-context.ts

@@ -106,6 +106,8 @@ import {
     Task2,
     DebugAdapterExecutable,
     DebugAdapterServer,
+    DebugAdapterNamedPipeServer,
+    DebugAdapterInlineImplementation,
     Breakpoint,
     SourceBreakpoint,
     FunctionBreakpoint,
@@ -930,6 +932,8 @@ export function createAPIFactory(
             Task2,
             DebugAdapterExecutable,
             DebugAdapterServer,
+            DebugAdapterNamedPipeServer,
+            DebugAdapterInlineImplementation,
             DebugConfigurationProviderTriggerKind,
             Breakpoint,
             SourceBreakpoint,

package/src/plugin/types-impl.ts

@@ -2120,6 +2120,12 @@ export class DebugAdapterExecutable {
     }
 }
 
+export namespace DebugAdapterExecutable {
+    export function is(adapter: theia.DebugAdapterDescriptor | undefined): adapter is theia.DebugAdapterExecutable {
+        return !!adapter && 'command' in adapter;
+    }
+}
+
 /**
  * Represents a debug adapter running as a socket based server.
  */
@@ -2145,6 +2151,52 @@ export class DebugAdapterServer {
     }
 }
 
+export namespace DebugAdapterServer {
+    export function is(adapter: theia.DebugAdapterDescriptor | undefined): adapter is DebugAdapterServer {
+        return !!adapter && 'port' in adapter;
+    }
+}
+
+/**
+ * Represents a debug adapter running as a Named Pipe (on Windows)/UNIX Domain Socket (on non-Windows) based server.
+ */
+@es5ClassCompat
+export class DebugAdapterNamedPipeServer {
+    /**
+     * Create a description for a debug adapter running as a Named Pipe (on Windows)/UNIX Domain Socket (on non-Windows) based server.
+     */
+    constructor(readonly path: string) { }
+}
+
+export namespace DebugAdapterNamedPipeServer {
+    export function is(adapter: theia.DebugAdapterDescriptor | undefined): adapter is DebugAdapterNamedPipeServer {
+        return !!adapter && 'path' in adapter;
+    }
+}
+
+/**
+ * A debug adapter descriptor for an inline implementation.
+ */
+@es5ClassCompat
+export class DebugAdapterInlineImplementation {
+    implementation: theia.DebugAdapter;
+
+    /**
+     * Create a descriptor for an inline implementation of a debug adapter.
+     */
+    constructor(impl: theia.DebugAdapter) {
+        this.implementation = impl;
+    }
+}
+
+export namespace DebugAdapterInlineImplementation {
+    export function is(adapter: theia.DebugAdapterDescriptor | undefined): adapter is DebugAdapterInlineImplementation {
+        return !!adapter && 'implementation' in adapter;
+    }
+}
+
+export type DebugAdapterDescriptor = DebugAdapterExecutable | DebugAdapterServer | DebugAdapterNamedPipeServer | DebugAdapterInlineImplementation;
+
 export enum LogLevel {
     Trace = 1,
     Debug = 2,