Skip to content

Commit f1de808

Browse files
committed
fix(cli): emit every file in a watcher burst
1 parent 4d2a48a commit f1de808

2 files changed

Lines changed: 44 additions & 6 deletions

File tree

‎packages/cli/src/server/fileWatcher.test.ts‎

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
11
import { EventEmitter } from "node:events";
2-
import { describe, expect, it, vi } from "vitest";
2+
import { beforeEach, describe, expect, it, vi } from "vitest";
3+
4+
type WatchCallback = (eventType: string, filename: string | Buffer | null) => void;
35

46
const mockWatcher = new EventEmitter() as EventEmitter & { close: () => void };
57
mockWatcher.close = vi.fn();
68

7-
vi.mock("node:fs", () => ({
8-
watch: vi.fn(() => mockWatcher),
9-
}));
9+
vi.mock("node:fs", async (importOriginal) => {
10+
const original = await importOriginal<typeof import("node:fs")>();
11+
return {
12+
...original,
13+
watch: vi.fn((_path: string, _options: unknown, onChange: WatchCallback) => {
14+
mockWatcher.on("change", onChange);
15+
return mockWatcher;
16+
}),
17+
};
18+
});
1019

1120
const { shouldWatchProjectFile, createProjectWatcher } = await import("./fileWatcher.js");
1221

@@ -30,6 +39,27 @@ describe("shouldWatchProjectFile", () => {
3039
});
3140

3241
describe("createProjectWatcher", () => {
42+
beforeEach(() => {
43+
mockWatcher.removeAllListeners();
44+
vi.clearAllMocks();
45+
vi.useRealTimers();
46+
});
47+
48+
it("notifies once for every file changed in one debounce burst", () => {
49+
vi.useFakeTimers();
50+
const projectWatcher = createProjectWatcher("/fake/project/dir");
51+
const listener = vi.fn();
52+
projectWatcher.addListener(listener);
53+
54+
mockWatcher.emit("change", "change", "scene-a.html");
55+
mockWatcher.emit("change", "change", "scene-b.html");
56+
mockWatcher.emit("change", "change", "scene-a.html");
57+
vi.advanceTimersByTime(300);
58+
59+
expect(listener.mock.calls).toEqual([["scene-a.html"], ["scene-b.html"]]);
60+
projectWatcher.close();
61+
});
62+
3363
// Regression: fs.watch can fail asynchronously (e.g. EMFILE from exhausted
3464
// OS watch handles) via an 'error' event, not a thrown exception. An
3565
// EventEmitter 'error' with no listener crashes the whole process — this

‎packages/cli/src/server/fileWatcher.ts‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ export function shouldWatchProjectFile(filename: string): boolean {
3434

3535
export function createProjectWatcher(projectDir: string): ProjectWatcher {
3636
const listeners = new Set<FileChangeListener>();
37+
const pendingPaths = new Set<string>();
3738
let debounceTimer: ReturnType<typeof setTimeout> | null = null;
3839
let watcher: FSWatcher | null = null;
3940

@@ -43,10 +44,16 @@ export function createProjectWatcher(projectDir: string): ProjectWatcher {
4344
const relativePath = filename.toString();
4445
if (!shouldWatchProjectFile(relativePath)) return;
4546

47+
pendingPaths.add(relativePath);
4648
if (debounceTimer) clearTimeout(debounceTimer);
4749
debounceTimer = setTimeout(() => {
48-
for (const fn of listeners) {
49-
fn(relativePath);
50+
const changedPaths = [...pendingPaths];
51+
pendingPaths.clear();
52+
debounceTimer = null;
53+
for (const changedPath of changedPaths) {
54+
for (const fn of listeners) {
55+
fn(changedPath);
56+
}
5057
}
5158
}, DEBOUNCE_MS);
5259
});
@@ -72,6 +79,7 @@ export function createProjectWatcher(projectDir: string): ProjectWatcher {
7279
},
7380
close() {
7481
if (debounceTimer) clearTimeout(debounceTimer);
82+
pendingPaths.clear();
7583
watcher?.close();
7684
listeners.clear();
7785
},

0 commit comments

Comments
 (0)