-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
feat(http): refactor node:http client instrumentation for portability #20393
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
isaacs
wants to merge
8
commits into
develop
Choose a base branch
from
isaacschlueter/portable-http-integration-client
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
0103473
core: add getDefaultExport method
isaacs 6cf3536
feat(http): portable node:http client instrumentation (#20393)
isaacs 178c45e
fixup! feat(http): portable node:http client instrumentation (#20393)
isaacs 171bd38
fixup! feat(http): portable node:http client instrumentation (#20393)
isaacs e1ae662
fixup! feat(http): portable node:http client instrumentation (#20393)
isaacs 5c11ce7
fixup! fixup! feat(http): portable node:http client instrumentation (…
isaacs 4f3b260
fixup! core: add getDefaultExport method
isaacs 9abf370
fixup! feat(http): portable node:http client instrumentation (#20393)
isaacs File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
261 changes: 80 additions & 181 deletions
261
...ages/node-core-integration-tests/suites/tracing/requests/http-no-tracing-no-spans/test.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,202 +1,101 @@ | ||
| import { createTestServer } from '@sentry-internal/test-utils'; | ||
| import { describe, expect } from 'vitest'; | ||
| import { conditionalTest } from '../../../../utils'; | ||
| import { createEsmAndCjsTests } from '../../../../utils/runner'; | ||
|
|
||
| describe('outgoing http requests with tracing & spans disabled', () => { | ||
| createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => { | ||
| conditionalTest({ min: 22 })('node >=22', () => { | ||
| test('outgoing http requests are correctly instrumented with tracing & spans disabled', async () => { | ||
| expect.assertions(11); | ||
| test('outgoing http requests are correctly instrumented with tracing & spans disabled', async () => { | ||
| expect.assertions(11); | ||
|
|
||
| const [SERVER_URL, closeTestServer] = await createTestServer() | ||
| .get('/api/v0', headers => { | ||
| expect(headers['sentry-trace']).toEqual(expect.stringMatching(/^([a-f\d]{32})-([a-f\d]{16})$/)); | ||
| expect(headers['sentry-trace']).not.toEqual('00000000000000000000000000000000-0000000000000000'); | ||
| expect(headers['baggage']).toEqual(expect.any(String)); | ||
| }) | ||
| .get('/api/v1', headers => { | ||
| expect(headers['sentry-trace']).toEqual(expect.stringMatching(/^([a-f\d]{32})-([a-f\d]{16})$/)); | ||
| expect(headers['sentry-trace']).not.toEqual('00000000000000000000000000000000-0000000000000000'); | ||
| expect(headers['baggage']).toEqual(expect.any(String)); | ||
| }) | ||
| .get('/api/v2', headers => { | ||
| expect(headers['baggage']).toBeUndefined(); | ||
| expect(headers['sentry-trace']).toBeUndefined(); | ||
| }) | ||
| .get('/api/v3', headers => { | ||
| expect(headers['baggage']).toBeUndefined(); | ||
| expect(headers['sentry-trace']).toBeUndefined(); | ||
| }) | ||
| .start(); | ||
| const [SERVER_URL, closeTestServer] = await createTestServer() | ||
| .get('/api/v0', headers => { | ||
| expect(headers['sentry-trace']).toEqual(expect.stringMatching(/^([a-f\d]{32})-([a-f\d]{16})$/)); | ||
| expect(headers['sentry-trace']).not.toEqual('00000000000000000000000000000000-0000000000000000'); | ||
| expect(headers['baggage']).toEqual(expect.any(String)); | ||
| }) | ||
| .get('/api/v1', headers => { | ||
| expect(headers['sentry-trace']).toEqual(expect.stringMatching(/^([a-f\d]{32})-([a-f\d]{16})$/)); | ||
| expect(headers['sentry-trace']).not.toEqual('00000000000000000000000000000000-0000000000000000'); | ||
| expect(headers['baggage']).toEqual(expect.any(String)); | ||
| }) | ||
| .get('/api/v2', headers => { | ||
| expect(headers['baggage']).toBeUndefined(); | ||
| expect(headers['sentry-trace']).toBeUndefined(); | ||
| }) | ||
| .get('/api/v3', headers => { | ||
| expect(headers['baggage']).toBeUndefined(); | ||
| expect(headers['sentry-trace']).toBeUndefined(); | ||
| }) | ||
| .start(); | ||
|
|
||
| await createRunner() | ||
| .withEnv({ SERVER_URL }) | ||
| .expect({ | ||
| event: { | ||
| exception: { | ||
| values: [ | ||
| { | ||
| type: 'Error', | ||
| value: 'foo', | ||
| }, | ||
| ], | ||
| }, | ||
| breadcrumbs: [ | ||
| { | ||
| message: 'manual breadcrumb', | ||
| timestamp: expect.any(Number), | ||
| }, | ||
| { | ||
| category: 'http', | ||
| data: { | ||
| 'http.method': 'GET', | ||
| url: `${SERVER_URL}/api/v0`, | ||
| status_code: 200, | ||
| ADDED_PATH: '/api/v0', | ||
| }, | ||
| timestamp: expect.any(Number), | ||
| type: 'http', | ||
| }, | ||
| { | ||
| category: 'http', | ||
| data: { | ||
| 'http.method': 'GET', | ||
| url: `${SERVER_URL}/api/v1`, | ||
| status_code: 200, | ||
| ADDED_PATH: '/api/v1', | ||
| }, | ||
| timestamp: expect.any(Number), | ||
| type: 'http', | ||
| }, | ||
| await createRunner() | ||
| .withEnv({ SERVER_URL }) | ||
| .expect({ | ||
| event: { | ||
| exception: { | ||
| values: [ | ||
| { | ||
| category: 'http', | ||
| data: { | ||
| 'http.method': 'GET', | ||
| url: `${SERVER_URL}/api/v2`, | ||
| status_code: 200, | ||
| ADDED_PATH: '/api/v2', | ||
| }, | ||
| timestamp: expect.any(Number), | ||
| type: 'http', | ||
| }, | ||
| { | ||
| category: 'http', | ||
| data: { | ||
| 'http.method': 'GET', | ||
| url: `${SERVER_URL}/api/v3`, | ||
| status_code: 200, | ||
| ADDED_PATH: '/api/v3', | ||
| }, | ||
| timestamp: expect.any(Number), | ||
| type: 'http', | ||
| type: 'Error', | ||
| value: 'foo', | ||
| }, | ||
| ], | ||
| }, | ||
| }) | ||
| .start() | ||
| .completed(); | ||
|
|
||
| closeTestServer(); | ||
| }); | ||
| }); | ||
|
|
||
| // On older node versions, outgoing requests do not get trace-headers injected, sadly | ||
| // This is because the necessary diagnostics channel hook is not available yet | ||
| conditionalTest({ max: 21 })('node <22', () => { | ||
|
JPeer264 marked this conversation as resolved.
|
||
| test('outgoing http requests generate breadcrumbs correctly with tracing & spans disabled', async () => { | ||
| expect.assertions(9); | ||
|
|
||
| const [SERVER_URL, closeTestServer] = await createTestServer() | ||
| .get('/api/v0', headers => { | ||
| // This is not instrumented, sadly | ||
| expect(headers['baggage']).toBeUndefined(); | ||
| expect(headers['sentry-trace']).toBeUndefined(); | ||
| }) | ||
| .get('/api/v1', headers => { | ||
| // This is not instrumented, sadly | ||
| expect(headers['baggage']).toBeUndefined(); | ||
| expect(headers['sentry-trace']).toBeUndefined(); | ||
| }) | ||
| .get('/api/v2', headers => { | ||
| expect(headers['baggage']).toBeUndefined(); | ||
| expect(headers['sentry-trace']).toBeUndefined(); | ||
| }) | ||
| .get('/api/v3', headers => { | ||
| expect(headers['baggage']).toBeUndefined(); | ||
| expect(headers['sentry-trace']).toBeUndefined(); | ||
| }) | ||
| .start(); | ||
|
|
||
| await createRunner() | ||
| .withEnv({ SERVER_URL }) | ||
| .expect({ | ||
| event: { | ||
| exception: { | ||
| values: [ | ||
| { | ||
| type: 'Error', | ||
| value: 'foo', | ||
| }, | ||
| ], | ||
| breadcrumbs: [ | ||
| { | ||
| message: 'manual breadcrumb', | ||
| timestamp: expect.any(Number), | ||
| }, | ||
| breadcrumbs: [ | ||
| { | ||
| message: 'manual breadcrumb', | ||
| timestamp: expect.any(Number), | ||
| }, | ||
| { | ||
| category: 'http', | ||
| data: { | ||
| 'http.method': 'GET', | ||
| url: `${SERVER_URL}/api/v0`, | ||
| status_code: 200, | ||
| ADDED_PATH: '/api/v0', | ||
| }, | ||
| timestamp: expect.any(Number), | ||
| type: 'http', | ||
| { | ||
| category: 'http', | ||
| data: { | ||
| 'http.method': 'GET', | ||
| url: `${SERVER_URL}/api/v0`, | ||
| status_code: 200, | ||
| ADDED_PATH: '/api/v0', | ||
| }, | ||
| { | ||
| category: 'http', | ||
| data: { | ||
| 'http.method': 'GET', | ||
| url: `${SERVER_URL}/api/v1`, | ||
| status_code: 200, | ||
| ADDED_PATH: '/api/v1', | ||
| }, | ||
| timestamp: expect.any(Number), | ||
| type: 'http', | ||
| timestamp: expect.any(Number), | ||
| type: 'http', | ||
| }, | ||
| { | ||
| category: 'http', | ||
| data: { | ||
| 'http.method': 'GET', | ||
| url: `${SERVER_URL}/api/v1`, | ||
| status_code: 200, | ||
| ADDED_PATH: '/api/v1', | ||
| }, | ||
| { | ||
| category: 'http', | ||
| data: { | ||
| 'http.method': 'GET', | ||
| url: `${SERVER_URL}/api/v2`, | ||
| status_code: 200, | ||
| ADDED_PATH: '/api/v2', | ||
| }, | ||
| timestamp: expect.any(Number), | ||
| type: 'http', | ||
| timestamp: expect.any(Number), | ||
| type: 'http', | ||
| }, | ||
| { | ||
| category: 'http', | ||
| data: { | ||
| 'http.method': 'GET', | ||
| url: `${SERVER_URL}/api/v2`, | ||
| status_code: 200, | ||
| ADDED_PATH: '/api/v2', | ||
| }, | ||
| { | ||
| category: 'http', | ||
| data: { | ||
| 'http.method': 'GET', | ||
| url: `${SERVER_URL}/api/v3`, | ||
| status_code: 200, | ||
| ADDED_PATH: '/api/v3', | ||
| }, | ||
| timestamp: expect.any(Number), | ||
| type: 'http', | ||
| timestamp: expect.any(Number), | ||
| type: 'http', | ||
| }, | ||
| { | ||
| category: 'http', | ||
| data: { | ||
| 'http.method': 'GET', | ||
| url: `${SERVER_URL}/api/v3`, | ||
| status_code: 200, | ||
| ADDED_PATH: '/api/v3', | ||
| }, | ||
| ], | ||
| }, | ||
| }) | ||
| .start() | ||
| .completed(); | ||
| timestamp: expect.any(Number), | ||
| type: 'http', | ||
| }, | ||
| ], | ||
| }, | ||
| }) | ||
| .start() | ||
| .completed(); | ||
|
|
||
| closeTestServer(); | ||
| }); | ||
| closeTestServer(); | ||
| }); | ||
| }); | ||
| }); | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Light http integration loses trace propagation on Node <22
Medium Severity
The
node-corelighthttpIntegrationonly injectssentry-trace/baggagevia thehttp.client.request.createddiagnostic channel, which does not exist before Node 22.12. The fallback added for older Nodes (http.client.request.start) only attaches breadcrumb listeners — it cannot inject headers because that channel fires after headers have been sent. The corresponding integration test was un-gated fromconditionalTest({ min: 22 })and now unconditionally assertssentry-traceandbaggageare set on/api/v0and/api/v1, which will fail when the suite runs against Node <22.Additional Locations (1)
packages/node-core/src/light/integrations/httpIntegration.ts#L109-L141Reviewed by Cursor Bugbot for commit 5c11ce7. Configure here.