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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'none' })],
});

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'strict' })],
});

setTimeout(() => {
// should not be called
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
const Sentry = require('@sentry/node');

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

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject(new Error('test rejection'));
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
const Sentry = require('@sentry/node');

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

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
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,
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'strict' })],
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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,
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
import * as childProcess from 'child_process';
import * as path from 'path';
import { afterAll, describe, expect, test } from 'vitest';
import { cleanupChildProcesses } from '../../../utils/runner';
import { createRunner } from '../../../utils/runner';

describe('onUnhandledRejectionIntegration', () => {
afterAll(() => {
cleanupChildProcesses();
});

test('should show string-type promise rejection warnings by default', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-warn-string.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr.trim())
.toBe(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
test rejection`);
done();
});
}));

test('should show error-type promise rejection warnings by default', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-warn-error.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr)
.toContain(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
Error: test rejection
at Object.<anonymous>`);
done();
});
}));

test('should not close process on unhandled rejection in strict mode', () =>
new Promise<void>(done => {
expect.assertions(4);

const testScriptPath = path.resolve(__dirname, 'mode-strict.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).not.toBeNull();
expect(err?.code).toBe(1);
expect(stdout).not.toBe("I'm alive!");
expect(stderr)
.toContain(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
test rejection`);
done();
});
}));

test('should not close process or warn on unhandled rejection in none mode', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-none.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr).toBe('');
done();
});
}));

test('captures exceptions for unhandled rejections', async () => {
await createRunner(__dirname, 'scenario-warn.ts')
.expect({
event: {
level: 'error',
exception: {
values: [
{
type: 'Error',
value: 'test rejection',
mechanism: {
type: 'onunhandledrejection',
handled: false,
},
stacktrace: {
frames: expect.any(Array),
},
},
],
},
},
})
.start()
.completed();
});

test('captures exceptions for unhandled rejections in strict mode', async () => {
await createRunner(__dirname, 'scenario-strict.ts')
.expect({
event: {
level: 'fatal',
exception: {
values: [
{
type: 'Error',
value: 'test rejection',
mechanism: {
type: 'onunhandledrejection',
handled: false,
},
stacktrace: {
frames: expect.any(Array),
},
},
],
},
},
})
.start()
.completed();
});
});
20 changes: 13 additions & 7 deletions packages/node/src/integrations/onunhandledrejection.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Client, IntegrationFn } from '@sentry/core';
import type { Client, IntegrationFn, SeverityLevel } from '@sentry/core';
import { captureException, consoleSandbox, defineIntegration, getClient } from '@sentry/core';
import { logAndExitProcess } from '../utils/errorhandling';

Expand All@@ -15,12 +15,15 @@ interface OnUnhandledRejectionOptions {
const INTEGRATION_NAME = 'OnUnhandledRejection';

const _onUnhandledRejectionIntegration = ((options: Partial<OnUnhandledRejectionOptions> = {}) => {
const mode = options.mode || 'warn';
const opts = {
mode: 'warn',
...options,
} satisfies OnUnhandledRejectionOptions;

return {
name: INTEGRATION_NAME,
setup(client) {
global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, { mode }));
global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, opts));
},
};
}) satisfies IntegrationFn;
Expand All@@ -46,25 +49,28 @@ export function makeUnhandledPromiseHandler(
return;
}

const level: SeverityLevel = options.mode === 'strict' ? 'fatal' : 'error';

captureException(reason, {
originalException: promise,
captureContext: {
extra: { unhandledPromiseRejection: true },
level,
},
mechanism: {
handled: false,
type: 'onunhandledrejection',
},
});

handleRejection(reason, options);
handleRejection(reason, options.mode);
};
}

/**
* Handler for `mode` option
*/
function handleRejection(reason: unknown, options: OnUnhandledRejectionOptions): void {
function handleRejection(reason: unknown, mode: UnhandledRejectionMode): void {
// https://github.com/nodejs/node/blob/7cf6f9e964aa00772965391c23acda6d71972a9a/lib/internal/process/promises.js#L234-L240
const rejectionWarning =
'This error originated either by ' +
Expand All@@ -73,12 +79,12 @@ function handleRejection(reason: unknown, options: OnUnhandledRejectionOptions):
' The promise rejected with the reason:';

/* eslint-disable no-console */
if (options.mode === 'warn') {
if (mode === 'warn') {
consoleSandbox(() => {
console.warn(rejectionWarning);
console.error(reason && typeof reason === 'object' && 'stack' in reason ? reason.stack : reason);
});
} else if (options.mode === 'strict') {
} else if (mode === 'strict') {
consoleSandbox(() => {
console.warn(rejectionWarning);
});
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(node): Use `fatal` level for unhandled rejections in `strict` mode by mydea · Pull Request #15720 · getsentry/sentry-javascript · GitHub
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'none' })],
});

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'strict' })],
});

setTimeout(() => {
// should not be called
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
const Sentry = require('@sentry/node');

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

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject(new Error('test rejection'));
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
const Sentry = require('@sentry/node');

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

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
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,
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'strict' })],
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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,
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
import * as childProcess from 'child_process';
import * as path from 'path';
import { afterAll, describe, expect, test } from 'vitest';
import { cleanupChildProcesses } from '../../../utils/runner';
import { createRunner } from '../../../utils/runner';

describe('onUnhandledRejectionIntegration', () => {
afterAll(() => {
cleanupChildProcesses();
});

test('should show string-type promise rejection warnings by default', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-warn-string.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr.trim())
.toBe(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
test rejection`);
done();
});
}));

