push.rocks/smartwatch
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

BREAKING CHANGE(watchers): Replace polling-based write stabilization with debounce-based event coalescing and simplify watcher options

Browse Source
This commit is contained in:
Jürgen Kunz
2025-12-08 16:06:18 +00:00
parent 5a6d9a2575
commit 097ea96e99
9 changed files with 106 additions and 288 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
changelog.md
View File

@@ -1,5 +1,16 @@
# Changelog # Changelog
## 2025-12-08 - 6.0.0 - BREAKING CHANGE(watchers)
Replace polling-based write stabilization with debounce-based event coalescing and simplify watcher options
- Remove polling-based WriteStabilizer (ts/utils/write-stabilizer.ts) and related waitForWriteFinish logic
- Introduce debounce-based coalescing (debounceMs) for Node and Deno watchers (ts/watchers/watcher.node.ts, ts/watchers/watcher.deno.ts)
- Change IWatcherOptions: remove stabilityThreshold/pollInterval/maxWaitTime and add debounceMs
- Default watcher options updated to use debounceMs = 100
- Node/Deno watchers now skip editor temp files earlier, debounce duplicate events, and emit events directly (no size polling)
- Updated default watcher creation in Smartwatch to pass debounceMs
- Update package.json build script to run 'tsbuild tsfolders'
## 2025-12-08 - 5.1.0 - feat(watchers) ## 2025-12-08 - 5.1.0 - feat(watchers)
Improve write stabilization and ignore temporary editor files Improve write stabilization and ignore temporary editor files

2
package.json
View File

@@ -8,7 +8,7 @@
"scripts": { "scripts": {
"test": "(npm run prepareTest && tstest test/)", "test": "(npm run prepareTest && tstest test/)",
"prepareTest": "(rm -f ./test/assets/hi.txt)", "prepareTest": "(rm -f ./test/assets/hi.txt)",
"build": "tsbuild", "build": "tsbuild tsfolders",
"buildDocs": "tsdoc" "buildDocs": "tsdoc"
}, },
"repository": { "repository": {

2
ts/00_commitinfo_data.ts
View File

@@ -3,6 +3,6 @@
*/ */
export const commitinfo = { export const commitinfo = {
name: '@push.rocks/smartwatch', name: '@push.rocks/smartwatch',
version: '5.1.0', version: '6.0.0',
description: 'A cross-runtime file watcher with glob pattern support for Node.js, Deno, and Bun.' description: 'A cross-runtime file watcher with glob pattern support for Node.js, Deno, and Bun.'
} }

4
ts/smartwatch.classes.smartwatch.ts
View File

@@ -132,9 +132,7 @@ export class Smartwatch {
basePaths: watchPaths, basePaths: watchPaths,
depth: 4, depth: 4,
followSymlinks: false, followSymlinks: false,
stabilityThreshold: 100, debounceMs: 100
pollInterval: 100,
maxWaitTime: 1000
}); });
// Subscribe to watcher events and dispatch to appropriate subjects // Subscribe to watcher events and dispatch to appropriate subjects

109
ts/utils/write-stabilizer.ts
View File

