keep runtimeError out of shortSummary

Author: jackbrewer

src/format.js

@@ -33,47 +33,35 @@ const getError = (id, expected, categories, audits) => {
   return { message: categoryError, details: categoryAudits };
 };
 
-const formatShortSummary = ({ categories, runtimeError }) => {
-  if (runtimeError) {
-    return runtimeError.message;
-  }
+const formatShortSummary = (categories) => {
   return categories
     .map(({ title, score }) => `${title}: ${Math.round(score * 100)}`)
     .join(', ');
 };
 
 const formatResults = ({ results, thresholds }) => {
-  const hasScores = !results.lhr.runtimeError;
+  const runtimeError = results.lhr.runtimeError;
 
   const categories = Object.values(results.lhr.categories).map(
     ({ title, score, id, auditRefs }) => ({ title, score, id, auditRefs }),
   );
 
-  const categoriesBelowThreshold =
-    hasScores &&
-    Object.entries(thresholds).filter(([id, expected]) =>
-      belowThreshold(id, expected, categories),
-    );
-
-  const errors =
-    hasScores &&
-    categoriesBelowThreshold.map(([id, expected]) =>
-      getError(id, expected, categories, results.lhr.audits),
-    );
-
-  const summary =
-    hasScores &&
-    categories.map(({ title, score, id }) => ({
-      title,
-      score,
-      id,
-      ...(thresholds[id] ? { threshold: thresholds[id] } : {}),
-    }));
-
-  const shortSummary = formatShortSummary({
-    categories,
-    runtimeError: results.lhr.runtimeError,
-  });
+  const categoriesBelowThreshold = Object.entries(thresholds).filter(
+    ([id, expected]) => belowThreshold(id, expected, categories),
+  );
+
+  const errors = categoriesBelowThreshold.map(([id, expected]) =>
+    getError(id, expected, categories, results.lhr.audits),
+  );
+
+  const summary = categories.map(({ title, score, id }) => ({
+    title,
+    score,
+    id,
+    ...(thresholds[id] ? { threshold: thresholds[id] } : {}),
+  }));
+
+  const shortSummary = formatShortSummary(categories);
 
   const formattedReport = makeReplacements(results.report);
 
@@ -92,7 +80,7 @@ const formatResults = ({ results, thresholds }) => {
     minifyJS: true,
   });
 
-  return { summary, shortSummary, details, report, errors };
+  return { summary, shortSummary, details, report, errors, runtimeError };
 };
 
 module.exports = {

src/format.test.js

@@ -106,25 +106,13 @@ describe('format', () => {
       { title: 'SEO', score: 0.7, id: 'seo' },
       { title: 'PWA', score: 0.6, id: 'pwa' },
     ];
-    const runtimeError = {
-      code: 'NO_FCP',
-      message:
-        'The page did not paint any content. Please ensure you keep the browser window in the foreground during the load and try again. (NO_FCP)',
-    };
 
     it('should return a shortSummary containing scores if available', () => {
-      const shortSummary = formatShortSummary({ categories });
+      const shortSummary = formatShortSummary(categories);
       expect(shortSummary).toEqual(
         'Performance: 100, Accessibility: 90, Best Practices: 80, SEO: 70, PWA: 60',
       );
     });
-
-    it('should return a shortSummary error message', () => {
-      const shortSummary = formatShortSummary({
-        runtimeError,
-      });
-      expect(shortSummary).toEqual(runtimeError.message);
-    });
   });
 
   describe('formatResults', () => {

src/index.js

@@ -52,13 +52,21 @@ const persistResults = async ({ report, path }) => {
 };
 
 const getUtils = ({ utils }) => {
+  // This function checks to see if we're running within the Netlify Build system,
+  // and if so, we use the util functions. If not, we're likely running locally
+  // so fall back using console.log to emulate the output.
+
+  // If available, fails the Netlify build with the supplied message
+  // https://docs.netlify.com/integrations/build-plugins/create-plugins/#error-reporting
   const failBuild =
     (utils && utils.build && utils.build.failBuild) ||
     ((message, { error } = {}) => {
       console.error(message, error && error.message);
       process.exitCode = 1;
     });
 
+  // If available, displays the summary in the Netlify UI Deploy Summary section
+  // https://docs.netlify.com/integrations/build-plugins/create-plugins/#logging
   const show =
     (utils && utils.status && utils.status.show) ||
     (({ summary }) => console.log(summary));
@@ -94,10 +102,11 @@ const runAudit = async ({
     if (error) {
       return { error };
     } else {
-      const { summary, shortSummary, details, report, errors } = formatResults({
-        results,
-        thresholds,
-      });
+      const { summary, shortSummary, details, report, errors, runtimeError } =
+        formatResults({
+          results,
+          thresholds,
+        });
 
       if (output_path) {
         await persistResults({ report, path: join(serveDir, output_path) });
@@ -109,6 +118,7 @@ const runAudit = async ({
         details,
         report,
         errors,
+        runtimeError,
       };
     }
   } catch (error) {
@@ -161,28 +171,45 @@ const processResults = ({ data, errors }) => {
   return {
     error: err,
     summary: data
-      .map(({ path, url, summary, shortSummary, details, report }) => {
-        const obj = { report, details };
+      .map(
+        ({
+          path,
+          url,
+          summary,
+          shortSummary,
+          details,
+          report,
+          runtimeError,
+        }) => {
+          const obj = { report, details };
 
-        if (summary) {
-          obj.summary = summary.reduce((acc, item) => {
-            acc[item.id] = Math.round(item.score * 100);
-            return acc;
-          }, {});
-        }
+          if (!runtimeError && summary) {
+            obj.summary = summary.reduce((acc, item) => {
+              acc[item.id] = Math.round(item.score * 100);
+              return acc;
+            }, {});
+          }
 
-        if (path) {
-          obj.path = path;
-          reports.push(obj);
-          return `Summary for path '${chalk.magenta(path)}': ${shortSummary}`;
-        }
-        if (url) {
-          obj.url = url;
-          reports.push(obj);
-          return `Summary for url '${chalk.magenta(url)}': ${shortSummary}`;
-        }
-        return `${shortSummary}`;
-      })
+          if (runtimeError) {
+            reports.push(obj);
+            return `Error testing '${chalk.magenta(path || url)}': ${
+              runtimeError.message
+            }`;
+          }
+
+          if (path) {
+            obj.path = path;
+            reports.push(obj);
+            return `Summary for path '${chalk.magenta(path)}': ${shortSummary}`;
+          }
+          if (url) {
+            obj.url = url;
+            reports.push(obj);
+            return `Summary for url '${chalk.magenta(url)}': ${shortSummary}`;
+          }
+          return `${shortSummary}`;
+        },
+      )
       .join('\n'),
     extraData: reports,
   };
@@ -204,7 +231,7 @@ module.exports = {
       const allErrors = [];
       const data = [];
       for (const { serveDir, path, url, thresholds, output_path } of audits) {
-        const { errors, summary, shortSummary, details, report } =
+        const { errors, summary, shortSummary, details, report, runtimeError } =
           await runAudit({
             serveDir,
             path,
@@ -213,9 +240,13 @@ module.exports = {
             output_path,
             settings,
           });
-        if (summary) {
+
+        if (summary && !runtimeError) {
           console.log({ results: summary });
         }
+        if (runtimeError) {
+          console.log({ runtimeError });
+        }
 
         const fullPath = [serveDir, path].join('/');
         if (report) {
@@ -239,6 +270,7 @@ module.exports = {
           shortSummary,
           details,
           report,
+          runtimeError,
         });
       }