fix(core, node): support loading Express options lazily#20211

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
isaacs merged 1 commit into from
Apr 13, 2026
Merged

fix(core, node): support loading Express options lazily #20211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions dev-packages/node-integration-tests/suites/express/late-init/instrument.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

// First: preload the express instrumentation without calling Sentry.init().
// registers OTel module hook, patches the Express module with no config.
Sentry.preloadOpenTelemetry({ integrations: ['Express'] });

// call Sentry.init() with express integration config.
// instrumentExpress is already registered, so this calls setConfig() on the
// existing instrumentation to update its options. The lazy getOptions()
// in patchLayer ensures the updated options are read at request time.
Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
// suppress the middleware layer that the cors module generates
integrations: [Sentry.expressIntegration({ ignoreLayersType: ['middleware'] })],
});
18 changes: 18 additions & 0 deletions dev-packages/node-integration-tests/suites/express/late-init/scenario.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import cors from 'cors';
import express from 'express';
import * as Sentry from '@sentry/node';
import { startExpressServerAndSendPortToRunner } from '@sentry-internal/node-integration-tests';

const app = express();

// cors() would normally create a 'middleware' type span, but the
// ignoreLayersType: ['middleware'] option set via Sentry.init() suppresses it.
app.use(cors());

app.get('/test/express', (_req, res) => {
res.send({ response: 'response 1' });
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);
49 changes: 49 additions & 0 deletions dev-packages/node-integration-tests/suites/express/late-init/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import { afterAll, describe, expect } from 'vitest';
import { assertSentryTransaction } from '../../../utils/assertions';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

describe('express late init', () => {
afterAll(() => {
cleanupChildProcesses();
});

createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
test('applies expressIntegration config set via Sentry.init() called after instrumentExpress()', async () => {
const runner = createRunner()
.expect({
transaction: transaction => {
assertSentryTransaction(transaction, {
transaction: 'GET /test/express',
contexts: {
trace: {
op: 'http.server',
status: 'ok',
},
},
});
// request_handler span IS present
// confirms the express patch was applied.
expect(transaction.spans).toContainEqual(
expect.objectContaining({
data: expect.objectContaining({
'express.type': 'request_handler',
}),
}),
);
// Middleware spans NOT present, ignoreLayersType: ['middleware']
// configured via the Sentry.init() AFTER instrumentExpress().
expect(transaction.spans).not.toContainEqual(
expect.objectContaining({
data: expect.objectContaining({
'express.type': 'middleware',
}),
}),
);
},
})
.start();
runner.makeRequest('get', '/test/express');
await runner.completed();
});
});
});
60 changes: 53 additions & 7 deletions packages/core/src/integrations/express/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,24 @@ import { setSDKProcessingMetadata } from './set-sdk-processing-metadata';
const getExpressExport = (express: ExpressModuleExport): ExpressExport =>
hasDefaultProp(express) ? express.default : (express as ExpressExport);

function isLegacyOptions(
options: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),
): options is ExpressIntegrationOptions & { express: ExpressModuleExport } {
return !!(options as { express: ExpressModuleExport }).express;
}

// TODO: remove this deprecation handling in v11
let didLegacyDeprecationWarning = false;
function deprecationWarning() {
if (!didLegacyDeprecationWarning) {
didLegacyDeprecationWarning = true;
DEBUG_BUILD &&
debug.warn(
'[Express] `patchExpressModule(options)` is deprecated. Use `patchExpressModule(moduleExports, getOptions)` instead.',
);
}
}

/**
* This is a portable instrumentatiton function that works in any environment
* where Express can be loaded, without depending on OpenTelemetry.
Expand All@@ -69,11 +87,39 @@ const getExpressExport = (express: ExpressModuleExport): ExpressExport =>
* import express from 'express';
* import * as Sentry from '@sentry/deno'; // or any SDK that extends core
*
* Sentry.patchExpressModule({ express })
* Sentry.patchExpressModule(express, () => ({}));
* ```
*/
export const patchExpressModule = (options: ExpressIntegrationOptions) => {
export function patchExpressModule(
moduleExports: ExpressModuleExport,
getOptions: () => ExpressIntegrationOptions,
): ExpressModuleExport;
/**
* @deprecated Pass the Express module export as the first argument and options getter as the second argument.
*/
export function patchExpressModule(
options: ExpressIntegrationOptions & { express: ExpressModuleExport },
): ExpressModuleExport;
export function patchExpressModule(
optionsOrExports: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),
maybeGetOptions?: () => ExpressIntegrationOptions,
): ExpressModuleExport {
let getOptions: () => ExpressIntegrationOptions;
let moduleExports: ExpressModuleExport;
if (!maybeGetOptions && isLegacyOptions(optionsOrExports)) {
const { express, ...options } = optionsOrExports;
moduleExports = express;
getOptions = () => options;
deprecationWarning();
} else if (typeof maybeGetOptions !== 'function') {
throw new TypeError('`patchExpressModule(moduleExports, getOptions)` requires a `getOptions` callback');
} else {
getOptions = maybeGetOptions;
moduleExports = optionsOrExports as ExpressModuleExport;
}

@cursorcursorBotApr 10, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Public API function signature changed for exported function

Low Severity

Flagging per the review rules file: patchExpressModule is publicly exported from @sentry/core and its function signature changed from a single-argument form to a two-argument overloaded form. Additionally, the publicly exported ExpressIntegrationOptions type changed the express field from required to optional. While backward compatibility is maintained via a deprecated overload and runtime deprecation warning, consumers who stored options in a variable typed as ExpressIntegrationOptions and passed it to patchExpressModule will encounter a TypeScript error, since the deprecated overload requires ExpressIntegrationOptions & { express: ExpressModuleExport } which the now-optional express field no longer satisfies.

Additional Locations (1)
Fix in CursorFix in Web

Triggered by project rule: PR Review Guidelines for Cursor Bot

Reviewed by Cursor Bugbot for commit 0be7618. Configure here.


// pass in the require() or import() result of express
const express = getExpressExport(options.express);
const express = getExpressExport(moduleExports);
const routerProto: ExpressRouterv4 | ExpressRouterv5 | undefined = isExpressWithRouterPrototype(express)
? express.Router.prototype // Express v5
: isExpressWithoutRouterPrototype(express)
Expand All@@ -93,7 +139,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
function routeTrace(this: ExpressRouter, ...args: Parameters<typeof originalRouteMethod>[]) {
const route = originalRouteMethod.apply(this, args);
const layer = this.stack[this.stack.length - 1] as ExpressLayer;
patchLayer(options, layer, getLayerPath(args));
patchLayer(getOptions, layer, getLayerPath(args));
return route;
},
);
Expand All@@ -113,7 +159,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
if (!layer) {
return route;
}
patchLayer(options, layer, getLayerPath(args));
patchLayer(getOptions, layer, getLayerPath(args));
return route;
},
);
Expand DownExpand Up@@ -141,7 +187,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
if (router) {
const layer = router.stack[router.stack.length - 1];
if (layer) {
patchLayer(options, layer, getLayerPath(args));
patchLayer(getOptions, layer, getLayerPath(args));
}
}
return route;
Expand All@@ -152,7 +198,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
}

return express;
};
}

/**
* An Express-compatible error handler, used by setupExpressErrorHandler
Expand Down
8 changes: 7 additions & 1 deletion packages/core/src/integrations/express/patch-layer.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,11 @@ export type ExpressPatchLayerOptions = Pick<
'onRouteResolved' | 'ignoreLayers' | 'ignoreLayersType'
>;

export function patchLayer(options: ExpressPatchLayerOptions, maybeLayer?: ExpressLayer, layerPath?: string): void {
export function patchLayer(
getOptions: () => ExpressPatchLayerOptions,
maybeLayer?: ExpressLayer,
layerPath?: string,
): void {
if (!maybeLayer?.handle) {
return;
}
Expand All@@ -86,6 +90,8 @@ export function patchLayer(options: ExpressPatchLayerOptions, maybeLayer?: Expre
//oxlint-disable-next-line no-explicit-any
...otherArgs: any[]
) {
const options = getOptions();

// Set normalizedRequest here because expressRequestHandler middleware
// (registered via setupExpressErrorHandler) is added after routes and
// therefore never runs for successful requests — route handlers typically
Expand Down
7 changes: 6 additions & 1 deletion packages/core/src/integrations/express/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -136,7 +136,12 @@ export type ExpressRouter = {
export type IgnoreMatcher = string | RegExp | ((name: string) => boolean);

export type ExpressIntegrationOptions = {
express: ExpressModuleExport; //Express
Comment thread
isaacs marked this conversation as resolved.
/**
* @deprecated Pass the express module as the first argument, and an
* options getter as the second argument to patchExpressModule.
*/
express?: ExpressModuleExport;

