Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 6 additions & 23 deletions packages/node/src/integrations/local-variables/common.ts
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
import type { Debugger } from 'node:inspector';
import type { StackFrame, StackParser } from '@sentry/types';

export type Variables = Record<string, unknown>;

export type RateLimitIncrement = () => void;

/**
* The key used to store the local variables on the error object.
*/
export const LOCAL_VARIABLES_KEY = '__SENTRY_ERROR_LOCAL_VARIABLES__';

/**
* Creates a rate limiter that will call the disable callback when the rate limit is reached and the enable callback
* when a timeout has occurred.
Expand DownExpand Up@@ -55,6 +59,7 @@ export type PausedExceptionEvent = Debugger.PausedEventDataType & {
data: {
// This contains error.stack
description: string;
objectId?: string;
};
};

Expand All@@ -68,28 +73,6 @@ export function functionNamesMatch(a: string | undefined, b: string | undefined)
return a === b || (isAnonymous(a) && isAnonymous(b));
}

/** Creates a unique hash from stack frames */
export function hashFrames(frames: StackFrame[] | undefined): string | undefined {
if (frames === undefined) {
return;
}

// Only hash the 10 most recent frames (ie. the last 10)
return frames.slice(-10).reduce((acc, frame) => `${acc},${frame.function},${frame.lineno},${frame.colno}`, '');
}

/**
* We use the stack parser to create a unique hash from the exception stack trace
* This is used to lookup vars when the exception passes through the event processor
*/
export function hashFromStack(stackParser: StackParser, stack: string | undefined): string | undefined {
if (stack === undefined) {
return undefined;
}

return hashFrames(stackParser(stack, 1));
}

