fs: add recursive watch for linux #45098

anonrig · 2022-10-20T19:05:23Z

Fixes #36005

List

Add promises API
- fs: add recursive watch for linux #45098 (review)
Add tests for promises API
Add URL as filename tests
Make a decision in making watcher initialization async or sync.
- fs: add recursive watch for linux #45098 (comment)
Add symlink support

CC @nodejs/fs

lib/fs.js

lib/internal/fs/linux_recursive_watcher.js

lib/internal/fs/linux_watcher.js

mcollina

This module uses a mix of callbacks and promises. I would prefer if it only relied on callbacks as it would be a callback API. Maybe I'm a bit too concerned about the intertwining of our two sets of APIs.

This also needs support for the promises API.

lib/internal/fs/watch/linux.js

PR-URL: #45098 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Notable changes: * deps: * update ICU to 72.1 (Michaël Zasso) [#45068](#45068) * doc: * add lukekarrys to collaborators (Luke Karrys) [#45180](#45180) * add anonrig to collaborators (Yagiz Nizipli) [#45002](#45002) * fs: * (SEMVER-MINOR) fs: add recursive watch to linux (Yagiz Nizipli) [#45098](#45098) * util * (SEMVER-MINOR) add MIME utilities (Bradley Farias) [#21128](#21128) PR-URL: #45269

