fix(v8/node): Enforce that ContextLines integration does not leave open file handles#14997

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 3 commits into from
Jan 14, 2025
Merged

fix(v8/node): Enforce that ContextLines integration does not leave open file handles #14997

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
dc7422b
fix(node): Enforce that ContextLines integration does not leave open …
AbhiPrasad Jan 14, 2025
f33afd3
Merge branch 'v8' into v8-abhi-context-lines-stream-handle
AbhiPrasad Jan 14, 2025
373bbff
with conditional test
AbhiPrasad Jan 14, 2025
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
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

Work in this release was contributed by @HHK1. Thank you for your contribution!
Work in this release was contributed by @HHK1 and @mstrokin. Thank you for your contribution!

## 8.48.0

Expand Down
0 ...-tests/suites/contextLines/instrument.mjs → ...Lines/filename-with-spaces/instrument.mjs
View file
Open in desktop
File renamed without changes.
0 ...ites/contextLines/scenario with space.cjs → ...ename-with-spaces/scenario with space.cjs
View file
Open in desktop
File renamed without changes.
0 ...ites/contextLines/scenario with space.mjs → ...ename-with-spaces/scenario with space.mjs
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions ...gration-tests/suites/contextLines/test.ts → ...contextLines/filename-with-spaces/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { join } from 'path';
import { conditionalTest } from '../../utils';
import { createRunner } from '../../utils/runner';
import { conditionalTest } from '../../../utils';
import { createRunner } from '../../../utils/runner';

