fix(instrumentation): only call onRequire for full matches on core modules with sub-paths
#3451
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?
In #3161, we introduced the
RequireInTheMiddleSingleton, which should be a (mostly) drop-in replacement forrequire-in-the-middle(RITM); however, the way these two handle core modules with sub-paths (e.g.fs/promises) is different. This PR fixesRequireInTheMiddleSingletonto be consistent with RITM.Fixes #3448
Short description of the changes
Consider the scenario where we are patching a core module (e.g.
@opentelemetry/instrumentation-fs, which patchesfs). When the application callsrequireon that core module with a sub-path (e.g.fs/promises), RITM does not see that as internal tofsand thus does not call theonRequirefunction; however,RequireInTheMiddleSingletondoes.To make
RequireInTheMiddleSingletonmore consistent with RITM, we should only call theonRequirefunction for full matches (i.e.fs/promisesshould call hooks forfs/promisesbut not forfs).We detect whether a module is a core module by checking whether
basedirisundefined.Type of change
How Has This Been Tested?
I fixed and added additional unit tests to
RequireInTheMiddleSingleton.Checklist: