chore(opentelemetry-instrumentation): improve _warnOnPreloadedModules function not to show warning logs when the module is not marked as loaded
#6095
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
rlj1202
force-pushed
the
chore/warn-on-preloaded-modules
branch
2 times, most recently
from
b755cfa to
8ae3980
Compare
rlj1202
changed the title
_warnOnPreloadedModules function not to show warning logs when the module is not marked as loaded
rlj1202
force-pushed
the
chore/warn-on-preloaded-modules
branch
from
8ae3980 to
caab4e6
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #6095 +/- ##
=======================================
Coverage 95.16% 95.16%
=======================================
Files 316 316
Lines 9226 9226
Branches 2082 2082
=======================================
Hits 8780 8780
Misses 446 446 🚀 New features to boost your workflow:
|
… function not to show warning logs when the module is not marked as loaded
rlj1202
force-pushed
the
chore/warn-on-preloaded-modules
branch
from
caab4e6 to
7cbc531
Compare
david-luna
reviewed
Dec 10, 2025
| try { | ||
| const resolvedModule = require.resolve(name); | ||
| if (require.cache[resolvedModule]) { | ||
| if (require.cache[resolvedModule]?.loaded) { |
Contributor
There was a problem hiding this comment.
This function gets called when enabling a instrumentation and we're not certain when this will happen. There is more than one way to register and enable instrumentations so I wonder if we can have a situation where we are enabling an instrumentation amid the load process of the instrumented module (and loaded ins not true yet).
Author
There was a problem hiding this comment.
Then... just printing the information together might be enough like this:
this._diag.warn(
`Module ${name} has been loaded before ${this.instrumentationName} so it might not work, please initialize it before requiring ${name} (loaded = ${require.cache[resolvedModule]?.loaded ?? false})`
);
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem is this PR solving?
On ESM environment where ECMAScript module and CommonJS modules coexist, unnecessary module preload warning logs appear.
How Has This Been Tested?
Example:
graph TD; main.mjs-->a.mjs; main.mjs-->b.cjs; main.mjs-->d.mjs; main.mjs-->e.cjs; b.cjs-->c.cjs; e.cjs-->f.cjs;main.mjsvisited,b.cjsande.cjsappear in therequire.cacheasloaded = falsea.mjsvisited and loadedb.cjsvisited,c.cjsappears in therequire.cacheasloaded = falsec.cjsvisited and loadedb.cjsloadedd.mjsvisited and loadede.cjsvisited,f.cjsappears in therequire.cacheasloaded = falsef.cjsvisited and loadede.cjsloadedmain.mjsloadedSo to warn preloaded modules properly in ESM environment,
Module.loadedproperty should be considered.Checklist: