fix: prevent ESM loader from loading instrumentation multiple times #1729
+57
−1
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## main #1729 +/- ##
=======================================
Coverage 96.87% 96.87%
=======================================
Files 200 200
Lines 39181 39191 +10
Branches 24 25 +1
=======================================
+ Hits 37956 37966 +10
Misses 1225 1225
Flags with carried forward coverage won't be shown. Click here to find out more.
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
bizob2828
approved these changes
Jul 18, 2023
Node.js Engineering Board
automation
moved this from Needs PR Review
to Done: Issues recently completed
Jul 18, 2023
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Version 10 of the Node agent added support for instrumenting a module more than once. This had a knock-on effect in our ESM loader in that we were naively calling
registerInstrumentationevery time a CJS module was imported, which in turn, would cause our instrumentation to be registered multiple times if an applicationimport-ed a module more than once. This exhibited as route name duplication for transactions in the Express instrumentation / GH issue, but would have caused strangeness with all instrumentation.To fix, I've added CJS modules to the
registeredSpecifiersMap after performing instrumentation registration, and added a check to the beginning of the resolve hook logic to not register again if the loader has already performed on a module.How to Test
registerInstrumentationis only called if we haven't instrumented a module yetnpm linkto test manuallyRelated Issues
Closes #1646 and Closes #1693