WIP: Intergrate debug adapter into python example

kaisalmen · kaisalmen · commit 7f5da55aa9bc · 2025-02-05T12:16:49.000+01:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/examples/package.json b/packages/examples/package.json
@@ -73,6 +73,7 @@
   "dependencies": {
     "@codingame/monaco-vscode-configuration-service-override": "13.1.3",
     "@codingame/monaco-vscode-cpp-default-extension": "13.1.3",
+    "@codingame/monaco-vscode-debug-service-override": "13.1.3",
     "@codingame/monaco-vscode-editor-api": "13.1.3",
     "@codingame/monaco-vscode-environment-service-override": "13.1.3",
     "@codingame/monaco-vscode-explorer-service-override": "13.1.3",
diff --git a/packages/examples/resources/debugger/docker-compose.yml b/packages/examples/resources/debugger/docker-compose.yml
@@ -11,7 +11,7 @@ services:
     platform: linux/amd64
     volumes:
       - ../python:/home/mlc/workspace
-      - ../../src/debugger:/home/mlc/server/src
+      - ../../src/debugger/server:/home/mlc/server/src
     ports:
       - 55555:5555
     tty: true
diff --git a/packages/examples/resources/debugger/package.json b/packages/examples/resources/debugger/package.json
@@ -39,6 +39,6 @@
     "tsx": "~4.19.2"
   },
   "scripts": {
-    "start": "npm i && vite-node src/debugServer.ts"
+    "start": "npm i && tsx src/debugServer.ts"
   }
 }
diff --git a/packages/examples/src/debugger/client/debugger.ts b/packages/examples/src/debugger/client/debugger.ts
@@ -0,0 +1,112 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) 2024 TypeFox and others.
+ * Licensed under the MIT License. See LICENSE in the package root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+import * as vscode from 'vscode';
+import type { ExtensionConfig } from 'monaco-editor-wrapper';
+
+// This is derived from:
+// https://github.com/CodinGame/monaco-vscode-api/blob/main/demo/src/features/debugger.ts
+
+export const provideDebuggerExtensionConfig = (): ExtensionConfig => {
+    const filesOrContents = new Map<string, string | URL>();
+    filesOrContents.set('./extension.js', '// nothing');
+
+    return {
+        config: {
+            name: 'debugger-py-client',
+            publisher: 'TypeFox',
+            version: '1.0.0',
+            engines: {
+                vscode: '*'
+            },
+            // A browser field is mandatory for the extension to be flagged as `web`
+            browser: 'extension.js',
+            contributes: {
+                debuggers: [
+                    {
+                        type: 'python',
+                        label: 'Test',
+                        languages: ['python']
+                    }
+                ],
+                breakpoints: [
+                    {
+                        language: 'python'
+                    }
+                ]
+            }
+        },
+        filesOrContents
+    };
+};
+
+export const confiugureDebugging = async (api: typeof vscode) => {
+    class WebsocketDebugAdapter implements vscode.DebugAdapter {
+        private websocket: WebSocket;
+
+        constructor(websocket: WebSocket) {
+            this.websocket = websocket;
+            this.websocket.onmessage = (message) => {
+                this._onDidSendMessage.fire(JSON.parse(message.data));
+            };
+        }
+
+        _onDidSendMessage = new api.EventEmitter<vscode.DebugProtocolMessage>();
+        onDidSendMessage = this._onDidSendMessage.event;
+
+        handleMessage(message: vscode.DebugProtocolMessage): void {
+            this.websocket.send(JSON.stringify(message));
+        }
+
+        dispose() {
+            this.websocket.close();
+        }
+    }
+
+    api.debug.registerDebugConfigurationProvider('javascript', {
+        resolveDebugConfiguration() {
+            return {
+                name: 'Test debugger',
+                type: 'javascript',
+                request: 'launch'
+            };
+        }
+    });
+
+    api.debug.registerDebugAdapterDescriptorFactory('javascript', {
+        async createDebugAdapterDescriptor() {
+            const websocket = new WebSocket('ws://localhost:5555');
+
+            await new Promise((resolve, reject) => {
+                websocket.onopen = resolve;
+                websocket.onerror = () =>
+                    reject(new Error('Unable to connect to debugger server. Run `npm run start:debugServer`'));
+            });
+
+            websocket.send(
+                JSON.stringify({
+                    main: '/workspace/test.js',
+                    files: {
+                        '/workspace/test.js': new TextDecoder().decode(
+                            await api.workspace.fs.readFile(
+                                api.Uri.file('/workspace/test.js')
+                            )
+                        )
+                    }
+                })
+            );
+
+            const adapter = new WebsocketDebugAdapter(websocket);
+
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            adapter.onDidSendMessage((message: any) => {
+                if (message.type === 'event' && message.event === 'output') {
+                    console.log('OUTPUT', message.body.output);
+                }
+            });
+            return new api.DebugAdapterInlineImplementation(adapter);
+        }
+    });
+};
diff --git a/packages/examples/src/debugger/server/debugServer.ts b/packages/examples/src/debugger/server/debugServer.ts
@@ -3,7 +3,7 @@
  * Licensed under the MIT License. See LICENSE in the package root for license information.
  * ------------------------------------------------------------------------------------------ */
 
