experimental support for Cody as a VS Code Web extension (#424)

Introduces a few "platform" abstractions to make it possible to run Cody as a VS Code Web extension (i.e., running in the web browser at https://vscode.dev or similar). Web extension usage is for internal development and testing only; it is not supported and may be removed at any time. See `vscode/doc/web.md` for information about this experimental, unsupported method for running Cody in VS Code Web. ## Test plan Run `cd vscode && pnpm run watch:dev:web` then open http://localhost:3000 in your web browser. You should see the Cody extension in VS Code Web.
sourcegraph · Jul 28, 2023 · ae16c27 · ae16c27
1 parent 52b465a
commit ae16c27
Show file tree

Hide file tree

Showing 19 changed files with 557 additions and 153 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -2,11 +2,11 @@
   "version": "0.1.0",
   "configurations": [
     {
-      "name": "Launch VS Code Extension",
+      "name": "Launch VS Code Extension (Desktop)",
       "type": "extensionHost",
       "request": "launch",
       "runtimeExecutable": "${execPath}",
-      "preLaunchTask": "Build VS Code Extension",
+      "preLaunchTask": "Build VS Code Extension (Desktop)",
       "args": [
         "--extensionDevelopmentPath=${workspaceRoot}/vscode",
         "--disable-extension=sourcegraph.cody-ai",
@@ -21,11 +21,11 @@
       }
     },
     {
-      "name": "Launch VS Code Extension (Separate Instance)",
+      "name": "Launch VS Code Extension (Desktop; Separate Instance)",
       "type": "extensionHost",
       "request": "launch",
       "runtimeExecutable": "${execPath}",
-      "preLaunchTask": "Build VS Code Extension",
+      "preLaunchTask": "Build VS Code Extension (Desktop)",
       "args": [
         "--user-data-dir=/tmp/vscode-cody-extension-dev-host",
         "--profile-temp",
@@ -42,6 +42,30 @@
         "CODY_DEBUG_ENABLE": "true",
         "CODY_FOCUS_ON_STARTUP": "1"
       }
+    },
+    {
+      "name": "Launch VS Code Extension (Web, in Browser)",
+      "type": "node",
+      "request": "launch",
+      "preLaunchTask": "Build VS Code Extension (Web)",
+      "runtimeExecutable": "pnpm",
+      "runtimeArgs": ["-C", "${workspaceFolder}/vscode", "run", "--silent", "_dev:vscode-test-web"],
+      "outFiles": ["${workspaceFolder}/vscode/dist/**/*.js"]
+    },
+    {
+      "name": "Launch VS Code Extension (Web Extension Host)",
+      "type": "pwa-extensionHost",
+      "debugWebWorkerHost": true,
+      "request": "launch",
+      "preLaunchTask": "Build VS Code Extension (Web)",
+      "outFiles": ["${workspaceFolder}/vscode/dist/**/*.js"],
+      "args": [
+        "--extensionDevelopmentPath=${workspaceRoot}/vscode",
+        "--extensionDevelopmentKind=web",
+        "--disable-extension=sourcegraph.cody-ai",
+        "--disable-extension=github.copilot",
+        "--disable-extension=github.copilot-nightly"
+      ]
     }
   ]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,13 +1,17 @@
 {
   "search.exclude": {
     "**/node_modules": true,
-    "**/dist": true
+    "**/dist": true,
+    "**/.eslintcache": true,
+    "**/.vscode-test": true,
+    "**/.vscode-test-web": true
   },
   "files.exclude": {
     "**/node_modules": true,
     "**/dist": true,
     "**/.eslintcache": true,
-    "**/.vscode-test": true
+    "**/.vscode-test": true,
+    "**/.vscode-test-web": true
   },
   "editor.formatOnSave": true,
   "npm.packageManager": "pnpm",

diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -17,10 +17,19 @@
       }
     },
     {
-      "label": "Build VS Code Extension",
+      "label": "Build VS Code Extension (Desktop)",
       "type": "npm",
       "path": "vscode",
-      "script": "build:dev",
+      "script": "build:dev:desktop",
+      "problemMatcher": "$tsc-watch",
+      "options": { "cwd": "vscode" },
+      "isBackground": true
+    },
+    {
+      "label": "Build VS Code Extension (Web)",
+      "type": "npm",
+      "path": "vscode",
+      "script": "build:dev:web",
       "problemMatcher": "$tsc-watch",
       "options": { "cwd": "vscode" },
       "isBackground": true

diff --git a/doc/dev/index.md b/doc/dev/index.md
@@ -8,7 +8,7 @@
 
 ### Build and run the VS Code extension
 
-Open this repository in VS Code and run the `Launch VS Code Extension` build/debug task (or run `pnpm -C vscode run dev`).
+Open this repository in VS Code and run the `Launch VS Code Extension (Desktop)` build/debug task (or run `pnpm -C vscode run dev`).
 
 See [vscode/CONTRIBUTING.md](../../vscode/CONTRIBUTING.md) for more information.
 

diff --git a/lib/shared/src/sourcegraph-api/completions/browserClient.ts b/lib/shared/src/sourcegraph-api/completions/browserClient.ts
@@ -21,6 +21,7 @@ export class SourcegraphBrowserCompletionsClient extends SourcegraphCompletionsC
             headers: Object.fromEntries(headersInstance.entries()),
             body: JSON.stringify(params),
             signal: abort.signal,
+            openWhenHidden: isRunningInWebWorker, // otherwise tries to call document.addEventListener
             async onopen(response) {
                 if (!response.ok && response.headers.get('content-type') !== 'text/event-stream') {
                     let errorMessage: null | string = null
@@ -59,3 +60,12 @@ export class SourcegraphBrowserCompletionsClient extends SourcegraphCompletionsC
         }
     }
 }
+
+declare const WorkerGlobalScope: never
+const isRunningInWebWorker = typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope
+
+if (isRunningInWebWorker) {
+    // HACK: @microsoft/fetch-event-source tries to call document.removeEventListener, which is not
+    // available in a worker.
+    ;(self as any).document = { removeEventListener: () => {} }
+}