test('should show error-type promise rejection warnings by default', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-warn-error.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr)
.toContain(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
Error: test rejection
at Object.<anonymous>`);
done();
});
}));

test('should not close process on unhandled rejection in strict mode', () =>
new Promise<void>(done => {
expect.assertions(4);

const testScriptPath = path.resolve(__dirname, 'mode-strict.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).not.toBeNull();
expect(err?.code).toBe(1);
expect(stdout).not.toBe("I'm alive!");
expect(stderr)
.toContain(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
test rejection`);
done();
});
}));

test('should not close process or warn on unhandled rejection in none mode', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-none.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr).toBe('');
done();
});
}));

test('captures exceptions for unhandled rejections', async () => {
await createRunner(__dirname, 'scenario-warn.ts')
.expect({
event: {
level: 'error',
exception: {
values: [
{
type: 'Error',
value: 'test rejection',
mechanism: {
type: 'onunhandledrejection',
handled: false,
},
stacktrace: {
frames: expect.any(Array),
},
},
],
},
},
})
.start()
.completed();
});

test('captures exceptions for unhandled rejections in strict mode', async () => {
await createRunner(__dirname, 'scenario-strict.ts')
.expect({
event: {
level: 'fatal',
exception: {
values: [
{
type: 'Error',
value: 'test rejection',
mechanism: {
type: 'onunhandledrejection',
handled: false,
},
stacktrace: {
frames: expect.any(Array),
},
},
],
},
},
})
.start()
.completed();
});
});
20 changes: 13 additions & 7 deletions packages/node/src/integrations/onunhandledrejection.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Client, IntegrationFn } from '@sentry/core';
import type { Client, IntegrationFn, SeverityLevel } from '@sentry/core';
import { captureException, consoleSandbox, defineIntegration, getClient } from '@sentry/core';
import { logAndExitProcess } from '../utils/errorhandling';

Expand All@@ -15,12 +15,15 @@ interface OnUnhandledRejectionOptions {
const INTEGRATION_NAME = 'OnUnhandledRejection';

const _onUnhandledRejectionIntegration = ((options: Partial<OnUnhandledRejectionOptions> = {}) => {
const mode = options.mode || 'warn';
const opts = {
mode: 'warn',
...options,
} satisfies OnUnhandledRejectionOptions;

return {
name: INTEGRATION_NAME,
setup(client) {
global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, { mode }));
global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, opts));
},
};
}) satisfies IntegrationFn;
Expand All@@ -46,25 +49,28 @@ export function makeUnhandledPromiseHandler(
return;
}

const level: SeverityLevel = options.mode === 'strict' ? 'fatal' : 'error';

captureException(reason, {
originalException: promise,
captureContext: {
extra: { unhandledPromiseRejection: true },
level,
},
mechanism: {
handled: false,
type: 'onunhandledrejection',
},
});

handleRejection(reason, options);
handleRejection(reason, options.mode);
};
}

/**
* Handler for `mode` option
*/
function handleRejection(reason: unknown, options: OnUnhandledRejectionOptions): void {
function handleRejection(reason: unknown, mode: UnhandledRejectionMode): void {
// https://github.com/nodejs/node/blob/7cf6f9e964aa00772965391c23acda6d71972a9a/lib/internal/process/promises.js#L234-L240
const rejectionWarning =
'This error originated either by ' +
Expand All@@ -73,12 +79,12 @@ function handleRejection(reason: unknown, options: OnUnhandledRejectionOptions):
' The promise rejected with the reason:';

/* eslint-disable no-console */
if (options.mode === 'warn') {
if (mode === 'warn') {
consoleSandbox(() => {
console.warn(rejectionWarning);
console.error(reason && typeof reason === 'object' && 'stack' in reason ? reason.stack : reason);
});
} else if (options.mode === 'strict') {
} else if (mode === 'strict') {
consoleSandbox(() => {
console.warn(rejectionWarning);
});
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(node): Use `fatal` level for unhandled rejections in `strict` mode by mydea · Pull Request #15720 · getsentry/sentry-javascript · GitHub
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'none' })],
});

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'strict' })],
});