/** Ignore specific based on their name */
ignoreLayers?: IgnoreMatcher[];
/** Ignore specific layers based on their type */
Expand Down
Loading
Loading
, '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(core, node): support loading Express options lazily#20211

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

isaacs
merged 1 commit into

from

Apr 13, 2026
 Merged


fix(core, node): support loading Express options lazily
#20211
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

// First: preload the express instrumentation without calling Sentry.init().
// registers OTel module hook, patches the Express module with no config.
Sentry.preloadOpenTelemetry({ integrations: ['Express'] });

// call Sentry.init() with express integration config.
// instrumentExpress is already registered, so this calls setConfig() on the
// existing instrumentation to update its options. The lazy getOptions()
// in patchLayer ensures the updated options are read at request time.
Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
 transport: loggingTransport,
 // suppress the middleware layer that the cors module generates
 integrations: [Sentry.expressIntegration({ ignoreLayersType: ['middleware'] })],
});

18 changes: 18 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import cors from 'cors';
import express from 'express';
import * as Sentry from '@sentry/node';
import { startExpressServerAndSendPortToRunner } from '@sentry-internal/node-integration-tests';

const app = express();

// cors() would normally create a 'middleware' type span, but the
// ignoreLayersType: ['middleware'] option set via Sentry.init() suppresses it.
app.use(cors());

app.get('/test/express', (_req, res) => {
 res.send({ response: 'response 1' });
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);

49 changes: 49 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import { afterAll, describe, expect } from 'vitest';
import { assertSentryTransaction } from '../../../utils/assertions';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

describe('express late init', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
 test('applies expressIntegration config set via Sentry.init() called after instrumentExpress()', async () => {
 const runner = createRunner()
 .expect({
 transaction: transaction => {
 assertSentryTransaction(transaction, {
 transaction: 'GET /test/express',
 contexts: {
 trace: {
 op: 'http.server',
 status: 'ok',
 },
 },
 });
 // request_handler span IS present
 // confirms the express patch was applied.
 expect(transaction.spans).toContainEqual(
 expect.objectContaining({
 data: expect.objectContaining({
 'express.type': 'request_handler',
 }),
 }),
 );
 // Middleware spans NOT present, ignoreLayersType: ['middleware']
 // configured via the Sentry.init() AFTER instrumentExpress().
 expect(transaction.spans).not.toContainEqual(
 expect.objectContaining({
 data: expect.objectContaining({
 'express.type': 'middleware',
 }),
 }),
 );
 },
 })
 .start();
 runner.makeRequest('get', '/test/express');
 await runner.completed();
 });
 });
});

60 changes: 53 additions & 7 deletions
packages/core/src/integrations/express/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,24 @@ import { setSDKProcessingMetadata } from './set-sdk-processing-metadata';
const getExpressExport = (express: ExpressModuleExport): ExpressExport =>
 hasDefaultProp(express) ? express.default : (express as ExpressExport);

function isLegacyOptions(
 options: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),
): options is ExpressIntegrationOptions & { express: ExpressModuleExport } {
 return !!(options as { express: ExpressModuleExport }).express;
}

// TODO: remove this deprecation handling in v11
let didLegacyDeprecationWarning = false;
function deprecationWarning() {
 if (!didLegacyDeprecationWarning) {
 didLegacyDeprecationWarning = true;
 DEBUG_BUILD &&
 debug.warn(
 '[Express] `patchExpressModule(options)` is deprecated. Use `patchExpressModule(moduleExports, getOptions)` instead.',
 );
 }
}

/**
 * This is a portable instrumentatiton function that works in any environment
 * where Express can be loaded, without depending on OpenTelemetry.
Expand All@@ -69,11 +87,39 @@ const getExpressExport = (express: ExpressModuleExport): ExpressExport =>
 * import express from 'express';
 * import * as Sentry from '@sentry/deno'; // or any SDK that extends core
 *
 * Sentry.patchExpressModule({ express })
 * Sentry.patchExpressModule(express, () => ({}));
 * ```
 */
export const patchExpressModule = (options: ExpressIntegrationOptions) => {
export function patchExpressModule(
 moduleExports: ExpressModuleExport,
 getOptions: () => ExpressIntegrationOptions,
): ExpressModuleExport;
/**
 * @deprecated Pass the Express module export as the first argument and options getter as the second argument.
 */
export function patchExpressModule(
 options: ExpressIntegrationOptions & { express: ExpressModuleExport },
): ExpressModuleExport;
export function patchExpressModule(
 optionsOrExports: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),
 maybeGetOptions?: () => ExpressIntegrationOptions,
): ExpressModuleExport {
 let getOptions: () => ExpressIntegrationOptions;
 let moduleExports: ExpressModuleExport;
 if (!maybeGetOptions && isLegacyOptions(optionsOrExports)) {
 const { express, ...options } = optionsOrExports;
 moduleExports = express;
 getOptions = () => options;
 deprecationWarning();
 } else if (typeof maybeGetOptions !== 'function') {
 throw new TypeError('`patchExpressModule(moduleExports, getOptions)` requires a `getOptions` callback');
 } else {
 getOptions = maybeGetOptions;
 moduleExports = optionsOrExports as ExpressModuleExport;
 }
@cursorcursorBotApr 10, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Public API function signature changed for exported function
Low Severity
Flagging per the review rules file: patchExpressModule is publicly exported from @sentry/core and its function signature changed from a single-argument form to a two-argument overloaded form. Additionally, the publicly exported ExpressIntegrationOptions type changed the express field from required to optional. While backward compatibility is maintained via a deprecated overload and runtime deprecation warning, consumers who stored options in a variable typed as ExpressIntegrationOptions and passed it to patchExpressModule will encounter a TypeScript error, since the deprecated overload requires ExpressIntegrationOptions & { express: ExpressModuleExport } which the now-optional express field no longer satisfies.
Additional Locations (1)
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 0be7618. Configure here.

 // pass in the require() or import() result of express
 const express = getExpressExport(options.express);
 const express = getExpressExport(moduleExports);
 const routerProto: ExpressRouterv4 | ExpressRouterv5 | undefined = isExpressWithRouterPrototype(express)
 ? express.Router.prototype // Express v5
 : isExpressWithoutRouterPrototype(express)
Expand All@@ -93,7 +139,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 function routeTrace(this: ExpressRouter, ...args: Parameters<typeof originalRouteMethod>[]) {
 const route = originalRouteMethod.apply(this, args);
 const layer = this.stack[this.stack.length - 1] as ExpressLayer;
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 return route;
 },
 );
Expand All@@ -113,7 +159,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 if (!layer) {
 return route;
 }
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 return route;
 },
 );
Expand DownExpand Up@@ -141,7 +187,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 if (router) {
 const layer = router.stack[router.stack.length - 1];
 if (layer) {
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 }
 }
 return route;
Expand All@@ -152,7 +198,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 }

 return express;
};
}

/**
 * An Express-compatible error handler, used by setupExpressErrorHandler
Expand Down

8 changes: 7 additions & 1 deletion
packages/core/src/integrations/express/patch-layer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,11 @@ export type ExpressPatchLayerOptions = Pick<
 'onRouteResolved' | 'ignoreLayers' | 'ignoreLayersType'
>;

export function patchLayer(options: ExpressPatchLayerOptions, maybeLayer?: ExpressLayer, layerPath?: string): void {
export function patchLayer(
 getOptions: () => ExpressPatchLayerOptions,
 maybeLayer?: ExpressLayer,
 layerPath?: string,
): void {
 if (!maybeLayer?.handle) {
 return;
 }
Expand All@@ -86,6 +90,8 @@ export function patchLayer(options: ExpressPatchLayerOptions, maybeLayer?: Expre
 //oxlint-disable-next-line no-explicit-any
 ...otherArgs: any[]
 ) {
 const options = getOptions();

 // Set normalizedRequest here because expressRequestHandler middleware
 // (registered via setupExpressErrorHandler) is added after routes and
 // therefore never runs for successful requests — route handlers typically
Expand Down

7 changes: 6 additions & 1 deletion
packages/core/src/integrations/express/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,7 +136,12 @@ export type ExpressRouter = {
export type IgnoreMatcher = string | RegExp | ((name: string) => boolean);

export type ExpressIntegrationOptions = {
 express: ExpressModuleExport; //Express
Comment thread
isaacs marked this conversation as resolved.

 /**
 * @deprecated Pass the express module as the first argument, and an
 * options getter as the second argument to patchExpressModule.
 */
 express?: ExpressModuleExport;

 /** Ignore specific based on their name */
 ignoreLayers?: IgnoreMatcher[];
 /** Ignore specific layers based on their type */
