fix up a few things with sentry setup

Author: nsdeschenes

packages/bundler-plugin-core/src/bundle-analysis/bundleAnalysisPluginFactory.ts

@@ -18,13 +18,15 @@ interface BundleAnalysisUploadPluginArgs {
   unpluginMetaContext: UnpluginContextMeta;
   bundleAnalysisUploadPlugin: BundleAnalysisUploadPlugin;
   sentryClient: SentryClient;
+  handleRecoverableError: (error: unknown) => void;
 }
 
 export const bundleAnalysisPluginFactory = ({
   options,
   unpluginMetaContext,
   bundleAnalysisUploadPlugin,
   sentryClient,
+  handleRecoverableError,
 }: BundleAnalysisUploadPluginArgs): UnpluginOptions => {
   const output: Output = {
     version: "1",
@@ -101,6 +103,8 @@ export const bundleAnalysisPluginFactory = ({
           "none",
           { bundler: unpluginMetaContext.framework },
         );
+
+        handleRecoverableError(error);
         return;
       } finally {
         sentryClient?.metricsAggregator?.add(
@@ -128,12 +132,13 @@ export const bundleAnalysisPluginFactory = ({
           "none",
           { bundler: unpluginMetaContext.framework },
         );
-      } catch {
+      } catch (error) {
         sentryClient?.metricsAggregator?.add(
           "c",
           "upload_bundle_stats.error",
           1,
         );
+        handleRecoverableError(error);
         return;
       } finally {
         sentryClient?.metricsAggregator?.add(

packages/bundler-plugin-core/src/index.ts

@@ -43,11 +43,6 @@ function codecovUnpluginFactory({
 
     const options = normalizedOptions.options;
 
-    const { sentryClient } = createSentryInstance(
-      options,
-      unpluginMetaContext.framework,
-    );
-
     if (!satisfies(process.version, NODE_VERSION_RANGE)) {
       red(
         `Codecov ${unpluginMetaContext.framework} bundler plugin requires Node.js ${NODE_VERSION_RANGE}. You are using Node.js ${process.version}. Please upgrade your Node.js version.`,
@@ -56,13 +51,56 @@ function codecovUnpluginFactory({
       return plugins;
     }
 
+    const { sentryClient } = createSentryInstance(
+      options,
+      unpluginMetaContext.framework,
+    );
+
+    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;
+      }
+    });
+
+    function handleRecoverableError(unknownError: unknown) {
+      if (sentrySession) {
+        sentrySession.status = "abnormal";
+        try {
+          if (options.errorHandler) {
+            try {
+              if (unknownError instanceof Error) {
+                options.errorHandler(unknownError);
+              } else {
+                options.errorHandler(new Error("An unknown error occurred"));
+              }
+            } catch (e) {
+              sentrySession.status = "crashed";
+              throw e;
+            }
+          } else {
+            sentrySession.status = "crashed";
+            throw unknownError;
+          }
+        } finally {
+          sentryHub?.endSession();
+        }
+      }
+    }
+
     if (options?.enableBundleAnalysis) {
       plugins.push(
         bundleAnalysisPluginFactory({
           options,
           unpluginMetaContext,
           bundleAnalysisUploadPlugin,
           sentryClient,
+          handleRecoverableError,
         }),
       );
     }

packages/bundler-plugin-core/src/sentry.ts

@@ -19,12 +19,16 @@ export const createSentryInstance = (
   const telemetry = options.telemetry ?? true;
 
   if (telemetry === false || !!options.dryRun) {
-    return { sentryClient: undefined };
+    return { sentryClient: undefined, sentryHub: undefined };
   }
 
   const client = new NodeClient({
     dsn: "https://[email protected]/4506739665207296",
 
+    _experiments: {
+      metricsAggregator: true,
+    },
+
     tracesSampleRate: 1,
     sampleRate: 1,
 
@@ -71,7 +75,7 @@ export const createSentryInstance = (
   // increment the counter for the bundler
   client.metricsAggregator?.add("c", `bundler-${bundler}`, 1);
 
-  return { sentryClient: client };
+  return { sentryClient: client, sentryHub: hub };
 };
 
 export const setTelemetryDataOnHub = (

packages/bundler-plugin-core/src/types.ts

@@ -116,6 +116,24 @@ export interface Options {
    */
   telemetry?: boolean;
 
+  /**
+   * When an error occurs during release creation or sourcemaps upload, the plugin will call this
+   * function.
+   *
+   * By default, the plugin will simply throw an error, thereby stopping the bundling process. If an
+   * `errorHandler` callback is provided, compilation will continue, unless an error is thrown in
+   * the provided callback.
+   *
+   * To allow compilation to continue but still emit a warning, set this option to the following:
+   *
+   * ```js
+   * (err) => {
+   *   console.warn(err);
+   * }
+   * ```
+   */
+  errorHandler?: (err: Error) => void;
+
   sentry?: {
     /**
      * Only send bundle stats to sentry (used within sentry bundler plugin).