conditionalTest({ min: 18 })('ContextLines integration in ESM', () => {
test('reads encoded context lines from filenames with spaces', done => {
Expand Down
5 changes: 5 additions & 0 deletions dev-packages/node-integration-tests/suites/contextLines/memory-leak/nested-file.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import * as Sentry from '@sentry/node';

export function captureException(i: number): void {
Sentry.captureException(new Error(`error in loop ${i}`));
}
7 changes: 7 additions & 0 deletions dev-packages/node-integration-tests/suites/contextLines/memory-leak/other-file.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { captureException } from './nested-file';

export function runSentry(): void {
for (let i = 0; i < 10; i++) {
captureException(i);
}
}
30 changes: 30 additions & 0 deletions dev-packages/node-integration-tests/suites/contextLines/memory-leak/scenario.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import { execSync } from 'node:child_process';
import * as path from 'node:path';

import { loggingTransport } from '@sentry-internal/node-integration-tests';
import * as Sentry from '@sentry/node';

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
transport: loggingTransport,
});

import { runSentry } from './other-file';

runSentry();

const lsofOutput = execSync(`lsof -p ${process.pid}`, { encoding: 'utf8' });
const lsofTable = lsofOutput.split('\n');
const mainPath = __dirname.replace(`${path.sep}suites${path.sep}contextLines${path.sep}memory-leak`, '');
const numberOfLsofEntriesWithMainPath = lsofTable.filter(entry => entry.includes(mainPath));

// There should only be a single entry with the main path, otherwise we are leaking file handles from the
// context lines integration.
if (numberOfLsofEntriesWithMainPath.length > 1) {
// eslint-disable-next-line no-console
console.error('Leaked file handles detected');
// eslint-disable-next-line no-console
console.error(lsofTable);
process.exit(1);
}
17 changes: 17 additions & 0 deletions dev-packages/node-integration-tests/suites/contextLines/memory-leak/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

conditionalTest({ min: 18 })('ContextLines integration in CJS', () => {
afterAll(() => {
cleanupChildProcesses();
});

// Regression test for: https://github.com/getsentry/sentry-javascript/issues/14892
test('does not leak open file handles', done => {
createRunner(__dirname, 'scenario.ts')
.expectN(10, {
event: {},
})
.start(done);
});
});
213 changes: 213 additions & 0 deletions dev-packages/node-integration-tests/test.txt
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions dev-packages/node-integration-tests/utils/runner.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -168,6 +168,12 @@ export function createRunner(...paths: string[]) {
expectedEnvelopes.push(expected);
return this;
},
expectN: function (n: number, expected: Expected) {
for (let i = 0; i < n; i++) {
expectedEnvelopes.push(expected);
}
return this;
},
expectHeader: function (expected: ExpectedEnvelopeHeader) {
if (!expectedEnvelopeHeaders) {
expectedEnvelopeHeaders = [];
Expand Down
14 changes: 11 additions & 3 deletions packages/node/src/integrations/contextlines.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -142,13 +142,21 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
input: stream,
});

// We need to explicitly destroy the stream to prevent memory leaks,
// removing the listeners on the readline interface is not enough.
// See: https://github.com/nodejs/node/issues/9002 and https://github.com/getsentry/sentry-javascript/issues/14892
function destroyStreamAndResolve(): void {
stream.destroy();
resolve();
}

// Init at zero and increment at the start of the loop because lines are 1 indexed.
let lineNumber = 0;
let currentRangeIndex = 0;
const range = ranges[currentRangeIndex];
if (range === undefined) {
// We should never reach this point, but if we do, we should resolve the promise to prevent it from hanging.
resolve();
destroyStreamAndResolve();
return;
}
let rangeStart = range[0];
Expand All@@ -162,14 +170,14 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
DEBUG_BUILD && logger.error(`Failed to read file: ${path}. Error: ${e}`);
lineReaded.close();
lineReaded.removeAllListeners();
resolve();
destroyStreamAndResolve();
}

// We need to handle the error event to prevent the process from crashing in < Node 16
// https://github.com/nodejs/node/pull/31603
stream.on('error', onStreamError);
lineReaded.on('error', onStreamError);
lineReaded.on('close', resolve);
lineReaded.on('close', destroyStreamAndResolve);

lineReaded.on('line', line => {
lineNumber++;
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
fix(v8/node): Enforce that ContextLines integration does not leave open file handles#14997

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 3 commits into

from

Jan 14, 2025
 Merged


fix(v8/node): Enforce that ContextLines integration does not leave open file handles
#14997
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
dc7422b

fix(node): Enforce that ContextLines integration does not leave open …


AbhiPrasad Jan 14, 2025
f33afd3

Merge branch 'v8' into v8-abhi-context-lines-stream-handle


AbhiPrasad Jan 14, 2025
373bbff

with conditional test


AbhiPrasad Jan 14, 2025

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


2 changes: 1 addition & 1 deletion
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

Work in this release was contributed by @HHK1. Thank you for your contribution!
Work in this release was contributed by @HHK1 and @mstrokin. Thank you for your contribution!

## 8.48.0

Expand Down

0
...-tests/suites/contextLines/instrument.mjs → ...Lines/filename-with-spaces/instrument.mjs

View file


Open in desktop


File renamed without changes.


0
...ites/contextLines/scenario with space.cjs → ...ename-with-spaces/scenario with space.cjs

View file


Open in desktop


File renamed without changes.


0
...ites/contextLines/scenario with space.mjs → ...ename-with-spaces/scenario with space.mjs

View file


Open in desktop


File renamed without changes.


4 changes: 2 additions & 2 deletions
...gration-tests/suites/contextLines/test.ts → ...contextLines/filename-with-spaces/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { join } from 'path';
import { conditionalTest } from '../../utils';
import { createRunner } from '../../utils/runner';
import { conditionalTest } from '../../../utils';
import { createRunner } from '../../../utils/runner';

conditionalTest({ min: 18 })('ContextLines integration in ESM', () => {
 test('reads encoded context lines from filenames with spaces', done => {
Expand Down

5 changes: 5 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/nested-file.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import * as Sentry from '@sentry/node';

export function captureException(i: number): void {
 Sentry.captureException(new Error(`error in loop ${i}`));
}

7 changes: 7 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/other-file.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { captureException } from './nested-file';

export function runSentry(): void {
 for (let i = 0; i < 10; i++) {
 captureException(i);
 }
}

30 changes: 30 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/scenario.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import { execSync } from 'node:child_process';
import * as path from 'node:path';

import { loggingTransport } from '@sentry-internal/node-integration-tests';
import * as Sentry from '@sentry/node';

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
});

import { runSentry } from './other-file';

runSentry();

const lsofOutput = execSync(`lsof -p ${process.pid}`, { encoding: 'utf8' });
const lsofTable = lsofOutput.split('\n');
const mainPath = __dirname.replace(`${path.sep}suites${path.sep}contextLines${path.sep}memory-leak`, '');
const numberOfLsofEntriesWithMainPath = lsofTable.filter(entry => entry.includes(mainPath));

// There should only be a single entry with the main path, otherwise we are leaking file handles from the
// context lines integration.
if (numberOfLsofEntriesWithMainPath.length > 1) {
 // eslint-disable-next-line no-console
 console.error('Leaked file handles detected');
 // eslint-disable-next-line no-console
 console.error(lsofTable);
 process.exit(1);
}

17 changes: 17 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

conditionalTest({ min: 18 })('ContextLines integration in CJS', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 // Regression test for: https://github.com/getsentry/sentry-javascript/issues/14892
 test('does not leak open file handles', done => {
 createRunner(__dirname, 'scenario.ts')
 .expectN(10, {
 event: {},
 })
 .start(done);
 });
});

213 changes: 213 additions & 0 deletions
dev-packages/node-integration-tests/test.txt

View file


Open in desktop


Large diffs are not rendered by default.


6 changes: 6 additions & 0 deletions
dev-packages/node-integration-tests/utils/runner.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -168,6 +168,12 @@ export function createRunner(...paths: string[]) {
 expectedEnvelopes.push(expected);
 return this;
 },
 expectN: function (n: number, expected: Expected) {
 for (let i = 0; i < n; i++) {
 expectedEnvelopes.push(expected);
 }
 return this;
 },
 expectHeader: function (expected: ExpectedEnvelopeHeader) {
 if (!expectedEnvelopeHeaders) {
 expectedEnvelopeHeaders = [];
Expand Down

14 changes: 11 additions & 3 deletions
packages/node/src/integrations/contextlines.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,13 +142,21 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
 input: stream,
 });

 // We need to explicitly destroy the stream to prevent memory leaks,
 // removing the listeners on the readline interface is not enough.
 // See: https://github.com/nodejs/node/issues/9002 and https://github.com/getsentry/sentry-javascript/issues/14892
 function destroyStreamAndResolve(): void {
 stream.destroy();
 resolve();
 }

 // Init at zero and increment at the start of the loop because lines are 1 indexed.
 let lineNumber = 0;
 let currentRangeIndex = 0;
 const range = ranges[currentRangeIndex];
 if (range === undefined) {
 // We should never reach this point, but if we do, we should resolve the promise to prevent it from hanging.
resolve();
destroyStreamAndResolve();
 return;
 }
 let rangeStart = range[0];
Expand All@@ -162,14 +170,14 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
 DEBUG_BUILD && logger.error(`Failed to read file: ${path}. Error: ${e}`);
 lineReaded.close();
 lineReaded.removeAllListeners();
resolve();
destroyStreamAndResolve();
 }

 // We need to handle the error event to prevent the process from crashing in < Node 16
 // https://github.com/nodejs/node/pull/31603
 stream.on('error', onStreamError);
 lineReaded.on('error', onStreamError);
 lineReaded.on('close', resolve);
 lineReaded.on('close', destroyStreamAndResolve);

 lineReaded.on('line', line => {
 lineNumber++;
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
fix(v8/node): Enforce that ContextLines integration does not leave open file handles#14997

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 3 commits into

from

Jan 14, 2025
 Merged


fix(v8/node): Enforce that ContextLines integration does not leave open file handles
#14997
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
dc7422b

fix(node): Enforce that ContextLines integration does not leave open …


AbhiPrasad Jan 14, 2025
f33afd3

Merge branch 'v8' into v8-abhi-context-lines-stream-handle


AbhiPrasad Jan 14, 2025
373bbff

with conditional test


AbhiPrasad Jan 14, 2025

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


2 changes: 1 addition & 1 deletion
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

Work in this release was contributed by @HHK1. Thank you for your contribution!
Work in this release was contributed by @HHK1 and @mstrokin. Thank you for your contribution!

## 8.48.0

Expand Down

0
...-tests/suites/contextLines/instrument.mjs → ...Lines/filename-with-spaces/instrument.mjs

View file


Open in desktop


File renamed without changes.


0
...ites/contextLines/scenario with space.cjs → ...ename-with-spaces/scenario with space.cjs

View file


Open in desktop


File renamed without changes.


0
...ites/contextLines/scenario with space.mjs → ...ename-with-spaces/scenario with space.mjs

View file


Open in desktop


File renamed without changes.


4 changes: 2 additions & 2 deletions
...gration-tests/suites/contextLines/test.ts → ...contextLines/filename-with-spaces/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { join } from 'path';
import { conditionalTest } from '../../utils';
import { createRunner } from '../../utils/runner';
import { conditionalTest } from '../../../utils';
import { createRunner } from '../../../utils/runner';

conditionalTest({ min: 18 })('ContextLines integration in ESM', () => {
 test('reads encoded context lines from filenames with spaces', done => {
Expand Down

5 changes: 5 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/nested-file.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import * as Sentry from '@sentry/node';

export function captureException(i: number): void {
 Sentry.captureException(new Error(`error in loop ${i}`));
}

7 changes: 7 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/other-file.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { captureException } from './nested-file';

export function runSentry(): void {
 for (let i = 0; i < 10; i++) {
 captureException(i);
 }
}

30 changes: 30 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/scenario.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import { execSync } from 'node:child_process';
import * as path from 'node:path';

import { loggingTransport } from '@sentry-internal/node-integration-tests';
import * as Sentry from '@sentry/node';

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
});

import { runSentry } from './other-file';

runSentry();

const lsofOutput = execSync(`lsof -p ${process.pid}`, { encoding: 'utf8' });
const lsofTable = lsofOutput.split('\n');
const mainPath = __dirname.replace(`${path.sep}suites${path.sep}contextLines${path.sep}memory-leak`, '');
const numberOfLsofEntriesWithMainPath = lsofTable.filter(entry => entry.includes(mainPath));

// There should only be a single entry with the main path, otherwise we are leaking file handles from the
// context lines integration.
if (numberOfLsofEntriesWithMainPath.length > 1) {
 // eslint-disable-next-line no-console
 console.error('Leaked file handles detected');
 // eslint-disable-next-line no-console
 console.error(lsofTable);
 process.exit(1);
}

17 changes: 17 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

conditionalTest({ min: 18 })('ContextLines integration in CJS', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 // Regression test for: https://github.com/getsentry/sentry-javascript/issues/14892
 test('does not leak open file handles', done => {
 createRunner(__dirname, 'scenario.ts')
 .expectN(10, {
 event: {},
 })
 .start(done);
 });
});

213 changes: 213 additions & 0 deletions
dev-packages/node-integration-tests/test.txt

View file


Open in desktop


Large diffs are not rendered by default.


6 changes: 6 additions & 0 deletions
dev-packages/node-integration-tests/utils/runner.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -168,6 +168,12 @@ export function createRunner(...paths: string[]) {
 expectedEnvelopes.push(expected);
 return this;
 },
 expectN: function (n: number, expected: Expected) {
 for (let i = 0; i < n; i++) {
 expectedEnvelopes.push(expected);
 }
 return this;
 },
 expectHeader: function (expected: ExpectedEnvelopeHeader) {
 if (!expectedEnvelopeHeaders) {
 expectedEnvelopeHeaders = [];
Expand Down

14 changes: 11 additions & 3 deletions
packages/node/src/integrations/contextlines.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,13 +142,21 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
 input: stream,
 });

 // We need to explicitly destroy the stream to prevent memory leaks,
 // removing the listeners on the readline interface is not enough.
 // See: https://github.com/nodejs/node/issues/9002 and https://github.com/getsentry/sentry-javascript/issues/14892
 function destroyStreamAndResolve(): void {
 stream.destroy();
 resolve();
 }

 // Init at zero and increment at the start of the loop because lines are 1 indexed.
 let lineNumber = 0;
 let currentRangeIndex = 0;
 const range = ranges[currentRangeIndex];
 if (range === undefined) {
 // We should never reach this point, but if we do, we should resolve the promise to prevent it from hanging.
resolve();
destroyStreamAndResolve();
 return;
 }
 let rangeStart = range[0];
Expand All@@ -162,14 +170,14 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
 DEBUG_BUILD && logger.error(`Failed to read file: ${path}. Error: ${e}`);
 lineReaded.close();
 lineReaded.removeAllListeners();
resolve();
destroyStreamAndResolve();
 }

 // We need to handle the error event to prevent the process from crashing in < Node 16
 // https://github.com/nodejs/node/pull/31603
 stream.on('error', onStreamError);
 lineReaded.on('error', onStreamError);
 lineReaded.on('close', resolve);
 lineReaded.on('close', destroyStreamAndResolve);

 lineReaded.on('line', line => {
 lineNumber++;
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
fix(v8/node): Enforce that ContextLines integration does not leave open file handles#14997

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 3 commits into

from

Jan 14, 2025
 Merged


fix(v8/node): Enforce that ContextLines integration does not leave open file handles
#14997
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
dc7422b

fix(node): Enforce that ContextLines integration does not leave open …


AbhiPrasad Jan 14, 2025
f33afd3

Merge branch 'v8' into v8-abhi-context-lines-stream-handle


AbhiPrasad Jan 14, 2025
373bbff

with conditional test


AbhiPrasad Jan 14, 2025

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


2 changes: 1 addition & 1 deletion
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

Work in this release was contributed by @HHK1. Thank you for your contribution!
Work in this release was contributed by @HHK1 and @mstrokin. Thank you for your contribution!

## 8.48.0

Expand Down

0
...-tests/suites/contextLines/instrument.mjs → ...Lines/filename-with-spaces/instrument.mjs

View file


Open in desktop


File renamed without changes.


0
...ites/contextLines/scenario with space.cjs → ...ename-with-spaces/scenario with space.cjs

View file


Open in desktop


File renamed without changes.


0
...ites/contextLines/scenario with space.mjs → ...ename-with-spaces/scenario with space.mjs

View file


Open in desktop


File renamed without changes.


4 changes: 2 additions & 2 deletions
...gration-tests/suites/contextLines/test.ts → ...contextLines/filename-with-spaces/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { join } from 'path';
import { conditionalTest } from '../../utils';
import { createRunner } from '../../utils/runner';
import { conditionalTest } from '../../../utils';
import { createRunner } from '../../../utils/runner';

conditionalTest({ min: 18 })('ContextLines integration in ESM', () => {
 test('reads encoded context lines from filenames with spaces', done => {
Expand Down

5 changes: 5 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/nested-file.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import * as Sentry from '@sentry/node';

export function captureException(i: number): void {
 Sentry.captureException(new Error(`error in loop ${i}`));
}

7 changes: 7 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/other-file.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { captureException } from './nested-file';

export function runSentry(): void {
 for (let i = 0; i < 10; i++) {
 captureException(i);
 }
}

30 changes: 30 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/scenario.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import { execSync } from 'node:child_process';
import * as path from 'node:path';

import { loggingTransport } from '@sentry-internal/node-integration-tests';
import * as Sentry from '@sentry/node';

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
});

import { runSentry } from './other-file';

runSentry();

const lsofOutput = execSync(`lsof -p ${process.pid}`, { encoding: 'utf8' });
const lsofTable = lsofOutput.split('\n');
const mainPath = __dirname.replace(`${path.sep}suites${path.sep}contextLines${path.sep}memory-leak`, '');
const numberOfLsofEntriesWithMainPath = lsofTable.filter(entry => entry.includes(mainPath));

// There should only be a single entry with the main path, otherwise we are leaking file handles from the
// context lines integration.
if (numberOfLsofEntriesWithMainPath.length > 1) {
 // eslint-disable-next-line no-console
 console.error('Leaked file handles detected');
 // eslint-disable-next-line no-console
 console.error(lsofTable);
 process.exit(1);
}

17 changes: 17 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

conditionalTest({ min: 18 })('ContextLines integration in CJS', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 // Regression test for: https://github.com/getsentry/sentry-javascript/issues/14892
 test('does not leak open file handles', done => {
 createRunner(__dirname, 'scenario.ts')
 .expectN(10, {
 event: {},
 })
 .start(done);
 });
});

213 changes: 213 additions & 0 deletions
dev-packages/node-integration-tests/test.txt

View file


Open in desktop


Large diffs are not rendered by default.


6 changes: 6 additions & 0 deletions
dev-packages/node-integration-tests/utils/runner.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -168,6 +168,12 @@ export function createRunner(...paths: string[]) {
 expectedEnvelopes.push(expected);
 return this;
 },
 expectN: function (n: number, expected: Expected) {
 for (let i = 0; i < n; i++) {
 expectedEnvelopes.push(expected);
 }
 return this;
 },
 expectHeader: function (expected: ExpectedEnvelopeHeader) {
 if (!expectedEnvelopeHeaders) {
 expectedEnvelopeHeaders = [];
Expand Down

14 changes: 11 additions & 3 deletions
packages/node/src/integrations/contextlines.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,13 +142,21 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
 input: stream,
 });

 // We need to explicitly destroy the stream to prevent memory leaks,
 // removing the listeners on the readline interface is not enough.
 // See: https://github.com/nodejs/node/issues/9002 and https://github.com/getsentry/sentry-javascript/issues/14892
 function destroyStreamAndResolve(): void {
 stream.destroy();
 resolve();
 }

 // Init at zero and increment at the start of the loop because lines are 1 indexed.
 let lineNumber = 0;
 let currentRangeIndex = 0;
 const range = ranges[currentRangeIndex];
 if (range === undefined) {
 // We should never reach this point, but if we do, we should resolve the promise to prevent it from hanging.
resolve();
destroyStreamAndResolve();
 return;
 }
 let rangeStart = range[0];
Expand All@@ -162,14 +170,14 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
 DEBUG_BUILD && logger.error(`Failed to read file: ${path}. Error: ${e}`);
 lineReaded.close();
 lineReaded.removeAllListeners();
resolve();
destroyStreamAndResolve();
 }

 // We need to handle the error event to prevent the process from crashing in < Node 16
 // https://github.com/nodejs/node/pull/31603
 stream.on('error', onStreamError);
 lineReaded.on('error', onStreamError);
 lineReaded.on('close', resolve);
 lineReaded.on('close', destroyStreamAndResolve);

 lineReaded.on('line', line => {
 lineNumber++;
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
fix(v8/node): Enforce that ContextLines integration does not leave open file handles#14997

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 3 commits into

from

Jan 14, 2025
 Merged


fix(v8/node): Enforce that ContextLines integration does not leave open file handles
#14997
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
dc7422b

fix(node): Enforce that ContextLines integration does not leave open …


AbhiPrasad Jan 14, 2025
f33afd3

Merge branch 'v8' into v8-abhi-context-lines-stream-handle


AbhiPrasad Jan 14, 2025
373bbff

with conditional test


AbhiPrasad Jan 14, 2025

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


2 changes: 1 addition & 1 deletion
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

Work in this release was contributed by @HHK1. Thank you for your contribution!
Work in this release was contributed by @HHK1 and @mstrokin. Thank you for your contribution!

## 8.48.0

Expand Down

0
...-tests/suites/contextLines/instrument.mjs → ...Lines/filename-with-spaces/instrument.mjs

View file


Open in desktop


File renamed without changes.


0
...ites/contextLines/scenario with space.cjs → ...ename-with-spaces/scenario with space.cjs

View file


Open in desktop


File renamed without changes.


0
...ites/contextLines/scenario with space.mjs → ...ename-with-spaces/scenario with space.mjs

View file


Open in desktop


File renamed without changes.


4 changes: 2 additions & 2 deletions
...gration-tests/suites/contextLines/test.ts → ...contextLines/filename-with-spaces/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { join } from 'path';
import { conditionalTest } from '../../utils';
import { createRunner } from '../../utils/runner';
import { conditionalTest } from '../../../utils';
import { createRunner } from '../../../utils/runner';

conditionalTest({ min: 18 })('ContextLines integration in ESM', () => {
 test('reads encoded context lines from filenames with spaces', done => {
Expand Down

5 changes: 5 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/nested-file.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import * as Sentry from '@sentry/node';

export function captureException(i: number): void {
 Sentry.captureException(new Error(`error in loop ${i}`));
}

7 changes: 7 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/other-file.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { captureException } from './nested-file';

export function runSentry(): void {
 for (let i = 0; i < 10; i++) {
 captureException(i);
 }
}

30 changes: 30 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/scenario.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import { execSync } from 'node:child_process';
import * as path from 'node:path';

import { loggingTransport } from '@sentry-internal/node-integration-tests';
import * as Sentry from '@sentry/node';

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
});

import { runSentry } from './other-file';

runSentry();

const lsofOutput = execSync(`lsof -p ${process.pid}`, { encoding: 'utf8' });
const lsofTable = lsofOutput.split('\n');
const mainPath = __dirname.replace(`${path.sep}suites${path.sep}contextLines${path.sep}memory-leak`, '');
const numberOfLsofEntriesWithMainPath = lsofTable.filter(entry => entry.includes(mainPath));

// There should only be a single entry with the main path, otherwise we are leaking file handles from the
// context lines integration.
if (numberOfLsofEntriesWithMainPath.length > 1) {
 // eslint-disable-next-line no-console
 console.error('Leaked file handles detected');
 // eslint-disable-next-line no-console
 console.error(lsofTable);
 process.exit(1);
}

17 changes: 17 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

conditionalTest({ min: 18 })('ContextLines integration in CJS', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 // Regression test for: https://github.com/getsentry/sentry-javascript/issues/14892
 test('does not leak open file handles', done => {
 createRunner(__dirname, 'scenario.ts')
 .expectN(10, {
 event: {},
 })
 .start(done);
 });
});

213 changes: 213 additions & 0 deletions
dev-packages/node-integration-tests/test.txt

View file


Open in desktop


Large diffs are not rendered by default.


6 changes: 6 additions & 0 deletions
dev-packages/node-integration-tests/utils/runner.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -168,6 +168,12 @@ export function createRunner(...paths: string[]) {
 expectedEnvelopes.push(expected);
 return this;
 },
 expectN: function (n: number, expected: Expected) {
 for (let i = 0; i < n; i++) {
 expectedEnvelopes.push(expected);
 }
 return this;
 },
 expectHeader: function (expected: ExpectedEnvelopeHeader) {
 if (!expectedEnvelopeHeaders) {
 expectedEnvelopeHeaders = [];
Expand Down

14 changes: 11 additions & 3 deletions
packages/node/src/integrations/contextlines.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,13 +142,21 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
 input: stream,
 });

 // We need to explicitly destroy the stream to prevent memory leaks,
 // removing the listeners on the readline interface is not enough.
 // See: https://github.com/nodejs/node/issues/9002 and https://github.com/getsentry/sentry-javascript/issues/14892
 function destroyStreamAndResolve(): void {
 stream.destroy();
 resolve();
 }

 // Init at zero and increment at the start of the loop because lines are 1 indexed.
 let lineNumber = 0;
 let currentRangeIndex = 0;
 const range = ranges[currentRangeIndex];
 if (range === undefined) {
 // We should never reach this point, but if we do, we should resolve the promise to prevent it from hanging.
resolve();
destroyStreamAndResolve();
 return;
 }
 let rangeStart = range[0];
Expand All@@ -162,14 +170,14 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
 DEBUG_BUILD && logger.error(`Failed to read file: ${path}. Error: ${e}`);
 lineReaded.close();
 lineReaded.removeAllListeners();
resolve();
destroyStreamAndResolve();
 }

 // We need to handle the error event to prevent the process from crashing in < Node 16
 // https://github.com/nodejs/node/pull/31603
 stream.on('error', onStreamError);
 lineReaded.on('error', onStreamError);
 lineReaded.on('close', resolve);
 lineReaded.on('close', destroyStreamAndResolve);

 lineReaded.on('line', line => {
 lineNumber++;
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
fix(v8/node): Enforce that ContextLines integration does not leave open file handles#14997

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 3 commits into

from

Jan 14, 2025
 Merged


fix(v8/node): Enforce that ContextLines integration does not leave open file handles
#14997
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
dc7422b

fix(node): Enforce that ContextLines integration does not leave open …


AbhiPrasad Jan 14, 2025
f33afd3

Merge branch 'v8' into v8-abhi-context-lines-stream-handle


AbhiPrasad Jan 14, 2025
373bbff

with conditional test


AbhiPrasad Jan 14, 2025

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


2 changes: 1 addition & 1 deletion
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

Work in this release was contributed by @HHK1. Thank you for your contribution!
Work in this release was contributed by @HHK1 and @mstrokin. Thank you for your contribution!

## 8.48.0

Expand Down

0
...-tests/suites/contextLines/instrument.mjs → ...Lines/filename-with-spaces/instrument.mjs

View file


Open in desktop


File renamed without changes.


0
...ites/contextLines/scenario with space.cjs → ...ename-with-spaces/scenario with space.cjs

View file


Open in desktop


File renamed without changes.


0
...ites/contextLines/scenario with space.mjs → ...ename-with-spaces/scenario with space.mjs

View file


Open in desktop


File renamed without changes.


4 changes: 2 additions & 2 deletions
...gration-tests/suites/contextLines/test.ts → ...contextLines/filename-with-spaces/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { join } from 'path';
import { conditionalTest } from '../../utils';
import { createRunner } from '../../utils/runner';
import { conditionalTest } from '../../../utils';
import { createRunner } from '../../../utils/runner';

conditionalTest({ min: 18 })('ContextLines integration in ESM', () => {
 test('reads encoded context lines from filenames with spaces', done => {
Expand Down

5 changes: 5 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/nested-file.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import * as Sentry from '@sentry/node';

export function captureException(i: number): void {
 Sentry.captureException(new Error(`error in loop ${i}`));
}

7 changes: 7 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/other-file.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { captureException } from './nested-file';

export function runSentry(): void {
 for (let i = 0; i < 10; i++) {
 captureException(i);
 }
}

30 changes: 30 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/scenario.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import { execSync } from 'node:child_process';
import * as path from 'node:path';

import { loggingTransport } from '@sentry-internal/node-integration-tests';
import * as Sentry from '@sentry/node';

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
});

import { runSentry } from './other-file';

runSentry();

const lsofOutput = execSync(`lsof -p ${process.pid}`, { encoding: 'utf8' });
const lsofTable = lsofOutput.split('\n');
const mainPath = __dirname.replace(`${path.sep}suites${path.sep}contextLines${path.sep}memory-leak`, '');
const numberOfLsofEntriesWithMainPath = lsofTable.filter(entry => entry.includes(mainPath));

// There should only be a single entry with the main path, otherwise we are leaking file handles from the
// context lines integration.
if (numberOfLsofEntriesWithMainPath.length > 1) {
 // eslint-disable-next-line no-console
 console.error('Leaked file handles detected');
 // eslint-disable-next-line no-console
 console.error(lsofTable);
 process.exit(1);
}

17 changes: 17 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

conditionalTest({ min: 18 })('ContextLines integration in CJS', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 // Regression test for: https://github.com/getsentry/sentry-javascript/issues/14892
 test('does not leak open file handles', done => {
 createRunner(__dirname, 'scenario.ts')
 .expectN(10, {
 event: {},
 })
 .start(done);
 });
});

213 changes: 213 additions & 0 deletions
dev-packages/node-integration-tests/test.txt

View file


Open in desktop


Large diffs are not rendered by default.


6 changes: 6 additions & 0 deletions
dev-packages/node-integration-tests/utils/runner.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -168,6 +168,12 @@ export function createRunner(...paths: string[]) {
 expectedEnvelopes.push(expected);
 return this;
 },
 expectN: function (n: number, expected: Expected) {
 for (let i = 0; i < n; i++) {
 expectedEnvelopes.push(expected);
 }
 return this;
 },
 expectHeader: function (expected: ExpectedEnvelopeHeader) {
 if (!expectedEnvelopeHeaders) {
 expectedEnvelopeHeaders = [];
Expand Down

14 changes: 11 additions & 3 deletions
packages/node/src/integrations/contextlines.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,13 +142,21 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
 input: stream,
 });

 // We need to explicitly destroy the stream to prevent memory leaks,
 // removing the listeners on the readline interface is not enough.
 // See: https://github.com/nodejs/node/issues/9002 and https://github.com/getsentry/sentry-javascript/issues/14892
 function destroyStreamAndResolve(): void {
 stream.destroy();
 resolve();
 }

 // Init at zero and increment at the start of the loop because lines are 1 indexed.
 let lineNumber = 0;
 let currentRangeIndex = 0;
 const range = ranges[currentRangeIndex];
 if (range === undefined) {
 // We should never reach this point, but if we do, we should resolve the promise to prevent it from hanging.
resolve();
destroyStreamAndResolve();
 return;
 }
 let rangeStart = range[0];
Expand All@@ -162,14 +170,14 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
 DEBUG_BUILD && logger.error(`Failed to read file: ${path}. Error: ${e}`);
 lineReaded.close();
 lineReaded.removeAllListeners();
resolve();
destroyStreamAndResolve();
 }

 // We need to handle the error event to prevent the process from crashing in < Node 16
 // https://github.com/nodejs/node/pull/31603
 stream.on('error', onStreamError);
 lineReaded.on('error', onStreamError);
 lineReaded.on('close', resolve);
 lineReaded.on('close', destroyStreamAndResolve);

 lineReaded.on('line', line => {
 lineNumber++;
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
fix(v8/node): Enforce that ContextLines integration does not leave open file handles#14997

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 3 commits into

from

Jan 14, 2025
 Merged


fix(v8/node): Enforce that ContextLines integration does not leave open file handles
#14997
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
dc7422b

fix(node): Enforce that ContextLines integration does not leave open …


AbhiPrasad Jan 14, 2025
f33afd3

Merge branch 'v8' into v8-abhi-context-lines-stream-handle


AbhiPrasad Jan 14, 2025
373bbff

with conditional test


AbhiPrasad Jan 14, 2025

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


2 changes: 1 addition & 1 deletion
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

Work in this release was contributed by @HHK1. Thank you for your contribution!
Work in this release was contributed by @HHK1 and @mstrokin. Thank you for your contribution!

## 8.48.0

Expand Down

0
...-tests/suites/contextLines/instrument.mjs → ...Lines/filename-with-spaces/instrument.mjs

View file


Open in desktop


File renamed without changes.


0
...ites/contextLines/scenario with space.cjs → ...ename-with-spaces/scenario with space.cjs

View file


Open in desktop


File renamed without changes.


0
...ites/contextLines/scenario with space.mjs → ...ename-with-spaces/scenario with space.mjs

View file


Open in desktop


File renamed without changes.


4 changes: 2 additions & 2 deletions
...gration-tests/suites/contextLines/test.ts → ...contextLines/filename-with-spaces/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { join } from 'path';
import { conditionalTest } from '../../utils';
import { createRunner } from '../../utils/runner';
import { conditionalTest } from '../../../utils';
import { createRunner } from '../../../utils/runner';

conditionalTest({ min: 18 })('ContextLines integration in ESM', () => {
 test('reads encoded context lines from filenames with spaces', done => {
Expand Down

5 changes: 5 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/nested-file.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import * as Sentry from '@sentry/node';

export function captureException(i: number): void {
 Sentry.captureException(new Error(`error in loop ${i}`));
}

7 changes: 7 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/other-file.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { captureException } from './nested-file';

export function runSentry(): void {
 for (let i = 0; i < 10; i++) {
 captureException(i);
 }
}

30 changes: 30 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/scenario.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import { execSync } from 'node:child_process';
import * as path from 'node:path';

import { loggingTransport } from '@sentry-internal/node-integration-tests';
import * as Sentry from '@sentry/node';

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
});

import { runSentry } from './other-file';

runSentry();

const lsofOutput = execSync(`lsof -p ${process.pid}`, { encoding: 'utf8' });
const lsofTable = lsofOutput.split('\n');
const mainPath = __dirname.replace(`${path.sep}suites${path.sep}contextLines${path.sep}memory-leak`, '');
const numberOfLsofEntriesWithMainPath = lsofTable.filter(entry => entry.includes(mainPath));

// There should only be a single entry with the main path, otherwise we are leaking file handles from the
// context lines integration.
if (numberOfLsofEntriesWithMainPath.length > 1) {
 // eslint-disable-next-line no-console
 console.error('Leaked file handles detected');
 // eslint-disable-next-line no-console
 console.error(lsofTable);
 process.exit(1);
}

17 changes: 17 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

conditionalTest({ min: 18 })('ContextLines integration in CJS', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 // Regression test for: https://github.com/getsentry/sentry-javascript/issues/14892
 test('does not leak open file handles', done => {
 createRunner(__dirname, 'scenario.ts')
 .expectN(10, {
 event: {},
 })
 .start(done);
 });
});

213 changes: 213 additions & 0 deletions
dev-packages/node-integration-tests/test.txt

View file


Open in desktop


Large diffs are not rendered by default.


6 changes: 6 additions & 0 deletions
dev-packages/node-integration-tests/utils/runner.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -168,6 +168,12 @@ export function createRunner(...paths: string[]) {
 expectedEnvelopes.push(expected);
 return this;
 },
 expectN: function (n: number, expected: Expected) {
 for (let i = 0; i < n; i++) {
 expectedEnvelopes.push(expected);
 }
 return this;
 },
 expectHeader: function (expected: ExpectedEnvelopeHeader) {
 if (!expectedEnvelopeHeaders) {
 expectedEnvelopeHeaders = [];
Expand Down

14 changes: 11 additions & 3 deletions
packages/node/src/integrations/contextlines.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,13 +142,21 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
 input: stream,
 });

 // We need to explicitly destroy the stream to prevent memory leaks,
 // removing the listeners on the readline interface is not enough.
 // See: https://github.com/nodejs/node/issues/9002 and https://github.com/getsentry/sentry-javascript/issues/14892
 function destroyStreamAndResolve(): void {
 stream.destroy();
 resolve();
 }

 // Init at zero and increment at the start of the loop because lines are 1 indexed.
 let lineNumber = 0;
 let currentRangeIndex = 0;
 const range = ranges[currentRangeIndex];
 if (range === undefined) {
 // We should never reach this point, but if we do, we should resolve the promise to prevent it from hanging.
resolve();
destroyStreamAndResolve();
 return;
 }
 let rangeStart = range[0];
Expand All@@ -162,14 +170,14 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
 DEBUG_BUILD && logger.error(`Failed to read file: ${path}. Error: ${e}`);
 lineReaded.close();
 lineReaded.removeAllListeners();
resolve();
destroyStreamAndResolve();
 }

 // We need to handle the error event to prevent the process from crashing in < Node 16
 // https://github.com/nodejs/node/pull/31603
 stream.on('error', onStreamError);
 lineReaded.on('error', onStreamError);
 lineReaded.on('close', resolve);
 lineReaded.on('close', destroyStreamAndResolve);

 lineReaded.on('line', line => {
 lineNumber++;
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
fix(v8/node): Enforce that ContextLines integration does not leave open file handles#14997

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 3 commits into

from

Jan 14, 2025
 Merged


fix(v8/node): Enforce that ContextLines integration does not leave open file handles
#14997
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
dc7422b

fix(node): Enforce that ContextLines integration does not leave open …


AbhiPrasad Jan 14, 2025
f33afd3

Merge branch 'v8' into v8-abhi-context-lines-stream-handle


AbhiPrasad Jan 14, 2025
373bbff

with conditional test


AbhiPrasad Jan 14, 2025

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


2 changes: 1 addition & 1 deletion
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

Work in this release was contributed by @HHK1. Thank you for your contribution!
Work in this release was contributed by @HHK1 and @mstrokin. Thank you for your contribution!

## 8.48.0

Expand Down

0
...-tests/suites/contextLines/instrument.mjs → ...Lines/filename-with-spaces/instrument.mjs

View file


Open in desktop


File renamed without changes.


0
...ites/contextLines/scenario with space.cjs → ...ename-with-spaces/scenario with space.cjs

View file


Open in desktop


File renamed without changes.


0
...ites/contextLines/scenario with space.mjs → ...ename-with-spaces/scenario with space.mjs

View file


Open in desktop


File renamed without changes.


4 changes: 2 additions & 2 deletions
...gration-tests/suites/contextLines/test.ts → ...contextLines/filename-with-spaces/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { join } from 'path';
import { conditionalTest } from '../../utils';
import { createRunner } from '../../utils/runner';
import { conditionalTest } from '../../../utils';
import { createRunner } from '../../../utils/runner';

conditionalTest({ min: 18 })('ContextLines integration in ESM', () => {
 test('reads encoded context lines from filenames with spaces', done => {
Expand Down

5 changes: 5 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/nested-file.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import * as Sentry from '@sentry/node';

export function captureException(i: number): void {
 Sentry.captureException(new Error(`error in loop ${i}`));
}

7 changes: 7 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/other-file.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { captureException } from './nested-file';

export function runSentry(): void {
 for (let i = 0; i < 10; i++) {
 captureException(i);
 }
}

30 changes: 30 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/scenario.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import { execSync } from 'node:child_process';
import * as path from 'node:path';

import { loggingTransport } from '@sentry-internal/node-integration-tests';
import * as Sentry from '@sentry/node';

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
});

import { runSentry } from './other-file';

runSentry();

const lsofOutput = execSync(`lsof -p ${process.pid}`, { encoding: 'utf8' });
const lsofTable = lsofOutput.split('\n');
const mainPath = __dirname.replace(`${path.sep}suites${path.sep}contextLines${path.sep}memory-leak`, '');
const numberOfLsofEntriesWithMainPath = lsofTable.filter(entry => entry.includes(mainPath));

// There should only be a single entry with the main path, otherwise we are leaking file handles from the
// context lines integration.
if (numberOfLsofEntriesWithMainPath.length > 1) {
 // eslint-disable-next-line no-console
 console.error('Leaked file handles detected');
 // eslint-disable-next-line no-console
 console.error(lsofTable);
 process.exit(1);
}

17 changes: 17 additions & 0 deletions
dev-packages/node-integration-tests/suites/contextLines/memory-leak/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

conditionalTest({ min: 18 })('ContextLines integration in CJS', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 // Regression test for: https://github.com/getsentry/sentry-javascript/issues/14892
 test('does not leak open file handles', done => {
 createRunner(__dirname, 'scenario.ts')
 .expectN(10, {
 event: {},
 })
 .start(done);
 });
});

213 changes: 213 additions & 0 deletions
dev-packages/node-integration-tests/test.txt

View file


Open in desktop


Large diffs are not rendered by default.


6 changes: 6 additions & 0 deletions
dev-packages/node-integration-tests/utils/runner.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -168,6 +168,12 @@ export function createRunner(...paths: string[]) {
 expectedEnvelopes.push(expected);
 return this;
 },
 expectN: function (n: number, expected: Expected) {
 for (let i = 0; i < n; i++) {
 expectedEnvelopes.push(expected);
 }
 return this;
 },
 expectHeader: function (expected: ExpectedEnvelopeHeader) {
 if (!expectedEnvelopeHeaders) {
 expectedEnvelopeHeaders = [];
Expand Down

14 changes: 11 additions & 3 deletions
packages/node/src/integrations/contextlines.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,13 +142,21 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
 input: stream,
 });

 // We need to explicitly destroy the stream to prevent memory leaks,
 // removing the listeners on the readline interface is not enough.
 // See: https://github.com/nodejs/node/issues/9002 and https://github.com/getsentry/sentry-javascript/issues/14892
 function destroyStreamAndResolve(): void {
 stream.destroy();
 resolve();
 }

 // Init at zero and increment at the start of the loop because lines are 1 indexed.
 let lineNumber = 0;
 let currentRangeIndex = 0;
 const range = ranges[currentRangeIndex];
 if (range === undefined) {
 // We should never reach this point, but if we do, we should resolve the promise to prevent it from hanging.
resolve();
destroyStreamAndResolve();
 return;
 }
 let rangeStart = range[0];
Expand All@@ -162,14 +170,14 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
 DEBUG_BUILD && logger.error(`Failed to read file: ${path}. Error: ${e}`);
 lineReaded.close();
 lineReaded.removeAllListeners();
resolve();
destroyStreamAndResolve();
 }

 // We need to handle the error event to prevent the process from crashing in < Node 16
 // https://github.com/nodejs/node/pull/31603
 stream.on('error', onStreamError);
 lineReaded.on('error', onStreamError);
 lineReaded.on('close', resolve);
 lineReaded.on('close', destroyStreamAndResolve);

 lineReaded.on('line', line => {
 lineNumber++;
Expand Down