@sentry/core 10.53.1 → 10.54.0

package/build/cjs/integrations/express/index.js

@@ -9,121 +9,58 @@ const patchLayer = require('./patch-layer.js');
 const setSdkProcessingMetadata = require('./set-sdk-processing-metadata.js');
 const getDefaultExport = require('../../utils/get-default-export.js');
 
-/**
- * Platform-portable Express tracing integration.
- *
- * @module
- *
- * This Sentry integration is a derivative work based on the OpenTelemetry
- * Express instrumentation.
- *
- * <https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-express>
- *
- * Extended under the terms of the Apache 2.0 license linked below:
- *
- * ----
- *
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-
-function isLegacyOptions(
-  options,
-) {
-  return !!(options ).express;
+function isLegacyOptions(options) {
+  return !!options.express;
 }
-
-// TODO: remove this deprecation handling in v11
 let didLegacyDeprecationWarning = false;
 function deprecationWarning() {
   if (!didLegacyDeprecationWarning) {
     didLegacyDeprecationWarning = true;
-    debugBuild.DEBUG_BUILD &&
-      debugLogger.debug.warn(
-        '[Express] `patchExpressModule(options)` is deprecated. Use `patchExpressModule(moduleExports, getOptions)` instead.',
-      );
+    debugBuild.DEBUG_BUILD && debugLogger.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.
- *
- * @example
- * ```javascript
- * import express from 'express';
- * import * as Sentry from '@sentry/deno'; // or any SDK that extends core
- *
- * Sentry.patchExpressModule(express, () => ({}));
- * ```
- */
-
-function patchExpressModule(
-  optionsOrExports,
-  maybeGetOptions,
-) {
+function patchExpressModule(optionsOrExports, maybeGetOptions) {
   let getOptions;
   let moduleExports;
   if (!maybeGetOptions && isLegacyOptions(optionsOrExports)) {
-    const { express, ...options } = optionsOrExports;
-    moduleExports = express;
+    const { express: express2, ...options } = optionsOrExports;
+    moduleExports = express2;
     getOptions = () => options;
     deprecationWarning();
-  } else if (typeof maybeGetOptions !== 'function') {
-    throw new TypeError('`patchExpressModule(moduleExports, getOptions)` requires a `getOptions` callback');
+  } else if (typeof maybeGetOptions !== "function") {
+    throw new TypeError("`patchExpressModule(moduleExports, getOptions)` requires a `getOptions` callback");
   } else {
     getOptions = maybeGetOptions;
-    moduleExports = optionsOrExports ;
+    moduleExports = optionsOrExports;
   }
-
-  // pass in the require() or import() result of express
   const express = getDefaultExport.getDefaultExport(moduleExports);
-  const routerProto = utils.isExpressWithRouterPrototype(express)
-    ? express.Router.prototype // Express v5
-    : utils.isExpressWithoutRouterPrototype(express)
-      ? express.Router // Express v4
-      : undefined;
-
+  const routerProto = utils.isExpressWithRouterPrototype(express) ? express.Router.prototype : utils.isExpressWithoutRouterPrototype(express) ? express.Router : void 0;
   if (!routerProto) {
-    throw new TypeError('no valid Express route function to instrument');
+    throw new TypeError("no valid Express route function to instrument");
   }
-
-  // oxlint-disable-next-line @typescript-eslint/unbound-method
   const originalRouteMethod = routerProto.route;
   try {
     object.wrapMethod(
       routerProto,
-      'route',
-      function routeTrace( ...args) {
+      "route",
+      function routeTrace(...args) {
         const route = originalRouteMethod.apply(this, args);
-        const layer = this.stack[this.stack.length - 1] ;
+        const layer = this.stack[this.stack.length - 1];
         patchLayer.patchLayer(getOptions, layer, utils.getLayerPath(args));
         return route;
-      },
+      }
     );
   } catch (e) {
-    debugBuild.DEBUG_BUILD && debugLogger.debug.error('Failed to patch express route method:', e);
+    debugBuild.DEBUG_BUILD && debugLogger.debug.error("Failed to patch express route method:", e);
   }
-
-  // oxlint-disable-next-line @typescript-eslint/unbound-method
   const originalRouterUse = routerProto.use;
   try {
     object.wrapMethod(
       routerProto,
-      'use',
-      function useTrace( ...args) {
+      "use",
+      function useTrace(...args) {
         const route = originalRouterUse.apply(this, args);
         const layer = this.stack[this.stack.length - 1];
         if (!layer) {
@@ -131,24 +68,18 @@ function patchExpressModule(
         }
         patchLayer.patchLayer(getOptions, layer, utils.getLayerPath(args));
         return route;
-      },
+      }
     );
   } catch (e) {
-    debugBuild.DEBUG_BUILD && debugLogger.debug.error('Failed to patch express use method:', e);
+    debugBuild.DEBUG_BUILD && debugLogger.debug.error("Failed to patch express use method:", e);
   }
-
   const { application } = express;
   const originalApplicationUse = application.use;
   try {
     object.wrapMethod(
       application,
-      'use',
-      function appUseTrace(
-
-        ...args
-      ) {
-        // If we access app.router in express 4.x we trigger an assertion error.
-        // This property existed in v3, was removed in v4 and then re-added in v5.
+      "use",
+      function appUseTrace(...args) {
         const route = originalApplicationUse.apply(this, args);
         const router = utils.isExpressWithRouterPrototype(express) ? this.router : this._router;
         if (router) {
@@ -158,76 +89,30 @@ function patchExpressModule(
           }
         }
         return route;
-      },
+      }
     );
   } catch (e) {
-    debugBuild.DEBUG_BUILD && debugLogger.debug.error('Failed to patch express application.use method:', e);
+    debugBuild.DEBUG_BUILD && debugLogger.debug.error("Failed to patch express application.use method:", e);
   }
-
   return express;
 }
-
-/**
- * An Express-compatible error handler, used by setupExpressErrorHandler
- */
 function expressErrorHandler(options) {
-  return function sentryErrorMiddleware(
-    error,
-    request,
-    res,
-    next,
-  ) {
-    // When an error happens, the `expressRequestHandler` middleware does not run, so we set it here too
+  return function sentryErrorMiddleware(error, request, res, next) {
     setSdkProcessingMetadata.setSDKProcessingMetadata(request);
     const shouldHandleError = options?.shouldHandleError || utils.defaultShouldHandleError;
-
     if (shouldHandleError(error)) {
       const eventId = exports$1.captureException(error, {
-        mechanism: { type: 'auto.middleware.express', handled: false },
+        mechanism: { type: "auto.middleware.express", handled: false }
       });
-      (res ).sentry = eventId;
+      res.sentry = eventId;
     }
-
     next(error);
   };
 }
-
-/**
- * Add an Express error handler to capture errors to Sentry.
- *
- * The error handler must be before any other middleware and after all controllers.
- *
- * @param app The Express instances
- * @param options {ExpressHandlerOptions} Configuration options for the handler
- *
- * @example
- * ```javascript
- * import * as Sentry from 'sentry/deno'; // or any other @sentry/<platform>
- * import * as express from 'express';
- *
- * Sentry.instrumentExpress(express);
- *
- * const app = express();
- *
- * // Add your routes, etc.
- *
- * // Add this after all routes,
- * // but before any and other error-handling middlewares are defined
- * Sentry.setupExpressErrorHandler(app);
- *
- * app.listen(3000);
- * ```
- */
-function setupExpressErrorHandler(
-  app
-
-,
-  options,
-) {
+function setupExpressErrorHandler(app, options) {
   app.use(expressRequestHandler());
   app.use(expressErrorHandler(options));
 }
-
 function expressRequestHandler() {
   return function sentryRequestMiddleware(request, _res, next) {
     setSdkProcessingMetadata.setSDKProcessingMetadata(request);

package/build/cjs/integrations/express/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../../../src/integrations/express/index.ts"],"sourcesContent":["/**\n * Platform-portable Express tracing integration.\n *\n * @module\n *\n * This Sentry integration is a derivative work based on the OpenTelemetry\n * Express instrumentation.\n *\n * <https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-express>\n *\n * Extended under the terms of the Apache 2.0 license linked below:\n *\n * ----\n *\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { debug } from '../../utils/debug-logger';\nimport { captureException } from '../../exports';\nimport { DEBUG_BUILD } from '../../debug-build';\nimport type {\n  ExpressApplication,\n  ExpressErrorMiddleware,\n  ExpressHandlerOptions,\n  ExpressIntegrationOptions,\n  ExpressLayer,\n  ExpressMiddleware,\n  ExpressModuleExport,\n  ExpressRequest,\n  ExpressResponse,\n  ExpressRouter,\n  ExpressRouterv4,\n  ExpressRouterv5,\n  MiddlewareError,\n} from './types';\nimport {\n  defaultShouldHandleError,\n  getLayerPath,\n  isExpressWithoutRouterPrototype,\n  isExpressWithRouterPrototype,\n} from './utils';\nimport { wrapMethod } from '../../utils/object';\nimport { patchLayer } from './patch-layer';\nimport { setSDKProcessingMetadata } from './set-sdk-processing-metadata';\nimport { getDefaultExport } from '../../utils/get-default-export';\n\nfunction isLegacyOptions(\n  options: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),\n): options is ExpressIntegrationOptions & { express: ExpressModuleExport } {\n  return !!(options as { express: ExpressModuleExport }).express;\n}\n\n// TODO: remove this deprecation handling in v11\nlet didLegacyDeprecationWarning = false;\nfunction deprecationWarning() {\n  if (!didLegacyDeprecationWarning) {\n    didLegacyDeprecationWarning = true;\n    DEBUG_BUILD &&\n      debug.warn(\n        '[Express] `patchExpressModule(options)` is deprecated. Use `patchExpressModule(moduleExports, getOptions)` instead.',\n      );\n  }\n}\n\n/**\n * This is a portable instrumentatiton function that works in any environment\n * where Express can be loaded, without depending on OpenTelemetry.\n *\n * @example\n * ```javascript\n * import express from 'express';\n * import * as Sentry from '@sentry/deno'; // or any SDK that extends core\n *\n * Sentry.patchExpressModule(express, () => ({}));\n * ```\n */\nexport function patchExpressModule(\n  moduleExports: ExpressModuleExport,\n  getOptions: () => ExpressIntegrationOptions,\n): ExpressModuleExport;\n/**\n * @deprecated Pass the Express module export as the first argument and options getter as the second argument.\n */\nexport function patchExpressModule(\n  options: ExpressIntegrationOptions & { express: ExpressModuleExport },\n): ExpressModuleExport;\nexport function patchExpressModule(\n  optionsOrExports: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),\n  maybeGetOptions?: () => ExpressIntegrationOptions,\n): ExpressModuleExport {\n  let getOptions: () => ExpressIntegrationOptions;\n  let moduleExports: ExpressModuleExport;\n  if (!maybeGetOptions && isLegacyOptions(optionsOrExports)) {\n    const { express, ...options } = optionsOrExports;\n    moduleExports = express;\n    getOptions = () => options;\n    deprecationWarning();\n  } else if (typeof maybeGetOptions !== 'function') {\n    throw new TypeError('`patchExpressModule(moduleExports, getOptions)` requires a `getOptions` callback');\n  } else {\n    getOptions = maybeGetOptions;\n    moduleExports = optionsOrExports as ExpressModuleExport;\n  }\n\n  // pass in the require() or import() result of express\n  const express = getDefaultExport(moduleExports);\n  const routerProto: ExpressRouterv4 | ExpressRouterv5 | undefined = isExpressWithRouterPrototype(express)\n    ? express.Router.prototype // Express v5\n    : isExpressWithoutRouterPrototype(express)\n      ? express.Router // Express v4\n      : undefined;\n\n  if (!routerProto) {\n    throw new TypeError('no valid Express route function to instrument');\n  }\n\n  // oxlint-disable-next-line @typescript-eslint/unbound-method\n  const originalRouteMethod = routerProto.route;\n  try {\n    wrapMethod(\n      routerProto,\n      'route',\n      function routeTrace(this: ExpressRouter, ...args: Parameters<typeof originalRouteMethod>[]) {\n        const route = originalRouteMethod.apply(this, args);\n        const layer = this.stack[this.stack.length - 1] as ExpressLayer;\n        patchLayer(getOptions, layer, getLayerPath(args));\n        return route;\n      },\n    );\n  } catch (e) {\n    DEBUG_BUILD && debug.error('Failed to patch express route method:', e);\n  }\n\n  // oxlint-disable-next-line @typescript-eslint/unbound-method\n  const originalRouterUse = routerProto.use;\n  try {\n    wrapMethod(\n      routerProto,\n      'use',\n      function useTrace(this: ExpressApplication, ...args: Parameters<typeof originalRouterUse>) {\n        const route = originalRouterUse.apply(this, args);\n        const layer = this.stack[this.stack.length - 1];\n        if (!layer) {\n          return route;\n        }\n        patchLayer(getOptions, layer, getLayerPath(args));\n        return route;\n      },\n    );\n  } catch (e) {\n    DEBUG_BUILD && debug.error('Failed to patch express use method:', e);\n  }\n\n  const { application } = express;\n  const originalApplicationUse = application.use;\n  try {\n    wrapMethod(\n      application,\n      'use',\n      function appUseTrace(\n        this: ExpressApplication & {\n          _router?: ExpressRouter;\n          router?: ExpressRouter;\n        },\n        ...args: Parameters<ExpressApplication['use']>\n      ) {\n        // If we access app.router in express 4.x we trigger an assertion error.\n        // This property existed in v3, was removed in v4 and then re-added in v5.\n        const route = originalApplicationUse.apply(this, args);\n        const router = isExpressWithRouterPrototype(express) ? this.router : this._router;\n        if (router) {\n          const layer = router.stack[router.stack.length - 1];\n          if (layer) {\n            patchLayer(getOptions, layer, getLayerPath(args));\n          }\n        }\n        return route;\n      },\n    );\n  } catch (e) {\n    DEBUG_BUILD && debug.error('Failed to patch express application.use method:', e);\n  }\n\n  return express;\n}\n\n/**\n * An Express-compatible error handler, used by setupExpressErrorHandler\n */\nexport function expressErrorHandler(options?: ExpressHandlerOptions): ExpressErrorMiddleware {\n  return function sentryErrorMiddleware(\n    error: MiddlewareError,\n    request: ExpressRequest,\n    res: ExpressResponse,\n    next: (error: MiddlewareError) => void,\n  ): void {\n    // When an error happens, the `expressRequestHandler` middleware does not run, so we set it here too\n    setSDKProcessingMetadata(request);\n    const shouldHandleError = options?.shouldHandleError || defaultShouldHandleError;\n\n    if (shouldHandleError(error)) {\n      const eventId = captureException(error, {\n        mechanism: { type: 'auto.middleware.express', handled: false },\n      });\n      (res as { sentry?: string }).sentry = eventId;\n    }\n\n    next(error);\n  };\n}\n\n/**\n * Add an Express error handler to capture errors to Sentry.\n *\n * The error handler must be before any other middleware and after all controllers.\n *\n * @param app The Express instances\n * @param options {ExpressHandlerOptions} Configuration options for the handler\n *\n * @example\n * ```javascript\n * import * as Sentry from 'sentry/deno'; // or any other @sentry/<platform>\n * import * as express from 'express';\n *\n * Sentry.instrumentExpress(express);\n *\n * const app = express();\n *\n * // Add your routes, etc.\n *\n * // Add this after all routes,\n * // but before any and other error-handling middlewares are defined\n * Sentry.setupExpressErrorHandler(app);\n *\n * app.listen(3000);\n * ```\n */\nexport function setupExpressErrorHandler(\n  app: {\n    //oxlint-disable-next-line no-explicit-any\n    use: (middleware: any) => unknown;\n  },\n  options?: ExpressHandlerOptions,\n): void {\n  app.use(expressRequestHandler());\n  app.use(expressErrorHandler(options));\n}\n\nfunction expressRequestHandler(): ExpressMiddleware {\n  return function sentryRequestMiddleware(request: ExpressRequest, _res: ExpressResponse, next: () => void): void {\n    setSDKProcessingMetadata(request);\n    next();\n  };\n}\n"],"names":["DEBUG_BUILD","debug","getDefaultExport","isExpressWithRouterPrototype","isExpressWithoutRouterPrototype","wrapMethod","patchLayer","getLayerPath","setSDKProcessingMetadata","defaultShouldHandleError","captureException"],"mappings":";;;;;;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AA+BA,SAAS,eAAe;AACxB,EAAE,OAAO;AACT,EAA2E;AAC3E,EAAE,OAAO,CAAC,CAAC,CAAC,OAAA,GAA6C,OAAO;AAChE;;AAEA;AACA,IAAI,2BAAA,GAA8B,KAAK;AACvC,SAAS,kBAAkB,GAAG;AAC9B,EAAE,IAAI,CAAC,2BAA2B,EAAE;AACpC,IAAI,2BAAA,GAA8B,IAAI;AACtC,IAAIA,sBAAA;AACJ,MAAMC,iBAAK,CAAC,IAAI;AAChB,QAAQ,qHAAqH;AAC7H,OAAO;AACP,EAAE;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAWO,SAAS,kBAAkB;AAClC,EAAE,gBAAgB;AAClB,EAAE,eAAe;AACjB,EAAuB;AACvB,EAAE,IAAI,UAAU;AAChB,EAAE,IAAI,aAAa;AACnB,EAAE,IAAI,CAAC,eAAA,IAAmB,eAAe,CAAC,gBAAgB,CAAC,EAAE;AAC7D,IAAI,MAAM,EAAE,OAAO,EAAE,GAAG,OAAA,EAAQ,GAAI,gBAAgB;AACpD,IAAI,aAAA,GAAgB,OAAO;AAC3B,IAAI,UAAA,GAAa,MAAM,OAAO;AAC9B,IAAI,kBAAkB,EAAE;AACxB,EAAE,CAAA,MAAO,IAAI,OAAO,eAAA,KAAoB,UAAU,EAAE;AACpD,IAAI,MAAM,IAAI,SAAS,CAAC,kFAAkF,CAAC;AAC3G,EAAE,OAAO;AACT,IAAI,UAAA,GAAa,eAAe;AAChC,IAAI,aAAA,GAAgB,gBAAA;AACpB,EAAE;;AAEF;AACA,EAAE,MAAM,OAAA,GAAUC,iCAAgB,CAAC,aAAa,CAAC;AACjD,EAAE,MAAM,WAAW,GAAkDC,kCAA4B,CAAC,OAAO;AACzG,MAAM,OAAO,CAAC,MAAM,CAAC,SAAA;AACrB,MAAMC,qCAA+B,CAAC,OAAO;AAC7C,QAAQ,OAAO,CAAC,MAAA;AAChB,QAAQ,SAAS;;AAEjB,EAAE,IAAI,CAAC,WAAW,EAAE;AACpB,IAAI,MAAM,IAAI,SAAS,CAAC,+CAA+C,CAAC;AACxE,EAAE;;AAEF;AACA,EAAE,MAAM,mBAAA,GAAsB,WAAW,CAAC,KAAK;AAC/C,EAAE,IAAI;AACN,IAAIC,iBAAU;AACd,MAAM,WAAW;AACjB,MAAM,OAAO;AACb,MAAM,SAAS,UAAU,EAAsB,GAAG,IAAI,EAA4C;AAClG,QAAQ,MAAM,KAAA,GAAQ,mBAAmB,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC;AAC3D,QAAQ,MAAM,KAAA,GAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAA,GAAS,CAAC,CAAA;AACtD,QAAQC,qBAAU,CAAC,UAAU,EAAE,KAAK,EAAEC,kBAAY,CAAC,IAAI,CAAC,CAAC;AACzD,QAAQ,OAAO,KAAK;AACpB,MAAM,CAAC;AACP,KAAK;AACL,EAAE,CAAA,CAAE,OAAO,CAAC,EAAE;AACd,IAAIP,sBAAA,IAAeC,iBAAK,CAAC,KAAK,CAAC,uCAAuC,EAAE,CAAC,CAAC;AAC1E,EAAE;;AAEF;AACA,EAAE,MAAM,iBAAA,GAAoB,WAAW,CAAC,GAAG;AAC3C,EAAE,IAAI;AACN,IAAII,iBAAU;AACd,MAAM,WAAW;AACjB,MAAM,KAAK;AACX,MAAM,SAAS,QAAQ,EAA2B,GAAG,IAAI,EAAwC;AACjG,QAAQ,MAAM,KAAA,GAAQ,iBAAiB,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC;AACzD,QAAQ,MAAM,KAAA,GAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAA,GAAS,CAAC,CAAC;AACvD,QAAQ,IAAI,CAAC,KAAK,EAAE;AACpB,UAAU,OAAO,KAAK;AACtB,QAAQ;AACR,QAAQC,qBAAU,CAAC,UAAU,EAAE,KAAK,EAAEC,kBAAY,CAAC,IAAI,CAAC,CAAC;AACzD,QAAQ,OAAO,KAAK;AACpB,MAAM,CAAC;AACP,KAAK;AACL,EAAE,CAAA,CAAE,OAAO,CAAC,EAAE;AACd,IAAIP,sBAAA,IAAeC,iBAAK,CAAC,KAAK,CAAC,qCAAqC,EAAE,CAAC,CAAC;AACxE,EAAE;;AAEF,EAAE,MAAM,EAAE,WAAA,EAAY,GAAI,OAAO;AACjC,EAAE,MAAM,sBAAA,GAAyB,WAAW,CAAC,GAAG;AAChD,EAAE,IAAI;AACN,IAAII,iBAAU;AACd,MAAM,WAAW;AACjB,MAAM,KAAK;AACX,MAAM,SAAS,WAAW;;AAK1B,QAAQ,GAAG;AACX,QAAQ;AACR;AACA;AACA,QAAQ,MAAM,KAAA,GAAQ,sBAAsB,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC;AAC9D,QAAQ,MAAM,MAAA,GAASF,kCAA4B,CAAC,OAAO,CAAA,GAAI,IAAI,CAAC,MAAA,GAAS,IAAI,CAAC,OAAO;AACzF,QAAQ,IAAI,MAAM,EAAE;AACpB,UAAU,MAAM,KAAA,GAAQ,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,MAAA,GAAS,CAAC,CAAC;AAC7D,UAAU,IAAI,KAAK,EAAE;AACrB,YAAYG,qBAAU,CAAC,UAAU,EAAE,KAAK,EAAEC,kBAAY,CAAC,IAAI,CAAC,CAAC;AAC7D,UAAU;AACV,QAAQ;AACR,QAAQ,OAAO,KAAK;AACpB,MAAM,CAAC;AACP,KAAK;AACL,EAAE,CAAA,CAAE,OAAO,CAAC,EAAE;AACd,IAAIP,sBAAA,IAAeC,iBAAK,CAAC,KAAK,CAAC,iDAAiD,EAAE,CAAC,CAAC;AACpF,EAAE;;AAEF,EAAE,OAAO,OAAO;AAChB;;AAEA;AACA;AACA;AACO,SAAS,mBAAmB,CAAC,OAAO,EAAkD;AAC7F,EAAE,OAAO,SAAS,qBAAqB;AACvC,IAAI,KAAK;AACT,IAAI,OAAO;AACX,IAAI,GAAG;AACP,IAAI,IAAI;AACR,IAAU;AACV;AACA,IAAIO,iDAAwB,CAAC,OAAO,CAAC;AACrC,IAAI,MAAM,iBAAA,GAAoB,OAAO,EAAE,iBAAA,IAAqBC,8BAAwB;;AAEpF,IAAI,IAAI,iBAAiB,CAAC,KAAK,CAAC,EAAE;AAClC,MAAM,MAAM,OAAA,GAAUC,0BAAgB,CAAC,KAAK,EAAE;AAC9C,QAAQ,SAAS,EAAE,EAAE,IAAI,EAAE,yBAAyB,EAAE,OAAO,EAAE,KAAA,EAAO;AACtE,OAAO,CAAC;AACR,MAAM,CAAC,GAAA,GAA4B,MAAA,GAAS,OAAO;AACnD,IAAI;;AAEJ,IAAI,IAAI,CAAC,KAAK,CAAC;AACf,EAAE,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAAS,wBAAwB;AACxC,EAAE;;AAGA;AACF,EAAE,OAAO;AACT,EAAQ;AACR,EAAE,GAAG,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC;AAClC,EAAE,GAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;AACvC;;AAEA,SAAS,qBAAqB,GAAsB;AACpD,EAAE,OAAO,SAAS,uBAAuB,CAAC,OAAO,EAAkB,IAAI,EAAmB,IAAI,EAAoB;AAClH,IAAIF,iDAAwB,CAAC,OAAO,CAAC;AACrC,IAAI,IAAI,EAAE;AACV,EAAE,CAAC;AACH;;;;;;"}
+{"version":3,"file":"index.js","sources":["../../../../src/integrations/express/index.ts"],"sourcesContent":["/**\n * Platform-portable Express tracing integration.\n *\n * @module\n *\n * This Sentry integration is a derivative work based on the OpenTelemetry\n * Express instrumentation.\n *\n * <https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-express>\n *\n * Extended under the terms of the Apache 2.0 license linked below:\n *\n * ----\n *\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { debug } from '../../utils/debug-logger';\nimport { captureException } from '../../exports';\nimport { DEBUG_BUILD } from '../../debug-build';\nimport type {\n  ExpressApplication,\n  ExpressErrorMiddleware,\n  ExpressHandlerOptions,\n  ExpressIntegrationOptions,\n  ExpressLayer,\n  ExpressMiddleware,\n  ExpressModuleExport,\n  ExpressRequest,\n  ExpressResponse,\n  ExpressRouter,\n  ExpressRouterv4,\n  ExpressRouterv5,\n  MiddlewareError,\n} from './types';\nimport {\n  defaultShouldHandleError,\n  getLayerPath,\n  isExpressWithoutRouterPrototype,\n  isExpressWithRouterPrototype,\n} from './utils';\nimport { wrapMethod } from '../../utils/object';\nimport { patchLayer } from './patch-layer';\nimport { setSDKProcessingMetadata } from './set-sdk-processing-metadata';\nimport { getDefaultExport } from '../../utils/get-default-export';\n\nfunction isLegacyOptions(\n  options: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),\n): options is ExpressIntegrationOptions & { express: ExpressModuleExport } {\n  return !!(options as { express: ExpressModuleExport }).express;\n}\n\n// TODO: remove this deprecation handling in v11\nlet didLegacyDeprecationWarning = false;\nfunction deprecationWarning() {\n  if (!didLegacyDeprecationWarning) {\n    didLegacyDeprecationWarning = true;\n    DEBUG_BUILD &&\n      debug.warn(\n        '[Express] `patchExpressModule(options)` is deprecated. Use `patchExpressModule(moduleExports, getOptions)` instead.',\n      );\n  }\n}\n\n/**\n * This is a portable instrumentatiton function that works in any environment\n * where Express can be loaded, without depending on OpenTelemetry.\n *\n * @example\n * ```javascript\n * import express from 'express';\n * import * as Sentry from '@sentry/deno'; // or any SDK that extends core\n *\n * Sentry.patchExpressModule(express, () => ({}));\n * ```\n */\nexport function patchExpressModule(\n  moduleExports: ExpressModuleExport,\n  getOptions: () => ExpressIntegrationOptions,\n): ExpressModuleExport;\n/**\n * @deprecated Pass the Express module export as the first argument and options getter as the second argument.\n */\nexport function patchExpressModule(\n  options: ExpressIntegrationOptions & { express: ExpressModuleExport },\n): ExpressModuleExport;\nexport function patchExpressModule(\n  optionsOrExports: ExpressModuleExport | (ExpressIntegrationOptions & { express: ExpressModuleExport }),\n  maybeGetOptions?: () => ExpressIntegrationOptions,\n): ExpressModuleExport {\n  let getOptions: () => ExpressIntegrationOptions;\n  let moduleExports: ExpressModuleExport;\n  if (!maybeGetOptions && isLegacyOptions(optionsOrExports)) {\n    const { express, ...options } = optionsOrExports;\n    moduleExports = express;\n    getOptions = () => options;\n    deprecationWarning();\n  } else if (typeof maybeGetOptions !== 'function') {\n    throw new TypeError('`patchExpressModule(moduleExports, getOptions)` requires a `getOptions` callback');\n  } else {\n    getOptions = maybeGetOptions;\n    moduleExports = optionsOrExports as ExpressModuleExport;\n  }\n\n  // pass in the require() or import() result of express\n  const express = getDefaultExport(moduleExports);\n  const routerProto: ExpressRouterv4 | ExpressRouterv5 | undefined = isExpressWithRouterPrototype(express)\n    ? express.Router.prototype // Express v5\n    : isExpressWithoutRouterPrototype(express)\n      ? express.Router // Express v4\n      : undefined;\n\n  if (!routerProto) {\n    throw new TypeError('no valid Express route function to instrument');\n  }\n\n  // oxlint-disable-next-line @typescript-eslint/unbound-method\n  const originalRouteMethod = routerProto.route;\n  try {\n    wrapMethod(\n      routerProto,\n      'route',\n      function routeTrace(this: ExpressRouter, ...args: Parameters<typeof originalRouteMethod>[]) {\n        const route = originalRouteMethod.apply(this, args);\n        const layer = this.stack[this.stack.length - 1] as ExpressLayer;\n        patchLayer(getOptions, layer, getLayerPath(args));\n        return route;\n      },\n    );\n  } catch (e) {\n    DEBUG_BUILD && debug.error('Failed to patch express route method:', e);\n  }\n\n  // oxlint-disable-next-line @typescript-eslint/unbound-method\n  const originalRouterUse = routerProto.use;\n  try {\n    wrapMethod(\n      routerProto,\n      'use',\n      function useTrace(this: ExpressApplication, ...args: Parameters<typeof originalRouterUse>) {\n        const route = originalRouterUse.apply(this, args);\n        const layer = this.stack[this.stack.length - 1];\n        if (!layer) {\n          return route;\n        }\n        patchLayer(getOptions, layer, getLayerPath(args));\n        return route;\n      },\n    );\n  } catch (e) {\n    DEBUG_BUILD && debug.error('Failed to patch express use method:', e);\n  }\n\n  const { application } = express;\n  const originalApplicationUse = application.use;\n  try {\n    wrapMethod(\n      application,\n      'use',\n      function appUseTrace(\n        this: ExpressApplication & {\n          _router?: ExpressRouter;\n          router?: ExpressRouter;\n        },\n        ...args: Parameters<ExpressApplication['use']>\n      ) {\n        // If we access app.router in express 4.x we trigger an assertion error.\n        // This property existed in v3, was removed in v4 and then re-added in v5.\n        const route = originalApplicationUse.apply(this, args);\n        const router = isExpressWithRouterPrototype(express) ? this.router : this._router;\n        if (router) {\n          const layer = router.stack[router.stack.length - 1];\n          if (layer) {\n            patchLayer(getOptions, layer, getLayerPath(args));\n          }\n        }\n        return route;\n      },\n    );\n  } catch (e) {\n    DEBUG_BUILD && debug.error('Failed to patch express application.use method:', e);\n  }\n\n  return express;\n}\n\n/**\n * An Express-compatible error handler, used by setupExpressErrorHandler\n */\nexport function expressErrorHandler(options?: ExpressHandlerOptions): ExpressErrorMiddleware {\n  return function sentryErrorMiddleware(\n    error: MiddlewareError,\n    request: ExpressRequest,\n    res: ExpressResponse,\n    next: (error: MiddlewareError) => void,\n  ): void {\n    // When an error happens, the `expressRequestHandler` middleware does not run, so we set it here too\n    setSDKProcessingMetadata(request);\n    const shouldHandleError = options?.shouldHandleError || defaultShouldHandleError;\n\n    if (shouldHandleError(error)) {\n      const eventId = captureException(error, {\n        mechanism: { type: 'auto.middleware.express', handled: false },\n      });\n      (res as { sentry?: string }).sentry = eventId;\n    }\n\n    next(error);\n  };\n}\n\n/**\n * Add an Express error handler to capture errors to Sentry.\n *\n * The error handler must be before any other middleware and after all controllers.\n *\n * @param app The Express instances\n * @param options {ExpressHandlerOptions} Configuration options for the handler\n *\n * @example\n * ```javascript\n * import * as Sentry from 'sentry/deno'; // or any other @sentry/<platform>\n * import * as express from 'express';\n *\n * Sentry.instrumentExpress(express);\n *\n * const app = express();\n *\n * // Add your routes, etc.\n *\n * // Add this after all routes,\n * // but before any and other error-handling middlewares are defined\n * Sentry.setupExpressErrorHandler(app);\n *\n * app.listen(3000);\n * ```\n */\nexport function setupExpressErrorHandler(\n  app: {\n    //oxlint-disable-next-line no-explicit-any\n    use: (middleware: any) => unknown;\n  },\n  options?: ExpressHandlerOptions,\n): void {\n  app.use(expressRequestHandler());\n  app.use(expressErrorHandler(options));\n}\n\nfunction expressRequestHandler(): ExpressMiddleware {\n  return function sentryRequestMiddleware(request: ExpressRequest, _res: ExpressResponse, next: () => void): void {\n    setSDKProcessingMetadata(request);\n    next();\n  };\n}\n"],"names":["DEBUG_BUILD","debug","express","getDefaultExport","isExpressWithRouterPrototype","isExpressWithoutRouterPrototype","wrapMethod","patchLayer","getLayerPath","setSDKProcessingMetadata","defaultShouldHandleError","captureException"],"mappings":";;;;;;;;;;;AA0DA,SAAS,gBACP,OAAA,EACyE;AACzE,EAAA,OAAO,CAAC,CAAE,OAAA,CAA6C,OAAA;AACzD;AAGA,IAAI,2BAAA,GAA8B,KAAA;AAClC,SAAS,kBAAA,GAAqB;AAC5B,EAAA,IAAI,CAAC,2BAAA,EAA6B;AAChC,IAAA,2BAAA,GAA8B,IAAA;AAC9B,IAAAA,sBAAA,IACEC,iBAAA,CAAM,IAAA;AAAA,MACJ;AAAA,KACF;AAAA,EACJ;AACF;AAwBO,SAAS,kBAAA,CACd,kBACA,eAAA,EACqB;AACrB,EAAA,IAAI,UAAA;AACJ,EAAA,IAAI,aAAA;AACJ,EAAA,IAAI,CAAC,eAAA,IAAmB,eAAA,CAAgB,gBAAgB,CAAA,EAAG;AACzD,IAAA,MAAM,EAAE,OAAA,EAAAC,QAAAA,EAAS,GAAG,SAAQ,GAAI,gBAAA;AAChC,IAAA,aAAA,GAAgBA,QAAAA;AAChB,IAAA,UAAA,GAAa,MAAM,OAAA;AACnB,IAAA,kBAAA,EAAmB;AAAA,EACrB,CAAA,MAAA,IAAW,OAAO,eAAA,KAAoB,UAAA,EAAY;AAChD,IAAA,MAAM,IAAI,UAAU,kFAAkF,CAAA;AAAA,EACxG,CAAA,MAAO;AACL,IAAA,UAAA,GAAa,eAAA;AACb,IAAA,aAAA,GAAgB,gBAAA;AAAA,EAClB;AAGA,EAAA,MAAM,OAAA,GAAUC,kCAAiB,aAAa,CAAA;AAC9C,EAAA,MAAM,WAAA,GAA6DC,kCAAA,CAA6B,OAAO,CAAA,GACnG,OAAA,CAAQ,MAAA,CAAO,SAAA,GACfC,qCAAA,CAAgC,OAAO,CAAA,GACrC,OAAA,CAAQ,MAAA,GACR,MAAA;AAEN,EAAA,IAAI,CAAC,WAAA,EAAa;AAChB,IAAA,MAAM,IAAI,UAAU,+CAA+C,CAAA;AAAA,EACrE;AAGA,EAAA,MAAM,sBAAsB,WAAA,CAAY,KAAA;AACxC,EAAA,IAAI;AACF,IAAAC,iBAAA;AAAA,MACE,WAAA;AAAA,MACA,OAAA;AAAA,MACA,SAAS,cAAmC,IAAA,EAAgD;AAC1F,QAAA,MAAM,KAAA,GAAQ,mBAAA,CAAoB,KAAA,CAAM,IAAA,EAAM,IAAI,CAAA;AAClD,QAAA,MAAM,QAAQ,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,KAAA,CAAM,SAAS,CAAC,CAAA;AAC9C,QAAAC,qBAAA,CAAW,UAAA,EAAY,KAAA,EAAOC,kBAAA,CAAa,IAAI,CAAC,CAAA;AAChD,QAAA,OAAO,KAAA;AAAA,MACT;AAAA,KACF;AAAA,EACF,SAAS,CAAA,EAAG;AACV,IAAAR,sBAAA,IAAeC,iBAAA,CAAM,KAAA,CAAM,uCAAA,EAAyC,CAAC,CAAA;AAAA,EACvE;AAGA,EAAA,MAAM,oBAAoB,WAAA,CAAY,GAAA;AACtC,EAAA,IAAI;AACF,IAAAK,iBAAA;AAAA,MACE,WAAA;AAAA,MACA,KAAA;AAAA,MACA,SAAS,YAAsC,IAAA,EAA4C;AACzF,QAAA,MAAM,KAAA,GAAQ,iBAAA,CAAkB,KAAA,CAAM,IAAA,EAAM,IAAI,CAAA;AAChD,QAAA,MAAM,QAAQ,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,KAAA,CAAM,SAAS,CAAC,CAAA;AAC9C,QAAA,IAAI,CAAC,KAAA,EAAO;AACV,UAAA,OAAO,KAAA;AAAA,QACT;AACA,QAAAC,qBAAA,CAAW,UAAA,EAAY,KAAA,EAAOC,kBAAA,CAAa,IAAI,CAAC,CAAA;AAChD,QAAA,OAAO,KAAA;AAAA,MACT;AAAA,KACF;AAAA,EACF,SAAS,CAAA,EAAG;AACV,IAAAR,sBAAA,IAAeC,iBAAA,CAAM,KAAA,CAAM,qCAAA,EAAuC,CAAC,CAAA;AAAA,EACrE;AAEA,EAAA,MAAM,EAAE,aAAY,GAAI,OAAA;AACxB,EAAA,MAAM,yBAAyB,WAAA,CAAY,GAAA;AAC3C,EAAA,IAAI;AACF,IAAAK,iBAAA;AAAA,MACE,WAAA;AAAA,MACA,KAAA;AAAA,MACA,SAAS,eAKJ,IAAA,EACH;AAGA,QAAA,MAAM,KAAA,GAAQ,sBAAA,CAAuB,KAAA,CAAM,IAAA,EAAM,IAAI,CAAA;AACrD,QAAA,MAAM,SAASF,kCAAA,CAA6B,OAAO,CAAA,GAAI,IAAA,CAAK,SAAS,IAAA,CAAK,OAAA;AAC1E,QAAA,IAAI,MAAA,EAAQ;AACV,UAAA,MAAM,QAAQ,MAAA,CAAO,KAAA,CAAM,MAAA,CAAO,KAAA,CAAM,SAAS,CAAC,CAAA;AAClD,UAAA,IAAI,KAAA,EAAO;AACT,YAAAG,qBAAA,CAAW,UAAA,EAAY,KAAA,EAAOC,kBAAA,CAAa,IAAI,CAAC,CAAA;AAAA,UAClD;AAAA,QACF;AACA,QAAA,OAAO,KAAA;AAAA,MACT;AAAA,KACF;AAAA,EACF,SAAS,CAAA,EAAG;AACV,IAAAR,sBAAA,IAAeC,iBAAA,CAAM,KAAA,CAAM,iDAAA,EAAmD,CAAC,CAAA;AAAA,EACjF;AAEA,EAAA,OAAO,OAAA;AACT;AAKO,SAAS,oBAAoB,OAAA,EAAyD;AAC3F,EAAA,OAAO,SAAS,qBAAA,CACd,KAAA,EACA,OAAA,EACA,KACA,IAAA,EACM;AAEN,IAAAQ,iDAAA,CAAyB,OAAO,CAAA;AAChC,IAAA,MAAM,iBAAA,GAAoB,SAAS,iBAAA,IAAqBC,8BAAA;AAExD,IAAA,IAAI,iBAAA,CAAkB,KAAK,CAAA,EAAG;AAC5B,MAAA,MAAM,OAAA,GAAUC,2BAAiB,KAAA,EAAO;AAAA,QACtC,SAAA,EAAW,EAAE,IAAA,EAAM,yBAAA,EAA2B,SAAS,KAAA;AAAM,OAC9D,CAAA;AACD,MAAC,IAA4B,MAAA,GAAS,OAAA;AAAA,IACxC;AAEA,IAAA,IAAA,CAAK,KAAK,CAAA;AAAA,EACZ,CAAA;AACF;AA4BO,SAAS,wBAAA,CACd,KAIA,OAAA,EACM;AACN,EAAA,GAAA,CAAI,GAAA,CAAI,uBAAuB,CAAA;AAC/B,EAAA,GAAA,CAAI,GAAA,CAAI,mBAAA,CAAoB,OAAO,CAAC,CAAA;AACtC;AAEA,SAAS,qBAAA,GAA2C;AAClD,EAAA,OAAO,SAAS,uBAAA,CAAwB,OAAA,EAAyB,IAAA,EAAuB,IAAA,EAAwB;AAC9G,IAAAF,iDAAA,CAAyB,OAAO,CAAA;AAChC,IAAA,IAAA,EAAK;AAAA,EACP,CAAA;AACF;;;;;;"}

package/build/cjs/integrations/express/patch-layer.js

@@ -14,222 +14,114 @@ const utils = require('./utils.js');
 const defaultScopes = require('../../defaultScopes.js');
 const setSdkProcessingMetadata = require('./set-sdk-processing-metadata.js');
 
-/**
- * Platform-portable Express tracing integration.
- *
- * @module
- *
- * This Sentry integration is a derivative work based on the OpenTelemetry
- * Express instrumentation.
- *
- * <https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-express>
- *
- * Extended under the terms of the Apache 2.0 license linked below:
- *
- * ----
- *
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-
-function patchLayer(
-  getOptions,
-  maybeLayer,
-  layerPath,
-) {
+function patchLayer(getOptions, maybeLayer, layerPath) {
   if (!maybeLayer?.handle) {
     return;
   }
   const layer = maybeLayer;
-
   const layerHandleOriginal = layer.handle;
-
-  // avoid patching multiple times the same layer
   if (object.getOriginalFunction(layerHandleOriginal)) {
     return;
   }
-
   if (layerHandleOriginal.length === 4) {
-    // todo: instrument error handlers
     return;
   }
-
-  function layerHandlePatched(
-
-    req,
-    res,
-    //oxlint-disable-next-line no-explicit-any
-    ...otherArgs
-  ) {
+  function layerHandlePatched(req, res, ...otherArgs) {
     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
-    // send a response without calling next(). It would be safe to set this
-    // multiple times, since the data is identical, but more performant not to.
     setSdkProcessingMetadata.setSDKProcessingMetadata(req);
-
-    // Only create spans when there's an active parent span
-    // Without a parent span, this request is being ignored, so skip it
     const parentSpan = spanUtils.getActiveSpan();
     if (!parentSpan) {
       return layerHandleOriginal.apply(this, [req, res, ...otherArgs]);
     }
-
     if (layerPath) {
       requestLayerStore.storeLayer(req, layerPath);
     }
     const storedLayers = requestLayerStore.getStoredLayers(req);
     const isLayerPathStored = !!layerPath;
-
     const constructedRoute = utils.getConstructedRoute(req);
     const actualMatchedRoute = utils.getActualMatchedRoute(req, constructedRoute);
-
     options.onRouteResolved?.(actualMatchedRoute);
-
     const metadata = utils.getLayerMetadata(constructedRoute, layer, layerPath);
     const name = metadata.attributes[types.ATTR_EXPRESS_NAME];
     const type = metadata.attributes[types.ATTR_EXPRESS_TYPE];
     const attributes = Object.assign(metadata.attributes, {
-      [semanticAttributes.SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.express',
-      [semanticAttributes.SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.express`,
+      [semanticAttributes.SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: "auto.http.express",
+      [semanticAttributes.SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.express`
     });
     if (actualMatchedRoute) {
       attributes[types.ATTR_HTTP_ROUTE] = actualMatchedRoute;
     }
-
-    // verify against the config if the layer should be ignored
     if (utils.isLayerIgnored(metadata.attributes[types.ATTR_EXPRESS_NAME], type, options)) {
-      // XXX: the isLayerPathStored guard here is *not* present in the
-      // original @opentelemetry/instrumentation-express impl, but was
-      // suggested by the Sentry code review bot. It appears to correctly
-      // prevent improper layer calculation in the case where there's a
-      // middleware without a layerPath argument. It's unclear whether
-      // that's possible, or if any existing code depends on that "bug".
       if (isLayerPathStored) {
         storedLayers.pop();
       }
       return layerHandleOriginal.apply(this, [req, res, ...otherArgs]);
     }
-
     const currentScope = currentScopes.getIsolationScope();
     if (currentScope !== defaultScopes.getDefaultIsolationScope()) {
-      if (type === 'request_handler') {
-        // type cast b/c Otel unfortunately types info.request as any :(
-        const method = req.method ? req.method.toUpperCase() : 'GET';
+      if (type === "request_handler") {
+        const method = req.method ? req.method.toUpperCase() : "GET";
         currentScope.setTransactionName(`${method} ${constructedRoute}`);
       }
     } else {
-      debugBuild.DEBUG_BUILD && debugLogger.debug.warn('Isolation scope is still default isolation scope - skipping setting transactionName');
+      debugBuild.DEBUG_BUILD && debugLogger.debug.warn("Isolation scope is still default isolation scope - skipping setting transactionName");
     }
-
-    return trace.startSpanManual({ name, attributes }, span => {
+    return trace.startSpanManual({ name, attributes }, (span) => {
       let spanHasEnded = false;
-      // TODO: Fix router spans (getRouterPath does not work properly) to
-      // have useful names before removing this branch
       if (metadata.attributes[types.ATTR_EXPRESS_TYPE] === types.ExpressLayerType_ROUTER) {
         span.end();
         spanHasEnded = true;
       }
-      // listener for response.on('finish')
       const onResponseFinish = () => {
         if (!spanHasEnded) {
           spanHasEnded = true;
           span.end();
         }
       };
-
-      // verify we have a callback
       for (let i = 0; i < otherArgs.length; i++) {
-        const callback = otherArgs[i] ;
-        if (typeof callback !== 'function') {
+        const callback = otherArgs[i];
+        if (typeof callback !== "function") {
           continue;
         }
-
-        //oxlint-disable-next-line no-explicit-any
-        otherArgs[i] = function (...args) {
-          // express considers anything but an empty value, "route" or "router"
-          // passed to its callback to be an error
+        otherArgs[i] = function(...args) {
           const maybeError = args[0];
-          const isError = !!maybeError && maybeError !== 'route' && maybeError !== 'router';
+          const isError = !!maybeError && maybeError !== "route" && maybeError !== "router";
           if (!spanHasEnded && isError) {
             const [_, message] = utils.asErrorAndMessage(maybeError);
-            // intentionally do not record the exception here, because
-            // the error handler we assign does that, provided the user
-            // correctly calls setupExpressErrorHandler.
-            // TODO: A future enhancement can automatically attach
-            // the error handler if we detect that it has not been added.
             span.setStatus({
               code: spanstatus.SPAN_STATUS_ERROR,
-              message,
+              message
             });
           }
-
           if (!spanHasEnded) {
             spanHasEnded = true;
-            res.removeListener('finish', onResponseFinish);
+            res.removeListener("finish", onResponseFinish);
             span.end();
           }
           if (!(req.route && isError) && isLayerPathStored) {
             storedLayers.pop();
           }
-          // execute the callback back in the parent's scope, so that
-          // we bubble up each level as next() is called.
           return trace.withActiveSpan(parentSpan, () => callback.apply(this, args));
         };
         break;
       }
-
       try {
         return layerHandleOriginal.apply(this, [req, res, ...otherArgs]);
       } catch (anyError) {
         const [_, message] = utils.asErrorAndMessage(anyError);
-        // intentionally do not record the exception here, because
-        // the error handler we assign does that, provided the user
-        // correctly calls setupExpressErrorHandler.
-        // TODO: A future enhancement can automatically attach
-        // the error handler if we detect that it has not been added.
         span.setStatus({
           code: spanstatus.SPAN_STATUS_ERROR,
-          message,
+          message
         });
         throw anyError;
-        /* v8 ignore next - it sees the block end at the throw */
       } finally {
-        // At this point if the callback wasn't called, that means
-        // either the layer is asynchronous (so it will call the
-        // callback later on) or that the layer directly ends the
-        // http response, so we'll hook into the "finish" event to
-        // handle the later case.
         if (!spanHasEnded) {
-          res.once('finish', onResponseFinish);
+          res.once("finish", onResponseFinish);
         }
       }
     });
   }
-
-  // `handle` isn't just a regular function in some cases. It also contains
-  // some properties holding metadata and state so we need to proxy them
-  // through through patched function. Use a for-in to also pick up properties
-  // that other libraries might add to the prototype before we instrument.
-  // ref: https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1950
-  // ref: https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2271
-  // oxlint-disable-next-line guard-for-in
-  for (const key in layerHandleOriginal ) {
-    // skip standard function prototype fields that both have
+  for (const key in layerHandleOriginal) {
     if (key in layerHandlePatched) {
       continue;
     }
@@ -239,17 +131,15 @@ function patchLayer(
       },
       set(value) {
         layerHandleOriginal[key] = value;
-      },
+      }
     });
   }
