Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 72 additions & 12 deletions packages/desktop/src/main/debug/index.ts
Original file line number Diff line number Diff line change
@@ -1,32 +1,92 @@
import { BrowserWindow } from 'electron';
import type { DebugEvent } from '@clawwork/shared';
import { sanitizeForLog } from '@clawwork/shared';
import type { DebugEvent, LogEventInput } from '@clawwork/shared';
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

security-medium medium

Import sanitizeForLog as a value to ensure that buffered events are properly sanitized before being stored in memory, preventing potential leakage of sensitive information.

Suggested change
import type { DebugEvent, LogEventInput } from '@clawwork/shared';
import { sanitizeForLog, type DebugEvent, type LogEventInput } from '@clawwork/shared';

import type { DebugLogger } from './logger.js';
import { createDebugLogger } from './logger.js';

const noop = (): DebugEvent => ({ ts: '', level: 'debug', domain: 'app', event: '' }) as DebugEvent;
let debugLogger: DebugLogger = {
debug: noop,
info: noop,
warn: noop,
error: noop,
log: noop,
getRecentEvents: () => [],
currentFilePath: () => '',
};
const MAX_PRE_INIT_BUFFER = 256;

let debugLogger: DebugLogger;
let isInitialized = false;

function createNoopLogger(): DebugLogger {
const preInitBuffer: DebugEvent[] = [];

const flushToLogger = (logger: DebugLogger): void => {
for (const event of preInitBuffer) {
logger.log(event);
}
preInitBuffer.length = 0;
};

const makeBufferedLog =
(level: 'debug' | 'info' | 'warn' | 'error') =>
(input: LogEventInput): DebugEvent => {
const event = sanitizeForLog({
...input,
ts: new Date().toISOString(),
level,
} as DebugEvent);

preInitBuffer.push(event);
if (preInitBuffer.length > MAX_PRE_INIT_BUFFER) {
preInitBuffer.shift();
}

console.warn(
`[debug] Logger not initialized yet (pre-init event captured, buffer size: ${preInitBuffer.length}/${MAX_PRE_INIT_BUFFER}):`,
`[${level}] [${input.domain}] ${input.event}`,
input,
);
return event;
};

const noopLogger: DebugLogger = {
debug: makeBufferedLog('debug'),
info: makeBufferedLog('info'),
warn: makeBufferedLog('warn'),
error: makeBufferedLog('error'),
log: (input) => makeBufferedLog(input.level ?? 'debug')(input),
getRecentEvents: () => [...preInitBuffer],
currentFilePath: () => '',
};

Object.defineProperty(noopLogger, '__flush', {
value: flushToLogger,
writable: false,
enumerable: false,
});

return noopLogger;
}

debugLogger = createNoopLogger();

export function initDebugLogger(debugDir: string): DebugLogger {
debugLogger = createDebugLogger({
const realLogger = createDebugLogger({
debugDir,
console: true,
onEvent: broadcastDebugEvent,
});

const noop = debugLogger as DebugLogger & { __flush?: (logger: DebugLogger) => void };
if (noop.__flush) {
noop.__flush(realLogger);
}

debugLogger = realLogger;
isInitialized = true;
return debugLogger;
}

export function getDebugLogger(): DebugLogger {
return debugLogger;
}

export function isDebugLoggerInitialized(): boolean {
return isInitialized;
}

function broadcastDebugEvent(event: DebugEvent): void {
for (const win of BrowserWindow.getAllWindows()) {
try {
Expand Down
99 changes: 99 additions & 0 deletions packages/desktop/test/debug/debug-logger.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
import { describe, it, expect, vi, beforeEach } from 'vitest';
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Add path and os imports to support cross-platform temporary directory usage in tests.

import { join } from 'node:path';
import { tmpdir } from 'node:os';
import { describe, it, expect, vi, beforeEach } from 'vitest';


vi.mock('electron', () => ({
BrowserWindow: {
getAllWindows: () => [],
},
}));

describe('debug logger pre-init behavior', () => {
beforeEach(async () => {
vi.resetModules();
vi.restoreAllMocks();
});

it('buffers events before initDebugLogger runs', async () => {
const { getDebugLogger, isDebugLoggerInitialized } = await import(
'../../src/main/debug/index.js'
);

const logger = getDebugLogger();
const event1 = logger.info({ domain: 'app', event: 'test-event-1' });
const event2 = logger.error({ domain: 'gateway', event: 'test-event-2' });

expect(event1.level).toBe('info');
expect(event1.domain).toBe('app');
expect(event1.event).toBe('test-event-1');
expect(event2.level).toBe('error');
expect(event2.domain).toBe('gateway');

expect(getDebugLogger().getRecentEvents()).toHaveLength(2);
expect(isDebugLoggerInitialized()).toBe(false);
});

it('flushes buffered events to real logger after init', async () => {
const { getDebugLogger, initDebugLogger, isDebugLoggerInitialized } = await import(
'../../src/main/debug/index.js'
);

const logger = getDebugLogger();

logger.info({ domain: 'app', event: 'pre-init-event' });
logger.warn({ domain: 'gateway', event: 'pre-init-warn' });

expect(isDebugLoggerInitialized()).toBe(false);

const tempDir = '/tmp/test-debug';
const realLogger = initDebugLogger(tempDir);
expect(isDebugLoggerInitialized()).toBe(true);

const recentEvents = realLogger.getRecentEvents();
expect(recentEvents.some((e) => e.event === 'pre-init-event')).toBe(true);
expect(recentEvents.some((e) => e.event === 'pre-init-warn')).toBe(true);
});

it('drops oldest events when buffer is full (keeps most recent 256)', async () => {
const { getDebugLogger, initDebugLogger } = await import(
'../../src/main/debug/index.js'
);

const logger = getDebugLogger();

logger.info({ domain: 'app', event: 'oldest-event' });
for (let i = 1; i <= 256; i++) {
logger.debug({ domain: 'app', event: `buffer-overflow-test-${i}` });
}

const events = getDebugLogger().getRecentEvents();
expect(events).toHaveLength(256);
expect(events.some((e) => e.event === 'oldest-event')).toBe(false);
expect(events[0].event).toBe('buffer-overflow-test-1');
expect(events[255].event).toBe('buffer-overflow-test-256');

const tempDir = '/tmp/test-debug';
const realLogger = initDebugLogger(tempDir);
const flushedEvents = realLogger.getRecentEvents();
expect(flushedEvents.some((e) => e.event === 'oldest-event')).toBe(false);
});

it('warns via console when logging before init', async () => {
const { getDebugLogger, isDebugLoggerInitialized } = await import(
'../../src/main/debug/index.js'
);

if (isDebugLoggerInitialized()) {
return;
}

const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});

const logger = getDebugLogger();
logger.error({ domain: 'app', event: 'pre-init-warning-test' });

expect(warnSpy).toHaveBeenCalled();
const warningCall = warnSpy.mock.calls[0][0] as string;
expect(warningCall).toContain('[debug] Logger not initialized yet');

warnSpy.mockRestore();
});
});
Loading