ref(core): Make better use of Sentry (#246)

Luca Forstner · web-flow · commit 006cceb43e83 · 2023-05-25T10:57:54.000+02:00
diff --git a/packages/bundler-plugin-core/package.json b/packages/bundler-plugin-core/package.json
@@ -53,7 +53,7 @@
   },
   "dependencies": {
     "@sentry/cli": "^2.17.0",
-    "@sentry/node": "7.50.0",
+    "@sentry/node": "7.53.1",
     "find-up": "5.0.0",
     "glob": "9.3.2",
     "magic-string": "0.27.0",
diff --git a/packages/bundler-plugin-core/src/index.ts b/packages/bundler-plugin-core/src/index.ts
@@ -74,10 +74,17 @@ export function sentryUnpluginFactory({
       shouldSendTelemetry,
       unpluginMetaContext.framework
     );
-    const pluginExecutionTransaction = sentryHub.startTransaction({
-      name: "Sentry Bundler Plugin execution",
+    const sentrySession = sentryHub.startSession();
+    sentryHub.captureSession();
+
+    let sentEndSession = false; // Just to prevent infinite loops with beforeExit, which is called whenever the event loop empties out
+    // We also need to manually end sesisons on errors because beforeExit is not called on crashes
+    process.on("beforeExit", () => {
+      if (!sentEndSession) {
+        sentryHub.endSession();
+        sentEndSession = true;
+      }
     });
-    sentryHub.getScope().setSpan(pluginExecutionTransaction);
 
     const logger = createLogger({
       prefix: `[sentry-${unpluginMetaContext.framework}-plugin]`,
@@ -86,16 +93,25 @@ export function sentryUnpluginFactory({
     });
 
     function handleRecoverableError(unknownError: unknown) {
-      pluginExecutionTransaction.setStatus("internal_error");
-
-      if (options.errorHandler) {
-        if (unknownError instanceof Error) {
-          options.errorHandler(unknownError);
+      sentrySession.status = "abnormal";
+      try {
+        if (options.errorHandler) {
+          try {
+            if (unknownError instanceof Error) {
+              options.errorHandler(unknownError);
+            } else {
+              options.errorHandler(new Error("An unknown error occured"));
+            }
+          } catch (e) {
+            sentrySession.status = "crashed";
+            throw e;
+          }
         } else {
-          options.errorHandler(new Error("An unknown error occured"));
+          sentrySession.status = "crashed";
+          throw unknownError;
         }
-      } else {
-        throw unknownError;
+      } finally {
+        sentryHub.endSession();
       }
     }
 
@@ -115,10 +131,10 @@ export function sentryUnpluginFactory({
 
     plugins.push(
       telemetryPlugin({
-        pluginExecutionTransaction,
+        sentryClient,
+        sentryHub,
         logger,
         shouldSendTelemetry,
-        sentryClient,
       })
     );
 
diff --git a/packages/bundler-plugin-core/src/plugins/telemetry.ts b/packages/bundler-plugin-core/src/plugins/telemetry.ts
@@ -1,35 +1,30 @@
-import { NodeClient, Transaction } from "@sentry/node";
+import { Hub, NodeClient } from "@sentry/node";
 import { UnpluginOptions } from "unplugin";
 import { Logger } from "../sentry/logger";
 
 interface TelemetryPluginOptions {
+  sentryHub: Hub;
   sentryClient: NodeClient;
-  pluginExecutionTransaction: Transaction;
   shouldSendTelemetry: Promise<boolean>;
   logger: Logger;
 }
 
 export function telemetryPlugin({
+  sentryHub,
   sentryClient,
-  pluginExecutionTransaction,
   shouldSendTelemetry,
   logger,
 }: TelemetryPluginOptions): UnpluginOptions {
   return {
     name: "sentry-telemetry-plugin",
-    buildStart() {
-      void shouldSendTelemetry.then((willSendTelemetry) => {
-        if (willSendTelemetry) {
-          logger.info(
-            "Sending error and performance telemetry data to Sentry. To disable telemetry, set `options.telemetry` to `false`."
-          );
-        }
-      });
-      pluginExecutionTransaction.startTimestamp = Date.now() / 1000;
-    },
-    async writeBundle() {
-      pluginExecutionTransaction.finish();
-      await sentryClient.flush();
+    async buildStart() {
+      if (await shouldSendTelemetry) {
+        logger.info(
+          "Sending error and performance telemetry data to Sentry. To disable telemetry, set `options.telemetry` to `false`."
+        );
+        sentryHub.startTransaction({ name: "Sentry Bundler Plugin execution" }).finish();
+        await sentryClient.flush(3000);
+      }
     },
   };
 }
diff --git a/packages/bundler-plugin-core/src/sentry/telemetry.ts b/packages/bundler-plugin-core/src/sentry/telemetry.ts
@@ -62,6 +62,7 @@ export function createSentryInstance(
 export function setTelemetryDataOnHub(options: NormalizedOptions, hub: Hub, bundler: string) {
   const { org, project, release, errorHandler, sourcemaps } = options;
 
+  hub.setTag("upload-legacy-sourcemaps", !!release.uploadLegacySourcemaps);
   if (release.uploadLegacySourcemaps) {
     hub.setTag(
       "uploadLegacySourcemapsEntries",
@@ -70,29 +71,19 @@ export function setTelemetryDataOnHub(options: NormalizedOptions, hub: Hub, bund
   }
 
   // Optional release pipeline steps
-  if (release.cleanArtifacts) {
-    hub.setTag("clean-artifacts", true);
-  }
+  hub.setTag("clean-artifacts", release.cleanArtifacts);
   if (release.setCommits) {
     hub.setTag("set-commits", release.setCommits.auto === true ? "auto" : "manual");
+  } else {
+    hub.setTag("set-commits", "undefined");
   }
-  if (release.finalize) {
-    hub.setTag("finalize-release", true);
-  }
-  if (release.deploy) {
-    hub.setTag("add-deploy", true);
-  }
+  hub.setTag("finalize-release", release.finalize);
+  hub.setTag("deploy-options", !!release.deploy);
 
   // Miscelaneous options
-  if (errorHandler) {
-    hub.setTag("error-handler", "custom");
-  }
-  if (sourcemaps?.assets) {
-    hub.setTag("debug-id-upload", true);
-  }
-  if (sourcemaps?.deleteFilesAfterUpload) {
-    hub.setTag("delete-after-upload", true);
-  }
+  hub.setTag("custom-error-handler", !!errorHandler);
+  hub.setTag("sourcemaps-assets", !!sourcemaps?.assets);
+  hub.setTag("delete-after-upload", !!sourcemaps?.deleteFilesAfterUpload);
 
   hub.setTag("node", process.version);
 
diff --git a/packages/bundler-plugin-core/test/sentry/telemetry.test.ts b/packages/bundler-plugin-core/test/sentry/telemetry.test.ts
@@ -70,7 +70,7 @@ describe("addPluginOptionTagsToHub", () => {
       mockedHub as unknown as Hub,
       "rollup"
     );
-    expect(mockedHub.setTag).toHaveBeenCalledWith("add-deploy", true);
+    expect(mockedHub.setTag).toHaveBeenCalledWith("deploy-options", true);
   });
 
   it("should set errorHandler tag to `custom` if the errorHandler option is specified", () => {
@@ -80,7 +80,7 @@ describe("addPluginOptionTagsToHub", () => {
       mockedHub as unknown as Hub,
       "rollup"
     );
-    expect(mockedHub.setTag).toHaveBeenCalledWith("error-handler", "custom");
+    expect(mockedHub.setTag).toHaveBeenCalledWith("custom-error-handler", true);
   });
 
   it.each([
diff --git a/yarn.lock b/yarn.lock
@@ -2249,6 +2249,16 @@
     "@sentry/utils" "7.50.0"
     tslib "^1.9.3"
 
+"@sentry-internal/tracing@7.53.1":
+  version "7.53.1"
+  resolved "https://registry.npmjs.org/@sentry-internal/tracing/-/tracing-7.53.1.tgz#85517ba93ee721424c865706f7ff4eaab1569e6d"
+  integrity sha512-a4H4rvVdz0XDGgNfRqc7zg6rMt2P1P05xBmgfIfztYy94Vciw1QMdboNiT7einr8ra8wogdEaK4Pe2AzYAPBJQ==
+  dependencies:
+    "@sentry/core" "7.53.1"
+    "@sentry/types" "7.53.1"
+    "@sentry/utils" "7.53.1"
+    tslib "^1.9.3"
+
 "@sentry/cli@^2.17.0":
   version "2.18.1"
   resolved "https://registry.npmjs.org/@sentry/cli/-/cli-2.18.1.tgz#c44f189a1a72a83087a297c5fcc7668f86dd4308"
@@ -2269,6 +2279,15 @@
     "@sentry/utils" "7.50.0"
     tslib "^1.9.3"
 
+"@sentry/core@7.53.1":
+  version "7.53.1"
+  resolved "https://registry.npmjs.org/@sentry/core/-/core-7.53.1.tgz#c091a9d7fd010f8a2cb1dd71d949a8e453e35d4c"
+  integrity sha512-DAH8IJNORJJ7kQLqsZuhMkN6cwJjXzFuuUoZor7IIDHIHjtl51W+2F3Stg3+I3ZoKDfJfUNKqhipk2WZjG0FBg==
+  dependencies:
+    "@sentry/types" "7.53.1"
+    "@sentry/utils" "7.53.1"
+    tslib "^1.9.3"
+
 "@sentry/integrations@7.50":
   version "7.50.0"
   resolved "https://registry.npmjs.org/@sentry/integrations/-/integrations-7.50.0.tgz#82616f34ddba3c1f3e17b54900dfa7d8e0a0c537"
@@ -2279,7 +2298,7 @@
     localforage "^1.8.1"
     tslib "^1.9.3"
 
-"@sentry/node@7.50", "@sentry/node@7.50.0":
+"@sentry/node@7.50":
   version "7.50.0"
   resolved "https://registry.npmjs.org/@sentry/node/-/node-7.50.0.tgz#d6adab136d87f7dca614ea0d77944f902fa45626"
   integrity sha512-11UJBKoQFMp7f8sbzeO2gENsKIUkVCNBTzuPRib7l2K1HMjSfacXmwwma7ZEs0mc3ofIZ1UYuyONAXmI1lK9cQ==
@@ -2293,11 +2312,30 @@
     lru_map "^0.3.3"
     tslib "^1.9.3"
 
+"@sentry/node@7.53.1":
+  version "7.53.1"
+  resolved "https://registry.npmjs.org/@sentry/node/-/node-7.53.1.tgz#d4c47477cf4305e352b511635d1d3d4d160e8bd7"
+  integrity sha512-B4ax8sRd54xj4ad+4eY2EOKNt0Mh1NjuLW1zUKS8HW3h0bmuaDFzGuhEVvEY5H4SaV6tZKj1c0dvnMnyUbYkhA==
+  dependencies:
+    "@sentry-internal/tracing" "7.53.1"
+    "@sentry/core" "7.53.1"
+    "@sentry/types" "7.53.1"
+    "@sentry/utils" "7.53.1"
+    cookie "^0.4.1"
+    https-proxy-agent "^5.0.0"
+    lru_map "^0.3.3"
+    tslib "^1.9.3"
+
 "@sentry/types@7.50.0":
   version "7.50.0"
   resolved "https://registry.npmjs.org/@sentry/types/-/types-7.50.0.tgz#52a035cad83a80ca26fa53c09eb1241250c3df3e"
   integrity sha512-Zo9vyI98QNeYT0K0y57Rb4JRWDaPEgmp+QkQ4CRQZFUTWetO5fvPZ4Gb/R7TW16LajuHZlbJBHmvmNj2pkL2kw==
 
+"@sentry/types@7.53.1":
+  version "7.53.1"
+  resolved "https://registry.npmjs.org/@sentry/types/-/types-7.53.1.tgz#3eefbad851f2d0deff67285d7e976d23d7d06a41"
+  integrity sha512-/ijchRIu+jz3+j/zY+7KRPfLSCY14fTx5xujjbOdmEKjmIHQmwPBdszcQm40uwofrR8taV4hbt5MFN+WnjCkCw==
+
 "@sentry/utils@7.50.0":
   version "7.50.0"
   resolved "https://registry.npmjs.org/@sentry/utils/-/utils-7.50.0.tgz#2b93a48024651436e95b7c8e2066aee7c2234d57"
@@ -2306,6 +2344,14 @@
     "@sentry/types" "7.50.0"
     tslib "^1.9.3"
 
+"@sentry/utils@7.53.1":
+  version "7.53.1"
+  resolved "https://registry.npmjs.org/@sentry/utils/-/utils-7.53.1.tgz#b1f9f1dd4de7127287ad5027c2bd1133c5590486"
+  integrity sha512-DKJA1LSUOEv4KOR828MzVuLh+drjeAgzyKgN063OEKmnirgjgRgNNS8wUgwpG0Tn2k6ANZGCwrdfzPeSBxshKg==
+  dependencies:
+    "@sentry/types" "7.53.1"
+    tslib "^1.9.3"
+
 "@sigstore/protobuf-specs@^0.1.0":
   version "0.1.0"
   resolved "https://registry.npmjs.org/@sigstore/protobuf-specs/-/protobuf-specs-0.1.0.tgz#957cb64ea2f5ce527cc9cf02a096baeb0d2b99b4"
