Skip to content

feat: Use dataCollection.frameContextLines for ContextLines integration #21323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
s1gr1d wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

feat: Use dataCollection.frameContextLines for ContextLines integration #21323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f7e4be9
feat: Use `dataCollection.frameContextLines` for ContextLines integra…
s1gr1d Jun 3, 2026
144b64a
change default to 7 lines
s1gr1d Jun 3, 2026
58b0b3c
update test
s1gr1d Jun 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions packages/browser/src/integrations/contextlines.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,25 @@ const DEFAULT_LINES_OF_CONTEXT = 7;

const INTEGRATION_NAME = 'ContextLines';

// TODO(v11): Use `dataCollection.frameContextLines` default (5)
interface ContextLinesOptions {
/**
* Sets the number of context lines for each frame when loading a file.
* Defaults to 7.
*
* Set to 0 to disable loading and inclusion of source files.
*
* When set, this option takes precedence over `dataCollection.frameContextLines`.
**/
frameContextLines?: number;
}

const _contextLinesIntegration = ((options: ContextLinesOptions = {}) => {
const contextLines = options.frameContextLines != null ? options.frameContextLines : DEFAULT_LINES_OF_CONTEXT;

return {
name: INTEGRATION_NAME,
processEvent(event) {
processEvent(event, _hint, client) {
const contextLines =
options.frameContextLines ?? client?.getDataCollectionOptions().frameContextLines ?? DEFAULT_LINES_OF_CONTEXT;
return addSourceContext(event, contextLines);
},
};
Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/utils/data-collection/defaultPiiToCollectionOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export function defaultPiiToCollectionOptions(sendDefaultPii?: boolean): Resolve
queryParams: true,
genAI: { inputs: true, outputs: true },
stackFrameVariables: true,
frameContextLines: 5,
frameContextLines: 7, // default should be 5, but ContextLines integration uses 7
Comment thread
sentry[bot] marked this conversation as resolved.
}
: {
userInfo: false,
Expand All @@ -24,6 +24,6 @@ export function defaultPiiToCollectionOptions(sendDefaultPii?: boolean): Resolve
queryParams: { deny: PII_HEADER_SNIPPETS },
genAI: { inputs: false, outputs: false },
stackFrameVariables: true,
frameContextLines: 5,
frameContextLines: 7, // default should be 5, but ContextLines integration uses 7
};
}
8 changes: 4 additions & 4 deletions packages/core/test/lib/utils/data-collection/defaultPiiToCollectionOptions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ describe('defaultPiiToCollectionOptions', () => {
queryParams: true,
genAI: { inputs: true, outputs: true },
stackFrameVariables: true,
frameContextLines: 5,
frameContextLines: 7,
});
});

Expand All @@ -27,7 +27,7 @@ describe('defaultPiiToCollectionOptions', () => {
queryParams: { deny: ['forwarded', '-ip', 'remote-', 'via', '-user'] },
genAI: { inputs: false, outputs: false },
stackFrameVariables: true,
frameContextLines: 5,
frameContextLines: 7,
});
});

Expand All @@ -43,7 +43,7 @@ describe('defaultPiiToCollectionOptions', () => {
queryParams: { deny: ['forwarded', '-ip', 'remote-', 'via', '-user'] },
genAI: { inputs: false, outputs: false },
stackFrameVariables: true,
frameContextLines: 5,
frameContextLines: 7,
});
});

Expand All @@ -59,7 +59,7 @@ describe('defaultPiiToCollectionOptions', () => {
queryParams: { deny: ['forwarded', '-ip', 'remote-', 'via', '-user'] },
genAI: { inputs: false, outputs: false },
stackFrameVariables: true,
frameContextLines: 5,
frameContextLines: 7,
});
});
});
2 changes: 1 addition & 1 deletion packages/core/test/lib/utils/data-collection/resolveDataCollectionOptions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ describe('resolveDataCollectionOptions', () => {
expect(result.httpBodies).toEqual([]);
expect(result.genAI).toEqual({ inputs: false, outputs: false });
expect(result.stackFrameVariables).toBe(true);
expect(result.frameContextLines).toBe(5);
expect(result.frameContextLines).toBe(7);
});

