1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-04 17:18:23 -05:00
denoland-deno/tests/unit_node/_fs/_fs_watch_test.ts
Marvin Hagemeister 9e6288ec61
fix(node/fs/promises): watch should be async iterable (#24805)
The way `fs.watch` works is different in `node:fs/promises` than
`node:fs`. It has a different function signature and it returns an async
iterable instead, see
https://nodejs.org/api/fs.html#fspromiseswatchfilename-options

Fixes https://github.com/denoland/deno/issues/24661
2024-07-31 13:07:49 +02:00

98 lines
2.5 KiB
TypeScript

// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
import { unwatchFile, watch, watchFile } from "node:fs";
import { watch as watchPromise } from "node:fs/promises";
import { assert, assertEquals } from "@std/assert";
function wait(time: number) {
return new Promise((resolve) => {
setTimeout(resolve, time);
});
}
Deno.test({
name: "watching a file",
async fn() {
const file = Deno.makeTempFileSync();
const result: Array<[string, string | null]> = [];
const watcher = watch(
file,
(eventType, filename) => result.push([eventType, filename]),
);
await wait(100);
Deno.writeTextFileSync(file, "something");
await wait(100);
watcher.close();
await wait(100);
assertEquals(result.length >= 1, true);
},
});
Deno.test({
name: "watching a file with options",
async fn() {
const file = Deno.makeTempFileSync();
watchFile(
file,
() => {},
);
await wait(100);
unwatchFile(file);
},
});
Deno.test({
name: "watch.unref() should work",
sanitizeOps: false,
sanitizeResources: false,
async fn() {
const file = Deno.makeTempFileSync();
const watcher = watch(file, () => {});
// Wait for the watcher to be initialized
await wait(10);
// @ts-ignore node types are outdated in deno.
watcher.unref();
},
});
Deno.test({
name: "node [fs/promises] watch should return async iterable",
sanitizeOps: false,
sanitizeResources: false,
async fn() {
const file = Deno.makeTempFileSync();
Deno.writeTextFileSync(file, "foo");
const result: { eventType: string; filename: string | null }[] = [];
const controller = new AbortController();
const watcher = watchPromise(file, {
// Node types resolved by the LSP clash with ours
// deno-lint-ignore no-explicit-any
signal: controller.signal as any,
});
const deferred = Promise.withResolvers<void>();
let stopLength = 0;
setTimeout(async () => {
Deno.writeTextFileSync(file, "something");
controller.abort();
stopLength = result.length;
await wait(100);
Deno.writeTextFileSync(file, "something else");
await wait(100);
deferred.resolve();
}, 100);
for await (const event of watcher) {
result.push(event);
}
await deferred.promise;
assertEquals(result.length, stopLength);
assert(
result.every((item) =>
typeof item.eventType === "string" && typeof item.filename === "string"
),
);
},
});