diff --git a/packages/comfyui-desktop-bridge-types/comfyDesktopBridge.d.ts b/packages/comfyui-desktop-bridge-types/comfyDesktopBridge.d.ts index 662bdfeaa..64e8f5f0c 100644 --- a/packages/comfyui-desktop-bridge-types/comfyDesktopBridge.d.ts +++ b/packages/comfyui-desktop-bridge-types/comfyDesktopBridge.d.ts @@ -36,6 +36,10 @@ export type ComfyDesktop2TelemetryProperties = Record< string, ComfyDesktop2TelemetryValue | ComfyDesktop2TelemetryValue[] > +export interface ComfyDesktop2Error { + message: string + stack?: string +} export type ComfyDesktop2FirebaseAuthState = | { status: 'pending' @@ -65,6 +69,8 @@ export interface ComfyDesktop2LogsBridge { } export interface ComfyDesktop2TelemetryBridge { capture(event: string, properties?: ComfyDesktop2TelemetryProperties): void + /** Capture a hosted-frontend exception through Desktop's privacy and release-context boundary. */ + captureException?(error: ComfyDesktop2Error, properties?: ComfyDesktop2TelemetryProperties): void /** Report the hosted view's complete Firebase state for process-wide consensus. */ reportFirebaseAuthState?(state: ComfyDesktop2FirebaseAuthState): void } diff --git a/packages/comfyui-desktop-bridge-types/package.json b/packages/comfyui-desktop-bridge-types/package.json index 09b0ab344..1e921733f 100644 --- a/packages/comfyui-desktop-bridge-types/package.json +++ b/packages/comfyui-desktop-bridge-types/package.json @@ -1,6 +1,6 @@ { "name": "@comfyorg/comfyui-desktop-bridge-types", - "version": "0.2.0", + "version": "0.2.1", "description": "TypeScript definitions for the Comfy Desktop hosted frontend bridge", "type": "module", "main": "./index.js", diff --git a/src/main/lib/ipc/registerTelemetryHandlers.test.ts b/src/main/lib/ipc/registerTelemetryHandlers.test.ts index 401a4c861..ca3f08967 100644 --- a/src/main/lib/ipc/registerTelemetryHandlers.test.ts +++ b/src/main/lib/ipc/registerTelemetryHandlers.test.ts @@ -315,7 +315,15 @@ describe('registerTelemetryHandlers', () => { listener('telemetry:captureException')( { sender: { id: 8 } }, - { message: 'boom', properties: { client: 'web', deployment: 'cloud' } } + { + message: 'boom', + stack: 'Error: boom\n at app.ts:1:1', + properties: { + client: 'web', + deployment: 'cloud', + error_type: 'workspace_auth_gate_initialization_failure' + } + } ) const [err, sent] = mocks.captureExceptionAndForward.mock.calls[0]! as [ @@ -323,6 +331,8 @@ describe('registerTelemetryHandlers', () => { Record ] expect(err.message).toBe('boom') + expect(err.stack).toBe('Error: boom\n at app.ts:1:1') + expect(sent.error_type).toBe('workspace_auth_gate_initialization_failure') expect(sent.deployment).toBe('local') expect(sent.client).toBeUndefined() }) diff --git a/src/main/lib/telemetry.test.ts b/src/main/lib/telemetry.test.ts index 14375d94a..15e63e86b 100644 --- a/src/main/lib/telemetry.test.ts +++ b/src/main/lib/telemetry.test.ts @@ -372,11 +372,13 @@ describe('telemetry default event properties', () => { setupTelemetry({ appVersion: '1.0.0', appEnv: 'prod', bind: 'id' }) exceptions.length = 0 - telemetry.captureException(new Error('boom'), { foo: 'bar' }) + telemetry.captureException(new Error('boom'), { + error_type: 'workspace_auth_gate_initialization_failure' + }) expect(exceptions).toHaveLength(1) expect(exceptions[0]!.properties).toMatchObject({ - foo: 'bar', + error_type: 'workspace_auth_gate_initialization_failure', app_version: '1.0.0', client: 'desktop', $process_person_profile: false diff --git a/src/preload/comfyPreload.test.ts b/src/preload/comfyPreload.test.ts index ad3e3fa41..2395bd9d6 100644 --- a/src/preload/comfyPreload.test.ts +++ b/src/preload/comfyPreload.test.ts @@ -35,6 +35,27 @@ function hostedBridge(): HostedFrontendBridge { describe('comfyPreload model access bridge', () => { beforeEach(() => { mocks.invoke.mockReset() + mocks.send.mockReset() + }) + + it('forwards hosted frontend exceptions through the scrubbed Desktop telemetry channel', () => { + const bridge = hostedBridge() + const error = new Error('boom') + error.stack = 'Error: boom\n at app.ts:1:1' + + bridge.Telemetry.captureException!(error, { + error_type: 'workspace_auth_gate_initialization_failure', + level: 'error' + }) + + expect(mocks.send).toHaveBeenCalledWith('telemetry:captureException', { + message: error.message, + stack: error.stack, + properties: { + error_type: 'workspace_auth_gate_initialization_failure', + level: 'error' + } + }) }) it('forwards the repository URL through the desktop2 IPC contract', async () => { diff --git a/src/preload/comfyPreload.ts b/src/preload/comfyPreload.ts index f510b15fd..f56727fa6 100644 --- a/src/preload/comfyPreload.ts +++ b/src/preload/comfyPreload.ts @@ -88,8 +88,19 @@ const reportFirebaseAuthState: NonNullable< ComfyDesktop2TelemetryBridge['reportFirebaseAuthState'] > = (state): void => sendTelemetry('telemetry:firebaseAuthState', state) +const captureException: NonNullable = ( + error, + properties +): void => + sendTelemetry('telemetry:captureException', { + message: error.message, + ...(error.stack ? { stack: error.stack } : {}), + properties + }) + const Telemetry: ComfyDesktop2TelemetryBridge = { capture: (event, properties): void => sendTelemetry('telemetry:capture', { event, properties }), + captureException, reportFirebaseAuthState } diff --git a/src/types/comfyDesktopBridge.ts b/src/types/comfyDesktopBridge.ts index dedd6cbbd..4af383309 100644 --- a/src/types/comfyDesktopBridge.ts +++ b/src/types/comfyDesktopBridge.ts @@ -38,6 +38,11 @@ export type ComfyDesktop2TelemetryProperties = Record< ComfyDesktop2TelemetryValue | ComfyDesktop2TelemetryValue[] > +export interface ComfyDesktop2Error { + message: string + stack?: string +} + export type ComfyDesktop2FirebaseAuthState = | { status: 'pending' } | { status: 'signed_out' } @@ -63,6 +68,8 @@ export interface ComfyDesktop2LogsBridge { export interface ComfyDesktop2TelemetryBridge { capture(event: string, properties?: ComfyDesktop2TelemetryProperties): void + /** Capture a hosted-frontend exception through Desktop's privacy and release-context boundary. */ + captureException?(error: ComfyDesktop2Error, properties?: ComfyDesktop2TelemetryProperties): void /** Report the hosted view's complete Firebase state for process-wide consensus. */ reportFirebaseAuthState?(state: ComfyDesktop2FirebaseAuthState): void }