it('returns spec defaults when dataCollection is explicitly set to empty object', () => {
Expand Down
11 changes: 7 additions & 4 deletions packages/deno/src/integrations/contextlines.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,22 +36,25 @@ async function readSourceFile(filename: string): Promise<string | null> {
return content;
}

// TODO(v11): Use `dataCollection.frameContextLines` default (5)
interface ContextLinesOptions {
/**
* Sets the number of context lines for each frame when loading a file.
* Defaults to 7.
*
* Set to 0 to disable loading and inclusion of source files.
*/
*
* When set, this option takes precedence over `dataCollection.frameContextLines`.
**/
frameContextLines?: number;
}

const _contextLinesIntegration = ((options: ContextLinesOptions = {}) => {
const contextLines = options.frameContextLines !== undefined ? options.frameContextLines : DEFAULT_LINES_OF_CONTEXT;

return {
name: INTEGRATION_NAME,
processEvent(event) {
processEvent(event, _hint, client) {
const contextLines =
options.frameContextLines ?? client?.getDataCollectionOptions().frameContextLines ?? DEFAULT_LINES_OF_CONTEXT;
return addSourceContext(event, contextLines);
},
};
Expand Down
9 changes: 6 additions & 3 deletions packages/node-core/src/integrations/contextlines.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,15 @@ const INTEGRATION_NAME = 'ContextLines';
export const MAX_CONTEXTLINES_COLNO: number = 1000;
export const MAX_CONTEXTLINES_LINENO: number = 10000;

// TODO(v11): Use `dataCollection.frameContextLines` default (5)
interface ContextLinesOptions {
/**
* Sets the number of context lines for each frame when loading a file.
* Defaults to 7.
*
* Set to 0 to disable loading and inclusion of source files.
*
* When set, this option takes precedence over `dataCollection.frameContextLines`.
**/
frameContextLines?: number;
}
Expand Down Expand Up @@ -398,11 +401,11 @@ function makeContextRange(line: number, linecontext: number): [start: number, en

/** Exported only for tests, as a type-safe variant. */
export const _contextLinesIntegration = ((options: ContextLinesOptions = {}) => {
const contextLines = options.frameContextLines !== undefined ? options.frameContextLines : DEFAULT_LINES_OF_CONTEXT;

return {
name: INTEGRATION_NAME,
processEvent(event) {
processEvent(event, _hint, client) {
const contextLines =
options.frameContextLines ?? client?.getDataCollectionOptions().frameContextLines ?? DEFAULT_LINES_OF_CONTEXT;
return addSourceContext(event, contextLines);
},
};
Expand Down
52 changes: 52 additions & 0 deletions packages/node-core/test/integrations/contextlines.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,4 +231,56 @@ describe('ContextLines', () => {
expect(readStreamSpy).not.toHaveBeenCalled();
});
});

describe('dataCollection.frameContextLines', () => {
function clientWithFrameContextLines(frameContextLines: number) {
return {
getDataCollectionOptions: () => ({ frameContextLines }),
} as unknown as Parameters<NonNullable<typeof contextLines.processEvent>>[2];
}

test('uses dataCollection.frameContextLines when no integration option is set', async () => {
contextLines = _contextLinesIntegration();
const frames = parseStackFrames(defaultStackParser, new Error('test'));

await contextLines.processEvent(
{ exception: { values: [{ stacktrace: { frames } }] } },
{},
clientWithFrameContextLines(2),
);

const frame = frames.find(f => f.context_line !== undefined);
expect(frame?.pre_context).toHaveLength(2);
expect(frame?.post_context).toHaveLength(2);
});

test('does not read source files when dataCollection.frameContextLines is 0', async () => {
contextLines = _contextLinesIntegration();
const readStreamSpy = vi.spyOn(fs, 'createReadStream');
const frames = parseStackFrames(defaultStackParser, new Error('test'));

await contextLines.processEvent(
{ exception: { values: [{ stacktrace: { frames } }] } },
{},
clientWithFrameContextLines(0),
);

expect(readStreamSpy).not.toHaveBeenCalled();
});

test('integration option takes precedence over dataCollection.frameContextLines', async () => {
contextLines = _contextLinesIntegration({ frameContextLines: 1 });
const frames = parseStackFrames(defaultStackParser, new Error('test'));

await contextLines.processEvent(
{ exception: { values: [{ stacktrace: { frames } }] } },
{},
clientWithFrameContextLines(5),
);

const frame = frames.find(f => f.context_line !== undefined);
expect(frame?.pre_context).toHaveLength(1);
expect(frame?.post_context).toHaveLength(1);
});
});
});
Loading