Skip to content
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

fix(node): remove new URL usage in Undici integration #8147

Merged
merged 1 commit into from
May 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 18 additions & 11 deletions packages/node/src/integrations/undici/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ import type { EventProcessor, Integration } from '@sentry/types';
import {
dynamicRequire,
dynamicSamplingContextToSentryBaggageHeader,
getSanitizedUrlString,
parseUrl,
stringMatchesSomePattern,
stripUrlQueryAndFragment,
} from '@sentry/utils';
import { LRUMap } from 'lru_map';

Expand Down Expand Up @@ -36,6 +37,15 @@ export interface UndiciOptions {
// Please note that you cannot use `console.log` to debug the callbacks registered to the `diagnostics_channel` API.
// To debug, you can use `writeFileSync` to write to a file:
// https://nodejs.org/api/async_hooks.html#printing-in-asynchook-callbacks
//
// import { writeFileSync } from 'fs';
// import { format } from 'util';
//
// function debug(...args: any): void {
// // Use a function like this one when debugging inside an AsyncHook callback
// // @ts-ignore any
// writeFileSync('log.out', `${format(...args)}\n`, { flag: 'a' });
// }

/**
* Instruments outgoing HTTP requests made with the `undici` package via
Expand Down Expand Up @@ -113,8 +123,8 @@ export class Undici implements Integration {

const { request } = message as RequestCreateMessage;

const url = new URL(request.path, request.origin);
const stringUrl = url.toString();
const stringUrl = request.origin ? request.origin.toString() + request.path : request.path;
const url = parseUrl(stringUrl);

if (isSentryRequest(stringUrl) || request.__sentry__ !== undefined) {
return;
Expand All @@ -133,16 +143,15 @@ export class Undici implements Integration {
const data: Record<string, unknown> = {
'http.method': method,
};
const params = url.searchParams.toString();
if (params) {
data['http.query'] = `?${params}`;
if (url.search) {
data['http.query'] = url.search;
}
if (url.hash) {
data['http.fragment'] = url.hash;
}
const span = activeSpan.startChild({
op: 'http.client',
description: `${method} ${stripUrlQueryAndFragment(stringUrl)}`,
description: `${method} ${getSanitizedUrlString(url)}`,
data,
});
request.__sentry__ = span;
Expand Down Expand Up @@ -184,8 +193,7 @@ export class Undici implements Integration {

const { request, response } = message as RequestEndMessage;

const url = new URL(request.path, request.origin);
const stringUrl = url.toString();
const stringUrl = request.origin ? request.origin.toString() + request.path : request.path;

if (isSentryRequest(stringUrl)) {
return;
Expand Down Expand Up @@ -225,8 +233,7 @@ export class Undici implements Integration {

const { request } = message as RequestErrorMessage;

const url = new URL(request.path, request.origin);
const stringUrl = url.toString();
const stringUrl = request.origin ? request.origin.toString() + request.path : request.path;

if (isSentryRequest(stringUrl)) {
return;
Expand Down
19 changes: 19 additions & 0 deletions packages/node/test/integrations/undici.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,25 @@ conditionalTest({ min: 16 })('Undici integration', () => {
expect(span).toEqual(expect.objectContaining({ status: 'internal_error' }));
});

it('creates a span for invalid looking urls', async () => {
const transaction = hub.startTransaction({ name: 'test-transaction' }) as Transaction;
hub.getScope().setSpan(transaction);

try {
// Intentionally add // to the url
// fetch accepts this URL, but throws an error later on
await fetch('http://a-url-that-no-exists.com//');
} catch (e) {
// ignore
}

expect(transaction.spanRecorder?.spans.length).toBe(2);

const span = transaction.spanRecorder?.spans[1];
expect(span).toEqual(expect.objectContaining({ description: 'GET http://a-url-that-no-exists.com//' }));
expect(span).toEqual(expect.objectContaining({ status: 'internal_error' }));
});

it('does not create a span for sentry requests', async () => {
const transaction = hub.startTransaction({ name: 'test-transaction' }) as Transaction;
hub.getScope().setSpan(transaction);
Expand Down