@theia/filesystem 1.77.0-next.95 → 1.77.0

package/lib/node/nodejs-watcher/node-directory-watcher.spec.js

@@ -1,4 +1,3 @@
-"use strict";
 // *****************************************************************************
 // Copyright (C) 2026 Ehab Younes and others.
 //
@@ -14,26 +13,24 @@
 //
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 // *****************************************************************************
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const assert = tslib_1.__importStar(require("assert"));
-const path = tslib_1.__importStar(require("path"));
-const temp = tslib_1.__importStar(require("temp"));
-const fs = tslib_1.__importStar(require("@theia/core/shared/fs-extra"));
-const events_1 = require("events");
-const promise_util_1 = require("@theia/core/lib/common/promise-util");
-const core_1 = require("@theia/core");
-const node_1 = require("@theia/core/lib/node");
-const watcher_test_helper_1 = require("../test/watcher-test-helper");
-const node_directory_watcher_1 = require("./node-directory-watcher");
-const watcher_host_1 = require("./watcher-host");
+import * as assert from 'assert';
+import * as path from 'path';
+import * as temp from 'temp';
+import * as fs from '@theia/core/shared/fs-extra';
+import { EventEmitter } from 'events';
+import { Deferred, wait } from '@theia/core/lib/common/promise-util';
+import { isWindows } from '@theia/core';
+import { FileUri } from '@theia/core/lib/node';
+import { NO_LOGGING, TempDir, WATCHER_TIMINGS as TIMINGS } from '../test/watcher-test-helper.js';
+import { DirectoryWatcherProvider, NodeDirectoryWatcher } from './node-directory-watcher.js';
+import { WatcherHost } from './watcher-host.js';
 const track = temp.track();
 /** How long to keep listening after the expected changes arrived, to catch any that should not have. */
-const SETTLE_DELAY = watcher_test_helper_1.WATCHER_TIMINGS.deleteDelay * 3;
+const SETTLE_DELAY = TIMINGS.deleteDelay * 3;
 /** Indexed by `FileChangeType`. */
 const CHANGE_NAMES = ['updated', 'added', 'deleted'];
 /** Replaces the whole platform boundary, so behaviour no host can reproduce is driven directly. */
