@prairielearn/sentry 3.0.7 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @prairielearn/sentry
 
+## 4.0.0
+
+### Major Changes
+
+- a7d1ad9: Switch to using `@sentry/node-core`. The consumer must now ensure that OpenTelemetry is configured correctly.
+
+### Patch Changes
+
+- 23adb05: Upgrade all JavaScript dependencies
+
 ## 3.0.7
 
 ### Patch Changes

package/README.md

@@ -1,6 +1,6 @@
 # `@prairielearn/sentry`
 
-Opinionated wrapper around `@sentry/node`. Currently, the only difference is that it exports an async `init` function that automatically sets the release to the current Git revision, if available.
+Opinionated wrapper around `@sentry/core` and `@sentry/node-core`. The main modification is an async `init` function that automatically sets the release to the current Git revision, if available.
 
 ```ts
 import { init } from '@prairielearn/sentry';
@@ -10,3 +10,15 @@ await init({
   environment: 'ENVIRONMENT HERE',
 });
 ```
+
+## Why `@sentry/node-core` instead of `@sentry/node`?
+
+`@sentry/node` ships with automatic OpenTelemetry integration. This has two main downsides for us:
+
+- PrairieLearn applications have their own OpenTelemetry setup, which conflicts with Sentry's desire to control OpenTelemetry. In isolation, this wouldn't be a problem, as they offer configuration options to disable automatic OpenTelemetry setup. However...
+- It pins OpenTelemetry instrumentation packages to specific versions. This makes it hard for us to upgrade OpenTelemetry instrumentation packages independently.
+- It includes a lot of unnecessary OpenTelemetry instrumentation packages that are unused in our codebase.
+
+By using `@sentry/node-core` instead, we retain full control over the OpenTelemetry setup and the versions of OpenTelemetry instrumentation packages we use.
+
+See <https://github.com/getsentry/sentry-javascript/issues/15213> for slightly more historical context.

package/dist/express.d.ts

@@ -0,0 +1,50 @@
+import type * as http from 'node:http';
+interface MiddlewareError extends Error {
+    status?: number | string;
+    statusCode?: number | string;
+    status_code?: number | string;
+    output?: {
+        statusCode?: number | string;
+    };
+}
+type ExpressMiddleware = (req: http.IncomingMessage, res: http.ServerResponse, next: () => void) => void;
+type ExpressErrorMiddleware = (error: MiddlewareError, req: http.IncomingMessage, res: http.ServerResponse, next: (error: MiddlewareError) => void) => void;
+interface ExpressHandlerOptions {
+    /**
+     * Callback method deciding whether error should be captured and sent to Sentry
+     * @param error Captured middleware error
+     */
+    shouldHandleError?(error: MiddlewareError): boolean;
+}
+/**
+ * An Express-compatible error handler.
+ */
+export declare function expressErrorHandler(options?: ExpressHandlerOptions): ExpressErrorMiddleware;
+/**
+ * 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
+ * const Sentry = require('@sentry/node');
+ * const express = require("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);
+ * ```
+ */
+export declare function setupExpressErrorHandler(app: {
+    use: (middleware: ExpressMiddleware | ExpressErrorMiddleware) => unknown;
+}, options?: ExpressHandlerOptions): void;
+export {};

package/dist/express.js

@@ -0,0 +1,77 @@
+// This is a fork of Sentry's Express integration from `@sentry/node`that's not
+// available in the `@sentry/node-core` package`. It has been lightly modified
+// to remove unused code and conform to PrairieLearn's coding style.
+//
+// See this package's `README.md` for more information about why we aren't
+// using `@sentry/node` directly.
+//
+// This was forked from the following file on 2025-07-30:
+// https://github.com/getsentry/sentry-javascript/blob/12ac49a9956fd1b64b3f8ad4b2b8f1da426a1efd/packages/node/src/integrations/tracing/express.ts
+import { captureException, getIsolationScope, httpRequestToRequestData } from '@sentry/core';
+import { ensureIsWrapped } from '@sentry/node-core';
+/**
+ * An Express-compatible error handler.
+ */
+export function expressErrorHandler(options) {
+    return function sentryErrorMiddleware(error, request, res, next) {
+        const normalizedRequest = httpRequestToRequestData(request);
+        // Ensure we use the express-enhanced request here, instead of the plain HTTP one
+        // When an error happens, the `expressRequestHandler` middleware does not run, so we set it here too
+        getIsolationScope().setSDKProcessingMetadata({ normalizedRequest });
+        const shouldHandleError = options?.shouldHandleError || defaultShouldHandleError;
+        if (shouldHandleError(error)) {
+            const eventId = captureException(error, {
+                mechanism: { type: 'middleware', handled: false },
+            });
+            res.sentry = eventId;
+        }
+        next(error);
+    };
+}
+function expressRequestHandler() {
+    return function sentryRequestMiddleware(request, _res, next) {
+        const normalizedRequest = httpRequestToRequestData(request);
+        // Ensure we use the express-enhanced request here, instead of the plain HTTP one
+        getIsolationScope().setSDKProcessingMetadata({ normalizedRequest });
+        next();
+    };
+}
+/**
+ * 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
+ * const Sentry = require('@sentry/node');
+ * const express = require("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);
+ * ```
+ */
+export function setupExpressErrorHandler(app, options) {
+    app.use(expressRequestHandler());
+    app.use(expressErrorHandler(options));
+    ensureIsWrapped(app.use, 'express');
+}
+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;
+}
+//# sourceMappingURL=express.js.map

package/dist/express.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"express.js","sourceRoot":"","sources":["../src/express.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,8EAA8E;AAC9E,oEAAoE;AACpE,EAAE;AACF,0EAA0E;AAC1E,iCAAiC;AACjC,EAAE;AACF,yDAAyD;AACzD,iJAAiJ;AAIjJ,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAC7F,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAgCpD;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAA+B;IACjE,OAAO,SAAS,qBAAqB,CACnC,KAAsB,EACtB,OAA6B,EAC7B,GAAwB,EACxB,IAAsC;QAEtC,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC;QAC5D,iFAAiF;QACjF,oGAAoG;QACpG,iBAAiB,EAAE,CAAC,wBAAwB,CAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAEpE,MAAM,iBAAiB,GAAG,OAAO,EAAE,iBAAiB,IAAI,wBAAwB,CAAC;QAEjF,IAAI,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,EAAE;gBACtC,SAAS,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,EAAE;aAClD,CAAC,CAAC;YACF,GAA2B,CAAC,MAAM,GAAG,OAAO,CAAC;QAChD,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,CAAC;IACd,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB;IAC5B,OAAO,SAAS,uBAAuB,CACrC,OAA6B,EAC7B,IAAyB,EACzB,IAAgB;QAEhB,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC;QAC5D,iFAAiF;QACjF,iBAAiB,EAAE,CAAC,wBAAwB,CAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAEpE,IAAI,EAAE,CAAC;IACT,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,wBAAwB,CACtC,GAAiF,EACjF,OAA+B;IAE/B,GAAG,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACjC,GAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC;IACtC,eAAe,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,yBAAyB,CAAC,KAAsB;IACvD,MAAM,UAAU,GACd,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC;IACpF,OAAO,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAoB,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;AAC/D,CAAC;AAED,6DAA6D;AAC7D,SAAS,wBAAwB,CAAC,KAAsB;IACtD,MAAM,MAAM,GAAG,yBAAyB,CAAC,KAAK,CAAC,CAAC;IAChD,OAAO,MAAM,IAAI,GAAG,CAAC;AACvB,CAAC","sourcesContent":["// This is a fork of Sentry's Express integration from `@sentry/node`that's not\n// available in the `@sentry/node-core` package`. It has been lightly modified\n// to remove unused code and conform to PrairieLearn's coding style.\n//\n// See this package's `README.md` for more information about why we aren't\n// using `@sentry/node` directly.\n//\n// This was forked from the following file on 2025-07-30:\n// https://github.com/getsentry/sentry-javascript/blob/12ac49a9956fd1b64b3f8ad4b2b8f1da426a1efd/packages/node/src/integrations/tracing/express.ts\n\nimport type * as http from 'node:http';\n\nimport { captureException, getIsolationScope, httpRequestToRequestData } from '@sentry/core';\nimport { ensureIsWrapped } from '@sentry/node-core';\n\ninterface 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\ntype ExpressMiddleware = (\n  req: http.IncomingMessage,\n  res: http.ServerResponse,\n  next: () => void,\n) => void;\n\ntype ExpressErrorMiddleware = (\n  error: MiddlewareError,\n  req: http.IncomingMessage,\n  res: http.ServerResponse,\n  next: (error: MiddlewareError) => void,\n) => void;\n\ninterface ExpressHandlerOptions {\n  /**\n   * Callback method deciding whether error should be captured and sent to Sentry\n   * @param error Captured middleware error\n   */\n  shouldHandleError?(error: MiddlewareError): boolean;\n}\n\n/**\n * An Express-compatible error handler.\n */\nexport function expressErrorHandler(options?: ExpressHandlerOptions): ExpressErrorMiddleware {\n  return function sentryErrorMiddleware(\n    error: MiddlewareError,\n    request: http.IncomingMessage,\n    res: http.ServerResponse,\n    next: (error: MiddlewareError) => void,\n  ): void {\n    const normalizedRequest = httpRequestToRequestData(request);\n    // Ensure we use the express-enhanced request here, instead of the plain HTTP one\n    // When an error happens, the `expressRequestHandler` middleware does not run, so we set it here too\n    getIsolationScope().setSDKProcessingMetadata({ normalizedRequest });\n\n    const shouldHandleError = options?.shouldHandleError || defaultShouldHandleError;\n\n    if (shouldHandleError(error)) {\n      const eventId = captureException(error, {\n        mechanism: { type: 'middleware', handled: false },\n      });\n      (res as { sentry?: string }).sentry = eventId;\n    }\n\n    next(error);\n  };\n}\n\nfunction expressRequestHandler(): ExpressMiddleware {\n  return function sentryRequestMiddleware(\n    request: http.IncomingMessage,\n    _res: http.ServerResponse,\n    next: () => void,\n  ): void {\n    const normalizedRequest = httpRequestToRequestData(request);\n    // Ensure we use the express-enhanced request here, instead of the plain HTTP one\n    getIsolationScope().setSDKProcessingMetadata({ normalizedRequest });\n\n    next();\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 * const Sentry = require('@sentry/node');\n * const express = require(\"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: { use: (middleware: ExpressMiddleware | ExpressErrorMiddleware) => unknown },\n  options?: ExpressHandlerOptions,\n): void {\n  app.use(expressRequestHandler());\n  app.use(expressErrorHandler(options));\n  ensureIsWrapped(app.use, 'express');\n}\n\nfunction getStatusCodeFromResponse(error: MiddlewareError): number {\n  const statusCode =\n    error.status || error.statusCode || error.status_code || error.output?.statusCode;\n  return statusCode ? parseInt(statusCode as string, 10) : 500;\n}\n\n/** Returns true if response code is internal server error */\nfunction defaultShouldHandleError(error: MiddlewareError): boolean {\n  const status = getStatusCodeFromResponse(error);\n  return status >= 500;\n}\n"]}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import * as Sentry from '@sentry/node';
+import * as Sentry from '@sentry/node-core';
 /**
  * A thin wrapper around {@link Sentry.init} that automatically sets `release`
  * based on the current Git revision.
@@ -18,5 +18,6 @@ export declare function init(options: Sentry.NodeOptions): Promise<void>;
  * isolate requests and set request data for Sentry.
  */
 export declare function requestHandler(): (req: any, _res: any, next: any) => void;