Expand Down
Loading
Loading

, '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(core, node): support loading Express options lazily#20211

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

isaacs
merged 1 commit into

from

Apr 13, 2026
 Merged


fix(core, node): support loading Express options lazily
#20211
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

// First: preload the express instrumentation without calling Sentry.init().
// registers OTel module hook, patches the Express module with no config.
Sentry.preloadOpenTelemetry({ integrations: ['Express'] });

// call Sentry.init() with express integration config.
// instrumentExpress is already registered, so this calls setConfig() on the
// existing instrumentation to update its options. The lazy getOptions()
// in patchLayer ensures the updated options are read at request time.
Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
 transport: loggingTransport,
 // suppress the middleware layer that the cors module generates
 integrations: [Sentry.expressIntegration({ ignoreLayersType: ['middleware'] })],
});

18 changes: 18 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import cors from 'cors';
import express from 'express';
import * as Sentry from '@sentry/node';
import { startExpressServerAndSendPortToRunner } from '@sentry-internal/node-integration-tests';

const app = express();

// cors() would normally create a 'middleware' type span, but the
// ignoreLayersType: ['middleware'] option set via Sentry.init() suppresses it.
app.use(cors());

app.get('/test/express', (_req, res) => {
 res.send({ response: 'response 1' });
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);

49 changes: 49 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import { afterAll, describe, expect } from 'vitest';
import { assertSentryTransaction } from '../../../utils/assertions';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

describe('express late init', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
 test('applies expressIntegration config set via Sentry.init() called after instrumentExpress()', async () => {
 const runner = createRunner()
 .expect({
 transaction: transaction => {
 assertSentryTransaction(transaction, {
 transaction: 'GET /test/express',
 contexts: {
 trace: {
 op: 'http.server',
 status: 'ok',
 },
 },
 });
 // request_handler span IS present
 // confirms the express patch was applied.
 expect(transaction.spans).toContainEqual(
 expect.objectContaining({
 data: expect.objectContaining({
 'express.type': 'request_handler',
 }),
 }),
 );
 // Middleware spans NOT present, ignoreLayersType: ['middleware']
 // configured via the Sentry.init() AFTER instrumentExpress().
 expect(transaction.spans).not.toContainEqual(
 expect.objectContaining({
 data: expect.objectContaining({
 'express.type': 'middleware',
 }),
 }),
 );
 },
 })
 .start();
 runner.makeRequest('get', '/test/express');
 await runner.completed();
 });
 });
});

60 changes: 53 additions & 7 deletions
packages/core/src/integrations/express/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,24 @@ import { setSDKProcessingMetadata } from './set-sdk-processing-metadata';
const getExpressExport = (express: ExpressModuleExport): ExpressExport =>
 hasDefaultProp(express) ? express.default : (express as ExpressExport);

function isLegacyOptions(
 options: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),
): options is ExpressIntegrationOptions & { express: ExpressModuleExport } {
 return !!(options as { express: ExpressModuleExport }).express;
}

// TODO: remove this deprecation handling in v11
let didLegacyDeprecationWarning = false;
function deprecationWarning() {
 if (!didLegacyDeprecationWarning) {
 didLegacyDeprecationWarning = true;
 DEBUG_BUILD &&
 debug.warn(
 '[Express] `patchExpressModule(options)` is deprecated. Use `patchExpressModule(moduleExports, getOptions)` instead.',
 );
 }
}

/**
 * This is a portable instrumentatiton function that works in any environment
 * where Express can be loaded, without depending on OpenTelemetry.
Expand All@@ -69,11 +87,39 @@ const getExpressExport = (express: ExpressModuleExport): ExpressExport =>
 * import express from 'express';
 * import * as Sentry from '@sentry/deno'; // or any SDK that extends core
 *
 * Sentry.patchExpressModule({ express })
 * Sentry.patchExpressModule(express, () => ({}));
 * ```
 */
export const patchExpressModule = (options: ExpressIntegrationOptions) => {
export function patchExpressModule(
 moduleExports: ExpressModuleExport,
 getOptions: () => ExpressIntegrationOptions,
): ExpressModuleExport;
/**
 * @deprecated Pass the Express module export as the first argument and options getter as the second argument.
 */
export function patchExpressModule(
 options: ExpressIntegrationOptions & { express: ExpressModuleExport },
): ExpressModuleExport;
export function patchExpressModule(
 optionsOrExports: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),
 maybeGetOptions?: () => ExpressIntegrationOptions,
): ExpressModuleExport {
 let getOptions: () => ExpressIntegrationOptions;
 let moduleExports: ExpressModuleExport;
 if (!maybeGetOptions && isLegacyOptions(optionsOrExports)) {
 const { express, ...options } = optionsOrExports;
 moduleExports = express;
 getOptions = () => options;
 deprecationWarning();
 } else if (typeof maybeGetOptions !== 'function') {
 throw new TypeError('`patchExpressModule(moduleExports, getOptions)` requires a `getOptions` callback');
 } else {
 getOptions = maybeGetOptions;
 moduleExports = optionsOrExports as ExpressModuleExport;
 }
@cursorcursorBotApr 10, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Public API function signature changed for exported function
Low Severity
Flagging per the review rules file: patchExpressModule is publicly exported from @sentry/core and its function signature changed from a single-argument form to a two-argument overloaded form. Additionally, the publicly exported ExpressIntegrationOptions type changed the express field from required to optional. While backward compatibility is maintained via a deprecated overload and runtime deprecation warning, consumers who stored options in a variable typed as ExpressIntegrationOptions and passed it to patchExpressModule will encounter a TypeScript error, since the deprecated overload requires ExpressIntegrationOptions & { express: ExpressModuleExport } which the now-optional express field no longer satisfies.
Additional Locations (1)
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 0be7618. Configure here.

 // pass in the require() or import() result of express
 const express = getExpressExport(options.express);
 const express = getExpressExport(moduleExports);
 const routerProto: ExpressRouterv4 | ExpressRouterv5 | undefined = isExpressWithRouterPrototype(express)
 ? express.Router.prototype // Express v5
 : isExpressWithoutRouterPrototype(express)
Expand All@@ -93,7 +139,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 function routeTrace(this: ExpressRouter, ...args: Parameters<typeof originalRouteMethod>[]) {
 const route = originalRouteMethod.apply(this, args);
 const layer = this.stack[this.stack.length - 1] as ExpressLayer;
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 return route;
 },
 );
Expand All@@ -113,7 +159,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 if (!layer) {
 return route;
 }
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 return route;
 },
 );
Expand DownExpand Up@@ -141,7 +187,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 if (router) {
 const layer = router.stack[router.stack.length - 1];
 if (layer) {
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 }
 }
 return route;
Expand All@@ -152,7 +198,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 }

 return express;
};
}

/**
 * An Express-compatible error handler, used by setupExpressErrorHandler
Expand Down

8 changes: 7 additions & 1 deletion
packages/core/src/integrations/express/patch-layer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,11 @@ export type ExpressPatchLayerOptions = Pick<
 'onRouteResolved' | 'ignoreLayers' | 'ignoreLayersType'
>;

export function patchLayer(options: ExpressPatchLayerOptions, maybeLayer?: ExpressLayer, layerPath?: string): void {
export function patchLayer(
 getOptions: () => ExpressPatchLayerOptions,
 maybeLayer?: ExpressLayer,
 layerPath?: string,
): void {
 if (!maybeLayer?.handle) {
 return;
 }
Expand All@@ -86,6 +90,8 @@ export function patchLayer(options: ExpressPatchLayerOptions, maybeLayer?: Expre
 //oxlint-disable-next-line no-explicit-any
 ...otherArgs: any[]
 ) {
 const options = getOptions();

 // Set normalizedRequest here because expressRequestHandler middleware
 // (registered via setupExpressErrorHandler) is added after routes and
 // therefore never runs for successful requests — route handlers typically
Expand Down

7 changes: 6 additions & 1 deletion
packages/core/src/integrations/express/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,7 +136,12 @@ export type ExpressRouter = {
export type IgnoreMatcher = string | RegExp | ((name: string) => boolean);

export type ExpressIntegrationOptions = {
 express: ExpressModuleExport; //Express
Comment thread
isaacs marked this conversation as resolved.

 /**
 * @deprecated Pass the express module as the first argument, and an
 * options getter as the second argument to patchExpressModule.
 */
 express?: ExpressModuleExport;

 /** Ignore specific based on their name */
 ignoreLayers?: IgnoreMatcher[];
 /** Ignore specific layers based on their type */