export interface FrameVariables {
function: string;
vars?: Variables;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,14 @@ declare module 'node:inspector/promises' {
method: 'Runtime.getProperties',
params: Runtime.GetPropertiesParameterType,
): Promise<Runtime.GetPropertiesReturnType>;
public post(
method: 'Runtime.callFunctionOn',
params: Runtime.CallFunctionOnParameterType,
): Promise<Runtime.CallFunctionOnReturnType>;
public post(
method: 'Runtime.releaseObject',
params: Runtime.ReleaseObjectParameterType,
): Promise<Runtime.ReleaseObjectReturnType>;

public on(
event: 'Debugger.paused',
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
import { Worker } from 'node:worker_threads';
import { defineIntegration } from '@sentry/core';
import type { Event, Exception, IntegrationFn } from '@sentry/types';
import { LRUMap, logger } from '@sentry/utils';
import type { Event, EventHint, Exception, IntegrationFn } from '@sentry/types';
import { logger } from '@sentry/utils';

import type { NodeClient } from '../../sdk/client';
import type { FrameVariables, LocalVariablesIntegrationOptions, LocalVariablesWorkerArgs } from './common';
import { functionNamesMatch, hashFrames } from './common';
import { LOCAL_VARIABLES_KEY } from './common';
import { functionNamesMatch } from './common';

// This string is a placeholder that gets overwritten with the worker code.
export const base64WorkerScript = '###LocalVariablesWorkerScript###';
Expand All@@ -20,23 +21,7 @@ function log(...args: unknown[]): void {
export const localVariablesAsyncIntegration = defineIntegration(((
integrationOptions: LocalVariablesIntegrationOptions = {},
) => {
const cachedFrames: LRUMap<string, FrameVariables[]> = new LRUMap(20);

function addLocalVariablesToException(exception: Exception): void {
const hash = hashFrames(exception?.stacktrace?.frames);

if (hash === undefined) {
return;
}

// Check if we have local variables for an exception that matches the hash
// remove is identical to get but also removes the entry from the cache
const cachedFrame = cachedFrames.remove(hash);

if (cachedFrame === undefined) {
return;
}

function addLocalVariablesToException(exception: Exception, localVariables: FrameVariables[]): void {
// Filter out frames where the function name is `new Promise` since these are in the error.stack frames
// but do not appear in the debugger call frames
const frames = (exception.stacktrace?.frames || []).filter(frame => frame.function !== 'new Promise');
Expand All@@ -45,32 +30,41 @@ export const localVariablesAsyncIntegration = defineIntegration(((
// Sentry frames are in reverse order
const frameIndex = frames.length - i - 1;

const cachedFrameVariable = cachedFrame[i];
const frameVariable = frames[frameIndex];
const frameLocalVariables = localVariables[i];
const frame = frames[frameIndex];

if (!frameVariable || !cachedFrameVariable) {
if (!frame || !frameLocalVariables) {
// Drop out if we run out of frames to match up
break;
}

if (
// We need to have vars to add
cachedFrameVariable.vars === undefined ||
frameLocalVariables.vars === undefined ||
// We're not interested in frames that are not in_app because the vars are not relevant
frameVariable.in_app === false ||
frame.in_app === false ||
// The function names need to match
!functionNamesMatch(frameVariable.function, cachedFrameVariable.function)
!functionNamesMatch(frame.function, frameLocalVariables.function)
) {
continue;
}

frameVariable.vars = cachedFrameVariable.vars;
frame.vars = frameLocalVariables.vars;
}
}

function addLocalVariablesToEvent(event: Event): Event {
for (const exception of event.exception?.values || []) {
addLocalVariablesToException(exception);
function addLocalVariablesToEvent(event: Event, hint: EventHint): Event {
if (
hint.originalException &&
typeof hint.originalException === 'object' &&
LOCAL_VARIABLES_KEY in hint.originalException &&
Array.isArray(hint.originalException[LOCAL_VARIABLES_KEY])
) {
for (const exception of event.exception?.values || []) {
addLocalVariablesToException(exception, hint.originalException[LOCAL_VARIABLES_KEY]);
}

hint.originalException[LOCAL_VARIABLES_KEY] = undefined;
Comment on lines +56 to +67

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in both here and the worker, is it worth adding some kind of debug logging for when the sdk is in debug mode?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can validate it pretty easily by inspecting the event in beforeSend, so I think we don't explicitly need logging for every event, but @timfish if you think it's a good idea go for it.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's also the discussion over whether some of our logging here should be behind debug: true or regular console.*. If we hit rate limiting maybe this should always be logged rather than only when debug is enabled? Users are unlikely to have debug logging enabled in production but it's likely useful to know when you're hitting rate limiting.

}

return event;
Expand All@@ -96,10 +90,6 @@ export const localVariablesAsyncIntegration = defineIntegration(((
worker.terminate();
});

worker.on('message', ({ exceptionHash, frames }) => {
cachedFrames.set(exceptionHash, frames);
});

worker.once('error', (err: Error) => {
log('Worker error', err);
});
Expand DownExpand Up@@ -139,8 +129,8 @@ export const localVariablesAsyncIntegration = defineIntegration(((
},
);
},
processEvent(event: Event): Event {
return addLocalVariablesToEvent(event);
processEvent(event: Event, hint: EventHint): Event {
return addLocalVariablesToEvent(event, hint);
},
};
}) satisfies IntegrationFn);
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Debugger, InspectorNotification, Runtime, Session } from 'node:inspector';
import { defineIntegration, getClient } from '@sentry/core';
import type { Event, Exception, IntegrationFn, StackParser } from '@sentry/types';
import type { Event, Exception, IntegrationFn, StackFrame, StackParser } from '@sentry/types';
import { LRUMap, logger } from '@sentry/utils';

import { NODE_MAJOR } from '../../nodeVersion';
Expand All@@ -12,7 +12,29 @@ import type {
RateLimitIncrement,
Variables,
} from './common';
import { createRateLimiter, functionNamesMatch, hashFrames, hashFromStack } from './common';
import { createRateLimiter, functionNamesMatch } from './common';

/** Creates a unique hash from stack frames */
export function hashFrames(frames: StackFrame[] | undefined): string | undefined {
if (frames === undefined) {
return;
}

// Only hash the 10 most recent frames (ie. the last 10)
return frames.slice(-10).reduce((acc, frame) => `${acc},${frame.function},${frame.lineno},${frame.colno}`, '');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should filter out system frames here, so basically either

  1. pick all the frames (if less than 10)
  2. pick 10 most recent frames (after filtering out system frames)

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code is for the sync debugger has simply been copied from ./common.ts as it's no longer common between the two implementations. I probably should have left it there! The sync debugger has seen no changes other than the moving of this code.

}

/**
* We use the stack parser to create a unique hash from the exception stack trace
* This is used to lookup vars when the exception passes through the event processor
*/
export function hashFromStack(stackParser: StackParser, stack: string | undefined): string | undefined {
if (stack === undefined) {
return undefined;
}

return hashFrames(stackParser(stack, 1));
}

type OnPauseEvent = InspectorNotification<Debugger.PausedEventDataType>;
export interface DebugSession {
Expand Down
48 changes: 29 additions & 19 deletions packages/node/src/integrations/local-variables/worker.ts
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
import type { Debugger, InspectorNotification, Runtime } from 'node:inspector';
import { Session } from 'node:inspector/promises';
import { parentPort, workerData } from 'node:worker_threads';
import type { StackParser } from '@sentry/types';
import { createStackParser, nodeStackLineParser } from '@sentry/utils';
import { createGetModuleFromFilename } from '../../utils/module';
import { workerData } from 'node:worker_threads';
import type { LocalVariablesWorkerArgs, PausedExceptionEvent, RateLimitIncrement, Variables } from './common';
import { createRateLimiter, hashFromStack } from './common';
import { LOCAL_VARIABLES_KEY } from './common';
import { createRateLimiter } from './common';

const options: LocalVariablesWorkerArgs = workerData;

const stackParser = createStackParser(nodeStackLineParser(createGetModuleFromFilename(options.basePath)));

function log(...args: unknown[]): void {
if (options.debug) {
// eslint-disable-next-line no-console
Expand DownExpand Up@@ -88,19 +84,15 @@ let rateLimiter: RateLimitIncrement | undefined;

async function handlePaused(
session: Session,
stackParser: StackParser,
{ reason, data, callFrames }: PausedExceptionEvent,
): Promise<void> {
{ reason, data: { objectId }, callFrames }: PausedExceptionEvent,
): Promise<string | undefined> {
if (reason !== 'exception' && reason !== 'promiseRejection') {
return;
}

rateLimiter?.();

// data.description contains the original error.stack
const exceptionHash = hashFromStack(stackParser, data?.description);

if (exceptionHash == undefined) {
if (objectId == undefined) {
return;
}

Expand All@@ -123,7 +115,15 @@ async function handlePaused(
}
}

parentPort?.postMessage({ exceptionHash, frames });
// We write the local variables to a property on the error object. These can be read by the integration as the error
// event pass through the SDK event pipeline
await session.post('Runtime.callFunctionOn', {
functionDeclaration: `function() { this.${LOCAL_VARIABLES_KEY} = ${JSON.stringify(frames)}; }`,
Comment thread Fixed

Check warning

Code scanning / CodeQL

Improper code sanitization

Code construction depends on an [improperly sanitized value](1).
silent: true,
objectId,
});

return objectId;
}

async function startDebugger(): Promise<void> {
Expand All@@ -141,13 +141,23 @@ async function startDebugger(): Promise<void> {
session.on('Debugger.paused', (event: InspectorNotification<Debugger.PausedEventDataType>) => {
isPaused = true;

handlePaused(session, stackParser, event.params as PausedExceptionEvent).then(
() => {
handlePaused(session, event.params as PausedExceptionEvent).then(
async objectId => {
// After the pause work is complete, resume execution!
return isPaused ? session.post('Debugger.resume') : Promise.resolve();
if (isPaused) {
await session.post('Debugger.resume');
}

if (objectId) {
// The object must be released after the debugger has resumed or we get a memory leak.
// For node v20, setImmediate is enough here but for v22 a longer delay is required
setTimeout(async () => {
await session.post('Runtime.releaseObject', { objectId });
}, 1_000);
}
},
_ => {
// ignore
// ignore any errors
},
);
});
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 6 additions & 23 deletions packages/node/src/integrations/local-variables/common.ts
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
import type { Debugger } from 'node:inspector';
import type { StackFrame, StackParser } from '@sentry/types';

export type Variables = Record<string, unknown>;

export type RateLimitIncrement = () => void;

/**
* The key used to store the local variables on the error object.
*/
export const LOCAL_VARIABLES_KEY = '__SENTRY_ERROR_LOCAL_VARIABLES__';

/**
* Creates a rate limiter that will call the disable callback when the rate limit is reached and the enable callback
* when a timeout has occurred.
Expand DownExpand Up@@ -55,6 +59,7 @@ export type PausedExceptionEvent = Debugger.PausedEventDataType & {
data: {
// This contains error.stack
description: string;
objectId?: string;
};
};

Expand All@@ -68,28 +73,6 @@ export function functionNamesMatch(a: string | undefined, b: string | undefined)
return a === b || (isAnonymous(a) && isAnonymous(b));
}

/** Creates a unique hash from stack frames */
export function hashFrames(frames: StackFrame[] | undefined): string | undefined {
if (frames === undefined) {
return;
}

// Only hash the 10 most recent frames (ie. the last 10)
return frames.slice(-10).reduce((acc, frame) => `${acc},${frame.function},${frame.lineno},${frame.colno}`, '');
}

/**
* We use the stack parser to create a unique hash from the exception stack trace
* This is used to lookup vars when the exception passes through the event processor
*/
export function hashFromStack(stackParser: StackParser, stack: string | undefined): string | undefined {
if (stack === undefined) {
return undefined;
}

return hashFrames(stackParser(stack, 1));
}

export interface FrameVariables {
function: string;
vars?: Variables;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,14 @@ declare module 'node:inspector/promises' {
method: 'Runtime.getProperties',
params: Runtime.GetPropertiesParameterType,
): Promise<Runtime.GetPropertiesReturnType>;
public post(
method: 'Runtime.callFunctionOn',
params: Runtime.CallFunctionOnParameterType,
): Promise<Runtime.CallFunctionOnReturnType>;
public post(
method: 'Runtime.releaseObject',
params: Runtime.ReleaseObjectParameterType,
): Promise<Runtime.ReleaseObjectReturnType>;

public on(
event: 'Debugger.paused',
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
import { Worker } from 'node:worker_threads';
import { defineIntegration } from '@sentry/core';
import type { Event, Exception, IntegrationFn } from '@sentry/types';
import { LRUMap, logger } from '@sentry/utils';
import type { Event, EventHint, Exception, IntegrationFn } from '@sentry/types';
import { logger } from '@sentry/utils';

import type { NodeClient } from '../../sdk/client';
import type { FrameVariables, LocalVariablesIntegrationOptions, LocalVariablesWorkerArgs } from './common';
import { functionNamesMatch, hashFrames } from './common';
import { LOCAL_VARIABLES_KEY } from './common';
import { functionNamesMatch } from './common';

// This string is a placeholder that gets overwritten with the worker code.
export const base64WorkerScript = '###LocalVariablesWorkerScript###';
Expand All@@ -20,23 +21,7 @@ function log(...args: unknown[]): void {
export const localVariablesAsyncIntegration = defineIntegration(((
integrationOptions: LocalVariablesIntegrationOptions = {},
) => {
const cachedFrames: LRUMap<string, FrameVariables[]> = new LRUMap(20);

function addLocalVariablesToException(exception: Exception): void {
const hash = hashFrames(exception?.stacktrace?.frames);

if (hash === undefined) {
return;
}

// Check if we have local variables for an exception that matches the hash
// remove is identical to get but also removes the entry from the cache
const cachedFrame = cachedFrames.remove(hash);

if (cachedFrame === undefined) {
return;
}

function addLocalVariablesToException(exception: Exception, localVariables: FrameVariables[]): void {
// Filter out frames where the function name is `new Promise` since these are in the error.stack frames
// but do not appear in the debugger call frames
const frames = (exception.stacktrace?.frames || []).filter(frame => frame.function !== 'new Promise');
Expand All@@ -45,32 +30,41 @@ export const localVariablesAsyncIntegration = defineIntegration(((
// Sentry frames are in reverse order
const frameIndex = frames.length - i - 1;

const cachedFrameVariable = cachedFrame[i];
const frameVariable = frames[frameIndex];
const frameLocalVariables = localVariables[i];
const frame = frames[frameIndex];

if (!frameVariable || !cachedFrameVariable) {
if (!frame || !frameLocalVariables) {
// Drop out if we run out of frames to match up
break;
}

if (
// We need to have vars to add
cachedFrameVariable.vars === undefined ||
frameLocalVariables.vars === undefined ||
// We're not interested in frames that are not in_app because the vars are not relevant
frameVariable.in_app === false ||
frame.in_app === false ||
// The function names need to match
!functionNamesMatch(frameVariable.function, cachedFrameVariable.function)
!functionNamesMatch(frame.function, frameLocalVariables.function)
) {
continue;
}

frameVariable.vars = cachedFrameVariable.vars;
frame.vars = frameLocalVariables.vars;
}
}

function addLocalVariablesToEvent(event: Event): Event {
for (const exception of event.exception?.values || []) {
addLocalVariablesToException(exception);
function addLocalVariablesToEvent(event: Event, hint: EventHint): Event {
if (
hint.originalException &&
typeof hint.originalException === 'object' &&
LOCAL_VARIABLES_KEY in hint.originalException &&
Array.isArray(hint.originalException[LOCAL_VARIABLES_KEY])
) {
for (const exception of event.exception?.values || []) {
addLocalVariablesToException(exception, hint.originalException[LOCAL_VARIABLES_KEY]);
}

hint.originalException[LOCAL_VARIABLES_KEY] = undefined;
Comment on lines +56 to +67

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in both here and the worker, is it worth adding some kind of debug logging for when the sdk is in debug mode?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can validate it pretty easily by inspecting the event in beforeSend, so I think we don't explicitly need logging for every event, but @timfish if you think it's a good idea go for it.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's also the discussion over whether some of our logging here should be behind debug: true or regular console.*. If we hit rate limiting maybe this should always be logged rather than only when debug is enabled? Users are unlikely to have debug logging enabled in production but it's likely useful to know when you're hitting rate limiting.

}

return event;
Expand All@@ -96,10 +90,6 @@ export const localVariablesAsyncIntegration = defineIntegration(((
worker.terminate();
});

worker.on('message', ({ exceptionHash, frames }) => {
cachedFrames.set(exceptionHash, frames);
});

worker.once('error', (err: Error) => {
log('Worker error', err);
});
Expand DownExpand Up@@ -139,8 +129,8 @@ export const localVariablesAsyncIntegration = defineIntegration(((
},
);
},
processEvent(event: Event): Event {
return addLocalVariablesToEvent(event);
processEvent(event: Event, hint: EventHint): Event {
return addLocalVariablesToEvent(event, hint);
},
};
}) satisfies IntegrationFn);
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Debugger, InspectorNotification, Runtime, Session } from 'node:inspector';
import { defineIntegration, getClient } from '@sentry/core';
import type { Event, Exception, IntegrationFn, StackParser } from '@sentry/types';
import type { Event, Exception, IntegrationFn, StackFrame, StackParser } from '@sentry/types';
import { LRUMap, logger } from '@sentry/utils';

import { NODE_MAJOR } from '../../nodeVersion';
Expand All@@ -12,7 +12,29 @@ import type {
RateLimitIncrement,
Variables,
} from './common';
import { createRateLimiter, functionNamesMatch, hashFrames, hashFromStack } from './common';
import { createRateLimiter, functionNamesMatch } from './common';

/** Creates a unique hash from stack frames */
export function hashFrames(frames: StackFrame[] | undefined): string | undefined {
if (frames === undefined) {
return;
}

// Only hash the 10 most recent frames (ie. the last 10)
return frames.slice(-10).reduce((acc, frame) => `${acc},${frame.function},${frame.lineno},${frame.colno}`, '');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should filter out system frames here, so basically either

  1. pick all the frames (if less than 10)
  2. pick 10 most recent frames (after filtering out system frames)

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code is for the sync debugger has simply been copied from ./common.ts as it's no longer common between the two implementations. I probably should have left it there! The sync debugger has seen no changes other than the moving of this code.

}

/**
* We use the stack parser to create a unique hash from the exception stack trace
* This is used to lookup vars when the exception passes through the event processor
*/
export function hashFromStack(stackParser: StackParser, stack: string | undefined): string | undefined {
if (stack === undefined) {
return undefined;
}

return hashFrames(stackParser(stack, 1));
}

type OnPauseEvent = InspectorNotification<Debugger.PausedEventDataType>;
export interface DebugSession {
Expand Down
48 changes: 29 additions & 19 deletions packages/node/src/integrations/local-variables/worker.ts
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
import type { Debugger, InspectorNotification, Runtime } from 'node:inspector';
import { Session } from 'node:inspector/promises';
import { parentPort, workerData } from 'node:worker_threads';
import type { StackParser } from '@sentry/types';
import { createStackParser, nodeStackLineParser } from '@sentry/utils';
import { createGetModuleFromFilename } from '../../utils/module';
import { workerData } from 'node:worker_threads';
import type { LocalVariablesWorkerArgs, PausedExceptionEvent, RateLimitIncrement, Variables } from './common';
import { createRateLimiter, hashFromStack } from './common';
import { LOCAL_VARIABLES_KEY } from './common';
import { createRateLimiter } from './common';

const options: LocalVariablesWorkerArgs = workerData;

const stackParser = createStackParser(nodeStackLineParser(createGetModuleFromFilename(options.basePath)));

function log(...args: unknown[]): void {
if (options.debug) {
// eslint-disable-next-line no-console
Expand DownExpand Up@@ -88,19 +84,15 @@ let rateLimiter: RateLimitIncrement | undefined;

async function handlePaused(
session: Session,
stackParser: StackParser,
{ reason, data, callFrames }: PausedExceptionEvent,
): Promise<void> {
{ reason, data: { objectId }, callFrames }: PausedExceptionEvent,
): Promise<string | undefined> {
if (reason !== 'exception' && reason !== 'promiseRejection') {
return;
}

rateLimiter?.();

// data.description contains the original error.stack
const exceptionHash = hashFromStack(stackParser, data?.description);

if (exceptionHash == undefined) {
if (objectId == undefined) {
return;
}

Expand All@@ -123,7 +115,15 @@ async function handlePaused(
}
}

parentPort?.postMessage({ exceptionHash, frames });
// We write the local variables to a property on the error object. These can be read by the integration as the error
// event pass through the SDK event pipeline
await session.post('Runtime.callFunctionOn', {
functionDeclaration: `function() { this.${LOCAL_VARIABLES_KEY} = ${JSON.stringify(frames)}; }`,
Comment thread Fixed

Check warning

Code scanning / CodeQL

Improper code sanitization

Code construction depends on an [improperly sanitized value](1).
silent: true,
objectId,
});

return objectId;
}

async function startDebugger(): Promise<void> {
Expand All@@ -141,13 +141,23 @@ async function startDebugger(): Promise<void> {
session.on('Debugger.paused', (event: InspectorNotification<Debugger.PausedEventDataType>) => {
isPaused = true;

handlePaused(session, stackParser, event.params as PausedExceptionEvent).then(
() => {
handlePaused(session, event.params as PausedExceptionEvent).then(
async objectId => {
// After the pause work is complete, resume execution!
return isPaused ? session.post('Debugger.resume') : Promise.resolve();
if (isPaused) {
await session.post('Debugger.resume');
}

if (objectId) {
// The object must be released after the debugger has resumed or we get a memory leak.
// For node v20, setImmediate is enough here but for v22 a longer delay is required
setTimeout(async () => {
await session.post('Runtime.releaseObject', { objectId });
}, 1_000);
}
},
_ => {
// ignore
// ignore any errors
},
);
});
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 6 additions & 23 deletions packages/node/src/integrations/local-variables/common.ts
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
import type { Debugger } from 'node:inspector';
import type { StackFrame, StackParser } from '@sentry/types';

export type Variables = Record<string, unknown>;

export type RateLimitIncrement = () => void;

/**
* The key used to store the local variables on the error object.
*/
export const LOCAL_VARIABLES_KEY = '__SENTRY_ERROR_LOCAL_VARIABLES__';

/**
* Creates a rate limiter that will call the disable callback when the rate limit is reached and the enable callback
* when a timeout has occurred.
Expand DownExpand Up@@ -55,6 +59,7 @@ export type PausedExceptionEvent = Debugger.PausedEventDataType & {
data: {
// This contains error.stack
description: string;
objectId?: string;
};
};

Expand All@@ -68,28 +73,6 @@ export function functionNamesMatch(a: string | undefined, b: string | undefined)
return a === b || (isAnonymous(a) && isAnonymous(b));
}

/** Creates a unique hash from stack frames */
export function hashFrames(frames: StackFrame[] | undefined): string | undefined {
if (frames === undefined) {
return;
}

// Only hash the 10 most recent frames (ie. the last 10)
return frames.slice(-10).reduce((acc, frame) => `${acc},${frame.function},${frame.lineno},${frame.colno}`, '');
}

/**
* We use the stack parser to create a unique hash from the exception stack trace
* This is used to lookup vars when the exception passes through the event processor
*/
export function hashFromStack(stackParser: StackParser, stack: string | undefined): string | undefined {
if (stack === undefined) {
return undefined;
}

return hashFrames(stackParser(stack, 1));
}

export interface FrameVariables {
function: string;
vars?: Variables;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,14 @@ declare module 'node:inspector/promises' {
method: 'Runtime.getProperties',
params: Runtime.GetPropertiesParameterType,
): Promise<Runtime.GetPropertiesReturnType>;
public post(
method: 'Runtime.callFunctionOn',
params: Runtime.CallFunctionOnParameterType,
): Promise<Runtime.CallFunctionOnReturnType>;
public post(
method: 'Runtime.releaseObject',
params: Runtime.ReleaseObjectParameterType,
): Promise<Runtime.ReleaseObjectReturnType>;

public on(
event: 'Debugger.paused',
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
import { Worker } from 'node:worker_threads';
import { defineIntegration } from '@sentry/core';
import type { Event, Exception, IntegrationFn } from '@sentry/types';
import { LRUMap, logger } from '@sentry/utils';
import type { Event, EventHint, Exception, IntegrationFn } from '@sentry/types';
import { logger } from '@sentry/utils';

import type { NodeClient } from '../../sdk/client';
import type { FrameVariables, LocalVariablesIntegrationOptions, LocalVariablesWorkerArgs } from './common';
import { functionNamesMatch, hashFrames } from './common';
import { LOCAL_VARIABLES_KEY } from './common';
import { functionNamesMatch } from './common';

// This string is a placeholder that gets overwritten with the worker code.
export const base64WorkerScript = '###LocalVariablesWorkerScript###';
Expand All@@ -20,23 +21,7 @@ function log(...args: unknown[]): void {
export const localVariablesAsyncIntegration = defineIntegration(((
integrationOptions: LocalVariablesIntegrationOptions = {},
) => {
const cachedFrames: LRUMap<string, FrameVariables[]> = new LRUMap(20);

function addLocalVariablesToException(exception: Exception): void {
const hash = hashFrames(exception?.stacktrace?.frames);

if (hash === undefined) {
return;
}

// Check if we have local variables for an exception that matches the hash
// remove is identical to get but also removes the entry from the cache
const cachedFrame = cachedFrames.remove(hash);

if (cachedFrame === undefined) {
return;
}

function addLocalVariablesToException(exception: Exception, localVariables: FrameVariables[]): void {
// Filter out frames where the function name is `new Promise` since these are in the error.stack frames
// but do not appear in the debugger call frames
const frames = (exception.stacktrace?.frames || []).filter(frame => frame.function !== 'new Promise');
Expand All@@ -45,32 +30,41 @@ export const localVariablesAsyncIntegration = defineIntegration(((
// Sentry frames are in reverse order
const frameIndex = frames.length - i - 1;

const cachedFrameVariable = cachedFrame[i];
const frameVariable = frames[frameIndex];
const frameLocalVariables = localVariables[i];
const frame = frames[frameIndex];

if (!frameVariable || !cachedFrameVariable) {
if (!frame || !frameLocalVariables) {
// Drop out if we run out of frames to match up
break;
}

if (
// We need to have vars to add
cachedFrameVariable.vars === undefined ||
frameLocalVariables.vars === undefined ||
// We're not interested in frames that are not in_app because the vars are not relevant
frameVariable.in_app === false ||
frame.in_app === false ||
// The function names need to match
!functionNamesMatch(frameVariable.function, cachedFrameVariable.function)
!functionNamesMatch(frame.function, frameLocalVariables.function)
) {
continue;
}

frameVariable.vars = cachedFrameVariable.vars;
frame.vars = frameLocalVariables.vars;
}
}

function addLocalVariablesToEvent(event: Event): Event {
for (const exception of event.exception?.values || []) {
addLocalVariablesToException(exception);
function addLocalVariablesToEvent(event: Event, hint: EventHint): Event {
if (
hint.originalException &&
typeof hint.originalException === 'object' &&
LOCAL_VARIABLES_KEY in hint.originalException &&
Array.isArray(hint.originalException[LOCAL_VARIABLES_KEY])
) {
for (const exception of event.exception?.values || []) {
addLocalVariablesToException(exception, hint.originalException[LOCAL_VARIABLES_KEY]);
}

hint.originalException[LOCAL_VARIABLES_KEY] = undefined;
Comment on lines +56 to +67

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in both here and the worker, is it worth adding some kind of debug logging for when the sdk is in debug mode?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can validate it pretty easily by inspecting the event in beforeSend, so I think we don't explicitly need logging for every event, but @timfish if you think it's a good idea go for it.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's also the discussion over whether some of our logging here should be behind debug: true or regular console.*. If we hit rate limiting maybe this should always be logged rather than only when debug is enabled? Users are unlikely to have debug logging enabled in production but it's likely useful to know when you're hitting rate limiting.

}

return event;
Expand All@@ -96,10 +90,6 @@ export const localVariablesAsyncIntegration = defineIntegration(((
worker.terminate();
});

worker.on('message', ({ exceptionHash, frames }) => {
cachedFrames.set(exceptionHash, frames);
});

worker.once('error', (err: Error) => {
log('Worker error', err);
});
Expand DownExpand Up@@ -139,8 +129,8 @@ export const localVariablesAsyncIntegration = defineIntegration(((
},
);
},
processEvent(event: Event): Event {
return addLocalVariablesToEvent(event);
processEvent(event: Event, hint: EventHint): Event {
return addLocalVariablesToEvent(event, hint);
},
};
}) satisfies IntegrationFn);
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Debugger, InspectorNotification, Runtime, Session } from 'node:inspector';
import { defineIntegration, getClient } from '@sentry/core';
import type { Event, Exception, IntegrationFn, StackParser } from '@sentry/types';
import type { Event, Exception, IntegrationFn, StackFrame, StackParser } from '@sentry/types';
import { LRUMap, logger } from '@sentry/utils';

import { NODE_MAJOR } from '../../nodeVersion';
Expand All@@ -12,7 +12,29 @@ import type {
RateLimitIncrement,
Variables,
} from './common';
import { createRateLimiter, functionNamesMatch, hashFrames, hashFromStack } from './common';
import { createRateLimiter, functionNamesMatch } from './common';

/** Creates a unique hash from stack frames */
export function hashFrames(frames: StackFrame[] | undefined): string | undefined {
if (frames === undefined) {
return;
}

// Only hash the 10 most recent frames (ie. the last 10)
return frames.slice(-10).reduce((acc, frame) => `${acc},${frame.function},${frame.lineno},${frame.colno}`, '');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should filter out system frames here, so basically either

  1. pick all the frames (if less than 10)
  2. pick 10 most recent frames (after filtering out system frames)

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code is for the sync debugger has simply been copied from ./common.ts as it's no longer common between the two implementations. I probably should have left it there! The sync debugger has seen no changes other than the moving of this code.

}

/**
* We use the stack parser to create a unique hash from the exception stack trace
* This is used to lookup vars when the exception passes through the event processor
*/
export function hashFromStack(stackParser: StackParser, stack: string | undefined): string | undefined {
if (stack === undefined) {
return undefined;
}

return hashFrames(stackParser(stack, 1));
}

type OnPauseEvent = InspectorNotification<Debugger.PausedEventDataType>;
export interface DebugSession {
Expand Down
48 changes: 29 additions & 19 deletions packages/node/src/integrations/local-variables/worker.ts
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
import type { Debugger, InspectorNotification, Runtime } from 'node:inspector';
import { Session } from 'node:inspector/promises';
import { parentPort, workerData } from 'node:worker_threads';
import type { StackParser } from '@sentry/types';
import { createStackParser, nodeStackLineParser } from '@sentry/utils';
import { createGetModuleFromFilename } from '../../utils/module';
import { workerData } from 'node:worker_threads';
import type { LocalVariablesWorkerArgs, PausedExceptionEvent, RateLimitIncrement, Variables } from './common';
import { createRateLimiter, hashFromStack } from './common';
import { LOCAL_VARIABLES_KEY } from './common';
import { createRateLimiter } from './common';

const options: LocalVariablesWorkerArgs = workerData;

const stackParser = createStackParser(nodeStackLineParser(createGetModuleFromFilename(options.basePath)));

function log(...args: unknown[]): void {
if (options.debug) {
// eslint-disable-next-line no-console
Expand DownExpand Up@@ -88,19 +84,15 @@ let rateLimiter: RateLimitIncrement | undefined;

async function handlePaused(
session: Session,
stackParser: StackParser,
{ reason, data, callFrames }: PausedExceptionEvent,
): Promise<void> {
{ reason, data: { objectId }, callFrames }: PausedExceptionEvent,
): Promise<string | undefined> {
if (reason !== 'exception' && reason !== 'promiseRejection') {
return;
}

rateLimiter?.();

// data.description contains the original error.stack
const exceptionHash = hashFromStack(stackParser, data?.description);

if (exceptionHash == undefined) {
if (objectId == undefined) {
return;
}

Expand All@@ -123,7 +115,15 @@ async function handlePaused(
}
}

parentPort?.postMessage({ exceptionHash, frames });
// We write the local variables to a property on the error object. These can be read by the integration as the error
// event pass through the SDK event pipeline
await session.post('Runtime.callFunctionOn', {
functionDeclaration: `function() { this.${LOCAL_VARIABLES_KEY} = ${JSON.stringify(frames)}; }`,
Comment thread Fixed

Check warning

Code scanning / CodeQL

Improper code sanitization

Code construction depends on an [improperly sanitized value](1).
silent: true,
objectId,
});

return objectId;
}

async function startDebugger(): Promise<void> {
Expand All@@ -141,13 +141,23 @@ async function startDebugger(): Promise<void> {
session.on('Debugger.paused', (event: InspectorNotification<Debugger.PausedEventDataType>) => {
isPaused = true;

handlePaused(session, stackParser, event.params as PausedExceptionEvent).then(
() => {
handlePaused(session, event.params as PausedExceptionEvent).then(
async objectId => {
// After the pause work is complete, resume execution!
return isPaused ? session.post('Debugger.resume') : Promise.resolve();
if (isPaused) {
await session.post('Debugger.resume');
}

if (objectId) {
// The object must be released after the debugger has resumed or we get a memory leak.
// For node v20, setImmediate is enough here but for v22 a longer delay is required
setTimeout(async () => {
await session.post('Runtime.releaseObject', { objectId });
}, 1_000);
}
},
_ => {
// ignore
// ignore any errors
},
);
});
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 6 additions & 23 deletions packages/node/src/integrations/local-variables/common.ts
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
import type { Debugger } from 'node:inspector';
import type { StackFrame, StackParser } from '@sentry/types';

export type Variables = Record<string, unknown>;

export type RateLimitIncrement = () => void;

/**
* The key used to store the local variables on the error object.
*/
export const LOCAL_VARIABLES_KEY = '__SENTRY_ERROR_LOCAL_VARIABLES__';

/**
* Creates a rate limiter that will call the disable callback when the rate limit is reached and the enable callback
* when a timeout has occurred.
Expand DownExpand Up@@ -55,6 +59,7 @@ export type PausedExceptionEvent = Debugger.PausedEventDataType & {
data: {
// This contains error.stack
description: string;
objectId?: string;
};
};

Expand All@@ -68,28 +73,6 @@ export function functionNamesMatch(a: string | undefined, b: string | undefined)
return a === b || (isAnonymous(a) && isAnonymous(b));
}

/** Creates a unique hash from stack frames */
export function hashFrames(frames: StackFrame[] | undefined): string | undefined {
if (frames === undefined) {
return;
}

// Only hash the 10 most recent frames (ie. the last 10)
return frames.slice(-10).reduce((acc, frame) => `${acc},${frame.function},${frame.lineno},${frame.colno}`, '');
}

/**
* We use the stack parser to create a unique hash from the exception stack trace
* This is used to lookup vars when the exception passes through the event processor
*/
export function hashFromStack(stackParser: StackParser, stack: string | undefined): string | undefined {
if (stack === undefined) {
return undefined;
}

return hashFrames(stackParser(stack, 1));
}

export interface FrameVariables {
function: string;
vars?: Variables;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,14 @@ declare module 'node:inspector/promises' {
method: 'Runtime.getProperties',
params: Runtime.GetPropertiesParameterType,
): Promise<Runtime.GetPropertiesReturnType>;
public post(
method: 'Runtime.callFunctionOn',
params: Runtime.CallFunctionOnParameterType,
): Promise<Runtime.CallFunctionOnReturnType>;
public post(
method: 'Runtime.releaseObject',
params: Runtime.ReleaseObjectParameterType,
): Promise<Runtime.ReleaseObjectReturnType>;

public on(
event: 'Debugger.paused',
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
import { Worker } from 'node:worker_threads';
import { defineIntegration } from '@sentry/core';
import type { Event, Exception, IntegrationFn } from '@sentry/types';
import { LRUMap, logger } from '@sentry/utils';
import type { Event, EventHint, Exception, IntegrationFn } from '@sentry/types';
import { logger } from '@sentry/utils';

import type { NodeClient } from '../../sdk/client';
import type { FrameVariables, LocalVariablesIntegrationOptions, LocalVariablesWorkerArgs } from './common';
import { functionNamesMatch, hashFrames } from './common';
import { LOCAL_VARIABLES_KEY } from './common';
import { functionNamesMatch } from './common';

// This string is a placeholder that gets overwritten with the worker code.
export const base64WorkerScript = '###LocalVariablesWorkerScript###';
Expand All@@ -20,23 +21,7 @@ function log(...args: unknown[]): void {
export const localVariablesAsyncIntegration = defineIntegration(((
integrationOptions: LocalVariablesIntegrationOptions = {},
) => {
const cachedFrames: LRUMap<string, FrameVariables[]> = new LRUMap(20);

function addLocalVariablesToException(exception: Exception): void {
const hash = hashFrames(exception?.stacktrace?.frames);

if (hash === undefined) {
return;
}

// Check if we have local variables for an exception that matches the hash
// remove is identical to get but also removes the entry from the cache
const cachedFrame = cachedFrames.remove(hash);

if (cachedFrame === undefined) {
return;
}

function addLocalVariablesToException(exception: Exception, localVariables: FrameVariables[]): void {
// Filter out frames where the function name is `new Promise` since these are in the error.stack frames
// but do not appear in the debugger call frames
const frames = (exception.stacktrace?.frames || []).filter(frame => frame.function !== 'new Promise');
Expand All@@ -45,32 +30,41 @@ export const localVariablesAsyncIntegration = defineIntegration(((
// Sentry frames are in reverse order
const frameIndex = frames.length - i - 1;

const cachedFrameVariable = cachedFrame[i];
const frameVariable = frames[frameIndex];
const frameLocalVariables = localVariables[i];
const frame = frames[frameIndex];

if (!frameVariable || !cachedFrameVariable) {
if (!frame || !frameLocalVariables) {
// Drop out if we run out of frames to match up
break;
}

if (
// We need to have vars to add
cachedFrameVariable.vars === undefined ||
frameLocalVariables.vars === undefined ||
// We're not interested in frames that are not in_app because the vars are not relevant
frameVariable.in_app === false ||
frame.in_app === false ||
// The function names need to match
!functionNamesMatch(frameVariable.function, cachedFrameVariable.function)
!functionNamesMatch(frame.function, frameLocalVariables.function)
) {
continue;
}

frameVariable.vars = cachedFrameVariable.vars;
frame.vars = frameLocalVariables.vars;
}
}

function addLocalVariablesToEvent(event: Event): Event {
for (const exception of event.exception?.values || []) {
addLocalVariablesToException(exception);
function addLocalVariablesToEvent(event: Event, hint: EventHint): Event {
if (
hint.originalException &&
typeof hint.originalException === 'object' &&
LOCAL_VARIABLES_KEY in hint.originalException &&
Array.isArray(hint.originalException[LOCAL_VARIABLES_KEY])
) {
for (const exception of event.exception?.values || []) {
addLocalVariablesToException(exception, hint.originalException[LOCAL_VARIABLES_KEY]);
}

hint.originalException[LOCAL_VARIABLES_KEY] = undefined;
Comment on lines +56 to +67

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in both here and the worker, is it worth adding some kind of debug logging for when the sdk is in debug mode?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can validate it pretty easily by inspecting the event in beforeSend, so I think we don't explicitly need logging for every event, but @timfish if you think it's a good idea go for it.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's also the discussion over whether some of our logging here should be behind debug: true or regular console.*. If we hit rate limiting maybe this should always be logged rather than only when debug is enabled? Users are unlikely to have debug logging enabled in production but it's likely useful to know when you're hitting rate limiting.

}

return event;
Expand All@@ -96,10 +90,6 @@ export const localVariablesAsyncIntegration = defineIntegration(((
worker.terminate();
});

worker.on('message', ({ exceptionHash, frames }) => {
cachedFrames.set(exceptionHash, frames);
});

worker.once('error', (err: Error) => {
log('Worker error', err);
});
Expand DownExpand Up@@ -139,8 +129,8 @@ export const localVariablesAsyncIntegration = defineIntegration(((
},
);
},
processEvent(event: Event): Event {
return addLocalVariablesToEvent(event);
processEvent(event: Event, hint: EventHint): Event {
return addLocalVariablesToEvent(event, hint);
},
};
}) satisfies IntegrationFn);
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Debugger, InspectorNotification, Runtime, Session } from 'node:inspector';
import { defineIntegration, getClient } from '@sentry/core';
import type { Event, Exception, IntegrationFn, StackParser } from '@sentry/types';
import type { Event, Exception, IntegrationFn, StackFrame, StackParser } from '@sentry/types';
import { LRUMap, logger } from '@sentry/utils';

import { NODE_MAJOR } from '../../nodeVersion';
Expand All@@ -12,7 +12,29 @@ import type {
RateLimitIncrement,
Variables,
} from './common';
import { createRateLimiter, functionNamesMatch, hashFrames, hashFromStack } from './common';
import { createRateLimiter, functionNamesMatch } from './common';

/** Creates a unique hash from stack frames */
export function hashFrames(frames: StackFrame[] | undefined): string | undefined {
if (frames === undefined) {
return;
}

// Only hash the 10 most recent frames (ie. the last 10)
return frames.slice(-10).reduce((acc, frame) => `${acc},${frame.function},${frame.lineno},${frame.colno}`, '');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should filter out system frames here, so basically either

  1. pick all the frames (if less than 10)
  2. pick 10 most recent frames (after filtering out system frames)

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code is for the sync debugger has simply been copied from ./common.ts as it's no longer common between the two implementations. I probably should have left it there! The sync debugger has seen no changes other than the moving of this code.

}

/**
* We use the stack parser to create a unique hash from the exception stack trace
* This is used to lookup vars when the exception passes through the event processor
*/
export function hashFromStack(stackParser: StackParser, stack: string | undefined): string | undefined {
if (stack === undefined) {
return undefined;
}

return hashFrames(stackParser(stack, 1));
}

type OnPauseEvent = InspectorNotification<Debugger.PausedEventDataType>;
export interface DebugSession {
Expand Down
48 changes: 29 additions & 19 deletions packages/node/src/integrations/local-variables/worker.ts
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
import type { Debugger, InspectorNotification, Runtime } from 'node:inspector';
import { Session } from 'node:inspector/promises';
import { parentPort, workerData } from 'node:worker_threads';
import type { StackParser } from '@sentry/types';
import { createStackParser, nodeStackLineParser } from '@sentry/utils';
import { createGetModuleFromFilename } from '../../utils/module';
import { workerData } from 'node:worker_threads';
import type { LocalVariablesWorkerArgs, PausedExceptionEvent, RateLimitIncrement, Variables } from './common';
import { createRateLimiter, hashFromStack } from './common';
import { LOCAL_VARIABLES_KEY } from './common';
import { createRateLimiter } from './common';

const options: LocalVariablesWorkerArgs = workerData;

const stackParser = createStackParser(nodeStackLineParser(createGetModuleFromFilename(options.basePath)));

function log(...args: unknown[]): void {
if (options.debug) {
// eslint-disable-next-line no-console
Expand DownExpand Up@@ -88,19 +84,15 @@ let rateLimiter: RateLimitIncrement | undefined;

async function handlePaused(
session: Session,
stackParser: StackParser,
{ reason, data, callFrames }: PausedExceptionEvent,
): Promise<void> {
{ reason, data: { objectId }, callFrames }: PausedExceptionEvent,
): Promise<string | undefined> {
if (reason !== 'exception' && reason !== 'promiseRejection') {
return;
}

rateLimiter?.();

// data.description contains the original error.stack
const exceptionHash = hashFromStack(stackParser, data?.description);

if (exceptionHash == undefined) {
if (objectId == undefined) {
return;
}

Expand All@@ -123,7 +115,15 @@ async function handlePaused(
}
}

parentPort?.postMessage({ exceptionHash, frames });
// We write the local variables to a property on the error object. These can be read by the integration as the error
// event pass through the SDK event pipeline
await session.post('Runtime.callFunctionOn', {
functionDeclaration: `function() { this.${LOCAL_VARIABLES_KEY} = ${JSON.stringify(frames)}; }`,
Comment thread Fixed

Check warning

Code scanning / CodeQL

Improper code sanitization

Code construction depends on an [improperly sanitized value](1).
silent: true,
objectId,
});

return objectId;
}

async function startDebugger(): Promise<void> {
Expand All@@ -141,13 +141,23 @@ async function startDebugger(): Promise<void> {
session.on('Debugger.paused', (event: InspectorNotification<Debugger.PausedEventDataType>) => {
isPaused = true;

handlePaused(session, stackParser, event.params as PausedExceptionEvent).then(
() => {
handlePaused(session, event.params as PausedExceptionEvent).then(
async objectId => {
// After the pause work is complete, resume execution!
return isPaused ? session.post('Debugger.resume') : Promise.resolve();
if (isPaused) {
await session.post('Debugger.resume');
}

if (objectId) {
// The object must be released after the debugger has resumed or we get a memory leak.
// For node v20, setImmediate is enough here but for v22 a longer delay is required
setTimeout(async () => {
await session.post('Runtime.releaseObject', { objectId });
}, 1_000);
}
},
_ => {
// ignore
// ignore any errors
},
);
});
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 6 additions & 23 deletions packages/node/src/integrations/local-variables/common.ts
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
import type { Debugger } from 'node:inspector';
import type { StackFrame, StackParser } from '@sentry/types';

export type Variables = Record<string, unknown>;

export type RateLimitIncrement = () => void;

/**
* The key used to store the local variables on the error object.
*/
export const LOCAL_VARIABLES_KEY = '__SENTRY_ERROR_LOCAL_VARIABLES__';

/**
* Creates a rate limiter that will call the disable callback when the rate limit is reached and the enable callback
* when a timeout has occurred.
Expand DownExpand Up@@ -55,6 +59,7 @@ export type PausedExceptionEvent = Debugger.PausedEventDataType & {
data: {
// This contains error.stack
description: string;
objectId?: string;
};
};

Expand All@@ -68,28 +73,6 @@ export function functionNamesMatch(a: string | undefined, b: string | undefined)
return a === b || (isAnonymous(a) && isAnonymous(b));
}

/** Creates a unique hash from stack frames */
export function hashFrames(frames: StackFrame[] | undefined): string | undefined {
if (frames === undefined) {
return;
}

// Only hash the 10 most recent frames (ie. the last 10)
return frames.slice(-10).reduce((acc, frame) => `${acc},${frame.function},${frame.lineno},${frame.colno}`, '');
}

/**
* We use the stack parser to create a unique hash from the exception stack trace
* This is used to lookup vars when the exception passes through the event processor
*/
export function hashFromStack(stackParser: StackParser, stack: string | undefined): string | undefined {
if (stack === undefined) {
return undefined;
}

return hashFrames(stackParser(stack, 1));
}

export interface FrameVariables {
function: string;
vars?: Variables;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,14 @@ declare module 'node:inspector/promises' {
method: 'Runtime.getProperties',
params: Runtime.GetPropertiesParameterType,
): Promise<Runtime.GetPropertiesReturnType>;
public post(
method: 'Runtime.callFunctionOn',
params: Runtime.CallFunctionOnParameterType,
): Promise<Runtime.CallFunctionOnReturnType>;
public post(
method: 'Runtime.releaseObject',
params: Runtime.ReleaseObjectParameterType,
): Promise<Runtime.ReleaseObjectReturnType>;

public on(
event: 'Debugger.paused',
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
import { Worker } from 'node:worker_threads';
import { defineIntegration } from '@sentry/core';
import type { Event, Exception, IntegrationFn } from '@sentry/types';
import { LRUMap, logger } from '@sentry/utils';
import type { Event, EventHint, Exception, IntegrationFn } from '@sentry/types';
import { logger } from '@sentry/utils';

import type { NodeClient } from '../../sdk/client';
import type { FrameVariables, LocalVariablesIntegrationOptions, LocalVariablesWorkerArgs } from './common';
import { functionNamesMatch, hashFrames } from './common';
import { LOCAL_VARIABLES_KEY } from './common';
import { functionNamesMatch } from './common';

// This string is a placeholder that gets overwritten with the worker code.
export const base64WorkerScript = '###LocalVariablesWorkerScript###';
Expand All@@ -20,23 +21,7 @@ function log(...args: unknown[]): void {
export const localVariablesAsyncIntegration = defineIntegration(((
integrationOptions: LocalVariablesIntegrationOptions = {},
) => {
const cachedFrames: LRUMap<string, FrameVariables[]> = new LRUMap(20);

function addLocalVariablesToException(exception: Exception): void {
const hash = hashFrames(exception?.stacktrace?.frames);

if (hash === undefined) {
return;
}

// Check if we have local variables for an exception that matches the hash
// remove is identical to get but also removes the entry from the cache
const cachedFrame = cachedFrames.remove(hash);

if (cachedFrame === undefined) {
return;
}

function addLocalVariablesToException(exception: Exception, localVariables: FrameVariables[]): void {
// Filter out frames where the function name is `new Promise` since these are in the error.stack frames
// but do not appear in the debugger call frames
const frames = (exception.stacktrace?.frames || []).filter(frame => frame.function !== 'new Promise');
Expand All@@ -45,32 +30,41 @@ export const localVariablesAsyncIntegration = defineIntegration(((
// Sentry frames are in reverse order
const frameIndex = frames.length - i - 1;

const cachedFrameVariable = cachedFrame[i];
const frameVariable = frames[frameIndex];
const frameLocalVariables = localVariables[i];
const frame = frames[frameIndex];

if (!frameVariable || !cachedFrameVariable) {
if (!frame || !frameLocalVariables) {
// Drop out if we run out of frames to match up
break;
}

if (
// We need to have vars to add
cachedFrameVariable.vars === undefined ||
frameLocalVariables.vars === undefined ||
// We're not interested in frames that are not in_app because the vars are not relevant
frameVariable.in_app === false ||
frame.in_app === false ||
// The function names need to match
!functionNamesMatch(frameVariable.function, cachedFrameVariable.function)
!functionNamesMatch(frame.function, frameLocalVariables.function)
) {
continue;
}

frameVariable.vars = cachedFrameVariable.vars;
frame.vars = frameLocalVariables.vars;
}
}

function addLocalVariablesToEvent(event: Event): Event {
for (const exception of event.exception?.values || []) {
addLocalVariablesToException(exception);
function addLocalVariablesToEvent(event: Event, hint: EventHint): Event {
if (
hint.originalException &&
typeof hint.originalException === 'object' &&
LOCAL_VARIABLES_KEY in hint.originalException &&
Array.isArray(hint.originalException[LOCAL_VARIABLES_KEY])
) {
for (const exception of event.exception?.values || []) {
addLocalVariablesToException(exception, hint.originalException[LOCAL_VARIABLES_KEY]);
}

hint.originalException[LOCAL_VARIABLES_KEY] = undefined;
Comment on lines +56 to +67

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in both here and the worker, is it worth adding some kind of debug logging for when the sdk is in debug mode?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can validate it pretty easily by inspecting the event in beforeSend, so I think we don't explicitly need logging for every event, but @timfish if you think it's a good idea go for it.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's also the discussion over whether some of our logging here should be behind debug: true or regular console.*. If we hit rate limiting maybe this should always be logged rather than only when debug is enabled? Users are unlikely to have debug logging enabled in production but it's likely useful to know when you're hitting rate limiting.

}

return event;
Expand All@@ -96,10 +90,6 @@ export const localVariablesAsyncIntegration = defineIntegration(((
worker.terminate();
});

worker.on('message', ({ exceptionHash, frames }) => {
cachedFrames.set(exceptionHash, frames);
});

worker.once('error', (err: Error) => {
log('Worker error', err);
});
Expand DownExpand Up@@ -139,8 +129,8 @@ export const localVariablesAsyncIntegration = defineIntegration(((
},
);
},
processEvent(event: Event): Event {
return addLocalVariablesToEvent(event);
processEvent(event: Event, hint: EventHint): Event {
return addLocalVariablesToEvent(event, hint);
},
};
}) satisfies IntegrationFn);
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Debugger, InspectorNotification, Runtime, Session } from 'node:inspector';
import { defineIntegration, getClient } from '@sentry/core';
import type { Event, Exception, IntegrationFn, StackParser } from '@sentry/types';
import type { Event, Exception, IntegrationFn, StackFrame, StackParser } from '@sentry/types';
import { LRUMap, logger } from '@sentry/utils';

import { NODE_MAJOR } from '../../nodeVersion';
Expand All@@ -12,7 +12,29 @@ import type {
RateLimitIncrement,
Variables,
} from './common';
import { createRateLimiter, functionNamesMatch, hashFrames, hashFromStack } from './common';
import { createRateLimiter, functionNamesMatch } from './common';

/** Creates a unique hash from stack frames */
export function hashFrames(frames: StackFrame[] | undefined): string | undefined {
if (frames === undefined) {
return;
}

// Only hash the 10 most recent frames (ie. the last 10)
return frames.slice(-10).reduce((acc, frame) => `${acc},${frame.function},${frame.lineno},${frame.colno}`, '');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should filter out system frames here, so basically either

  1. pick all the frames (if less than 10)
  2. pick 10 most recent frames (after filtering out system frames)

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code is for the sync debugger has simply been copied from ./common.ts as it's no longer common between the two implementations. I probably should have left it there! The sync debugger has seen no changes other than the moving of this code.

}

/**
* We use the stack parser to create a unique hash from the exception stack trace
* This is used to lookup vars when the exception passes through the event processor
*/
export function hashFromStack(stackParser: StackParser, stack: string | undefined): string | undefined {
if (stack === undefined) {
return undefined;
}

return hashFrames(stackParser(stack, 1));
}

type OnPauseEvent = InspectorNotification<Debugger.PausedEventDataType>;
export interface DebugSession {
Expand Down
48 changes: 29 additions & 19 deletions packages/node/src/integrations/local-variables/worker.ts
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
import type { Debugger, InspectorNotification, Runtime } from 'node:inspector';
import { Session } from 'node:inspector/promises';
import { parentPort, workerData } from 'node:worker_threads';
import type { StackParser } from '@sentry/types';
import { createStackParser, nodeStackLineParser } from '@sentry/utils';
import { createGetModuleFromFilename } from '../../utils/module';
import { workerData } from 'node:worker_threads';
import type { LocalVariablesWorkerArgs, PausedExceptionEvent, RateLimitIncrement, Variables } from './common';
import { createRateLimiter, hashFromStack } from './common';
import { LOCAL_VARIABLES_KEY } from './common';
import { createRateLimiter } from './common';

const options: LocalVariablesWorkerArgs = workerData;

const stackParser = createStackParser(nodeStackLineParser(createGetModuleFromFilename(options.basePath)));

function log(...args: unknown[]): void {
if (options.debug) {
// eslint-disable-next-line no-console
Expand DownExpand Up@@ -88,19 +84,15 @@ let rateLimiter: RateLimitIncrement | undefined;

async function handlePaused(
session: Session,
stackParser: StackParser,
{ reason, data, callFrames }: PausedExceptionEvent,
): Promise<void> {
{ reason, data: { objectId }, callFrames }: PausedExceptionEvent,
): Promise<string | undefined> {
if (reason !== 'exception' && reason !== 'promiseRejection') {
return;
}

rateLimiter?.();

// data.description contains the original error.stack
const exceptionHash = hashFromStack(stackParser, data?.description);

if (exceptionHash == undefined) {
if (objectId == undefined) {
return;
}

Expand All@@ -123,7 +115,15 @@ async function handlePaused(
}
}

parentPort?.postMessage({ exceptionHash, frames });
// We write the local variables to a property on the error object. These can be read by the integration as the error
// event pass through the SDK event pipeline
await session.post('Runtime.callFunctionOn', {
functionDeclaration: `function() { this.${LOCAL_VARIABLES_KEY} = ${JSON.stringify(frames)}; }`,
Comment thread Fixed

Check warning

Code scanning / CodeQL

Improper code sanitization

Code construction depends on an [improperly sanitized value](1).
silent: true,
objectId,
});

return objectId;
}

async function startDebugger(): Promise<void> {
Expand All@@ -141,13 +141,23 @@ async function startDebugger(): Promise<void> {
session.on('Debugger.paused', (event: InspectorNotification<Debugger.PausedEventDataType>) => {
isPaused = true;

handlePaused(session, stackParser, event.params as PausedExceptionEvent).then(
() => {
handlePaused(session, event.params as PausedExceptionEvent).then(
async objectId => {
// After the pause work is complete, resume execution!
return isPaused ? session.post('Debugger.resume') : Promise.resolve();
if (isPaused) {
await session.post('Debugger.resume');
}

if (objectId) {
// The object must be released after the debugger has resumed or we get a memory leak.
// For node v20, setImmediate is enough here but for v22 a longer delay is required
setTimeout(async () => {
await session.post('Runtime.releaseObject', { objectId });
}, 1_000);
}
},
_ => {
// ignore
// ignore any errors
},
);
});
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 6 additions & 23 deletions packages/node/src/integrations/local-variables/common.ts
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
import type { Debugger } from 'node:inspector';
import type { StackFrame, StackParser } from '@sentry/types';

export type Variables = Record<string, unknown>;

export type RateLimitIncrement = () => void;

/**
* The key used to store the local variables on the error object.
*/
export const LOCAL_VARIABLES_KEY = '__SENTRY_ERROR_LOCAL_VARIABLES__';

/**
* Creates a rate limiter that will call the disable callback when the rate limit is reached and the enable callback
* when a timeout has occurred.
Expand DownExpand Up@@ -55,6 +59,7 @@ export type PausedExceptionEvent = Debugger.PausedEventDataType & {
data: {
// This contains error.stack
description: string;
objectId?: string;
};
};

Expand All@@ -68,28 +73,6 @@ export function functionNamesMatch(a: string | undefined, b: string | undefined)
return a === b || (isAnonymous(a) && isAnonymous(b));
}

/** Creates a unique hash from stack frames */
export function hashFrames(frames: StackFrame[] | undefined): string | undefined {
if (frames === undefined) {
return;
}

// Only hash the 10 most recent frames (ie. the last 10)
return frames.slice(-10).reduce((acc, frame) => `${acc},${frame.function},${frame.lineno},${frame.colno}`, '');
}

/**
* We use the stack parser to create a unique hash from the exception stack trace
* This is used to lookup vars when the exception passes through the event processor
*/
export function hashFromStack(stackParser: StackParser, stack: string | undefined): string | undefined {
if (stack === undefined) {
return undefined;
}

return hashFrames(stackParser(stack, 1));
}

export interface FrameVariables {
function: string;
vars?: Variables;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,14 @@ declare module 'node:inspector/promises' {
method: 'Runtime.getProperties',
params: Runtime.GetPropertiesParameterType,
): Promise<Runtime.GetPropertiesReturnType>;
public post(
method: 'Runtime.callFunctionOn',
params: Runtime.CallFunctionOnParameterType,
): Promise<Runtime.CallFunctionOnReturnType>;
public post(
method: 'Runtime.releaseObject',
params: Runtime.ReleaseObjectParameterType,
): Promise<Runtime.ReleaseObjectReturnType>;

public on(
event: 'Debugger.paused',
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
import { Worker } from 'node:worker_threads';
import { defineIntegration } from '@sentry/core';
import type { Event, Exception, IntegrationFn } from '@sentry/types';
import { LRUMap, logger } from '@sentry/utils';
import type { Event, EventHint, Exception, IntegrationFn } from '@sentry/types';
import { logger } from '@sentry/utils';

import type { NodeClient } from '../../sdk/client';
import type { FrameVariables, LocalVariablesIntegrationOptions, LocalVariablesWorkerArgs } from './common';
import { functionNamesMatch, hashFrames } from './common';
import { LOCAL_VARIABLES_KEY } from './common';
import { functionNamesMatch } from './common';

// This string is a placeholder that gets overwritten with the worker code.
export const base64WorkerScript = '###LocalVariablesWorkerScript###';
Expand All@@ -20,23 +21,7 @@ function log(...args: unknown[]): void {
export const localVariablesAsyncIntegration = defineIntegration(((
integrationOptions: LocalVariablesIntegrationOptions = {},
) => {
const cachedFrames: LRUMap<string, FrameVariables[]> = new LRUMap(20);

function addLocalVariablesToException(exception: Exception): void {
const hash = hashFrames(exception?.stacktrace?.frames);

if (hash === undefined) {
return;
}

// Check if we have local variables for an exception that matches the hash
// remove is identical to get but also removes the entry from the cache
const cachedFrame = cachedFrames.remove(hash);

if (cachedFrame === undefined) {
return;
}

function addLocalVariablesToException(exception: Exception, localVariables: FrameVariables[]): void {
// Filter out frames where the function name is `new Promise` since these are in the error.stack frames
// but do not appear in the debugger call frames
const frames = (exception.stacktrace?.frames || []).filter(frame => frame.function !== 'new Promise');
Expand All@@ -45,32 +30,41 @@ export const localVariablesAsyncIntegration = defineIntegration(((
// Sentry frames are in reverse order
const frameIndex = frames.length - i - 1;

const cachedFrameVariable = cachedFrame[i];
const frameVariable = frames[frameIndex];
const frameLocalVariables = localVariables[i];
const frame = frames[frameIndex];

if (!frameVariable || !cachedFrameVariable) {
if (!frame || !frameLocalVariables) {
// Drop out if we run out of frames to match up
break;
}

if (
// We need to have vars to add
cachedFrameVariable.vars === undefined ||
frameLocalVariables.vars === undefined ||
// We're not interested in frames that are not in_app because the vars are not relevant
frameVariable.in_app === false ||
frame.in_app === false ||
// The function names need to match
!functionNamesMatch(frameVariable.function, cachedFrameVariable.function)
!functionNamesMatch(frame.function, frameLocalVariables.function)
) {
continue;
}

frameVariable.vars = cachedFrameVariable.vars;
frame.vars = frameLocalVariables.vars;
}
}

function addLocalVariablesToEvent(event: Event): Event {
for (const exception of event.exception?.values || []) {
addLocalVariablesToException(exception);
function addLocalVariablesToEvent(event: Event, hint: EventHint): Event {
if (
hint.originalException &&
typeof hint.originalException === 'object' &&
LOCAL_VARIABLES_KEY in hint.originalException &&
Array.isArray(hint.originalException[LOCAL_VARIABLES_KEY])
) {
for (const exception of event.exception?.values || []) {
addLocalVariablesToException(exception, hint.originalException[LOCAL_VARIABLES_KEY]);
}

hint.originalException[LOCAL_VARIABLES_KEY] = undefined;
Comment on lines +56 to +67

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in both here and the worker, is it worth adding some kind of debug logging for when the sdk is in debug mode?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can validate it pretty easily by inspecting the event in beforeSend, so I think we don't explicitly need logging for every event, but @timfish if you think it's a good idea go for it.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's also the discussion over whether some of our logging here should be behind debug: true or regular console.*. If we hit rate limiting maybe this should always be logged rather than only when debug is enabled? Users are unlikely to have debug logging enabled in production but it's likely useful to know when you're hitting rate limiting.

}

return event;
Expand All@@ -96,10 +90,6 @@ export const localVariablesAsyncIntegration = defineIntegration(((
worker.terminate();
});

worker.on('message', ({ exceptionHash, frames }) => {
cachedFrames.set(exceptionHash, frames);
});

worker.once('error', (err: Error) => {
log('Worker error', err);
});
Expand DownExpand Up@@ -139,8 +129,8 @@ export const localVariablesAsyncIntegration = defineIntegration(((
},
);
},
processEvent(event: Event): Event {
return addLocalVariablesToEvent(event);
processEvent(event: Event, hint: EventHint): Event {
return addLocalVariablesToEvent(event, hint);
},
};
}) satisfies IntegrationFn);
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Debugger, InspectorNotification, Runtime, Session } from 'node:inspector';
import { defineIntegration, getClient } from '@sentry/core';
import type { Event, Exception, IntegrationFn, StackParser } from '@sentry/types';
import type { Event, Exception, IntegrationFn, StackFrame, StackParser } from '@sentry/types';
import { LRUMap, logger } from '@sentry/utils';

import { NODE_MAJOR } from '../../nodeVersion';
Expand All@@ -12,7 +12,29 @@ import type {
RateLimitIncrement,
Variables,
} from './common';
import { createRateLimiter, functionNamesMatch, hashFrames, hashFromStack } from './common';
import { createRateLimiter, functionNamesMatch } from './common';

/** Creates a unique hash from stack frames */
export function hashFrames(frames: StackFrame[] | undefined): string | undefined {
if (frames === undefined) {
return;
}

// Only hash the 10 most recent frames (ie. the last 10)
return frames.slice(-10).reduce((acc, frame) => `${acc},${frame.function},${frame.lineno},${frame.colno}`, '');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should filter out system frames here, so basically either

  1. pick all the frames (if less than 10)
  2. pick 10 most recent frames (after filtering out system frames)

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code is for the sync debugger has simply been copied from ./common.ts as it's no longer common between the two implementations. I probably should have left it there! The sync debugger has seen no changes other than the moving of this code.

}

/**
* We use the stack parser to create a unique hash from the exception stack trace
* This is used to lookup vars when the exception passes through the event processor
*/
export function hashFromStack(stackParser: StackParser, stack: string | undefined): string | undefined {
if (stack === undefined) {
return undefined;
}

return hashFrames(stackParser(stack, 1));
}

type OnPauseEvent = InspectorNotification<Debugger.PausedEventDataType>;
export interface DebugSession {
Expand Down
48 changes: 29 additions & 19 deletions packages/node/src/integrations/local-variables/worker.ts
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
import type { Debugger, InspectorNotification, Runtime } from 'node:inspector';
import { Session } from 'node:inspector/promises';
import { parentPort, workerData } from 'node:worker_threads';
import type { StackParser } from '@sentry/types';
import { createStackParser, nodeStackLineParser } from '@sentry/utils';
import { createGetModuleFromFilename } from '../../utils/module';
import { workerData } from 'node:worker_threads';
import type { LocalVariablesWorkerArgs, PausedExceptionEvent, RateLimitIncrement, Variables } from './common';
import { createRateLimiter, hashFromStack } from './common';
import { LOCAL_VARIABLES_KEY } from './common';
import { createRateLimiter } from './common';

const options: LocalVariablesWorkerArgs = workerData;

const stackParser = createStackParser(nodeStackLineParser(createGetModuleFromFilename(options.basePath)));

function log(...args: unknown[]): void {
if (options.debug) {
// eslint-disable-next-line no-console
Expand DownExpand Up@@ -88,19 +84,15 @@ let rateLimiter: RateLimitIncrement | undefined;

async function handlePaused(
session: Session,
stackParser: StackParser,
{ reason, data, callFrames }: PausedExceptionEvent,
): Promise<void> {
{ reason, data: { objectId }, callFrames }: PausedExceptionEvent,
): Promise<string | undefined> {
if (reason !== 'exception' && reason !== 'promiseRejection') {
return;
}

rateLimiter?.();

// data.description contains the original error.stack
const exceptionHash = hashFromStack(stackParser, data?.description);

if (exceptionHash == undefined) {
if (objectId == undefined) {
return;
}

Expand All@@ -123,7 +115,15 @@ async function handlePaused(
}
}

parentPort?.postMessage({ exceptionHash, frames });
// We write the local variables to a property on the error object. These can be read by the integration as the error
// event pass through the SDK event pipeline
await session.post('Runtime.callFunctionOn', {
functionDeclaration: `function() { this.${LOCAL_VARIABLES_KEY} = ${JSON.stringify(frames)}; }`,
Comment thread Fixed

Check warning

Code scanning / CodeQL

Improper code sanitization

Code construction depends on an [improperly sanitized value](1).
silent: true,
objectId,
});

return objectId;
}

async function startDebugger(): Promise<void> {
Expand All@@ -141,13 +141,23 @@ async function startDebugger(): Promise<void> {
session.on('Debugger.paused', (event: InspectorNotification<Debugger.PausedEventDataType>) => {
isPaused = true;

handlePaused(session, stackParser, event.params as PausedExceptionEvent).then(
() => {
handlePaused(session, event.params as PausedExceptionEvent).then(
async objectId => {
// After the pause work is complete, resume execution!
return isPaused ? session.post('Debugger.resume') : Promise.resolve();
if (isPaused) {
await session.post('Debugger.resume');
}

if (objectId) {
// The object must be released after the debugger has resumed or we get a memory leak.
// For node v20, setImmediate is enough here but for v22 a longer delay is required
setTimeout(async () => {
await session.post('Runtime.releaseObject', { objectId });
}, 1_000);
}
},
_ => {
// ignore
// ignore any errors
},
);
});
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 6 additions & 23 deletions packages/node/src/integrations/local-variables/common.ts
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
import type { Debugger } from 'node:inspector';
import type { StackFrame, StackParser } from '@sentry/types';

export type Variables = Record<string, unknown>;

export type RateLimitIncrement = () => void;

/**
* The key used to store the local variables on the error object.
*/
export const LOCAL_VARIABLES_KEY = '__SENTRY_ERROR_LOCAL_VARIABLES__';

/**
* Creates a rate limiter that will call the disable callback when the rate limit is reached and the enable callback
* when a timeout has occurred.
Expand DownExpand Up@@ -55,6 +59,7 @@ export type PausedExceptionEvent = Debugger.PausedEventDataType & {
data: {
// This contains error.stack
description: string;
objectId?: string;
};
};

Expand All@@ -68,28 +73,6 @@ export function functionNamesMatch(a: string | undefined, b: string | undefined)
return a === b || (isAnonymous(a) && isAnonymous(b));
}

/** Creates a unique hash from stack frames */
export function hashFrames(frames: StackFrame[] | undefined): string | undefined {
if (frames === undefined) {
return;
}

// Only hash the 10 most recent frames (ie. the last 10)
return frames.slice(-10).reduce((acc, frame) => `${acc},${frame.function},${frame.lineno},${frame.colno}`, '');
}

/**
* We use the stack parser to create a unique hash from the exception stack trace
* This is used to lookup vars when the exception passes through the event processor
*/
export function hashFromStack(stackParser: StackParser, stack: string | undefined): string | undefined {
if (stack === undefined) {
return undefined;
}

return hashFrames(stackParser(stack, 1));
}

export interface FrameVariables {
function: string;
vars?: Variables;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,14 @@ declare module 'node:inspector/promises' {
method: 'Runtime.getProperties',
params: Runtime.GetPropertiesParameterType,
): Promise<Runtime.GetPropertiesReturnType>;
public post(
method: 'Runtime.callFunctionOn',
params: Runtime.CallFunctionOnParameterType,
): Promise<Runtime.CallFunctionOnReturnType>;
public post(
method: 'Runtime.releaseObject',
params: Runtime.ReleaseObjectParameterType,
): Promise<Runtime.ReleaseObjectReturnType>;

public on(
event: 'Debugger.paused',
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
import { Worker } from 'node:worker_threads';
import { defineIntegration } from '@sentry/core';
import type { Event, Exception, IntegrationFn } from '@sentry/types';
import { LRUMap, logger } from '@sentry/utils';
import type { Event, EventHint, Exception, IntegrationFn } from '@sentry/types';
import { logger } from '@sentry/utils';

import type { NodeClient } from '../../sdk/client';
import type { FrameVariables, LocalVariablesIntegrationOptions, LocalVariablesWorkerArgs } from './common';
import { functionNamesMatch, hashFrames } from './common';
import { LOCAL_VARIABLES_KEY } from './common';
import { functionNamesMatch } from './common';

// This string is a placeholder that gets overwritten with the worker code.
export const base64WorkerScript = '###LocalVariablesWorkerScript###';
Expand All@@ -20,23 +21,7 @@ function log(...args: unknown[]): void {
export const localVariablesAsyncIntegration = defineIntegration(((
integrationOptions: LocalVariablesIntegrationOptions = {},
) => {
const cachedFrames: LRUMap<string, FrameVariables[]> = new LRUMap(20);

function addLocalVariablesToException(exception: Exception): void {
const hash = hashFrames(exception?.stacktrace?.frames);

if (hash === undefined) {
return;
}

// Check if we have local variables for an exception that matches the hash
// remove is identical to get but also removes the entry from the cache
const cachedFrame = cachedFrames.remove(hash);

if (cachedFrame === undefined) {
return;
}

function addLocalVariablesToException(exception: Exception, localVariables: FrameVariables[]): void {
// Filter out frames where the function name is `new Promise` since these are in the error.stack frames
// but do not appear in the debugger call frames
const frames = (exception.stacktrace?.frames || []).filter(frame => frame.function !== 'new Promise');
Expand All@@ -45,32 +30,41 @@ export const localVariablesAsyncIntegration = defineIntegration(((
// Sentry frames are in reverse order
const frameIndex = frames.length - i - 1;

const cachedFrameVariable = cachedFrame[i];
const frameVariable = frames[frameIndex];
const frameLocalVariables = localVariables[i];
const frame = frames[frameIndex];

if (!frameVariable || !cachedFrameVariable) {
if (!frame || !frameLocalVariables) {
// Drop out if we run out of frames to match up
break;
}

if (
// We need to have vars to add
cachedFrameVariable.vars === undefined ||
frameLocalVariables.vars === undefined ||
// We're not interested in frames that are not in_app because the vars are not relevant
frameVariable.in_app === false ||
frame.in_app === false ||
// The function names need to match
!functionNamesMatch(frameVariable.function, cachedFrameVariable.function)
!functionNamesMatch(frame.function, frameLocalVariables.function)
) {
continue;
}

frameVariable.vars = cachedFrameVariable.vars;
frame.vars = frameLocalVariables.vars;
}
}

function addLocalVariablesToEvent(event: Event): Event {
for (const exception of event.exception?.values || []) {
addLocalVariablesToException(exception);
function addLocalVariablesToEvent(event: Event, hint: EventHint): Event {
if (
hint.originalException &&
typeof hint.originalException === 'object' &&
LOCAL_VARIABLES_KEY in hint.originalException &&
Array.isArray(hint.originalException[LOCAL_VARIABLES_KEY])
) {
for (const exception of event.exception?.values || []) {
addLocalVariablesToException(exception, hint.originalException[LOCAL_VARIABLES_KEY]);
}

hint.originalException[LOCAL_VARIABLES_KEY] = undefined;
Comment on lines +56 to +67

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in both here and the worker, is it worth adding some kind of debug logging for when the sdk is in debug mode?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can validate it pretty easily by inspecting the event in beforeSend, so I think we don't explicitly need logging for every event, but @timfish if you think it's a good idea go for it.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's also the discussion over whether some of our logging here should be behind debug: true or regular console.*. If we hit rate limiting maybe this should always be logged rather than only when debug is enabled? Users are unlikely to have debug logging enabled in production but it's likely useful to know when you're hitting rate limiting.

}

return event;
Expand All@@ -96,10 +90,6 @@ export const localVariablesAsyncIntegration = defineIntegration(((
worker.terminate();
});

worker.on('message', ({ exceptionHash, frames }) => {
cachedFrames.set(exceptionHash, frames);
});

worker.once('error', (err: Error) => {
log('Worker error', err);
});
Expand DownExpand Up@@ -139,8 +129,8 @@ export const localVariablesAsyncIntegration = defineIntegration(((
},
);
},
processEvent(event: Event): Event {
return addLocalVariablesToEvent(event);
processEvent(event: Event, hint: EventHint): Event {
return addLocalVariablesToEvent(event, hint);
},
};
}) satisfies IntegrationFn);
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Debugger, InspectorNotification, Runtime, Session } from 'node:inspector';
import { defineIntegration, getClient } from '@sentry/core';
import type { Event, Exception, IntegrationFn, StackParser } from '@sentry/types';
import type { Event, Exception, IntegrationFn, StackFrame, StackParser } from '@sentry/types';
import { LRUMap, logger } from '@sentry/utils';

import { NODE_MAJOR } from '../../nodeVersion';
Expand All@@ -12,7 +12,29 @@ import type {
RateLimitIncrement,
Variables,
} from './common';
import { createRateLimiter, functionNamesMatch, hashFrames, hashFromStack } from './common';
import { createRateLimiter, functionNamesMatch } from './common';

/** Creates a unique hash from stack frames */
export function hashFrames(frames: StackFrame[] | undefined): string | undefined {
if (frames === undefined) {
return;
}

// Only hash the 10 most recent frames (ie. the last 10)
return frames.slice(-10).reduce((acc, frame) => `${acc},${frame.function},${frame.lineno},${frame.colno}`, '');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should filter out system frames here, so basically either

  1. pick all the frames (if less than 10)
  2. pick 10 most recent frames (after filtering out system frames)

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code is for the sync debugger has simply been copied from ./common.ts as it's no longer common between the two implementations. I probably should have left it there! The sync debugger has seen no changes other than the moving of this code.

}

/**
* We use the stack parser to create a unique hash from the exception stack trace
* This is used to lookup vars when the exception passes through the event processor
*/
export function hashFromStack(stackParser: StackParser, stack: string | undefined): string | undefined {
if (stack === undefined) {
return undefined;
}

return hashFrames(stackParser(stack, 1));
}

type OnPauseEvent = InspectorNotification<Debugger.PausedEventDataType>;
export interface DebugSession {
Expand Down
48 changes: 29 additions & 19 deletions packages/node/src/integrations/local-variables/worker.ts
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
import type { Debugger, InspectorNotification, Runtime } from 'node:inspector';
import { Session } from 'node:inspector/promises';
import { parentPort, workerData } from 'node:worker_threads';
import type { StackParser } from '@sentry/types';
import { createStackParser, nodeStackLineParser } from '@sentry/utils';
import { createGetModuleFromFilename } from '../../utils/module';
import { workerData } from 'node:worker_threads';
import type { LocalVariablesWorkerArgs, PausedExceptionEvent, RateLimitIncrement, Variables } from './common';
import { createRateLimiter, hashFromStack } from './common';
import { LOCAL_VARIABLES_KEY } from './common';
import { createRateLimiter } from './common';

const options: LocalVariablesWorkerArgs = workerData;

const stackParser = createStackParser(nodeStackLineParser(createGetModuleFromFilename(options.basePath)));

function log(...args: unknown[]): void {
if (options.debug) {
// eslint-disable-next-line no-console
Expand DownExpand Up@@ -88,19 +84,15 @@ let rateLimiter: RateLimitIncrement | undefined;

async function handlePaused(
session: Session,
stackParser: StackParser,
{ reason, data, callFrames }: PausedExceptionEvent,
): Promise<void> {
{ reason, data: { objectId }, callFrames }: PausedExceptionEvent,
): Promise<string | undefined> {
if (reason !== 'exception' && reason !== 'promiseRejection') {
return;
}

rateLimiter?.();

// data.description contains the original error.stack
const exceptionHash = hashFromStack(stackParser, data?.description);

if (exceptionHash == undefined) {
if (objectId == undefined) {
return;
}

Expand All@@ -123,7 +115,15 @@ async function handlePaused(
}
}

parentPort?.postMessage({ exceptionHash, frames });
// We write the local variables to a property on the error object. These can be read by the integration as the error
// event pass through the SDK event pipeline
await session.post('Runtime.callFunctionOn', {
functionDeclaration: `function() { this.${LOCAL_VARIABLES_KEY} = ${JSON.stringify(frames)}; }`,
Comment thread Fixed

Check warning

Code scanning / CodeQL

Improper code sanitization

Code construction depends on an [improperly sanitized value](1).
silent: true,
objectId,
});

return objectId;
}

async function startDebugger(): Promise<void> {
Expand All@@ -141,13 +141,23 @@ async function startDebugger(): Promise<void> {
session.on('Debugger.paused', (event: InspectorNotification<Debugger.PausedEventDataType>) => {
isPaused = true;

handlePaused(session, stackParser, event.params as PausedExceptionEvent).then(
() => {
handlePaused(session, event.params as PausedExceptionEvent).then(
async objectId => {
// After the pause work is complete, resume execution!
return isPaused ? session.post('Debugger.resume') : Promise.resolve();
if (isPaused) {
await session.post('Debugger.resume');
}

if (objectId) {
// The object must be released after the debugger has resumed or we get a memory leak.
// For node v20, setImmediate is enough here but for v22 a longer delay is required
setTimeout(async () => {
await session.post('Runtime.releaseObject', { objectId });
}, 1_000);
}
},
_ => {
// ignore
// ignore any errors
},
);
});
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 6 additions & 23 deletions packages/node/src/integrations/local-variables/common.ts
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
import type { Debugger } from 'node:inspector';
import type { StackFrame, StackParser } from '@sentry/types';

export type Variables = Record<string, unknown>;

export type RateLimitIncrement = () => void;

/**
* The key used to store the local variables on the error object.
*/
export const LOCAL_VARIABLES_KEY = '__SENTRY_ERROR_LOCAL_VARIABLES__';

/**
* Creates a rate limiter that will call the disable callback when the rate limit is reached and the enable callback
* when a timeout has occurred.
Expand DownExpand Up@@ -55,6 +59,7 @@ export type PausedExceptionEvent = Debugger.PausedEventDataType & {
data: {
// This contains error.stack
description: string;
objectId?: string;
};
};

Expand All@@ -68,28 +73,6 @@ export function functionNamesMatch(a: string | undefined, b: string | undefined)
return a === b || (isAnonymous(a) && isAnonymous(b));
}

/** Creates a unique hash from stack frames */
export function hashFrames(frames: StackFrame[] | undefined): string | undefined {
if (frames === undefined) {
return;
}

// Only hash the 10 most recent frames (ie. the last 10)
return frames.slice(-10).reduce((acc, frame) => `${acc},${frame.function},${frame.lineno},${frame.colno}`, '');
}

/**
* We use the stack parser to create a unique hash from the exception stack trace
* This is used to lookup vars when the exception passes through the event processor
*/
export function hashFromStack(stackParser: StackParser, stack: string | undefined): string | undefined {
if (stack === undefined) {
return undefined;
}

return hashFrames(stackParser(stack, 1));
}

export interface FrameVariables {
function: string;
vars?: Variables;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,14 @@ declare module 'node:inspector/promises' {
method: 'Runtime.getProperties',
params: Runtime.GetPropertiesParameterType,
): Promise<Runtime.GetPropertiesReturnType>;
public post(
method: 'Runtime.callFunctionOn',
params: Runtime.CallFunctionOnParameterType,
): Promise<Runtime.CallFunctionOnReturnType>;
public post(
method: 'Runtime.releaseObject',
params: Runtime.ReleaseObjectParameterType,
): Promise<Runtime.ReleaseObjectReturnType>;

public on(
event: 'Debugger.paused',
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
import { Worker } from 'node:worker_threads';
import { defineIntegration } from '@sentry/core';
import type { Event, Exception, IntegrationFn } from '@sentry/types';
import { LRUMap, logger } from '@sentry/utils';
import type { Event, EventHint, Exception, IntegrationFn } from '@sentry/types';
import { logger } from '@sentry/utils';

import type { NodeClient } from '../../sdk/client';
import type { FrameVariables, LocalVariablesIntegrationOptions, LocalVariablesWorkerArgs } from './common';
import { functionNamesMatch, hashFrames } from './common';
import { LOCAL_VARIABLES_KEY } from './common';
import { functionNamesMatch } from './common';

// This string is a placeholder that gets overwritten with the worker code.
export const base64WorkerScript = '###LocalVariablesWorkerScript###';
Expand All@@ -20,23 +21,7 @@ function log(...args: unknown[]): void {
export const localVariablesAsyncIntegration = defineIntegration(((
integrationOptions: LocalVariablesIntegrationOptions = {},
) => {
const cachedFrames: LRUMap<string, FrameVariables[]> = new LRUMap(20);

function addLocalVariablesToException(exception: Exception): void {
const hash = hashFrames(exception?.stacktrace?.frames);

if (hash === undefined) {
return;
}

// Check if we have local variables for an exception that matches the hash
// remove is identical to get but also removes the entry from the cache
const cachedFrame = cachedFrames.remove(hash);

if (cachedFrame === undefined) {
return;
}

function addLocalVariablesToException(exception: Exception, localVariables: FrameVariables[]): void {
// Filter out frames where the function name is `new Promise` since these are in the error.stack frames
// but do not appear in the debugger call frames
const frames = (exception.stacktrace?.frames || []).filter(frame => frame.function !== 'new Promise');
Expand All@@ -45,32 +30,41 @@ export const localVariablesAsyncIntegration = defineIntegration(((
// Sentry frames are in reverse order
const frameIndex = frames.length - i - 1;

const cachedFrameVariable = cachedFrame[i];
const frameVariable = frames[frameIndex];
const frameLocalVariables = localVariables[i];
const frame = frames[frameIndex];

if (!frameVariable || !cachedFrameVariable) {
if (!frame || !frameLocalVariables) {
// Drop out if we run out of frames to match up
break;
}

if (
// We need to have vars to add
cachedFrameVariable.vars === undefined ||
frameLocalVariables.vars === undefined ||
// We're not interested in frames that are not in_app because the vars are not relevant
frameVariable.in_app === false ||
frame.in_app === false ||
// The function names need to match
!functionNamesMatch(frameVariable.function, cachedFrameVariable.function)
!functionNamesMatch(frame.function, frameLocalVariables.function)
) {
continue;
}

frameVariable.vars = cachedFrameVariable.vars;
frame.vars = frameLocalVariables.vars;
}
}

function addLocalVariablesToEvent(event: Event): Event {
for (const exception of event.exception?.values || []) {
addLocalVariablesToException(exception);
function addLocalVariablesToEvent(event: Event, hint: EventHint): Event {
if (
hint.originalException &&
typeof hint.originalException === 'object' &&
LOCAL_VARIABLES_KEY in hint.originalException &&
Array.isArray(hint.originalException[LOCAL_VARIABLES_KEY])
) {
for (const exception of event.exception?.values || []) {
addLocalVariablesToException(exception, hint.originalException[LOCAL_VARIABLES_KEY]);
}

hint.originalException[LOCAL_VARIABLES_KEY] = undefined;
Comment on lines +56 to +67

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in both here and the worker, is it worth adding some kind of debug logging for when the sdk is in debug mode?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can validate it pretty easily by inspecting the event in beforeSend, so I think we don't explicitly need logging for every event, but @timfish if you think it's a good idea go for it.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's also the discussion over whether some of our logging here should be behind debug: true or regular console.*. If we hit rate limiting maybe this should always be logged rather than only when debug is enabled? Users are unlikely to have debug logging enabled in production but it's likely useful to know when you're hitting rate limiting.

}

return event;
Expand All@@ -96,10 +90,6 @@ export const localVariablesAsyncIntegration = defineIntegration(((
worker.terminate();
});

worker.on('message', ({ exceptionHash, frames }) => {
cachedFrames.set(exceptionHash, frames);
});

worker.once('error', (err: Error) => {
log('Worker error', err);
});
Expand DownExpand Up@@ -139,8 +129,8 @@ export const localVariablesAsyncIntegration = defineIntegration(((
},
);
},
processEvent(event: Event): Event {
return addLocalVariablesToEvent(event);
processEvent(event: Event, hint: EventHint): Event {
return addLocalVariablesToEvent(event, hint);
},
};
}) satisfies IntegrationFn);
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Debugger, InspectorNotification, Runtime, Session } from 'node:inspector';
import { defineIntegration, getClient } from '@sentry/core';
import type { Event, Exception, IntegrationFn, StackParser } from '@sentry/types';
import type { Event, Exception, IntegrationFn, StackFrame, StackParser } from '@sentry/types';
import { LRUMap, logger } from '@sentry/utils';

import { NODE_MAJOR } from '../../nodeVersion';
Expand All@@ -12,7 +12,29 @@ import type {
RateLimitIncrement,
Variables,
} from './common';
import { createRateLimiter, functionNamesMatch, hashFrames, hashFromStack } from './common';
import { createRateLimiter, functionNamesMatch } from './common';

/** Creates a unique hash from stack frames */
export function hashFrames(frames: StackFrame[] | undefined): string | undefined {
if (frames === undefined) {
return;
}

// Only hash the 10 most recent frames (ie. the last 10)
return frames.slice(-10).reduce((acc, frame) => `${acc},${frame.function},${frame.lineno},${frame.colno}`, '');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should filter out system frames here, so basically either

  1. pick all the frames (if less than 10)
  2. pick 10 most recent frames (after filtering out system frames)

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code is for the sync debugger has simply been copied from ./common.ts as it's no longer common between the two implementations. I probably should have left it there! The sync debugger has seen no changes other than the moving of this code.

}

/**
* We use the stack parser to create a unique hash from the exception stack trace
* This is used to lookup vars when the exception passes through the event processor
*/
export function hashFromStack(stackParser: StackParser, stack: string | undefined): string | undefined {
if (stack === undefined) {
return undefined;
}

return hashFrames(stackParser(stack, 1));
}

type OnPauseEvent = InspectorNotification<Debugger.PausedEventDataType>;
export interface DebugSession {
Expand Down
48 changes: 29 additions & 19 deletions packages/node/src/integrations/local-variables/worker.ts
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
import type { Debugger, InspectorNotification, Runtime } from 'node:inspector';
import { Session } from 'node:inspector/promises';
import { parentPort, workerData } from 'node:worker_threads';
import type { StackParser } from '@sentry/types';
import { createStackParser, nodeStackLineParser } from '@sentry/utils';
import { createGetModuleFromFilename } from '../../utils/module';
import { workerData } from 'node:worker_threads';
import type { LocalVariablesWorkerArgs, PausedExceptionEvent, RateLimitIncrement, Variables } from './common';
import { createRateLimiter, hashFromStack } from './common';
import { LOCAL_VARIABLES_KEY } from './common';
import { createRateLimiter } from './common';

const options: LocalVariablesWorkerArgs = workerData;

const stackParser = createStackParser(nodeStackLineParser(createGetModuleFromFilename(options.basePath)));

function log(...args: unknown[]): void {
if (options.debug) {
// eslint-disable-next-line no-console
Expand DownExpand Up@@ -88,19 +84,15 @@ let rateLimiter: RateLimitIncrement | undefined;

async function handlePaused(
session: Session,
stackParser: StackParser,
{ reason, data, callFrames }: PausedExceptionEvent,
): Promise<void> {
{ reason, data: { objectId }, callFrames }: PausedExceptionEvent,
): Promise<string | undefined> {
if (reason !== 'exception' && reason !== 'promiseRejection') {
return;
}

rateLimiter?.();

// data.description contains the original error.stack
const exceptionHash = hashFromStack(stackParser, data?.description);

if (exceptionHash == undefined) {
if (objectId == undefined) {
return;
}

Expand All@@ -123,7 +115,15 @@ async function handlePaused(
}
}

parentPort?.postMessage({ exceptionHash, frames });
// We write the local variables to a property on the error object. These can be read by the integration as the error
// event pass through the SDK event pipeline
await session.post('Runtime.callFunctionOn', {
functionDeclaration: `function() { this.${LOCAL_VARIABLES_KEY} = ${JSON.stringify(frames)}; }`,
Comment thread Fixed

Check warning

Code scanning / CodeQL

Improper code sanitization

Code construction depends on an [improperly sanitized value](1).
silent: true,
objectId,
});

return objectId;
}

async function startDebugger(): Promise<void> {
Expand All@@ -141,13 +141,23 @@ async function startDebugger(): Promise<void> {
session.on('Debugger.paused', (event: InspectorNotification<Debugger.PausedEventDataType>) => {
isPaused = true;

handlePaused(session, stackParser, event.params as PausedExceptionEvent).then(
() => {
handlePaused(session, event.params as PausedExceptionEvent).then(
async objectId => {
// After the pause work is complete, resume execution!
return isPaused ? session.post('Debugger.resume') : Promise.resolve();
if (isPaused) {
await session.post('Debugger.resume');
}

if (objectId) {
// The object must be released after the debugger has resumed or we get a memory leak.
// For node v20, setImmediate is enough here but for v22 a longer delay is required
setTimeout(async () => {
await session.post('Runtime.releaseObject', { objectId });
}, 1_000);
}
},
_ => {
// ignore
// ignore any errors
},
);
});
Expand Down