use featureset object

bcpeinhardt · bcpeinhardt · commit da073b66aaf9 · 2024-07-26T00:03:46.000Z
diff --git a/src/featureSet.ts b/src/featureSet.ts
@@ -0,0 +1,21 @@
+import * as semver from "semver"
+
+export type FeatureSet = {
+  coderExtension: boolean
+  proxyLogDirectory: boolean
+}
+
+/**
+ * Builds and returns a FeatureSet object for a given coder version.
+ */
+export function featureSetForVersion(version: semver.SemVer | null): FeatureSet {
+  return {
+    coderExtension:
+      version?.major === 0 && version?.minor <= 14 && version?.patch < 1 && version?.prerelease.length === 0,
+
+    // CLI versions before 2.3.3 don't support the --log-dir flag!
+    // If this check didn't exist, VS Code connections would fail on
+    // older versions because of an unknown CLI argument.
+    proxyLogDirectory: (version?.compare("2.3.3") || 0) > 0 || version?.prerelease[0] === "devel",
+  }
+}
diff --git a/src/remote.ts b/src/remote.ts
@@ -14,12 +14,12 @@ import { makeCoderSdk, startWorkspace, waitForBuild } from "./api"
 import { extractAgents } from "./api-helper"
 import * as cli from "./cliManager"
 import { Commands } from "./commands"
+import { featureSetForVersion, FeatureSet } from "./featureSet"
 import { getHeaderCommand } from "./headers"
 import { SSHConfig, SSHValues, mergeSSHConfigValues } from "./sshConfig"
 import { computeSSHProperties, sshSupportsSetEnv } from "./sshSupport"
 import { Storage } from "./storage"
 import { AuthorityPrefix, expandPath, parseRemoteAuthority } from "./util"
-import { supportsCoderAgentLogDirFlag } from "./version"
 import { WorkspaceAction } from "./workspaceAction"
 
 export interface RemoteDetails extends vscode.Disposable {
@@ -34,7 +34,6 @@ export class Remote {
     private readonly storage: Storage,
     private readonly commands: Commands,
     private readonly mode: vscode.ExtensionMode,
-    private coderVersion: semver.SemVer | null = null,
   ) {}
 
   private async confirmStart(workspaceName: string): Promise<boolean> {
@@ -195,16 +194,38 @@ export class Remote {
     // Store for use in commands.
     this.commands.workspaceRestClient = workspaceRestClient
 
+    let binaryPath: string | undefined
+    if (this.mode === vscode.ExtensionMode.Production) {
+      binaryPath = await this.storage.fetchBinary(workspaceRestClient, parts.label)
+    } else {
+      try {
+        // In development, try to use `/tmp/coder` as the binary path.
+        // This is useful for debugging with a custom bin!
+        binaryPath = path.join(os.tmpdir(), "coder")
+        await fs.stat(binaryPath)
+      } catch (ex) {
+        binaryPath = await this.storage.fetchBinary(workspaceRestClient, parts.label)
+      }
+    }
+
     // First thing is to check the version.
     const buildInfo = await workspaceRestClient.getBuildInfo()
-    this.coderVersion = semver.parse(buildInfo.version)
+
+    let version: semver.SemVer | null = null
+    try {
+      let v = await cli.version(binaryPath)
+      if (!v) {
+        v = buildInfo.version
+      }
+      version = semver.parse(v)
+    } catch (e) {
+      version = semver.parse(buildInfo.version)
+    }
+
+    const featureSet = featureSetForVersion(version)
+
     // Server versions before v0.14.1 don't support the vscodessh command!
-    if (
-      this.coderVersion?.major === 0 &&
-      this.coderVersion?.minor <= 14 &&
-      this.coderVersion?.patch < 1 &&
-      this.coderVersion?.prerelease.length === 0
-    ) {
+    if (featureSet.coderExtension) {
       await this.vscodeProposed.window.showErrorMessage(
         "Incompatible Server",
         {
@@ -502,7 +523,7 @@ export class Remote {
     // "Host not found".
     try {
       this.storage.writeToCoderOutputChannel("Updating SSH config...")
-      await this.updateSSHConfig(workspaceRestClient, parts.label, parts.host)
+      await this.updateSSHConfig(workspaceRestClient, parts.label, parts.host, binaryPath, featureSet)
     } catch (error) {
       this.storage.writeToCoderOutputChannel(`Failed to configure SSH: ${error}`)
       throw error
@@ -542,28 +563,11 @@ export class Remote {
     }
   }
 
-  /**
-   * Tries to get the install CLI version. If that fails, defaults
-   * to the remote coder version. For the most part these should be in sync.
-   */
-  private async probableCoderVersion(binaryPath: string): Promise<semver.SemVer | null> {
-    try {
-      const version = await cli.version(binaryPath)
-      const parsedVersion = semver.parse(version)
-      if (!parsedVersion) {
-        return this.coderVersion
-      }
-      return parsedVersion
-    } catch (e) {
-      return this.coderVersion
-    }
-  }
-
   /**
    * Format's the --log-dir argument for the ProxyCommand
    */
-  private async formatLogArg(binpath: string): Promise<string> {
-    if (!supportsCoderAgentLogDirFlag(await this.probableCoderVersion(binpath))) {
+  private async formatLogArg(featureSet: FeatureSet): Promise<string> {
+    if (!featureSet.proxyLogDirectory) {
       return ""
     }
 
@@ -581,7 +585,13 @@ export class Remote {
 
   // updateSSHConfig updates the SSH configuration with a wildcard that handles
   // all Coder entries.
-  private async updateSSHConfig(restClient: Api, label: string, hostName: string) {
+  private async updateSSHConfig(
+    restClient: Api,
+    label: string,
+    hostName: string,
+    binaryPath: string,
+    featureSet: FeatureSet,
+  ) {
     let deploymentSSHConfig = {}
     try {
       const deploymentConfig = await restClient.getDeploymentSSHConfig()
@@ -642,20 +652,6 @@ export class Remote {
     const sshConfig = new SSHConfig(sshConfigFile)
     await sshConfig.load()
 
-    let binaryPath: string | undefined
-    if (this.mode === vscode.ExtensionMode.Production) {
-      binaryPath = await this.storage.fetchBinary(restClient, label)
-    } else {
-      try {
-        // In development, try to use `/tmp/coder` as the binary path.
-        // This is useful for debugging with a custom bin!
-        binaryPath = path.join(os.tmpdir(), "coder")
-        await fs.stat(binaryPath)
-      } catch (ex) {
-        binaryPath = await this.storage.fetchBinary(restClient, label)
-      }
-    }
-
     const escape = (str: string): string => `"${str.replace(/"/g, '\\"')}"`
     // Escape a command line to be executed by the Coder binary, so ssh doesn't substitute variables.
     const escapeSubcommand: (str: string) => string =
@@ -677,7 +673,7 @@ export class Remote {
       Host: label ? `${AuthorityPrefix}.${label}--*` : `${AuthorityPrefix}--*`,
       ProxyCommand: `${escape(binaryPath)}${headerArg} vscodessh --network-info-dir ${escape(
         this.storage.getNetworkInfoPath(),
-      )}${await this.formatLogArg(binaryPath)} --session-token-file ${escape(this.storage.getSessionTokenPath(label))} --url-file ${escape(
+      )}${await this.formatLogArg(featureSet)} --session-token-file ${escape(this.storage.getSessionTokenPath(label))} --url-file ${escape(
         this.storage.getUrlPath(label),
       )} %h`,
       ConnectTimeout: "0",
