fix!: Replaced esm loader with import-in-the-middle to fix instrumentation firing for both commonjs and esm #1760
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
This was referenced Aug 14, 2023
Codecov Report
@@ Coverage Diff @@
## main #1760 +/- ##
==========================================
- Coverage 96.88% 96.88% -0.01%
==========================================
Files 200 199 -1
Lines 39210 38838 -372
Branches 22 0 -22
==========================================
- Hits 37989 37627 -362
+ Misses 1221 1211 -10
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 2 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
bizob2828
changed the title
jmartin4563
suggested changes
Aug 16, 2023
| @@ -272,8 +272,7 @@ const INFINITE_TRACING = { | |||
| const FEATURES = { | |||
| ESM: { | |||
| LOADER: `${SUPPORTABILITY.FEATURES}/ESM/Loader`, | |||
| UNSUPPORTED_LOADER: `${SUPPORTABILITY.FEATURES}/ESM/UnsupportedLoader`, | |||
| CUSTOM_INSTRUMENTATION: `${SUPPORTABILITY.FEATURES}/ESM/CustomInstrumentation` | |||
There was a problem hiding this comment.
Same thing about Angler here, should update to remove this metric
There was a problem hiding this comment.
yep, ill get all these queued up in one PR shortly
There was a problem hiding this comment.
Here's the PR https://source.datanerd.us/agents/angler/pull/476
| @@ -13,16 +13,19 @@ module.exports = [ | |||
| { | |||
| type: 'generic', | |||
| moduleName: '@grpc/grpc-js/build/src/resolving-call', | |||
| isEsm: true, | |||
There was a problem hiding this comment.
Wait, why did this have to get added? It's not an ESM module, and I thought that's what the flag is for?
There was a problem hiding this comment.
This code is getting transpiled and it has named exports instead of default, that's why
jmartin4563
previously approved these changes
Aug 17, 2023
…rics for ESM, and removed esm unit tests as they are no longer relevant
…vs the default key
jmartin4563
previously approved these changes
Aug 17, 2023
jmartin4563
approved these changes
Aug 17, 2023
Node.js Engineering Board
automation
moved this from Needs PR Review
to Done: Issues recently completed
Aug 17, 2023
This was referenced Aug 21, 2023
Closed
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.
Details
This PR restores support for ESM in Node 20. It also supersedes #1759. It's also worth noting at the time of opening this it layers on top of #1758 . By relying on import-in-the-middle it de-couples are agent from proxying ESM packages to instrument. However this now requires us to do
--loader newrelic/esm-loader.mjs -r newrelic. You can see by the PR that it also removes the complexities we created by having a test loader that injects a fake agent before calling the new loader, this is no longer needed. Also since our esm loader now just calls import in the middle, there is no need to test esm files and mock esm with testdouble. I also shifted some supportability metrics around ESM to the agent.Changelog details
node --experimental-loader newrelic/esm-loader.mjs -r newrelic path/to/app.jsconfig.esm.custom_instrumentation_entrypointto register ESM instrumentation.newrelic.instrument*APIs but you must pass in an object and specifyisEsm: true.Related Issues
Closes #1646
Closes #1720