-class TestHost extends watcher_host_1.WatcherHost {
+class TestHost extends WatcherHost {
     constructor() {
         super(...arguments);
         /** Set to exercise the macOS and Windows name handling on any host. */
@@ -42,7 +39,7 @@ class TestHost extends watcher_host_1.WatcherHost {
         this.caseInsensitive = super.caseInsensitiveFileNames;
         /** Set to make `fs.watch` refuse, as on EACCES or an exhausted handle budget. */
         this.refuseToOpen = false;
-        this.missing = new promise_util_1.Deferred();
+        this.missing = new Deferred();
         /** Resolves once `expectMissing` was told a path and that path was found missing. */
         this.whenMissing = this.missing.promise;
         /** How many times a directory was read. */
@@ -92,17 +89,17 @@ class TestHost extends watcher_host_1.WatcherHost {
             throw new Error('EACCES');
         }
         this.listener = listener;
-        this.handleEmitter = new events_1.EventEmitter();
+        this.handleEmitter = new EventEmitter();
         return Object.assign(this.handleEmitter, { close: () => { this.listener = undefined; } });
     }
 }
 /** A temporary directory, the watchers on it, and the changes their clients were told about. */
-class Sandbox extends watcher_test_helper_1.TempDir {
+class Sandbox extends TempDir {
     constructor() {
         super(fs.realpathSync.native(temp.mkdirSync('node-directory-watcher')));
         /** Errors logged by the watchers of this sandbox. */
         this.errors = [];
-        this.logging = { ...watcher_test_helper_1.NO_LOGGING, error: (message) => this.errors.push(message) };
+        this.logging = { ...NO_LOGGING, error: (message) => this.errors.push(message) };
         this.reports = [];
         /** The platform boundary every watcher of this sandbox shares. */
         this.host = new TestHost(this.logging);
@@ -137,7 +134,7 @@ class Sandbox extends watcher_test_helper_1.TempDir {
     }
     /** A watcher whose events the test feeds in, not yet started. */
     starting(target = this.root, ...requests) {
-        return this.track(new node_directory_watcher_1.NodeDirectoryWatcher(target, this.logging, this, watcher_test_helper_1.WATCHER_TIMINGS, this.host), requests);
+        return this.track(new NodeDirectoryWatcher(target, this.logging, this, TIMINGS, this.host), requests);
     }
     /** Feeds the watchers of this sandbox an event as the platform would. */
     fire(eventType, fileName) {
@@ -145,7 +142,7 @@ class Sandbox extends watcher_test_helper_1.TempDir {
     }
     /** A watcher driven by a real `fs.watch` handle, already started. */
     async watchingForReal(target = this.root, ...requests) {
-        const watcher = this.track(new node_directory_watcher_1.NodeDirectoryWatcher(target, this.logging, this, watcher_test_helper_1.WATCHER_TIMINGS, new watcher_host_1.WatcherHost(this.logging)), requests);
+        const watcher = this.track(new NodeDirectoryWatcher(target, this.logging, this, TIMINGS, new WatcherHost(this.logging)), requests);
         await watcher.whenStarted;
         await this.warmUp(watcher, target);
         return watcher;
@@ -161,7 +158,7 @@ class Sandbox extends watcher_test_helper_1.TempDir {
         const deadline = Date.now() + 5000;
         while (!this.reported(99).some(entry => entry.includes('.warmup')) && Date.now() < deadline) {
             fs.writeFileSync(probe, 'ping');
-            await (0, promise_util_1.wait)(100);
+            await wait(100);
         }
         fs.removeSync(probe);
     }
@@ -171,7 +168,7 @@ class Sandbox extends watcher_test_helper_1.TempDir {
             .filter(report => report.clients?.includes(clientId))
             .flatMap(report => report.changes)
             .map(change => {
-            const relative = path.relative(this.root, node_1.FileUri.fsPath(change.uri)).split(path.sep).join('/');
+            const relative = path.relative(this.root, FileUri.fsPath(change.uri)).split(path.sep).join('/');
             return `${CHANGE_NAMES[change.type]} ${relative || '.'}`;
         });
     }
@@ -202,7 +199,7 @@ class Sandbox extends watcher_test_helper_1.TempDir {
             });
             this.notify = undefined;
         }
-        await (0, promise_util_1.wait)(SETTLE_DELAY);
+        await wait(SETTLE_DELAY);
     }
 }
 describe('node-directory-watcher', function () {
@@ -234,7 +231,7 @@ describe('node-directory-watcher', function () {
             box.write('a.txt');
             box.host.duringNextRead = async () => {
                 box.fire('change', 'a.txt');
-                await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.changeDelay * 4);
+                await wait(TIMINGS.changeDelay * 4);
             };
             await box.watching(box.root, box.directory());
             await box.expect(1, 'updated a.txt');
@@ -243,7 +240,7 @@ describe('node-directory-watcher', function () {
             box.host.duringNextRead = async () => {
                 box.write('a.txt');
                 box.fire('rename', 'a.txt');
-                await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.changeDelay * 4);
+                await wait(TIMINGS.changeDelay * 4);
             };
             await box.watching(box.root, box.directory());
             await box.expect(1, 'added a.txt');
@@ -268,10 +265,10 @@ describe('node-directory-watcher', function () {
             box.write('a.txt');
             box.write('b.txt');
             // A long grace period, so the deletions wait for the second batch on a slow host.
-            const watcher = new node_directory_watcher_1.NodeDirectoryWatcher(box.root, watcher_test_helper_1.NO_LOGGING, box, { ...watcher_test_helper_1.WATCHER_TIMINGS, deleteDelay: 1000 }, box.host);
+            const watcher = new NodeDirectoryWatcher(box.root, NO_LOGGING, box, { ...TIMINGS, deleteDelay: 1000 }, box.host);
             watcher.addRequest(0, box.directory());
             await watcher.whenStarted;
-            const lookedUp = new promise_util_1.Deferred();
+            const lookedUp = new Deferred();
             const childLookup = box.host.childLookup.bind(box.host);
             box.host.childLookup = directory => {
                 const storedName = childLookup(directory);
@@ -417,7 +414,7 @@ describe('node-directory-watcher', function () {
         });
         it('reports changes under the path each request asked for', async () => {
             const real = box.mkdir('real');
-            fs.symlinkSync(real, box.path('link'), core_1.isWindows ? 'junction' : 'dir');
+            fs.symlinkSync(real, box.path('link'), isWindows ? 'junction' : 'dir');
             await box.watching(real, box.directory(real), box.directory(box.path('link'), 2, [], real));
             box.write('real', 'a.txt');
             box.fire('rename', 'a.txt');
@@ -483,7 +480,7 @@ describe('node-directory-watcher', function () {
         });
         it('is followed through a symbolic link above it once it appears', async () => {
             const real = box.mkdir('real');
-            fs.symlinkSync(real, box.path('link'), core_1.isWindows ? 'junction' : 'dir');
+            fs.symlinkSync(real, box.path('link'), isWindows ? 'junction' : 'dir');
             const target = box.path('link', 'later');
             box.host.expectMissing(target);
             // Missing, so the provider could not resolve the link and kept the path as it was asked for.
@@ -506,7 +503,7 @@ describe('node-directory-watcher', function () {
             watcher.addRequest(1, box.directory(box.root, 2));
             box.remove('later.txt');
             box.host.fail(new Error('EPERM'));
-            await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.existencePollDelay * 2);
+            await wait(TIMINGS.existencePollDelay * 2);
             box.write('after.txt');
             box.fire('rename', 'after.txt');
             await box.expectAmong(2, 'added after.txt');
@@ -619,7 +616,7 @@ describe('node-directory-watcher', function () {
             };
             box.mkdir('ws');
             box.write('ws', 'a.txt');
-            await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.existencePollDelay * 4);
+            await wait(TIMINGS.existencePollDelay * 4);
             box.mkdir('ws');
             box.write('ws', 'a.txt');
             await box.expect(1, 'deleted ws', 'added ws');
@@ -667,7 +664,7 @@ describe('node-directory-watcher', function () {
             box.host.duringNextRead = async () => {
                 box.write('ws', 'a.txt');
                 box.fire('change', 'a.txt');
-                await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.changeDelay * 4);
+                await wait(TIMINGS.changeDelay * 4);
             };
             await box.watching(target, box.directory(target));
             await box.expect(1);
@@ -685,7 +682,7 @@ describe('node-directory-watcher', function () {
             };
             box.mkdir('cfg');
             box.write('cfg', 'settings.json');
-            await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.existencePollDelay * 6);
+            await wait(TIMINGS.existencePollDelay * 6);
             await box.expect(1, 'deleted cfg');
             await box.expect(2);
         });
@@ -698,7 +695,7 @@ describe('node-directory-watcher', function () {
             box.host.duringNextRead = async () => {
                 box.write('ws', 'a.txt');
                 box.fire('rename', 'a.txt');
-                await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.changeDelay * 4);
+                await wait(TIMINGS.changeDelay * 4);
                 fs.renameSync(target, box.path('ws-old'));
                 box.mkdir('ws');
                 box.write('ws', 'a.txt');
@@ -794,7 +791,7 @@ describe('node-directory-watcher', function () {
             box.host.refuseToOpen = true;
             box.host.expectMissing(target);
             box.starting(target, box.directory(target));
-            await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.existencePollDelay * 2);
+            await wait(TIMINGS.existencePollDelay * 2);
             box.remove('ws');
             await box.host.whenMissing;
             await box.expect(1, 'deleted ws');
@@ -869,7 +866,7 @@ describe('node-directory-watcher', function () {
             const watcher = box.starting(box.root);
             box.host.refuseToOpen = true;
             // Several poll rounds, one report.
-            await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.existencePollDelay * 4);
+            await wait(TIMINGS.existencePollDelay * 4);
             assert.strictEqual(box.errors.length, 1, `expected one report, got ${JSON.stringify(box.errors)}`);
             box.host.refuseToOpen = false;
             watcher.addRequest(0, box.directory());
@@ -884,7 +881,7 @@ describe('node-directory-watcher', function () {
             // decline this one and leave the watcher holding a dead handle for good.
             box.host.duringNextRead = () => box.host.fail(new Error('EPERM'));
             box.host.fail(new Error('EPERM'));
-            await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.existencePollDelay * 5);
+            await wait(TIMINGS.existencePollDelay * 5);
             box.write('a.txt');
             box.fire('rename', 'a.txt');
             await box.expectAmong(1, 'added a.txt');
@@ -912,7 +909,7 @@ describe('node-directory-watcher', function () {
                 box.write('a.txt');
                 box.fire('rename', 'a.txt');
                 // Long enough for the batch to be queued behind the restart before the handle fails again.
-                await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.changeDelay * 4);
+                await wait(TIMINGS.changeDelay * 4);
                 box.host.fail(new Error('EPERM'));
             };
             box.host.fail(new Error('EPERM'));
@@ -924,7 +921,7 @@ describe('node-directory-watcher', function () {
             box.host.duringNextRead = async () => {
                 box.write('a.txt');
                 box.fire('rename', 'a.txt');
-                await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.changeDelay * 4);
+                await wait(TIMINGS.changeDelay * 4);
                 box.host.fail(new Error('EPERM'));
             };
             box.host.fail(new Error('EPERM'));
@@ -963,7 +960,7 @@ describe('node-directory-watcher', function () {
             box.write('later');
             box.host.duringNextRead = () => box.host.fail(new Error('EPERM'));
             box.host.fail(new Error('EPERM'));
-            await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.existencePollDelay * 5);
+            await wait(TIMINGS.existencePollDelay * 5);
             assert.strictEqual(watcher.directory, box.root);
             assert.strictEqual(resolved, 1);
         });
@@ -971,7 +968,7 @@ describe('node-directory-watcher', function () {
             box.write('a.txt');
             box.host.duringNextRead = () => box.host.fail(new Error('EPERM'));
             await box.watching(box.root, box.directory());
-            await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.existencePollDelay * 2);
+            await wait(TIMINGS.existencePollDelay * 2);
             box.write('b.txt');
             box.fire('rename', 'b.txt');
             await box.expect(1, 'added b.txt');
@@ -1009,7 +1006,7 @@ describe('node-directory-watcher', function () {
             const file = box.write('foo.txt');
             box.host.caseInsensitive = true;
             // A long grace period, so the deletion of the old name still waits after the first batch on a slow host.
-            const watcher = new node_directory_watcher_1.NodeDirectoryWatcher(box.root, watcher_test_helper_1.NO_LOGGING, box, { ...watcher_test_helper_1.WATCHER_TIMINGS, deleteDelay: 1000 }, box.host);
+            const watcher = new NodeDirectoryWatcher(box.root, NO_LOGGING, box, { ...TIMINGS, deleteDelay: 1000 }, box.host);
             watcher.addRequest(0, box.file(file));
             watcher.addRequest(1, box.directory(box.root, 2));
             await watcher.whenStarted;
@@ -1079,8 +1076,8 @@ describe('node-directory-watcher', function () {
             assert.strictEqual(box.host.reads - readsBefore, 2);
         });
         it('rejects a timing that would silently become 1ms', () => {
-            assert.throws(() => new node_directory_watcher_1.NodeDirectoryWatcher(box.root, watcher_test_helper_1.NO_LOGGING, box, { ...watcher_test_helper_1.WATCHER_TIMINGS, deleteDelay: 0 }), /positive number/);
-            assert.throws(() => new node_directory_watcher_1.NodeDirectoryWatcher(box.root, watcher_test_helper_1.NO_LOGGING, box, { ...watcher_test_helper_1.WATCHER_TIMINGS, changeDelay: -1 }), /positive number/);
+            assert.throws(() => new NodeDirectoryWatcher(box.root, NO_LOGGING, box, { ...TIMINGS, deleteDelay: 0 }), /positive number/);
+            assert.throws(() => new NodeDirectoryWatcher(box.root, NO_LOGGING, box, { ...TIMINGS, changeDelay: -1 }), /positive number/);
         });
         it('refuses to watch a network share, which crashes macOS', async () => {
             const target = box.mkdir('network-share');
@@ -1114,12 +1111,12 @@ describe('node-directory-watcher', function () {
             await watcher.whenDisposed;
         });
         it('tells a request moved onto a watcher still waiting for its directory about its file once', async () => {
-            const provider = new node_directory_watcher_1.DirectoryWatcherProvider(watcher_test_helper_1.NO_LOGGING, box, { ...watcher_test_helper_1.WATCHER_TIMINGS, existencePollDelay: 400 }, box.host);
+            const provider = new DirectoryWatcherProvider(NO_LOGGING, box, { ...TIMINGS, existencePollDelay: 400 }, box.host);
             const directory = box.path('cfg');
             const file = box.path('cfg', 'settings.json');
             try {
                 await provider.watch(0, box.directory(directory));
-                await (0, promise_util_1.wait)(200);
+                await wait(200);
                 await provider.watch(1, box.file(file, 2));
                 // Both appear right after the directory watcher polled, so the file watcher finds them first.
                 const exists = box.host.exists.bind(box.host);
@@ -1141,7 +1138,7 @@ describe('node-directory-watcher', function () {
             }
         });
         it('opens no second handle on a directory when a file request for it is merged', async () => {
-            const provider = new node_directory_watcher_1.DirectoryWatcherProvider(watcher_test_helper_1.NO_LOGGING, box, watcher_test_helper_1.WATCHER_TIMINGS, box.host);
+            const provider = new DirectoryWatcherProvider(NO_LOGGING, box, TIMINGS, box.host);
             const opened = [];
             const watch = box.host.watch.bind(box.host);
             box.host.watch = (directory, listener) => {
@@ -1164,7 +1161,7 @@ describe('node-directory-watcher', function () {
             }
         });
         it('does not tell a directory request joining a re-keyed file watcher that its directory was added', async () => {
-            const provider = new node_directory_watcher_1.DirectoryWatcherProvider(watcher_test_helper_1.NO_LOGGING, box, watcher_test_helper_1.WATCHER_TIMINGS, box.host);
+            const provider = new DirectoryWatcherProvider(NO_LOGGING, box, TIMINGS, box.host);
             try {
                 await provider.watch(0, box.file(box.path('later.txt')));
                 // Joins after the re-key to the directory, while the file watcher reads its children.
@@ -1183,7 +1180,7 @@ describe('node-directory-watcher', function () {
         it('happens once the last request is released', async () => {
             const watcher = await box.watching(box.root, box.directory(), box.directory(box.root, 2));
             watcher.removeRequest(0);
-            await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.deferredDisposalTimeout * 2);
+            await wait(TIMINGS.deferredDisposalTimeout * 2);
             assert.strictEqual(watcher.isDisposed, false, 'a watcher with a request left must stay alive');
             watcher.removeRequest(1);
             await watcher.whenDisposed;
@@ -1192,7 +1189,7 @@ describe('node-directory-watcher', function () {
             const watcher = await box.watching(box.root, box.directory());
             watcher.removeRequest(0);
             watcher.addRequest(1, box.directory(box.root, 2));
-            await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.deferredDisposalTimeout * 2);
+            await wait(TIMINGS.deferredDisposalTimeout * 2);
             assert.strictEqual(watcher.isDisposed, false);
         });
         it('silences a deletion that was still pending', async () => {
@@ -1205,7 +1202,7 @@ describe('node-directory-watcher', function () {
         });
         it('keeps its state in sync while it briefly has no requests', async () => {
             box.write('a.txt');
-            const watcher = new node_directory_watcher_1.NodeDirectoryWatcher(box.root, watcher_test_helper_1.NO_LOGGING, box, { ...watcher_test_helper_1.WATCHER_TIMINGS, deferredDisposalTimeout: 1000 }, box.host);
+            const watcher = new NodeDirectoryWatcher(box.root, NO_LOGGING, box, { ...TIMINGS, deferredDisposalTimeout: 1000 }, box.host);
             watcher.addRequest(0, box.directory());
             await watcher.whenStarted;
             try {
@@ -1213,7 +1210,7 @@ describe('node-directory-watcher', function () {
                 box.remove('a.txt');
                 box.fire('rename', 'a.txt');
                 watcher.removeRequest(0);
-                await (0, promise_util_1.wait)(watcher_test_helper_1.WATCHER_TIMINGS.deleteDelay * 3);
+                await wait(TIMINGS.deleteDelay * 3);
                 // The deletion was settled meanwhile, so the recreated file is an addition, not an update.
                 watcher.addRequest(1, box.directory(box.root, 2));
                 box.write('a.txt');