@prairielearn/sentry 2.0.2 → 2.0.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @prairielearn/sentry
 
+## 2.0.4
+
+### Patch Changes
+
+- 68653a6: Handle errors inside request event processor
+
+## 2.0.3
+
+### Patch Changes
+
+- 24a93b8: Upgrade all JavaScript dependencies
+
 ## 2.0.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -4,5 +4,19 @@ import * as Sentry from '@sentry/node';
  * based on the current Git revision.
  */
 export declare function init(options: Sentry.NodeOptions): Promise<void>;
-export { Breadcrumb, BreadcrumbHint, Request, SdkInfo, Event, EventHint, Exception, Session, Severity, SeverityLevel, StackFrame, Stacktrace, Thread, User, AddRequestDataToEventOptions, PolymorphicRequest, NodeOptions, } from '@sentry/node';
-export { addGlobalEventProcessor, addBreadcrumb, captureException, captureEvent, captureMessage, configureScope, createTransport, getHubFromCarrier, getCurrentHub, Hub, makeMain, Scope, startTransaction, SDK_VERSION, setContext, setExtra, setExtras, setTag, setTags, setUser, withScope, NodeClient, makeNodeTransport, addRequestDataToEvent, extractRequestData, defaultIntegrations, defaultStackParser, lastEventId, flush, close, getSentryRelease, deepReadDirSync, Integrations, Handlers, runWithAsyncContext, getCurrentScope, } from '@sentry/node';
+/**
+ * Sentry v8 switched from simple, manual instrumentation to "automatic"
+ * instrumentation based on OpenTelemetry. However, this interferes with
+ * the way that our applications asynchronously load their configuration,
+ * specifically the Sentry DSN. Sentry's automatic request isolation and
+ * request data extraction requires that `Sentry.init` be called before
+ * any other code is loaded, but our application startup structure is such
+ * that we import most of our own code before we can load the Sentry DSN.
+ *
+ * Rather than jumping through hoops to restructure our application to
+ * support this, this small function can be added as Express middleware to
+ * isolate requests and set request data for Sentry.
+ */
+export declare function requestHandler(): (req: any, _res: any, next: any) => void;
+export { Breadcrumb, BreadcrumbHint, Request, PolymorphicRequest, SdkInfo, Event, EventHint, Exception, Session, SeverityLevel, StackFrame, Stacktrace, Thread, User, Span, NodeOptions, } from '@sentry/node';
+export { addEventProcessor, addBreadcrumb, captureException, captureEvent, captureMessage, createTransport, getCurrentHub, Scope, SDK_VERSION, setContext, setExtra, setExtras, setTag, setTags, setUser, withScope, NodeClient, makeNodeTransport, addRequestDataToEvent, extractRequestData, defaultStackParser, flush, close, getSentryRelease, getCurrentScope, startSpan, startSpanManual, startInactiveSpan, expressIntegration, expressErrorHandler, setupExpressErrorHandler, } from '@sentry/node';

package/dist/index.js

@@ -1,4 +1,5 @@
 import * as Sentry from '@sentry/node';
+import { stripUrlQueryAndFragment } from '@sentry/utils';
 import { execa } from 'execa';
 /**
  * A thin wrapper around {@link Sentry.init} that automatically sets `release`
@@ -20,5 +21,57 @@ export async function init(options) {
         ...options,
     });
 }
-export { addGlobalEventProcessor, addBreadcrumb, captureException, captureEvent, captureMessage, configureScope, createTransport, getHubFromCarrier, getCurrentHub, Hub, makeMain, Scope, startTransaction, SDK_VERSION, setContext, setExtra, setExtras, setTag, setTags, setUser, withScope, NodeClient, makeNodeTransport, addRequestDataToEvent, extractRequestData, defaultIntegrations, defaultStackParser, lastEventId, flush, close, getSentryRelease, deepReadDirSync, Integrations, Handlers, runWithAsyncContext, getCurrentScope, } from '@sentry/node';
+/**
+ * Based on Sentry code that is not exported:
+ * https://github.com/getsentry/sentry-javascript/blob/602703652959b581304a7849cb97117f296493bc/packages/utils/src/requestdata.ts#L102
+ */
+function extractTransaction(req) {
+    const method = req.method?.toUpperCase() || '';
+    const path = stripUrlQueryAndFragment(req.originalUrl || req.url || '');
+    let name = '';
+    if (method) {
+        name += method;
+    }
+    if (method && path) {
+        name += ' ';
+    }
+    if (path) {
+        name += path;
+    }
+    return name;
+}
+/**
+ * Sentry v8 switched from simple, manual instrumentation to "automatic"
+ * instrumentation based on OpenTelemetry. However, this interferes with
+ * the way that our applications asynchronously load their configuration,
+ * specifically the Sentry DSN. Sentry's automatic request isolation and
+ * request data extraction requires that `Sentry.init` be called before
+ * any other code is loaded, but our application startup structure is such
+ * that we import most of our own code before we can load the Sentry DSN.
+ *
+ * Rather than jumping through hoops to restructure our application to
+ * support this, this small function can be added as Express middleware to
+ * isolate requests and set request data for Sentry.
+ */
+export function requestHandler() {
+    return (req, _res, next) => {
+        Sentry.withIsolationScope((scope) => {
+            scope.addEventProcessor((event) => {
+                // If an event processor throws an error, Sentry will catch it and
+                // retrigger the event processor, which infinitely recurses. We'll
+                // treat our event processor as a best-effort operation and silently
+                // swallow any errors.
+                try {
+                    event.transaction = extractTransaction(req);
+                    return Sentry.addRequestDataToEvent(event, req);
+                }
+                catch {
+                    return event;
+                }
+            });
+            next();
+        });
+    };
+}
+export { addEventProcessor, addBreadcrumb, captureException, captureEvent, captureMessage, createTransport, getCurrentHub, Scope, SDK_VERSION, setContext, setExtra, setExtras, setTag, setTags, setUser, withScope, NodeClient, makeNodeTransport, addRequestDataToEvent, extractRequestData, defaultStackParser, flush, close, getSentryRelease, getCurrentScope, startSpan, startSpanManual, startInactiveSpan, expressIntegration, expressErrorHandler, setupExpressErrorHandler, } from '@sentry/node';
 //# 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,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,OAAO,CAAC,EAAE,CAAC;YACX,mEAAmE;YACnE,oCAAoC;QACtC,CAAC;IACH,CAAC;IAED,MAAM,CAAC,IAAI,CAAC;QACV,OAAO;QACP,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC;AAyBD,OAAO,EACL,uBAAuB,EACvB,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACd,cAAc,EACd,eAAe,EACf,iBAAiB,EACjB,aAAa,EACb,GAAG,EACH,QAAQ,EACR,KAAK,EACL,gBAAgB,EAChB,WAAW,EACX,UAAU,EACV,QAAQ,EACR,SAAS,EACT,MAAM,EACN,OAAO,EACP,OAAO,EACP,SAAS,EACT,UAAU,EACV,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,WAAW,EACX,KAAK,EACL,KAAK,EACL,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,QAAQ,EACR,mBAAmB,EACnB,eAAe,GAChB,MAAM,cAAc,CAAC","sourcesContent":["import * 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 (e) {\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// We export every type and function from `@sentry/node` *except* for init,\n// which we replace with our own version up above.\n\nexport {\n  Breadcrumb,\n  BreadcrumbHint,\n  Request,\n  SdkInfo,\n  Event,\n  EventHint,\n  Exception,\n  Session,\n  Severity,\n  SeverityLevel,\n  StackFrame,\n  Stacktrace,\n  Thread,\n  User,\n  AddRequestDataToEventOptions,\n  PolymorphicRequest,\n  NodeOptions,\n} from '@sentry/node';\n\nexport {\n  addGlobalEventProcessor,\n  addBreadcrumb,\n  captureException,\n  captureEvent,\n  captureMessage,\n  configureScope,\n  createTransport,\n  getHubFromCarrier,\n  getCurrentHub,\n  Hub,\n  makeMain,\n  Scope,\n  startTransaction,\n  SDK_VERSION,\n  setContext,\n  setExtra,\n  setExtras,\n  setTag,\n  setTags,\n  setUser,\n  withScope,\n  NodeClient,\n  makeNodeTransport,\n  addRequestDataToEvent,\n  extractRequestData,\n  defaultIntegrations,\n  defaultStackParser,\n  lastEventId,\n  flush,\n  close,\n  getSentryRelease,\n  deepReadDirSync,\n  Integrations,\n  Handlers,\n  runWithAsyncContext,\n  getCurrentScope,\n} from '@sentry/node';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AACzD,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,OAAO,CAAC,EAAE,CAAC;YACX,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,OAAO,MAAM,CAAC,qBAAqB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;gBAClD,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;AAwBD,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACd,eAAe,EACf,aAAa,EACb,KAAK,EACL,WAAW,EACX,UAAU,EACV,QAAQ,EACR,SAAS,EACT,MAAM,EACN,OAAO,EACP,OAAO,EACP,SAAS,EACT,UAAU,EACV,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,KAAK,EACL,KAAK,EACL,gBAAgB,EAChB,eAAe,EACf,SAAS,EACT,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,wBAAwB,GACzB,MAAM,cAAc,CAAC","sourcesContent":["import * as Sentry from '@sentry/node';\nimport { stripUrlQueryAndFragment } from '@sentry/utils';\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 (e) {\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          return Sentry.addRequestDataToEvent(event, req);\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 {\n  Breadcrumb,\n  BreadcrumbHint,\n  Request,\n  PolymorphicRequest,\n  SdkInfo,\n  Event,\n  EventHint,\n  Exception,\n  Session,\n  SeverityLevel,\n  StackFrame,\n  Stacktrace,\n  Thread,\n  User,\n  Span,\n  NodeOptions,\n} from '@sentry/node';\n\nexport {\n  addEventProcessor,\n  addBreadcrumb,\n  captureException,\n  captureEvent,\n  captureMessage,\n  createTransport,\n  getCurrentHub,\n  Scope,\n  SDK_VERSION,\n  setContext,\n  setExtra,\n  setExtras,\n  setTag,\n  setTags,\n  setUser,\n  withScope,\n  NodeClient,\n  makeNodeTransport,\n  addRequestDataToEvent,\n  extractRequestData,\n  defaultStackParser,\n  flush,\n  close,\n  getSentryRelease,\n  getCurrentScope,\n  startSpan,\n  startSpanManual,\n  startInactiveSpan,\n  expressIntegration,\n  expressErrorHandler,\n  setupExpressErrorHandler,\n} from '@sentry/node';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prairielearn/sentry",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "type": "module",
   "main": "dist/index.js",
   "repository": {
@@ -14,12 +14,13 @@
   },
   "devDependencies": {
     "@prairielearn/tsconfig": "^0.0.0",
-    "@types/node": "^20.13.0",
-    "tsx": "^4.11.0",
-    "typescript": "^5.4.5"
+    "@types/node": "^20.14.9",
+    "tsx": "^4.16.2",
+    "typescript": "^5.5.3"
   },
   "dependencies": {
-    "@sentry/node": "^7.116.0",
-    "execa": "^9.1.0"
+    "@sentry/node": "^8.18.0",
+    "@sentry/utils": "^8.18.0",
+    "execa": "^9.3.0"
   }
 }