setTimeout(() => {
// should not be called
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
const Sentry = require('@sentry/node');

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

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject(new Error('test rejection'));
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
const Sentry = require('@sentry/node');

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

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
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,
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'strict' })],
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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,
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
import * as childProcess from 'child_process';
import * as path from 'path';
import { afterAll, describe, expect, test } from 'vitest';
import { cleanupChildProcesses } from '../../../utils/runner';
import { createRunner } from '../../../utils/runner';

describe('onUnhandledRejectionIntegration', () => {
afterAll(() => {
cleanupChildProcesses();
});

test('should show string-type promise rejection warnings by default', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-warn-string.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr.trim())
.toBe(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
test rejection`);
done();
});
}));

test('should show error-type promise rejection warnings by default', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-warn-error.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr)
.toContain(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
Error: test rejection
at Object.<anonymous>`);
done();
});
}));

test('should not close process on unhandled rejection in strict mode', () =>
new Promise<void>(done => {
expect.assertions(4);

const testScriptPath = path.resolve(__dirname, 'mode-strict.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).not.toBeNull();
expect(err?.code).toBe(1);
expect(stdout).not.toBe("I'm alive!");
expect(stderr)
.toContain(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
test rejection`);
done();
});
}));

test('should not close process or warn on unhandled rejection in none mode', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-none.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr).toBe('');
done();
});
}));

test('captures exceptions for unhandled rejections', async () => {
await createRunner(__dirname, 'scenario-warn.ts')
.expect({
event: {
level: 'error',
exception: {
values: [
{
type: 'Error',
value: 'test rejection',
mechanism: {
type: 'onunhandledrejection',
handled: false,
},
stacktrace: {
frames: expect.any(Array),
},
},
],
},
},
})
.start()
.completed();
});

test('captures exceptions for unhandled rejections in strict mode', async () => {
await createRunner(__dirname, 'scenario-strict.ts')
.expect({
event: {
level: 'fatal',
exception: {
values: [
{
type: 'Error',
value: 'test rejection',
mechanism: {
type: 'onunhandledrejection',
handled: false,
},
stacktrace: {
frames: expect.any(Array),
},
},
],
},
},
})
.start()
.completed();
});
});
20 changes: 13 additions & 7 deletions packages/node/src/integrations/onunhandledrejection.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Client, IntegrationFn } from '@sentry/core';
import type { Client, IntegrationFn, SeverityLevel } from '@sentry/core';
import { captureException, consoleSandbox, defineIntegration, getClient } from '@sentry/core';
import { logAndExitProcess } from '../utils/errorhandling';

Expand All@@ -15,12 +15,15 @@ interface OnUnhandledRejectionOptions {
const INTEGRATION_NAME = 'OnUnhandledRejection';

const _onUnhandledRejectionIntegration = ((options: Partial<OnUnhandledRejectionOptions> = {}) => {
const mode = options.mode || 'warn';
const opts = {
mode: 'warn',
...options,
} satisfies OnUnhandledRejectionOptions;

return {
name: INTEGRATION_NAME,
setup(client) {
global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, { mode }));
global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, opts));
},
};
}) satisfies IntegrationFn;
Expand All@@ -46,25 +49,28 @@ export function makeUnhandledPromiseHandler(
return;
}

const level: SeverityLevel = options.mode === 'strict' ? 'fatal' : 'error';

captureException(reason, {
originalException: promise,
captureContext: {
extra: { unhandledPromiseRejection: true },
level,
},
mechanism: {
handled: false,
type: 'onunhandledrejection',
},
});

handleRejection(reason, options);
handleRejection(reason, options.mode);
};
}

/**
* Handler for `mode` option
*/
function handleRejection(reason: unknown, options: OnUnhandledRejectionOptions): void {
function handleRejection(reason: unknown, mode: UnhandledRejectionMode): void {
// https://github.com/nodejs/node/blob/7cf6f9e964aa00772965391c23acda6d71972a9a/lib/internal/process/promises.js#L234-L240
const rejectionWarning =
'This error originated either by ' +
Expand All@@ -73,12 +79,12 @@ function handleRejection(reason: unknown, options: OnUnhandledRejectionOptions):
' The promise rejected with the reason:';

/* eslint-disable no-console */
if (options.mode === 'warn') {
if (mode === 'warn') {
consoleSandbox(() => {
console.warn(rejectionWarning);
console.error(reason && typeof reason === 'object' && 'stack' in reason ? reason.stack : reason);
});
} else if (options.mode === 'strict') {
} else if (mode === 'strict') {
consoleSandbox(() => {
console.warn(rejectionWarning);
});
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(node): Use `fatal` level for unhandled rejections in `strict` mode by mydea · Pull Request #15720 · getsentry/sentry-javascript · GitHub
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'none' })],
});

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'strict' })],
});

setTimeout(() => {
// should not be called
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
const Sentry = require('@sentry/node');

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

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject(new Error('test rejection'));
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
const Sentry = require('@sentry/node');

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

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
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,
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'strict' })],
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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,
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
import * as childProcess from 'child_process';
import * as path from 'path';
import { afterAll, describe, expect, test } from 'vitest';
import { cleanupChildProcesses } from '../../../utils/runner';
import { createRunner } from '../../../utils/runner';

describe('onUnhandledRejectionIntegration', () => {
afterAll(() => {
cleanupChildProcesses();
});

test('should show string-type promise rejection warnings by default', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-warn-string.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr.trim())
.toBe(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
test rejection`);
done();
});
}));

