lib: add diagnostics_channel events to module loading #44340

Qard · 2022-08-22T11:57:11Z

Adding module.cjs.load and module.esm.load diagnostics_channel events so APMs don't need to patch the module system to know when a particular module has been loaded.

nodejs-github-bot · 2022-08-22T11:57:15Z

Review requested:

@nodejs/modules

lib/internal/modules/cjs/loader.js

bmeck · 2022-08-22T12:44:28Z

I'd be more comfortable not sending something that will be directly patched as it won't work for ESM

…

On Mon, Aug 22, 2022, 7:39 AM Stephen Belanger ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In lib/internal/modules/cjs/loader.js <#44340 (comment)>: > @@ -797,6 +800,7 @@ Module._load = function(request, parent, isMain) { throw new ERR_UNKNOWN_BUILTIN_MODULE(request); } + onModuleLoad.publish(module); The hasSubscribers check is only relevant if you're building input objects. If you just pass stuff in as-is it will be a no-op when there's no subscribers. Do we want to match anyway though just for consistency? — Reply to this email directly, view it on GitHub <#44340 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABZJI2NJF3NWVW462NJJ3TV2NYJNANCNFSM57HMHFCQ> . You are receiving this because you are on a team that was mentioned.Message ID: ***@***.***>

GeoffreyBooth · 2022-08-22T15:52:35Z

Since the ESM loader can also load CommonJS, should the event perhaps just be "module load" without the specific of whether it's ESM or CommonJS? I assume there's a payload with details like what module was loaded (?) so that could be where we specify which loader was used, which format the file was recognized as, etc.

GeoffreyBooth · 2022-08-22T15:58:16Z

test/parallel/test-diagnostics-channel-module-esm-load.js

+  seen = module;
+}));
+
+import('http').then(http => {


Can you write a test in ESM (in an .mjs file) to confirm that works too? What about static import statements?

Not sure how that would work. Wouldn't the module graph already be resolved/loaded by the time any code runs to actually register a subscriber? Maybe it could work in a loader?

That's why I asked 😄

We should add a test that shows expected esm behavior.

simon-id · 2022-08-23T09:47:07Z

Don't forget to add it to the docs here: https://nodejs.org/api/diagnostics_channel.html#built-in-channels

rochdev · 2022-08-23T21:33:53Z

Could more events be added? There are use cases where having just one event is not enough, for example capturing how long each require call took which would require 2 events surrounding the function. Also including more data than just the module would be helpful, for example the path to the entry point, whether it's a core module, the base path, etc. Basically most of what require-in-the-middle has been doing historically, except the version since that's specific to package managers. Basically I think there could be 3 events: 1 when require is called, 1 when it finishes, and 1 when the module is actually loaded with module resolution information included as well.

trevnorris · 2022-08-25T21:31:16Z

@Qard Thanks for doing this. I just want to let you know that this would cover all the use cases for the data we've been collecting internally.

trevnorris · 2022-09-27T20:27:47Z

@Qard Would you mind fixing the lint error so all the tests can pass?

Qard · 2022-09-27T21:24:10Z

There's some more changes I've been meaning to make. I'll try to get to that after NodeConf EU. Just had a very busy few weeks. 😅

GeoffreyBooth · 2022-09-28T00:28:00Z

There’s some more changes I’ve been meaning to make. I’ll try to get to that after NodeConf EU. Just had a very busy few weeks. 😅

Thanks. Let’s also please not land this until all open questions are resolved.

Qard · 2022-10-18T03:48:53Z

Going to redo this on #44943 after it lands.

GeoffreyBooth · 2022-10-18T17:55:17Z

Going to redo this on #44943 after it lands.

Thanks. Will that other PR enable things like I mentioned in #44340 (comment), where we could have more generic events like “module load” and then additional properties for extra data like module specifier, module system (CommonJS or ESM), resolved path, etc.?

Qard · 2022-12-15T06:24:22Z

I've reimplemented this on top of #44943. Ignore the first commit, that's inherited from that PR. I'll rebase after that lands to fix this PR. :)

GeoffreyBooth · 2022-12-15T06:30:47Z

FYI there's a lot of refactoring in progress for module loading, including starting to merge together the CJS and ESM loaders. I would wait until the dust settles on that work before landing this. I would also suggest you make the events less tied to subsystem: like module resolution, module loading; whether it was from require or import, etc.

doc/api/diagnostics_channel.md

nodejs-github-bot · 2024-06-19T19:37:41Z

CI: https://ci.nodejs.org/job/node-test-pull-request/59896/

Flarna

Maybe add a bit more info into the commit message.

Flarna · 2024-06-20T07:51:00Z

Seems windows test failures are related to this PR:

+     parentURL: 'file:///C:/workspace/node-test-binary-windows-js-suites/node/test/parallel/test-diagnostics-channel-module-import.js',
-     parentURL: 'file://C:\\workspace\\node-test-binary-windows-js-suites\\node\\test\\parallel\\test-diagnostics-channel-module-import.js',

This commit adds a tracing channel for module loading through `import()` and `require()`. Co-Authored-By: Stephen Belanger <admin@stephenbelanger.com>

nodejs-github-bot · 2024-06-20T17:43:17Z

CI: https://ci.nodejs.org/job/node-test-pull-request/59906/

nodejs-github-bot · 2024-06-20T23:52:12Z

Commit Queue failed

- Loading data for nodejs/node/pull/44340
✔  Done loading data for nodejs/node/pull/44340
----------------------------------- PR info ------------------------------------
Title      lib: add diagnostics_channel events to module loading (#44340)
Author     Stephen Belanger  (@Qard)
Branch     Qard:diagnostics-channel-for-module-loads -> nodejs:main
Labels     module, semver-minor, esm, author ready, needs-ci, loaders, diagnostics_channel, commit-queue-squash
Commits    1
 - lib: add diagnostics_channel events to module loading
Committers 1
 - RafaelGSS 
PR-URL: https://github.com/nodejs/node/pull/44340
Reviewed-By: Geoffrey Booth 
Reviewed-By: Santiago Gimeno 
Reviewed-By: Rafael Gonzaga 
Reviewed-By: James M Snell 
Reviewed-By: Gerhard Stöbich 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/44340
Reviewed-By: Geoffrey Booth 
Reviewed-By: Santiago Gimeno 
Reviewed-By: Rafael Gonzaga 
Reviewed-By: James M Snell 
Reviewed-By: Gerhard Stöbich 
--------------------------------------------------------------------------------
   ⚠  Commits were pushed since the last approving review:
   ⚠  - lib: add diagnostics_channel events to module loading
   ℹ  This PR was created on Mon, 22 Aug 2022 11:57:11 GMT
   ✔  Approvals: 5
   ✔  - Geoffrey Booth (@GeoffreyBooth) (TSC): https://github.com/nodejs/node/pull/44340#pullrequestreview-2126574661
   ✔  - Santiago Gimeno (@santigimeno): https://github.com/nodejs/node/pull/44340#pullrequestreview-2126639621
   ✔  - Rafael Gonzaga (@RafaelGSS) (TSC): https://github.com/nodejs/node/pull/44340#pullrequestreview-2126661939
   ✔  - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/44340#pullrequestreview-2128947843
   ✔  - Gerhard Stöbich (@Flarna): https://github.com/nodejs/node/pull/44340#pullrequestreview-2129682835
   ✔  Last GitHub CI successful
   ℹ  Last Full PR CI on 2024-06-20T17:43:17Z: https://ci.nodejs.org/job/node-test-pull-request/59906/
- Querying data for job/node-test-pull-request/59906/
   ✔  Last Jenkins CI successful
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu

https://github.com/nodejs/node/actions/runs/9605921698

This commit adds a tracing channel for module loading through `import()` and `require()`. Co-Authored-By: Stephen Belanger <admin@stephenbelanger.com> PR-URL: #44340 Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>

RafaelGSS · 2024-06-21T00:26:15Z

Landed in fbdfe93

This commit adds a tracing channel for module loading through `import()` and `require()`. Co-Authored-By: Stephen Belanger <admin@stephenbelanger.com> PR-URL: #44340 Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>

This commit adds a tracing channel for module loading through `import()` and `require()`. Co-Authored-By: Stephen Belanger <admin@stephenbelanger.com> PR-URL: nodejs#44340 Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>

Notable changes: deps,lib,src: * (SEMVER-MINOR) add experimental web storage (Colin Ihrig) #52435 doc: * move `node --run` stability to rc (Yagiz Nizipli) #53433 * mark WebSocket as stable (Matthew Aitken) #53352 * mark --heap-prof and related flags stable (Joyee Cheung) #53343 * mark --cpu-prof and related flags stable (Joyee Cheung) #53343 * doc-only deprecate OpenSSL engine-based APIs (Richard Lau) #53329 inspector: * fix disable async hooks on Debugger.setAsyncCallStackDepth (Joyee Cheung) #53473 lib: * (SEMVER-MINOR) add diagnostics_channel events to module loading (RafaelGSS) #44340 util: * (SEMVER-MINOR) support `--no-` for argument with boolean type for parseArgs (Zhenwei Jin) #53107 PR-URL: #53583

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

simon-id reviewed Aug 22, 2022

View reviewed changes

lib/internal/modules/cjs/loader.js Outdated Show resolved Hide resolved

GeoffreyBooth reviewed Aug 22, 2022

View reviewed changes

jasnell previously approved these changes Aug 28, 2022

View reviewed changes

rochdev mentioned this pull request Sep 21, 2022

fs plugin support DataDog/dd-trace-js#2395

Open

Trott force-pushed the main branch from 2d76238 to ca3ed36 Compare November 12, 2022 01:49

Qard force-pushed the diagnostics-channel-for-module-loads branch 5 times, most recently from 92affe4 to 99f0481 Compare December 15, 2022 06:16

Qard force-pushed the diagnostics-channel-for-module-loads branch from 99f0481 to c565e0e Compare December 15, 2022 06:32

Flarna reviewed Jun 19, 2024

View reviewed changes

doc/api/diagnostics_channel.md Outdated Show resolved Hide resolved

RafaelGSS force-pushed the diagnostics-channel-for-module-loads branch from 484d6a1 to 683fb3d Compare June 19, 2024 14:13

RafaelGSS added the request-ci Add this label to start a Jenkins CI on a PR. label Jun 19, 2024

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Jun 19, 2024

This comment was marked as outdated.

Sign in to view

jasnell approved these changes Jun 19, 2024

View reviewed changes

Flarna approved these changes Jun 20, 2024

View reviewed changes

lib: add diagnostics_channel events to module loading

7de89ed

This commit adds a tracing channel for module loading through `import()` and `require()`. Co-Authored-By: Stephen Belanger <admin@stephenbelanger.com>

RafaelGSS force-pushed the diagnostics-channel-for-module-loads branch from 683fb3d to 7de89ed Compare June 20, 2024 13:41

RafaelGSS added the request-ci Add this label to start a Jenkins CI on a PR. label Jun 20, 2024

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Jun 20, 2024

RafaelGSS added the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 20, 2024

nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Jun 20, 2024

RafaelGSS removed the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Jun 21, 2024

RafaelGSS closed this Jun 21, 2024

targos mentioned this pull request Jun 25, 2024

v22.4.0 release proposal #53583

Merged

Karliz24 mentioned this pull request Jul 9, 2024

## 2024-07-02, Version 22.4.0 (Current), @targos Karliz24/Marley-#16

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

lib: add diagnostics_channel events to module loading #44340

lib: add diagnostics_channel events to module loading #44340

Qard commented Aug 22, 2022

nodejs-github-bot commented Aug 22, 2022

bmeck commented Aug 22, 2022 via email

GeoffreyBooth commented Aug 22, 2022

GeoffreyBooth Aug 22, 2022

Qard Aug 23, 2022

GeoffreyBooth Aug 23, 2022

simon-id commented Aug 23, 2022

rochdev commented Aug 23, 2022

trevnorris commented Aug 25, 2022

trevnorris commented Sep 27, 2022

Qard commented Sep 27, 2022

GeoffreyBooth commented Sep 28, 2022

Qard commented Oct 18, 2022 •

edited

Loading

GeoffreyBooth commented Oct 18, 2022

Qard commented Dec 15, 2022

GeoffreyBooth commented Dec 15, 2022

This comment was marked as outdated.

nodejs-github-bot commented Jun 19, 2024

Flarna left a comment

Flarna commented Jun 20, 2024 •

edited

Loading

nodejs-github-bot commented Jun 20, 2024

nodejs-github-bot commented Jun 20, 2024

RafaelGSS commented Jun 21, 2024

lib: add diagnostics_channel events to module loading #44340

lib: add diagnostics_channel events to module loading #44340

Conversation

Qard commented Aug 22, 2022

nodejs-github-bot commented Aug 22, 2022

bmeck commented Aug 22, 2022 via email

GeoffreyBooth commented Aug 22, 2022

GeoffreyBooth Aug 22, 2022

Choose a reason for hiding this comment

Qard Aug 23, 2022

Choose a reason for hiding this comment

GeoffreyBooth Aug 23, 2022

Choose a reason for hiding this comment

simon-id commented Aug 23, 2022

rochdev commented Aug 23, 2022

trevnorris commented Aug 25, 2022

trevnorris commented Sep 27, 2022

Qard commented Sep 27, 2022

GeoffreyBooth commented Sep 28, 2022

Qard commented Oct 18, 2022 • edited Loading

GeoffreyBooth commented Oct 18, 2022

Qard commented Dec 15, 2022

GeoffreyBooth commented Dec 15, 2022

This comment was marked as outdated.

nodejs-github-bot commented Jun 19, 2024

Flarna left a comment

Choose a reason for hiding this comment

Flarna commented Jun 20, 2024 • edited Loading

nodejs-github-bot commented Jun 20, 2024

nodejs-github-bot commented Jun 20, 2024

RafaelGSS commented Jun 21, 2024

Qard commented Oct 18, 2022 •

edited

Loading

Flarna commented Jun 20, 2024 •

edited

Loading