Expand Down
Loading
Loading

, '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(core, node): support loading Express options lazily#20211

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

isaacs
merged 1 commit into

from

Apr 13, 2026
 Merged


fix(core, node): support loading Express options lazily
#20211
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

// First: preload the express instrumentation without calling Sentry.init().
// registers OTel module hook, patches the Express module with no config.
Sentry.preloadOpenTelemetry({ integrations: ['Express'] });

// call Sentry.init() with express integration config.
// instrumentExpress is already registered, so this calls setConfig() on the
// existing instrumentation to update its options. The lazy getOptions()
// in patchLayer ensures the updated options are read at request time.
Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
 transport: loggingTransport,
 // suppress the middleware layer that the cors module generates
 integrations: [Sentry.expressIntegration({ ignoreLayersType: ['middleware'] })],
});

18 changes: 18 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import cors from 'cors';
import express from 'express';
import * as Sentry from '@sentry/node';
import { startExpressServerAndSendPortToRunner } from '@sentry-internal/node-integration-tests';

const app = express();

// cors() would normally create a 'middleware' type span, but the
// ignoreLayersType: ['middleware'] option set via Sentry.init() suppresses it.
app.use(cors());

app.get('/test/express', (_req, res) => {
 res.send({ response: 'response 1' });
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);

49 changes: 49 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import { afterAll, describe, expect } from 'vitest';
import { assertSentryTransaction } from '../../../utils/assertions';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

describe('express late init', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
 test('applies expressIntegration config set via Sentry.init() called after instrumentExpress()', async () => {
 const runner = createRunner()
 .expect({
 transaction: transaction => {
 assertSentryTransaction(transaction, {
 transaction: 'GET /test/express',
 contexts: {
 trace: {
 op: 'http.server',
 status: 'ok',
 },
 },
 });
 // request_handler span IS present
 // confirms the express patch was applied.
 expect(transaction.spans).toContainEqual(
 expect.objectContaining({
 data: expect.objectContaining({
 'express.type': 'request_handler',
 }),
 }),
 );
 // Middleware spans NOT present, ignoreLayersType: ['middleware']
 // configured via the Sentry.init() AFTER instrumentExpress().
 expect(transaction.spans).not.toContainEqual(
 expect.objectContaining({
 data: expect.objectContaining({
 'express.type': 'middleware',
 }),
 }),
 );
 },
 })
 .start();
 runner.makeRequest('get', '/test/express');
 await runner.completed();
 });
 });
});

60 changes: 53 additions & 7 deletions
packages/core/src/integrations/express/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,24 @@ import { setSDKProcessingMetadata } from './set-sdk-processing-metadata';
const getExpressExport = (express: ExpressModuleExport): ExpressExport =>
 hasDefaultProp(express) ? express.default : (express as ExpressExport);

function isLegacyOptions(
 options: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),
): options is ExpressIntegrationOptions & { express: ExpressModuleExport } {
 return !!(options as { express: ExpressModuleExport }).express;
}

// TODO: remove this deprecation handling in v11
let didLegacyDeprecationWarning = false;
function deprecationWarning() {
 if (!didLegacyDeprecationWarning) {
 didLegacyDeprecationWarning = true;
 DEBUG_BUILD &&
 debug.warn(
 '[Express] `patchExpressModule(options)` is deprecated. Use `patchExpressModule(moduleExports, getOptions)` instead.',
 );
 }
}

/**
 * This is a portable instrumentatiton function that works in any environment
 * where Express can be loaded, without depending on OpenTelemetry.
Expand All@@ -69,11 +87,39 @@ const getExpressExport = (express: ExpressModuleExport): ExpressExport =>
 * import express from 'express';
 * import * as Sentry from '@sentry/deno'; // or any SDK that extends core
 *
 * Sentry.patchExpressModule({ express })
 * Sentry.patchExpressModule(express, () => ({}));
 * ```
 */
export const patchExpressModule = (options: ExpressIntegrationOptions) => {
export function patchExpressModule(
 moduleExports: ExpressModuleExport,
 getOptions: () => ExpressIntegrationOptions,
): ExpressModuleExport;
/**
 * @deprecated Pass the Express module export as the first argument and options getter as the second argument.
 */
export function patchExpressModule(
 options: ExpressIntegrationOptions & { express: ExpressModuleExport },
): ExpressModuleExport;
export function patchExpressModule(
 optionsOrExports: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),
 maybeGetOptions?: () => ExpressIntegrationOptions,
): ExpressModuleExport {
 let getOptions: () => ExpressIntegrationOptions;
 let moduleExports: ExpressModuleExport;
 if (!maybeGetOptions && isLegacyOptions(optionsOrExports)) {
 const { express, ...options } = optionsOrExports;
 moduleExports = express;
 getOptions = () => options;
 deprecationWarning();
 } else if (typeof maybeGetOptions !== 'function') {
 throw new TypeError('`patchExpressModule(moduleExports, getOptions)` requires a `getOptions` callback');
 } else {
 getOptions = maybeGetOptions;
 moduleExports = optionsOrExports as ExpressModuleExport;
 }
@cursorcursorBotApr 10, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Public API function signature changed for exported function
Low Severity
Flagging per the review rules file: patchExpressModule is publicly exported from @sentry/core and its function signature changed from a single-argument form to a two-argument overloaded form. Additionally, the publicly exported ExpressIntegrationOptions type changed the express field from required to optional. While backward compatibility is maintained via a deprecated overload and runtime deprecation warning, consumers who stored options in a variable typed as ExpressIntegrationOptions and passed it to patchExpressModule will encounter a TypeScript error, since the deprecated overload requires ExpressIntegrationOptions & { express: ExpressModuleExport } which the now-optional express field no longer satisfies.
Additional Locations (1)
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 0be7618. Configure here.

 // pass in the require() or import() result of express
 const express = getExpressExport(options.express);
 const express = getExpressExport(moduleExports);
 const routerProto: ExpressRouterv4 | ExpressRouterv5 | undefined = isExpressWithRouterPrototype(express)
 ? express.Router.prototype // Express v5
 : isExpressWithoutRouterPrototype(express)
Expand All@@ -93,7 +139,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 function routeTrace(this: ExpressRouter, ...args: Parameters<typeof originalRouteMethod>[]) {
 const route = originalRouteMethod.apply(this, args);
 const layer = this.stack[this.stack.length - 1] as ExpressLayer;
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 return route;
 },
 );
Expand All@@ -113,7 +159,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 if (!layer) {
 return route;
 }
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 return route;
 },
 );
Expand DownExpand Up@@ -141,7 +187,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 if (router) {
 const layer = router.stack[router.stack.length - 1];
 if (layer) {
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 }
 }
 return route;
Expand All@@ -152,7 +198,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 }

 return express;
};
}

/**
 * An Express-compatible error handler, used by setupExpressErrorHandler
Expand Down

8 changes: 7 additions & 1 deletion
packages/core/src/integrations/express/patch-layer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,11 @@ export type ExpressPatchLayerOptions = Pick<
 'onRouteResolved' | 'ignoreLayers' | 'ignoreLayersType'
>;

export function patchLayer(options: ExpressPatchLayerOptions, maybeLayer?: ExpressLayer, layerPath?: string): void {
export function patchLayer(
 getOptions: () => ExpressPatchLayerOptions,
 maybeLayer?: ExpressLayer,
 layerPath?: string,
): void {
 if (!maybeLayer?.handle) {
 return;
 }
Expand All@@ -86,6 +90,8 @@ export function patchLayer(options: ExpressPatchLayerOptions, maybeLayer?: Expre
 //oxlint-disable-next-line no-explicit-any
 ...otherArgs: any[]
 ) {
 const options = getOptions();

 // Set normalizedRequest here because expressRequestHandler middleware
 // (registered via setupExpressErrorHandler) is added after routes and
 // therefore never runs for successful requests — route handlers typically
Expand Down

7 changes: 6 additions & 1 deletion
packages/core/src/integrations/express/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,7 +136,12 @@ export type ExpressRouter = {
export type IgnoreMatcher = string | RegExp | ((name: string) => boolean);

export type ExpressIntegrationOptions = {
 express: ExpressModuleExport; //Express
Comment thread
isaacs marked this conversation as resolved.

 /**
 * @deprecated Pass the express module as the first argument, and an
 * options getter as the second argument to patchExpressModule.
 */
 express?: ExpressModuleExport;

 /** Ignore specific based on their name */
 ignoreLayers?: IgnoreMatcher[];
 /** Ignore specific layers based on their type */
