chore: add additional logging around resource and memory useage

package.json

@@ -4,7 +4,7 @@
   "displayName": "Coder",
   "description": "Open any workspace with a single click.",
   "repository": "https://github.com/coder/vscode-coder",
-  "version": "1.7.0",
+  "version": "1.7.0-debug.1",
   "engines": {
     "vscode": "^1.73.0"
   },

src/extension.ts

@@ -7,12 +7,27 @@ import { makeCoderSdk, needToken } from "./api"
 import { errToStr } from "./api-helper"
 import { Commands } from "./commands"
 import { CertificateError, getErrorDetail } from "./error"
+import { getMemoryLogger } from "./memoryLogger"
 import { Remote } from "./remote"
 import { Storage } from "./storage"
 import { toSafeHost } from "./util"
 import { WorkspaceQuery, WorkspaceProvider } from "./workspacesProvider"
 
 export async function activate(ctx: vscode.ExtensionContext): Promise<void> {
+  // Initialize the memory logger right when the extension starts.
+  const logger = getMemoryLogger()
+  await logger.initLogFile(ctx.globalStorageUri.fsPath)
+
+  // Log initial memory usage and activation
+  logger.info("CODER extension activating")
+  logger.logMemoryUsage("EXTENSION_ACTIVATE")
+
+  // Register disposal of the logger when the extension deactivates
+  ctx.subscriptions.push({ dispose: () => logger.dispose() })
+
+  // Log extension mode
+  logger.info(`Extension mode: ${extensionModeToString(ctx.extensionMode)}`)
+
   // The Remote SSH extension's proposed APIs are used to override the SSH host
   // name in VS Code itself. It's visually unappealing having a lengthy name!
   //
@@ -25,9 +40,13 @@ export async function activate(ctx: vscode.ExtensionContext): Promise<void> {
     vscode.extensions.getExtension("codeium.windsurf-remote-openssh") ||
     vscode.extensions.getExtension("ms-vscode-remote.remote-ssh")
   if (!remoteSSHExtension) {
+    logger.error("Remote SSH extension not found, cannot activate Coder extension")
     vscode.window.showErrorMessage("Remote SSH extension not found, cannot activate Coder extension")
     throw new Error("Remote SSH extension not found")
   }
+
+  logger.info(`Found Remote SSH extension: ${remoteSSHExtension.id}`)
+
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const vscodeProposed: typeof vscode = (module as any)._load(
     "vscode",
@@ -281,4 +300,25 @@ export async function activate(ctx: vscode.ExtensionContext): Promise<void> {
       }
     }
   }
+
+  logger.info("Coder extension activation complete")
+}
+
+function extensionModeToString(mode: vscode.ExtensionMode): string {
+  switch (mode) {
+    case vscode.ExtensionMode.Development:
+      return "Development"
+    case vscode.ExtensionMode.Production:
+      return "Production"
+    case vscode.ExtensionMode.Test:
+      return "Test"
+    default:
+      return `Unknown (${mode})`
+  }
+}
+
+export function deactivate(): void {
+  const logger = getMemoryLogger()
+  logger.info("Coder extension deactivating")
+  logger.logMemoryUsage("EXTENSION_DEACTIVATE")
 }

src/inbox.ts

@@ -5,6 +5,7 @@ import * as vscode from "vscode"
 import { WebSocket } from "ws"
 import { coderSessionTokenHeader } from "./api"
 import { errToStr } from "./api-helper"
+import { getMemoryLogger } from "./memoryLogger"
 import { type Storage } from "./storage"
 
 // These are the template IDs of our notifications.
