diff --git a/src/platform/telemetry/cmpEventSink.test.ts b/src/platform/telemetry/cmpEventSink.test.ts new file mode 100644 index 00000000000..56dc066dbb5 --- /dev/null +++ b/src/platform/telemetry/cmpEventSink.test.ts @@ -0,0 +1,83 @@ +import type { CmpEvent } from '@comfyorg/comfy-multi-player' + +import { reportError } from './reportError' +import { cmpEventSink } from './cmpEventSink' + +vi.mock('./reportError', () => ({ reportError: vi.fn() })) + +const event: CmpEvent = { + schema_version: 1, + type: 'op_rejected', + source: 'applyOps', + code: 'unknown_widget', + message: 'widget write rejected', + error_name: 'OpRejectedError', + op_id: '0123456789abcdef0123456789abcdef', + batch_index: 2 +} + +describe('cmpEventSink', () => { + it('maps a cmp event to the generic error reporter', () => { + expect(cmpEventSink(event)).toBeUndefined() + + expect(reportError).toHaveBeenCalledWith( + expect.objectContaining({ + name: 'OpRejectedError', + message: event.message + }), + { + errorType: 'cmp_event', + tags: { + cmp_event_schema_version: 1, + cmp_event_type: 'op_rejected', + cmp_event_source: 'applyOps', + cmp_event_code: 'unknown_widget', + cmp_event_error_name: 'OpRejectedError' + }, + context: { + op_id: event.op_id, + batch_index: 2 + } + } + ) + }) + + it('omits absent optional fields for a minimal event', () => { + cmpEventSink({ + schema_version: 1, + type: 'clock_anomaly', + source: 'clock', + code: 'skew', + message: 'clock skew detected' + }) + + expect(reportError).toHaveBeenLastCalledWith( + expect.objectContaining({ + name: 'CmpEvent', + message: 'clock skew detected' + }), + { + errorType: 'cmp_event', + tags: { + cmp_event_schema_version: 1, + cmp_event_type: 'clock_anomaly', + cmp_event_source: 'clock', + cmp_event_code: 'skew', + cmp_event_error_name: undefined + }, + context: {} + } + ) + }) + + it('bounds diagnostic messages and accepts additive event names', () => { + cmpEventSink({ ...event, type: 'future_event', message: 'x'.repeat(2_000) }) + + expect(reportError).toHaveBeenLastCalledWith( + expect.objectContaining({ message: 'x'.repeat(1_024) }), + expect.objectContaining({ + tags: expect.objectContaining({ cmp_event_type: 'future_event' }) + }) + ) + }) +}) diff --git a/src/platform/telemetry/cmpEventSink.ts b/src/platform/telemetry/cmpEventSink.ts new file mode 100644 index 00000000000..cfc5ff170f1 --- /dev/null +++ b/src/platform/telemetry/cmpEventSink.ts @@ -0,0 +1,34 @@ +import type { CmpEvent, CmpEventSink } from '@comfyorg/comfy-multi-player' + +import { reportError } from './reportError' + +const MAX_MESSAGE_LENGTH = 1_024 +const DEFAULT_ERROR_NAME = 'CmpEvent' + +const toError = (event: CmpEvent): Error => { + const error = new Error(event.message.slice(0, MAX_MESSAGE_LENGTH)) + error.name = event.error_name ?? DEFAULT_ERROR_NAME + return error +} + +const definedContextOf = (event: CmpEvent): Record => { + const context: Record = {} + if (event.op_id !== undefined) context.op_id = event.op_id + if (event.batch_index !== undefined) context.batch_index = event.batch_index + return context +} + +export const cmpEventSink: CmpEventSink = (event) => { + reportError(toError(event), { + errorType: 'cmp_event', + tags: { + cmp_event_schema_version: event.schema_version, + cmp_event_type: event.type, + cmp_event_source: event.source, + cmp_event_code: event.code, + cmp_event_error_name: event.error_name + }, + context: definedContextOf(event) + }) + return undefined +}