feat: add "Show Logs" command to help with network debugging

Author: kylecarbs

package.json

@@ -168,6 +168,12 @@
         "title": "Coder: Refresh Workspace",
         "icon": "$(refresh)",
         "when": "coder.authenticated"
+      },
+      {
+        "command": "coder.viewLogs",
+        "title": "Coder: View Logs",
+        "icon": "$(list-unordered)",
+        "when": "coder.authenticated"
       }
     ],
     "menus": {

src/commands.ts

@@ -115,6 +115,17 @@ export class Commands {
     }
   }
 
+  // viewLogs opens the workspace logs.
+  public async viewLogs(): Promise<void> {
+    if (!this.storage.workspaceLogPath) {
+      vscode.window.showInformationMessage("No logs available.", this.storage.workspaceLogPath || "<unset>")
+      return
+    }
+    const uri = vscode.Uri.file(this.storage.workspaceLogPath)
+    const doc = await vscode.workspace.openTextDocument(uri)
+    await vscode.window.showTextDocument(doc)
+  }
+
   public async logout(): Promise<void> {
     await this.storage.setURL(undefined)
     await this.storage.setSessionToken(undefined)

src/extension.ts

@@ -157,6 +157,7 @@ export async function activate(ctx: vscode.ExtensionContext): Promise<void> {
     myWorkspacesProvider.fetchAndRefresh()
     allWorkspacesProvider.fetchAndRefresh()
   })
+  vscode.commands.registerCommand("coder.viewLogs", commands.viewLogs.bind(commands))
 
   // Since the "onResolveRemoteAuthority:ssh-remote" activation event exists
   // in package.json we're able to perform actions before the authority is

src/remote.ts

@@ -76,10 +76,11 @@ export class Remote {
       await this.closeRemote()
       return
     }
+    // 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.
     const hasCoderLogs = (parsedVersion?.compare("2.3.3") || 0) >= 0 || parsedVersion?.prerelease[0] === "devel"
 
-    console.log("hasCoderLogs", hasCoderLogs)
-
     // Find the workspace from the URI scheme provided!
     try {
       this.storage.workspace = await getWorkspaceByOwnerAndName(parts[0], parts[1])
@@ -429,14 +430,15 @@ export class Remote {
     //
     // If we didn't write to the SSH config file, connecting would fail with
     // "Host not found".
-    await this.updateSSHConfig(authorityParts[1])
+    await this.updateSSHConfig(authorityParts[1], hasCoderLogs)
 
     this.findSSHProcessID().then((pid) => {
       if (!pid) {
         // TODO: Show an error here!
         return
       }
       disposables.push(this.showNetworkUpdates(pid))
+      this.storage.workspaceLogPath = path.join(this.storage.getLogPath(), `${pid}.log`)
     })
 
     // Register the label formatter again because SSH overrides it!
@@ -459,7 +461,7 @@ export class Remote {
 
   // updateSSHConfig updates the SSH configuration with a wildcard that handles
   // all Coder entries.
-  private async updateSSHConfig(hostName: string) {
+  private async updateSSHConfig(hostName: string, hasCoderLogs = false) {
     let deploymentSSHConfig = defaultSSHConfigResponse
     try {
       const deploymentConfig = await getDeploymentSSHConfig()
@@ -487,21 +489,24 @@ export class Remote {
     // Now override with the user's config.
     const userConfigSSH = vscode.workspace.getConfiguration("coder").get<string[]>("sshConfig") || []
     // Parse the user's config into a Record<string, string>.
-    const userConfig = userConfigSSH.reduce((acc, line) => {
-      let i = line.indexOf("=")
-      if (i === -1) {
-        i = line.indexOf(" ")
+    const userConfig = userConfigSSH.reduce(
+      (acc, line) => {
+        let i = line.indexOf("=")
         if (i === -1) {
-          // This line is malformed. The setting is incorrect, and does not match
-          // the pattern regex in the settings schema.
-          return acc
+          i = line.indexOf(" ")
+          if (i === -1) {
+            // This line is malformed. The setting is incorrect, and does not match
+            // the pattern regex in the settings schema.
+            return acc
+          }
         }
-      }
-      const key = line.slice(0, i)
-      const value = line.slice(i + 1)
-      acc[key] = value
-      return acc
-    }, {} as Record<string, string>)
+        const key = line.slice(0, i)
+        const value = line.slice(i + 1)
+        acc[key] = value
+        return acc
+      },
+      {} as Record<string, string>,
+    )
     const sshConfigOverrides = mergeSSHConfigValues(deploymentSSHConfig, userConfig)
 
     let sshConfigFile = vscode.workspace.getConfiguration().get<string>("remote.SSH.configFile")
@@ -542,12 +547,16 @@ export class Remote {
     if (typeof headerCommand === "string" && headerCommand.trim().length > 0) {
       headerArg = ` --header-command ${escape(headerCommand)}`
     }
-
+    let logArg = ""
+    if (hasCoderLogs) {
+      await fs.mkdir(this.storage.getLogPath(), { recursive: true })
+      logArg = ` --log-dir ${escape(this.storage.getLogPath())}`
+    }
     const sshValues: SSHValues = {
       Host: `${Remote.Prefix}*`,
       ProxyCommand: `${escape(binaryPath)}${headerArg} vscodessh --network-info-dir ${escape(
         this.storage.getNetworkInfoPath(),
-      )} --session-token-file ${escape(this.storage.getSessionTokenPath())} --url-file ${escape(
+      )}${logArg} --session-token-file ${escape(this.storage.getSessionTokenPath())} --url-file ${escape(
         this.storage.getURLPath(),
       )} %h`,
       ConnectTimeout: "0",

src/storage.ts

@@ -15,6 +15,7 @@ import { getHeaderCommand, getHeaders } from "./headers"
 
 export class Storage {
   public workspace?: Workspace
+  public workspaceLogPath?: string
 
   constructor(
     private readonly output: vscode.OutputChannel,
@@ -279,6 +280,12 @@ export class Storage {
     return path.join(this.globalStorageUri.fsPath, "net")
   }
 
+  // getLogPath returns the path where log data from the Coder
+  // agent is stored.
+  public getLogPath(): string {
+    return path.join(this.globalStorageUri.fsPath, "log")
+  }
+
   public getUserSettingsPath(): string {
     return path.join(this.globalStorageUri.fsPath, "..", "..", "..", "User", "settings.json")
   }