core: report artifact error when collected, add err.extra (#15258)

GoogleChrome · Jul 14, 2023 · bef3df9 · bef3df9
1 parent 376db8f
commit bef3df9
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 9 deletions.
diff --git a/core/gather/runner-helpers.js b/core/gather/runner-helpers.js
@@ -25,6 +25,8 @@
 
 import log from 'lighthouse-logger';
 
+import {Sentry} from '../lib/sentry.js';
+
 /**
  *
  * @param {{id: string}} dependency
@@ -115,7 +117,13 @@ async function collectPhaseArtifacts(options) {
       return artifact;
     });
 
-    await artifactPromise.catch(() => {});
+    await artifactPromise.catch((err) => {
+      Sentry.captureException(err, {
+        tags: {gatherer: artifactDefn.id, phase},
+        level: 'error',
+      });
+      log.error(artifactDefn.id, err.message);
+    });
     artifactState[phase][artifactDefn.id] = artifactPromise;
   }
 }

diff --git a/core/lib/sentry.js b/core/lib/sentry.js
@@ -126,9 +126,16 @@ async function init(opts) {
         if (opts.tags) {
           scope.setTags(opts.tags);
         }
-        if (opts.extra) {
-          scope.setExtras(opts.extra);
+
+        // Add extra details
+        let extra;
+        if (opts.extra) extra = {...opts.extra};
+        // @ts-expect-error Non-standard property
+        if (err.extra) extra = {...extra, ...err.extra};
+        if (extra) {
+          scope.setExtras(extra);
         }
+
         Sentry.captureException(err);
       });
     };

diff --git a/core/runner.js b/core/runner.js
@@ -390,15 +390,11 @@ class Runner {
           // @ts-expect-error: TODO why is this a type error now?
           const artifactError = artifacts[artifactName];
 
-          Sentry.captureException(artifactError, {
-            tags: {gatherer: artifactName},
-            level: 'error',
-          });
-
           log.warn('Runner', `${artifactName} gatherer, required by audit ${audit.meta.id},` +
             ` encountered an error: ${artifactError.message}`);
 
-          // Create a friendlier display error and mark it as expected to avoid duplicates in Sentry
+          // Create a friendlier display error and mark it as expected to avoid duplicates in Sentry.
+          // The artifact error was already sent to Sentry in `collectPhaseArtifacts`.
           const error = new LighthouseError(LighthouseError.errors.ERRORED_REQUIRED_ARTIFACT,
               {artifactName, errorMessage: artifactError.message}, {cause: artifactError});
           // @ts-expect-error Non-standard property added to Error