test('should show error-type promise rejection warnings by default', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-warn-error.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr)
.toContain(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
Error: test rejection
at Object.<anonymous>`);
done();
});
}));

test('should not close process on unhandled rejection in strict mode', () =>
new Promise<void>(done => {
expect.assertions(4);

const testScriptPath = path.resolve(__dirname, 'mode-strict.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).not.toBeNull();
expect(err?.code).toBe(1);
expect(stdout).not.toBe("I'm alive!");
expect(stderr)
.toContain(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
test rejection`);
done();
});
}));

test('should not close process or warn on unhandled rejection in none mode', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-none.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr).toBe('');
done();
});
}));

test('captures exceptions for unhandled rejections', async () => {
await createRunner(__dirname, 'scenario-warn.ts')
.expect({
event: {
level: 'error',
exception: {
values: [
{
type: 'Error',
value: 'test rejection',
mechanism: {
type: 'onunhandledrejection',
handled: false,
},
stacktrace: {
frames: expect.any(Array),
},
},
],
},
},
})
.start()
.completed();
});

test('captures exceptions for unhandled rejections in strict mode', async () => {
await createRunner(__dirname, 'scenario-strict.ts')
.expect({
event: {
level: 'fatal',
exception: {
values: [
{
type: 'Error',
value: 'test rejection',
mechanism: {
type: 'onunhandledrejection',
handled: false,
},
stacktrace: {
frames: expect.any(Array),
},
},
],
},
},
})
.start()
.completed();
});
});
20 changes: 13 additions & 7 deletions packages/node/src/integrations/onunhandledrejection.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Client, IntegrationFn } from '@sentry/core';
import type { Client, IntegrationFn, SeverityLevel } from '@sentry/core';
import { captureException, consoleSandbox, defineIntegration, getClient } from '@sentry/core';
import { logAndExitProcess } from '../utils/errorhandling';

Expand All@@ -15,12 +15,15 @@ interface OnUnhandledRejectionOptions {
const INTEGRATION_NAME = 'OnUnhandledRejection';

const _onUnhandledRejectionIntegration = ((options: Partial<OnUnhandledRejectionOptions> = {}) => {
const mode = options.mode || 'warn';
const opts = {
mode: 'warn',
...options,
} satisfies OnUnhandledRejectionOptions;

return {
name: INTEGRATION_NAME,
setup(client) {
global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, { mode }));
global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, opts));
},
};
}) satisfies IntegrationFn;
Expand All@@ -46,25 +49,28 @@ export function makeUnhandledPromiseHandler(
return;
}

const level: SeverityLevel = options.mode === 'strict' ? 'fatal' : 'error';

captureException(reason, {
originalException: promise,
captureContext: {
extra: { unhandledPromiseRejection: true },
level,
},
mechanism: {
handled: false,
type: 'onunhandledrejection',
},
});

handleRejection(reason, options);
handleRejection(reason, options.mode);
};
}

/**
* Handler for `mode` option
*/
function handleRejection(reason: unknown, options: OnUnhandledRejectionOptions): void {
function handleRejection(reason: unknown, mode: UnhandledRejectionMode): void {
// https://github.com/nodejs/node/blob/7cf6f9e964aa00772965391c23acda6d71972a9a/lib/internal/process/promises.js#L234-L240
const rejectionWarning =
'This error originated either by ' +
Expand All@@ -73,12 +79,12 @@ function handleRejection(reason: unknown, options: OnUnhandledRejectionOptions):
' The promise rejected with the reason:';

/* eslint-disable no-console */
if (options.mode === 'warn') {
if (mode === 'warn') {
consoleSandbox(() => {
console.warn(rejectionWarning);
console.error(reason && typeof reason === 'object' && 'stack' in reason ? reason.stack : reason);
});
} else if (options.mode === 'strict') {
} else if (mode === 'strict') {
consoleSandbox(() => {
console.warn(rejectionWarning);
});
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' fix(node): Use `fatal` level for unhandled rejections in `strict` mode by mydea · Pull Request #15720 · getsentry/sentry-javascript · GitHub
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'none' })],
});

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'strict' })],
});