Expand Down
Loading
Loading

, '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(core, node): support loading Express options lazily#20211

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

isaacs
merged 1 commit into

from

Apr 13, 2026
 Merged


fix(core, node): support loading Express options lazily
#20211
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

// First: preload the express instrumentation without calling Sentry.init().
// registers OTel module hook, patches the Express module with no config.
Sentry.preloadOpenTelemetry({ integrations: ['Express'] });

// call Sentry.init() with express integration config.
// instrumentExpress is already registered, so this calls setConfig() on the
// existing instrumentation to update its options. The lazy getOptions()
// in patchLayer ensures the updated options are read at request time.
Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
 transport: loggingTransport,
 // suppress the middleware layer that the cors module generates
 integrations: [Sentry.expressIntegration({ ignoreLayersType: ['middleware'] })],
});

18 changes: 18 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import cors from 'cors';
import express from 'express';
import * as Sentry from '@sentry/node';
import { startExpressServerAndSendPortToRunner } from '@sentry-internal/node-integration-tests';

const app = express();

// cors() would normally create a 'middleware' type span, but the
// ignoreLayersType: ['middleware'] option set via Sentry.init() suppresses it.
app.use(cors());

app.get('/test/express', (_req, res) => {
 res.send({ response: 'response 1' });
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);

49 changes: 49 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import { afterAll, describe, expect } from 'vitest';
import { assertSentryTransaction } from '../../../utils/assertions';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

describe('express late init', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
 test('applies expressIntegration config set via Sentry.init() called after instrumentExpress()', async () => {
 const runner = createRunner()
 .expect({
 transaction: transaction => {
 assertSentryTransaction(transaction, {
 transaction: 'GET /test/express',
 contexts: {
 trace: {
 op: 'http.server',
 status: 'ok',
 },
 },
 });
 // request_handler span IS present
 // confirms the express patch was applied.
 expect(transaction.spans).toContainEqual(
 expect.objectContaining({
 data: expect.objectContaining({
 'express.type': 'request_handler',
 }),
 }),
 );
 // Middleware spans NOT present, ignoreLayersType: ['middleware']
 // configured via the Sentry.init() AFTER instrumentExpress().
 expect(transaction.spans).not.toContainEqual(
 expect.objectContaining({
 data: expect.objectContaining({
 'express.type': 'middleware',
 }),
 }),
 );
 },
 })
 .start();
 runner.makeRequest('get', '/test/express');
 await runner.completed();
 });
 });
});

60 changes: 53 additions & 7 deletions
packages/core/src/integrations/express/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,24 @@ import { setSDKProcessingMetadata } from './set-sdk-processing-metadata';
const getExpressExport = (express: ExpressModuleExport): ExpressExport =>
 hasDefaultProp(express) ? express.default : (express as ExpressExport);

function isLegacyOptions(
 options: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),
): options is ExpressIntegrationOptions & { express: ExpressModuleExport } {
 return !!(options as { express: ExpressModuleExport }).express;
}

// TODO: remove this deprecation handling in v11
let didLegacyDeprecationWarning = false;
function deprecationWarning() {
 if (!didLegacyDeprecationWarning) {
 didLegacyDeprecationWarning = true;
 DEBUG_BUILD &&
 debug.warn(
 '[Express] `patchExpressModule(options)` is deprecated. Use `patchExpressModule(moduleExports, getOptions)` instead.',
 );
 }
}

/**
 * This is a portable instrumentatiton function that works in any environment
 * where Express can be loaded, without depending on OpenTelemetry.
Expand All@@ -69,11 +87,39 @@ const getExpressExport = (express: ExpressModuleExport): ExpressExport =>
 * import express from 'express';
 * import * as Sentry from '@sentry/deno'; // or any SDK that extends core
 *
 * Sentry.patchExpressModule({ express })
 * Sentry.patchExpressModule(express, () => ({}));
 * ```
 */
export const patchExpressModule = (options: ExpressIntegrationOptions) => {
export function patchExpressModule(
 moduleExports: ExpressModuleExport,
 getOptions: () => ExpressIntegrationOptions,
): ExpressModuleExport;
/**
 * @deprecated Pass the Express module export as the first argument and options getter as the second argument.
 */
export function patchExpressModule(
 options: ExpressIntegrationOptions & { express: ExpressModuleExport },
): ExpressModuleExport;
export function patchExpressModule(
 optionsOrExports: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),
 maybeGetOptions?: () => ExpressIntegrationOptions,
): ExpressModuleExport {
 let getOptions: () => ExpressIntegrationOptions;
 let moduleExports: ExpressModuleExport;
 if (!maybeGetOptions && isLegacyOptions(optionsOrExports)) {
 const { express, ...options } = optionsOrExports;
 moduleExports = express;
 getOptions = () => options;
 deprecationWarning();
 } else if (typeof maybeGetOptions !== 'function') {
 throw new TypeError('`patchExpressModule(moduleExports, getOptions)` requires a `getOptions` callback');
 } else {
 getOptions = maybeGetOptions;
 moduleExports = optionsOrExports as ExpressModuleExport;
 }
@cursorcursorBotApr 10, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Public API function signature changed for exported function
Low Severity
Flagging per the review rules file: patchExpressModule is publicly exported from @sentry/core and its function signature changed from a single-argument form to a two-argument overloaded form. Additionally, the publicly exported ExpressIntegrationOptions type changed the express field from required to optional. While backward compatibility is maintained via a deprecated overload and runtime deprecation warning, consumers who stored options in a variable typed as ExpressIntegrationOptions and passed it to patchExpressModule will encounter a TypeScript error, since the deprecated overload requires ExpressIntegrationOptions & { express: ExpressModuleExport } which the now-optional express field no longer satisfies.
Additional Locations (1)
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 0be7618. Configure here.

 // pass in the require() or import() result of express
 const express = getExpressExport(options.express);
 const express = getExpressExport(moduleExports);
 const routerProto: ExpressRouterv4 | ExpressRouterv5 | undefined = isExpressWithRouterPrototype(express)
 ? express.Router.prototype // Express v5
 : isExpressWithoutRouterPrototype(express)
Expand All@@ -93,7 +139,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 function routeTrace(this: ExpressRouter, ...args: Parameters<typeof originalRouteMethod>[]) {
 const route = originalRouteMethod.apply(this, args);
 const layer = this.stack[this.stack.length - 1] as ExpressLayer;
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 return route;
 },
 );
Expand All@@ -113,7 +159,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 if (!layer) {
 return route;
 }
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 return route;
 },
 );
Expand DownExpand Up@@ -141,7 +187,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 if (router) {
 const layer = router.stack[router.stack.length - 1];
 if (layer) {
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 }
 }
 return route;
Expand All@@ -152,7 +198,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 }

 return express;
};
}

/**
 * An Express-compatible error handler, used by setupExpressErrorHandler
Expand Down

8 changes: 7 additions & 1 deletion
packages/core/src/integrations/express/patch-layer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,11 @@ export type ExpressPatchLayerOptions = Pick<
 'onRouteResolved' | 'ignoreLayers' | 'ignoreLayersType'
>;

export function patchLayer(options: ExpressPatchLayerOptions, maybeLayer?: ExpressLayer, layerPath?: string): void {
export function patchLayer(
 getOptions: () => ExpressPatchLayerOptions,
 maybeLayer?: ExpressLayer,
 layerPath?: string,
): void {
 if (!maybeLayer?.handle) {
 return;
 }
Expand All@@ -86,6 +90,8 @@ export function patchLayer(options: ExpressPatchLayerOptions, maybeLayer?: Expre
 //oxlint-disable-next-line no-explicit-any
 ...otherArgs: any[]
 ) {
 const options = getOptions();

 // Set normalizedRequest here because expressRequestHandler middleware
 // (registered via setupExpressErrorHandler) is added after routes and
 // therefore never runs for successful requests — route handlers typically
Expand Down

7 changes: 6 additions & 1 deletion
packages/core/src/integrations/express/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,7 +136,12 @@ export type ExpressRouter = {
export type IgnoreMatcher = string | RegExp | ((name: string) => boolean);

export type ExpressIntegrationOptions = {
 express: ExpressModuleExport; //Express
Comment thread
isaacs marked this conversation as resolved.

 /**
 * @deprecated Pass the express module as the first argument, and an
 * options getter as the second argument to patchExpressModule.
 */
 express?: ExpressModuleExport;

 /** Ignore specific based on their name */
 ignoreLayers?: IgnoreMatcher[];
 /** Ignore specific layers based on their type */
Expand Down
Loading
Loading

