Open external URI (#8)

* Fix tsc commands

They were complaining about the -p flag so I removed them since they do
not appear necessary.  I also removed --outDir since that is already
specified in the tsconfig.json.

* Uncapitalize workspace

It does not seem we capitalize it in our docs so this may be more
consistent.

* Handle external URIs

This makes it so we can have an "open in VS Code" button that
automatically launches our extension where it can handle downloading the
binary (todo) then opening the workspace (done).

* Use remote.SSH.configFile when set

Otherwise if it is set (either by the user or an extension like Gitpod)
our configuration will not be picked up since it is in the default
location.  VS Code will not read both the default location and this
location.

Author: code-asher

package.json

@@ -5,7 +5,7 @@
   "description": "Connect VS Code to your Coder Workspaces",
   "repository": "https://github.com/cdr/vscode-coder",
   "preview": true,
-  "version": "0.0.3-dev",
+  "version": "0.0.4",
   "engines": {
     "vscode": "^1.54.0"
   },
@@ -21,6 +21,7 @@
     "Other"
   ],
   "activationEvents": [
+    "onUri",
     "onView:coderWorkspaces"
   ],
   "main": "./dist/extension.js",
@@ -144,8 +145,8 @@
     "watch": "webpack --watch",
     "package": "webpack --mode production --devtool hidden-source-map",
     "lint": "eslint . --ext ts,md",
-    "tsc:compile": "tsc -p . --outDir out",
-    "tsc:watch": "tsc -p -w . --outDir out",
+    "tsc:compile": "tsc",
+    "tsc:watch": "tsc -w",
     "pretest:ci": "npm run tsc:compile",
     "test:ci": "node ./out/test/runTest.js",
     "test": "npm run test:ci",

src/extension.test.ts

@@ -1,5 +1,6 @@
 // import * as assert from "assert"
 // import * as vscode from "vscode"