-
   object.markFunctionWrapped(layerHandlePatched, layerHandleOriginal);
-
-  Object.defineProperty(layer, 'handle', {
+  Object.defineProperty(layer, "handle", {
     enumerable: true,
     configurable: true,
     writable: true,
-    value: layerHandlePatched,
+    value: layerHandlePatched
   });
 }
 

package/build/cjs/integrations/express/patch-layer.js.map

@@ -1 +1 @@
-{"version":3,"file":"patch-layer.js","sources":["../../../../src/integrations/express/patch-layer.ts"],"sourcesContent":["/**\n * Platform-portable Express tracing integration.\n *\n * @module\n *\n * This Sentry integration is a derivative work based on the OpenTelemetry\n * Express instrumentation.\n *\n * <https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-express>\n *\n * Extended under the terms of the Apache 2.0 license linked below:\n *\n * ----\n *\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { DEBUG_BUILD } from '../../debug-build';\nimport { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '../../semanticAttributes';\nimport { SPAN_STATUS_ERROR, startSpanManual, withActiveSpan } from '../../tracing';\nimport { debug } from '../../utils/debug-logger';\nimport type { SpanAttributes } from '../../types-hoist/span';\nimport { getActiveSpan } from '../../utils/spanUtils';\nimport { getStoredLayers, storeLayer } from './request-layer-store';\nimport {\n  type ExpressRequest,\n  type ExpressResponse,\n  type ExpressIntegrationOptions,\n  type ExpressLayer,\n  ATTR_HTTP_ROUTE,\n  ATTR_EXPRESS_TYPE,\n  ATTR_EXPRESS_NAME,\n  ExpressLayerType_ROUTER,\n} from './types';\nimport {\n  asErrorAndMessage,\n  getActualMatchedRoute,\n  getConstructedRoute,\n  getLayerMetadata,\n  isLayerIgnored,\n} from './utils';\nimport { getIsolationScope } from '../../currentScopes';\nimport { getDefaultIsolationScope } from '../../defaultScopes';\nimport { getOriginalFunction, markFunctionWrapped } from '../../utils/object';\nimport { setSDKProcessingMetadata } from './set-sdk-processing-metadata';\n\nexport type ExpressPatchLayerOptions = Pick<\n  ExpressIntegrationOptions,\n  'onRouteResolved' | 'ignoreLayers' | 'ignoreLayersType'\n>;\n\nexport function patchLayer(\n  getOptions: () => ExpressPatchLayerOptions,\n  maybeLayer?: ExpressLayer,\n  layerPath?: string,\n): void {\n  if (!maybeLayer?.handle) {\n    return;\n  }\n  const layer = maybeLayer;\n\n  const layerHandleOriginal = layer.handle;\n\n  // avoid patching multiple times the same layer\n  if (getOriginalFunction(layerHandleOriginal)) {\n    return;\n  }\n\n  if (layerHandleOriginal.length === 4) {\n    // todo: instrument error handlers\n    return;\n  }\n\n  function layerHandlePatched(\n    this: ExpressLayer,\n    req: ExpressRequest,\n    res: ExpressResponse,\n    //oxlint-disable-next-line no-explicit-any\n    ...otherArgs: any[]\n  ) {\n    const options = getOptions();\n\n    // Set normalizedRequest here because expressRequestHandler middleware\n    // (registered via setupExpressErrorHandler) is added after routes and\n    // therefore never runs for successful requests — route handlers typically\n    // send a response without calling next(). It would be safe to set this\n    // multiple times, since the data is identical, but more performant not to.\n    setSDKProcessingMetadata(req);\n\n    // Only create spans when there's an active parent span\n    // Without a parent span, this request is being ignored, so skip it\n    const parentSpan = getActiveSpan();\n    if (!parentSpan) {\n      return layerHandleOriginal.apply(this, [req, res, ...otherArgs]);\n    }\n\n    if (layerPath) {\n      storeLayer(req, layerPath);\n    }\n    const storedLayers = getStoredLayers(req);\n    const isLayerPathStored = !!layerPath;\n\n    const constructedRoute = getConstructedRoute(req);\n    const actualMatchedRoute = getActualMatchedRoute(req, constructedRoute);\n\n    options.onRouteResolved?.(actualMatchedRoute);\n\n    const metadata = getLayerMetadata(constructedRoute, layer, layerPath);\n    const name = metadata.attributes[ATTR_EXPRESS_NAME];\n    const type = metadata.attributes[ATTR_EXPRESS_TYPE];\n    const attributes: SpanAttributes = Object.assign(metadata.attributes, {\n      [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.express',\n      [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.express`,\n    });\n    if (actualMatchedRoute) {\n      attributes[ATTR_HTTP_ROUTE] = actualMatchedRoute;\n    }\n\n    // verify against the config if the layer should be ignored\n    if (isLayerIgnored(metadata.attributes[ATTR_EXPRESS_NAME], type, options)) {\n      // XXX: the isLayerPathStored guard here is *not* present in the\n      // original @opentelemetry/instrumentation-express impl, but was\n      // suggested by the Sentry code review bot. It appears to correctly\n      // prevent improper layer calculation in the case where there's a\n      // middleware without a layerPath argument. It's unclear whether\n      // that's possible, or if any existing code depends on that \"bug\".\n      if (isLayerPathStored) {\n        storedLayers.pop();\n      }\n      return layerHandleOriginal.apply(this, [req, res, ...otherArgs]);\n    }\n\n    const currentScope = getIsolationScope();\n    if (currentScope !== getDefaultIsolationScope()) {\n      if (type === 'request_handler') {\n        // type cast b/c Otel unfortunately types info.request as any :(\n        const method = req.method ? req.method.toUpperCase() : 'GET';\n        currentScope.setTransactionName(`${method} ${constructedRoute}`);\n      }\n    } else {\n      DEBUG_BUILD && debug.warn('Isolation scope is still default isolation scope - skipping setting transactionName');\n    }\n\n    return startSpanManual({ name, attributes }, span => {\n      let spanHasEnded = false;\n      // TODO: Fix router spans (getRouterPath does not work properly) to\n      // have useful names before removing this branch\n      if (metadata.attributes[ATTR_EXPRESS_TYPE] === ExpressLayerType_ROUTER) {\n        span.end();\n        spanHasEnded = true;\n      }\n      // listener for response.on('finish')\n      const onResponseFinish = () => {\n        if (!spanHasEnded) {\n          spanHasEnded = true;\n          span.end();\n        }\n      };\n\n      // verify we have a callback\n      for (let i = 0; i < otherArgs.length; i++) {\n        const callback = otherArgs[i] as Function;\n        if (typeof callback !== 'function') {\n          continue;\n        }\n\n        //oxlint-disable-next-line no-explicit-any\n        otherArgs[i] = function (...args: any[]) {\n          // express considers anything but an empty value, \"route\" or \"router\"\n          // passed to its callback to be an error\n          const maybeError = args[0];\n          const isError = !!maybeError && maybeError !== 'route' && maybeError !== 'router';\n          if (!spanHasEnded && isError) {\n            const [_, message] = asErrorAndMessage(maybeError);\n            // intentionally do not record the exception here, because\n            // the error handler we assign does that, provided the user\n            // correctly calls setupExpressErrorHandler.\n            // TODO: A future enhancement can automatically attach\n            // the error handler if we detect that it has not been added.\n            span.setStatus({\n              code: SPAN_STATUS_ERROR,\n              message,\n            });\n          }\n\n          if (!spanHasEnded) {\n            spanHasEnded = true;\n            res.removeListener('finish', onResponseFinish);\n            span.end();\n          }\n          if (!(req.route && isError) && isLayerPathStored) {\n            storedLayers.pop();\n          }\n          // execute the callback back in the parent's scope, so that\n          // we bubble up each level as next() is called.\n          return withActiveSpan(parentSpan, () => callback.apply(this, args));\n        };\n        break;\n      }\n\n      try {\n        return layerHandleOriginal.apply(this, [req, res, ...otherArgs]);\n      } catch (anyError) {\n        const [_, message] = asErrorAndMessage(anyError);\n        // intentionally do not record the exception here, because\n        // the error handler we assign does that, provided the user\n        // correctly calls setupExpressErrorHandler.\n        // TODO: A future enhancement can automatically attach\n        // the error handler if we detect that it has not been added.\n        span.setStatus({\n          code: SPAN_STATUS_ERROR,\n          message,\n        });\n        throw anyError;\n        /* v8 ignore next - it sees the block end at the throw */\n      } finally {\n        // At this point if the callback wasn't called, that means\n        // either the layer is asynchronous (so it will call the\n        // callback later on) or that the layer directly ends the\n        // http response, so we'll hook into the \"finish\" event to\n        // handle the later case.\n        if (!spanHasEnded) {\n          res.once('finish', onResponseFinish);\n        }\n      }\n    });\n  }\n\n  // `handle` isn't just a regular function in some cases. It also contains\n  // some properties holding metadata and state so we need to proxy them\n  // through through patched function. Use a for-in to also pick up properties\n  // that other libraries might add to the prototype before we instrument.\n  // ref: https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1950\n  // ref: https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2271\n  // oxlint-disable-next-line guard-for-in\n  for (const key in layerHandleOriginal as Function & Record<string, unknown>) {\n    // skip standard function prototype fields that both have\n    if (key in layerHandlePatched) {\n      continue;\n    }\n    Object.defineProperty(layerHandlePatched, key, {\n      get() {\n        return layerHandleOriginal[key];\n      },\n      set(value) {\n        layerHandleOriginal[key] = value;\n      },\n    });\n  }\n\n  markFunctionWrapped(layerHandlePatched, layerHandleOriginal);\n\n  Object.defineProperty(layer, 'handle', {\n    enumerable: true,\n    configurable: true,\n    writable: true,\n    value: layerHandlePatched,\n  });\n}\n"],"names":["getOriginalFunction","setSDKProcessingMetadata","getActiveSpan","storeLayer","getStoredLayers","getConstructedRoute","getActualMatchedRoute","getLayerMetadata","ATTR_EXPRESS_NAME","ATTR_EXPRESS_TYPE","SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN","SEMANTIC_ATTRIBUTE_SENTRY_OP","ATTR_HTTP_ROUTE","isLayerIgnored","getIsolationScope","getDefaultIsolationScope","DEBUG_BUILD","debug","startSpanManual","ExpressLayerType_ROUTER","asErrorAndMessage","SPAN_STATUS_ERROR","withActiveSpan","markFunctionWrapped"],"mappings":";;;;;;;;;;;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AAoCO,SAAS,UAAU;AAC1B,EAAE,UAAU;AACZ,EAAE,UAAU;AACZ,EAAE,SAAS;AACX,EAAQ;AACR,EAAE,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE;AAC3B,IAAI;AACJ,EAAE;AACF,EAAE,MAAM,KAAA,GAAQ,UAAU;;AAE1B,EAAE,MAAM,mBAAA,GAAsB,KAAK,CAAC,MAAM;;AAE1C;AACA,EAAE,IAAIA,0BAAmB,CAAC,mBAAmB,CAAC,EAAE;AAChD,IAAI;AACJ,EAAE;;AAEF,EAAE,IAAI,mBAAmB,CAAC,MAAA,KAAW,CAAC,EAAE;AACxC;AACA,IAAI;AACJ,EAAE;;AAEF,EAAE,SAAS,kBAAkB;;AAE7B,IAAI,GAAG;AACP,IAAI,GAAG;AACP;AACA,IAAI,GAAG;AACP,IAAI;AACJ,IAAI,MAAM,OAAA,GAAU,UAAU,EAAE;;AAEhC;AACA;AACA;AACA;AACA;AACA,IAAIC,iDAAwB,CAAC,GAAG,CAAC;;AAEjC;AACA;AACA,IAAI,MAAM,UAAA,GAAaC,uBAAa,EAAE;AACtC,IAAI,IAAI,CAAC,UAAU,EAAE;AACrB,MAAM,OAAO,mBAAmB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;AACtE,IAAI;;AAEJ,IAAI,IAAI,SAAS,EAAE;AACnB,MAAMC,4BAAU,CAAC,GAAG,EAAE,SAAS,CAAC;AAChC,IAAI;AACJ,IAAI,MAAM,YAAA,GAAeC,iCAAe,CAAC,GAAG,CAAC;AAC7C,IAAI,MAAM,iBAAA,GAAoB,CAAC,CAAC,SAAS;;AAEzC,IAAI,MAAM,gBAAA,GAAmBC,yBAAmB,CAAC,GAAG,CAAC;AACrD,IAAI,MAAM,qBAAqBC,2BAAqB,CAAC,GAAG,EAAE,gBAAgB,CAAC;;AAE3E,IAAI,OAAO,CAAC,eAAe,GAAG,kBAAkB,CAAC;;AAEjD,IAAI,MAAM,QAAA,GAAWC,sBAAgB,CAAC,gBAAgB,EAAE,KAAK,EAAE,SAAS,CAAC;AACzE,IAAI,MAAM,OAAO,QAAQ,CAAC,UAAU,CAACC,uBAAiB,CAAC;AACvD,IAAI,MAAM,OAAO,QAAQ,CAAC,UAAU,CAACC,uBAAiB,CAAC;AACvD,IAAI,MAAM,UAAU,GAAmB,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE;AAC1E,MAAM,CAACC,mDAAgC,GAAG,mBAAmB;AAC7D,MAAM,CAACC,+CAA4B,GAAG,CAAC,EAAA,IAAA,CAAA,QAAA,CAAA;AACA,KAAA,CAAA;AACA,IAAA,IAAA,kBAAA,EAAA;AACA,MAAA,UAAA,CAAAC,qBAAA,CAAA,GAAA,kBAAA;AACA,IAAA;;AAEA;AACA,IAAA,IAAAC,oBAAA,CAAA,QAAA,CAAA,UAAA,CAAAL,uBAAA,CAAA,EAAA,IAAA,EAAA,OAAA,CAAA,EAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAA,IAAA,iBAAA,EAAA;AACA,QAAA,YAAA,CAAA,GAAA,EAAA;AACA,MAAA;AACA,MAAA,OAAA,mBAAA,CAAA,KAAA,CAAA,IAAA,EAAA,CAAA,GAAA,EAAA,GAAA,EAAA,GAAA,SAAA,CAAA,CAAA;AACA,IAAA;;AAEA,IAAA,MAAA,YAAA,GAAAM,+BAAA,EAAA;AACA,IAAA,IAAA,YAAA,KAAAC,sCAAA,EAAA,EAAA;AACA,MAAA,IAAA,IAAA,KAAA,iBAAA,EAAA;AACA;AACA,QAAA,MAAA,MAAA,GAAA,GAAA,CAAA,MAAA,GAAA,GAAA,CAAA,MAAA,CAAA,WAAA,EAAA,GAAA,KAAA;AACA,QAAA,YAAA,CAAA,kBAAA,CAAA,CAAA,EAAA,MAAA,CAAA,CAAA,EAAA,gBAAA,CAAA,CAAA,CAAA;AACA,MAAA;AACA,IAAA,CAAA,MAAA;AACA,MAAAC,sBAAA,IAAAC,iBAAA,CAAA,IAAA,CAAA,qFAAA,CAAA;AACA,IAAA;;AAEA,IAAA,OAAAC,qBAAA,CAAA,EAAA,IAAA,EAAA,UAAA,EAAA,EAAA,IAAA,IAAA;AACA,MAAA,IAAA,YAAA,GAAA,KAAA;AACA;AACA;AACA,MAAA,IAAA,QAAA,CAAA,UAAA,CAAAT,uBAAA,CAAA,KAAAU,6BAAA,EAAA;AACA,QAAA,IAAA,CAAA,GAAA,EAAA;AACA,QAAA,YAAA,GAAA,IAAA;AACA,MAAA;AACA;AACA,MAAA,MAAA,gBAAA,GAAA,MAAA;AACA,QAAA,IAAA,CAAA,YAAA,EAAA;AACA,UAAA,YAAA,GAAA,IAAA;AACA,UAAA,IAAA,CAAA,GAAA,EAAA;AACA,QAAA;AACA,MAAA,CAAA;;AAEA;AACA,MAAA,KAAA,IAAA,CAAA,GAAA,CAAA,EAAA,CAAA,GAAA,SAAA,CAAA,MAAA,EAAA,CAAA,EAAA,EAAA;AACA,QAAA,MAAA,QAAA,GAAA,SAAA,CAAA,CAAA,CAAA;AACA,QAAA,IAAA,OAAA,QAAA,KAAA,UAAA,EAAA;AACA,UAAA;AACA,QAAA;;AAEA;AACA,QAAA,SAAA,CAAA,CAAA,CAAA,GAAA,UAAA,GAAA,IAAA,EAAA;AACA;AACA;AACA,UAAA,MAAA,UAAA,GAAA,IAAA,CAAA,CAAA,CAAA;AACA,UAAA,MAAA,OAAA,GAAA,CAAA,CAAA,UAAA,IAAA,UAAA,KAAA,OAAA,IAAA,UAAA,KAAA,QAAA;AACA,UAAA,IAAA,CAAA,YAAA,IAAA,OAAA,EAAA;AACA,YAAA,MAAA,CAAA,CAAA,EAAA,OAAA,CAAA,GAAAC,uBAAA,CAAA,UAAA,CAAA;AACA;AACA;AACA;AACA;AACA;AACA,YAAA,IAAA,CAAA,SAAA,CAAA;AACA,cAAA,IAAA,EAAAC,4BAAA;AACA,cAAA,OAAA;AACA,aAAA,CAAA;AACA,UAAA;;AAEA,UAAA,IAAA,CAAA,YAAA,EAAA;AACA,YAAA,YAAA,GAAA,IAAA;AACA,YAAA,GAAA,CAAA,cAAA,CAAA,QAAA,EAAA,gBAAA,CAAA;AACA,YAAA,IAAA,CAAA,GAAA,EAAA;AACA,UAAA;AACA,UAAA,IAAA,EAAA,GAAA,CAAA,KAAA,IAAA,OAAA,CAAA,IAAA,iBAAA,EAAA;AACA,YAAA,YAAA,CAAA,GAAA,EAAA;AACA,UAAA;AACA;AACA;AACA,UAAA,OAAAC,oBAAA,CAAA,UAAA,EAAA,MAAA,QAAA,CAAA,KAAA,CAAA,IAAA,EAAA,IAAA,CAAA,CAAA;AACA,QAAA,CAAA;AACA,QAAA;AACA,MAAA;;AAEA,MAAA,IAAA;AACA,QAAA,OAAA,mBAAA,CAAA,KAAA,CAAA,IAAA,EAAA,CAAA,GAAA,EAAA,GAAA,EAAA,GAAA,SAAA,CAAA,CAAA;AACA,MAAA,CAAA,CAAA,OAAA,QAAA,EAAA;AACA,QAAA,MAAA,CAAA,CAAA,EAAA,OAAA,CAAA,GAAAF,uBAAA,CAAA,QAAA,CAAA;AACA;AACA;AACA;AACA;AACA;AACA,QAAA,IAAA,CAAA,SAAA,CAAA;AACA,UAAA,IAAA,EAAAC,4BAAA;AACA,UAAA,OAAA;AACA,SAAA,CAAA;AACA,QAAA,MAAA,QAAA;AACA;AACA,MAAA,CAAA,SAAA;AACA;AACA;AACA;AACA;AACA;AACA,QAAA,IAAA,CAAA,YAAA,EAAA;AACA,UAAA,GAAA,CAAA,IAAA,CAAA,QAAA,EAAA,gBAAA,CAAA;AACA,QAAA;AACA,MAAA;AACA,IAAA,CAAA,CAAA;AACA,EAAA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAA,KAAA,MAAA,GAAA,IAAA,mBAAA,GAAA;AACA;AACA,IAAA,IAAA,GAAA,IAAA,kBAAA,EAAA;AACA,MAAA;AACA,IAAA;AACA,IAAA,MAAA,CAAA,cAAA,CAAA,kBAAA,EAAA,GAAA,EAAA;AACA,MAAA,GAAA,GAAA;AACA,QAAA,OAAA,mBAAA,CAAA,GAAA,CAAA;AACA,MAAA,CAAA;AACA,MAAA,GAAA,CAAA,KAAA,EAAA;AACA,QAAA,mBAAA,CAAA,GAAA,CAAA,GAAA,KAAA;AACA,MAAA,CAAA;AACA,KAAA,CAAA;AACA,EAAA;;AAEA,EAAAE,0BAAA,CAAA,kBAAA,EAAA,mBAAA,CAAA;;AAEA,EAAA,MAAA,CAAA,cAAA,CAAA,KAAA,EAAA,QAAA,EAAA;AACA,IAAA,UAAA,EAAA,IAAA;AACA,IAAA,YAAA,EAAA,IAAA;AACA,IAAA,QAAA,EAAA,IAAA;AACA,IAAA,KAAA,EAAA,kBAAA;AACA,GAAA,CAAA;AACA;;;;"}
+{"version":3,"file":"patch-layer.js","sources":["../../../../src/integrations/express/patch-layer.ts"],"sourcesContent":["/**\n * Platform-portable Express tracing integration.\n *\n * @module\n *\n * This Sentry integration is a derivative work based on the OpenTelemetry\n * Express instrumentation.\n *\n * <https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-express>\n *\n * Extended under the terms of the Apache 2.0 license linked below:\n *\n * ----\n *\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { DEBUG_BUILD } from '../../debug-build';\nimport { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '../../semanticAttributes';\nimport { SPAN_STATUS_ERROR, startSpanManual, withActiveSpan } from '../../tracing';\nimport { debug } from '../../utils/debug-logger';\nimport type { SpanAttributes } from '../../types/span';\nimport { getActiveSpan } from '../../utils/spanUtils';\nimport { getStoredLayers, storeLayer } from './request-layer-store';\nimport {\n  type ExpressRequest,\n  type ExpressResponse,\n  type ExpressIntegrationOptions,\n  type ExpressLayer,\n  ATTR_HTTP_ROUTE,\n  ATTR_EXPRESS_TYPE,\n  ATTR_EXPRESS_NAME,\n  ExpressLayerType_ROUTER,\n} from './types';\nimport {\n  asErrorAndMessage,\n  getActualMatchedRoute,\n  getConstructedRoute,\n  getLayerMetadata,\n  isLayerIgnored,\n} from './utils';\nimport { getIsolationScope } from '../../currentScopes';\nimport { getDefaultIsolationScope } from '../../defaultScopes';\nimport { getOriginalFunction, markFunctionWrapped } from '../../utils/object';\nimport { setSDKProcessingMetadata } from './set-sdk-processing-metadata';\n\nexport type ExpressPatchLayerOptions = Pick<\n  ExpressIntegrationOptions,\n  'onRouteResolved' | 'ignoreLayers' | 'ignoreLayersType'\n>;\n\nexport function patchLayer(\n  getOptions: () => ExpressPatchLayerOptions,\n  maybeLayer?: ExpressLayer,\n  layerPath?: string,\n): void {\n  if (!maybeLayer?.handle) {\n    return;\n  }\n  const layer = maybeLayer;\n\n  const layerHandleOriginal = layer.handle;\n\n  // avoid patching multiple times the same layer\n  if (getOriginalFunction(layerHandleOriginal)) {\n    return;\n  }\n\n  if (layerHandleOriginal.length === 4) {\n    // todo: instrument error handlers\n    return;\n  }\n\n  function layerHandlePatched(\n    this: ExpressLayer,\n    req: ExpressRequest,\n    res: ExpressResponse,\n    //oxlint-disable-next-line no-explicit-any\n    ...otherArgs: any[]\n  ) {\n    const options = getOptions();\n\n    // Set normalizedRequest here because expressRequestHandler middleware\n    // (registered via setupExpressErrorHandler) is added after routes and\n    // therefore never runs for successful requests — route handlers typically\n    // send a response without calling next(). It would be safe to set this\n    // multiple times, since the data is identical, but more performant not to.\n    setSDKProcessingMetadata(req);\n\n    // Only create spans when there's an active parent span\n    // Without a parent span, this request is being ignored, so skip it\n    const parentSpan = getActiveSpan();\n    if (!parentSpan) {\n      return layerHandleOriginal.apply(this, [req, res, ...otherArgs]);\n    }\n\n    if (layerPath) {\n      storeLayer(req, layerPath);\n    }\n    const storedLayers = getStoredLayers(req);\n    const isLayerPathStored = !!layerPath;\n\n    const constructedRoute = getConstructedRoute(req);\n    const actualMatchedRoute = getActualMatchedRoute(req, constructedRoute);\n\n    options.onRouteResolved?.(actualMatchedRoute);\n\n    const metadata = getLayerMetadata(constructedRoute, layer, layerPath);\n    const name = metadata.attributes[ATTR_EXPRESS_NAME];\n    const type = metadata.attributes[ATTR_EXPRESS_TYPE];\n    const attributes: SpanAttributes = Object.assign(metadata.attributes, {\n      [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.express',\n      [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.express`,\n    });\n    if (actualMatchedRoute) {\n      attributes[ATTR_HTTP_ROUTE] = actualMatchedRoute;\n    }\n\n    // verify against the config if the layer should be ignored\n    if (isLayerIgnored(metadata.attributes[ATTR_EXPRESS_NAME], type, options)) {\n      // XXX: the isLayerPathStored guard here is *not* present in the\n      // original @opentelemetry/instrumentation-express impl, but was\n      // suggested by the Sentry code review bot. It appears to correctly\n      // prevent improper layer calculation in the case where there's a\n      // middleware without a layerPath argument. It's unclear whether\n      // that's possible, or if any existing code depends on that \"bug\".\n      if (isLayerPathStored) {\n        storedLayers.pop();\n      }\n      return layerHandleOriginal.apply(this, [req, res, ...otherArgs]);\n    }\n\n    const currentScope = getIsolationScope();\n    if (currentScope !== getDefaultIsolationScope()) {\n      if (type === 'request_handler') {\n        // type cast b/c Otel unfortunately types info.request as any :(\n        const method = req.method ? req.method.toUpperCase() : 'GET';\n        currentScope.setTransactionName(`${method} ${constructedRoute}`);\n      }\n    } else {\n      DEBUG_BUILD && debug.warn('Isolation scope is still default isolation scope - skipping setting transactionName');\n    }\n\n    return startSpanManual({ name, attributes }, span => {\n      let spanHasEnded = false;\n      // TODO: Fix router spans (getRouterPath does not work properly) to\n      // have useful names before removing this branch\n      if (metadata.attributes[ATTR_EXPRESS_TYPE] === ExpressLayerType_ROUTER) {\n        span.end();\n        spanHasEnded = true;\n      }\n      // listener for response.on('finish')\n      const onResponseFinish = () => {\n        if (!spanHasEnded) {\n          spanHasEnded = true;\n          span.end();\n        }\n      };\n\n      // verify we have a callback\n      for (let i = 0; i < otherArgs.length; i++) {\n        const callback = otherArgs[i] as Function;\n        if (typeof callback !== 'function') {\n          continue;\n        }\n\n        //oxlint-disable-next-line no-explicit-any\n        otherArgs[i] = function (...args: any[]) {\n          // express considers anything but an empty value, \"route\" or \"router\"\n          // passed to its callback to be an error\n          const maybeError = args[0];\n          const isError = !!maybeError && maybeError !== 'route' && maybeError !== 'router';\n          if (!spanHasEnded && isError) {\n            const [_, message] = asErrorAndMessage(maybeError);\n            // intentionally do not record the exception here, because\n            // the error handler we assign does that, provided the user\n            // correctly calls setupExpressErrorHandler.\n            // TODO: A future enhancement can automatically attach\n            // the error handler if we detect that it has not been added.\n            span.setStatus({\n              code: SPAN_STATUS_ERROR,\n              message,\n            });\n          }\n\n          if (!spanHasEnded) {\n            spanHasEnded = true;\n            res.removeListener('finish', onResponseFinish);\n            span.end();\n          }\n          if (!(req.route && isError) && isLayerPathStored) {\n            storedLayers.pop();\n          }\n          // execute the callback back in the parent's scope, so that\n          // we bubble up each level as next() is called.\n          return withActiveSpan(parentSpan, () => callback.apply(this, args));\n        };\n        break;\n      }\n\n      try {\n        return layerHandleOriginal.apply(this, [req, res, ...otherArgs]);\n      } catch (anyError) {\n        const [_, message] = asErrorAndMessage(anyError);\n        // intentionally do not record the exception here, because\n        // the error handler we assign does that, provided the user\n        // correctly calls setupExpressErrorHandler.\n        // TODO: A future enhancement can automatically attach\n        // the error handler if we detect that it has not been added.\n        span.setStatus({\n          code: SPAN_STATUS_ERROR,\n          message,\n        });\n        throw anyError;\n        /* v8 ignore next - it sees the block end at the throw */\n      } finally {\n        // At this point if the callback wasn't called, that means\n        // either the layer is asynchronous (so it will call the\n        // callback later on) or that the layer directly ends the\n        // http response, so we'll hook into the \"finish\" event to\n        // handle the later case.\n        if (!spanHasEnded) {\n          res.once('finish', onResponseFinish);\n        }\n      }\n    });\n  }\n\n  // `handle` isn't just a regular function in some cases. It also contains\n  // some properties holding metadata and state so we need to proxy them\n  // through through patched function. Use a for-in to also pick up properties\n  // that other libraries might add to the prototype before we instrument.\n  // ref: https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1950\n  // ref: https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2271\n  // oxlint-disable-next-line guard-for-in\n  for (const key in layerHandleOriginal as Function & Record<string, unknown>) {\n    // skip standard function prototype fields that both have\n    if (key in layerHandlePatched) {\n      continue;\n    }\n    Object.defineProperty(layerHandlePatched, key, {\n      get() {\n        return layerHandleOriginal[key];\n      },\n      set(value) {\n        layerHandleOriginal[key] = value;\n      },\n    });\n  }\n\n  markFunctionWrapped(layerHandlePatched, layerHandleOriginal);\n\n  Object.defineProperty(layer, 'handle', {\n    enumerable: true,\n    configurable: true,\n    writable: true,\n    value: layerHandlePatched,\n  });\n}\n"],"names":["getOriginalFunction","setSDKProcessingMetadata","getActiveSpan","storeLayer","getStoredLayers","getConstructedRoute","getActualMatchedRoute","getLayerMetadata","ATTR_EXPRESS_NAME","ATTR_EXPRESS_TYPE","SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN","SEMANTIC_ATTRIBUTE_SENTRY_OP","ATTR_HTTP_ROUTE","isLayerIgnored","getIsolationScope","getDefaultIsolationScope","DEBUG_BUILD","debug","startSpanManual","ExpressLayerType_ROUTER","asErrorAndMessage","SPAN_STATUS_ERROR","withActiveSpan","markFunctionWrapped"],"mappings":";;;;;;;;;;;;;;;;AA+DO,SAAS,UAAA,CACd,UAAA,EACA,UAAA,EACA,SAAA,EACM;AACN,EAAA,IAAI,CAAC,YAAY,MAAA,EAAQ;AACvB,IAAA;AAAA,EACF;AACA,EAAA,MAAM,KAAA,GAAQ,UAAA;AAEd,EAAA,MAAM,sBAAsB,KAAA,CAAM,MAAA;AAGlC,EAAA,IAAIA,0BAAA,CAAoB,mBAAmB,CAAA,EAAG;AAC5C,IAAA;AAAA,EACF;AAEA,EAAA,IAAI,mBAAA,CAAoB,WAAW,CAAA,EAAG;AAEpC,IAAA;AAAA,EACF;AAEA,EAAA,SAAS,kBAAA,CAEP,GAAA,EACA,GAAA,EAAA,GAEG,SAAA,EACH;AACA,IAAA,MAAM,UAAU,UAAA,EAAW;AAO3B,IAAAC,iDAAA,CAAyB,GAAG,CAAA;AAI5B,IAAA,MAAM,aAAaC,uBAAA,EAAc;AACjC,IAAA,IAAI,CAAC,UAAA,EAAY;AACf,MAAA,OAAO,mBAAA,CAAoB,MAAM,IAAA,EAAM,CAAC,KAAK,GAAA,EAAK,GAAG,SAAS,CAAC,CAAA;AAAA,IACjE;AAEA,IAAA,IAAI,SAAA,EAAW;AACb,MAAAC,4BAAA,CAAW,KAAK,SAAS,CAAA;AAAA,IAC3B;AACA,IAAA,MAAM,YAAA,GAAeC,kCAAgB,GAAG,CAAA;AACxC,IAAA,MAAM,iBAAA,GAAoB,CAAC,CAAC,SAAA;AAE5B,IAAA,MAAM,gBAAA,GAAmBC,0BAAoB,GAAG,CAAA;AAChD,IAAA,MAAM,kBAAA,GAAqBC,2BAAA,CAAsB,GAAA,EAAK,gBAAgB,CAAA;AAEtE,IAAA,OAAA,CAAQ,kBAAkB,kBAAkB,CAAA;AAE5C,IAAA,MAAM,QAAA,GAAWC,sBAAA,CAAiB,gBAAA,EAAkB,KAAA,EAAO,SAAS,CAAA;AACpE,IAAA,MAAM,IAAA,GAAO,QAAA,CAAS,UAAA,CAAWC,uBAAiB,CAAA;AAClD,IAAA,MAAM,IAAA,GAAO,QAAA,CAAS,UAAA,CAAWC,uBAAiB,CAAA;AAClD,IAAA,MAAM,UAAA,GAA6B,MAAA,CAAO,MAAA,CAAO,QAAA,CAAS,UAAA,EAAY;AAAA,MACpE,CAACC,mDAAgC,GAAG,mBAAA;AAAA,MACpC,CAACC,+CAA4B,GAAG,CAAA,EAAG,IAAI,CAAA,QAAA;AAAA,KACxC,CAAA;AACD,IAAA,IAAI,kBAAA,EAAoB;AACtB,MAAA,UAAA,CAAWC,qBAAe,CAAA,GAAI,kBAAA;AAAA,IAChC;AAGA,IAAA,IAAIC,qBAAe,QAAA,CAAS,UAAA,CAAWL,uBAAiB,CAAA,EAAG,IAAA,EAAM,OAAO,CAAA,EAAG;AAOzE,MAAA,IAAI,iBAAA,EAAmB;AACrB,QAAA,YAAA,CAAa,GAAA,EAAI;AAAA,MACnB;AACA,MAAA,OAAO,mBAAA,CAAoB,MAAM,IAAA,EAAM,CAAC,KAAK,GAAA,EAAK,GAAG,SAAS,CAAC,CAAA;AAAA,IACjE;AAEA,IAAA,MAAM,eAAeM,+BAAA,EAAkB;AACvC,IAAA,IAAI,YAAA,KAAiBC,wCAAyB,EAAG;AAC/C,MAAA,IAAI,SAAS,iBAAA,EAAmB;AAE9B,QAAA,MAAM,SAAS,GAAA,CAAI,MAAA,GAAS,GAAA,CAAI,MAAA,CAAO,aAAY,GAAI,KAAA;AACvD,QAAA,YAAA,CAAa,kBAAA,CAAmB,CAAA,EAAG,MAAM,CAAA,CAAA,EAAI,gBAAgB,CAAA,CAAE,CAAA;AAAA,MACjE;AAAA,IACF,CAAA,MAAO;AACL,MAAAC,sBAAA,IAAeC,iBAAA,CAAM,KAAK,qFAAqF,CAAA;AAAA,IACjH;AAEA,IAAA,OAAOC,qBAAA,CAAgB,EAAE,IAAA,EAAM,UAAA,IAAc,CAAA,IAAA,KAAQ;AACnD,MAAA,IAAI,YAAA,GAAe,KAAA;AAGnB,MAAA,IAAI,QAAA,CAAS,UAAA,CAAWT,uBAAiB,CAAA,KAAMU,6BAAA,EAAyB;AACtE,QAAA,IAAA,CAAK,GAAA,EAAI;AACT,QAAA,YAAA,GAAe,IAAA;AAAA,MACjB;AAEA,MAAA,MAAM,mBAAmB,MAAM;AAC7B,QAAA,IAAI,CAAC,YAAA,EAAc;AACjB,UAAA,YAAA,GAAe,IAAA;AACf,UAAA,IAAA,CAAK,GAAA,EAAI;AAAA,QACX;AAAA,MACF,CAAA;AAGA,MAAA,KAAA,IAAS,CAAA,GAAI,CAAA,EAAG,CAAA,GAAI,SAAA,CAAU,QAAQ,CAAA,EAAA,EAAK;AACzC,QAAA,MAAM,QAAA,GAAW,UAAU,CAAC,CAAA;AAC5B,QAAA,IAAI,OAAO,aAAa,UAAA,EAAY;AAClC,UAAA;AAAA,QACF;AAGA,QAAA,SAAA,CAAU,CAAC,CAAA,GAAI,SAAA,GAAa,IAAA,EAAa;AAGvC,UAAA,MAAM,UAAA,GAAa,KAAK,CAAC,CAAA;AACzB,UAAA,MAAM,UAAU,CAAC,CAAC,UAAA,IAAc,UAAA,KAAe,WAAW,UAAA,KAAe,QAAA;AACzE,UAAA,IAAI,CAAC,gBAAgB,OAAA,EAAS;AAC5B,YAAA,MAAM,CAAC,CAAA,EAAG,OAAO,CAAA,GAAIC,wBAAkB,UAAU,CAAA;AAMjD,YAAA,IAAA,CAAK,SAAA,CAAU;AAAA,cACb,IAAA,EAAMC,4BAAA;AAAA,cACN;AAAA,aACD,CAAA;AAAA,UACH;AAEA,UAAA,IAAI,CAAC,YAAA,EAAc;AACjB,YAAA,YAAA,GAAe,IAAA;AACf,YAAA,GAAA,CAAI,cAAA,CAAe,UAAU,gBAAgB,CAAA;AAC7C,YAAA,IAAA,CAAK,GAAA,EAAI;AAAA,UACX;AACA,UAAA,IAAI,EAAE,GAAA,CAAI,KAAA,IAAS,OAAA,CAAA,IAAY,iBAAA,EAAmB;AAChD,YAAA,YAAA,CAAa,GAAA,EAAI;AAAA,UACnB;AAGA,UAAA,OAAOC,qBAAe,UAAA,EAAY,MAAM,SAAS,KAAA,CAAM,IAAA,EAAM,IAAI,CAAC,CAAA;AAAA,QACpE,CAAA;AACA,QAAA;AAAA,MACF;AAEA,MAAA,IAAI;AACF,QAAA,OAAO,mBAAA,CAAoB,MAAM,IAAA,EAAM,CAAC,KAAK,GAAA,EAAK,GAAG,SAAS,CAAC,CAAA;AAAA,MACjE,SAAS,QAAA,EAAU;AACjB,QAAA,MAAM,CAAC,CAAA,EAAG,OAAO,CAAA,GAAIF,wBAAkB,QAAQ,CAAA;AAM/C,QAAA,IAAA,CAAK,SAAA,CAAU;AAAA,UACb,IAAA,EAAMC,4BAAA;AAAA,UACN;AAAA,SACD,CAAA;AACD,QAAA,MAAM,QAAA;AAAA,MAER,CAAA,SAAE;AAMA,QAAA,IAAI,CAAC,YAAA,EAAc;AACjB,UAAA,GAAA,CAAI,IAAA,CAAK,UAAU,gBAAgB,CAAA;AAAA,QACrC;AAAA,MACF;AAAA,IACF,CAAC,CAAA;AAAA,EACH;AASA,EAAA,KAAA,MAAW,OAAO,mBAAA,EAA2D;AAE3E,IAAA,IAAI,OAAO,kBAAA,EAAoB;AAC7B,MAAA;AAAA,IACF;AACA,IAAA,MAAA,CAAO,cAAA,CAAe,oBAAoB,GAAA,EAAK;AAAA,MAC7C,GAAA,GAAM;AACJ,QAAA,OAAO,oBAAoB,GAAG,CAAA;AAAA,MAChC,CAAA;AAAA,MACA,IAAI,KAAA,EAAO;AACT,QAAA,mBAAA,CAAoB,GAAG,CAAA,GAAI,KAAA;AAAA,MAC7B;AAAA,KACD,CAAA;AAAA,EACH;AAEA,EAAAE,0BAAA,CAAoB,oBAAoB,mBAAmB,CAAA;AAE3D,EAAA,MAAA,CAAO,cAAA,CAAe,OAAO,QAAA,EAAU;AAAA,IACrC,UAAA,EAAY,IAAA;AAAA,IACZ,YAAA,EAAc,IAAA;AAAA,IACd,QAAA,EAAU,IAAA;AAAA,IACV,KAAA,EAAO;AAAA,GACR,CAAA;AACH;;;;"}