, '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(core, node): support loading Express options lazily#20211

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

isaacs
merged 1 commit into

from

Apr 13, 2026
 Merged


fix(core, node): support loading Express options lazily
#20211
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

// First: preload the express instrumentation without calling Sentry.init().
// registers OTel module hook, patches the Express module with no config.
Sentry.preloadOpenTelemetry({ integrations: ['Express'] });

// call Sentry.init() with express integration config.
// instrumentExpress is already registered, so this calls setConfig() on the
// existing instrumentation to update its options. The lazy getOptions()
// in patchLayer ensures the updated options are read at request time.
Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
 transport: loggingTransport,
 // suppress the middleware layer that the cors module generates
 integrations: [Sentry.expressIntegration({ ignoreLayersType: ['middleware'] })],
});

18 changes: 18 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import cors from 'cors';
import express from 'express';
import * as Sentry from '@sentry/node';
import { startExpressServerAndSendPortToRunner } from '@sentry-internal/node-integration-tests';

const app = express();

// cors() would normally create a 'middleware' type span, but the
// ignoreLayersType: ['middleware'] option set via Sentry.init() suppresses it.
app.use(cors());

app.get('/test/express', (_req, res) => {
 res.send({ response: 'response 1' });
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);

49 changes: 49 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import { afterAll, describe, expect } from 'vitest';
import { assertSentryTransaction } from '../../../utils/assertions';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

describe('express late init', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
 test('applies expressIntegration config set via Sentry.init() called after instrumentExpress()', async () => {
 const runner = createRunner()
 .expect({
 transaction: transaction => {
 assertSentryTransaction(transaction, {
 transaction: 'GET /test/express',
 contexts: {
 trace: {
 op: 'http.server',
 status: 'ok',
 },
 },
 });
 // request_handler span IS present
 // confirms the express patch was applied.
 expect(transaction.spans).toContainEqual(
 expect.objectContaining({
 data: expect.objectContaining({
 'express.type': 'request_handler',
 }),
 }),
 );
 // Middleware spans NOT present, ignoreLayersType: ['middleware']
 // configured via the Sentry.init() AFTER instrumentExpress().
 expect(transaction.spans).not.toContainEqual(
 expect.objectContaining({
 data: expect.objectContaining({
 'express.type': 'middleware',
 }),
 }),
 );
 },
 })
 .start();
 runner.makeRequest('get', '/test/express');
 await runner.completed();
 });
 });
});

60 changes: 53 additions & 7 deletions
packages/core/src/integrations/express/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,24 @@ import { setSDKProcessingMetadata } from './set-sdk-processing-metadata';
const getExpressExport = (express: ExpressModuleExport): ExpressExport =>
 hasDefaultProp(express) ? express.default : (express as ExpressExport);

function isLegacyOptions(
 options: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),
): options is ExpressIntegrationOptions & { express: ExpressModuleExport } {
 return !!(options as { express: ExpressModuleExport }).express;
}

// TODO: remove this deprecation handling in v11
let didLegacyDeprecationWarning = false;
function deprecationWarning() {
 if (!didLegacyDeprecationWarning) {
 didLegacyDeprecationWarning = true;
 DEBUG_BUILD &&
 debug.warn(
 '[Express] `patchExpressModule(options)` is deprecated. Use `patchExpressModule(moduleExports, getOptions)` instead.',
 );
 }
}

/**
 * This is a portable instrumentatiton function that works in any environment
 * where Express can be loaded, without depending on OpenTelemetry.
Expand All@@ -69,11 +87,39 @@ const getExpressExport = (express: ExpressModuleExport): ExpressExport =>
 * import express from 'express';
 * import * as Sentry from '@sentry/deno'; // or any SDK that extends core
 *
 * Sentry.patchExpressModule({ express })
 * Sentry.patchExpressModule(express, () => ({}));
 * ```
 */
export const patchExpressModule = (options: ExpressIntegrationOptions) => {
export function patchExpressModule(
 moduleExports: ExpressModuleExport,
 getOptions: () => ExpressIntegrationOptions,
): ExpressModuleExport;
/**
 * @deprecated Pass the Express module export as the first argument and options getter as the second argument.
 */
export function patchExpressModule(
 options: ExpressIntegrationOptions & { express: ExpressModuleExport },
): ExpressModuleExport;
export function patchExpressModule(
 optionsOrExports: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),
 maybeGetOptions?: () => ExpressIntegrationOptions,
): ExpressModuleExport {
 let getOptions: () => ExpressIntegrationOptions;
 let moduleExports: ExpressModuleExport;
 if (!maybeGetOptions && isLegacyOptions(optionsOrExports)) {
 const { express, ...options } = optionsOrExports;
 moduleExports = express;
 getOptions = () => options;
 deprecationWarning();
 } else if (typeof maybeGetOptions !== 'function') {
 throw new TypeError('`patchExpressModule(moduleExports, getOptions)` requires a `getOptions` callback');
 } else {
 getOptions = maybeGetOptions;
 moduleExports = optionsOrExports as ExpressModuleExport;
 }
@cursorcursorBotApr 10, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Public API function signature changed for exported function
Low Severity
Flagging per the review rules file: patchExpressModule is publicly exported from @sentry/core and its function signature changed from a single-argument form to a two-argument overloaded form. Additionally, the publicly exported ExpressIntegrationOptions type changed the express field from required to optional. While backward compatibility is maintained via a deprecated overload and runtime deprecation warning, consumers who stored options in a variable typed as ExpressIntegrationOptions and passed it to patchExpressModule will encounter a TypeScript error, since the deprecated overload requires ExpressIntegrationOptions & { express: ExpressModuleExport } which the now-optional express field no longer satisfies.
Additional Locations (1)
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 0be7618. Configure here.

 // pass in the require() or import() result of express
 const express = getExpressExport(options.express);
 const express = getExpressExport(moduleExports);
 const routerProto: ExpressRouterv4 | ExpressRouterv5 | undefined = isExpressWithRouterPrototype(express)
 ? express.Router.prototype // Express v5
 : isExpressWithoutRouterPrototype(express)
Expand All@@ -93,7 +139,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 function routeTrace(this: ExpressRouter, ...args: Parameters<typeof originalRouteMethod>[]) {
 const route = originalRouteMethod.apply(this, args);
 const layer = this.stack[this.stack.length - 1] as ExpressLayer;
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 return route;
 },
 );
Expand All@@ -113,7 +159,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 if (!layer) {
 return route;
 }
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 return route;
 },
 );
Expand DownExpand Up@@ -141,7 +187,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 if (router) {
 const layer = router.stack[router.stack.length - 1];
 if (layer) {
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 }
 }
 return route;
Expand All@@ -152,7 +198,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 }

 return express;
};
}

/**
 * An Express-compatible error handler, used by setupExpressErrorHandler
Expand Down

8 changes: 7 additions & 1 deletion
packages/core/src/integrations/express/patch-layer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,11 @@ export type ExpressPatchLayerOptions = Pick<
 'onRouteResolved' | 'ignoreLayers' | 'ignoreLayersType'
>;

export function patchLayer(options: ExpressPatchLayerOptions, maybeLayer?: ExpressLayer, layerPath?: string): void {
export function patchLayer(
 getOptions: () => ExpressPatchLayerOptions,
 maybeLayer?: ExpressLayer,
 layerPath?: string,
): void {
 if (!maybeLayer?.handle) {
 return;
 }
Expand All@@ -86,6 +90,8 @@ export function patchLayer(options: ExpressPatchLayerOptions, maybeLayer?: Expre
 //oxlint-disable-next-line no-explicit-any
 ...otherArgs: any[]
 ) {
 const options = getOptions();

 // Set normalizedRequest here because expressRequestHandler middleware
 // (registered via setupExpressErrorHandler) is added after routes and
 // therefore never runs for successful requests — route handlers typically
Expand Down

7 changes: 6 additions & 1 deletion
packages/core/src/integrations/express/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,7 +136,12 @@ export type ExpressRouter = {
export type IgnoreMatcher = string | RegExp | ((name: string) => boolean);

export type ExpressIntegrationOptions = {
 express: ExpressModuleExport; //Express
Comment thread
isaacs marked this conversation as resolved.

 /**
 * @deprecated Pass the express module as the first argument, and an
 * options getter as the second argument to patchExpressModule.
 */
 express?: ExpressModuleExport;

 /** Ignore specific based on their name */
 ignoreLayers?: IgnoreMatcher[];
 /** Ignore specific layers based on their type */
Expand Down
Loading
Loading

, '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(core, node): support loading Express options lazily#20211

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

isaacs
merged 1 commit into

from