-// this is derived from:
+// This is derived from:
 // https://github.com/CodinGame/monaco-vscode-api/blob/main/demo/src/debugServer.ts
 // the major difference is that the debug server runs already inside the container
 
@@ -125,6 +125,7 @@ wss.on('connection', (ws) => {
     ws.on(
         'message',
         sequential(async (message: string) => {
+            console.log('Received message', message);
             if (!initialized) {
                 try {
                     initialized = true;
diff --git a/packages/examples/src/python/client/config.ts b/packages/examples/src/python/client/config.ts
@@ -4,14 +4,30 @@
  * ------------------------------------------------------------------------------------------ */
 
 import * as vscode from 'vscode';
+import getConfigurationServiceOverride from '@codingame/monaco-vscode-configuration-service-override';
+import getDebugServiceOverride from '@codingame/monaco-vscode-debug-service-override';
 import getKeybindingsServiceOverride from '@codingame/monaco-vscode-keybindings-service-override';
+import getLifecycleServiceOverride from '@codingame/monaco-vscode-lifecycle-service-override';
+import getLocalizationServiceOverride from '@codingame/monaco-vscode-localization-service-override';
+import getBannerServiceOverride from '@codingame/monaco-vscode-view-banner-service-override';
+import getStatusBarServiceOverride from '@codingame/monaco-vscode-view-status-bar-service-override';
+import getTitleBarServiceOverride from '@codingame/monaco-vscode-view-title-bar-service-override';
+import getExplorerServiceOverride from '@codingame/monaco-vscode-explorer-service-override';
+import getRemoteAgentServiceOverride from '@codingame/monaco-vscode-remote-agent-service-override';
+import getEnvironmentServiceOverride from '@codingame/monaco-vscode-environment-service-override';
+import getSecretStorageServiceOverride from '@codingame/monaco-vscode-secret-storage-service-override';
+import getStorageServiceOverride from '@codingame/monaco-vscode-storage-service-override';
+import getSearchServiceOverride from '@codingame/monaco-vscode-search-service-override';
 import '@codingame/monaco-vscode-python-default-extension';
 import { LogLevel } from '@codingame/monaco-vscode-api';
 import { MonacoLanguageClient } from 'monaco-languageclient';
 import { createUrl } from 'monaco-languageclient/tools';
 import type { WrapperConfig } from 'monaco-editor-wrapper';
 import { toSocket, WebSocketMessageReader, WebSocketMessageWriter } from 'vscode-ws-jsonrpc';
 import { configureMonacoWorkers } from '../../common/client/utils.js';
+import { defaultHtmlAugmentationInstructions, defaultViewsInit } from 'monaco-editor-wrapper/vscode/services';
+import { createDefaultLocaleConfiguration } from 'monaco-languageclient/vscode/services';
+import { provideDebuggerExtensionConfig } from '../../debugger/client/debugger.js';
 
 export const createWrapperConfig = (workspaceRoot: string, code: string, codeUri: string): WrapperConfig => {
     const url = createUrl({
@@ -28,6 +44,8 @@ export const createWrapperConfig = (workspaceRoot: string, code: string, codeUri
     const reader = new WebSocketMessageReader(iWebSocket);
     const writer = new WebSocketMessageWriter(iWebSocket);
 
+    const workspaceFile = vscode.Uri.file('/home/mlc/workspace/.vscode/workspace.code-workspace');
+
     return {
         $type: 'extended',
         htmlContainer: document.getElementById('monaco-editor-root')!,
@@ -66,7 +84,25 @@ export const createWrapperConfig = (workspaceRoot: string, code: string, codeUri
         },
         vscodeApiConfig: {
             serviceOverrides: {
-                ...getKeybindingsServiceOverride()
+                ...getConfigurationServiceOverride(),
+                ...getKeybindingsServiceOverride(),
+                ...getLifecycleServiceOverride(),
+                ...getLocalizationServiceOverride(createDefaultLocaleConfiguration()),
+                ...getBannerServiceOverride(),
+                ...getStatusBarServiceOverride(),
+                ...getTitleBarServiceOverride(),
+                ...getExplorerServiceOverride(),
+                ...getRemoteAgentServiceOverride(),
+                ...getEnvironmentServiceOverride(),
+                ...getSecretStorageServiceOverride(),
+                ...getStorageServiceOverride(),
+                ...getSearchServiceOverride(),
+                ...getDebugServiceOverride()
+            },
+            viewsConfig: {
+                viewServiceType: 'ViewsService',
+                htmlAugmentationInstructions: defaultHtmlAugmentationInstructions,
+                viewsInitFunc: defaultViewsInit
             },
             userConfiguration: {
                 json: JSON.stringify({
@@ -75,8 +111,46 @@ export const createWrapperConfig = (workspaceRoot: string, code: string, codeUri
                     'editor.wordBasedSuggestions': 'off',
                     'editor.experimental.asyncTokenization': true
                 })
-            }
+            },
+            workspaceConfig: {
+                enableWorkspaceTrust: true,
+                windowIndicator: {
+                    label: 'mlc-python-example',
+                    tooltip: '',
+                    command: ''
+                },
+                workspaceProvider: {
+                    trusted: true,
+                    async open() {
+                        window.open(window.location.href);
+                        return true;
+                    },
+                    workspace: {
+                        workspaceUri: workspaceFile
+                    }
+                },
+                configurationDefaults: {
+                    'window.title': 'mlc-python-example${separator}${dirty}${activeEditorShort}'
+                },
+                productConfiguration: {
+                    nameShort: 'mlc-python-example',
+                    nameLong: 'mlc-python-example'
+                }
+            },
         },
+        extensions: [
+            {
+                config: {
+                    name: 'mlc-app-playground',
+                    publisher: 'TypeFox',
+                    version: '1.0.0',
+                    engines: {
+                        vscode: '*'
+                    }
+                }
+            },
+            provideDebuggerExtensionConfig()
+        ],
         editorAppConfig: {
             codeResources: {
                 modified: {
diff --git a/packages/examples/src/python/client/main.ts b/packages/examples/src/python/client/main.ts
@@ -7,10 +7,13 @@ import * as vscode from 'vscode';
 // this is required syntax highlighting
 import '@codingame/monaco-vscode-python-default-extension';
 import { RegisteredFileSystemProvider, registerFileSystemOverlay, RegisteredMemoryFile } from '@codingame/monaco-vscode-files-service-override';
+import { type RegisterLocalProcessExtensionResult } from '@codingame/monaco-vscode-api/extensions';
 import { MonacoEditorLanguageClientWrapper } from 'monaco-editor-wrapper';
 import { createWrapperConfig } from './config.js';
+import '../../debugger/client/debugger.js';
 import helloPyCode from '../../../resources/python/hello.py?raw';
 import hello2PyCode from '../../../resources/python/hello2.py?raw';
+import { confiugureDebugging } from '../../debugger/client/debugger.js';
 
 export const runPythonWrapper = async () => {
     const helloPyUri = vscode.Uri.file('/workspace/hello.py');
@@ -30,6 +33,10 @@ export const runPythonWrapper = async () => {
                 console.warn('Editor was already started!');
             } else {
                 await wrapper.init(wrapperConfig);
+                const initResult = wrapper.getExtensionRegisterResult('debugger-py-client') as RegisterLocalProcessExtensionResult | undefined;
+                if (initResult !== undefined) {
+                    confiugureDebugging(await initResult.getApi());
+                }
 
                 // open files, so the LS can pick it up
                 await vscode.workspace.openTextDocument(hello2PyUri);

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,6 @@`
`39`	`39`	`"tsx": "~4.19.2"`
`40`	`40`	`},`
`41`	`41`	`"scripts": {`
`42`		`- "start": "npm i && vite-node src/debugServer.ts"`
	`42`	`+ "start": "npm i && tsx src/debugServer.ts"`
`43`	`43`	`}`
`44`	`44`	`}`