feat(browser): Attach virtual stack traces to HttpClient events.#14515

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.

Sign up for GitHub

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

Merged
lforst merged 4 commits into from
Dec 12, 2024
Merged

feat(browser): Attach virtual stack traces to HttpClient events. #14515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b776eac
feat(browser): Attach virtual stack traces to `HttpClient` events.
onurtemizkan Nov 27, 2024
648693c
Update integration tests
onurtemizkan Nov 27, 2024
33a5bfa
Pass stacktrace string instead of error.
onurtemizkan Nov 28, 2024
a7b89bc
Switch back to passing error
onurtemizkan Nov 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions dev-packages/browser-integration-tests/suites/integrations/httpclient/axios/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
type: 'http.client',
handled: false,
},
stacktrace: {
frames: expect.arrayContaining([
expect.objectContaining({
filename: 'http://sentry-test.io/subject.bundle.js',
function: '?',
in_app: true,
}),
]),
},
},
],
},
Expand Down
9 changes: 9 additions & 0 deletions dev-packages/browser-integration-tests/suites/integrations/httpclient/fetch/simple/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,15 @@ sentryTest(
type: 'http.client',
handled: false,
},
stacktrace: {
frames: expect.arrayContaining([
expect.objectContaining({
filename: 'http://sentry-test.io/subject.bundle.js',
function: '?',
in_app: true,
}),
]),
},
},
],
},
Expand Down
9 changes: 9 additions & 0 deletions ...ckages/browser-integration-tests/suites/integrations/httpclient/fetch/withRequest/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,15 @@ sentryTest('works with a Request passed in', async ({ getLocalTestUrl, page }) =
type: 'http.client',
handled: false,
},
stacktrace: {
frames: expect.arrayContaining([
expect.objectContaining({
filename: 'http://sentry-test.io/subject.bundle.js',
function: '?',
in_app: true,
}),
]),
},
},
],
},
Expand Down
9 changes: 9 additions & 0 deletions ...tegration-tests/suites/integrations/httpclient/fetch/withRequestAndBodyAndOptions/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
type: 'http.client',
handled: false,
},
stacktrace: {
frames: expect.arrayContaining([
expect.objectContaining({
filename: 'http://sentry-test.io/subject.bundle.js',
function: '?',
in_app: true,
}),
]),
},
},
],
},
Expand Down
9 changes: 9 additions & 0 deletions ...wser-integration-tests/suites/integrations/httpclient/fetch/withRequestAndOptions/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,15 @@ sentryTest('works with a Request (without body) & options passed in', async ({ g
type: 'http.client',
handled: false,
},
stacktrace: {
frames: expect.arrayContaining([
expect.objectContaining({
filename: 'http://sentry-test.io/subject.bundle.js',
function: '?',
in_app: true,
}),
]),
},
},
],
},
Expand Down
9 changes: 9 additions & 0 deletions dev-packages/browser-integration-tests/suites/integrations/httpclient/xhr/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
type: 'http.client',
handled: false,
},
stacktrace: {
frames: expect.arrayContaining([
expect.objectContaining({
filename: 'http://sentry-test.io/subject.bundle.js',
function: '?',
in_app: true,
}),
]),
},
},
],
},
Expand Down
1 change: 0 additions & 1 deletion dev-packages/browser-integration-tests/utils/generatePlugin.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -176,7 +176,6 @@ class SentryScenarioGenerationPlugin {
}
: {};

// Checking if the current scenario has imported `@sentry/integrations`.
compiler.hooks.normalModuleFactory.tap(this._name, factory => {
factory.hooks.parser.for('javascript/auto').tap(this._name, parser => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
Expand Down
8 changes: 8 additions & 0 deletions packages/browser-utils/src/instrument/xhr.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,13 @@ export function instrumentXHR(): void {
// eslint-disable-next-line @typescript-eslint/unbound-method
xhrproto.open = new Proxy(xhrproto.open, {
apply(originalOpen, xhrOpenThisArg: XMLHttpRequest & SentryWrappedXMLHttpRequest, xhrOpenArgArray) {
// NOTE: If you are a Sentry user, and you are seeing this stack frame,
// it means the error, that was caused by your XHR call did not
// have a stack trace. If you are using HttpClient integration,
// this is the expected behavior, as we are using this virtual error to capture
// the location of your XHR call, and group your HttpClient events accordingly.
const virtualError = new Error();

const startTimestamp = timestampInSeconds() * 1000;

// open() should always be called with two or more arguments
Expand DownExpand Up@@ -75,6 +82,7 @@ export function instrumentXHR(): void {
endTimestamp: timestampInSeconds() * 1000,
startTimestamp,
xhr: xhrOpenThisArg,
virtualError,
};
triggerHandlers('xhr', handlerData);
}
Expand Down
20 changes: 16 additions & 4 deletions packages/browser/src/integrations/httpclient.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ function _fetchResponseHandler(
requestInfo: RequestInfo,
response: Response,
requestInit?: RequestInit,
error?: unknown,
): void {
if (_shouldCaptureResponse(options, response.status, response.url)) {
const request = _getRequest(requestInfo, requestInit);
Expand All@@ -89,6 +90,7 @@ function _fetchResponseHandler(
responseHeaders,
requestCookies,
responseCookies,
error,
});

captureEvent(event);
Expand DownExpand Up@@ -127,6 +129,7 @@ function _xhrResponseHandler(
xhr: XMLHttpRequest,
method: string,
headers: Record<string, string>,
error?: unknown,
): void {
if (_shouldCaptureResponse(options, xhr.status, xhr.responseURL)) {
let requestHeaders, responseCookies, responseHeaders;
Expand DownExpand Up@@ -159,6 +162,7 @@ function _xhrResponseHandler(
// Can't access request cookies from XHR
responseHeaders,
responseCookies,
error,
});

captureEvent(event);
Expand DownExpand Up@@ -288,15 +292,15 @@ function _wrapFetch(client: Client, options: HttpClientOptions): void {
return;
}

const { response, args } = handlerData;
const { response, args, error, virtualError } = handlerData;
const [requestInfo, requestInit] = args as [RequestInfo, RequestInit | undefined];

if (!response) {
return;
}

_fetchResponseHandler(options, requestInfo, response as Response, requestInit);
});
_fetchResponseHandler(options, requestInfo, response as Response, requestInit, error || virtualError);
}, false);
}

/**
Expand All@@ -312,6 +316,8 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
return;
}

const { error, virtualError } = handlerData;

const xhr = handlerData.xhr as SentryWrappedXMLHttpRequest & XMLHttpRequest;

const sentryXhrData = xhr[SENTRY_XHR_DATA_KEY];
Expand All@@ -323,7 +329,7 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
const { method, request_headers: headers } = sentryXhrData;

try {
_xhrResponseHandler(options, xhr, method, headers);
_xhrResponseHandler(options, xhr, method, headers, error || virtualError);
} catch (e) {
DEBUG_BUILD && logger.warn('Error while extracting response event form XHR response', e);
}
Expand DownExpand Up@@ -358,7 +364,12 @@ function _createEvent(data: {
responseCookies?: Record<string, string>;
requestHeaders?: Record<string, string>;
requestCookies?: Record<string, string>;
error?: unknown;
}): SentryEvent {
const client = getClient();
const virtualStackTrace = client && data.error && data.error instanceof Error ? data.error.stack : undefined;
// Remove the first frame from the stack as it's the HttpClient call
const stack = virtualStackTrace && client ? client.getOptions().stackParser(virtualStackTrace, 0, 1) : undefined;
const message = `HTTP Client Error with status code: ${data.status}`;

const event: SentryEvent = {
Expand All@@ -368,6 +379,7 @@ function _createEvent(data: {
{
type: 'Error',
value: message,
stacktrace: stack ? { frames: stack } : undefined,
},
],
},
Expand Down
5 changes: 5 additions & 0 deletions packages/core/src/types-hoist/instrument.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,9 @@ export interface HandlerDataXhr {
xhr: SentryWrappedXMLHttpRequest;
startTimestamp?: number;
endTimestamp?: number;
error?: unknown;
// This is to be consumed by the HttpClient integration
virtualError?: unknown;
}

interface SentryFetchData {
Expand All@@ -56,6 +59,8 @@ export interface HandlerDataFetch {
headers: WebFetchHeaders;
};
error?: unknown;
// This is to be consumed by the HttpClient integration
virtualError?: unknown;
}

export interface HandlerDataDom {
Expand Down
22 changes: 12 additions & 10 deletions packages/core/src/utils-hoist/instrument/fetch.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,15 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat

fill(GLOBAL_OBJ, 'fetch', function (originalFetch: () => void): () => void {
return function (...args: any[]): void {
// We capture the error right here and not in the Promise error callback because Safari (and probably other
// browsers too) will wipe the stack trace up to this point, only leaving us with this file which is useless.

// NOTE: If you are a Sentry user, and you are seeing this stack frame,
// it means the error, that was caused by your fetch call did not
// have a stack trace, so the SDK backfilled the stack trace so
// you can see which fetch call failed.
const virtualError = new Error();

const { method, url } = parseFetchArgs(args);
const handlerData: HandlerDataFetch = {
args,
Expand All@@ -56,6 +65,8 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
url,
},
startTimestamp: timestampInSeconds() * 1000,
// // Adding the error to be able to fingerprint the failed fetch event in HttpClient instrumentation
virtualError,
};

// if there is no callback, fetch is instrumented directly
Expand All@@ -65,15 +76,6 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
});
}

// We capture the stack right here and not in the Promise error callback because Safari (and probably other
// browsers too) will wipe the stack trace up to this point, only leaving us with this file which is useless.

// NOTE: If you are a Sentry user, and you are seeing this stack frame,
// it means the error, that was caused by your fetch call did not
// have a stack trace, so the SDK backfilled the stack trace so
// you can see which fetch call failed.
const virtualStackTrace = new Error().stack;

// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
return originalFetch.apply(GLOBAL_OBJ, args).then(
async (response: Response) => {
Expand DownExpand Up@@ -101,7 +103,7 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
// it means the error, that was caused by your fetch call did not
// have a stack trace, so the SDK backfilled the stack trace so
// you can see which fetch call failed.
error.stack = virtualStackTrace;
error.stack = virtualError.stack;
addNonEnumerableProperty(error, 'framesToPop', 1);
}

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(browser): Attach virtual stack traces to HttpClient events.#14515

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.

 Sign up for GitHub

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

 Merged

lforst
merged 4 commits into

from

Dec 12, 2024
 Merged


feat(browser): Attach virtual stack traces to HttpClient events.
#14515
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
b776eac

feat(browser): Attach virtual stack traces to `HttpClient` events.


onurtemizkan Nov 27, 2024
648693c

Update integration tests


onurtemizkan Nov 27, 2024
33a5bfa

Pass stacktrace string instead of error.


onurtemizkan Nov 28, 2024
a7b89bc

Switch back to passing error


onurtemizkan Nov 29, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/axios/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/fetch/simple/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...ckages/browser-integration-tests/suites/integrations/httpclient/fetch/withRequest/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,15 @@ sentryTest('works with a Request passed in', async ({ getLocalTestUrl, page }) =
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...tegration-tests/suites/integrations/httpclient/fetch/withRequestAndBodyAndOptions/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...wser-integration-tests/suites/integrations/httpclient/fetch/withRequestAndOptions/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,15 @@ sentryTest('works with a Request (without body) & options passed in', async ({ g
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/xhr/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

1 change: 0 additions & 1 deletion
dev-packages/browser-integration-tests/utils/generatePlugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -176,7 +176,6 @@ class SentryScenarioGenerationPlugin {
 }
 : {};

 // Checking if the current scenario has imported `@sentry/integrations`.
 compiler.hooks.normalModuleFactory.tap(this._name, factory => {
 factory.hooks.parser.for('javascript/auto').tap(this._name, parser => {
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
Expand Down

8 changes: 8 additions & 0 deletions
packages/browser-utils/src/instrument/xhr.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,13 @@ export function instrumentXHR(): void {
 // eslint-disable-next-line @typescript-eslint/unbound-method
 xhrproto.open = new Proxy(xhrproto.open, {
 apply(originalOpen, xhrOpenThisArg: XMLHttpRequest & SentryWrappedXMLHttpRequest, xhrOpenArgArray) {
 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your XHR call did not
 // have a stack trace. If you are using HttpClient integration,
 // this is the expected behavior, as we are using this virtual error to capture
 // the location of your XHR call, and group your HttpClient events accordingly.
 const virtualError = new Error();

 const startTimestamp = timestampInSeconds() * 1000;

 // open() should always be called with two or more arguments
Expand DownExpand Up@@ -75,6 +82,7 @@ export function instrumentXHR(): void {
 endTimestamp: timestampInSeconds() * 1000,
 startTimestamp,
 xhr: xhrOpenThisArg,
 virtualError,
 };
 triggerHandlers('xhr', handlerData);
 }
Expand Down

20 changes: 16 additions & 4 deletions
packages/browser/src/integrations/httpclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ function _fetchResponseHandler(
 requestInfo: RequestInfo,
 response: Response,
 requestInit?: RequestInit,
 error?: unknown,
): void {
 if (_shouldCaptureResponse(options, response.status, response.url)) {
 const request = _getRequest(requestInfo, requestInit);
Expand All@@ -89,6 +90,7 @@ function _fetchResponseHandler(
 responseHeaders,
 requestCookies,
 responseCookies,
 error,
 });

 captureEvent(event);
Expand DownExpand Up@@ -127,6 +129,7 @@ function _xhrResponseHandler(
 xhr: XMLHttpRequest,
 method: string,
 headers: Record<string, string>,
 error?: unknown,
): void {
 if (_shouldCaptureResponse(options, xhr.status, xhr.responseURL)) {
 let requestHeaders, responseCookies, responseHeaders;
Expand DownExpand Up@@ -159,6 +162,7 @@ function _xhrResponseHandler(
 // Can't access request cookies from XHR
 responseHeaders,
 responseCookies,
 error,
 });

 captureEvent(event);
Expand DownExpand Up@@ -288,15 +292,15 @@ function _wrapFetch(client: Client, options: HttpClientOptions): void {
 return;
 }

 const { response, args } = handlerData;
 const { response, args, error, virtualError } = handlerData;
 const [requestInfo, requestInit] = args as [RequestInfo, RequestInit | undefined];

 if (!response) {
 return;
 }

 _fetchResponseHandler(options, requestInfo, response as Response, requestInit);
 });
 _fetchResponseHandler(options, requestInfo, response as Response, requestInit, error || virtualError);
 }, false);
}

/**
Expand All@@ -312,6 +316,8 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
 return;
 }

 const { error, virtualError } = handlerData;

 const xhr = handlerData.xhr as SentryWrappedXMLHttpRequest & XMLHttpRequest;

 const sentryXhrData = xhr[SENTRY_XHR_DATA_KEY];
Expand All@@ -323,7 +329,7 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
 const { method, request_headers: headers } = sentryXhrData;

 try {
 _xhrResponseHandler(options, xhr, method, headers);
 _xhrResponseHandler(options, xhr, method, headers, error || virtualError);
 } catch (e) {
 DEBUG_BUILD && logger.warn('Error while extracting response event form XHR response', e);
 }
Expand DownExpand Up@@ -358,7 +364,12 @@ function _createEvent(data: {
 responseCookies?: Record<string, string>;
 requestHeaders?: Record<string, string>;
 requestCookies?: Record<string, string>;
 error?: unknown;
}): SentryEvent {
 const client = getClient();
 const virtualStackTrace = client && data.error && data.error instanceof Error ? data.error.stack : undefined;
 // Remove the first frame from the stack as it's the HttpClient call
 const stack = virtualStackTrace && client ? client.getOptions().stackParser(virtualStackTrace, 0, 1) : undefined;
 const message = `HTTP Client Error with status code: ${data.status}`;

 const event: SentryEvent = {
Expand All@@ -368,6 +379,7 @@ function _createEvent(data: {
 {
 type: 'Error',
 value: message,
 stacktrace: stack ? { frames: stack } : undefined,
 },
 ],
 },
Expand Down

5 changes: 5 additions & 0 deletions
packages/core/src/types-hoist/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,9 @@ export interface HandlerDataXhr {
 xhr: SentryWrappedXMLHttpRequest;
 startTimestamp?: number;
 endTimestamp?: number;
 error?: unknown;
 // This is to be consumed by the HttpClient integration
 virtualError?: unknown;
}

interface SentryFetchData {
Expand All@@ -56,6 +59,8 @@ export interface HandlerDataFetch {
 headers: WebFetchHeaders;
 };
 error?: unknown;
 // This is to be consumed by the HttpClient integration
 virtualError?: unknown;
}

export interface HandlerDataDom {
Expand Down

22 changes: 12 additions & 10 deletions
packages/core/src/utils-hoist/instrument/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,15 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat

 fill(GLOBAL_OBJ, 'fetch', function (originalFetch: () => void): () => void {
 return function (...args: any[]): void {
 // We capture the error right here and not in the Promise error callback because Safari (and probably other
 // browsers too) will wipe the stack trace up to this point, only leaving us with this file which is useless.

 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 const virtualError = new Error();

 const { method, url } = parseFetchArgs(args);
 const handlerData: HandlerDataFetch = {
 args,
Expand All@@ -56,6 +65,8 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 url,
 },
 startTimestamp: timestampInSeconds() * 1000,
 // // Adding the error to be able to fingerprint the failed fetch event in HttpClient instrumentation
 virtualError,
 };

 // if there is no callback, fetch is instrumented directly
Expand All@@ -65,15 +76,6 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 });
 }

 // We capture the stack right here and not in the Promise error callback because Safari (and probably other
 // browsers too) will wipe the stack trace up to this point, only leaving us with this file which is useless.

 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 const virtualStackTrace = new Error().stack;

 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
 return originalFetch.apply(GLOBAL_OBJ, args).then(
 async (response: Response) => {
Expand DownExpand Up@@ -101,7 +103,7 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 error.stack = virtualStackTrace;
 error.stack = virtualError.stack;
 addNonEnumerableProperty(error, 'framesToPop', 1);
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(browser): Attach virtual stack traces to HttpClient events.#14515

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.

 Sign up for GitHub

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

 Merged

lforst
merged 4 commits into

from

Dec 12, 2024
 Merged


feat(browser): Attach virtual stack traces to HttpClient events.
#14515
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
b776eac

feat(browser): Attach virtual stack traces to `HttpClient` events.


onurtemizkan Nov 27, 2024
648693c

Update integration tests


onurtemizkan Nov 27, 2024
33a5bfa

Pass stacktrace string instead of error.


onurtemizkan Nov 28, 2024
a7b89bc

Switch back to passing error


onurtemizkan Nov 29, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/axios/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/fetch/simple/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...ckages/browser-integration-tests/suites/integrations/httpclient/fetch/withRequest/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,15 @@ sentryTest('works with a Request passed in', async ({ getLocalTestUrl, page }) =
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...tegration-tests/suites/integrations/httpclient/fetch/withRequestAndBodyAndOptions/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...wser-integration-tests/suites/integrations/httpclient/fetch/withRequestAndOptions/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,15 @@ sentryTest('works with a Request (without body) & options passed in', async ({ g
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/xhr/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

1 change: 0 additions & 1 deletion
dev-packages/browser-integration-tests/utils/generatePlugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -176,7 +176,6 @@ class SentryScenarioGenerationPlugin {
 }
 : {};

 // Checking if the current scenario has imported `@sentry/integrations`.
 compiler.hooks.normalModuleFactory.tap(this._name, factory => {
 factory.hooks.parser.for('javascript/auto').tap(this._name, parser => {
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
Expand Down

8 changes: 8 additions & 0 deletions
packages/browser-utils/src/instrument/xhr.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,13 @@ export function instrumentXHR(): void {
 // eslint-disable-next-line @typescript-eslint/unbound-method
 xhrproto.open = new Proxy(xhrproto.open, {
 apply(originalOpen, xhrOpenThisArg: XMLHttpRequest & SentryWrappedXMLHttpRequest, xhrOpenArgArray) {
 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your XHR call did not
 // have a stack trace. If you are using HttpClient integration,
 // this is the expected behavior, as we are using this virtual error to capture
 // the location of your XHR call, and group your HttpClient events accordingly.
 const virtualError = new Error();

 const startTimestamp = timestampInSeconds() * 1000;

 // open() should always be called with two or more arguments
Expand DownExpand Up@@ -75,6 +82,7 @@ export function instrumentXHR(): void {
 endTimestamp: timestampInSeconds() * 1000,
 startTimestamp,
 xhr: xhrOpenThisArg,
 virtualError,
 };
 triggerHandlers('xhr', handlerData);
 }
Expand Down

20 changes: 16 additions & 4 deletions
packages/browser/src/integrations/httpclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ function _fetchResponseHandler(
 requestInfo: RequestInfo,
 response: Response,
 requestInit?: RequestInit,
 error?: unknown,
): void {
 if (_shouldCaptureResponse(options, response.status, response.url)) {
 const request = _getRequest(requestInfo, requestInit);
Expand All@@ -89,6 +90,7 @@ function _fetchResponseHandler(
 responseHeaders,
 requestCookies,
 responseCookies,
 error,
 });

 captureEvent(event);
Expand DownExpand Up@@ -127,6 +129,7 @@ function _xhrResponseHandler(
 xhr: XMLHttpRequest,
 method: string,
 headers: Record<string, string>,
 error?: unknown,
): void {
 if (_shouldCaptureResponse(options, xhr.status, xhr.responseURL)) {
 let requestHeaders, responseCookies, responseHeaders;
Expand DownExpand Up@@ -159,6 +162,7 @@ function _xhrResponseHandler(
 // Can't access request cookies from XHR
 responseHeaders,
 responseCookies,
 error,
 });

 captureEvent(event);
Expand DownExpand Up@@ -288,15 +292,15 @@ function _wrapFetch(client: Client, options: HttpClientOptions): void {
 return;
 }

 const { response, args } = handlerData;
 const { response, args, error, virtualError } = handlerData;
 const [requestInfo, requestInit] = args as [RequestInfo, RequestInit | undefined];

 if (!response) {
 return;
 }

 _fetchResponseHandler(options, requestInfo, response as Response, requestInit);
 });
 _fetchResponseHandler(options, requestInfo, response as Response, requestInit, error || virtualError);
 }, false);
}

/**
Expand All@@ -312,6 +316,8 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
 return;
 }

 const { error, virtualError } = handlerData;

 const xhr = handlerData.xhr as SentryWrappedXMLHttpRequest & XMLHttpRequest;

 const sentryXhrData = xhr[SENTRY_XHR_DATA_KEY];
Expand All@@ -323,7 +329,7 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
 const { method, request_headers: headers } = sentryXhrData;

 try {
 _xhrResponseHandler(options, xhr, method, headers);
 _xhrResponseHandler(options, xhr, method, headers, error || virtualError);
 } catch (e) {
 DEBUG_BUILD && logger.warn('Error while extracting response event form XHR response', e);
 }
Expand DownExpand Up@@ -358,7 +364,12 @@ function _createEvent(data: {
 responseCookies?: Record<string, string>;
 requestHeaders?: Record<string, string>;
 requestCookies?: Record<string, string>;
 error?: unknown;
}): SentryEvent {
 const client = getClient();
 const virtualStackTrace = client && data.error && data.error instanceof Error ? data.error.stack : undefined;
 // Remove the first frame from the stack as it's the HttpClient call
 const stack = virtualStackTrace && client ? client.getOptions().stackParser(virtualStackTrace, 0, 1) : undefined;
 const message = `HTTP Client Error with status code: ${data.status}`;

 const event: SentryEvent = {
Expand All@@ -368,6 +379,7 @@ function _createEvent(data: {
 {
 type: 'Error',
 value: message,
 stacktrace: stack ? { frames: stack } : undefined,
 },
 ],
 },
Expand Down

5 changes: 5 additions & 0 deletions
packages/core/src/types-hoist/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,9 @@ export interface HandlerDataXhr {
 xhr: SentryWrappedXMLHttpRequest;
 startTimestamp?: number;
 endTimestamp?: number;
 error?: unknown;
 // This is to be consumed by the HttpClient integration
 virtualError?: unknown;
}

interface SentryFetchData {
Expand All@@ -56,6 +59,8 @@ export interface HandlerDataFetch {
 headers: WebFetchHeaders;
 };
 error?: unknown;
 // This is to be consumed by the HttpClient integration
 virtualError?: unknown;
}

export interface HandlerDataDom {
Expand Down

22 changes: 12 additions & 10 deletions
packages/core/src/utils-hoist/instrument/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,15 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat

 fill(GLOBAL_OBJ, 'fetch', function (originalFetch: () => void): () => void {
 return function (...args: any[]): void {
 // We capture the error right here and not in the Promise error callback because Safari (and probably other
 // browsers too) will wipe the stack trace up to this point, only leaving us with this file which is useless.

 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 const virtualError = new Error();

 const { method, url } = parseFetchArgs(args);
 const handlerData: HandlerDataFetch = {
 args,
Expand All@@ -56,6 +65,8 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 url,
 },
 startTimestamp: timestampInSeconds() * 1000,
 // // Adding the error to be able to fingerprint the failed fetch event in HttpClient instrumentation
 virtualError,
 };

 // if there is no callback, fetch is instrumented directly
Expand All@@ -65,15 +76,6 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 });
 }

 // We capture the stack right here and not in the Promise error callback because Safari (and probably other
 // browsers too) will wipe the stack trace up to this point, only leaving us with this file which is useless.

 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 const virtualStackTrace = new Error().stack;

 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
 return originalFetch.apply(GLOBAL_OBJ, args).then(
 async (response: Response) => {
Expand DownExpand Up@@ -101,7 +103,7 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 error.stack = virtualStackTrace;
 error.stack = virtualError.stack;
 addNonEnumerableProperty(error, 'framesToPop', 1);
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(browser): Attach virtual stack traces to HttpClient events.#14515

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.

 Sign up for GitHub

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

 Merged

lforst
merged 4 commits into

from

Dec 12, 2024
 Merged


feat(browser): Attach virtual stack traces to HttpClient events.
#14515
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
b776eac

feat(browser): Attach virtual stack traces to `HttpClient` events.


onurtemizkan Nov 27, 2024
648693c

Update integration tests


onurtemizkan Nov 27, 2024
33a5bfa

Pass stacktrace string instead of error.


onurtemizkan Nov 28, 2024
a7b89bc

Switch back to passing error


onurtemizkan Nov 29, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/axios/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/fetch/simple/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...ckages/browser-integration-tests/suites/integrations/httpclient/fetch/withRequest/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,15 @@ sentryTest('works with a Request passed in', async ({ getLocalTestUrl, page }) =
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...tegration-tests/suites/integrations/httpclient/fetch/withRequestAndBodyAndOptions/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...wser-integration-tests/suites/integrations/httpclient/fetch/withRequestAndOptions/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,15 @@ sentryTest('works with a Request (without body) & options passed in', async ({ g
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/xhr/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

1 change: 0 additions & 1 deletion
dev-packages/browser-integration-tests/utils/generatePlugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -176,7 +176,6 @@ class SentryScenarioGenerationPlugin {
 }
 : {};

 // Checking if the current scenario has imported `@sentry/integrations`.
 compiler.hooks.normalModuleFactory.tap(this._name, factory => {
 factory.hooks.parser.for('javascript/auto').tap(this._name, parser => {
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
Expand Down

8 changes: 8 additions & 0 deletions
packages/browser-utils/src/instrument/xhr.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,13 @@ export function instrumentXHR(): void {
 // eslint-disable-next-line @typescript-eslint/unbound-method
 xhrproto.open = new Proxy(xhrproto.open, {
 apply(originalOpen, xhrOpenThisArg: XMLHttpRequest & SentryWrappedXMLHttpRequest, xhrOpenArgArray) {
 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your XHR call did not
 // have a stack trace. If you are using HttpClient integration,
 // this is the expected behavior, as we are using this virtual error to capture
 // the location of your XHR call, and group your HttpClient events accordingly.
 const virtualError = new Error();

 const startTimestamp = timestampInSeconds() * 1000;

 // open() should always be called with two or more arguments
Expand DownExpand Up@@ -75,6 +82,7 @@ export function instrumentXHR(): void {
 endTimestamp: timestampInSeconds() * 1000,
 startTimestamp,
 xhr: xhrOpenThisArg,
 virtualError,
 };
 triggerHandlers('xhr', handlerData);
 }
Expand Down

20 changes: 16 additions & 4 deletions
packages/browser/src/integrations/httpclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ function _fetchResponseHandler(
 requestInfo: RequestInfo,
 response: Response,
 requestInit?: RequestInit,
 error?: unknown,
): void {
 if (_shouldCaptureResponse(options, response.status, response.url)) {
 const request = _getRequest(requestInfo, requestInit);
Expand All@@ -89,6 +90,7 @@ function _fetchResponseHandler(
 responseHeaders,
 requestCookies,
 responseCookies,
 error,
 });

 captureEvent(event);
Expand DownExpand Up@@ -127,6 +129,7 @@ function _xhrResponseHandler(
 xhr: XMLHttpRequest,
 method: string,
 headers: Record<string, string>,
 error?: unknown,
): void {
 if (_shouldCaptureResponse(options, xhr.status, xhr.responseURL)) {
 let requestHeaders, responseCookies, responseHeaders;
Expand DownExpand Up@@ -159,6 +162,7 @@ function _xhrResponseHandler(
 // Can't access request cookies from XHR
 responseHeaders,
 responseCookies,
 error,
 });

 captureEvent(event);
Expand DownExpand Up@@ -288,15 +292,15 @@ function _wrapFetch(client: Client, options: HttpClientOptions): void {
 return;
 }

 const { response, args } = handlerData;
 const { response, args, error, virtualError } = handlerData;
 const [requestInfo, requestInit] = args as [RequestInfo, RequestInit | undefined];

 if (!response) {
 return;
 }

 _fetchResponseHandler(options, requestInfo, response as Response, requestInit);
 });
 _fetchResponseHandler(options, requestInfo, response as Response, requestInit, error || virtualError);
 }, false);
}

/**
Expand All@@ -312,6 +316,8 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
 return;
 }

 const { error, virtualError } = handlerData;

 const xhr = handlerData.xhr as SentryWrappedXMLHttpRequest & XMLHttpRequest;

 const sentryXhrData = xhr[SENTRY_XHR_DATA_KEY];
Expand All@@ -323,7 +329,7 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
 const { method, request_headers: headers } = sentryXhrData;

 try {
 _xhrResponseHandler(options, xhr, method, headers);
 _xhrResponseHandler(options, xhr, method, headers, error || virtualError);
 } catch (e) {
 DEBUG_BUILD && logger.warn('Error while extracting response event form XHR response', e);
 }
Expand DownExpand Up@@ -358,7 +364,12 @@ function _createEvent(data: {
 responseCookies?: Record<string, string>;
 requestHeaders?: Record<string, string>;
 requestCookies?: Record<string, string>;
 error?: unknown;
}): SentryEvent {
 const client = getClient();
 const virtualStackTrace = client && data.error && data.error instanceof Error ? data.error.stack : undefined;
 // Remove the first frame from the stack as it's the HttpClient call
 const stack = virtualStackTrace && client ? client.getOptions().stackParser(virtualStackTrace, 0, 1) : undefined;
 const message = `HTTP Client Error with status code: ${data.status}`;

 const event: SentryEvent = {
Expand All@@ -368,6 +379,7 @@ function _createEvent(data: {
 {
 type: 'Error',
 value: message,
 stacktrace: stack ? { frames: stack } : undefined,
 },
 ],
 },
Expand Down

5 changes: 5 additions & 0 deletions
packages/core/src/types-hoist/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,9 @@ export interface HandlerDataXhr {
 xhr: SentryWrappedXMLHttpRequest;
 startTimestamp?: number;
 endTimestamp?: number;
 error?: unknown;
 // This is to be consumed by the HttpClient integration
 virtualError?: unknown;
}

interface SentryFetchData {
Expand All@@ -56,6 +59,8 @@ export interface HandlerDataFetch {
 headers: WebFetchHeaders;
 };
 error?: unknown;
 // This is to be consumed by the HttpClient integration
 virtualError?: unknown;
}

export interface HandlerDataDom {
Expand Down

22 changes: 12 additions & 10 deletions
packages/core/src/utils-hoist/instrument/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,15 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat

 fill(GLOBAL_OBJ, 'fetch', function (originalFetch: () => void): () => void {
 return function (...args: any[]): void {
 // We capture the error right here and not in the Promise error callback because Safari (and probably other
 // browsers too) will wipe the stack trace up to this point, only leaving us with this file which is useless.

 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 const virtualError = new Error();

 const { method, url } = parseFetchArgs(args);
 const handlerData: HandlerDataFetch = {
 args,
Expand All@@ -56,6 +65,8 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 url,
 },
 startTimestamp: timestampInSeconds() * 1000,
 // // Adding the error to be able to fingerprint the failed fetch event in HttpClient instrumentation
 virtualError,
 };

 // if there is no callback, fetch is instrumented directly
Expand All@@ -65,15 +76,6 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 });
 }

 // We capture the stack right here and not in the Promise error callback because Safari (and probably other
 // browsers too) will wipe the stack trace up to this point, only leaving us with this file which is useless.

 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 const virtualStackTrace = new Error().stack;

 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
 return originalFetch.apply(GLOBAL_OBJ, args).then(
 async (response: Response) => {
Expand DownExpand Up@@ -101,7 +103,7 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 error.stack = virtualStackTrace;
 error.stack = virtualError.stack;
 addNonEnumerableProperty(error, 'framesToPop', 1);
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(browser): Attach virtual stack traces to HttpClient events.#14515

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.

 Sign up for GitHub

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

 Merged

lforst
merged 4 commits into

from

Dec 12, 2024
 Merged


feat(browser): Attach virtual stack traces to HttpClient events.
#14515
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
b776eac

feat(browser): Attach virtual stack traces to `HttpClient` events.


onurtemizkan Nov 27, 2024
648693c

Update integration tests


onurtemizkan Nov 27, 2024
33a5bfa

Pass stacktrace string instead of error.


onurtemizkan Nov 28, 2024
a7b89bc

Switch back to passing error


onurtemizkan Nov 29, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/axios/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/fetch/simple/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...ckages/browser-integration-tests/suites/integrations/httpclient/fetch/withRequest/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,15 @@ sentryTest('works with a Request passed in', async ({ getLocalTestUrl, page }) =
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...tegration-tests/suites/integrations/httpclient/fetch/withRequestAndBodyAndOptions/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...wser-integration-tests/suites/integrations/httpclient/fetch/withRequestAndOptions/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,15 @@ sentryTest('works with a Request (without body) & options passed in', async ({ g
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/xhr/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

1 change: 0 additions & 1 deletion
dev-packages/browser-integration-tests/utils/generatePlugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -176,7 +176,6 @@ class SentryScenarioGenerationPlugin {
 }
 : {};

 // Checking if the current scenario has imported `@sentry/integrations`.
 compiler.hooks.normalModuleFactory.tap(this._name, factory => {
 factory.hooks.parser.for('javascript/auto').tap(this._name, parser => {
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
Expand Down

8 changes: 8 additions & 0 deletions
packages/browser-utils/src/instrument/xhr.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,13 @@ export function instrumentXHR(): void {
 // eslint-disable-next-line @typescript-eslint/unbound-method
 xhrproto.open = new Proxy(xhrproto.open, {
 apply(originalOpen, xhrOpenThisArg: XMLHttpRequest & SentryWrappedXMLHttpRequest, xhrOpenArgArray) {
 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your XHR call did not
 // have a stack trace. If you are using HttpClient integration,
 // this is the expected behavior, as we are using this virtual error to capture
 // the location of your XHR call, and group your HttpClient events accordingly.
 const virtualError = new Error();

 const startTimestamp = timestampInSeconds() * 1000;

 // open() should always be called with two or more arguments
Expand DownExpand Up@@ -75,6 +82,7 @@ export function instrumentXHR(): void {
 endTimestamp: timestampInSeconds() * 1000,
 startTimestamp,
 xhr: xhrOpenThisArg,
 virtualError,
 };
 triggerHandlers('xhr', handlerData);
 }
Expand Down

20 changes: 16 additions & 4 deletions
packages/browser/src/integrations/httpclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ function _fetchResponseHandler(
 requestInfo: RequestInfo,
 response: Response,
 requestInit?: RequestInit,
 error?: unknown,
): void {
 if (_shouldCaptureResponse(options, response.status, response.url)) {
 const request = _getRequest(requestInfo, requestInit);
Expand All@@ -89,6 +90,7 @@ function _fetchResponseHandler(
 responseHeaders,
 requestCookies,
 responseCookies,
 error,
 });

 captureEvent(event);
Expand DownExpand Up@@ -127,6 +129,7 @@ function _xhrResponseHandler(
 xhr: XMLHttpRequest,
 method: string,
 headers: Record<string, string>,
 error?: unknown,
): void {
 if (_shouldCaptureResponse(options, xhr.status, xhr.responseURL)) {
 let requestHeaders, responseCookies, responseHeaders;
Expand DownExpand Up@@ -159,6 +162,7 @@ function _xhrResponseHandler(
 // Can't access request cookies from XHR
 responseHeaders,
 responseCookies,
 error,
 });

 captureEvent(event);
Expand DownExpand Up@@ -288,15 +292,15 @@ function _wrapFetch(client: Client, options: HttpClientOptions): void {
 return;
 }

 const { response, args } = handlerData;
 const { response, args, error, virtualError } = handlerData;
 const [requestInfo, requestInit] = args as [RequestInfo, RequestInit | undefined];

 if (!response) {
 return;
 }

 _fetchResponseHandler(options, requestInfo, response as Response, requestInit);
 });
 _fetchResponseHandler(options, requestInfo, response as Response, requestInit, error || virtualError);
 }, false);
}

/**
Expand All@@ -312,6 +316,8 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
 return;
 }

 const { error, virtualError } = handlerData;

 const xhr = handlerData.xhr as SentryWrappedXMLHttpRequest & XMLHttpRequest;

 const sentryXhrData = xhr[SENTRY_XHR_DATA_KEY];
Expand All@@ -323,7 +329,7 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
 const { method, request_headers: headers } = sentryXhrData;

 try {
 _xhrResponseHandler(options, xhr, method, headers);
 _xhrResponseHandler(options, xhr, method, headers, error || virtualError);
 } catch (e) {
 DEBUG_BUILD && logger.warn('Error while extracting response event form XHR response', e);
 }
Expand DownExpand Up@@ -358,7 +364,12 @@ function _createEvent(data: {
 responseCookies?: Record<string, string>;
 requestHeaders?: Record<string, string>;
 requestCookies?: Record<string, string>;
 error?: unknown;
}): SentryEvent {
 const client = getClient();
 const virtualStackTrace = client && data.error && data.error instanceof Error ? data.error.stack : undefined;
 // Remove the first frame from the stack as it's the HttpClient call
 const stack = virtualStackTrace && client ? client.getOptions().stackParser(virtualStackTrace, 0, 1) : undefined;
 const message = `HTTP Client Error with status code: ${data.status}`;

 const event: SentryEvent = {
Expand All@@ -368,6 +379,7 @@ function _createEvent(data: {
 {
 type: 'Error',
 value: message,
 stacktrace: stack ? { frames: stack } : undefined,
 },
 ],
 },
Expand Down

5 changes: 5 additions & 0 deletions
packages/core/src/types-hoist/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,9 @@ export interface HandlerDataXhr {
 xhr: SentryWrappedXMLHttpRequest;
 startTimestamp?: number;
 endTimestamp?: number;
 error?: unknown;
 // This is to be consumed by the HttpClient integration
 virtualError?: unknown;
}

interface SentryFetchData {
Expand All@@ -56,6 +59,8 @@ export interface HandlerDataFetch {
 headers: WebFetchHeaders;
 };
 error?: unknown;
 // This is to be consumed by the HttpClient integration
 virtualError?: unknown;
}

export interface HandlerDataDom {
Expand Down

22 changes: 12 additions & 10 deletions
packages/core/src/utils-hoist/instrument/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,15 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat

 fill(GLOBAL_OBJ, 'fetch', function (originalFetch: () => void): () => void {
 return function (...args: any[]): void {
 // We capture the error right here and not in the Promise error callback because Safari (and probably other
 // browsers too) will wipe the stack trace up to this point, only leaving us with this file which is useless.

 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 const virtualError = new Error();

 const { method, url } = parseFetchArgs(args);
 const handlerData: HandlerDataFetch = {
 args,
Expand All@@ -56,6 +65,8 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 url,
 },
 startTimestamp: timestampInSeconds() * 1000,
 // // Adding the error to be able to fingerprint the failed fetch event in HttpClient instrumentation
 virtualError,
 };

 // if there is no callback, fetch is instrumented directly
Expand All@@ -65,15 +76,6 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 });
 }

 // We capture the stack right here and not in the Promise error callback because Safari (and probably other
 // browsers too) will wipe the stack trace up to this point, only leaving us with this file which is useless.

 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 const virtualStackTrace = new Error().stack;

 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
 return originalFetch.apply(GLOBAL_OBJ, args).then(
 async (response: Response) => {
Expand DownExpand Up@@ -101,7 +103,7 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 error.stack = virtualStackTrace;
 error.stack = virtualError.stack;
 addNonEnumerableProperty(error, 'framesToPop', 1);
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(browser): Attach virtual stack traces to HttpClient events.#14515

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.

 Sign up for GitHub

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

 Merged

lforst
merged 4 commits into

from

Dec 12, 2024
 Merged


feat(browser): Attach virtual stack traces to HttpClient events.
#14515
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
b776eac

feat(browser): Attach virtual stack traces to `HttpClient` events.


onurtemizkan Nov 27, 2024
648693c

Update integration tests


onurtemizkan Nov 27, 2024
33a5bfa

Pass stacktrace string instead of error.


onurtemizkan Nov 28, 2024
a7b89bc

Switch back to passing error


onurtemizkan Nov 29, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/axios/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/fetch/simple/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...ckages/browser-integration-tests/suites/integrations/httpclient/fetch/withRequest/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,15 @@ sentryTest('works with a Request passed in', async ({ getLocalTestUrl, page }) =
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...tegration-tests/suites/integrations/httpclient/fetch/withRequestAndBodyAndOptions/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...wser-integration-tests/suites/integrations/httpclient/fetch/withRequestAndOptions/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,15 @@ sentryTest('works with a Request (without body) & options passed in', async ({ g
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/xhr/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

1 change: 0 additions & 1 deletion
dev-packages/browser-integration-tests/utils/generatePlugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -176,7 +176,6 @@ class SentryScenarioGenerationPlugin {
 }
 : {};

 // Checking if the current scenario has imported `@sentry/integrations`.
 compiler.hooks.normalModuleFactory.tap(this._name, factory => {
 factory.hooks.parser.for('javascript/auto').tap(this._name, parser => {
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
Expand Down

8 changes: 8 additions & 0 deletions
packages/browser-utils/src/instrument/xhr.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,13 @@ export function instrumentXHR(): void {
 // eslint-disable-next-line @typescript-eslint/unbound-method
 xhrproto.open = new Proxy(xhrproto.open, {
 apply(originalOpen, xhrOpenThisArg: XMLHttpRequest & SentryWrappedXMLHttpRequest, xhrOpenArgArray) {
 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your XHR call did not
 // have a stack trace. If you are using HttpClient integration,
 // this is the expected behavior, as we are using this virtual error to capture
 // the location of your XHR call, and group your HttpClient events accordingly.
 const virtualError = new Error();

 const startTimestamp = timestampInSeconds() * 1000;

 // open() should always be called with two or more arguments
Expand DownExpand Up@@ -75,6 +82,7 @@ export function instrumentXHR(): void {
 endTimestamp: timestampInSeconds() * 1000,
 startTimestamp,
 xhr: xhrOpenThisArg,
 virtualError,
 };
 triggerHandlers('xhr', handlerData);
 }
Expand Down

20 changes: 16 additions & 4 deletions
packages/browser/src/integrations/httpclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ function _fetchResponseHandler(
 requestInfo: RequestInfo,
 response: Response,
 requestInit?: RequestInit,
 error?: unknown,
): void {
 if (_shouldCaptureResponse(options, response.status, response.url)) {
 const request = _getRequest(requestInfo, requestInit);
Expand All@@ -89,6 +90,7 @@ function _fetchResponseHandler(
 responseHeaders,
 requestCookies,
 responseCookies,
 error,
 });

 captureEvent(event);
Expand DownExpand Up@@ -127,6 +129,7 @@ function _xhrResponseHandler(
 xhr: XMLHttpRequest,
 method: string,
 headers: Record<string, string>,
 error?: unknown,
): void {
 if (_shouldCaptureResponse(options, xhr.status, xhr.responseURL)) {
 let requestHeaders, responseCookies, responseHeaders;
Expand DownExpand Up@@ -159,6 +162,7 @@ function _xhrResponseHandler(
 // Can't access request cookies from XHR
 responseHeaders,
 responseCookies,
 error,
 });

 captureEvent(event);
Expand DownExpand Up@@ -288,15 +292,15 @@ function _wrapFetch(client: Client, options: HttpClientOptions): void {
 return;
 }

 const { response, args } = handlerData;
 const { response, args, error, virtualError } = handlerData;
 const [requestInfo, requestInit] = args as [RequestInfo, RequestInit | undefined];

 if (!response) {
 return;
 }

 _fetchResponseHandler(options, requestInfo, response as Response, requestInit);
 });
 _fetchResponseHandler(options, requestInfo, response as Response, requestInit, error || virtualError);
 }, false);
}

/**
Expand All@@ -312,6 +316,8 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
 return;
 }

 const { error, virtualError } = handlerData;

 const xhr = handlerData.xhr as SentryWrappedXMLHttpRequest & XMLHttpRequest;

 const sentryXhrData = xhr[SENTRY_XHR_DATA_KEY];
Expand All@@ -323,7 +329,7 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
 const { method, request_headers: headers } = sentryXhrData;

 try {
 _xhrResponseHandler(options, xhr, method, headers);
 _xhrResponseHandler(options, xhr, method, headers, error || virtualError);
 } catch (e) {
 DEBUG_BUILD && logger.warn('Error while extracting response event form XHR response', e);
 }
Expand DownExpand Up@@ -358,7 +364,12 @@ function _createEvent(data: {
 responseCookies?: Record<string, string>;
 requestHeaders?: Record<string, string>;
 requestCookies?: Record<string, string>;
 error?: unknown;
}): SentryEvent {
 const client = getClient();
 const virtualStackTrace = client && data.error && data.error instanceof Error ? data.error.stack : undefined;
 // Remove the first frame from the stack as it's the HttpClient call
 const stack = virtualStackTrace && client ? client.getOptions().stackParser(virtualStackTrace, 0, 1) : undefined;
 const message = `HTTP Client Error with status code: ${data.status}`;

 const event: SentryEvent = {
Expand All@@ -368,6 +379,7 @@ function _createEvent(data: {
 {
 type: 'Error',
 value: message,
 stacktrace: stack ? { frames: stack } : undefined,
 },
 ],
 },
Expand Down

5 changes: 5 additions & 0 deletions
packages/core/src/types-hoist/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,9 @@ export interface HandlerDataXhr {
 xhr: SentryWrappedXMLHttpRequest;
 startTimestamp?: number;
 endTimestamp?: number;
 error?: unknown;
 // This is to be consumed by the HttpClient integration
 virtualError?: unknown;
}

interface SentryFetchData {
Expand All@@ -56,6 +59,8 @@ export interface HandlerDataFetch {
 headers: WebFetchHeaders;
 };
 error?: unknown;
 // This is to be consumed by the HttpClient integration
 virtualError?: unknown;
}

export interface HandlerDataDom {
Expand Down

22 changes: 12 additions & 10 deletions
packages/core/src/utils-hoist/instrument/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,15 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat

 fill(GLOBAL_OBJ, 'fetch', function (originalFetch: () => void): () => void {
 return function (...args: any[]): void {
 // We capture the error right here and not in the Promise error callback because Safari (and probably other
 // browsers too) will wipe the stack trace up to this point, only leaving us with this file which is useless.

 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 const virtualError = new Error();

 const { method, url } = parseFetchArgs(args);
 const handlerData: HandlerDataFetch = {
 args,
Expand All@@ -56,6 +65,8 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 url,
 },
 startTimestamp: timestampInSeconds() * 1000,
 // // Adding the error to be able to fingerprint the failed fetch event in HttpClient instrumentation
 virtualError,
 };

 // if there is no callback, fetch is instrumented directly
Expand All@@ -65,15 +76,6 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 });
 }

 // We capture the stack right here and not in the Promise error callback because Safari (and probably other
 // browsers too) will wipe the stack trace up to this point, only leaving us with this file which is useless.

 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 const virtualStackTrace = new Error().stack;

 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
 return originalFetch.apply(GLOBAL_OBJ, args).then(
 async (response: Response) => {
Expand DownExpand Up@@ -101,7 +103,7 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 error.stack = virtualStackTrace;
 error.stack = virtualError.stack;
 addNonEnumerableProperty(error, 'framesToPop', 1);
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(browser): Attach virtual stack traces to HttpClient events.#14515

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.

 Sign up for GitHub

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

 Merged

lforst
merged 4 commits into

from

Dec 12, 2024
 Merged


feat(browser): Attach virtual stack traces to HttpClient events.
#14515
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
b776eac

feat(browser): Attach virtual stack traces to `HttpClient` events.


onurtemizkan Nov 27, 2024
648693c

Update integration tests


onurtemizkan Nov 27, 2024
33a5bfa

Pass stacktrace string instead of error.


onurtemizkan Nov 28, 2024
a7b89bc

Switch back to passing error


onurtemizkan Nov 29, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/axios/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/fetch/simple/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...ckages/browser-integration-tests/suites/integrations/httpclient/fetch/withRequest/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,15 @@ sentryTest('works with a Request passed in', async ({ getLocalTestUrl, page }) =
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...tegration-tests/suites/integrations/httpclient/fetch/withRequestAndBodyAndOptions/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...wser-integration-tests/suites/integrations/httpclient/fetch/withRequestAndOptions/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,15 @@ sentryTest('works with a Request (without body) & options passed in', async ({ g
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/xhr/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

1 change: 0 additions & 1 deletion
dev-packages/browser-integration-tests/utils/generatePlugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -176,7 +176,6 @@ class SentryScenarioGenerationPlugin {
 }
 : {};

 // Checking if the current scenario has imported `@sentry/integrations`.
 compiler.hooks.normalModuleFactory.tap(this._name, factory => {
 factory.hooks.parser.for('javascript/auto').tap(this._name, parser => {
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
Expand Down

8 changes: 8 additions & 0 deletions
packages/browser-utils/src/instrument/xhr.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,13 @@ export function instrumentXHR(): void {
 // eslint-disable-next-line @typescript-eslint/unbound-method
 xhrproto.open = new Proxy(xhrproto.open, {
 apply(originalOpen, xhrOpenThisArg: XMLHttpRequest & SentryWrappedXMLHttpRequest, xhrOpenArgArray) {
 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your XHR call did not
 // have a stack trace. If you are using HttpClient integration,
 // this is the expected behavior, as we are using this virtual error to capture
 // the location of your XHR call, and group your HttpClient events accordingly.
 const virtualError = new Error();

 const startTimestamp = timestampInSeconds() * 1000;

 // open() should always be called with two or more arguments
Expand DownExpand Up@@ -75,6 +82,7 @@ export function instrumentXHR(): void {
 endTimestamp: timestampInSeconds() * 1000,
 startTimestamp,
 xhr: xhrOpenThisArg,
 virtualError,
 };
 triggerHandlers('xhr', handlerData);
 }
Expand Down

20 changes: 16 additions & 4 deletions
packages/browser/src/integrations/httpclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ function _fetchResponseHandler(
 requestInfo: RequestInfo,
 response: Response,
 requestInit?: RequestInit,
 error?: unknown,
): void {
 if (_shouldCaptureResponse(options, response.status, response.url)) {
 const request = _getRequest(requestInfo, requestInit);
Expand All@@ -89,6 +90,7 @@ function _fetchResponseHandler(
 responseHeaders,
 requestCookies,
 responseCookies,
 error,
 });

 captureEvent(event);
Expand DownExpand Up@@ -127,6 +129,7 @@ function _xhrResponseHandler(
 xhr: XMLHttpRequest,
 method: string,
 headers: Record<string, string>,
 error?: unknown,
): void {
 if (_shouldCaptureResponse(options, xhr.status, xhr.responseURL)) {
 let requestHeaders, responseCookies, responseHeaders;
Expand DownExpand Up@@ -159,6 +162,7 @@ function _xhrResponseHandler(
 // Can't access request cookies from XHR
 responseHeaders,
 responseCookies,
 error,
 });

 captureEvent(event);
Expand DownExpand Up@@ -288,15 +292,15 @@ function _wrapFetch(client: Client, options: HttpClientOptions): void {
 return;
 }

 const { response, args } = handlerData;
 const { response, args, error, virtualError } = handlerData;
 const [requestInfo, requestInit] = args as [RequestInfo, RequestInit | undefined];

 if (!response) {
 return;
 }

 _fetchResponseHandler(options, requestInfo, response as Response, requestInit);
 });
 _fetchResponseHandler(options, requestInfo, response as Response, requestInit, error || virtualError);
 }, false);
}

/**
Expand All@@ -312,6 +316,8 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
 return;
 }

 const { error, virtualError } = handlerData;

 const xhr = handlerData.xhr as SentryWrappedXMLHttpRequest & XMLHttpRequest;

 const sentryXhrData = xhr[SENTRY_XHR_DATA_KEY];
Expand All@@ -323,7 +329,7 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
 const { method, request_headers: headers } = sentryXhrData;

 try {
 _xhrResponseHandler(options, xhr, method, headers);
 _xhrResponseHandler(options, xhr, method, headers, error || virtualError);
 } catch (e) {
 DEBUG_BUILD && logger.warn('Error while extracting response event form XHR response', e);
 }
Expand DownExpand Up@@ -358,7 +364,12 @@ function _createEvent(data: {
 responseCookies?: Record<string, string>;
 requestHeaders?: Record<string, string>;
 requestCookies?: Record<string, string>;
 error?: unknown;
}): SentryEvent {
 const client = getClient();
 const virtualStackTrace = client && data.error && data.error instanceof Error ? data.error.stack : undefined;
 // Remove the first frame from the stack as it's the HttpClient call
 const stack = virtualStackTrace && client ? client.getOptions().stackParser(virtualStackTrace, 0, 1) : undefined;
 const message = `HTTP Client Error with status code: ${data.status}`;

 const event: SentryEvent = {
Expand All@@ -368,6 +379,7 @@ function _createEvent(data: {
 {
 type: 'Error',
 value: message,
 stacktrace: stack ? { frames: stack } : undefined,
 },
 ],
 },
Expand Down

5 changes: 5 additions & 0 deletions
packages/core/src/types-hoist/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,9 @@ export interface HandlerDataXhr {
 xhr: SentryWrappedXMLHttpRequest;
 startTimestamp?: number;
 endTimestamp?: number;
 error?: unknown;
 // This is to be consumed by the HttpClient integration
 virtualError?: unknown;
}

interface SentryFetchData {
Expand All@@ -56,6 +59,8 @@ export interface HandlerDataFetch {
 headers: WebFetchHeaders;
 };
 error?: unknown;
 // This is to be consumed by the HttpClient integration
 virtualError?: unknown;
}

export interface HandlerDataDom {
Expand Down

22 changes: 12 additions & 10 deletions
packages/core/src/utils-hoist/instrument/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,15 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat

 fill(GLOBAL_OBJ, 'fetch', function (originalFetch: () => void): () => void {
 return function (...args: any[]): void {
 // We capture the error right here and not in the Promise error callback because Safari (and probably other
 // browsers too) will wipe the stack trace up to this point, only leaving us with this file which is useless.

 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 const virtualError = new Error();

 const { method, url } = parseFetchArgs(args);
 const handlerData: HandlerDataFetch = {
 args,
Expand All@@ -56,6 +65,8 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 url,
 },
 startTimestamp: timestampInSeconds() * 1000,
 // // Adding the error to be able to fingerprint the failed fetch event in HttpClient instrumentation
 virtualError,
 };

 // if there is no callback, fetch is instrumented directly
Expand All@@ -65,15 +76,6 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 });
 }

 // We capture the stack right here and not in the Promise error callback because Safari (and probably other
 // browsers too) will wipe the stack trace up to this point, only leaving us with this file which is useless.

 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 const virtualStackTrace = new Error().stack;

 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
 return originalFetch.apply(GLOBAL_OBJ, args).then(
 async (response: Response) => {
Expand DownExpand Up@@ -101,7 +103,7 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 error.stack = virtualStackTrace;
 error.stack = virtualError.stack;
 addNonEnumerableProperty(error, 'framesToPop', 1);
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(browser): Attach virtual stack traces to HttpClient events.#14515

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.

 Sign up for GitHub

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

 Merged

lforst
merged 4 commits into

from

Dec 12, 2024
 Merged


feat(browser): Attach virtual stack traces to HttpClient events.
#14515
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
b776eac

feat(browser): Attach virtual stack traces to `HttpClient` events.


onurtemizkan Nov 27, 2024
648693c

Update integration tests


onurtemizkan Nov 27, 2024
33a5bfa

Pass stacktrace string instead of error.


onurtemizkan Nov 28, 2024
a7b89bc

Switch back to passing error


onurtemizkan Nov 29, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/axios/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/fetch/simple/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...ckages/browser-integration-tests/suites/integrations/httpclient/fetch/withRequest/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,15 @@ sentryTest('works with a Request passed in', async ({ getLocalTestUrl, page }) =
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...tegration-tests/suites/integrations/httpclient/fetch/withRequestAndBodyAndOptions/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
...wser-integration-tests/suites/integrations/httpclient/fetch/withRequestAndOptions/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,15 @@ sentryTest('works with a Request (without body) & options passed in', async ({ g
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/httpclient/xhr/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,15 @@ sentryTest(
 type: 'http.client',
 handled: false,
 },
 stacktrace: {
 frames: expect.arrayContaining([
 expect.objectContaining({
 filename: 'http://sentry-test.io/subject.bundle.js',
 function: '?',
 in_app: true,
 }),
 ]),
 },
 },
 ],
 },
Expand Down

1 change: 0 additions & 1 deletion
dev-packages/browser-integration-tests/utils/generatePlugin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -176,7 +176,6 @@ class SentryScenarioGenerationPlugin {
 }
 : {};

 // Checking if the current scenario has imported `@sentry/integrations`.
 compiler.hooks.normalModuleFactory.tap(this._name, factory => {
 factory.hooks.parser.for('javascript/auto').tap(this._name, parser => {
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
Expand Down

8 changes: 8 additions & 0 deletions
packages/browser-utils/src/instrument/xhr.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,13 @@ export function instrumentXHR(): void {
 // eslint-disable-next-line @typescript-eslint/unbound-method
 xhrproto.open = new Proxy(xhrproto.open, {
 apply(originalOpen, xhrOpenThisArg: XMLHttpRequest & SentryWrappedXMLHttpRequest, xhrOpenArgArray) {
 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your XHR call did not
 // have a stack trace. If you are using HttpClient integration,
 // this is the expected behavior, as we are using this virtual error to capture
 // the location of your XHR call, and group your HttpClient events accordingly.
 const virtualError = new Error();

 const startTimestamp = timestampInSeconds() * 1000;

 // open() should always be called with two or more arguments
Expand DownExpand Up@@ -75,6 +82,7 @@ export function instrumentXHR(): void {
 endTimestamp: timestampInSeconds() * 1000,
 startTimestamp,
 xhr: xhrOpenThisArg,
 virtualError,
 };
 triggerHandlers('xhr', handlerData);
 }
Expand Down

20 changes: 16 additions & 4 deletions
packages/browser/src/integrations/httpclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ function _fetchResponseHandler(
 requestInfo: RequestInfo,
 response: Response,
 requestInit?: RequestInit,
 error?: unknown,
): void {
 if (_shouldCaptureResponse(options, response.status, response.url)) {
 const request = _getRequest(requestInfo, requestInit);
Expand All@@ -89,6 +90,7 @@ function _fetchResponseHandler(
 responseHeaders,
 requestCookies,
 responseCookies,
 error,
 });

 captureEvent(event);
Expand DownExpand Up@@ -127,6 +129,7 @@ function _xhrResponseHandler(
 xhr: XMLHttpRequest,
 method: string,
 headers: Record<string, string>,
 error?: unknown,
): void {
 if (_shouldCaptureResponse(options, xhr.status, xhr.responseURL)) {
 let requestHeaders, responseCookies, responseHeaders;
Expand DownExpand Up@@ -159,6 +162,7 @@ function _xhrResponseHandler(
 // Can't access request cookies from XHR
 responseHeaders,
 responseCookies,
 error,
 });

 captureEvent(event);
Expand DownExpand Up@@ -288,15 +292,15 @@ function _wrapFetch(client: Client, options: HttpClientOptions): void {
 return;
 }

 const { response, args } = handlerData;
 const { response, args, error, virtualError } = handlerData;
 const [requestInfo, requestInit] = args as [RequestInfo, RequestInit | undefined];

 if (!response) {
 return;
 }

 _fetchResponseHandler(options, requestInfo, response as Response, requestInit);
 });
 _fetchResponseHandler(options, requestInfo, response as Response, requestInit, error || virtualError);
 }, false);
}

/**
Expand All@@ -312,6 +316,8 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
 return;
 }

 const { error, virtualError } = handlerData;

 const xhr = handlerData.xhr as SentryWrappedXMLHttpRequest & XMLHttpRequest;

 const sentryXhrData = xhr[SENTRY_XHR_DATA_KEY];
Expand All@@ -323,7 +329,7 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
 const { method, request_headers: headers } = sentryXhrData;

 try {
 _xhrResponseHandler(options, xhr, method, headers);
 _xhrResponseHandler(options, xhr, method, headers, error || virtualError);
 } catch (e) {
 DEBUG_BUILD && logger.warn('Error while extracting response event form XHR response', e);
 }
Expand DownExpand Up@@ -358,7 +364,12 @@ function _createEvent(data: {
 responseCookies?: Record<string, string>;
 requestHeaders?: Record<string, string>;
 requestCookies?: Record<string, string>;
 error?: unknown;
}): SentryEvent {
 const client = getClient();
 const virtualStackTrace = client && data.error && data.error instanceof Error ? data.error.stack : undefined;
 // Remove the first frame from the stack as it's the HttpClient call
 const stack = virtualStackTrace && client ? client.getOptions().stackParser(virtualStackTrace, 0, 1) : undefined;
 const message = `HTTP Client Error with status code: ${data.status}`;

 const event: SentryEvent = {
Expand All@@ -368,6 +379,7 @@ function _createEvent(data: {
 {
 type: 'Error',
 value: message,
 stacktrace: stack ? { frames: stack } : undefined,
 },
 ],
 },
Expand Down

5 changes: 5 additions & 0 deletions
packages/core/src/types-hoist/instrument.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,9 @@ export interface HandlerDataXhr {
 xhr: SentryWrappedXMLHttpRequest;
 startTimestamp?: number;
 endTimestamp?: number;
 error?: unknown;
 // This is to be consumed by the HttpClient integration
 virtualError?: unknown;
}

interface SentryFetchData {
Expand All@@ -56,6 +59,8 @@ export interface HandlerDataFetch {
 headers: WebFetchHeaders;
 };
 error?: unknown;
 // This is to be consumed by the HttpClient integration
 virtualError?: unknown;
}

export interface HandlerDataDom {
Expand Down

22 changes: 12 additions & 10 deletions
packages/core/src/utils-hoist/instrument/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,15 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat

 fill(GLOBAL_OBJ, 'fetch', function (originalFetch: () => void): () => void {
 return function (...args: any[]): void {
 // We capture the error right here and not in the Promise error callback because Safari (and probably other
 // browsers too) will wipe the stack trace up to this point, only leaving us with this file which is useless.

 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 const virtualError = new Error();

 const { method, url } = parseFetchArgs(args);
 const handlerData: HandlerDataFetch = {
 args,
Expand All@@ -56,6 +65,8 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 url,
 },
 startTimestamp: timestampInSeconds() * 1000,
 // // Adding the error to be able to fingerprint the failed fetch event in HttpClient instrumentation
 virtualError,
 };

 // if there is no callback, fetch is instrumented directly
Expand All@@ -65,15 +76,6 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 });
 }

 // We capture the stack right here and not in the Promise error callback because Safari (and probably other
 // browsers too) will wipe the stack trace up to this point, only leaving us with this file which is useless.

 // NOTE: If you are a Sentry user, and you are seeing this stack frame,
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 const virtualStackTrace = new Error().stack;

 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
 return originalFetch.apply(GLOBAL_OBJ, args).then(
 async (response: Response) => {
Expand DownExpand Up@@ -101,7 +103,7 @@ function instrumentFetch(onFetchResolved?: (response: Response) => void, skipNat
 // it means the error, that was caused by your fetch call did not
 // have a stack trace, so the SDK backfilled the stack trace so
 // you can see which fetch call failed.
 error.stack = virtualStackTrace;
 error.stack = virtualError.stack;
 addNonEnumerableProperty(error, 'framesToPop', 1);
 }

Expand Down