@@ -17,9 +18,17 @@ export class Inbox implements vscode.Disposable {
   readonly #storage: Storage
   #disposed = false
   #socket: WebSocket
+  #messageCount = 0
+  #workspaceId: string
+  #memoryInterval: NodeJS.Timeout
 
   constructor(workspace: Workspace, httpAgent: ProxyAgent, restClient: Api, storage: Storage) {
+    const logger = getMemoryLogger()
     this.#storage = storage
+    this.#workspaceId = workspace.id
+
+    logger.trackResourceCreated("InboxWebSocket", workspace.id)
+    logger.info(`Creating inbox for workspace: ${workspace.owner_name}/${workspace.name} (${workspace.id})`)
 
     const baseUrlRaw = restClient.getAxiosInstance().defaults.baseURL
     if (!baseUrlRaw) {
@@ -38,6 +47,8 @@ export class Inbox implements vscode.Disposable {
     const socketProto = baseUrl.protocol === "https:" ? "wss:" : "ws:"
     const socketUrl = `${socketProto}//${baseUrl.host}/api/v2/notifications/inbox/watch?format=plaintext&templates=${watchTemplatesParam}&targets=${watchTargetsParam}`
 
+    logger.debug(`Connecting to inbox WebSocket at: ${socketUrl}`)
+
     const token = restClient.getAxiosInstance().defaults.headers.common[coderSessionTokenHeader] as string | undefined
     this.#socket = new WebSocket(new URL(socketUrl), {
       agent: httpAgent,
@@ -50,35 +61,74 @@ export class Inbox implements vscode.Disposable {
     })
 
     this.#socket.on("open", () => {
+      logger.info(`Inbox WebSocket connection opened for workspace: ${workspace.id}`)
       this.#storage.writeToCoderOutputChannel("Listening to Coder Inbox")
     })
 
     this.#socket.on("error", (error) => {
+      logger.error(`Inbox WebSocket error for workspace: ${workspace.id}`, error)
       this.notifyError(error)
       this.dispose()
     })
 
+    this.#socket.on("close", (code, reason) => {
+      logger.info(`Inbox WebSocket closed for workspace: ${workspace.id}, code: ${code}, reason: ${reason || "none"}`)
+      if (!this.#disposed) {
+        this.dispose()
+      }
+    })
+
     this.#socket.on("message", (data) => {
+      this.#messageCount++
+
+      // Log periodic message stats
+      if (this.#messageCount % 10 === 0) {
+        logger.info(`Inbox received ${this.#messageCount} messages for workspace: ${workspace.id}`)
+        logger.logMemoryUsage("INBOX_WEBSOCKET")
+      }
+
       try {
         const inboxMessage = JSON.parse(data.toString()) as GetInboxNotificationResponse
-
+        logger.debug(`Inbox notification received: ${inboxMessage.notification.title}`)
         vscode.window.showInformationMessage(inboxMessage.notification.title)
       } catch (error) {
+        logger.error(`Error processing inbox message for workspace: ${workspace.id}`, error)
         this.notifyError(error)
       }
     })
+
+    // Log memory stats periodically
+    this.#memoryInterval = setInterval(
+      () => {
+        if (!this.#disposed) {
+          logger.logMemoryUsage("INBOX_PERIODIC")
+        } else {
+          clearInterval(this.#memoryInterval)
+        }
+      },
+      5 * 60 * 1000,
+    ) // Every 5 minutes
   }
 
   dispose() {
+    const logger = getMemoryLogger()
+
     if (!this.#disposed) {
+      logger.info(`Disposing inbox for workspace: ${this.#workspaceId} after ${this.#messageCount} messages`)
       this.#storage.writeToCoderOutputChannel("No longer listening to Coder Inbox")
       this.#socket.close()
       this.#disposed = true
+      logger.trackResourceDisposed("InboxWebSocket", this.#workspaceId)
     }
+
+    clearInterval(this.#memoryInterval)
   }
 
   private notifyError(error: unknown) {
+    const logger = getMemoryLogger()
     const message = errToStr(error, "Got empty error while monitoring Coder Inbox")
+
+    logger.error(`Inbox error for workspace: ${this.#workspaceId}`, error)
     this.#storage.writeToCoderOutputChannel(message)
   }
 }