feat(watchers): Improve write stabilization and ignore temporary editor files
This commit is contained in:
@@ -28,6 +28,7 @@ export const defaultWatcherOptions: IWatcherOptions = {
|
||||
basePaths: [],
|
||||
depth: 4,
|
||||
followSymlinks: false,
|
||||
stabilityThreshold: 300,
|
||||
pollInterval: 100
|
||||
stabilityThreshold: 100,
|
||||
pollInterval: 100,
|
||||
maxWaitTime: 1000
|
||||
};
|
||||
|
||||
@@ -30,6 +30,8 @@ export interface IWatcherOptions {
|
||||
stabilityThreshold: number;
|
||||
/** Poll interval for write detection (ms) */
|
||||
pollInterval: number;
|
||||
/** Maximum time to wait for write stabilization (ms) */
|
||||
maxWaitTime: number;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -74,6 +74,19 @@ export class DenoWatcher implements IWatcher {
|
||||
|
||||
constructor(private options: IWatcherOptions) {}
|
||||
|
||||
/**
|
||||
* Check if a file is a temporary file created by editors
|
||||
*/
|
||||
private isTemporaryFile(filePath: string): boolean {
|
||||
const basename = filePath.split('/').pop() || '';
|
||||
// Editor temp files: *.tmp.*, *.swp, *.swx, *~, .#*
|
||||
if (basename.includes('.tmp.')) return true;
|
||||
if (basename.endsWith('.swp') || basename.endsWith('.swx')) return true;
|
||||
if (basename.endsWith('~')) return true;
|
||||
if (basename.startsWith('.#')) return true;
|
||||
return false;
|
||||
}
|
||||
|
||||
get isWatching(): boolean {
|
||||
return this._isWatching;
|
||||
}
|
||||
@@ -162,6 +175,11 @@ export class DenoWatcher implements IWatcher {
|
||||
return;
|
||||
}
|
||||
|
||||
// Skip temporary files created by editors (atomic saves)
|
||||
if (this.isTemporaryFile(filePath)) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Throttle duplicate events
|
||||
if (!this.shouldEmit(filePath, kind)) {
|
||||
return;
|
||||
@@ -169,19 +187,15 @@ export class DenoWatcher implements IWatcher {
|
||||
|
||||
try {
|
||||
if (kind === 'create') {
|
||||
// Create events (atomic saves) don't need stabilization - file is already complete
|
||||
const stats = await this.statSafe(filePath);
|
||||
if (stats) {
|
||||
// Wait for write to stabilize
|
||||
await this.waitForWriteFinish(filePath);
|
||||
const finalStats = await this.statSafe(filePath);
|
||||
|
||||
if (finalStats) {
|
||||
this.watchedFiles.add(filePath);
|
||||
const eventType: TWatchEventType = finalStats.isDirectory() ? 'addDir' : 'add';
|
||||
this.events$.next({ type: eventType, path: filePath, stats: finalStats });
|
||||
}
|
||||
this.watchedFiles.add(filePath);
|
||||
const eventType: TWatchEventType = stats.isDirectory() ? 'addDir' : 'add';
|
||||
this.events$.next({ type: eventType, path: filePath, stats });
|
||||
}
|
||||
} else if (kind === 'modify') {
|
||||
// Modify events are in-place writes - use stabilization
|
||||
const stats = await this.statSafe(filePath);
|
||||
if (stats && !stats.isDirectory()) {
|
||||
// Wait for write to stabilize
|
||||
@@ -212,6 +226,7 @@ export class DenoWatcher implements IWatcher {
|
||||
return new Promise((resolve) => {
|
||||
let lastSize = -1;
|
||||
let lastChange = Date.now();
|
||||
const startTime = Date.now();
|
||||
|
||||
const poll = async () => {
|
||||
try {
|
||||
@@ -222,6 +237,14 @@ export class DenoWatcher implements IWatcher {
|
||||
}
|
||||
|
||||
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;
|
||||
|
||||
@@ -20,10 +20,24 @@ export class NodeWatcher implements IWatcher {
|
||||
constructor(private options: IWatcherOptions) {
|
||||
this.writeStabilizer = new WriteStabilizer(
|
||||
options.stabilityThreshold,
|
||||
options.pollInterval
|
||||
options.pollInterval,
|
||||
options.maxWaitTime
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a file is a temporary file created by editors
|
||||
*/
|
||||
private isTemporaryFile(filePath: string): boolean {
|
||||
const basename = path.basename(filePath);
|
||||
// Editor temp files: *.tmp.*, *.swp, *.swx, *~, .#*
|
||||
if (basename.includes('.tmp.')) return true;
|
||||
if (basename.endsWith('.swp') || basename.endsWith('.swx')) return true;
|
||||
if (basename.endsWith('~')) return true;
|
||||
if (basename.startsWith('.#')) return true;
|
||||
return false;
|
||||
}
|
||||
|
||||
get isWatching(): boolean {
|
||||
return this._isWatching;
|
||||
}
|
||||
@@ -114,6 +128,11 @@ export class NodeWatcher implements IWatcher {
|
||||
): Promise<void> {
|
||||
const fullPath = path.join(basePath, filename);
|
||||
|
||||
// Skip temporary files created by editors (atomic saves)
|
||||
if (this.isTemporaryFile(fullPath)) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Throttle duplicate events
|
||||
if (!this.shouldEmit(fullPath, eventType)) {
|
||||
return;
|
||||
@@ -132,23 +151,14 @@ export class NodeWatcher implements IWatcher {
|
||||
this.events$.next({ type: 'addDir', path: fullPath, stats });
|
||||
}
|
||||
} else {
|
||||
// Wait for write to stabilize before emitting
|
||||
try {
|
||||
const stableStats = await this.writeStabilizer.waitForWriteFinish(fullPath);
|
||||
const wasWatched = this.watchedFiles.has(fullPath);
|
||||
this.watchedFiles.add(fullPath);
|
||||
this.events$.next({
|
||||
type: wasWatched ? 'change' : 'add',
|
||||
path: fullPath,
|
||||
stats: stableStats
|
||||
});
|
||||
} catch {
|
||||
// File was deleted during stabilization
|
||||
if (this.watchedFiles.has(fullPath)) {
|
||||
this.watchedFiles.delete(fullPath);
|
||||
this.events$.next({ type: 'unlink', path: fullPath });
|
||||
}
|
||||
}
|
||||
// Rename events (atomic saves) don't need stabilization - file is already complete
|
||||
const wasWatched = this.watchedFiles.has(fullPath);
|
||||
this.watchedFiles.add(fullPath);
|
||||
this.events$.next({
|
||||
type: wasWatched ? 'change' : 'add',
|
||||
path: fullPath,
|
||||
stats
|
||||
});
|
||||
}
|
||||
} else {
|
||||
// File doesn't exist - it was deleted
|
||||
@@ -162,7 +172,7 @@ export class NodeWatcher implements IWatcher {
|
||||
}
|
||||
}
|
||||
} else if (eventType === 'change') {
|
||||
// File was modified
|
||||
// File was modified in-place - use stabilization for streaming writes
|
||||
if (stats && !stats.isDirectory()) {
|
||||
try {
|
||||
const stableStats = await this.writeStabilizer.waitForWriteFinish(fullPath);
|
||||
|
||||
Reference in New Issue
Block a user