mirror of
https://github.com/Ark0N/Codeman.git
synced 2026-10-10 17:29:41 +02:00
JD
f12b5ac88b
A pasted image landed in <workspace>/.claude-images/, a name that belongs to another tool, in a folder nothing ignored, so it showed up in git status of every case that ever received a paste. Uploads now go to a flat <workspace>/.codeman-uploads/ that carries a .gitignore of `*` (written once, never over a file already there): in the workspace because that is the only path identical for a local agent and a container, flat because a nested .codeman/ is the data dir itself when the workspace is the home directory. The directory names live in paste-image-gc.ts alone. The old folder receives nothing but stays readable for one release: the hourly sweep and the delete cleanup go through uploadDirs(), the image watcher's ignore filter reads the names. uploadDirs() lists only real directories, none that is, contains or sits inside the data dir, and nothing for a remote session, since both consumers delete. The route refuses a remote (SSH) session before touching disk: the file would land on this host under the remote path, where the agent cannot read it. test/paste-image-dir-shared.test.ts binds port 0 and leaves the port guard's legacy list. Decided in #553.
459 lines
15 KiB
TypeScript
459 lines
15 KiB
TypeScript
/**
|
|
* @fileoverview Tests for ImageWatcher
|
|
*
|
|
* Tests image file detection, burst throttling, debounce behavior,
|
|
* session management, and cleanup.
|
|
*
|
|
* Uses mocked chokidar to avoid real filesystem watching.
|
|
*/
|
|
|
|
import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
|
|
import { EventEmitter } from 'node:events';
|
|
|
|
// Create a mock watcher factory
|
|
const mockWatchers = new Map<string, EventEmitter>();
|
|
|
|
vi.mock('chokidar', () => ({
|
|
watch: vi.fn((path: string) => {
|
|
const watcher = new EventEmitter();
|
|
(watcher as Record<string, unknown>).close = vi.fn();
|
|
mockWatchers.set(path, watcher);
|
|
return watcher;
|
|
}),
|
|
}));
|
|
|
|
vi.mock('node:fs', async (importOriginal) => {
|
|
const orig = await importOriginal<typeof import('node:fs')>();
|
|
return {
|
|
...orig,
|
|
statSync: vi.fn(() => ({ size: 2048 })),
|
|
};
|
|
});
|
|
|
|
import { ImageWatcher } from '../src/image-watcher.js';
|
|
import { watch } from 'chokidar';
|
|
import { statSync } from 'node:fs';
|
|
|
|
describe('ImageWatcher', () => {
|
|
let watcher: ImageWatcher;
|
|
|
|
beforeEach(() => {
|
|
vi.useFakeTimers();
|
|
mockWatchers.clear();
|
|
watcher = new ImageWatcher();
|
|
});
|
|
|
|
afterEach(() => {
|
|
watcher.stop();
|
|
vi.useRealTimers();
|
|
});
|
|
|
|
// ========== Start / Stop ==========
|
|
|
|
describe('start / stop', () => {
|
|
it('should not be running initially', () => {
|
|
expect(watcher.isRunning()).toBe(false);
|
|
});
|
|
|
|
it('should be running after start()', () => {
|
|
watcher.start();
|
|
expect(watcher.isRunning()).toBe(true);
|
|
});
|
|
|
|
it('should not be running after stop()', () => {
|
|
watcher.start();
|
|
watcher.stop();
|
|
expect(watcher.isRunning()).toBe(false);
|
|
});
|
|
|
|
it('should be idempotent on double start', () => {
|
|
watcher.start();
|
|
watcher.start();
|
|
expect(watcher.isRunning()).toBe(true);
|
|
});
|
|
});
|
|
|
|
// ========== Session Watching ==========
|
|
|
|
describe('watchSession', () => {
|
|
it('should auto-start when watchSession is called', () => {
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
expect(watcher.isRunning()).toBe(true);
|
|
});
|
|
|
|
it('should track watched sessions', () => {
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
expect(watcher.getWatchedSessions()).toContain('session-1');
|
|
});
|
|
|
|
it('should not double-watch the same session with same dir', () => {
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
// Only one watcher should be created
|
|
expect(watcher.getWatchedSessions()).toHaveLength(1);
|
|
});
|
|
|
|
it("ignores Codeman's own upload folders, so a pdf the user handed over is not a detected artifact", () => {
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
const [, opts] = vi.mocked(watch).mock.calls.at(-1) as unknown as [string, { ignored: (p: string) => boolean }];
|
|
expect(opts.ignored('/home/user/project/.codeman-uploads/paste-1-ab.pdf')).toBe(true);
|
|
expect(opts.ignored('/home/user/project/.claude-images/paste-1-ab.png')).toBe(true);
|
|
expect(opts.ignored('/home/user/project/docs/report.pdf')).toBe(false);
|
|
});
|
|
|
|
it('should replace watcher when working directory changes', () => {
|
|
watcher.watchSession('session-1', '/home/user/project-a');
|
|
watcher.watchSession('session-1', '/home/user/project-b');
|
|
|
|
expect(watcher.getWatchedSessions()).toHaveLength(1);
|
|
// Should have created watcher for both paths
|
|
expect(mockWatchers.has('/home/user/project-a')).toBe(true);
|
|
expect(mockWatchers.has('/home/user/project-b')).toBe(true);
|
|
});
|
|
});
|
|
|
|
// ========== Unwatch Session ==========
|
|
|
|
describe('unwatchSession', () => {
|
|
it('should remove a watched session', () => {
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
watcher.unwatchSession('session-1');
|
|
expect(watcher.getWatchedSessions()).not.toContain('session-1');
|
|
});
|
|
|
|
it('should close the chokidar watcher', () => {
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
const chokidarWatcher = mockWatchers.get('/home/user/project')!;
|
|
watcher.unwatchSession('session-1');
|
|
expect(chokidarWatcher.close).toHaveBeenCalled();
|
|
});
|
|
|
|
it('should be safe to call for non-watched session', () => {
|
|
expect(() => watcher.unwatchSession('nonexistent')).not.toThrow();
|
|
expect(watcher.getWatchedSessions()).toHaveLength(0);
|
|
});
|
|
|
|
it('should clear pending debounce timers for the session', () => {
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
const chokidarWatcher = mockWatchers.get('/home/user/project')!;
|
|
|
|
// Trigger an image detection (starts debounce timer)
|
|
chokidarWatcher.emit('add', '/home/user/project/screenshot.png');
|
|
|
|
// Unwatch should clear the timer without emitting
|
|
const handler = vi.fn();
|
|
watcher.on('image:detected', handler);
|
|
watcher.unwatchSession('session-1');
|
|
|
|
// Advance past debounce period
|
|
vi.advanceTimersByTime(500);
|
|
expect(handler).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
// ========== Image Detection ==========
|
|
|
|
describe('image detection', () => {
|
|
it('should emit attachment:detected for .png files', () => {
|
|
const handler = vi.fn();
|
|
watcher.on('attachment:detected', handler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
const chokidarWatcher = mockWatchers.get('/home/user/project')!;
|
|
|
|
chokidarWatcher.emit('add', '/home/user/project/screenshot.png');
|
|
vi.advanceTimersByTime(300); // past debounce (200ms)
|
|
|
|
expect(handler).toHaveBeenCalledTimes(1);
|
|
const event = handler.mock.calls[0][0];
|
|
expect(event.sessionId).toBe('session-1');
|
|
expect(event.fileName).toBe('screenshot.png');
|
|
expect(event.filePath).toBe('/home/user/project/screenshot.png');
|
|
expect(event.relativePath).toBe('screenshot.png');
|
|
expect(event.extension).toBe('png');
|
|
expect(event.attachmentType).toBe('image');
|
|
expect(event.size).toBe(2048);
|
|
});
|
|
|
|
it('should not emit legacy image:detected for .png attachment cards', () => {
|
|
const handler = vi.fn();
|
|
watcher.on('image:detected', handler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
mockWatchers.get('/home/user/project')!.emit('add', '/home/user/project/screenshot.png');
|
|
vi.advanceTimersByTime(300);
|
|
|
|
expect(handler).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it.each([
|
|
['report.pdf', 'pdf'],
|
|
['brief.docx', 'document'],
|
|
['deck.pptx', 'presentation'],
|
|
])('should emit attachment:detected for %s files', (fileName, attachmentType) => {
|
|
const handler = vi.fn();
|
|
watcher.on('attachment:detected', handler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
mockWatchers.get('/home/user/project')!.emit('add', `/home/user/project/${fileName}`);
|
|
vi.advanceTimersByTime(300);
|
|
|
|
expect(handler).toHaveBeenCalledTimes(1);
|
|
expect(handler.mock.calls[0][0]).toMatchObject({
|
|
sessionId: 'session-1',
|
|
fileName,
|
|
attachmentType,
|
|
});
|
|
});
|
|
|
|
it('should emit for .jpg files', () => {
|
|
const handler = vi.fn();
|
|
watcher.on('image:detected', handler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
const chokidarWatcher = mockWatchers.get('/home/user/project')!;
|
|
|
|
chokidarWatcher.emit('add', '/home/user/project/photo.jpg');
|
|
vi.advanceTimersByTime(300);
|
|
|
|
expect(handler).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
it('should emit for .jpeg files', () => {
|
|
const handler = vi.fn();
|
|
watcher.on('image:detected', handler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
mockWatchers.get('/home/user/project')!.emit('add', '/home/user/project/img.jpeg');
|
|
vi.advanceTimersByTime(300);
|
|
|
|
expect(handler).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
it('should emit for .gif files', () => {
|
|
const handler = vi.fn();
|
|
watcher.on('image:detected', handler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
mockWatchers.get('/home/user/project')!.emit('add', '/home/user/project/anim.gif');
|
|
vi.advanceTimersByTime(300);
|
|
|
|
expect(handler).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
it('should emit for .webp files', () => {
|
|
const handler = vi.fn();
|
|
watcher.on('image:detected', handler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
mockWatchers.get('/home/user/project')!.emit('add', '/home/user/project/img.webp');
|
|
vi.advanceTimersByTime(300);
|
|
|
|
expect(handler).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
it('should emit for .svg files', () => {
|
|
const handler = vi.fn();
|
|
watcher.on('image:detected', handler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
mockWatchers.get('/home/user/project')!.emit('add', '/home/user/project/icon.svg');
|
|
vi.advanceTimersByTime(300);
|
|
|
|
expect(handler).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
it('should NOT emit for non-image files', () => {
|
|
const handler = vi.fn();
|
|
watcher.on('image:detected', handler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
const chokidarWatcher = mockWatchers.get('/home/user/project')!;
|
|
|
|
chokidarWatcher.emit('add', '/home/user/project/readme.md');
|
|
vi.advanceTimersByTime(300);
|
|
|
|
expect(handler).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should NOT emit for .ts files', () => {
|
|
const handler = vi.fn();
|
|
watcher.on('image:detected', handler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
mockWatchers.get('/home/user/project')!.emit('add', '/home/user/project/index.ts');
|
|
vi.advanceTimersByTime(300);
|
|
|
|
expect(handler).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should compute relative path from working directory', () => {
|
|
const handler = vi.fn();
|
|
watcher.on('image:detected', handler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
mockWatchers.get('/home/user/project')!.emit('add', '/home/user/project/assets/img.jpg');
|
|
vi.advanceTimersByTime(300);
|
|
|
|
expect(handler.mock.calls[0][0].relativePath).toBe('assets/img.jpg');
|
|
});
|
|
});
|
|
|
|
// ========== Debounce Behavior ==========
|
|
|
|
describe('debounce', () => {
|
|
it('should debounce rapid events for the same file', () => {
|
|
const handler = vi.fn();
|
|
watcher.on('image:detected', handler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
const chokidarWatcher = mockWatchers.get('/home/user/project')!;
|
|
|
|
// Rapid adds of the same file
|
|
chokidarWatcher.emit('add', '/home/user/project/screenshot.jpg');
|
|
vi.advanceTimersByTime(100); // not yet past debounce
|
|
chokidarWatcher.emit('add', '/home/user/project/screenshot.jpg');
|
|
vi.advanceTimersByTime(100);
|
|
chokidarWatcher.emit('add', '/home/user/project/screenshot.jpg');
|
|
vi.advanceTimersByTime(300); // now past debounce from last emit
|
|
|
|
// Should only emit once (the last debounced one)
|
|
expect(handler).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
it('should allow events for different files concurrently', () => {
|
|
const handler = vi.fn();
|
|
watcher.on('image:detected', handler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
const chokidarWatcher = mockWatchers.get('/home/user/project')!;
|
|
|
|
chokidarWatcher.emit('add', '/home/user/project/a.jpg');
|
|
chokidarWatcher.emit('add', '/home/user/project/b.jpg');
|
|
vi.advanceTimersByTime(300);
|
|
|
|
expect(handler).toHaveBeenCalledTimes(2);
|
|
});
|
|
});
|
|
|
|
// ========== Burst Throttling ==========
|
|
|
|
describe('burst throttling', () => {
|
|
it('should throttle after 20 images in 10 seconds', () => {
|
|
const handler = vi.fn();
|
|
watcher.on('image:detected', handler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
const chokidarWatcher = mockWatchers.get('/home/user/project')!;
|
|
|
|
// Emit 25 unique images in quick succession
|
|
for (let i = 0; i < 25; i++) {
|
|
chokidarWatcher.emit('add', `/home/user/project/img${i}.jpg`);
|
|
vi.advanceTimersByTime(250); // past debounce, within burst window
|
|
}
|
|
|
|
// Only 20 should get through (BURST_LIMIT = 20)
|
|
expect(handler).toHaveBeenCalledTimes(20);
|
|
});
|
|
|
|
it('should reset burst counter after window expires', () => {
|
|
const handler = vi.fn();
|
|
watcher.on('image:detected', handler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
const chokidarWatcher = mockWatchers.get('/home/user/project')!;
|
|
|
|
// Fill up burst limit
|
|
for (let i = 0; i < 20; i++) {
|
|
chokidarWatcher.emit('add', `/home/user/project/img${i}.jpg`);
|
|
vi.advanceTimersByTime(250);
|
|
}
|
|
expect(handler).toHaveBeenCalledTimes(20);
|
|
|
|
// Wait for burst window to expire (10 seconds)
|
|
vi.advanceTimersByTime(11_000);
|
|
|
|
// Should accept new images
|
|
chokidarWatcher.emit('add', '/home/user/project/new.jpg');
|
|
vi.advanceTimersByTime(300);
|
|
|
|
expect(handler).toHaveBeenCalledTimes(21);
|
|
});
|
|
});
|
|
|
|
// ========== Error Handling ==========
|
|
|
|
describe('error handling', () => {
|
|
it('should emit image:error on chokidar error', () => {
|
|
const errorHandler = vi.fn();
|
|
watcher.on('image:error', errorHandler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
const chokidarWatcher = mockWatchers.get('/home/user/project')!;
|
|
|
|
const testError = new Error('watch failed');
|
|
chokidarWatcher.emit('error', testError);
|
|
|
|
expect(errorHandler).toHaveBeenCalledWith(testError, 'session-1');
|
|
});
|
|
|
|
it('should emit image:error if statSync fails during emission', () => {
|
|
vi.mocked(statSync).mockImplementation(() => {
|
|
throw new Error('ENOENT');
|
|
});
|
|
|
|
const errorHandler = vi.fn();
|
|
const detectHandler = vi.fn();
|
|
watcher.on('image:error', errorHandler);
|
|
watcher.on('image:detected', detectHandler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
mockWatchers.get('/home/user/project')!.emit('add', '/home/user/project/deleted.png');
|
|
vi.advanceTimersByTime(300);
|
|
|
|
expect(detectHandler).not.toHaveBeenCalled();
|
|
expect(errorHandler).toHaveBeenCalled();
|
|
|
|
// Restore
|
|
vi.mocked(statSync).mockReturnValue({ size: 2048 } as ReturnType<typeof statSync>);
|
|
});
|
|
});
|
|
|
|
// ========== Stop / Cleanup ==========
|
|
|
|
describe('stop', () => {
|
|
it('should close all chokidar watchers', () => {
|
|
watcher.watchSession('session-1', '/home/user/project-a');
|
|
watcher.watchSession('session-2', '/home/user/project-b');
|
|
|
|
watcher.stop();
|
|
|
|
for (const w of mockWatchers.values()) {
|
|
expect(w.close).toHaveBeenCalled();
|
|
}
|
|
});
|
|
|
|
it('should clear all maps', () => {
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
watcher.stop();
|
|
|
|
expect(watcher.getWatchedSessions()).toHaveLength(0);
|
|
expect(watcher.isRunning()).toBe(false);
|
|
});
|
|
|
|
it('should clear debounce timers so no events fire after stop', () => {
|
|
const handler = vi.fn();
|
|
watcher.on('image:detected', handler);
|
|
|
|
watcher.watchSession('session-1', '/home/user/project');
|
|
mockWatchers.get('/home/user/project')!.emit('add', '/home/user/project/screenshot.png');
|
|
|
|
// Stop before debounce fires
|
|
watcher.stop();
|
|
vi.advanceTimersByTime(500);
|
|
|
|
expect(handler).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
});
|