Merge pull request #39 from closedloop-ai/FEAT-145

FEAT-133: Add gateway diagnostics logging with UI

Author: shafty023

apps/desktop/package.json

@@ -1,6 +1,6 @@
 {
   "name": "desktop",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "description": "ClosedLoop Desktop",
   "author": "ClosedLoop AI <support@closedloop.ai>",
   "private": true,

apps/desktop/src/main/app.ts

@@ -30,6 +30,7 @@ import {
 import { seedReposConfig } from "./seed-repos-config.js";
 import { SUPPORTED_OPERATION_IDS, resolveOperationId } from "./approval-operations.js";
 import { shouldAutoApprove, OPERATION_RISK_TIERS } from "./approval-policy.js";
+import { gatewayLog } from "./gateway-logger.js";
 import { ActivityLogStore } from "./activity-log-store.js";
 import { ApprovalStore } from "./approval-store.js";
 import { JobStore, isTerminalJobStatus } from "./job-store.js";
@@ -203,6 +204,7 @@ export class DesktopApplication {
     this.syncPendingApprovalsToTray();
     this.desktopWindow.init();
 
+    gatewayLog.setVerbose(this.settingsStore.getAll().verboseLogging);
     this.migrateLegacyData();
     this.reconcileJobStore();
 
@@ -728,6 +730,9 @@ export class DesktopApplication {
   }
 
   private registerIpcHandlers(): void {
+    ipcMain.handle("desktop:get-logs", () => gatewayLog.getEntries());
+    ipcMain.handle("desktop:clear-logs", () => { gatewayLog.clear(); });
+
     ipcMain.handle("desktop:get-settings", () => {
       const settings = this.settingsStore.getAll();
       const activeAlwaysAllowRules = pruneExpiredAlwaysAllowRules(settings.alwaysAllowRules);
@@ -749,6 +754,7 @@ export class DesktopApplication {
         webAppOrigin?: string;
         defaultApprovalTier?: "auto" | "none" | "low" | "medium" | "high";
         autoApprovalRules?: Record<string, "auto" | "none" | "low" | "medium" | "high">;
+        verboseLogging?: boolean;
       }) => {
         const currentSettings = this.settingsStore.getAll();
         const nextPartial = { ...partial };
@@ -789,6 +795,9 @@ export class DesktopApplication {
         }
 
         const updated = this.settingsStore.update(nextPartial as Partial<DesktopSettings>);
+        if (typeof nextPartial.verboseLogging === "boolean") {
+          gatewayLog.setVerbose(nextPartial.verboseLogging);
+        }
 
         if (
           typeof partial.sandboxBaseDirectory === "string" &&

apps/desktop/src/main/cloud-command-executor.ts

@@ -1,4 +1,5 @@
 import { URL } from "node:url";
+import { gatewayLog } from "./gateway-logger.js";
 import type {
   CommandEventRecord,
   DesktopCancelEvent,
@@ -57,6 +58,7 @@ export class CloudCommandExecutor {
 
     const validationError = validateCommand(command);
     if (validationError) {
+      gatewayLog.warn("command-executor", `Rejected command ${command.commandId}: ${validationError}`);
       this.options.sendCommandAck({
         commandId: command.commandId,
         accepted: false,
@@ -66,6 +68,7 @@ export class CloudCommandExecutor {
       return;
     }
 
+    gatewayLog.debug("command-executor", `Enqueued command ${command.commandId}: ${command.method} ${command.path}`);
     const tracked: TrackedCommand = {
       command,
       state: "queued",
@@ -181,6 +184,7 @@ export class CloudCommandExecutor {
       return;
     }
     tracked.state = "running";
+    gatewayLog.debug("command-executor", `Executing command ${command.commandId}: ${command.method} ${command.path}`);
 
     const lockKey = deriveLockKey(command);
     if (lockKey) {
@@ -221,6 +225,7 @@ export class CloudCommandExecutor {
           cancelled: true,
           reason: running.cancelReason ?? "cancelled"
         });
+        gatewayLog.debug("command-executor", `Command ${command.commandId} cancelled`);
         this.markTerminal(command.commandId, "cancelled");
       } else if (running.timedOut) {
         this.emitTrackedEvent(command.commandId, "error", {
@@ -229,13 +234,16 @@ export class CloudCommandExecutor {
           code: "timeout",
           error: "command timed out"
         });
+        gatewayLog.error("command-executor", `Command ${command.commandId} timed out`);
         this.markTerminal(command.commandId, "failed");
       } else {
+        const msg = error instanceof Error ? error.message : "unknown command failure";
         this.emitTrackedEvent(command.commandId, "error", {
           type: "error",
           terminal: true,
-          error: error instanceof Error ? error.message : "unknown command failure"
+          error: msg
         });
+        gatewayLog.error("command-executor", `Command ${command.commandId} failed: ${msg}`);
         this.markTerminal(command.commandId, "failed");
       }
     } finally {
@@ -268,6 +276,7 @@ export class CloudCommandExecutor {
     const method = command.method.toUpperCase();
     const body = serializeBody(command.body, headers, method);
 
+    gatewayLog.debug("command-executor", `Gateway fetch: ${method} ${requestUrl.pathname}`);
     const response = await fetch(requestUrl, {
       method,
       headers,
@@ -280,6 +289,7 @@ export class CloudCommandExecutor {
 
     if (!response.ok && !isStream) {
       const message = await safeReadBodyAsText(response);
+      gatewayLog.error("command-executor", `Gateway returned ${response.status} for ${method} ${requestUrl.pathname}: ${message}`);
       throw new Error(`gateway returned ${response.status}${message ? `: ${message}` : ""}`);
     }
 

apps/desktop/src/main/cloud-socket.ts

@@ -1,4 +1,5 @@
 import { createHash, randomUUID } from "node:crypto";
+import { gatewayLog } from "./gateway-logger.js";
 import { io, type Socket } from "socket.io-client";
 import {
   PROTOCOL_VERSION,
@@ -94,6 +95,7 @@ export class CloudSocketService {
       state: DesktopPresenceEvent["state"];
     }
   ): void {
+    gatewayLog.debug("cloud-socket", `Sending presence: state=${event.state}`);
     this.emit("desktop.presence", event);
   }
 
@@ -129,6 +131,7 @@ export class CloudSocketService {
       if (this.stopped) {
         return;
       }
+      gatewayLog.info("cloud-socket", "Connected to relay, sending hello handshake");
       this.awaitingHelloAck = true;
       this.emitHello();
       this.scheduleHelloAckTimeout();
@@ -142,11 +145,13 @@ export class CloudSocketService {
       this.clearHelloAckTimer();
       const message = error instanceof Error ? error.message : "connection failed";
       if (looksLikeAuthError(error)) {
+        gatewayLog.error("cloud-socket", "Authentication failed on connect");
         this.notifyStatus({
           state: "degraded",
           error: "Authentication failed — verify your API key in Settings"
         });
       } else {
+        gatewayLog.error("cloud-socket", `Connection error: ${message}`);
         this.notifyStatus({ state: "degraded", error: `Cloud socket connection failed: ${message}` });
       }
     });
@@ -155,6 +160,7 @@ export class CloudSocketService {
       if (this.stopped) {
         return;
       }
+      gatewayLog.warn("cloud-socket", `Disconnected: ${reason}`);
       this.awaitingHelloAck = false;
       this.clearHelloAckTimer();
       this.notifyStatus({ state: "degraded", error: `Cloud socket disconnected: ${reason}` });
@@ -164,12 +170,14 @@ export class CloudSocketService {
       const event = asObject(payload);
       const computeTargetId = asNonEmptyString(event.computeTargetId);
       if (!computeTargetId) {
+        gatewayLog.warn("cloud-socket", "hello.ack missing computeTargetId, ignoring");
         return;
       }
 
       this.targetId = computeTargetId;
       this.awaitingHelloAck = false;
       this.clearHelloAckTimer();
+      gatewayLog.info("cloud-socket", `Hello ack received, targetId=${computeTargetId}`);
       const ackEvent: DesktopHelloAckEvent = {
         ...createEnvelope(),
         computeTargetId,
@@ -190,8 +198,10 @@ export class CloudSocketService {
     socket.on("desktop.command", (payload: unknown) => {
       const parsed = parseDesktopCommand(payload);
       if (!parsed) {
+        gatewayLog.warn("cloud-socket", "Received unparseable desktop.command, ignoring");
         return;
       }
+      gatewayLog.debug("cloud-socket", `Command received: ${parsed.operationId} ${parsed.method} ${parsed.path} (commandId=${parsed.commandId})`);
       this.options.onCommand?.(parsed);
     });
 
@@ -267,6 +277,7 @@ export class CloudSocketService {
       if (this.stopped || !this.awaitingHelloAck) {
         return;
       }
+      gatewayLog.warn("cloud-socket", "Hello ack timeout -- retrying handshake");
       this.notifyStatus({
         state: "degraded",
         error: "Connected to cloud socket but did not receive desktop.hello.ack"

apps/desktop/src/main/gateway-logger.ts

@@ -0,0 +1,94 @@
+/**
+ * Structured logger for the desktop gateway.
+ * All log entries are timestamped, tagged by subsystem, and optionally
+ * buffered in-memory so the UI can display recent entries.
+ */
+
+export type LogLevel = "info" | "warn" | "error";
+
+export interface LogEntry {
+  timestamp: string;
+  level: LogLevel;
+  tag: string;
+  message: string;
+}
+
+const MAX_BUFFER_SIZE = 500;
+
+export class GatewayLogger {
+  private verbose = false;
+  private readonly buffer: LogEntry[] = [];
+  private onChange?: (entries: LogEntry[]) => void;
+  private lastMessage = "";
+
+  setVerbose(enabled: boolean): void {
+    if (this.verbose === enabled) return;
+    this.verbose = enabled;
+    this.info("logger", enabled ? "Verbose logging enabled" : "Verbose logging disabled");
+  }
+
+  isVerbose(): boolean {
+    return this.verbose;
+  }
+
+  setOnChange(cb: (entries: LogEntry[]) => void): void {
+    this.onChange = cb;
+  }
+
+  info(tag: string, message: string): void {
+    this.log("info", tag, message);
+  }
+
+  warn(tag: string, message: string): void {
+    this.log("warn", tag, message);
+  }
+
+  error(tag: string, message: string): void {
+    this.log("error", tag, message);
+  }
+
+  /** Verbose-only log -- skipped when verbose mode is off. */
+  debug(tag: string, message: string): void {
+    if (!this.verbose) return;
+    this.log("info", tag, message);
+  }
+
+  getEntries(): LogEntry[] {
+    return [...this.buffer];
+  }
+
+  clear(): void {
+    this.buffer.length = 0;
+    this.lastMessage = "";
+    this.onChange?.([]);
+  }
+
+  private log(level: LogLevel, tag: string, message: string): void {
+    const key = `${level}:${tag}:${message}`;
+    if (key === this.lastMessage) return;
+    this.lastMessage = key;
+
+    const ts = new Date().toISOString();
+    const entry: LogEntry = { timestamp: ts, level, tag, message };
+
+    this.buffer.push(entry);
+    if (this.buffer.length > MAX_BUFFER_SIZE) {
+      this.buffer.splice(0, this.buffer.length - MAX_BUFFER_SIZE);
+    }
+
+    const short = ts.slice(11, 23);
+    const prefix = `[${tag}][${short}]`;
+    if (level === "error") {
+      console.error(prefix, message);
+    } else if (level === "warn") {
+      console.warn(prefix, message);
+    } else {
+      console.log(prefix, message);
+    }
+
+    this.onChange?.([...this.buffer]);
+  }
+}
+
+/** Singleton instance shared across the app. */
+export const gatewayLog = new GatewayLogger();

apps/desktop/src/main/preload.ts

@@ -53,7 +53,9 @@ const desktopApi = {
   listCompletedJobs: () => ipcRenderer.invoke("desktop:list-completed-jobs") as Promise<unknown>,
   getJob: (jobId: string) => ipcRenderer.invoke("desktop:get-job", jobId) as Promise<unknown>,
   getJobLogTail: (jobId: string, lines?: number) =>
-    ipcRenderer.invoke("desktop:get-job-log-tail", jobId, lines) as Promise<unknown>
+    ipcRenderer.invoke("desktop:get-job-log-tail", jobId, lines) as Promise<unknown>,
+  getLogs: () => ipcRenderer.invoke("desktop:get-logs") as Promise<unknown>,
+  clearLogs: () => ipcRenderer.invoke("desktop:clear-logs") as Promise<unknown>
 };
 
 contextBridge.exposeInMainWorld("desktopApi", desktopApi);

apps/desktop/src/main/settings-store.ts

@@ -181,6 +181,9 @@ export class SettingsStore {
     if (typeof partial.cloudConnectionEnabled === "boolean") {
       this.store.set("cloudConnectionEnabled", partial.cloudConnectionEnabled);
     }
+    if (typeof partial.verboseLogging === "boolean") {
+      this.store.set("verboseLogging", partial.verboseLogging);
+    }
     if (typeof partial.relayOrigin === "string") {
       this.store.set("relayOrigin" as keyof DesktopSettings, partial.relayOrigin);
     }