// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license. import { assert, assertEquals, assertThrows, delay } from "./test_util.ts"; // TODO(ry) Add more tests to specify format. Deno.test({ permissions: { read: false } }, function watchFsPermissions() { assertThrows(() => { Deno.watchFs("."); }, Deno.errors.NotCapable); }); Deno.test({ permissions: { read: true } }, function watchFsInvalidPath() { if (Deno.build.os === "windows") { assertThrows( () => { Deno.watchFs("non-existent.file"); }, Error, "Input watch path is neither a file nor a directory", ); } else { assertThrows(() => { Deno.watchFs("non-existent.file"); }, Deno.errors.NotFound); } }); async function getTwoEvents( iter: Deno.FsWatcher, ): Promise { const events = []; for await (const event of iter) { events.push(event); if (events.length > 2) break; } return events; } async function makeTempDir(): Promise { const testDir = await Deno.makeTempDir(); // The watcher sometimes witnesses the creation of it's own root // directory. Delay a bit. await delay(100); return testDir; } Deno.test( { permissions: { read: true, write: true } }, async function watchFsBasic() { const testDir = await makeTempDir(); const iter = Deno.watchFs(testDir); // Asynchronously capture two fs events. const eventsPromise = getTwoEvents(iter); // Make some random file system activity. const file1 = testDir + "/file1.txt"; const file2 = testDir + "/file2.txt"; Deno.writeFileSync(file1, new Uint8Array([0, 1, 2])); Deno.writeFileSync(file2, new Uint8Array([0, 1, 2])); // We should have gotten two fs events. const events = await eventsPromise; assert(events.length >= 2); assert(events[0].kind == "create"); assert(events[0].paths[0].includes(testDir)); assert(events[1].kind == "create" || events[1].kind == "modify"); assert(events[1].paths[0].includes(testDir)); }, ); Deno.test( { permissions: { read: true, write: true } }, async function watchFsRename() { const testDir = await makeTempDir(); const watcher = Deno.watchFs(testDir); async function waitForRename() { for await (const event of watcher) { if (event.kind === "rename") { break; } } } const eventPromise = waitForRename(); const file = testDir + "/file.txt"; await Deno.writeTextFile(file, "hello"); await Deno.rename(file, testDir + "/file2.txt"); await eventPromise; }, ); Deno.test( { permissions: { read: true, write: true } }, async function watchFsReturn() { const testDir = await makeTempDir(); const iter = Deno.watchFs(testDir); // Asynchronously loop events. const eventsPromise = getTwoEvents(iter); // Close the watcher. await iter.return!(); // Expect zero events. const events = await eventsPromise; assertEquals(events, []); }, ); Deno.test( { permissions: { read: true, write: true } }, async function watchFsClose() { const testDir = await makeTempDir(); const iter = Deno.watchFs(testDir); // Asynchronously loop events. const eventsPromise = getTwoEvents(iter); // Close the watcher. iter.close(); // Expect zero events. const events = await eventsPromise; assertEquals(events, []); }, ); Deno.test( { permissions: { read: true, write: true } }, async function watchFsExplicitResourceManagement() { let res; { const testDir = await makeTempDir(); using iter = Deno.watchFs(testDir); res = iter[Symbol.asyncIterator]().next(); } const { done } = await res; assert(done); }, ); Deno.test( { permissions: { read: true, write: true } }, async function watchFsExplicitResourceManagementManualClose() { const testDir = await makeTempDir(); using iter = Deno.watchFs(testDir); const res = iter[Symbol.asyncIterator]().next(); iter.close(); const { done } = await res; assert(done); }, );