Apr 13, 2026
 Merged


fix(core, node): support loading Express options lazily
#20211
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

// First: preload the express instrumentation without calling Sentry.init().
// registers OTel module hook, patches the Express module with no config.
Sentry.preloadOpenTelemetry({ integrations: ['Express'] });

// call Sentry.init() with express integration config.
// instrumentExpress is already registered, so this calls setConfig() on the
// existing instrumentation to update its options. The lazy getOptions()
// in patchLayer ensures the updated options are read at request time.
Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
 transport: loggingTransport,
 // suppress the middleware layer that the cors module generates
 integrations: [Sentry.expressIntegration({ ignoreLayersType: ['middleware'] })],
});

18 changes: 18 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import cors from 'cors';
import express from 'express';
import * as Sentry from '@sentry/node';
import { startExpressServerAndSendPortToRunner } from '@sentry-internal/node-integration-tests';

const app = express();

// cors() would normally create a 'middleware' type span, but the
// ignoreLayersType: ['middleware'] option set via Sentry.init() suppresses it.
app.use(cors());

app.get('/test/express', (_req, res) => {
 res.send({ response: 'response 1' });
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);

49 changes: 49 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import { afterAll, describe, expect } from 'vitest';
import { assertSentryTransaction } from '../../../utils/assertions';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

describe('express late init', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
 test('applies expressIntegration config set via Sentry.init() called after instrumentExpress()', async () => {
 const runner = createRunner()
 .expect({
 transaction: transaction => {
 assertSentryTransaction(transaction, {
 transaction: 'GET /test/express',
 contexts: {
 trace: {
 op: 'http.server',
 status: 'ok',
 },
 },
 });
 // request_handler span IS present
 // confirms the express patch was applied.
 expect(transaction.spans).toContainEqual(
 expect.objectContaining({
 data: expect.objectContaining({
 'express.type': 'request_handler',
 }),
 }),
 );
 // Middleware spans NOT present, ignoreLayersType: ['middleware']
 // configured via the Sentry.init() AFTER instrumentExpress().
 expect(transaction.spans).not.toContainEqual(
 expect.objectContaining({
 data: expect.objectContaining({
 'express.type': 'middleware',
 }),
 }),
 );
 },
 })
 .start();
 runner.makeRequest('get', '/test/express');
 await runner.completed();
 });
 });
});

60 changes: 53 additions & 7 deletions
packages/core/src/integrations/express/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,24 @@ import { setSDKProcessingMetadata } from './set-sdk-processing-metadata';
const getExpressExport = (express: ExpressModuleExport): ExpressExport =>
 hasDefaultProp(express) ? express.default : (express as ExpressExport);

function isLegacyOptions(
 options: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),
): options is ExpressIntegrationOptions & { express: ExpressModuleExport } {
 return !!(options as { express: ExpressModuleExport }).express;
}

// TODO: remove this deprecation handling in v11
let didLegacyDeprecationWarning = false;
function deprecationWarning() {
 if (!didLegacyDeprecationWarning) {
 didLegacyDeprecationWarning = true;
 DEBUG_BUILD &&
 debug.warn(
 '[Express] `patchExpressModule(options)` is deprecated. Use `patchExpressModule(moduleExports, getOptions)` instead.',
 );
 }
}

/**
 * This is a portable instrumentatiton function that works in any environment
 * where Express can be loaded, without depending on OpenTelemetry.
Expand All@@ -69,11 +87,39 @@ const getExpressExport = (express: ExpressModuleExport): ExpressExport =>
 * import express from 'express';
 * import * as Sentry from '@sentry/deno'; // or any SDK that extends core
 *
 * Sentry.patchExpressModule({ express })
 * Sentry.patchExpressModule(express, () => ({}));
 * ```
 */
export const patchExpressModule = (options: ExpressIntegrationOptions) => {
export function patchExpressModule(
 moduleExports: ExpressModuleExport,
 getOptions: () => ExpressIntegrationOptions,
): ExpressModuleExport;
/**
 * @deprecated Pass the Express module export as the first argument and options getter as the second argument.
 */
export function patchExpressModule(
 options: ExpressIntegrationOptions & { express: ExpressModuleExport },
): ExpressModuleExport;
export function patchExpressModule(
 optionsOrExports: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),
 maybeGetOptions?: () => ExpressIntegrationOptions,
): ExpressModuleExport {
 let getOptions: () => ExpressIntegrationOptions;
 let moduleExports: ExpressModuleExport;
 if (!maybeGetOptions && isLegacyOptions(optionsOrExports)) {
 const { express, ...options } = optionsOrExports;
 moduleExports = express;
 getOptions = () => options;
 deprecationWarning();
 } else if (typeof maybeGetOptions !== 'function') {
 throw new TypeError('`patchExpressModule(moduleExports, getOptions)` requires a `getOptions` callback');
 } else {
 getOptions = maybeGetOptions;
 moduleExports = optionsOrExports as ExpressModuleExport;
 }
@cursorcursorBotApr 10, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Public API function signature changed for exported function
Low Severity
Flagging per the review rules file: patchExpressModule is publicly exported from @sentry/core and its function signature changed from a single-argument form to a two-argument overloaded form. Additionally, the publicly exported ExpressIntegrationOptions type changed the express field from required to optional. While backward compatibility is maintained via a deprecated overload and runtime deprecation warning, consumers who stored options in a variable typed as ExpressIntegrationOptions and passed it to patchExpressModule will encounter a TypeScript error, since the deprecated overload requires ExpressIntegrationOptions & { express: ExpressModuleExport } which the now-optional express field no longer satisfies.
Additional Locations (1)
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 0be7618. Configure here.

 // pass in the require() or import() result of express
 const express = getExpressExport(options.express);
 const express = getExpressExport(moduleExports);
 const routerProto: ExpressRouterv4 | ExpressRouterv5 | undefined = isExpressWithRouterPrototype(express)
 ? express.Router.prototype // Express v5
 : isExpressWithoutRouterPrototype(express)
Expand All@@ -93,7 +139,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 function routeTrace(this: ExpressRouter, ...args: Parameters<typeof originalRouteMethod>[]) {
 const route = originalRouteMethod.apply(this, args);
 const layer = this.stack[this.stack.length - 1] as ExpressLayer;
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 return route;
 },
 );
Expand All@@ -113,7 +159,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 if (!layer) {
 return route;
 }
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 return route;
 },
 );
Expand DownExpand Up@@ -141,7 +187,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 if (router) {
 const layer = router.stack[router.stack.length - 1];
 if (layer) {
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 }
 }
 return route;
Expand All@@ -152,7 +198,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 }

 return express;
};
}

/**
 * An Express-compatible error handler, used by setupExpressErrorHandler
Expand Down

8 changes: 7 additions & 1 deletion
packages/core/src/integrations/express/patch-layer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,11 @@ export type ExpressPatchLayerOptions = Pick<
 'onRouteResolved' | 'ignoreLayers' | 'ignoreLayersType'
>;

export function patchLayer(options: ExpressPatchLayerOptions, maybeLayer?: ExpressLayer, layerPath?: string): void {
export function patchLayer(
 getOptions: () => ExpressPatchLayerOptions,
 maybeLayer?: ExpressLayer,
 layerPath?: string,
): void {
 if (!maybeLayer?.handle) {
 return;
 }
Expand All@@ -86,6 +90,8 @@ export function patchLayer(options: ExpressPatchLayerOptions, maybeLayer?: Expre
 //oxlint-disable-next-line no-explicit-any
 ...otherArgs: any[]
 ) {
 const options = getOptions();

 // Set normalizedRequest here because expressRequestHandler middleware
 // (registered via setupExpressErrorHandler) is added after routes and
 // therefore never runs for successful requests — route handlers typically
Expand Down

7 changes: 6 additions & 1 deletion
packages/core/src/integrations/express/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,7 +136,12 @@ export type ExpressRouter = {
export type IgnoreMatcher = string | RegExp | ((name: string) => boolean);

export type ExpressIntegrationOptions = {
 express: ExpressModuleExport; //Express
Comment thread
isaacs marked this conversation as resolved.

 /**
 * @deprecated Pass the express module as the first argument, and an
 * options getter as the second argument to patchExpressModule.
 */
 express?: ExpressModuleExport;

 /** Ignore specific based on their name */
 ignoreLayers?: IgnoreMatcher[];
 /** Ignore specific layers based on their type */
Expand Down
Loading
Loading

, '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(core, node): support loading Express options lazily#20211

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

isaacs
merged 1 commit into

from

Apr 13, 2026
 Merged


fix(core, node): support loading Express options lazily
#20211
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

