Merge branch 'main' into show-agent-metadata

rodrimaia · rodrimaia · commit e58a26b682ba · 2023-05-05T18:27:41.000-03:00
diff --git a/package.json b/package.json
@@ -4,7 +4,7 @@
   "displayName": "Coder Remote",
   "description": "Open any workspace with a single click.",
   "repository": "https://github.com/coder/vscode-coder",
-  "version": "0.1.17",
+  "version": "0.1.18",
   "engines": {
     "vscode": "^1.73.0"
   },
diff --git a/src/commands.ts b/src/commands.ts
@@ -217,7 +217,7 @@ export class Commands {
       if (agents.length === 1) {
         folderPath = agents[0].expanded_directory
         workspaceAgent = agents[0].name
-      } else {
+      } else if (agents.length > 0) {
         const agentQuickPick = vscode.window.createQuickPick()
         agentQuickPick.title = `Select an agent`
 
diff --git a/src/remote.ts b/src/remote.ts
@@ -21,7 +21,7 @@ import * as vscode from "vscode"
 import * as ws from "ws"
 import { z } from "zod"
 import { SSHConfig, SSHValues, defaultSSHConfigResponse, mergeSSHConfigValues } from "./sshConfig"
-import { sshSupportsSetEnv } from "./sshSupport"
+import { computeSSHProperties, sshSupportsSetEnv } from "./sshSupport"
 import { Storage } from "./storage"
 
 export class Remote {
@@ -123,7 +123,9 @@ export class Remote {
 
     const disposables: vscode.Disposable[] = []
     // Register before connection so the label still displays!
-    disposables.push(this.registerLabelFormatter(`${this.storage.workspace.owner_name}/${this.storage.workspace.name}`))
+    disposables.push(
+      this.registerLabelFormatter(remoteAuthority, this.storage.workspace.owner_name, this.storage.workspace.name),
+    )
 
     let buildComplete: undefined | (() => void)
     if (this.storage.workspace.latest_build.status === "stopped") {
@@ -409,7 +411,7 @@ export class Remote {
     //
     // If we didn't write to the SSH config file, connecting would fail with
     // "Host not found".
-    await this.updateSSHConfig()
+    await this.updateSSHConfig(authorityParts[1])
 
     this.findSSHProcessID().then((pid) => {
       if (!pid) {
@@ -420,14 +422,11 @@ export class Remote {
     })
 
     // Register the label formatter again because SSH overrides it!
-    let label = `${this.storage.workspace.owner_name}/${this.storage.workspace.name}`
-    if (agents.length > 1) {
-      label += `/${agent.name}`
-    }
-
+    const workspace = this.storage.workspace
+    const agentName = agents.length > 1 ? agent.name : undefined
     disposables.push(
       vscode.extensions.onDidChange(() => {
-        disposables.push(this.registerLabelFormatter(label))
+        disposables.push(this.registerLabelFormatter(remoteAuthority, workspace.owner_name, workspace.name, agentName))
       }),
     )
 
@@ -506,7 +505,7 @@ export class Remote {
 
   // updateSSHConfig updates the SSH configuration with a wildcard that handles
   // all Coder entries.
-  private async updateSSHConfig() {
+  private async updateSSHConfig(hostName: string) {
     let deploymentSSHConfig = defaultSSHConfigResponse
     try {
       const deploymentConfig = await getDeploymentSSHConfig()
@@ -594,6 +593,34 @@ export class Remote {
     }
 
     await sshConfig.update(sshValues, sshConfigOverrides)
+
+    // A user can provide a "Host *" entry in their SSH config to add options
+    // to all hosts. We need to ensure that the options we set are not
+    // overridden by the user's config.
+    const computedProperties = computeSSHProperties(hostName, sshConfig.getRaw())
+    const keysToMatch: Array<keyof SSHValues> = ["ProxyCommand", "UserKnownHostsFile", "StrictHostKeyChecking"]
+    for (let i = 0; i < keysToMatch.length; i++) {
+      const key = keysToMatch[i]
+      if (computedProperties[key] === sshValues[key]) {
+        continue
+      }
+
+      const result = await this.vscodeProposed.window.showErrorMessage(
+        "Unexpected SSH Config Option",
+        {
+          useCustom: true,
+          modal: true,
+          detail: `Your SSH config is overriding the "${key}" property to "${computedProperties[key]}" when it expected "${sshValues[key]}" for the "${hostName}" host. Please fix this and try again!`,
+        },
+        "Reload Window",
+      )
+      if (result === "Reload Window") {
+        await this.reloadWindow()
+      }
+      await this.closeRemote()
+    }
+
+    return sshConfig.getRaw()
   }
 
   // showNetworkUpdates finds the SSH process ID that is being used by this
@@ -744,14 +771,34 @@ export class Remote {
     await vscode.commands.executeCommand("workbench.action.reloadWindow")
   }
 
-  private registerLabelFormatter(suffix: string): vscode.Disposable {
+  private registerLabelFormatter(
+    remoteAuthority: string,
+    owner: string,
+    workspace: string,
+    agent?: string,
+  ): vscode.Disposable {
+    // VS Code splits based on the separator when displaying the label
+    // in a recently opened dialog. If the workspace suffix contains /,
+    // then it'll visually display weird:
+    // "/home/kyle [Coder: kyle/workspace]" displays as "workspace] /home/kyle [Coder: kyle"
+    // For this reason, we use a different / that visually appears the
+    // same on non-monospace fonts "∕".
+    let suffix = `Coder: ${owner}∕${workspace}`
+    if (agent) {
+      suffix += `∕${agent}`
+    }
+    // VS Code caches resource label formatters in it's global storage SQLite database
+    // under the key "memento/cachedResourceLabelFormatters2".
     return this.vscodeProposed.workspace.registerResourceLabelFormatter({
       scheme: "vscode-remote",
+      // authority is optional but VS Code prefers formatters that most
+      // accurately match the requested authority, so we include it.
+      authority: remoteAuthority,
       formatting: {
         label: "${path}",
         separator: "/",
         tildify: true,
-        workspaceSuffix: `Coder: ${suffix}`,
+        workspaceSuffix: suffix,
       },
     })
   }
diff --git a/src/sshSupport.test.ts b/src/sshSupport.test.ts
@@ -1,8 +1,9 @@
 import { it, expect } from "vitest"
-import { sshSupportsSetEnv, sshVersionSupportsSetEnv } from "./sshSupport"
+import { computeSSHProperties, sshSupportsSetEnv, sshVersionSupportsSetEnv } from "./sshSupport"
 
 const supports = {
   "OpenSSH_8.9p1 Ubuntu-3ubuntu0.1, OpenSSL 3.0.2 15 Mar 2022": true,
+  "OpenSSH_9.0p1, LibreSSL 3.3.6": true,
   "OpenSSH_7.6p1 Ubuntu-4ubuntu0.7, OpenSSL 1.0.2n 7 Dec 2017": false,
   "OpenSSH_7.4p1, OpenSSL 1.0.2k-fips  26 Jan 2017": false,
 }
@@ -16,3 +17,23 @@ Object.entries(supports).forEach(([version, expected]) => {
 it("current shell supports ssh", () => {
   expect(sshSupportsSetEnv()).toBeTruthy()
 })
+
+it("computes the config for a host", () => {
+  const properties = computeSSHProperties(
+    "coder-vscode--testing",
+    `Host *
+  StrictHostKeyChecking yes
+
+# --- START CODER VSCODE ---
+Host coder-vscode--*
+  StrictHostKeyChecking no
+  Another=true
+# --- END CODER VSCODE ---
+`,
+  )
+
+  expect(properties).toEqual({
+    Another: "true",
+    StrictHostKeyChecking: "yes",
+  })
+})
diff --git a/src/sshSupport.ts b/src/sshSupport.ts
@@ -24,13 +24,67 @@ export function sshVersionSupportsSetEnv(sshVersionString: string): boolean {
       return false
     }
     // 7.8 is the first version that supports SetEnv
-    if (Number.parseInt(parts[0], 10) < 7) {
+    const major = Number.parseInt(parts[0], 10)
+    const minor = Number.parseInt(parts[1], 10)
+    if (major < 7) {
       return false
     }
-    if (Number.parseInt(parts[1], 10) < 8) {
+    if (major === 7 && minor < 8) {
       return false
     }
     return true
   }
   return false
 }
+
+// computeSSHProperties accepts an SSH config and a host name and returns
+// the properties that should be set for that host.
+export function computeSSHProperties(host: string, config: string): Record<string, string> {
+  let currentConfig:
+    | {
+        Host: string
+        properties: Record<string, string>
+      }
+    | undefined
+  const configs: Array<typeof currentConfig> = []
+  config.split("\n").forEach((line) => {
+    line = line.trim()
+    if (line === "") {
+      return
+    }
+    const [key, ...valueParts] = line.split(/\s+|=/)
+    if (key.startsWith("#")) {
+      // Ignore comments!
+      return
+    }
+    if (key === "Host") {
+      if (currentConfig) {
+        configs.push(currentConfig)
+      }
+      currentConfig = {
+        Host: valueParts.join(" "),
+        properties: {},
+      }
+      return
+    }
+    if (!currentConfig) {
+      return
+    }
+    currentConfig.properties[key] = valueParts.join(" ")
+  })
+  if (currentConfig) {
+    configs.push(currentConfig)
+  }
+
+  const merged: Record<string, string> = {}
+  configs.reverse().forEach((config) => {
+    if (!config) {
+      return
+    }
+    if (!new RegExp("^" + config?.Host.replace(/\*/g, ".*") + "$").test(host)) {
+      return
+    }
+    Object.assign(merged, config.properties)
+  })
+  return merged
+}
diff --git a/src/storage.ts b/src/storage.ts
@@ -52,7 +52,13 @@ export class Storage {
   }
 
   public async getSessionToken(): Promise<string | undefined> {
-    return this.secrets.get("sessionToken")
+    try {
+      return await this.secrets.get("sessionToken")
+    } catch (ex) {
+      // The VS Code session store has become corrupt before, and
+      // will fail to get the session token...
+      return undefined
+    }
   }
 
   // getRemoteSSHLogPath returns the log path for the "Remote - SSH" output panel.
@@ -264,7 +270,7 @@ export class Storage {
   }
 
   public getUserSettingsPath(): string {
-    return path.join(this.appDataDir(), "Code", "User", "settings.json")
+    return path.join(this.globalStorageUri.fsPath, "..", "..", "..", "User", "settings.json")
   }
 
   public getSessionTokenPath(): string {
@@ -292,19 +298,6 @@ export class Storage {
     })
   }
 
-  private appDataDir(): string {
-    switch (process.platform) {
-      case "darwin":
-        return `${os.homedir()}/Library/Application Support`
-      case "linux":
-        return `${os.homedir()}/.config`
-      case "win32":
-        return process.env.APPDATA || ""
-      default:
-        return "/var/local"
-    }
-  }
-
   private async updateURL(): Promise<void> {
     const url = this.getURL()
     axios.defaults.baseURL = url
