@prairielearn/sentry 1.0.0

package/.turbo/turbo-build.log

@@ -0,0 +1,3 @@
+@prairielearn/sentry:build: cache hit, replaying output 8e15df250c27f0f0
+@prairielearn/sentry:build: warning package.json: No license field
+@prairielearn/sentry:build: $ tsc

package/README.md

@@ -0,0 +1,12 @@
+# `@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.
+
+```ts
+import { init } from '@prairielearn/sentry';
+
+await init({
+  dsn: 'DSN HERE',
+  environment: 'ENVIRONMENT HERE',
+});
+```

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import * as Sentry from '@sentry/node';
+/**
+ * A thin wrapper around {@link Sentry.init} that automatically sets `release`
+ * 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, CrossPlatformRequest, 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, } from '@sentry/node';

package/dist/index.js

@@ -0,0 +1,88 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Handlers = exports.Integrations = exports.deepReadDirSync = exports.getSentryRelease = exports.close = exports.flush = exports.lastEventId = exports.defaultStackParser = exports.defaultIntegrations = exports.extractRequestData = exports.addRequestDataToEvent = exports.makeNodeTransport = exports.NodeClient = exports.withScope = exports.setUser = exports.setTags = exports.setTag = exports.setExtras = exports.setExtra = exports.setContext = exports.SDK_VERSION = exports.startTransaction = exports.Scope = exports.makeMain = exports.Hub = exports.getCurrentHub = exports.getHubFromCarrier = exports.createTransport = exports.configureScope = exports.captureMessage = exports.captureEvent = exports.captureException = exports.addBreadcrumb = exports.addGlobalEventProcessor = exports.init = void 0;
+const Sentry = __importStar(require("@sentry/node"));
+const execa_1 = __importDefault(require("execa"));
+/**
+ * A thin wrapper around {@link Sentry.init} that automatically sets `release`
+ * based on the current Git revision.
+ */
+async function init(options) {
+    let release = options.release;
+    if (!release) {
+        try {
+            release = (await (0, execa_1.default)('git', ['rev-parse', 'HEAD'])).stdout.trim();
+        }
+        catch (e) {
+            // This most likely isn't running in an initialized git repository.
+            // Default to not setting a release.
+        }
+    }
+    Sentry.init({
+        release,
+        ...options,
+    });
+}
+exports.init = init;
+var node_1 = require("@sentry/node");
+Object.defineProperty(exports, "addGlobalEventProcessor", { enumerable: true, get: function () { return node_1.addGlobalEventProcessor; } });
+Object.defineProperty(exports, "addBreadcrumb", { enumerable: true, get: function () { return node_1.addBreadcrumb; } });
+Object.defineProperty(exports, "captureException", { enumerable: true, get: function () { return node_1.captureException; } });
+Object.defineProperty(exports, "captureEvent", { enumerable: true, get: function () { return node_1.captureEvent; } });
+Object.defineProperty(exports, "captureMessage", { enumerable: true, get: function () { return node_1.captureMessage; } });
+Object.defineProperty(exports, "configureScope", { enumerable: true, get: function () { return node_1.configureScope; } });
+Object.defineProperty(exports, "createTransport", { enumerable: true, get: function () { return node_1.createTransport; } });
+Object.defineProperty(exports, "getHubFromCarrier", { enumerable: true, get: function () { return node_1.getHubFromCarrier; } });
+Object.defineProperty(exports, "getCurrentHub", { enumerable: true, get: function () { return node_1.getCurrentHub; } });
+Object.defineProperty(exports, "Hub", { enumerable: true, get: function () { return node_1.Hub; } });
+Object.defineProperty(exports, "makeMain", { enumerable: true, get: function () { return node_1.makeMain; } });
+Object.defineProperty(exports, "Scope", { enumerable: true, get: function () { return node_1.Scope; } });
+Object.defineProperty(exports, "startTransaction", { enumerable: true, get: function () { return node_1.startTransaction; } });
+Object.defineProperty(exports, "SDK_VERSION", { enumerable: true, get: function () { return node_1.SDK_VERSION; } });
+Object.defineProperty(exports, "setContext", { enumerable: true, get: function () { return node_1.setContext; } });
+Object.defineProperty(exports, "setExtra", { enumerable: true, get: function () { return node_1.setExtra; } });
+Object.defineProperty(exports, "setExtras", { enumerable: true, get: function () { return node_1.setExtras; } });
+Object.defineProperty(exports, "setTag", { enumerable: true, get: function () { return node_1.setTag; } });
+Object.defineProperty(exports, "setTags", { enumerable: true, get: function () { return node_1.setTags; } });
+Object.defineProperty(exports, "setUser", { enumerable: true, get: function () { return node_1.setUser; } });
+Object.defineProperty(exports, "withScope", { enumerable: true, get: function () { return node_1.withScope; } });
+Object.defineProperty(exports, "NodeClient", { enumerable: true, get: function () { return node_1.NodeClient; } });
+Object.defineProperty(exports, "makeNodeTransport", { enumerable: true, get: function () { return node_1.makeNodeTransport; } });
+Object.defineProperty(exports, "addRequestDataToEvent", { enumerable: true, get: function () { return node_1.addRequestDataToEvent; } });
+Object.defineProperty(exports, "extractRequestData", { enumerable: true, get: function () { return node_1.extractRequestData; } });
+Object.defineProperty(exports, "defaultIntegrations", { enumerable: true, get: function () { return node_1.defaultIntegrations; } });
+Object.defineProperty(exports, "defaultStackParser", { enumerable: true, get: function () { return node_1.defaultStackParser; } });
+Object.defineProperty(exports, "lastEventId", { enumerable: true, get: function () { return node_1.lastEventId; } });
+Object.defineProperty(exports, "flush", { enumerable: true, get: function () { return node_1.flush; } });
+Object.defineProperty(exports, "close", { enumerable: true, get: function () { return node_1.close; } });
+Object.defineProperty(exports, "getSentryRelease", { enumerable: true, get: function () { return node_1.getSentryRelease; } });
+Object.defineProperty(exports, "deepReadDirSync", { enumerable: true, get: function () { return node_1.deepReadDirSync; } });
+Object.defineProperty(exports, "Integrations", { enumerable: true, get: function () { return node_1.Integrations; } });
+Object.defineProperty(exports, "Handlers", { enumerable: true, get: function () { return node_1.Handlers; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qDAAuC;AACvC,kDAA0B;AAE1B;;;GAGG;AACI,KAAK,UAAU,IAAI,CAAC,OAA2B;IACpD,IAAI,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAE9B,IAAI,CAAC,OAAO,EAAE;QACZ,IAAI;YACF,OAAO,GAAG,CAAC,MAAM,IAAA,eAAK,EAAC,KAAK,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;SACrE;QAAC,OAAO,CAAC,EAAE;YACV,mEAAmE;YACnE,oCAAoC;SACrC;KACF;IAED,MAAM,CAAC,IAAI,CAAC;QACV,OAAO;QACP,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC;AAhBD,oBAgBC;AAyBD,qCAmCsB;AAlCpB,+GAAA,uBAAuB,OAAA;AACvB,qGAAA,aAAa,OAAA;AACb,wGAAA,gBAAgB,OAAA;AAChB,oGAAA,YAAY,OAAA;AACZ,sGAAA,cAAc,OAAA;AACd,sGAAA,cAAc,OAAA;AACd,uGAAA,eAAe,OAAA;AACf,yGAAA,iBAAiB,OAAA;AACjB,qGAAA,aAAa,OAAA;AACb,2FAAA,GAAG,OAAA;AACH,gGAAA,QAAQ,OAAA;AACR,6FAAA,KAAK,OAAA;AACL,wGAAA,gBAAgB,OAAA;AAChB,mGAAA,WAAW,OAAA;AACX,kGAAA,UAAU,OAAA;AACV,gGAAA,QAAQ,OAAA;AACR,iGAAA,SAAS,OAAA;AACT,8FAAA,MAAM,OAAA;AACN,+FAAA,OAAO,OAAA;AACP,+FAAA,OAAO,OAAA;AACP,iGAAA,SAAS,OAAA;AACT,kGAAA,UAAU,OAAA;AACV,yGAAA,iBAAiB,OAAA;AACjB,6GAAA,qBAAqB,OAAA;AACrB,0GAAA,kBAAkB,OAAA;AAClB,2GAAA,mBAAmB,OAAA;AACnB,0GAAA,kBAAkB,OAAA;AAClB,mGAAA,WAAW,OAAA;AACX,6FAAA,KAAK,OAAA;AACL,6FAAA,KAAK,OAAA;AACL,wGAAA,gBAAgB,OAAA;AAChB,uGAAA,eAAe,OAAA;AACf,oGAAA,YAAY,OAAA;AACZ,gGAAA,QAAQ,OAAA"}

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@prairielearn/sentry",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch --preserveWatchOutput"
+  },
+  "devDependencies": {
+    "@prairielearn/tsconfig": "*",
+    "mocha": "^10.0.0",
+    "ts-node": "^10.8.1",
+    "typescript": "^4.7.4"
+  },
+  "dependencies": {
+    "@sentry/node": "^7.12.0",
+    "execa": "^5.1.1"
+  }
+}

package/src/index.ts

@@ -0,0 +1,84 @@
+import * as Sentry from '@sentry/node';
+import execa from 'execa';
+
+/**
+ * A thin wrapper around {@link Sentry.init} that automatically sets `release`
+ * based on the current Git revision.
+ */
+export async function init(options: Sentry.NodeOptions) {
+  let release = options.release;
+
+  if (!release) {
+    try {
+      release = (await execa('git', ['rev-parse', 'HEAD'])).stdout.trim();
+    } catch (e) {
+      // This most likely isn't running in an initialized git repository.
+      // Default to not setting a release.
+    }
+  }
+
+  Sentry.init({
+    release,
+    ...options,
+  });
+}
+
+// We export every type and function from `@sentry/node` *except* for init,
+// which we replace with our own version up above.
+
+export {
+  Breadcrumb,
+  BreadcrumbHint,
+  Request,
+  SdkInfo,
+  Event,
+  EventHint,
+  Exception,
+  Session,
+  Severity,
+  SeverityLevel,
+  StackFrame,
+  Stacktrace,
+  Thread,
+  User,
+  AddRequestDataToEventOptions,
+  CrossPlatformRequest,
+  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,
+} from '@sentry/node';

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@prairielearn/tsconfig",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "types": ["mocha", "node"],
+  }
+}