// First: preload the express instrumentation without calling Sentry.init().
// registers OTel module hook, patches the Express module with no config.
Sentry.preloadOpenTelemetry({ integrations: ['Express'] });

// call Sentry.init() with express integration config.
// instrumentExpress is already registered, so this calls setConfig() on the
// existing instrumentation to update its options. The lazy getOptions()
// in patchLayer ensures the updated options are read at request time.
Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
 transport: loggingTransport,
 // suppress the middleware layer that the cors module generates
 integrations: [Sentry.expressIntegration({ ignoreLayersType: ['middleware'] })],
});

18 changes: 18 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import cors from 'cors';
import express from 'express';
import * as Sentry from '@sentry/node';
import { startExpressServerAndSendPortToRunner } from '@sentry-internal/node-integration-tests';

const app = express();

// cors() would normally create a 'middleware' type span, but the
// ignoreLayersType: ['middleware'] option set via Sentry.init() suppresses it.
app.use(cors());

app.get('/test/express', (_req, res) => {
 res.send({ response: 'response 1' });
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);

49 changes: 49 additions & 0 deletions
dev-packages/node-integration-tests/suites/express/late-init/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import { afterAll, describe, expect } from 'vitest';
import { assertSentryTransaction } from '../../../utils/assertions';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

describe('express late init', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
 test('applies expressIntegration config set via Sentry.init() called after instrumentExpress()', async () => {
 const runner = createRunner()
 .expect({
 transaction: transaction => {
 assertSentryTransaction(transaction, {
 transaction: 'GET /test/express',
 contexts: {
 trace: {
 op: 'http.server',
 status: 'ok',
 },
 },
 });
 // request_handler span IS present
 // confirms the express patch was applied.
 expect(transaction.spans).toContainEqual(
 expect.objectContaining({
 data: expect.objectContaining({
 'express.type': 'request_handler',
 }),
 }),
 );
 // Middleware spans NOT present, ignoreLayersType: ['middleware']
 // configured via the Sentry.init() AFTER instrumentExpress().
 expect(transaction.spans).not.toContainEqual(
 expect.objectContaining({
 data: expect.objectContaining({
 'express.type': 'middleware',
 }),
 }),
 );
 },
 })
 .start();
 runner.makeRequest('get', '/test/express');
 await runner.completed();
 });
 });
});

60 changes: 53 additions & 7 deletions
packages/core/src/integrations/express/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,24 @@ import { setSDKProcessingMetadata } from './set-sdk-processing-metadata';
const getExpressExport = (express: ExpressModuleExport): ExpressExport =>
 hasDefaultProp(express) ? express.default : (express as ExpressExport);

function isLegacyOptions(
 options: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),
): options is ExpressIntegrationOptions & { express: ExpressModuleExport } {
 return !!(options as { express: ExpressModuleExport }).express;
}

// TODO: remove this deprecation handling in v11
let didLegacyDeprecationWarning = false;
function deprecationWarning() {
 if (!didLegacyDeprecationWarning) {
 didLegacyDeprecationWarning = true;
 DEBUG_BUILD &&
 debug.warn(
 '[Express] `patchExpressModule(options)` is deprecated. Use `patchExpressModule(moduleExports, getOptions)` instead.',
 );
 }
}

/**
 * This is a portable instrumentatiton function that works in any environment
 * where Express can be loaded, without depending on OpenTelemetry.
Expand All@@ -69,11 +87,39 @@ const getExpressExport = (express: ExpressModuleExport): ExpressExport =>
 * import express from 'express';
 * import * as Sentry from '@sentry/deno'; // or any SDK that extends core
 *
 * Sentry.patchExpressModule({ express })
 * Sentry.patchExpressModule(express, () => ({}));
 * ```
 */
export const patchExpressModule = (options: ExpressIntegrationOptions) => {
export function patchExpressModule(
 moduleExports: ExpressModuleExport,
 getOptions: () => ExpressIntegrationOptions,
): ExpressModuleExport;
/**
 * @deprecated Pass the Express module export as the first argument and options getter as the second argument.
 */
export function patchExpressModule(
 options: ExpressIntegrationOptions & { express: ExpressModuleExport },
): ExpressModuleExport;
export function patchExpressModule(
 optionsOrExports: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),
 maybeGetOptions?: () => ExpressIntegrationOptions,
): ExpressModuleExport {
 let getOptions: () => ExpressIntegrationOptions;
 let moduleExports: ExpressModuleExport;
 if (!maybeGetOptions && isLegacyOptions(optionsOrExports)) {
 const { express, ...options } = optionsOrExports;
 moduleExports = express;
 getOptions = () => options;
 deprecationWarning();
 } else if (typeof maybeGetOptions !== 'function') {
 throw new TypeError('`patchExpressModule(moduleExports, getOptions)` requires a `getOptions` callback');
 } else {
 getOptions = maybeGetOptions;
 moduleExports = optionsOrExports as ExpressModuleExport;
 }
@cursorcursorBotApr 10, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Public API function signature changed for exported function
Low Severity
Flagging per the review rules file: patchExpressModule is publicly exported from @sentry/core and its function signature changed from a single-argument form to a two-argument overloaded form. Additionally, the publicly exported ExpressIntegrationOptions type changed the express field from required to optional. While backward compatibility is maintained via a deprecated overload and runtime deprecation warning, consumers who stored options in a variable typed as ExpressIntegrationOptions and passed it to patchExpressModule will encounter a TypeScript error, since the deprecated overload requires ExpressIntegrationOptions & { express: ExpressModuleExport } which the now-optional express field no longer satisfies.
Additional Locations (1)
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 0be7618. Configure here.

 // pass in the require() or import() result of express
 const express = getExpressExport(options.express);
 const express = getExpressExport(moduleExports);
 const routerProto: ExpressRouterv4 | ExpressRouterv5 | undefined = isExpressWithRouterPrototype(express)
 ? express.Router.prototype // Express v5
 : isExpressWithoutRouterPrototype(express)
Expand All@@ -93,7 +139,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 function routeTrace(this: ExpressRouter, ...args: Parameters<typeof originalRouteMethod>[]) {
 const route = originalRouteMethod.apply(this, args);
 const layer = this.stack[this.stack.length - 1] as ExpressLayer;
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 return route;
 },
 );
Expand All@@ -113,7 +159,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 if (!layer) {
 return route;
 }
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 return route;
 },
 );
Expand DownExpand Up@@ -141,7 +187,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 if (router) {
 const layer = router.stack[router.stack.length - 1];
 if (layer) {
 patchLayer(options, layer, getLayerPath(args));
 patchLayer(getOptions, layer, getLayerPath(args));
 }
 }
 return route;
Expand All@@ -152,7 +198,7 @@ export const patchExpressModule = (options: ExpressIntegrationOptions) => {
 }

 return express;
};
}

/**
 * An Express-compatible error handler, used by setupExpressErrorHandler
Expand Down

8 changes: 7 additions & 1 deletion
packages/core/src/integrations/express/patch-layer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,11 @@ export type ExpressPatchLayerOptions = Pick<
 'onRouteResolved' | 'ignoreLayers' | 'ignoreLayersType'
>;

export function patchLayer(options: ExpressPatchLayerOptions, maybeLayer?: ExpressLayer, layerPath?: string): void {
export function patchLayer(
 getOptions: () => ExpressPatchLayerOptions,
 maybeLayer?: ExpressLayer,
 layerPath?: string,
): void {
 if (!maybeLayer?.handle) {
 return;
 }
Expand All@@ -86,6 +90,8 @@ export function patchLayer(options: ExpressPatchLayerOptions, maybeLayer?: Expre
 //oxlint-disable-next-line no-explicit-any
 ...otherArgs: any[]
 ) {
 const options = getOptions();

 // Set normalizedRequest here because expressRequestHandler middleware
 // (registered via setupExpressErrorHandler) is added after routes and
 // therefore never runs for successful requests — route handlers typically
Expand Down

7 changes: 6 additions & 1 deletion
packages/core/src/integrations/express/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,7 +136,12 @@ export type ExpressRouter = {
export type IgnoreMatcher = string | RegExp | ((name: string) => boolean);

export type ExpressIntegrationOptions = {
 express: ExpressModuleExport; //Express
Comment thread
isaacs marked this conversation as resolved.

 /**
 * @deprecated Pass the express module as the first argument, and an
 * options getter as the second argument to patchExpressModule.
 */
 express?: ExpressModuleExport;

 /** Ignore specific based on their name */
 ignoreLayers?: IgnoreMatcher[];
 /** Ignore specific layers based on their type */
Expand Down
Loading
Loading