Migrate "session_token" file to "session", add --global-config flag to "coder start"

Author: Aaron Lehmann

src/api.ts

@@ -125,6 +125,7 @@ export async function makeCoderSdk(baseUrl: string, token: string | undefined, s
  */
 export async function startWorkspaceIfStoppedOrFailed(
   restClient: Api,
+  globalConfigDir: string,
   binPath: string,
   workspace: Workspace,
   writeEmitter: vscode.EventEmitter<string>,
@@ -137,7 +138,13 @@ export async function startWorkspaceIfStoppedOrFailed(
   }
 
   return new Promise((resolve, reject) => {
-    const startArgs = ["start", "--yes", workspace.owner_name + "/" + workspace.name]
+    const startArgs = [
+      "--global-config",
+      globalConfigDir,
+      "start",
+      "--yes",
+      workspace.owner_name + "/" + workspace.name,
+    ]
     const startProcess = spawn(binPath, startArgs)
 
     startProcess.stdout.on("data", (data: Buffer) => {

src/remote.ts

@@ -53,6 +53,7 @@ export class Remote {
   private async maybeWaitForRunning(
     restClient: Api,
     workspace: Workspace,
+    label: string,
     binPath: string,
   ): Promise<Workspace | undefined> {
     // Maybe already running?
@@ -98,6 +99,7 @@ export class Remote {
           title: "Waiting for workspace build...",
         },
         async () => {
+          const globalConfigDir = path.dirname(this.storage.getSessionTokenPath(label))
           while (workspace.latest_build.status !== "running") {
             ++attempts
             switch (workspace.latest_build.status) {
@@ -114,7 +116,13 @@ export class Remote {
                 }
                 writeEmitter = initWriteEmitterAndTerminal()
                 this.storage.writeToCoderOutputChannel(`Starting ${workspaceName}...`)
-                workspace = await startWorkspaceIfStoppedOrFailed(restClient, binPath, workspace, writeEmitter)
+                workspace = await startWorkspaceIfStoppedOrFailed(
+                  restClient,
+                  globalConfigDir,
+                  binPath,
+                  workspace,
+                  writeEmitter,
+                )
                 break
               case "failed":
                 // On a first attempt, we will try starting a failed workspace
@@ -125,7 +133,13 @@ export class Remote {
                   }
                   writeEmitter = initWriteEmitterAndTerminal()
                   this.storage.writeToCoderOutputChannel(`Starting ${workspaceName}...`)
-                  workspace = await startWorkspaceIfStoppedOrFailed(restClient, binPath, workspace, writeEmitter)
+                  workspace = await startWorkspaceIfStoppedOrFailed(
+                    restClient,
+                    globalConfigDir,
+                    binPath,
+                    workspace,
+                    writeEmitter,
+                  )
                   break
                 }
               // Otherwise fall through and error.
@@ -167,6 +181,9 @@ export class Remote {
 
     const workspaceName = `${parts.username}/${parts.workspace}`
 
+    // Migrate "session_token" file to "session", if needed.
+    this.storage.migrateSessionToken(parts.label)
+
     // Get the URL and token belonging to this host.
     const { url: baseUrlRaw, token } = await this.storage.readCliConfig(parts.label)
 
@@ -303,7 +320,7 @@ export class Remote {
     disposables.push(this.registerLabelFormatter(remoteAuthority, workspace.owner_name, workspace.name))
 
     // If the workspace is not in a running state, try to get it running.
-    const updatedWorkspace = await this.maybeWaitForRunning(workspaceRestClient, workspace, binaryPath)
+    const updatedWorkspace = await this.maybeWaitForRunning(workspaceRestClient, workspace, parts.label, binaryPath)
     if (!updatedWorkspace) {
       // User declined to start the workspace.
       await this.closeRemote()

src/storage.ts

@@ -405,6 +405,20 @@ export class Storage {
    * The caller must ensure this directory exists before use.
    */
   public getSessionTokenPath(label: string): string {
+    return label
+      ? path.join(this.globalStorageUri.fsPath, label, "session")
+      : path.join(this.globalStorageUri.fsPath, "session")
+  }
+
+  /**
+   * Return the directory for the deployment with the provided label to where
+   * its session token was stored by older code.
+   *
+   * If the label is empty, read the old deployment-unaware config instead.
+   *
+   * The caller must ensure this directory exists before use.
+   */
+  public getLegacySessionTokenPath(label: string): string {
     return label
       ? path.join(this.globalStorageUri.fsPath, label, "session_token")
       : path.join(this.globalStorageUri.fsPath, "session_token")
@@ -488,6 +502,24 @@ export class Storage {
     }
   }
 
+  /**
+   * Migrate the session token file from "session_token" to "session", if needed.
+   */
+  public async migrateSessionToken(label: string) {
+    const oldTokenPath = this.getLegacySessionTokenPath(label)
+    try {
+      await fs.stat(oldTokenPath)
+      const newTokenPath = this.getSessionTokenPath(label)
+      await fs.rename(oldTokenPath, newTokenPath)
+      return
+    } catch (error) {
+      if ((error as NodeJS.ErrnoException)?.code === "ENOENT") {
+        return
+      }
+      throw error
+    }
+  }
+
   /**
    * Run the header command and return the generated headers.
    */