fix(instrumentation-http): Ensure instrumentation of `http.get` and `https.get` work when used in ESM code #4866

trentm · 2024-07-15T22:45:58Z

The issue was that the _wraping of http.get was getting the
just-wrapped http.request by accessing moduleExports.request.
However, when wrapping an ES module the moduleExports object from IITM
is a Proxy object that allows setting a property, but not re-getting
that set property.

The fix is to use the wrapped http.request from the this._wrap call.
That required fixing a bug in the IITM code-path of
InstrumentationBase.prototype._wrap to return the wrapped property.
(The previous code was doing return Object.defineProperty(...), which
returns the moduleExports, not the defined property.)

Fixes: #4857

…https.get` work when used in ESM code The issue was that the `_wrap`ing of `http.get` was getting the just-wrapped `http.request` by accessing `moduleExports.request`. However, when wrapping an ES module the `moduleExports` object from IITM is a Proxy object that allows setting a property, but *not* re-getting that set property. The fix is to use the wrapped `http.request` from the `this._wrap` call. That required fixing a bug in the IITM code-path of `InstrumentationBase.prototype._wrap` to return the wrapped property. (The previous code was doing `return Object.defineProperty(...)`, which returns the moduleExports, not the defined property.) Fixes: open-telemetry#4857

experimental/packages/opentelemetry-instrumentation-http/test/integrations/esm.test.mjs

trentm · 2024-07-15T22:48:04Z

experimental/packages/opentelemetry-instrumentation-http/package.json

-    "test": "nyc mocha test/**/*.test.ts",
+    "test:cjs": "nyc mocha test/**/*.test.ts",
+    "test:esm": "nyc node --experimental-loader=@opentelemetry/instrumentation/hook.mjs ../../../node_modules/.bin/mocha 'test/**/*.test.mjs'",
+    "test": "npm run test:cjs && npm run test:esm",


Reviewer note: This test:esm script follows the same pattern used for ESM tests in opentelemetry-instrumentation.

trentm · 2024-07-15T22:48:56Z

experimental/packages/opentelemetry-instrumentation/package.json

    "tdd:browser": "karma start",
    "test:cjs": "nyc mocha 'test/**/*.test.ts' --exclude 'test/browser/**/*.ts'",
-    "test:esm": "nyc node --experimental-loader=./hook.mjs ../../../node_modules/mocha/bin/mocha 'test/node/*.test.mjs' test/node/*.test.mjs",
+    "test:esm": "nyc node --experimental-loader=./hook.mjs ../../../node_modules/mocha/bin/mocha 'test/node/*.test.mjs'",


Reviewer note: I think this was a typo from when this was originally added. The additional test/node/*.test.mjs arg is redundant.

trentm · 2024-07-15T22:50:30Z

experimental/packages/opentelemetry-instrumentation/src/platform/node/instrumentation.ts

+      Object.defineProperty(moduleExports, name, {
        value: wrapped,
      });
+      return wrapped;


Reviewer note: From a quick check, I didn't see any core or contrib-repo instrumentations using the return value of this._wrap. Arguably this is a "fix" for @opentelemetry/instrumentation, but I didn't mention it in the CHANGELOG.

experimental/packages/opentelemetry-instrumentation/test/node/EsmInstrumentation.test.mjs

maryliag

just a nit, otherwise LGTM

hectorhdzg · 2024-07-16T23:39:51Z

@trentm sorry I'm terrible with acronyms, what IITM means?

trentm · 2024-07-17T05:27:43Z

@hectorhdzg

IITM

My bad: It is import-in-the-middle (https://github.com/nodejs/import-in-the-middle). (And often RITM for require-in-the-middle.)

…is file

hectorhdzg

LGTM

JamieDanielson

This is great, thanks for working on this! Appreciate the test updates as well. I left a few nits around the tests but the functionality itself is good. I'm now wondering about other instrumentations and what can be done there... but for now 🚀

experimental/packages/opentelemetry-instrumentation-http/test/integrations/esm.test.mjs

JamieDanielson · 2024-07-23T22:20:43Z

experimental/packages/opentelemetry-instrumentation/test/node/EsmInstrumentation.test.mjs

      moduleExports => {
-        this._wrap(moduleExports, 'testFunction', () => {
-          return () => 'patched';
+        const wrapRetval = this._wrap(moduleExports, 'testFunction', () => {


Suggested change

const wrapRetval = this._wrap(moduleExports, 'testFunction', () => {

const wrappedReturnValue = this._wrap(moduleExports, 'testFunction', () => {

This is a total nit, but I wonder if we could use a full name for this - primarily because this tends to be a confusing functionality and I'm a sucker for detailed variable names. Maybe something like patchedModule, similar to the patchedRequest you have in the http code? Nonblocking, especially since it's a test.

experimental/packages/opentelemetry-instrumentation-http/test/integrations/esm.test.mjs

JamieDanielson · 2024-07-23T22:31:59Z

Also I think this updates open-telemetry/opentelemetry-js-contrib#1942 now for http instrumentation?

Co-authored-by: Jamie Danielson <[email protected]>

experimental/packages/opentelemetry-instrumentation-http/test/integrations/esm.test.mjs

+      const clientReq = https.request(
+        `https://127.0.0.1:${port}/https.request`,
+        {
+          rejectUnauthorized: false,


experimental/packages/opentelemetry-instrumentation-http/test/integrations/esm.test.mjs

+      https.get(
+        `https://127.0.0.1:${port}/https.get`,
+        {
+          rejectUnauthorized: false,


…https.get` work when used in ESM code (open-telemetry#4866) * fix(instrumentation-http): Ensure instrumentation of `http.get` and `https.get` work when used in ESM code The issue was that the `_wrap`ing of `http.get` was getting the just-wrapped `http.request` by accessing `moduleExports.request`. However, when wrapping an ES module the `moduleExports` object from IITM is a Proxy object that allows setting a property, but *not* re-getting that set property. The fix is to use the wrapped `http.request` from the `this._wrap` call. That required fixing a bug in the IITM code-path of `InstrumentationBase.prototype._wrap` to return the wrapped property. (The previous code was doing `return Object.defineProperty(...)`, which returns the moduleExports, not the defined property.) Fixes: open-telemetry#4857 * correct typo in the changelog message * does this fix the test:esm script running on windows? * remove other console.logs (presumably dev leftovers) from tests in this file * test name suggestion Co-authored-by: Jamie Danielson <[email protected]> * test name suggestion Co-authored-by: Jamie Danielson <[email protected]> * test name suggestion Co-authored-by: Jamie Danielson <[email protected]> * test name suggestion Co-authored-by: Jamie Danielson <[email protected]> * var naming suggestion: expand cres and creq, the abbrev isn't obvious --------- Co-authored-by: Jamie Danielson <[email protected]>

trentm self-assigned this Jul 15, 2024

trentm requested a review from a team July 15, 2024 22:45

correct typo in the changelog message

4eb8607

github-advanced-security bot found potential problems Jul 15, 2024

View reviewed changes

experimental/packages/opentelemetry-instrumentation-http/test/integrations/esm.test.mjs Fixed Show fixed Hide fixed

experimental/packages/opentelemetry-instrumentation-http/test/integrations/esm.test.mjs Fixed Show fixed Hide fixed

trentm commented Jul 15, 2024

View reviewed changes

does this fix the test:esm script running on windows?

94933d6

maryliag reviewed Jul 16, 2024

View reviewed changes

experimental/packages/opentelemetry-instrumentation/test/node/EsmInstrumentation.test.mjs Show resolved Hide resolved

maryliag approved these changes Jul 16, 2024

View reviewed changes

trentm added 2 commits July 16, 2024 22:55

remove other console.logs (presumably dev leftovers) from tests in th…

942aa19

…is file

Merge branch 'main' into tm-fix-esm-http.get

28a81e7

hectorhdzg approved these changes Jul 17, 2024

View reviewed changes

JamieDanielson approved these changes Jul 23, 2024

View reviewed changes

trentm and others added 6 commits July 23, 2024 21:27

test name suggestion

ed68ff7

Co-authored-by: Jamie Danielson <[email protected]>

test name suggestion

5a40e94

Co-authored-by: Jamie Danielson <[email protected]>

test name suggestion

4ff3771

Co-authored-by: Jamie Danielson <[email protected]>

test name suggestion

71811c4

Co-authored-by: Jamie Danielson <[email protected]>

var naming suggestion: expand cres and creq, the abbrev isn't obvious

8eb6c7d

Merge branch 'main' into tm-fix-esm-http.get

011af25

trentm mentioned this pull request Jul 24, 2024

coordinate first pass at ESM support for all instrumentations open-telemetry/opentelemetry-js-contrib#1942

Open

37 tasks

github-advanced-security bot found potential problems Jul 24, 2024

View reviewed changes

trentm added this pull request to the merge queue Jul 24, 2024

Merged via the queue into open-telemetry:main with commit d4035eb Jul 24, 2024

trentm deleted the tm-fix-esm-http.get branch July 24, 2024 05:09

trentm mentioned this pull request Jul 25, 2024

feat(http): Allow to opt-out of instrumenting incoming/outgoing requests #4643

Merged

pichlermarc mentioned this pull request Aug 29, 2024

chore(deps): update deps matching "@opentelemetry/" open-telemetry/opentelemetry-js-contrib#2408

Merged

	const wrapRetval = this._wrap(moduleExports, 'testFunction', () => {
	const wrappedReturnValue = this._wrap(moduleExports, 'testFunction', () => {

fix(instrumentation-http): Ensure instrumentation of http.get and https.get work when used in ESM code #4866

fix(instrumentation-http): Ensure instrumentation of http.get and https.get work when used in ESM code #4866

Uh oh!

Conversation

trentm commented Jul 15, 2024

Uh oh!

Uh oh!

Uh oh!

trentm Jul 15, 2024

Choose a reason for hiding this comment

Uh oh!

trentm Jul 15, 2024

Choose a reason for hiding this comment

Uh oh!

trentm Jul 15, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

maryliag left a comment

Choose a reason for hiding this comment

Uh oh!

hectorhdzg commented Jul 16, 2024

Uh oh!

trentm commented Jul 17, 2024

Uh oh!

hectorhdzg left a comment

Choose a reason for hiding this comment

Uh oh!

JamieDanielson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JamieDanielson Jul 23, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JamieDanielson commented Jul 23, 2024

Uh oh!

Check failure

Check failure

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

fix(instrumentation-http): Ensure instrumentation of `http.get` and `https.get` work when used in ESM code #4866

fix(instrumentation-http): Ensure instrumentation of `http.get` and `https.get` work when used in ESM code #4866