@@ -1,109 +0,0 @@
import * as fs from 'fs';
interface IPendingWrite {
lastSize: number;
lastChange: number;
startTime: number;
timeoutId: ReturnType<typeof setTimeout>;
resolve: (stats: fs.Stats) => void;
reject: (error: Error) => void;
}
/**
* Implements awaitWriteFinish functionality by polling file size until stable.
* This replaces chokidar's built-in write stabilization.
*/
export class WriteStabilizer {
private pendingWrites = new Map<string, IPendingWrite>();
constructor(
private stabilityThreshold: number = 100,
private pollInterval: number = 100,
private maxWaitTime: number = 1000
) {}
/**
* Wait for a file write to complete by polling until size is stable
*/
async waitForWriteFinish(filePath: string): Promise<fs.Stats> {
// Cancel any existing pending check for this file
this.cancel(filePath);
return new Promise((resolve, reject) => {
const startTime = Date.now();
const poll = async () => {
try {
const stats = await fs.promises.stat(filePath);
const pending = this.pendingWrites.get(filePath);
if (!pending) {
// Was cancelled
return;
}
const now = Date.now();
// Check if we've exceeded max wait time - emit with current stats
if (now - pending.startTime >= this.maxWaitTime) {
this.pendingWrites.delete(filePath);
resolve(stats);
return;
}
if (stats.size !== pending.lastSize) {
// Size changed - file is still being written, reset timer
pending.lastSize = stats.size;
pending.lastChange = now;
pending.timeoutId = setTimeout(poll, this.pollInterval);
} else if (now - pending.lastChange >= this.stabilityThreshold) {
// Size has been stable for the threshold duration
this.pendingWrites.delete(filePath);
resolve(stats);
} else {
// Size is the same but not yet past threshold
pending.timeoutId = setTimeout(poll, this.pollInterval);
}
} catch (error: any) {
this.pendingWrites.delete(filePath);
if (error.code === 'ENOENT') {
// File was deleted during polling
reject(new Error(`File was deleted: ${filePath}`));
} else {
reject(error);
}
}
};
this.pendingWrites.set(filePath, {
lastSize: -1,
lastChange: startTime,
startTime: startTime,
timeoutId: setTimeout(poll, this.pollInterval),
resolve,
reject
});
});
}
/**
* Cancel any pending write stabilization for a file
*/
cancel(filePath: string): void {
const pending = this.pendingWrites.get(filePath);
if (pending) {
clearTimeout(pending.timeoutId);
this.pendingWrites.delete(filePath);
}
}
/**
* Cancel all pending write stabilizations
*/
cancelAll(): void {
for (const [filePath, pending] of this.pendingWrites) {
clearTimeout(pending.timeoutId);
}
this.pendingWrites.clear();
}
}

4
ts/watchers/index.ts
View File

@@ -28,7 +28,5 @@ export const defaultWatcherOptions: IWatcherOptions = {
basePaths: [], basePaths: [],
depth: 4, depth: 4,
followSymlinks: false, followSymlinks: false,
stabilityThreshold: 100, debounceMs: 100
pollInterval: 100,
maxWaitTime: 1000
}; };

8
ts/watchers/interfaces.ts
View File

@@ -26,12 +26,8 @@ export interface IWatcherOptions {
depth: number; depth: number;
/** Whether to follow symbolic links */ /** Whether to follow symbolic links */
followSymlinks: boolean; followSymlinks: boolean;
/** Stability threshold for write detection (ms) */ /** Debounce time in ms - events for the same file within this window are coalesced */
stabilityThreshold: number; debounceMs: number;
/** Poll interval for write detection (ms) */
pollInterval: number;
/** Maximum time to wait for write stabilization (ms) */
maxWaitTime: number;
} }
/** /**

136
ts/watchers/watcher.deno.ts
View File

@@ -65,10 +65,9 @@ export class DenoWatcher implements IWatcher {
private watcher: ReturnType<typeof Deno.watchFs> | null = null; private watcher: ReturnType<typeof Deno.watchFs> | null = null;
private watchedFiles: Set<string> = new Set(); private watchedFiles: Set<string> = new Set();
private _isWatching = false; private _isWatching = false;
private abortController: AbortController | null = null;
private recentEvents: Map<string, number> = new Map(); // Debounce: pending emits per file path
private throttleMs = 50; private pendingEmits: Map<string, ReturnType<typeof setTimeout>> = new Map();
private pendingWrites: Map<string, ReturnType<typeof setTimeout>> = new Map();
public readonly events$ = new smartrx.rxjs.Subject<IWatchEvent>(); public readonly events$ = new smartrx.rxjs.Subject<IWatchEvent>();
@@ -97,8 +96,6 @@ export class DenoWatcher implements IWatcher {
} }
try { try {
this.abortController = new AbortController();
// Start watching all base paths // Start watching all base paths
this.watcher = Deno.watchFs(this.options.basePaths, { recursive: true }); this.watcher = Deno.watchFs(this.options.basePaths, { recursive: true });
this._isWatching = true; this._isWatching = true;
@@ -122,11 +119,11 @@ export class DenoWatcher implements IWatcher {
async stop(): Promise<void> { async stop(): Promise<void> {
this._isWatching = false; this._isWatching = false;
// Cancel all pending write stabilizations // Cancel all pending debounced emits
for (const timeout of this.pendingWrites.values()) { for (const timeout of this.pendingEmits.values()) {
clearTimeout(timeout); clearTimeout(timeout);
} }
this.pendingWrites.clear(); this.pendingEmits.clear();
// Close the watcher // Close the watcher
if (this.watcher) { if (this.watcher) {
@@ -135,7 +132,6 @@ export class DenoWatcher implements IWatcher {
} }
this.watchedFiles.clear(); this.watchedFiles.clear();
this.recentEvents.clear();
} }
/** /**
@@ -153,7 +149,7 @@ export class DenoWatcher implements IWatcher {
} }
for (const filePath of event.paths) { for (const filePath of event.paths) {
await this.handleDenoEvent(event.kind, filePath); this.handleDenoEvent(event.kind, filePath);
} }
} }
} catch (error: any) { } catch (error: any) {
@@ -164,12 +160,12 @@ export class DenoWatcher implements IWatcher {
} }
/** /**
* Handle a Deno file system event * Handle a Deno file system event - debounce and normalize
*/ */
private async handleDenoEvent( private handleDenoEvent(
kind: 'create' | 'modify' | 'remove' | 'access' | 'any' | 'other', kind: 'create' | 'modify' | 'remove' | 'access' | 'any' | 'other',
filePath: string filePath: string
): Promise<void> { ): void {
// Ignore 'access' events (just reading the file) // Ignore 'access' events (just reading the file)
if (kind === 'access') { if (kind === 'access') {
return; return;
@@ -180,14 +176,30 @@ export class DenoWatcher implements IWatcher {
return; return;
} }
// Throttle duplicate events // Debounce: cancel any pending emit for this file
if (!this.shouldEmit(filePath, kind)) { const existing = this.pendingEmits.get(filePath);
return; if (existing) {
clearTimeout(existing);
} }
// Schedule debounced emit
const timeout = setTimeout(() => {
this.pendingEmits.delete(filePath);
this.emitFileEvent(filePath, kind);
}, this.options.debounceMs);
this.pendingEmits.set(filePath, timeout);
}
/**
* Emit the actual file event after debounce
*/
private async emitFileEvent(
filePath: string,
kind: 'create' | 'modify' | 'remove' | 'access' | 'any' | 'other'
): Promise<void> {
try { try {
if (kind === 'create') { if (kind === 'create') {
// Create events (atomic saves) don't need stabilization - file is already complete
const stats = await this.statSafe(filePath); const stats = await this.statSafe(filePath);
if (stats) { if (stats) {
this.watchedFiles.add(filePath); this.watchedFiles.add(filePath);
@@ -195,16 +207,9 @@ export class DenoWatcher implements IWatcher {
this.events$.next({ type: eventType, path: filePath, stats }); this.events$.next({ type: eventType, path: filePath, stats });
} }
} else if (kind === 'modify') { } else if (kind === 'modify') {
// Modify events are in-place writes - use stabilization
const stats = await this.statSafe(filePath); const stats = await this.statSafe(filePath);
if (stats && !stats.isDirectory()) { if (stats && !stats.isDirectory()) {
// Wait for write to stabilize this.events$.next({ type: 'change', path: filePath, stats });
await this.waitForWriteFinish(filePath);
const finalStats = await this.statSafe(filePath);
if (finalStats) {
this.events$.next({ type: 'change', path: filePath, stats: finalStats });
}
} }
} else if (kind === 'remove') { } else if (kind === 'remove') {
const wasDirectory = this.isKnownDirectory(filePath); const wasDirectory = this.isKnownDirectory(filePath);
@@ -219,52 +224,6 @@ export class DenoWatcher implements IWatcher {
} }
} }
/**
* Wait for file write to complete (polling-based)
*/
private async waitForWriteFinish(filePath: string): Promise<void> {
return new Promise((resolve) => {
let lastSize = -1;
let lastChange = Date.now();
const startTime = Date.now();
const poll = async () => {
try {
const stats = await this.statSafe(filePath);
if (!stats) {
resolve();
return;
}
const now = Date.now();
// Check if we've exceeded max wait time - resolve immediately
if (now - startTime >= this.options.maxWaitTime) {
this.pendingWrites.delete(filePath);
resolve();
return;
}
if (stats.size !== lastSize) {
lastSize = stats.size;
lastChange = now;
this.pendingWrites.set(filePath, setTimeout(poll, this.options.pollInterval));
} else if (now - lastChange >= this.options.stabilityThreshold) {
this.pendingWrites.delete(filePath);
resolve();
} else {
this.pendingWrites.set(filePath, setTimeout(poll, this.options.pollInterval));
}
} catch {
this.pendingWrites.delete(filePath);
resolve();
}
};
this.pendingWrites.set(filePath, setTimeout(poll, this.options.pollInterval));
});
}
/** /**
* Scan directory and emit 'add' events for existing files * Scan directory and emit 'add' events for existing files
*/ */
@@ -276,6 +235,12 @@ export class DenoWatcher implements IWatcher {
try { try {
for await (const entry of Deno.readDir(dirPath)) { for await (const entry of Deno.readDir(dirPath)) {
const fullPath = `${dirPath}/${entry.name}`; const fullPath = `${dirPath}/${entry.name}`;
// Skip temp files during initial scan too
if (this.isTemporaryFile(fullPath)) {
continue;
}
const stats = await this.statSafe(fullPath); const stats = await this.statSafe(fullPath);
if (!stats) { if (!stats) {
@@ -322,31 +287,4 @@ export class DenoWatcher implements IWatcher {
} }
return false; return false;
} }
/**
* Throttle duplicate events
*/
private shouldEmit(filePath: string, eventType: string): boolean {
const key = `${filePath}:${eventType}`;
const now = Date.now();
const lastEmit = this.recentEvents.get(key);
if (lastEmit && now - lastEmit < this.throttleMs) {
return false;
}
this.recentEvents.set(key, now);
// Clean up old entries periodically
if (this.recentEvents.size > 1000) {
const cutoff = now - this.throttleMs * 2;
for (const [k, time] of this.recentEvents) {
if (time < cutoff) {
this.recentEvents.delete(k);
}
}
}
return true;
}
} }

104
ts/watchers/watcher.node.ts
View File

@@ -2,7 +2,6 @@ import * as fs from 'fs';
import * as path from 'path'; import * as path from 'path';
import * as smartrx from '@push.rocks/smartrx'; import * as smartrx from '@push.rocks/smartrx';
import type { IWatcher, IWatcherOptions, IWatchEvent, TWatchEventType } from './interfaces.js'; import type { IWatcher, IWatcherOptions, IWatchEvent, TWatchEventType } from './interfaces.js';
import { WriteStabilizer } from '../utils/write-stabilizer.js';
/** /**
* Node.js/Bun file watcher using native fs.watch API * Node.js/Bun file watcher using native fs.watch API
@@ -11,19 +10,13 @@ export class NodeWatcher implements IWatcher {
private watchers: Map<string, fs.FSWatcher> = new Map(); private watchers: Map<string, fs.FSWatcher> = new Map();
private watchedFiles: Set<string> = new Set(); private watchedFiles: Set<string> = new Set();
private _isWatching = false; private _isWatching = false;
private writeStabilizer: WriteStabilizer;
private recentEvents: Map<string, number> = new Map(); // Debounce: pending emits per file path
private throttleMs = 50; private pendingEmits: Map<string, NodeJS.Timeout> = new Map();
public readonly events$ = new smartrx.rxjs.Subject<IWatchEvent>(); public readonly events$ = new smartrx.rxjs.Subject<IWatchEvent>();
constructor(private options: IWatcherOptions) { constructor(private options: IWatcherOptions) {}
this.writeStabilizer = new WriteStabilizer(
options.stabilityThreshold,
options.pollInterval,
options.maxWaitTime
);
}
/** /**
* Check if a file is a temporary file created by editors * Check if a file is a temporary file created by editors
@@ -70,15 +63,19 @@ export class NodeWatcher implements IWatcher {
async stop(): Promise<void> { async stop(): Promise<void> {
this._isWatching = false; this._isWatching = false;
this.writeStabilizer.cancelAll();
// Cancel all pending debounced emits
for (const timeout of this.pendingEmits.values()) {
clearTimeout(timeout);
}
this.pendingEmits.clear();
// Close all watchers // Close all watchers
for (const [watchPath, watcher] of this.watchers) { for (const [, watcher] of this.watchers) {
watcher.close(); watcher.close();
} }
this.watchers.clear(); this.watchers.clear();
this.watchedFiles.clear(); this.watchedFiles.clear();
this.recentEvents.clear();
} }
/** /**
@@ -119,13 +116,13 @@ export class NodeWatcher implements IWatcher {
} }
/** /**
* Handle raw fs.watch events and normalize them * Handle raw fs.watch events - debounce and normalize them
*/ */
private async handleFsEvent( private handleFsEvent(
basePath: string, basePath: string,
filename: string, filename: string,
eventType: 'rename' | 'change' | string eventType: 'rename' | 'change' | string
): Promise<void> { ): void {
const fullPath = path.join(basePath, filename); const fullPath = path.join(basePath, filename);
// Skip temporary files created by editors (atomic saves) // Skip temporary files created by editors (atomic saves)
@@ -133,11 +130,28 @@ export class NodeWatcher implements IWatcher {
return; return;
} }
// Throttle duplicate events // Debounce: cancel any pending emit for this file
if (!this.shouldEmit(fullPath, eventType)) { const existing = this.pendingEmits.get(fullPath);
return; if (existing) {
clearTimeout(existing);
} }
// Schedule debounced emit
const timeout = setTimeout(() => {
this.pendingEmits.delete(fullPath);
this.emitFileEvent(fullPath, eventType);
}, this.options.debounceMs);
this.pendingEmits.set(fullPath, timeout);
}
/**
* Emit the actual file event after debounce
*/
private async emitFileEvent(
fullPath: string,
eventType: 'rename' | 'change' | string
): Promise<void> {
try { try {
const stats = await this.statSafe(fullPath); const stats = await this.statSafe(fullPath);
@@ -151,7 +165,6 @@ export class NodeWatcher implements IWatcher {
this.events$.next({ type: 'addDir', path: fullPath, stats }); this.events$.next({ type: 'addDir', path: fullPath, stats });
} }
} else { } else {
// Rename events (atomic saves) don't need stabilization - file is already complete
const wasWatched = this.watchedFiles.has(fullPath); const wasWatched = this.watchedFiles.has(fullPath);
this.watchedFiles.add(fullPath); this.watchedFiles.add(fullPath);
this.events$.next({ this.events$.next({
@@ -172,28 +185,22 @@ export class NodeWatcher implements IWatcher {
} }
} }
} else if (eventType === 'change') { } else if (eventType === 'change') {
// File was modified in-place - use stabilization for streaming writes // File was modified
if (stats && !stats.isDirectory()) { if (stats && !stats.isDirectory()) {
try {
const stableStats = await this.writeStabilizer.waitForWriteFinish(fullPath);
// Check if this is a new file (not yet in watchedFiles)
const wasWatched = this.watchedFiles.has(fullPath); const wasWatched = this.watchedFiles.has(fullPath);
if (!wasWatched) { if (!wasWatched) {
// This is actually an 'add' - file wasn't being watched before // This is actually an 'add' - file wasn't being watched before
this.watchedFiles.add(fullPath); this.watchedFiles.add(fullPath);
this.events$.next({ type: 'add', path: fullPath, stats: stableStats }); this.events$.next({ type: 'add', path: fullPath, stats });
} else { } else {
this.events$.next({ type: 'change', path: fullPath, stats: stableStats }); this.events$.next({ type: 'change', path: fullPath, stats });
} }
} catch { } else if (!stats && this.watchedFiles.has(fullPath)) {
// File was deleted during write // File was deleted
if (this.watchedFiles.has(fullPath)) {
this.watchedFiles.delete(fullPath); this.watchedFiles.delete(fullPath);
this.events$.next({ type: 'unlink', path: fullPath }); this.events$.next({ type: 'unlink', path: fullPath });
} }
} }
}
}
} catch (error: any) { } catch (error: any) {
this.events$.next({ type: 'error', path: fullPath, error }); this.events$.next({ type: 'error', path: fullPath, error });
} }
@@ -212,6 +219,12 @@ export class NodeWatcher implements IWatcher {
for (const entry of entries) { for (const entry of entries) {
const fullPath = path.join(dirPath, entry.name); const fullPath = path.join(dirPath, entry.name);
// Skip temp files during initial scan too
if (this.isTemporaryFile(fullPath)) {
continue;
}
const stats = await this.statSafe(fullPath); const stats = await this.statSafe(fullPath);
if (!stats) { if (!stats) {
@@ -261,31 +274,4 @@ export class NodeWatcher implements IWatcher {
} }
return false; return false;
} }
/**
* Throttle duplicate events
*/
private shouldEmit(filePath: string, eventType: string): boolean {
const key = `${filePath}:${eventType}`;
const now = Date.now();
const lastEmit = this.recentEvents.get(key);
if (lastEmit && now - lastEmit < this.throttleMs) {
return false;
}
this.recentEvents.set(key, now);
// Clean up old entries periodically
if (this.recentEvents.size > 1000) {
const cutoff = now - this.throttleMs * 2;
for (const [k, time] of this.recentEvents) {
if (time < cutoff) {
this.recentEvents.delete(k);
}
}
}
return true;
}
} }