setTimeout(() => {
// should not be called
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
const Sentry = require('@sentry/node');

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

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject(new Error('test rejection'));
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
const Sentry = require('@sentry/node');

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

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
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,
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'strict' })],
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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,
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
import * as childProcess from 'child_process';
import * as path from 'path';
import { afterAll, describe, expect, test } from 'vitest';
import { cleanupChildProcesses } from '../../../utils/runner';
import { createRunner } from '../../../utils/runner';

describe('onUnhandledRejectionIntegration', () => {
afterAll(() => {
cleanupChildProcesses();
});

test('should show string-type promise rejection warnings by default', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-warn-string.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr.trim())
.toBe(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
test rejection`);
done();
});
}));

test('should show error-type promise rejection warnings by default', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-warn-error.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr)
.toContain(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
Error: test rejection
at Object.<anonymous>`);
done();
});
}));

test('should not close process on unhandled rejection in strict mode', () =>
new Promise<void>(done => {
expect.assertions(4);

const testScriptPath = path.resolve(__dirname, 'mode-strict.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).not.toBeNull();
expect(err?.code).toBe(1);
expect(stdout).not.toBe("I'm alive!");
expect(stderr)
.toContain(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
test rejection`);
done();
});
}));

test('should not close process or warn on unhandled rejection in none mode', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-none.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr).toBe('');
done();
});
}));

test('captures exceptions for unhandled rejections', async () => {
await createRunner(__dirname, 'scenario-warn.ts')
.expect({
event: {
level: 'error',
exception: {
values: [
{
type: 'Error',
value: 'test rejection',
mechanism: {
type: 'onunhandledrejection',
handled: false,
},
stacktrace: {
frames: expect.any(Array),
},
},
],
},
},
})
.start()
.completed();
});

test('captures exceptions for unhandled rejections in strict mode', async () => {
await createRunner(__dirname, 'scenario-strict.ts')
.expect({
event: {
level: 'fatal',
exception: {
values: [
{
type: 'Error',
value: 'test rejection',
mechanism: {
type: 'onunhandledrejection',
handled: false,
},
stacktrace: {
frames: expect.any(Array),
},
},
],
},
},
})
.start()
.completed();
});
});
20 changes: 13 additions & 7 deletions packages/node/src/integrations/onunhandledrejection.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Client, IntegrationFn } from '@sentry/core';
import type { Client, IntegrationFn, SeverityLevel } from '@sentry/core';
import { captureException, consoleSandbox, defineIntegration, getClient } from '@sentry/core';
import { logAndExitProcess } from '../utils/errorhandling';

Expand All@@ -15,12 +15,15 @@ interface OnUnhandledRejectionOptions {
const INTEGRATION_NAME = 'OnUnhandledRejection';

const _onUnhandledRejectionIntegration = ((options: Partial<OnUnhandledRejectionOptions> = {}) => {
const mode = options.mode || 'warn';
const opts = {
mode: 'warn',
...options,
} satisfies OnUnhandledRejectionOptions;

return {
name: INTEGRATION_NAME,
setup(client) {
global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, { mode }));
global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, opts));
},
};
}) satisfies IntegrationFn;
Expand All@@ -46,25 +49,28 @@ export function makeUnhandledPromiseHandler(
return;
}

const level: SeverityLevel = options.mode === 'strict' ? 'fatal' : 'error';

captureException(reason, {
originalException: promise,
captureContext: {
extra: { unhandledPromiseRejection: true },
level,
},
mechanism: {
handled: false,
type: 'onunhandledrejection',
},
});

handleRejection(reason, options);
handleRejection(reason, options.mode);
};
}

/**
* Handler for `mode` option
*/
function handleRejection(reason: unknown, options: OnUnhandledRejectionOptions): void {
function handleRejection(reason: unknown, mode: UnhandledRejectionMode): void {
// https://github.com/nodejs/node/blob/7cf6f9e964aa00772965391c23acda6d71972a9a/lib/internal/process/promises.js#L234-L240
const rejectionWarning =
'This error originated either by ' +
Expand All@@ -73,12 +79,12 @@ function handleRejection(reason: unknown, options: OnUnhandledRejectionOptions):
' The promise rejected with the reason:';

/* eslint-disable no-console */
if (options.mode === 'warn') {
if (mode === 'warn') {
consoleSandbox(() => {
console.warn(rejectionWarning);
console.error(reason && typeof reason === 'object' && 'stack' in reason ? reason.stack : reason);
});
} else if (options.mode === 'strict') {
} else if (mode === 'strict') {
consoleSandbox(() => {
console.warn(rejectionWarning);
});
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(node): Use `fatal` level for unhandled rejections in `strict` mode by mydea · Pull Request #15720 · getsentry/sentry-javascript · GitHub
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'none' })],
});

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'strict' })],
});

setTimeout(() => {
// should not be called
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
const Sentry = require('@sentry/node');

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

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject(new Error('test rejection'));
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
const Sentry = require('@sentry/node');

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

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
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,
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'strict' })],
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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,
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
import * as childProcess from 'child_process';
import * as path from 'path';
import { afterAll, describe, expect, test } from 'vitest';
import { cleanupChildProcesses } from '../../../utils/runner';
import { createRunner } from '../../../utils/runner';

describe('onUnhandledRejectionIntegration', () => {
afterAll(() => {
cleanupChildProcesses();
});

test('should show string-type promise rejection warnings by default', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-warn-string.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr.trim())
.toBe(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
test rejection`);
done();
});
}));