Notable changes: * deps: * update ICU to 72.1 (Michaël Zasso) [#45068](#45068) * doc: * add lukekarrys to collaborators (Luke Karrys) [#45180](#45180) * add anonrig to collaborators (Yagiz Nizipli) [#45002](#45002) * fs: * (SEMVER-MINOR) fs: add recursive watch to linux (Yagiz Nizipli) [#45098](#45098) * lib: * drop fetch experimental warning (Matteo Collina) [#45287](#45287) * util * (SEMVER-MINOR) add MIME utilities (Bradley Farias) [#21128](#21128) * improve textdecoder decode performance (Yagiz Nizipli) [#45294](#45294) PR-URL: #45269

Notable changes: * deps: * update ICU to 72.1 (Michaël Zasso) [#45068](#45068) * doc: * add lukekarrys to collaborators (Luke Karrys) [#45180](#45180) * add anonrig to collaborators (Yagiz Nizipli) [#45002](#45002) * fs: * (SEMVER-MINOR) fs: add recursive watch to linux (Yagiz Nizipli) [#45098](#45098) * lib: * drop fetch experimental warning (Matteo Collina) [#45287](#45287) * test_runner: * support function mocking (Colin Ihrig) [#45326](#45326) * util * (SEMVER-MINOR) add MIME utilities (Bradley Farias) [#21128](#21128) * improve textdecoder decode performance (Yagiz Nizipli) [#45294](#45294) PR-URL: #45269

PR-URL: #45098 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Notable changes: Add support for externally shared js builtins: By default Node.js is built so that all dependencies are bundled into the Node.js binary itself. Some Node.js distributions prefer to manage dependencies externally. There are existing build options that allow dependencies with native code to be externalized. This commit adds additional options so that dependencies with JavaScript code (including WASM) can also be externalized. This addition does not affect binaries shipped by the Node.js project but will allow other distributions to externalize additional dependencies when needed. Contributed by Michael Dawson in #44376 fs.watch recursive support on Linux: `fs.watch` supports recursive watch using the `recursive: true` option. ```js const watcher = fs.watch(testDirectory, { recursive: true }); watcher.on('change', function(event, filename) { }); ``` Contributed by Yagiz Nizipli in #45098 Support function mocking on Node.js test runner: The `node:test` module supports mocking during testing via a top-level `mock` object. ```js test('spies on an object method', (t) => { const number = { value: 5, add(a) { return this.value + a; }, }; t.mock.method(number, 'add'); assert.strictEqual(number.add(3), 8); assert.strictEqual(number.add.mock.calls.length, 1); }); ``` Contributed by Colin Ihrig in #45326 Other notable changes: buffer: * (SEMVER-MINOR) introduce File (Khafra) #45139 build: * disable v8 snapshot compression by default (Joyee Cheung) #45716 crypto: * update root certificates (Luigi Pinca) #45490 deps: * update ICU to 72.1 (Michaël Zasso) #45068 doc: * add doc-only deprecation for headers/trailers setters (Rich Trott) #45697 * add Rafael to the tsc (Michael Dawson) #45691 * deprecate use of invalid ports in `url.parse` (Antoine du Hamel) #45576 * add lukekarrys to collaborators (Luke Karrys) #45180 * add anonrig to collaborators (Yagiz Nizipli) #45002 * deprecate url.parse() (Rich Trott) #44919 lib: * drop fetch experimental warning (Matteo Collina) #45287 net: * (SEMVER-MINOR) add autoSelectFamily and autoSelectFamilyAttemptTimeout options (Paolo Insogna) #44731 * src: * (SEMVER-MINOR) add uvwasi version (Jithil P Ponnan) #45639 * (SEMVER-MINOR) add initial shadow realm support (Chengzhong Wu) #42869 test_runner: * (SEMVER-MINOR) add t.after() hook (Colin Ihrig) #45792 * (SEMVER-MINOR) don't use a symbol for runHook() (Colin Ihrig) #45792 tls: * (SEMVER-MINOR) add "ca" property to certificate object (Ben Noordhuis) #44935 * remove trustcor root ca certificates (Ben Noordhuis) #45776 tools: * update certdata.txt (Luigi Pinca) #45490 util: * add fast path for utf8 encoding (Yagiz Nizipli) #45412 * improve textdecoder decode performance (Yagiz Nizipli) #45294 * (SEMVER-MINOR) add MIME utilities (#21128) (Bradley Farias) #21128 PR-URL: TBD

Notable changes: Add support for externally shared js builtins: By default Node.js is built so that all dependencies are bundled into the Node.js binary itself. Some Node.js distributions prefer to manage dependencies externally. There are existing build options that allow dependencies with native code to be externalized. This commit adds additional options so that dependencies with JavaScript code (including WASM) can also be externalized. This addition does not affect binaries shipped by the Node.js project but will allow other distributions to externalize additional dependencies when needed. Contributed by Michael Dawson in #44376 fs.watch recursive support on Linux: `fs.watch` supports recursive watch using the `recursive: true` option. ```js const watcher = fs.watch(testDirectory, { recursive: true }); watcher.on('change', function(event, filename) { }); ``` Contributed by Yagiz Nizipli in #45098 Support function mocking on Node.js test runner: The `node:test` module supports mocking during testing via a top-level `mock` object. ```js test('spies on an object method', (t) => { const number = { value: 5, add(a) { return this.value + a; }, }; t.mock.method(number, 'add'); assert.strictEqual(number.add(3), 8); assert.strictEqual(number.add.mock.calls.length, 1); }); ``` Contributed by Colin Ihrig in #45326 Other notable changes: buffer: * (SEMVER-MINOR) introduce File (Khafra) #45139 build: * disable v8 snapshot compression by default (Joyee Cheung) #45716 crypto: * update root certificates (Luigi Pinca) #45490 deps: * update ICU to 72.1 (Michaël Zasso) #45068 doc: * add doc-only deprecation for headers/trailers setters (Rich Trott) #45697 * add Rafael to the tsc (Michael Dawson) #45691 * deprecate use of invalid ports in `url.parse` (Antoine du Hamel) #45576 * add lukekarrys to collaborators (Luke Karrys) #45180 * add anonrig to collaborators (Yagiz Nizipli) #45002 * deprecate url.parse() (Rich Trott) #44919 lib: * drop fetch experimental warning (Matteo Collina) #45287 net: * (SEMVER-MINOR) add autoSelectFamily and autoSelectFamilyAttemptTimeout options (Paolo Insogna) #44731 * src: * (SEMVER-MINOR) add uvwasi version (Jithil P Ponnan) #45639 * (SEMVER-MINOR) add initial shadow realm support (Chengzhong Wu) #42869 test_runner: * (SEMVER-MINOR) add t.after() hook (Colin Ihrig) #45792 * (SEMVER-MINOR) don't use a symbol for runHook() (Colin Ihrig) #45792 tls: * (SEMVER-MINOR) add "ca" property to certificate object (Ben Noordhuis) #44935 * remove trustcor root ca certificates (Ben Noordhuis) #45776 tools: * update certdata.txt (Luigi Pinca) #45490 util: * add fast path for utf8 encoding (Yagiz Nizipli) #45412 * improve textdecoder decode performance (Yagiz Nizipli) #45294 * (SEMVER-MINOR) add MIME utilities (#21128) (Bradley Farias) #21128 PR-URL: #46025

danielleadams · 2022-12-30T21:38:37Z

Hi @anonrig - this did not land cleanly on v18.x. When landing there were variables used that were not defined in v18.x-staging branch's version of the file. Could you open a backport PR? Thank you.

Notable changes: Add support for externally shared js builtins: By default Node.js is built so that all dependencies are bundled into the Node.js binary itself. Some Node.js distributions prefer to manage dependencies externally. There are existing build options that allow dependencies with native code to be externalized. This commit adds additional options so that dependencies with JavaScript code (including WASM) can also be externalized. This addition does not affect binaries shipped by the Node.js project but will allow other distributions to externalize additional dependencies when needed. Contributed by Michael Dawson in #44376 fs.watch recursive support on Linux: `fs.watch` supports recursive watch using the `recursive: true` option. ```js const watcher = fs.watch(testDirectory, { recursive: true }); watcher.on('change', function(event, filename) { }); ``` Contributed by Yagiz Nizipli in #45098 Support function mocking on Node.js test runner: The `node:test` module supports mocking during testing via a top-level `mock` object. ```js test('spies on an object method', (t) => { const number = { value: 5, add(a) { return this.value + a; }, }; t.mock.method(number, 'add'); assert.strictEqual(number.add(3), 8); assert.strictEqual(number.add.mock.calls.length, 1); }); ``` Contributed by Colin Ihrig in #45326 Other notable changes: buffer: * (SEMVER-MINOR) introduce File (Khafra) #45139 build: * disable v8 snapshot compression by default (Joyee Cheung) #45716 crypto: * update root certificates (Luigi Pinca) #45490 deps: * update ICU to 72.1 (Michaël Zasso) #45068 doc: * add doc-only deprecation for headers/trailers setters (Rich Trott) #45697 * add Rafael to the tsc (Michael Dawson) #45691 * deprecate use of invalid ports in `url.parse` (Antoine du Hamel) #45576 * add lukekarrys to collaborators (Luke Karrys) #45180 * add anonrig to collaborators (Yagiz Nizipli) #45002 * deprecate url.parse() (Rich Trott) #44919 lib: * drop fetch experimental warning (Matteo Collina) #45287 net: * (SEMVER-MINOR) add autoSelectFamily and autoSelectFamilyAttemptTimeout options (Paolo Insogna) #44731 * src: * (SEMVER-MINOR) add uvwasi version (Jithil P Ponnan) #45639 * (SEMVER-MINOR) add initial shadow realm support (Chengzhong Wu) #42869 test_runner: * (SEMVER-MINOR) add t.after() hook (Colin Ihrig) #45792 * (SEMVER-MINOR) don't use a symbol for runHook() (Colin Ihrig) #45792 tls: * (SEMVER-MINOR) add "ca" property to certificate object (Ben Noordhuis) #44935 * remove trustcor root ca certificates (Ben Noordhuis) #45776 tools: * update certdata.txt (Luigi Pinca) #45490 util: * add fast path for utf8 encoding (Yagiz Nizipli) #45412 * improve textdecoder decode performance (Yagiz Nizipli) #45294 * (SEMVER-MINOR) add MIME utilities (#21128) (Bradley Farias) #21128 PR-URL: #46025

anonrig · 2023-01-03T16:38:19Z

@danielleadams It seems this pull request is in the v18.x-staging branch: https://github.com/nodejs/node/blob/v18.13.0-proposal/lib/internal/fs/recursive_watch.js

juanarbol · 2023-01-26T19:47:35Z

@danielleadams It seems this pull request is in the v18.x-staging branch: https://github.com/nodejs/node/blob/v18.13.0-proposal/lib/internal/fs/recursive_watch.js

That link is a 404; marking this is a "backport-requested-v18.x" again.

anonrig · 2023-01-26T22:31:37Z

This pull request is already backported @juanarbol

Referencing: https://github.com/nodejs/node/blob/v18.x-staging/lib/internal/fs/recursive_watch.js

aduh95 · 2023-01-27T07:14:10Z

That's not correct @anonrig, the pull request was not backported, it never showed on the v18.x changelog. The file you linked was added with c2f0377 (which is a backport for #45265), but all the other changes in this PR still need to be backported manually (docs and tests).

raphaelboukara · 2024-01-15T08:45:53Z

Hi :)
Does this fix will be backported to v18.x ?

mcollina · 2024-01-15T08:56:08Z

I don't expect this to be backported, because there are issues with this and Node.js v18 is in maintenance.

See #48437 for more details.

anonrig added fs Issues and PRs related to the fs subsystem / file system. notable-change PRs with changes that should be highlighted in changelogs. labels Oct 20, 2022

nodejs-github-bot added the needs-ci PRs that need a full CI run. label Oct 20, 2022

kibertoad reviewed Oct 20, 2022

View reviewed changes

lib/fs.js Show resolved Hide resolved

aduh95 reviewed Oct 20, 2022

View reviewed changes

lib/internal/fs/linux_recursive_watcher.js Outdated Show resolved Hide resolved

aduh95 reviewed Oct 20, 2022

View reviewed changes

lib/internal/fs/linux_recursive_watcher.js Outdated Show resolved Hide resolved

lib/internal/fs/linux_recursive_watcher.js Outdated Show resolved Hide resolved

lib/internal/fs/linux_recursive_watcher.js Outdated Show resolved Hide resolved

bnoordhuis reviewed Oct 20, 2022

View reviewed changes

lib/internal/fs/linux_recursive_watcher.js Outdated Show resolved Hide resolved

lib/internal/fs/linux_recursive_watcher.js Outdated Show resolved Hide resolved

cjihrig reviewed Oct 20, 2022

View reviewed changes

lib/internal/fs/linux_recursive_watcher.js Outdated Show resolved Hide resolved

anonrig force-pushed the fs/add-recursive-watch branch from 0c106f0 to 45e8f37 Compare October 21, 2022 18:17

anonrig requested review from bnoordhuis, aduh95, cjihrig and kibertoad October 21, 2022 18:18

anonrig force-pushed the fs/add-recursive-watch branch 6 times, most recently from 7275124 to a7b310d Compare October 21, 2022 23:24

anonrig marked this pull request as ready for review October 21, 2022 23:30

anonrig force-pushed the fs/add-recursive-watch branch from a7b310d to fd0a954 Compare October 21, 2022 23:46

anonrig requested review from targos and removed request for kibertoad October 21, 2022 23:46

anonrig added the request-ci Add this label to start a Jenkins CI on a PR. label Oct 21, 2022

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Oct 21, 2022

This comment was marked as outdated.

Sign in to view

aduh95 reviewed Oct 22, 2022

View reviewed changes

lib/internal/fs/linux_watcher.js Outdated Show resolved Hide resolved

lib/internal/fs/linux_watcher.js Outdated Show resolved Hide resolved

lib/internal/fs/linux_watcher.js Outdated Show resolved Hide resolved

mcollina requested changes Oct 22, 2022

View reviewed changes

aduh95 reviewed Oct 22, 2022

View reviewed changes

lib/internal/fs/watch/linux.js Outdated Show resolved Hide resolved

anonrig force-pushed the fs/add-recursive-watch branch from d0f5179 to df1c187 Compare October 22, 2022 21:07

danielleadams mentioned this pull request Dec 30, 2022

v18.13.0 release proposal #46025

Merged

danielleadams added the backport-requested-v18.x PRs awaiting manual backport to the v18.x-staging branch. label Dec 30, 2022

anonrig removed the backport-requested-v18.x PRs awaiting manual backport to the v18.x-staging branch. label Jan 3, 2023

torchiaf mentioned this pull request Jan 12, 2023

Contexts aren't added/deleted from the Tray menu on Linux platforms rancher-sandbox/rancher-desktop#3765

Closed

juanarbol added the backport-requested-v18.x PRs awaiting manual backport to the v18.x-staging branch. label Jan 26, 2023

nascarsayan mentioned this pull request Mar 12, 2023

ERR_FEATURE_UNAVAILABLE_ON_PLATFORM Debdut/browser-extension#12

Closed

schlichtanders mentioned this pull request Oct 9, 2023

Linux support? sheldonjuncker/node-kubycat#4

Closed

richardlau added dont-land-on-v18.x PRs that should not land on the v18.x-staging branch and should not be released in v18.x. and removed backport-requested-v18.x PRs awaiting manual backport to the v18.x-staging branch. labels Jan 15, 2024

arenekosreal mentioned this pull request Feb 18, 2024

[Bug]: Linux 下不支持 fs.watch 的 recursive: true 选项 xiyuesaves/LiteLoaderQQNT-lite_tools#115

Closed

kirjavascript mentioned this pull request Apr 18, 2024

fix: remove 'recursive' from fs.watch stackblitz/webcontainer-docs#65

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fs: add recursive watch for linux #45098

fs: add recursive watch for linux #45098

anonrig commented Oct 20, 2022 •

edited

This comment was marked as outdated.

mcollina left a comment

danielleadams commented Dec 30, 2022

anonrig commented Jan 3, 2023

juanarbol commented Jan 26, 2023

anonrig commented Jan 26, 2023

aduh95 commented Jan 27, 2023

raphaelboukara commented Jan 15, 2024

mcollina commented Jan 15, 2024 •

edited

fs: add recursive watch for linux #45098

fs: add recursive watch for linux #45098

Conversation

anonrig commented Oct 20, 2022 • edited

List

This comment was marked as outdated.

mcollina left a comment

Choose a reason for hiding this comment

danielleadams commented Dec 30, 2022

anonrig commented Jan 3, 2023

juanarbol commented Jan 26, 2023

anonrig commented Jan 26, 2023

aduh95 commented Jan 27, 2023

raphaelboukara commented Jan 15, 2024

mcollina commented Jan 15, 2024 • edited

anonrig commented Oct 20, 2022 •

edited

mcollina commented Jan 15, 2024 •

edited