@sentry/core 10.47.0 → 10.49.0

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

@@ -0,0 +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  ExpressExport,\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  hasDefaultProp,\n  isExpressWithoutRouterPrototype,\n  isExpressWithRouterPrototype,\n} from './utils';\nimport { wrapMethod } from '../../utils/object';\nimport { patchLayer } from './patch-layer';\nimport { setSDKProcessingMetadata } from './set-sdk-processing-metadata';\n\nconst getExpressExport = (express: ExpressModuleExport): ExpressExport =>\n  hasDefaultProp(express) ? express.default : (express as ExpressExport);\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 = getExpressExport(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":[],"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;;;AAgCA,MAAM,gBAAA,GAAmB,CAAC,OAAO;AACjC,EAAE,cAAc,CAAC,OAAO,CAAA,GAAI,OAAO,CAAC,OAAA,IAAW,OAAA,EAAyB;;AAExE,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,IAAI,WAAA;AACJ,MAAM,KAAK,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,GAAU,gBAAgB,CAAC,aAAa,CAAC;AACjD,EAAE,MAAM,WAAW,GAAkD,4BAA4B,CAAC,OAAO;AACzG,MAAM,OAAO,CAAC,MAAM,CAAC,SAAA;AACrB,MAAM,+BAA+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,IAAI,UAAU;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,QAAQ,UAAU,CAAC,UAAU,EAAE,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;AACzD,QAAQ,OAAO,KAAK;AACpB,MAAM,CAAC;AACP,KAAK;AACL,EAAE,CAAA,CAAE,OAAO,CAAC,EAAE;AACd,IAAI,WAAA,IAAe,KAAK,CAAC,KAAK,CAAC,uCAAuC,EAAE,CAAC,CAAC;AAC1E,EAAE;;AAEF;AACA,EAAE,MAAM,iBAAA,GAAoB,WAAW,CAAC,GAAG;AAC3C,EAAE,IAAI;AACN,IAAI,UAAU;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,QAAQ,UAAU,CAAC,UAAU,EAAE,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;AACzD,QAAQ,OAAO,KAAK;AACpB,MAAM,CAAC;AACP,KAAK;AACL,EAAE,CAAA,CAAE,OAAO,CAAC,EAAE;AACd,IAAI,WAAA,IAAe,KAAK,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,IAAI,UAAU;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,GAAS,4BAA4B,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,YAAY,UAAU,CAAC,UAAU,EAAE,KAAK,EAAE,YAAY,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,IAAI,WAAA,IAAe,KAAK,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,IAAI,wBAAwB,CAAC,OAAO,CAAC;AACrC,IAAI,MAAM,iBAAA,GAAoB,OAAO,EAAE,iBAAA,IAAqB,wBAAwB;;AAEpF,IAAI,IAAI,iBAAiB,CAAC,KAAK,CAAC,EAAE;AAClC,MAAM,MAAM,OAAA,GAAU,gBAAgB,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,IAAI,wBAAwB,CAAC,OAAO,CAAC;AACrC,IAAI,IAAI,EAAE;AACV,EAAE,CAAC;AACH;;;;"}

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

@@ -0,0 +1,255 @@
+import { DEBUG_BUILD } from '../../debug-build.js';
+import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '../../semanticAttributes.js';
+import { debug } from '../../utils/debug-logger.js';
+import { getActiveSpan } from '../../utils/spanUtils.js';
+import { SPAN_STATUS_ERROR } from '../../tracing/spanstatus.js';
+import { getOriginalFunction, markFunctionWrapped } from '../../utils/object.js';
+import { getIsolationScope } from '../../currentScopes.js';
+import { startSpanManual, withActiveSpan } from '../../tracing/trace.js';
+import { storeLayer, getStoredLayers } from './request-layer-store.js';
+import { ATTR_EXPRESS_NAME, ATTR_EXPRESS_TYPE, ATTR_HTTP_ROUTE, ExpressLayerType_ROUTER } from './types.js';
+import { getConstructedRoute, getActualMatchedRoute, getLayerMetadata, isLayerIgnored, asErrorAndMessage } from './utils.js';
+import { getDefaultIsolationScope } from '../../defaultScopes.js';
+import { setSDKProcessingMetadata } from './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,
+) {
+  if (!maybeLayer?.handle) {
+    return;
+  }
+  const layer = maybeLayer;
+
+  const layerHandleOriginal = layer.handle;
+
+  // avoid patching multiple times the same layer
+  if (getOriginalFunction(layerHandleOriginal)) {
+    return;
+  }
+
+  if (layerHandleOriginal.length === 4) {
+    // todo: instrument error handlers
+    return;
+  }
+
+  function layerHandlePatched(
+
+    req,
+    res,
+    //oxlint-disable-next-line no-explicit-any
+    ...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(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 = getActiveSpan();
+    if (!parentSpan) {
+      return layerHandleOriginal.apply(this, [req, res, ...otherArgs]);
+    }
+
+    if (layerPath) {
+      storeLayer(req, layerPath);
+    }
+    const storedLayers = getStoredLayers(req);
+    const isLayerPathStored = !!layerPath;
+
+    const constructedRoute = getConstructedRoute(req);
+    const actualMatchedRoute = getActualMatchedRoute(req, constructedRoute);
+
+    options.onRouteResolved?.(actualMatchedRoute);
+
+    const metadata = getLayerMetadata(constructedRoute, layer, layerPath);
+    const name = metadata.attributes[ATTR_EXPRESS_NAME];
+    const type = metadata.attributes[ATTR_EXPRESS_TYPE];
+    const attributes = Object.assign(metadata.attributes, {
+      [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.express',
+      [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.express`,
+    });
+    if (actualMatchedRoute) {
+      attributes[ATTR_HTTP_ROUTE] = actualMatchedRoute;
+    }
+
+    // verify against the config if the layer should be ignored
+    if (isLayerIgnored(metadata.attributes[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 = getIsolationScope();
+    if (currentScope !== getDefaultIsolationScope()) {
+      if (type === 'request_handler') {
+        // type cast b/c Otel unfortunately types info.request as any :(
+        const method = req.method ? req.method.toUpperCase() : 'GET';
+        currentScope.setTransactionName(`${method} ${constructedRoute}`);
+      }
+    } else {
+      DEBUG_BUILD && debug.warn('Isolation scope is still default isolation scope - skipping setting transactionName');
+    }
+
+    return 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[ATTR_EXPRESS_TYPE] === 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') {
+          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
+          const maybeError = args[0];
+          const isError = !!maybeError && maybeError !== 'route' && maybeError !== 'router';
+          if (!spanHasEnded && isError) {
+            const [_, message] = 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: SPAN_STATUS_ERROR,
+              message,
+            });
+          }
+
+          if (!spanHasEnded) {
+            spanHasEnded = true;
+            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 withActiveSpan(parentSpan, () => callback.apply(this, args));
+        };
+        break;
+      }
+
+      try {
+        return layerHandleOriginal.apply(this, [req, res, ...otherArgs]);
+      } catch (anyError) {
+        const [_, message] = 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: SPAN_STATUS_ERROR,
+          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);
+        }
+      }
+    });
+  }
+
+  // `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
+    if (key in layerHandlePatched) {
+      continue;
+    }
+    Object.defineProperty(layerHandlePatched, key, {
+      get() {
+        return layerHandleOriginal[key];
+      },
+      set(value) {
+        layerHandleOriginal[key] = value;
+      },
+    });
+  }
+
+  markFunctionWrapped(layerHandlePatched, layerHandleOriginal);
+
+  Object.defineProperty(layer, 'handle', {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: layerHandlePatched,
+  });
+}
+
+export { patchLayer };
+//# sourceMappingURL=patch-layer.js.map

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

@@ -0,0 +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":[],"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,IAAI,mBAAmB,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,IAAI,wBAAwB,CAAC,GAAG,CAAC;;AAEjC;AACA;AACA,IAAI,MAAM,UAAA,GAAa,aAAa,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,MAAM,UAAU,CAAC,GAAG,EAAE,SAAS,CAAC;AAChC,IAAI;AACJ,IAAI,MAAM,YAAA,GAAe,eAAe,CAAC,GAAG,CAAC;AAC7C,IAAI,MAAM,iBAAA,GAAoB,CAAC,CAAC,SAAS;;AAEzC,IAAI,MAAM,gBAAA,GAAmB,mBAAmB,CAAC,GAAG,CAAC;AACrD,IAAI,MAAM,qBAAqB,qBAAqB,CAAC,GAAG,EAAE,gBAAgB,CAAC;;AAE3E,IAAI,OAAO,CAAC,eAAe,GAAG,kBAAkB,CAAC;;AAEjD,IAAI,MAAM,QAAA,GAAW,gBAAgB,CAAC,gBAAgB,EAAE,KAAK,EAAE,SAAS,CAAC;AACzE,IAAI,MAAM,OAAO,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC;AACvD,IAAI,MAAM,OAAO,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC;AACvD,IAAI,MAAM,UAAU,GAAmB,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE;AAC1E,MAAM,CAAC,gCAAgC,GAAG,mBAAmB;AAC7D,MAAM,CAAC,4BAA4B,GAAG,CAAC,EAAA,IAAA,CAAA,QAAA,CAAA;AACA,KAAA,CAAA;AACA,IAAA,IAAA,kBAAA,EAAA;AACA,MAAA,UAAA,CAAA,eAAA,CAAA,GAAA,kBAAA;AACA,IAAA;;AAEA;AACA,IAAA,IAAA,cAAA,CAAA,QAAA,CAAA,UAAA,CAAA,iBAAA,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,GAAA,iBAAA,EAAA;AACA,IAAA,IAAA,YAAA,KAAA,wBAAA,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,MAAA,WAAA,IAAA,KAAA,CAAA,IAAA,CAAA,qFAAA,CAAA;AACA,IAAA;;AAEA,IAAA,OAAA,eAAA,CAAA,EAAA,IAAA,EAAA,UAAA,EAAA,EAAA,IAAA,IAAA;AACA,MAAA,IAAA,YAAA,GAAA,KAAA;AACA;AACA;AACA,MAAA,IAAA,QAAA,CAAA,UAAA,CAAA,iBAAA,CAAA,KAAA,uBAAA,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,GAAA,iBAAA,CAAA,UAAA,CAAA;AACA;AACA;AACA;AACA;AACA;AACA,YAAA,IAAA,CAAA,SAAA,CAAA;AACA,cAAA,IAAA,EAAA,iBAAA;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,OAAA,cAAA,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,GAAA,iBAAA,CAAA,QAAA,CAAA;AACA;AACA;AACA;AACA;AACA;AACA,QAAA,IAAA,CAAA,SAAA,CAAA;AACA,UAAA,IAAA,EAAA,iBAAA;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,EAAA,mBAAA,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;;;;"}

package/build/esm/integrations/express/request-layer-store.js

@@ -0,0 +1,22 @@
+// map of patched request objects to stored layers
+const requestLayerStore = new WeakMap();
+const storeLayer = (req, layer) => {
+  const store = requestLayerStore.get(req);
+  if (!store) {
+    requestLayerStore.set(req, [layer]);
+  } else {
+    store.push(layer);
+  }
+};
+
+const getStoredLayers = (req) => {
+  let store = requestLayerStore.get(req);
+  if (!store) {
+    store = [];
+    requestLayerStore.set(req, store);
+  }
+  return store;
+};
+
+export { getStoredLayers, storeLayer };
+//# sourceMappingURL=request-layer-store.js.map

package/build/esm/integrations/express/request-layer-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-layer-store.js","sources":["../../../../src/integrations/express/request-layer-store.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 type { ExpressRequest } from './types';\n\n// map of patched request objects to stored layers\nconst requestLayerStore = new WeakMap<ExpressRequest, string[]>();\nexport const storeLayer = (req: ExpressRequest, layer: string) => {\n  const store = requestLayerStore.get(req);\n  if (!store) {\n    requestLayerStore.set(req, [layer]);\n  } else {\n    store.push(layer);\n  }\n};\n\nexport const getStoredLayers = (req: ExpressRequest) => {\n  let store = requestLayerStore.get(req);\n  if (!store) {\n    store = [];\n    requestLayerStore.set(req, store);\n  }\n  return store;\n};\n"],"names":[],"mappings":"AA+BA;AACA,MAAM,iBAAA,GAAoB,IAAI,OAAO,EAA4B;AAC1D,MAAM,aAAa,CAAC,GAAG,EAAkB,KAAK,KAAa;AAClE,EAAE,MAAM,QAAQ,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC;AAC1C,EAAE,IAAI,CAAC,KAAK,EAAE;AACd,IAAI,iBAAiB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;AACvC,EAAE,OAAO;AACT,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;AACrB,EAAE;AACF;;MAEa,eAAA,GAAkB,CAAC,GAAG,KAAqB;AACxD,EAAE,IAAI,QAAQ,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC;AACxC,EAAE,IAAI,CAAC,KAAK,EAAE;AACd,IAAI,KAAA,GAAQ,EAAE;AACd,IAAI,iBAAiB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC;AACrC,EAAE;AACF,EAAE,OAAO,KAAK;AACd;;;;"}

package/build/esm/integrations/express/set-sdk-processing-metadata.js

@@ -0,0 +1,15 @@
+import { getIsolationScope } from '../../currentScopes.js';
+import { httpRequestToRequestData } from '../../utils/request.js';
+
+// TODO: consider moving this into a core util, eg
+// setSDKProcessingMetadataFromRequest(..), if other integrations need it.
+function setSDKProcessingMetadata(request) {
+  const sdkProcMeta = getIsolationScope()?.getScopeData()?.sdkProcessingMetadata;
+  if (!sdkProcMeta?.normalizedRequest) {
+    const normalizedRequest = httpRequestToRequestData(request);
+    getIsolationScope().setSDKProcessingMetadata({ normalizedRequest });
+  }
+}
+
+export { setSDKProcessingMetadata };
+//# sourceMappingURL=set-sdk-processing-metadata.js.map

package/build/esm/integrations/express/set-sdk-processing-metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"set-sdk-processing-metadata.js","sources":["../../../../src/integrations/express/set-sdk-processing-metadata.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\n/**\n * Abstract this out because we call it in multiple places, and it's cheaper to\n * only do one time for any given request.\n */\n\nimport type { ExpressRequest } from './types';\nimport { getIsolationScope } from '../../currentScopes';\nimport { httpRequestToRequestData } from '../../utils/request';\n\n// TODO: consider moving this into a core util, eg\n// setSDKProcessingMetadataFromRequest(..), if other integrations need it.\nexport function setSDKProcessingMetadata(request: ExpressRequest) {\n  const sdkProcMeta = getIsolationScope()?.getScopeData()?.sdkProcessingMetadata;\n  if (!sdkProcMeta?.normalizedRequest) {\n    const normalizedRequest = httpRequestToRequestData(request);\n    getIsolationScope().setSDKProcessingMetadata({ normalizedRequest });\n  }\n}\n"],"names":[],"mappings":";;;AAsCA;AACA;AACO,SAAS,wBAAwB,CAAC,OAAO,EAAkB;AAClE,EAAE,MAAM,WAAA,GAAc,iBAAiB,EAAE,EAAE,YAAY,EAAE,EAAE,qBAAqB;AAChF,EAAE,IAAI,CAAC,WAAW,EAAE,iBAAiB,EAAE;AACvC,IAAI,MAAM,iBAAA,GAAoB,wBAAwB,CAAC,OAAO,CAAC;AAC/D,IAAI,iBAAiB,EAAE,CAAC,wBAAwB,CAAC,EAAE,iBAAA,EAAmB,CAAC;AACvE,EAAE;AACF;;;;"}

package/build/esm/integrations/express/types.js

@@ -0,0 +1,10 @@
+const ATTR_EXPRESS_NAME = 'express.name';
+const ATTR_HTTP_ROUTE = 'http.route';
+const ATTR_EXPRESS_TYPE = 'express.type';
+
+const ExpressLayerType_ROUTER = 'router';
+const ExpressLayerType_MIDDLEWARE = 'middleware';
+const ExpressLayerType_REQUEST_HANDLER = 'request_handler';
+
+export { ATTR_EXPRESS_NAME, ATTR_EXPRESS_TYPE, ATTR_HTTP_ROUTE, ExpressLayerType_MIDDLEWARE, ExpressLayerType_REQUEST_HANDLER, ExpressLayerType_ROUTER };
+//# sourceMappingURL=types.js.map

package/build/esm/integrations/express/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sources":["../../../../src/integrations/express/types.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 type { RequestEventData } from '../../types-hoist/request';\nimport type { SpanAttributes } from '../../types-hoist/span';\n\nexport const ATTR_EXPRESS_NAME = 'express.name';\nexport const ATTR_HTTP_ROUTE = 'http.route';\nexport const ATTR_EXPRESS_TYPE = 'express.type';\n\nexport type ExpressExport = {\n  Router: ExpressRouterv5 | ExpressRouterv4;\n  application: ExpressApplication;\n};\n\nexport type ExpressExportv5 = ExpressExport & {\n  Router: ExpressRouterv5;\n};\n\nexport type ExpressExportv4 = ExpressExport & {\n  Router: ExpressRouterv4;\n};\n\nexport type ExpressModuleExport = ExpressExport | { default: ExpressExport };\n\nexport interface ExpressRequest extends RequestEventData {\n  originalUrl: string;\n  route: unknown;\n  // Note: req.res is typed as optional (only present after middleware init).\n  // mark optional to preserve compat with express v4 types.\n  res?: ExpressResponse;\n}\n\n// just a minimum type def for what we need, since this also needs to\n// work in environments lacking node:http\nexport interface ExpressResponse {\n  once(ev: string, listener: Function): this;\n  removeListener(ev: string, listener?: Function): this;\n  emit(ev: string, ...data: unknown[]): this;\n}\n\nexport interface NextFunction {\n  (err?: unknown): void;\n  /**\n   * \"Break-out\" of a router by calling {next('router')};\n   * @see {https://expressjs.com/en/guide/using-middleware.html#middleware.router}\n   */\n  (deferToNext: 'router'): void;\n  /**\n   * \"Break-out\" of a route by calling {next('route')};\n   * @see {https://expressjs.com/en/guide/using-middleware.html#middleware.application}\n   */\n  (deferToNext: 'route'): void;\n}\n\n// Need to mark this as `any` so they don't conflict with the actual express\n//oxlint-disable-next-line no-explicit-any\nexport type ExpressApplicationRequestHandler = (...handlers: any[]) => any;\n\nexport type ExpressRequestInfo<T = unknown> = {\n  /** An express request object */\n  request: T;\n  route: string;\n  layerType: ExpressLayerType;\n};\n\nexport type ExpressLayerType = 'router' | 'middleware' | 'request_handler';\nexport const ExpressLayerType_ROUTER = 'router';\nexport const ExpressLayerType_MIDDLEWARE = 'middleware';\nexport const ExpressLayerType_REQUEST_HANDLER = 'request_handler';\n\nexport type PathParams = string | RegExp | Array<string | RegExp>;\nexport type LayerPathSegment = string | RegExp | number;\n\nexport interface ExpressRoute {\n  path: string;\n  stack: ExpressLayer[];\n}\n\nexport type ExpressRouterv4 = ExpressRouter;\n\nexport interface ExpressRouterv5 {\n  prototype: ExpressRouter;\n}\n\n// https://github.com/expressjs/express/blob/main/lib/router/layer.js#L33\nexport type ExpressLayer = {\n  handle: Function &\n    Record<string, unknown> & {\n      stack?: ExpressLayer[];\n    };\n  name: string;\n  params: { [key: string]: string };\n  path?: string;\n  regexp: RegExp;\n  route?: ExpressLayer;\n};\n\nexport type ExpressRouter = {\n  params: { [key: string]: string };\n  _params: string[];\n  caseSensitive: boolean;\n  mergeParams: boolean;\n  strict: boolean;\n  stack: ExpressLayer[];\n  route(prefix: PathParams): ExpressRoute;\n  use(...handlers: unknown[]): unknown;\n};\n\nexport type IgnoreMatcher = string | RegExp | ((name: string) => boolean);\n\nexport type ExpressIntegrationOptions = {\n  /**\n   * @deprecated Pass the express module as the first argument, and an\n   * options getter as the second argument to patchExpressModule.\n   */\n  express?: ExpressModuleExport;\n\n  /** Ignore specific based on their name */\n  ignoreLayers?: IgnoreMatcher[];\n  /** Ignore specific layers based on their type */\n  ignoreLayersType?: ExpressLayerType[];\n  /**\n   * Optional callback invoked each time a layer resolves the matched HTTP route.\n   * Platform-specific integrations (e.g. Node.js) use this to propagate the\n   * resolved route to the underlying transport layer (e.g. OTel RPCMetadata).\n   */\n  onRouteResolved?: (route: string | undefined) => void;\n};\n\nexport type LayerMetadata = {\n  attributes: SpanAttributes;\n  name: string;\n};\n\nexport interface ExpressApplication {\n  stack: ExpressLayer[];\n  use: ExpressApplicationRequestHandler;\n}\n\nexport interface MiddlewareError extends Error {\n  status?: number | string;\n  statusCode?: number | string;\n  status_code?: number | string;\n  output?: {\n    statusCode?: number | string;\n  };\n}\n\nexport type ExpressMiddleware = (req: ExpressRequest, res: ExpressResponse, next: () => void) => void;\n\nexport type ExpressErrorMiddleware = (\n  error: MiddlewareError,\n  req: ExpressRequest,\n  res: ExpressResponse,\n  next: (error: MiddlewareError) => void,\n) => void;\n\nexport interface ExpressHandlerOptions {\n  /**\n   * Callback method deciding whether error should be captured and sent to Sentry\n   * @param error Captured middleware error\n   */\n  shouldHandleError?(this: void, error: MiddlewareError): boolean;\n}\n"],"names":[],"mappings":"AAgCO,MAAM,iBAAA,GAAoB;AAC1B,MAAM,eAAA,GAAkB;AACxB,MAAM,iBAAA,GAAoB;;AA2D1B,MAAM,uBAAA,GAA0B;AAChC,MAAM,2BAAA,GAA8B;AACpC,MAAM,gCAAA,GAAmC;;;;"}

package/build/esm/integrations/express/utils.js

@@ -0,0 +1,225 @@
+import { getStoredLayers } from './request-layer-store.js';
+import { ExpressLayerType_ROUTER, ATTR_EXPRESS_TYPE, ATTR_EXPRESS_NAME, ExpressLayerType_REQUEST_HANDLER, ExpressLayerType_MIDDLEWARE } from './types.js';
+import { stringMatchesSomePattern } from '../../utils/string.js';
+
+/**
+ * Converts a user-provided error value into an error and error message pair
+ *
+ * @param error - User-provided error value
+ * @returns Both an Error or string representation of the value and an error message
+ */
+const asErrorAndMessage = (error) =>
+  error instanceof Error ? [error, error.message] : [String(error), String(error)];
+
+/**
+ * Checks if a route contains parameter patterns (e.g., :id, :userId)
+ * which are valid even if they don't exactly match the original URL
+ */
+function isRoutePattern(route) {
+  return route.includes(':') || route.includes('*');
+}
+
+/**
+ * Parse express layer context to retrieve a name and attributes.
+ * @param route The route of the layer
+ * @param layer Express layer
+ * @param [layerPath] if present, the path on which the layer has been mounted
+ */
+const getLayerMetadata = (
+  route,
+  layer,
+  layerPath,
+
+) => {
+  if (layer.name === 'router') {
+    const maybeRouterPath = getRouterPath('', layer);
+    const extractedRouterPath = maybeRouterPath ? maybeRouterPath : layerPath || route || '/';
+
+    return {
+      attributes: {
+        [ATTR_EXPRESS_NAME]: extractedRouterPath,
+        [ATTR_EXPRESS_TYPE]: ExpressLayerType_ROUTER,
+      },
+      name: `router - ${extractedRouterPath}`,
+    };
+  } else if (layer.name === 'bound dispatch' || layer.name === 'handle') {
+    return {
+      attributes: {
+        [ATTR_EXPRESS_NAME]: (route || layerPath) ?? 'request handler',
+        [ATTR_EXPRESS_TYPE]: ExpressLayerType_REQUEST_HANDLER,
+      },
+      name: `request handler${layer.path ? ` - ${route || layerPath}` : ''}`,
+    };
+  } else {
+    return {
+      attributes: {
+        [ATTR_EXPRESS_NAME]: layer.name,
+        [ATTR_EXPRESS_TYPE]: ExpressLayerType_MIDDLEWARE,
+      },
+      name: `middleware - ${layer.name}`,
+    };
+  }
+};
+
+/**
+ * Recursively search the router path from layer stack
+ * @param path The path to reconstruct
+ * @param layer The layer to reconstruct from
+ * @returns The reconstructed path
+ */
+const getRouterPath = (path, layer) => {
+  const stackLayer = Array.isArray(layer.handle?.stack) ? layer.handle?.stack?.[0] : undefined;
+
+  if (stackLayer?.route?.path) {
+    return `${path}${stackLayer.route.path}`;
+  }
+
+  if (stackLayer && Array.isArray(stackLayer?.handle?.stack)) {
+    return getRouterPath(path, stackLayer);
+  }
+
+  return path;
+};
+
+/**
+ * Check whether the given request is ignored by configuration
+ * It will not re-throw exceptions from `list` provided by the client
+ * @param constant e.g URL of request
+ * @param [list] List of ignore patterns
+ * @param [onException] callback for doing something when an exception has
+ *     occurred
+ */
+
+const isLayerIgnored = (
+  name,
+  type,
+  config,
+) => {
+  if (Array.isArray(config?.ignoreLayersType) && config?.ignoreLayersType?.includes(type)) {
+    return true;
+  }
+  if (!Array.isArray(config?.ignoreLayers)) {
+    return false;
+  }
+  try {
+    return stringMatchesSomePattern(name, config.ignoreLayers, true);
+  } catch {}
+
+  return false;
+};
+
+/**
+ * Extracts the actual matched route from Express request for OpenTelemetry instrumentation.
+ * Returns the route that should be used as the http.route attribute.
+ *
+ * @param req - The Express request object with layers store
+ * @param constructedRoute - The constructed route from `getConstructedRoute`
+ * @returns The matched route string or undefined if no valid route is found
+ */
+function getActualMatchedRoute(req, constructedRoute) {
+  const layersStore = getStoredLayers(req);
+
+  // If no layers are stored, no route can be determined
+  if (layersStore.length === 0) {
+    return undefined;
+  }
+
+  // Handle root path case - if all paths are root, only return root if originalUrl is also root
+  // The layer store also includes root paths in case a non-existing url was requested
+  if (layersStore.every(path => path === '/')) {
+    return req.originalUrl === '/' ? '/' : undefined;
+  }
+
+  if (constructedRoute === '*') {
+    return constructedRoute;
+  }
+
+  // For RegExp routes or route arrays, return the constructed route
+  // This handles the case where the route is defined using RegExp or an array
+  if (
+    constructedRoute.includes('/') &&
+    (constructedRoute.includes(',') ||
+      constructedRoute.includes('\\') ||
+      constructedRoute.includes('*') ||
+      constructedRoute.includes('['))
+  ) {
+    return constructedRoute;
+  }
+
+  // Ensure route starts with '/' if it doesn't already
+  const normalizedRoute = constructedRoute.startsWith('/') ? constructedRoute : `/${constructedRoute}`;
+
+  // Validate that this appears to be a matched route
+  // A route is considered matched if:
+  // 1. We have a constructed route
+  // 2. The original URL matches or starts with our route pattern
+  const isValidRoute =
+    normalizedRoute.length > 0 &&
+    (req.originalUrl === normalizedRoute ||
+      req.originalUrl.startsWith(normalizedRoute) ||
+      isRoutePattern(normalizedRoute));
+
+  return isValidRoute ? normalizedRoute : undefined;
+}
+
+function getConstructedRoute(req) {
+  const layersStore = getStoredLayers(req);
+
+  let constructedRoute = '';
+  for (const path of layersStore) {
+    if (path === '/' || path === '/*') {
+      continue;
+    }
+    constructedRoute += !constructedRoute || constructedRoute.endsWith('/') ? path : `/${path}`;
+  }
+
+  return constructedRoute.replace(/\/{2,}/g, '/');
+}
+
+const getLayerPath = (args) => {
+  const firstArg = args[0];
+
+  if (Array.isArray(firstArg)) {
+    return firstArg.map(arg => extractLayerPathSegment(arg) || '').join(',');
+  }
+
+  return extractLayerPathSegment(firstArg );
+};
+
+const extractLayerPathSegment = (arg) =>
+  typeof arg === 'string' ? arg : arg instanceof RegExp || typeof arg === 'number' ? String(arg) : undefined;
+
+// v5 we instrument Router.prototype
+// v4 we instrument Router itself
+const isExpressWithRouterPrototype = (express) =>
+  isExpressRouterPrototype((express )?.Router?.prototype);
+
+// In Express v4, Router is a function (not a plain object), so we need to accept both
+const isExpressRouterPrototype = (routerProto) =>
+  (typeof routerProto === 'object' || typeof routerProto === 'function') &&
+  !!routerProto &&
+  'route' in routerProto &&
+  typeof (routerProto ).route === 'function';
+
+const isExpressWithoutRouterPrototype = (express) =>
+  isExpressRouterPrototype((express ).Router) && !isExpressWithRouterPrototype(express);
+
+// dynamic puts the default on .default, require or normal import are fine
+const hasDefaultProp = (
+  express,
+
+) => !!express && typeof express === 'object' && 'default' in express && typeof express.default === 'function';
+
+function getStatusCodeFromResponse(error) {
+  const statusCode = error.status || error.statusCode || error.status_code || error.output?.statusCode;
+  return statusCode ? parseInt(statusCode , 10) : 500;
+}
+
+/** Returns true if response code is internal server error */
+function defaultShouldHandleError(error) {
+  const status = getStatusCodeFromResponse(error);
+  return status >= 500;
+}
+
+export { asErrorAndMessage, defaultShouldHandleError, getActualMatchedRoute, getConstructedRoute, getLayerMetadata, getLayerPath, getRouterPath, hasDefaultProp, isExpressWithRouterPrototype, isExpressWithoutRouterPrototype, isLayerIgnored, isRoutePattern };
+//# sourceMappingURL=utils.js.map