test('should show error-type promise rejection warnings by default', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-warn-error.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr)
.toContain(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
Error: test rejection
at Object.<anonymous>`);
done();
});
}));

test('should not close process on unhandled rejection in strict mode', () =>
new Promise<void>(done => {
expect.assertions(4);

const testScriptPath = path.resolve(__dirname, 'mode-strict.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).not.toBeNull();
expect(err?.code).toBe(1);
expect(stdout).not.toBe("I'm alive!");
expect(stderr)
.toContain(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
test rejection`);
done();
});
}));

test('should not close process or warn on unhandled rejection in none mode', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-none.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr).toBe('');
done();
});
}));

test('captures exceptions for unhandled rejections', async () => {
await createRunner(__dirname, 'scenario-warn.ts')
.expect({
event: {
level: 'error',
exception: {
values: [
{
type: 'Error',
value: 'test rejection',
mechanism: {
type: 'onunhandledrejection',
handled: false,
},
stacktrace: {
frames: expect.any(Array),
},
},
],
},
},
})
.start()
.completed();
});

test('captures exceptions for unhandled rejections in strict mode', async () => {
await createRunner(__dirname, 'scenario-strict.ts')
.expect({
event: {
level: 'fatal',
exception: {
values: [
{
type: 'Error',
value: 'test rejection',
mechanism: {
type: 'onunhandledrejection',
handled: false,
},
stacktrace: {
frames: expect.any(Array),
},
},
],
},
},
})
.start()
.completed();
});
});
20 changes: 13 additions & 7 deletions packages/node/src/integrations/onunhandledrejection.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Client, IntegrationFn } from '@sentry/core';
import type { Client, IntegrationFn, SeverityLevel } from '@sentry/core';
import { captureException, consoleSandbox, defineIntegration, getClient } from '@sentry/core';
import { logAndExitProcess } from '../utils/errorhandling';

Expand All@@ -15,12 +15,15 @@ interface OnUnhandledRejectionOptions {
const INTEGRATION_NAME = 'OnUnhandledRejection';

const _onUnhandledRejectionIntegration = ((options: Partial<OnUnhandledRejectionOptions> = {}) => {
const mode = options.mode || 'warn';
const opts = {
mode: 'warn',
...options,
} satisfies OnUnhandledRejectionOptions;

return {
name: INTEGRATION_NAME,
setup(client) {
global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, { mode }));
global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, opts));
},
};
}) satisfies IntegrationFn;
Expand All@@ -46,25 +49,28 @@ export function makeUnhandledPromiseHandler(
return;
}

const level: SeverityLevel = options.mode === 'strict' ? 'fatal' : 'error';

captureException(reason, {
originalException: promise,
captureContext: {
extra: { unhandledPromiseRejection: true },
level,
},
mechanism: {
handled: false,
type: 'onunhandledrejection',
},
});

handleRejection(reason, options);
handleRejection(reason, options.mode);
};
}

/**
* Handler for `mode` option
*/
function handleRejection(reason: unknown, options: OnUnhandledRejectionOptions): void {
function handleRejection(reason: unknown, mode: UnhandledRejectionMode): void {
// https://github.com/nodejs/node/blob/7cf6f9e964aa00772965391c23acda6d71972a9a/lib/internal/process/promises.js#L234-L240
const rejectionWarning =
'This error originated either by ' +
Expand All@@ -73,12 +79,12 @@ function handleRejection(reason: unknown, options: OnUnhandledRejectionOptions):
' The promise rejected with the reason:';

/* eslint-disable no-console */
if (options.mode === 'warn') {
if (mode === 'warn') {
consoleSandbox(() => {
console.warn(rejectionWarning);
console.error(reason && typeof reason === 'object' && 'stack' in reason ? reason.stack : reason);
});
} else if (options.mode === 'strict') {
} else if (mode === 'strict') {
consoleSandbox(() => {
console.warn(rejectionWarning);
});
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(node): Use `fatal` level for unhandled rejections in `strict` mode by mydea · Pull Request #15720 · getsentry/sentry-javascript · GitHub
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'none' })],
});

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'strict' })],
});

setTimeout(() => {
// should not be called
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
const Sentry = require('@sentry/node');

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

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject(new Error('test rejection'));
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
const Sentry = require('@sentry/node');

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

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
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,
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'strict' })],
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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,
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
import * as childProcess from 'child_process';
import * as path from 'path';
import { afterAll, describe, expect, test } from 'vitest';
import { cleanupChildProcesses } from '../../../utils/runner';
import { createRunner } from '../../../utils/runner';