+// import * as extension from "./extension"
 
 suite("Extension", () => {
   // TODO: these notifications should lead to each other and also show on
@@ -46,4 +47,7 @@ suite("Extension", () => {
 
   // TODO: several links
   test("help and feedback")
+
+  // TODO: how to test notification content?
+  test("uriHandler")
 })

src/extension.ts

@@ -18,6 +18,31 @@ import {
   CoderWorkspaceListItem,
 } from "./workspaces"
 
+export const uriHandler: vscode.UriHandler = {
+  // URIs look like this: vscode://extension-id/action/resource
+  // To manually test this you can use "Open URL" from the command pallete or
+  // use `code --open-url` from the command line.
+  handleUri(uri: vscode.Uri) {
+    // fsPath will be /action/resource.  Remove the leading slash so we can
+    // split on the first non-leading trailing slash which separates the
+    // action from the resource.  The action is not allowed to contain slashes
+    // but the resource can.
+    const [action, resource] = uri.fsPath.replace(/^\//, "").split("/")
+    if (!action || !resource) {
+      vscode.window.showErrorMessage(`URI is malformed: "${uri}"`)
+      return
+    }
+    switch (action) {
+      case "open-workspace":
+        openWorkspace(resource)
+        break
+      default:
+        vscode.window.showErrorMessage(`Unknown action "${action}"`)
+        break
+    }
+  },
+}
+
 export function activate(): void {
   preflightCheckCoderInstalled()
 
@@ -47,6 +72,8 @@ export function activate(): void {
 
   vscode.workspace.registerTextDocumentContentProvider("coder-logs", coderWorkspaceLogsDocumentProvider)
   vscode.workspace.registerTextDocumentContentProvider("coder-inspect", coderWorkspaceInspectDocumentProvider)
+
+  vscode.window.registerUriHandler(uriHandler)
 }
 
 export const outputChannel = vscode.window.createOutputChannel("Coder")

src/utils.test.ts

@@ -44,4 +44,10 @@ suite("Utils", () => {
     assert.strictEqual(await utils.binaryExists("sh"), true)
     assert.strictEqual(await utils.binaryExists("surely-no-binary-named-like-this-exists"), false)
   })
+
+  test("split", () => {
+    assert.deepStrictEqual(utils.split("foo/bar/baz", "/"), ["foo", "bar/baz"])
+    assert.deepStrictEqual(utils.split("foo/", "/"), ["foo", ""])
+    assert.deepStrictEqual(utils.split("foo", "/"), ["foo", ""])
+  })
 })

src/utils.ts

@@ -23,9 +23,21 @@ export const execJSON = async <T>(command: string): Promise<T> => {
   return JSON.parse(output)
 }
 
-// binaryExists returns "true" if the binary is found in $PATH
+/**
+ * Return "true" if the binary is found in $PATH.
+ */
 export const binaryExists = async (bin: string): Promise<boolean> => {
   return new Promise((res) => {
     nodeWhich(bin, (err) => res(!err))
   })
 }
+
+/**
+ * Split a string up to the delimiter.  If the delimiter does not exist the
+ * first item will have all the text and the second item will be an empty
+ * string.
+ */
+export const split = (str: string, delimiter: string): [string, string] => {
+  const index = str.indexOf(delimiter)
+  return index !== -1 ? [str.substring(0, index).trim(), str.substring(index + 1)] : [str, ""]
+}

src/workspaces.ts

@@ -28,29 +28,45 @@ export class CoderWorkspacesProvider implements vscode.TreeDataProvider<CoderWor
 export const rebuildWorkspace = async (name: string): Promise<void> => {
   try {
     await exec(`${coderBinary} envs rebuild ${name} --force`)
-    vscode.window.showInformationMessage(`Rebuilding Coder Workspace "${name}"`)
+    vscode.window.showInformationMessage(`Rebuilding Coder workspace "${name}"`)
   } catch (e) {
-    vscode.window.showErrorMessage(`Failed to rebuild Coder Workspaces: ${e}`)
+    vscode.window.showErrorMessage(`Failed to rebuild Coder workspaces: ${e}`)
   }
 }
 
 export const shutdownWorkspace = async (name: string): Promise<void> => {
   try {
     await exec(`${coderBinary} envs stop ${name}`)
-    vscode.window.showInformationMessage(`Shutting down Coder Workspace "${name}"`)
+    vscode.window.showInformationMessage(`Shutting down Coder workspace "${name}"`)
   } catch (e) {
-    vscode.window.showErrorMessage(`Failed to shutdown Coder Workspaces: ${e}`)
+    vscode.window.showErrorMessage(`Failed to shutdown Coder workspaces: ${e}`)
   }
 }
 
+/**
+ * Inject Coder hosts into the SSH config file.
+ *
+ * If `remote.SSH.configFile` is set use that otherwise use the default.
+ */
+const setupSSH = async (): Promise<void> => {
+  const configFile = vscode.workspace.getConfiguration("remote.SSH").get("configFile")
+  await exec(`${coderBinary} config-ssh ${configFile ? `--filepath ${configFile}` : ""}`)
+}
+
 export const openWorkspace = async (name: string): Promise<void> => {
   try {
-    await exec(
-      `${coderBinary} config-ssh && code --remote "ssh-remote+coder.${name}" $(${coderBinary} sh ${name} pwd | head -n 1)`,
+    await setupSSH()
+    // If the provided workspace does not exist this is the point at which we
+    // will find out because `coder sh` will exit with 1 causing the exec to
+    // reject (piping should be avoided since the exit code is swallowed).
+    const pwd = (await exec(`${coderBinary} sh ${name} pwd`)).trim() || "/"
+    vscode.window.showInformationMessage(`Opening Coder workspace ${name} to ${pwd}`)
+    await vscode.commands.executeCommand(
+      "vscode.openFolder",
+      vscode.Uri.parse(`vscode-remote://ssh-remote+coder.${name}${pwd}`),
     )
-    vscode.window.showInformationMessage(`Opening Coder Workspace ${name}`)
   } catch (e) {
-    vscode.window.showErrorMessage(`Failed to open Coder Workspace ${name}: ${e}`)
+    vscode.window.showErrorMessage(`Failed to open Coder workspace ${name}: ${e}`)
   }
   return
 }