package/src/index.ts

@@ -1,4 +1,5 @@
 import * as Sentry from '@sentry/node';
+import { stripUrlQueryAndFragment } from '@sentry/utils';
 import { execa } from 'execa';
 
 /**
@@ -23,6 +24,62 @@ export async function init(options: Sentry.NodeOptions) {
   });
 }
 
+/**
+ * Based on Sentry code that is not exported:
+ * https://github.com/getsentry/sentry-javascript/blob/602703652959b581304a7849cb97117f296493bc/packages/utils/src/requestdata.ts#L102
+ */
+function extractTransaction(req: any) {
+  const method = req.method?.toUpperCase() || '';
+  const path = stripUrlQueryAndFragment(req.originalUrl || req.url || '');
+
+  let name = '';
+  if (method) {
+    name += method;
+  }
+  if (method && path) {
+    name += ' ';
+  }
+  if (path) {
+    name += path;
+  }
+
+  return name;
+}
+
+/**
+ * Sentry v8 switched from simple, manual instrumentation to "automatic"
+ * instrumentation based on OpenTelemetry. However, this interferes with
+ * the way that our applications asynchronously load their configuration,
+ * specifically the Sentry DSN. Sentry's automatic request isolation and
+ * request data extraction requires that `Sentry.init` be called before
+ * any other code is loaded, but our application startup structure is such
+ * that we import most of our own code before we can load the Sentry DSN.
+ *
+ * Rather than jumping through hoops to restructure our application to
+ * support this, this small function can be added as Express middleware to
+ * isolate requests and set request data for Sentry.
+ */
+export function requestHandler() {
+  return (req: any, _res: any, next: any) => {
+    Sentry.withIsolationScope((scope) => {
+      scope.addEventProcessor((event) => {
+        // If an event processor throws an error, Sentry will catch it and
+        // retrigger the event processor, which infinitely recurses. We'll
+        // treat our event processor as a best-effort operation and silently
+        // swallow any errors.
+        try {
+          event.transaction = extractTransaction(req);
+          return Sentry.addRequestDataToEvent(event, req);
+        } catch {
+          return event;
+        }
+      });
+
+      next();
+    });
+  };
+}
+
 // We export every type and function from `@sentry/node` *except* for init,
 // which we replace with our own version up above.
 
@@ -30,36 +87,30 @@ export {
   Breadcrumb,
   BreadcrumbHint,
   Request,
+  PolymorphicRequest,
   SdkInfo,
   Event,
   EventHint,
   Exception,
   Session,
-  Severity,
   SeverityLevel,
   StackFrame,
   Stacktrace,
   Thread,
   User,
-  AddRequestDataToEventOptions,
-  PolymorphicRequest,
+  Span,
   NodeOptions,
 } from '@sentry/node';
 
 export {
-  addGlobalEventProcessor,
+  addEventProcessor,
   addBreadcrumb,
   captureException,
   captureEvent,
   captureMessage,
-  configureScope,
   createTransport,
-  getHubFromCarrier,
   getCurrentHub,
-  Hub,
-  makeMain,
   Scope,
-  startTransaction,
   SDK_VERSION,
   setContext,
   setExtra,
@@ -72,15 +123,15 @@ export {
   makeNodeTransport,
   addRequestDataToEvent,
   extractRequestData,
-  defaultIntegrations,
   defaultStackParser,
-  lastEventId,
   flush,
   close,
   getSentryRelease,
-  deepReadDirSync,
-  Integrations,
-  Handlers,
-  runWithAsyncContext,
   getCurrentScope,
+  startSpan,
+  startSpanManual,
+  startInactiveSpan,
+  expressIntegration,
+  expressErrorHandler,
+  setupExpressErrorHandler,
 } from '@sentry/node';