describe('onUnhandledRejectionIntegration', () => {
afterAll(() => {
cleanupChildProcesses();
});

test('should show string-type promise rejection warnings by default', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-warn-string.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr.trim())
.toBe(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
test rejection`);
done();
});
}));

test('should show error-type promise rejection warnings by default', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-warn-error.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr)
.toContain(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
Error: test rejection
at Object.<anonymous>`);
done();
});
}));

test('should not close process on unhandled rejection in strict mode', () =>
new Promise<void>(done => {
expect.assertions(4);

const testScriptPath = path.resolve(__dirname, 'mode-strict.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).not.toBeNull();
expect(err?.code).toBe(1);
expect(stdout).not.toBe("I'm alive!");
expect(stderr)
.toContain(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
test rejection`);
done();
});
}));

test('should not close process or warn on unhandled rejection in none mode', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-none.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr).toBe('');
done();
});
}));

test('captures exceptions for unhandled rejections', async () => {
await createRunner(__dirname, 'scenario-warn.ts')
.expect({
event: {
level: 'error',
exception: {
values: [
{
type: 'Error',
value: 'test rejection',
mechanism: {
type: 'onunhandledrejection',
handled: false,
},
stacktrace: {
frames: expect.any(Array),
},
},
],
},
},
})
.start()
.completed();
});

test('captures exceptions for unhandled rejections in strict mode', async () => {
await createRunner(__dirname, 'scenario-strict.ts')
.expect({
event: {
level: 'fatal',
exception: {
values: [
{
type: 'Error',
value: 'test rejection',
mechanism: {
type: 'onunhandledrejection',
handled: false,
},
stacktrace: {
frames: expect.any(Array),
},
},
],
},
},
})
.start()
.completed();
});
});
20 changes: 13 additions & 7 deletions packages/node/src/integrations/onunhandledrejection.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Client, IntegrationFn } from '@sentry/core';
import type { Client, IntegrationFn, SeverityLevel } from '@sentry/core';
import { captureException, consoleSandbox, defineIntegration, getClient } from '@sentry/core';
import { logAndExitProcess } from '../utils/errorhandling';

Expand All@@ -15,12 +15,15 @@ interface OnUnhandledRejectionOptions {
const INTEGRATION_NAME = 'OnUnhandledRejection';

const _onUnhandledRejectionIntegration = ((options: Partial<OnUnhandledRejectionOptions> = {}) => {
const mode = options.mode || 'warn';
const opts = {
mode: 'warn',
...options,
} satisfies OnUnhandledRejectionOptions;

return {
name: INTEGRATION_NAME,
setup(client) {
global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, { mode }));
global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, opts));
},
};
}) satisfies IntegrationFn;
Expand All@@ -46,25 +49,28 @@ export function makeUnhandledPromiseHandler(
return;
}

const level: SeverityLevel = options.mode === 'strict' ? 'fatal' : 'error';

captureException(reason, {
originalException: promise,
captureContext: {
extra: { unhandledPromiseRejection: true },
level,
},
mechanism: {
handled: false,
type: 'onunhandledrejection',
},
});

handleRejection(reason, options);
handleRejection(reason, options.mode);
};
}

/**
* Handler for `mode` option
*/
function handleRejection(reason: unknown, options: OnUnhandledRejectionOptions): void {
function handleRejection(reason: unknown, mode: UnhandledRejectionMode): void {
// https://github.com/nodejs/node/blob/7cf6f9e964aa00772965391c23acda6d71972a9a/lib/internal/process/promises.js#L234-L240
const rejectionWarning =
'This error originated either by ' +
Expand All@@ -73,12 +79,12 @@ function handleRejection(reason: unknown, options: OnUnhandledRejectionOptions):
' The promise rejected with the reason:';

/* eslint-disable no-console */
if (options.mode === 'warn') {
if (mode === 'warn') {
consoleSandbox(() => {
console.warn(rejectionWarning);
console.error(reason && typeof reason === 'object' && 'stack' in reason ? reason.stack : reason);
});
} else if (options.mode === 'strict') {
} else if (mode === 'strict') {
consoleSandbox(() => {
console.warn(rejectionWarning);
});
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); fix(node): Use `fatal` level for unhandled rejections in `strict` mode by mydea · Pull Request #15720 · getsentry/sentry-javascript · GitHub
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'none' })],
});

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'strict' })],
});

setTimeout(() => {
// should not be called
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
const Sentry = require('@sentry/node');

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

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject(new Error('test rejection'));
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
const Sentry = require('@sentry/node');

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

setTimeout(() => {
process.stdout.write("I'm alive!");
process.exit(0);
}, 500);

Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
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,
integrations: [Sentry.onUnhandledRejectionIntegration({ mode: 'strict' })],
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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,
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.reject('test rejection');
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
import * as childProcess from 'child_process';
import * as path from 'path';
import { afterAll, describe, expect, test } from 'vitest';
import { cleanupChildProcesses } from '../../../utils/runner';
import { createRunner } from '../../../utils/runner';

describe('onUnhandledRejectionIntegration', () => {
afterAll(() => {
cleanupChildProcesses();
});

test('should show string-type promise rejection warnings by default', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-warn-string.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr.trim())
.toBe(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
test rejection`);
done();
});
}));