-export type { Breadcrumb, BreadcrumbHint, Event, EventHint, Exception, NodeOptions, PolymorphicRequest, SdkInfo, Session, SeverityLevel, Span, StackFrame, Stacktrace, Thread, User, } from '@sentry/node';
-export { addBreadcrumb, addEventProcessor, captureEvent, captureException, captureMessage, close, createTransport, defaultStackParser, expressErrorHandler, expressIntegration, flush, getCurrentScope, getSentryRelease, makeNodeTransport, NodeClient, Scope, SDK_VERSION, SentryContextManager, setContext, setExtra, setExtras, setTag, setTags, setupExpressErrorHandler, setUser, startInactiveSpan, startSpan, startSpanManual, withIsolationScope, withScope, } from '@sentry/node';
+export type { Breadcrumb, BreadcrumbHint, Event, EventHint, Exception, NodeOptions, PolymorphicRequest, SdkInfo, Session, SeverityLevel, Span, StackFrame, Stacktrace, Thread, User, } from '@sentry/node-core';
+export { addBreadcrumb, addEventProcessor, captureEvent, captureException, captureMessage, close, createTransport, defaultStackParser, flush, getCurrentScope, getSentryRelease, makeNodeTransport, NodeClient, Scope, SDK_VERSION, SentryContextManager, setContext, setExtra, setExtras, setTag, setTags, setUser, startInactiveSpan, startSpan, startSpanManual, withIsolationScope, withScope, } from '@sentry/node-core';
+export { expressErrorHandler, setupExpressErrorHandler } from './express.js';

package/dist/index.js

@@ -1,5 +1,5 @@
 import { httpRequestToRequestData, stripUrlQueryAndFragment } from '@sentry/core';
