tests/unit_node/_fs/_fs_watch_test.ts - main - githubmirror/deno

tests/unit_node/_fs/_fs_watch_test.ts
177 строк4 KB
Luna
fix(ext/node): detect non-mtime stat changes in StatWatcher (#33950)
13 май 2026, 23:29
13 май 2026, 23:2948c2bbb
// Copyright 2018-2026 the Deno authors. MIT license.
import {
  type BigIntStats,
  type Stats,
  unwatchFile,
  watch,
  watchFile,
} from "node:fs";
import { watch as watchPromise } from "node:fs/promises";
import { assert, assertEquals, assertRejects } from "@std/assert";
import { spy } from "@std/testing/mock";

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",
  // TODO(bartlomieju): this test is flaky on CI
  ignore: true,
  async fn() {
    const file = Deno.makeTempFileSync();
    const spyFn = spy();
    watchFile(
      file,
      { interval: 10 },
      spyFn,
    );
    await wait(100);
    assertEquals(spyFn.calls.length, 0);
    await Deno.writeTextFile(file, "something");
    await wait(100);
    assertEquals(spyFn.calls.length, 1);
    unwatchFile(file);
    await wait(100);
    assertEquals(spyFn.calls.length, 1);
  },
});

Deno.test({
  name: "watchFile detects metadata-only changes (chmod)",
  ignore: Deno.build.os === "windows",
  async fn() {
    const file = Deno.makeTempFileSync();
    Deno.writeTextFileSync(file, "foo");
    Deno.chmodSync(file, 0o644);

    const calls: Array<[Stats, Stats]> = [];
    watchFile(
      file,
      { interval: 10 },
      (curr, prev) => calls.push([curr as Stats, prev as Stats]),
    );

    try {
      await wait(50);
      assertEquals(calls.length, 0);
      Deno.chmodSync(file, 0o600);
      await wait(150);
      assertEquals(calls.length, 1);
      assert(calls[0][0].mode !== calls[0][1].mode);
    } finally {
      unwatchFile(file);
    }
  },
});

Deno.test({
  name: "watchFile honors bigint option",
  async fn() {
    const file = Deno.makeTempFileSync();
    Deno.writeTextFileSync(file, "foo");

    const calls: Array<[BigIntStats, BigIntStats]> = [];
    watchFile(
      file,
      { interval: 10, bigint: true },
      (curr, prev) => calls.push([curr as BigIntStats, prev as BigIntStats]),
    );

    try {
      await wait(50);
      Deno.writeTextFileSync(file, "bar");
      await wait(150);
      assert(calls.length >= 1);
      assertEquals(typeof calls[0][0].mtimeMs, "bigint");
      assertEquals(typeof calls[0][0].ino, "bigint");
    } finally {
      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);

    // Aborting the signal must surface as an AbortError thrown from the
    // async iterator, matching Node's `fs.promises.watch` behavior.
    await assertRejects(
      async () => {
        for await (const event of watcher) {
          result.push(event);
        }
      },
      Error,
      "The operation was aborted",
    );
    await deferred.promise;

    assertEquals(result.length, stopLength);
    assert(
      result.every((item) =>
        typeof item.eventType === "string" && typeof item.filename === "string"
      ),
    );
  },
});