feat: log information regarding network updates

Author: brettkolodny

src/remote.ts

@@ -21,6 +21,7 @@ import { computeSSHProperties, sshSupportsSetEnv } from "./sshSupport"
 import { Storage } from "./storage"
 import { AuthorityPrefix, expandPath, parseRemoteAuthority } from "./util"
 import { WorkspaceMonitor } from "./workspaceMonitor"
+import { getMemoryLogger } from "./memoryLogger"
 
 export interface RemoteDetails extends vscode.Disposable {
   url: string
@@ -688,9 +689,20 @@ export class Remote {
   // showNetworkUpdates finds the SSH process ID that is being used by this
   // workspace and reads the file being created by the Coder CLI.
   private showNetworkUpdates(sshPid: number): vscode.Disposable {
+    const logger = getMemoryLogger()
+    logger.trackResourceCreated("NetworkStatusBar")
+    logger.info(`Starting network updates monitor for SSH PID: ${sshPid}`)
+
     const networkStatus = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, 1000)
+    networkStatus.name = "Coder Workspace Update"
     const networkInfoFile = path.join(this.storage.getNetworkInfoPath(), `${sshPid}.json`)
 
+    logger.debug(`Network info file path: ${networkInfoFile}`)
+
+    let refreshCount = 0
+    let disposed = false
+    let lastFileSize = 0
+
     const updateStatus = (network: {
       p2p: boolean
       latency: number
@@ -699,78 +711,117 @@ export class Remote {
       upload_bytes_sec: number
       download_bytes_sec: number
     }) => {
-      let statusText = "$(globe) "
-      if (network.p2p) {
-        statusText += "Direct "
-        networkStatus.tooltip = "You're connected peer-to-peer ✨."
-      } else {
-        statusText += network.preferred_derp + " "
-        networkStatus.tooltip =
-          "You're connected through a relay 🕵.\nWe'll switch over to peer-to-peer when available."
-      }
-      networkStatus.tooltip +=
-        "\n\nDownload ↓ " +
-        prettyBytes(network.download_bytes_sec, {
-          bits: true,
-        }) +
-        "/s • Upload ↑ " +
-        prettyBytes(network.upload_bytes_sec, {
-          bits: true,
-        }) +
-        "/s\n"
-
-      if (!network.p2p) {
-        const derpLatency = network.derp_latency[network.preferred_derp]
-
-        networkStatus.tooltip += `You ↔ ${derpLatency.toFixed(2)}ms ↔ ${network.preferred_derp} ↔ ${(network.latency - derpLatency).toFixed(2)}ms ↔ Workspace`
-
-        let first = true
-        Object.keys(network.derp_latency).forEach((region) => {
-          if (region === network.preferred_derp) {
-            return
-          }
-          if (first) {
-            networkStatus.tooltip += `\n\nOther regions:`
-            first = false
-          }
-          networkStatus.tooltip += `\n${region}: ${Math.round(network.derp_latency[region] * 100) / 100}ms`
-        })
-      }
+      try {
+        let statusText = "$(globe) "
+        if (network.p2p) {
+          statusText += "Direct "
+          networkStatus.tooltip = "You're connected peer-to-peer ✨."
+        } else {
+          statusText += network.preferred_derp + " "
+          networkStatus.tooltip =
+            "You're connected through a relay 🕵.\nWe'll switch over to peer-to-peer when available."
+        }
+        networkStatus.tooltip +=
+          "\n\nDownload ↓ " +
+          prettyBytes(network.download_bytes_sec, {
+            bits: true,
+          }) +
+          "/s • Upload ↑ " +
+          prettyBytes(network.upload_bytes_sec, {
+            bits: true,
+          }) +
+          "/s\n"
+
+        if (!network.p2p) {
+          const derpLatency = network.derp_latency[network.preferred_derp]
+
+          networkStatus.tooltip += `You ↔ ${derpLatency.toFixed(2)}ms ↔ ${network.preferred_derp} ↔ ${(
+            network.latency - derpLatency
+          ).toFixed(2)}ms ↔ Workspace`
+
+          let first = true
+          Object.keys(network.derp_latency).forEach((region) => {
+            if (region === network.preferred_derp) {
+              return
+            }
+            if (first) {
+              networkStatus.tooltip += `\n\nOther regions:`
+              first = false
+            }
+            networkStatus.tooltip += `\n${region}: ${Math.round(network.derp_latency[region] * 100) / 100}ms`
+          })
+        }
 
-      statusText += "(" + network.latency.toFixed(2) + "ms)"
-      networkStatus.text = statusText
-      networkStatus.show()
+        statusText += "(" + network.latency.toFixed(2) + "ms)"
+        networkStatus.text = statusText
+        networkStatus.show()
+
+        // Log occasional network stats updates (every 20 refreshes)
+        if (refreshCount % 20 === 0) {
+          logger.debug(
+            `Network stats update #${refreshCount}: p2p=${network.p2p}, latency=${network.latency.toFixed(2)}ms`,
+          )
+        }
+      } catch (ex) {
+        // Replace silent error ignoring with proper logging
+        logger.error("Error updating network status", ex)
+      }
     }
-    let disposed = false
+
     const periodicRefresh = () => {
       if (disposed) {
+        logger.debug("Network updates: Skipping refresh as disposed=true")
         return
       }
+
+      refreshCount++
+
+      // Log every 100 refreshes to track long-term operation
+      if (refreshCount % 100 === 0) {
+        logger.info(`Network updates: Completed ${refreshCount} refresh cycles for SSH PID: ${sshPid}`)
+        logger.logMemoryUsage("NETWORK_REFRESH")
+      }
+
       fs.readFile(networkInfoFile, "utf8")
         .then((content) => {
+          const currentSize = content.length
+          if (lastFileSize !== currentSize) {
+            logger.debug(`Network info file size changed: ${lastFileSize} -> ${currentSize} bytes`)
+            lastFileSize = currentSize
+          }
           return JSON.parse(content)
         })
         .then((parsed) => {
           try {
             updateStatus(parsed)
           } catch (ex) {
-            // Ignore
+            logger.error(`Failed to update status from parsed network info`, ex)
           }
         })
-        .catch(() => {
-          // TODO: Log a failure here!
+        .catch((error) => {
+          // Replace empty catch with proper error logging
+          logger.error(`Failed to read or parse network info file: ${networkInfoFile}`, error)
         })
         .finally(() => {
           // This matches the write interval of `coder vscodessh`.
-          setTimeout(periodicRefresh, 3000)
+          if (!disposed) {
+            setTimeout(periodicRefresh, 3000)
+          }
         })
     }
+
+    // Log the first refresh
+    logger.debug(`Starting initial network refresh for SSH PID: ${sshPid}`)
     periodicRefresh()
 
     return {
       dispose: () => {
-        disposed = true
-        networkStatus.dispose()
+        if (!disposed) {
+          logger.info(`Disposing network updates monitor for SSH PID: ${sshPid} after ${refreshCount} refreshes`)
+          disposed = true
+          networkStatus.dispose()
+          logger.trackResourceDisposed("NetworkStatusBar")
+        }
       },
     }
   }