-import * as Sentry from '@sentry/node';
+import * as Sentry from '@sentry/node-core';
 import { execa } from 'execa';
 /**
  * A thin wrapper around {@link Sentry.init} that automatically sets `release`
@@ -74,5 +74,6 @@ export function requestHandler() {
         });
     };
 }
-export { addBreadcrumb, addEventProcessor, captureEvent, captureException, captureMessage, close, createTransport, defaultStackParser, expressErrorHandler, expressIntegration, flush, getCurrentScope, getSentryRelease, makeNodeTransport, NodeClient, Scope, SDK_VERSION, SentryContextManager, setContext, setExtra, setExtras, setTag, setTags, setupExpressErrorHandler, setUser, startInactiveSpan, startSpan, startSpanManual, withIsolationScope, withScope, } from '@sentry/node';
+export { addBreadcrumb, addEventProcessor, captureEvent, captureException, captureMessage, close, createTransport, defaultStackParser, flush, getCurrentScope, getSentryRelease, makeNodeTransport, NodeClient, Scope, SDK_VERSION, SentryContextManager, setContext, setExtra, setExtras, setTag, setTags, setUser, startInactiveSpan, startSpan, startSpanManual, withIsolationScope, withScope, } from '@sentry/node-core';
+export { expressErrorHandler, setupExpressErrorHandler } from './express.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAClF,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAE9B;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAA2B;IACpD,IAAI,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAE9B,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,IAAI,CAAC;YACH,OAAO,GAAG,CAAC,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACtE,CAAC;QAAC,MAAM,CAAC;YACP,mEAAmE;YACnE,oCAAoC;QACtC,CAAC;IACH,CAAC;IAED,MAAM,CAAC,IAAI,CAAC;QACV,OAAO;QACP,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAS,kBAAkB,CAAC,GAAQ;IAClC,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;IAC/C,MAAM,IAAI,GAAG,wBAAwB,CAAC,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC;IAExE,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,IAAI,MAAM,EAAE,CAAC;QACX,IAAI,IAAI,MAAM,CAAC;IACjB,CAAC;IACD,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACnB,IAAI,IAAI,GAAG,CAAC;IACd,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,IAAI,IAAI,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,cAAc;IAC5B,OAAO,CAAC,GAAQ,EAAE,IAAS,EAAE,IAAS,EAAE,EAAE;QACxC,MAAM,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,EAAE;YAClC,KAAK,CAAC,iBAAiB,CAAC,CAAC,KAAK,EAAE,EAAE;gBAChC,kEAAkE;gBAClE,kEAAkE;gBAClE,oEAAoE;gBACpE,sBAAsB;gBACtB,IAAI,CAAC;oBACH,KAAK,CAAC,WAAW,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;oBAC5C,KAAK,CAAC,OAAO,GAAG,wBAAwB,CAAC,GAAG,CAAC,CAAC;oBAC9C,OAAO,KAAK,CAAC;gBACf,CAAC;gBAAC,MAAM,CAAC;oBACP,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,IAAI,EAAE,CAAC;QACT,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAuBD,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,KAAK,EACL,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,KAAK,EACL,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,UAAU,EACV,KAAK,EACL,WAAW,EACX,oBAAoB,EACpB,UAAU,EACV,QAAQ,EACR,SAAS,EACT,MAAM,EACN,OAAO,EACP,wBAAwB,EACxB,OAAO,EACP,iBAAiB,EACjB,SAAS,EACT,eAAe,EACf,kBAAkB,EAClB,SAAS,GACV,MAAM,cAAc,CAAC","sourcesContent":["import { httpRequestToRequestData, stripUrlQueryAndFragment } from '@sentry/core';\nimport * as Sentry from '@sentry/node';\nimport { execa } from 'execa';\n\n/**\n * A thin wrapper around {@link Sentry.init} that automatically sets `release`\n * based on the current Git revision.\n */\nexport async function init(options: Sentry.NodeOptions) {\n  let release = options.release;\n\n  if (!release) {\n    try {\n      release = (await execa('git', ['rev-parse', 'HEAD'])).stdout.trim();\n    } catch {\n      // This most likely isn't running in an initialized git repository.\n      // Default to not setting a release.\n    }\n  }\n\n  Sentry.init({\n    release,\n    ...options,\n  });\n}\n\n/**\n * Based on Sentry code that is not exported:\n * https://github.com/getsentry/sentry-javascript/blob/602703652959b581304a7849cb97117f296493bc/packages/utils/src/requestdata.ts#L102\n */\nfunction extractTransaction(req: any) {\n  const method = req.method?.toUpperCase() || '';\n  const path = stripUrlQueryAndFragment(req.originalUrl || req.url || '');\n\n  let name = '';\n  if (method) {\n    name += method;\n  }\n  if (method && path) {\n    name += ' ';\n  }\n  if (path) {\n    name += path;\n  }\n\n  return name;\n}\n\n/**\n * Sentry v8 switched from simple, manual instrumentation to \"automatic\"\n * instrumentation based on OpenTelemetry. However, this interferes with\n * the way that our applications asynchronously load their configuration,\n * specifically the Sentry DSN. Sentry's automatic request isolation and\n * request data extraction requires that `Sentry.init` be called before\n * any other code is loaded, but our application startup structure is such\n * that we import most of our own code before we can load the Sentry DSN.\n *\n * Rather than jumping through hoops to restructure our application to\n * support this, this small function can be added as Express middleware to\n * isolate requests and set request data for Sentry.\n */\nexport function requestHandler() {\n  return (req: any, _res: any, next: any) => {\n    Sentry.withIsolationScope((scope) => {\n      scope.addEventProcessor((event) => {\n        // If an event processor throws an error, Sentry will catch it and\n        // retrigger the event processor, which infinitely recurses. We'll\n        // treat our event processor as a best-effort operation and silently\n        // swallow any errors.\n        try {\n          event.transaction = extractTransaction(req);\n          event.request = httpRequestToRequestData(req);\n          return event;\n        } catch {\n          return event;\n        }\n      });\n\n      next();\n    });\n  };\n}\n\n// We export every type and function from `@sentry/node` *except* for init,\n// which we replace with our own version up above.\n\nexport type {\n  Breadcrumb,\n  BreadcrumbHint,\n  Event,\n  EventHint,\n  Exception,\n  NodeOptions,\n  PolymorphicRequest,\n  SdkInfo,\n  Session,\n  SeverityLevel,\n  Span,\n  StackFrame,\n  Stacktrace,\n  Thread,\n  User,\n} from '@sentry/node';\n\nexport {\n  addBreadcrumb,\n  addEventProcessor,\n  captureEvent,\n  captureException,\n  captureMessage,\n  close,\n  createTransport,\n  defaultStackParser,\n  expressErrorHandler,\n  expressIntegration,\n  flush,\n  getCurrentScope,\n  getSentryRelease,\n  makeNodeTransport,\n  NodeClient,\n  Scope,\n  SDK_VERSION,\n  SentryContextManager,\n  setContext,\n  setExtra,\n  setExtras,\n  setTag,\n  setTags,\n  setupExpressErrorHandler,\n  setUser,\n  startInactiveSpan,\n  startSpan,\n  startSpanManual,\n  withIsolationScope,\n  withScope,\n} from '@sentry/node';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAClF,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAE9B;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAA2B;IACpD,IAAI,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAE9B,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,IAAI,CAAC;YACH,OAAO,GAAG,CAAC,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACtE,CAAC;QAAC,MAAM,CAAC;YACP,mEAAmE;YACnE,oCAAoC;QACtC,CAAC;IACH,CAAC;IAED,MAAM,CAAC,IAAI,CAAC;QACV,OAAO;QACP,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAS,kBAAkB,CAAC,GAAQ;IAClC,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;IAC/C,MAAM,IAAI,GAAG,wBAAwB,CAAC,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC;IAExE,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,IAAI,MAAM,EAAE,CAAC;QACX,IAAI,IAAI,MAAM,CAAC;IACjB,CAAC;IACD,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACnB,IAAI,IAAI,GAAG,CAAC;IACd,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,IAAI,IAAI,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,cAAc;IAC5B,OAAO,CAAC,GAAQ,EAAE,IAAS,EAAE,IAAS,EAAE,EAAE;QACxC,MAAM,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,EAAE;YAClC,KAAK,CAAC,iBAAiB,CAAC,CAAC,KAAK,EAAE,EAAE;gBAChC,kEAAkE;gBAClE,kEAAkE;gBAClE,oEAAoE;gBACpE,sBAAsB;gBACtB,IAAI,CAAC;oBACH,KAAK,CAAC,WAAW,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;oBAC5C,KAAK,CAAC,OAAO,GAAG,wBAAwB,CAAC,GAAG,CAAC,CAAC;oBAC9C,OAAO,KAAK,CAAC;gBACf,CAAC;gBAAC,MAAM,CAAC;oBACP,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,IAAI,EAAE,CAAC;QACT,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAuBD,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,KAAK,EACL,eAAe,EACf,kBAAkB,EAClB,KAAK,EACL,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,UAAU,EACV,KAAK,EACL,WAAW,EACX,oBAAoB,EACpB,UAAU,EACV,QAAQ,EACR,SAAS,EACT,MAAM,EACN,OAAO,EACP,OAAO,EACP,iBAAiB,EACjB,SAAS,EACT,eAAe,EACf,kBAAkB,EAClB,SAAS,GACV,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC","sourcesContent":["import { httpRequestToRequestData, stripUrlQueryAndFragment } from '@sentry/core';\nimport * as Sentry from '@sentry/node-core';\nimport { execa } from 'execa';\n\n/**\n * A thin wrapper around {@link Sentry.init} that automatically sets `release`\n * based on the current Git revision.\n */\nexport async function init(options: Sentry.NodeOptions) {\n  let release = options.release;\n\n  if (!release) {\n    try {\n      release = (await execa('git', ['rev-parse', 'HEAD'])).stdout.trim();\n    } catch {\n      // This most likely isn't running in an initialized git repository.\n      // Default to not setting a release.\n    }\n  }\n\n  Sentry.init({\n    release,\n    ...options,\n  });\n}\n\n/**\n * Based on Sentry code that is not exported:\n * https://github.com/getsentry/sentry-javascript/blob/602703652959b581304a7849cb97117f296493bc/packages/utils/src/requestdata.ts#L102\n */\nfunction extractTransaction(req: any) {\n  const method = req.method?.toUpperCase() || '';\n  const path = stripUrlQueryAndFragment(req.originalUrl || req.url || '');\n\n  let name = '';\n  if (method) {\n    name += method;\n  }\n  if (method && path) {\n    name += ' ';\n  }\n  if (path) {\n    name += path;\n  }\n\n  return name;\n}\n\n/**\n * Sentry v8 switched from simple, manual instrumentation to \"automatic\"\n * instrumentation based on OpenTelemetry. However, this interferes with\n * the way that our applications asynchronously load their configuration,\n * specifically the Sentry DSN. Sentry's automatic request isolation and\n * request data extraction requires that `Sentry.init` be called before\n * any other code is loaded, but our application startup structure is such\n * that we import most of our own code before we can load the Sentry DSN.\n *\n * Rather than jumping through hoops to restructure our application to\n * support this, this small function can be added as Express middleware to\n * isolate requests and set request data for Sentry.\n */\nexport function requestHandler() {\n  return (req: any, _res: any, next: any) => {\n    Sentry.withIsolationScope((scope) => {\n      scope.addEventProcessor((event) => {\n        // If an event processor throws an error, Sentry will catch it and\n        // retrigger the event processor, which infinitely recurses. We'll\n        // treat our event processor as a best-effort operation and silently\n        // swallow any errors.\n        try {\n          event.transaction = extractTransaction(req);\n          event.request = httpRequestToRequestData(req);\n          return event;\n        } catch {\n          return event;\n        }\n      });\n\n      next();\n    });\n  };\n}\n\n// We export every type and function from `@sentry/node` *except* for init,\n// which we replace with our own version up above.\n\nexport type {\n  Breadcrumb,\n  BreadcrumbHint,\n  Event,\n  EventHint,\n  Exception,\n  NodeOptions,\n  PolymorphicRequest,\n  SdkInfo,\n  Session,\n  SeverityLevel,\n  Span,\n  StackFrame,\n  Stacktrace,\n  Thread,\n  User,\n} from '@sentry/node-core';\n\nexport {\n  addBreadcrumb,\n  addEventProcessor,\n  captureEvent,\n  captureException,\n  captureMessage,\n  close,\n  createTransport,\n  defaultStackParser,\n  flush,\n  getCurrentScope,\n  getSentryRelease,\n  makeNodeTransport,\n  NodeClient,\n  Scope,\n  SDK_VERSION,\n  SentryContextManager,\n  setContext,\n  setExtra,\n  setExtras,\n  setTag,\n  setTags,\n  setUser,\n  startInactiveSpan,\n  startSpan,\n  startSpanManual,\n  withIsolationScope,\n  withScope,\n} from '@sentry/node-core';\n\nexport { expressErrorHandler, setupExpressErrorHandler } from './express.js';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prairielearn/sentry",
-  "version": "3.0.7",
+  "version": "4.0.0",
   "type": "module",
   "repository": {
     "type": "git",
@@ -13,13 +13,13 @@
     "dev": "tsc --watch --preserveWatchOutput"
   },
   "dependencies": {
-    "@sentry/core": "^9.34.0",
-    "@sentry/node": "^9.34.0",
+    "@sentry/core": "^10.0.0",
+    "@sentry/node-core": "^10.0.0",
     "execa": "^9.6.0"
   },
   "devDependencies": {
     "@prairielearn/tsconfig": "^0.0.0",
-    "@types/node": "^22.15.34",
+    "@types/node": "^22.17.0",
     "tsx": "^4.20.3",
     "typescript": "^5.8.3"
   }

package/src/express.ts

@@ -0,0 +1,131 @@
+// This is a fork of Sentry's Express integration from `@sentry/node`that's not
+// available in the `@sentry/node-core` package`. It has been lightly modified
+// to remove unused code and conform to PrairieLearn's coding style.
+//
+// See this package's `README.md` for more information about why we aren't
+// using `@sentry/node` directly.
+//
+// This was forked from the following file on 2025-07-30:
+// https://github.com/getsentry/sentry-javascript/blob/12ac49a9956fd1b64b3f8ad4b2b8f1da426a1efd/packages/node/src/integrations/tracing/express.ts
+
+import type * as http from 'node:http';
+
+import { captureException, getIsolationScope, httpRequestToRequestData } from '@sentry/core';
+import { ensureIsWrapped } from '@sentry/node-core';
+
+interface MiddlewareError extends Error {
+  status?: number | string;
+  statusCode?: number | string;
+  status_code?: number | string;
+  output?: {
+    statusCode?: number | string;
+  };
+}
+
+type ExpressMiddleware = (
+  req: http.IncomingMessage,
+  res: http.ServerResponse,
+  next: () => void,
+) => void;
+
+type ExpressErrorMiddleware = (
+  error: MiddlewareError,
+  req: http.IncomingMessage,
+  res: http.ServerResponse,
+  next: (error: MiddlewareError) => void,
+) => void;
+
+interface ExpressHandlerOptions {
+  /**
+   * Callback method deciding whether error should be captured and sent to Sentry
+   * @param error Captured middleware error
+   */
+  shouldHandleError?(error: MiddlewareError): boolean;
+}
+
+/**
+ * An Express-compatible error handler.
+ */
+export function expressErrorHandler(options?: ExpressHandlerOptions): ExpressErrorMiddleware {
+  return function sentryErrorMiddleware(
+    error: MiddlewareError,
+    request: http.IncomingMessage,
+    res: http.ServerResponse,
+    next: (error: MiddlewareError) => void,
+  ): void {
+    const normalizedRequest = httpRequestToRequestData(request);
+    // Ensure we use the express-enhanced request here, instead of the plain HTTP one
+    // When an error happens, the `expressRequestHandler` middleware does not run, so we set it here too
+    getIsolationScope().setSDKProcessingMetadata({ normalizedRequest });
+
+    const shouldHandleError = options?.shouldHandleError || defaultShouldHandleError;
+
+    if (shouldHandleError(error)) {
+      const eventId = captureException(error, {
+        mechanism: { type: 'middleware', handled: false },
+      });
+      (res as { sentry?: string }).sentry = eventId;
+    }
+
+    next(error);
+  };
+}
+
+function expressRequestHandler(): ExpressMiddleware {
+  return function sentryRequestMiddleware(
+    request: http.IncomingMessage,
+    _res: http.ServerResponse,
+    next: () => void,
+  ): void {
+    const normalizedRequest = httpRequestToRequestData(request);
+    // Ensure we use the express-enhanced request here, instead of the plain HTTP one
+    getIsolationScope().setSDKProcessingMetadata({ normalizedRequest });
+
+    next();
+  };
+}
+
+/**
+ * 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
+ * const Sentry = require('@sentry/node');
+ * const express = require("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);
+ * ```
+ */
+export function setupExpressErrorHandler(
+  app: { use: (middleware: ExpressMiddleware | ExpressErrorMiddleware) => unknown },
+  options?: ExpressHandlerOptions,
+): void {
+  app.use(expressRequestHandler());
+  app.use(expressErrorHandler(options));
+  ensureIsWrapped(app.use, 'express');
+}
+
+function getStatusCodeFromResponse(error: MiddlewareError): number {
+  const statusCode =
+    error.status || error.statusCode || error.status_code || error.output?.statusCode;
+  return statusCode ? parseInt(statusCode as string, 10) : 500;
+}
+
+/** Returns true if response code is internal server error */
+function defaultShouldHandleError(error: MiddlewareError): boolean {
+  const status = getStatusCodeFromResponse(error);
+  return status >= 500;
+}

package/src/index.ts

@@ -1,5 +1,5 @@
 import { httpRequestToRequestData, stripUrlQueryAndFragment } from '@sentry/core';
-import * as Sentry from '@sentry/node';
+import * as Sentry from '@sentry/node-core';
 import { execa } from 'execa';
 
 /**
@@ -100,7 +100,7 @@ export type {
   Stacktrace,
   Thread,
   User,
-} from '@sentry/node';
+} from '@sentry/node-core';
 
 export {
   addBreadcrumb,
@@ -111,8 +111,6 @@ export {
   close,
   createTransport,
   defaultStackParser,
-  expressErrorHandler,
-  expressIntegration,
   flush,
   getCurrentScope,
   getSentryRelease,
@@ -126,11 +124,12 @@ export {
   setExtras,
   setTag,
   setTags,
-  setupExpressErrorHandler,
   setUser,
   startInactiveSpan,
   startSpan,
   startSpanManual,
   withIsolationScope,
   withScope,
-} from '@sentry/node';
+} from '@sentry/node-core';
+
+export { expressErrorHandler, setupExpressErrorHandler } from './express.js';