Files
claude-mem/tests/error-handling/hook-error-logging.test.ts
T
Alex Newman 52d2f72a82 Standardize and enhance error handling across hooks and worker service (#295)
* Enhance error logging in hooks

- Added detailed error logging in context-hook, new-hook, save-hook, and summary-hook to capture status, project, port, and relevant session information on failures.
- Improved error messages thrown in save-hook and summary-hook to include specific context about the failure.

* Refactor migration logging to use console.log instead of console.error

- Updated SessionSearch and SessionStore classes to replace console.error with console.log for migration-related messages.
- Added notes in the documentation to clarify the use of console.log for migration messages due to the unavailability of the structured logger during constructor execution.

* Refactor SDKAgent and silent-debug utility to simplify error handling

- Updated SDKAgent to use direct defaults instead of happy_path_error__with_fallback for non-critical fields such as last_user_message, last_assistant_message, title, filesRead, filesModified, concepts, and summary.request.
- Enhanced silent-debug documentation to clarify appropriate use cases for happy_path_error__with_fallback, emphasizing its role in handling unexpected null/undefined values while discouraging its use for nullable fields with valid defaults.

* fix: correct happy_path_error__with_fallback usage to prevent false errors

Fixes false "Missing cwd" and "Missing transcript_path" errors that were
flooding silent.log even when values were present.

Root cause: happy_path_error__with_fallback was being called unconditionally
instead of only when the value was actually missing.

Pattern changed from:
  value: happy_path_error__with_fallback('Missing', {}, value || '')

To correct usage:
  value: value || happy_path_error__with_fallback('Missing', {}, '')

Fixed in:
- src/hooks/save-hook.ts (PostToolUse hook)
- src/hooks/summary-hook.ts (Stop hook)
- src/services/worker/http/routes/SessionRoutes.ts (2 instances)

Impact: Eliminates false error noise, making actual errors visible.

Addresses issue #260 - users were seeing "Missing cwd" errors despite
Claude Code correctly passing all required fields.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* Enhance error logging and handling across services

- Improved error messages in SessionStore to include project context when fetching boundary observations and timestamps.
- Updated ChromaSync error handling to provide more informative messages regarding client initialization failures, including the project context.
- Enhanced error logging in WorkerService to include the package path when reading version fails.
- Added detailed error logging in worker-utils to capture expected and running versions during health checks.
- Extended WorkerErrorMessageOptions to include actualError for more informative restart instructions.

* Refactor error handling in hooks to use standardized fetch error handler

- Introduced a new error handler `handleFetchError` in `shared/error-handler.ts` to standardize logging and user-facing error messages for fetch failures across hooks.
- Updated `context-hook.ts`, `new-hook.ts`, `save-hook.ts`, and `summary-hook.ts` to utilize the new error handler, improving consistency and maintainability.
- Removed redundant imports and error handling logic related to worker restart instructions from the hooks.

* feat: add comprehensive error handling tests for hooks and ChromaSync client

---------

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
2025-12-13 23:25:43 -05:00

260 lines
7.7 KiB
TypeScript

/**
* Test: Hook Error Logging
*
* Verifies that hooks properly log errors when failures occur.
* This test prevents regression of silent failure bugs (observations 25389, 25307).
*
* Recent bugs:
* - save-hook was completely silent on errors
* - new-hook didn't log fetch failures
* - context-hook had no error context
*/
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { handleFetchError } from '../../src/hooks/shared/error-handler.js';
import { handleWorkerError } from '../../src/shared/hook-error-handler.js';
describe('Hook Error Logging', () => {
let consoleErrorSpy: any;
let loggerErrorSpy: any;
beforeEach(() => {
vi.clearAllMocks();
consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => {});
});
describe('handleFetchError', () => {
it('logs error with full context when fetch fails', () => {
const mockResponse = {
ok: false,
status: 500,
statusText: 'Internal Server Error'
} as Response;
const errorText = 'Database connection failed';
const context = {
hookName: 'save',
operation: 'Observation storage',
toolName: 'Bash',
sessionId: 'test-session-123',
port: 37777
};
expect(() => {
handleFetchError(mockResponse, errorText, context);
}).toThrow();
// Verify: Error thrown contains user-facing message with restart instructions
try {
handleFetchError(mockResponse, errorText, context);
} catch (error: any) {
expect(error.message).toContain('Failed Observation storage for Bash');
expect(error.message).toContain('npm run worker:restart');
}
});
it('includes port and session ID in error context', () => {
const mockResponse = {
ok: false,
status: 404
} as Response;
const context = {
hookName: 'context',
operation: 'Context generation',
project: 'my-project',
port: 37777
};
try {
handleFetchError(mockResponse, 'Not found', context);
} catch (error: any) {
expect(error.message).toContain('Context generation failed');
}
});
it('provides different messages for operations with and without tools', () => {
const mockResponse = { ok: false, status: 500 } as Response;
// With tool name
const withTool = {
hookName: 'save',
operation: 'Save',
toolName: 'Read'
};
try {
handleFetchError(mockResponse, 'error', withTool);
} catch (error: any) {
expect(error.message).toContain('for Read');
}
// Without tool name
const withoutTool = {
hookName: 'context',
operation: 'Context generation'
};
try {
handleFetchError(mockResponse, 'error', withoutTool);
} catch (error: any) {
expect(error.message).not.toContain('for');
expect(error.message).toContain('Context generation failed');
}
});
});
describe('handleWorkerError', () => {
it('handles timeout errors with restart instructions', () => {
const timeoutError = new Error('The operation was aborted due to timeout');
timeoutError.name = 'TimeoutError';
expect(() => {
handleWorkerError(timeoutError);
}).toThrow('Worker service connection failed');
});
it('handles connection refused errors with restart instructions', () => {
const connError = new Error('connect ECONNREFUSED 127.0.0.1:37777') as any;
connError.cause = { code: 'ECONNREFUSED' };
expect(() => {
handleWorkerError(connError);
}).toThrow('npm run worker:restart');
});
it('re-throws non-connection errors unchanged', () => {
const genericError = new Error('Something went wrong');
try {
handleWorkerError(genericError);
expect.fail('Should have thrown');
} catch (error: any) {
expect(error.message).toBe('Something went wrong');
expect(error.message).not.toContain('npm run worker:restart');
}
});
it('preserves original error message in thrown error', () => {
const originalError = new Error('Database write failed');
try {
handleWorkerError(originalError);
} catch (error: any) {
expect(error.message).toContain('Database write failed');
}
});
});
describe('Real Hook Error Scenarios', () => {
it('save-hook logs context when observation storage fails', async () => {
// Simulate save-hook.ts fetch failure
global.fetch = vi.fn().mockResolvedValue({
ok: false,
status: 500,
text: async () => 'Internal error'
});
const mockContext = {
hookName: 'save',
operation: 'Observation storage',
toolName: 'Edit',
sessionId: 'session-456',
port: 37777
};
const response = await fetch('http://127.0.0.1:37777/api/sessions/observations');
const errorText = await response.text();
expect(() => {
handleFetchError(response, errorText, mockContext);
}).toThrow('Failed Observation storage for Edit');
});
it('new-hook logs context when session initialization fails', async () => {
global.fetch = vi.fn().mockResolvedValue({
ok: false,
status: 400,
text: async () => 'Invalid session ID'
});
const mockContext = {
hookName: 'new',
operation: 'Session initialization',
project: 'claude-mem',
port: 37777
};
const response = await fetch('http://127.0.0.1:37777/api/sessions/init');
const errorText = await response.text();
expect(() => {
handleFetchError(response, errorText, mockContext);
}).toThrow('Session initialization failed');
});
it('context-hook logs context when context generation fails', async () => {
global.fetch = vi.fn().mockResolvedValue({
ok: false,
status: 503,
text: async () => 'Service unavailable'
});
const mockContext = {
hookName: 'context',
operation: 'Context generation',
project: 'my-app',
port: 37777
};
const response = await fetch('http://127.0.0.1:37777/api/context/inject');
const errorText = await response.text();
expect(() => {
handleFetchError(response, errorText, mockContext);
}).toThrow('Context generation failed');
});
});
describe('Error Message Quality', () => {
it('error messages are actionable and include next steps', () => {
const mockResponse = { ok: false, status: 500 } as Response;
const context = {
hookName: 'save',
operation: 'Test operation'
};
try {
handleFetchError(mockResponse, 'error', context);
} catch (error: any) {
// Must include restart command
expect(error.message).toMatch(/npm run worker:restart/);
// Must be user-facing (no technical jargon)
expect(error.message).not.toContain('ECONNREFUSED');
expect(error.message).not.toContain('fetch failed');
}
});
it('error messages identify which hook failed', () => {
const mockResponse = { ok: false, status: 500 } as Response;
const contexts = [
{ hookName: 'save', operation: 'Save' },
{ hookName: 'context', operation: 'Context' },
{ hookName: 'new', operation: 'Init' },
{ hookName: 'summary', operation: 'Summary' }
];
for (const context of contexts) {
try {
handleFetchError(mockResponse, 'error', context);
} catch (error: any) {
// Error should help user identify which operation failed
expect(error.message).toBeTruthy();
expect(error.message.length).toBeGreaterThan(10);
}
}
});
});
});