test('should show error-type promise rejection warnings by default', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-warn-error.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr)
.toContain(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
Error: test rejection
at Object.<anonymous>`);
done();
});
}));

test('should not close process on unhandled rejection in strict mode', () =>
new Promise<void>(done => {
expect.assertions(4);

const testScriptPath = path.resolve(__dirname, 'mode-strict.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).not.toBeNull();
expect(err?.code).toBe(1);
expect(stdout).not.toBe("I'm alive!");
expect(stderr)
.toContain(`This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason:
test rejection`);
done();
});
}));

test('should not close process or warn on unhandled rejection in none mode', () =>
new Promise<void>(done => {
expect.assertions(3);

const testScriptPath = path.resolve(__dirname, 'mode-none.js');

childProcess.execFile('node', [testScriptPath], { encoding: 'utf8' }, (err, stdout, stderr) => {
expect(err).toBeNull();
expect(stdout).toBe("I'm alive!");
expect(stderr).toBe('');
done();
});
}));

test('captures exceptions for unhandled rejections', async () => {
await createRunner(__dirname, 'scenario-warn.ts')
.expect({
event: {
level: 'error',
exception: {
values: [
{
type: 'Error',
value: 'test rejection',
mechanism: {
type: 'onunhandledrejection',
handled: false,
},
stacktrace: {
frames: expect.any(Array),
},
},
],
},
},
})
.start()
.completed();
});

test('captures exceptions for unhandled rejections in strict mode', async () => {
await createRunner(__dirname, 'scenario-strict.ts')
.expect({
event: {
level: 'fatal',
exception: {
values: [
{
type: 'Error',
value: 'test rejection',
mechanism: {
type: 'onunhandledrejection',
handled: false,
},
stacktrace: {
frames: expect.any(Array),
},
},
],
},
},
})
.start()
.completed();
});
});
20 changes: 13 additions & 7 deletions packages/node/src/integrations/onunhandledrejection.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { Client, IntegrationFn } from '@sentry/core';
import type { Client, IntegrationFn, SeverityLevel } from '@sentry/core';
import { captureException, consoleSandbox, defineIntegration, getClient } from '@sentry/core';
import { logAndExitProcess } from '../utils/errorhandling';

Expand All@@ -15,12 +15,15 @@ interface OnUnhandledRejectionOptions {
const INTEGRATION_NAME = 'OnUnhandledRejection';

const _onUnhandledRejectionIntegration = ((options: Partial<OnUnhandledRejectionOptions> = {}) => {
const mode = options.mode || 'warn';
const opts = {
mode: 'warn',
...options,
} satisfies OnUnhandledRejectionOptions;

return {
name: INTEGRATION_NAME,
setup(client) {
global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, { mode }));
global.process.on('unhandledRejection', makeUnhandledPromiseHandler(client, opts));
},
};
}) satisfies IntegrationFn;
Expand All@@ -46,25 +49,28 @@ export function makeUnhandledPromiseHandler(
return;
}

const level: SeverityLevel = options.mode === 'strict' ? 'fatal' : 'error';

captureException(reason, {
originalException: promise,
captureContext: {
extra: { unhandledPromiseRejection: true },
level,
},
mechanism: {
handled: false,
type: 'onunhandledrejection',
},
});

handleRejection(reason, options);
handleRejection(reason, options.mode);
};
}

/**
* Handler for `mode` option
*/
function handleRejection(reason: unknown, options: OnUnhandledRejectionOptions): void {
function handleRejection(reason: unknown, mode: UnhandledRejectionMode): void {
// https://github.com/nodejs/node/blob/7cf6f9e964aa00772965391c23acda6d71972a9a/lib/internal/process/promises.js#L234-L240
const rejectionWarning =
'This error originated either by ' +
Expand All@@ -73,12 +79,12 @@ function handleRejection(reason: unknown, options: OnUnhandledRejectionOptions):
' The promise rejected with the reason:';

/* eslint-disable no-console */
if (options.mode === 'warn') {
if (mode === 'warn') {
consoleSandbox(() => {
console.warn(rejectionWarning);
console.error(reason && typeof reason === 'object' && 'stack' in reason ? reason.stack : reason);
});
} else if (options.mode === 'strict') {
} else if (mode === 'strict') {
consoleSandbox(() => {
console.warn(rejectionWarning);
});
Expand Down