feat(calculate-results): Add better failure messages (#80)

Provide a meaningful reason for the failure

bin/cli

@@ -16,11 +16,9 @@ const chalk = require('chalk');
 const updateNotifier = require('update-notifier');
 const pkg = require('../package.json');
 
-const { scoreReducer } = require('../lib/helpers');
-const { getScores, getChromeFlags } = require('../lib/config');
+const { getChromeFlags } = require('../lib/config');
 const lighthouseReporter = require('../lib/lighthouse-reporter');
-const analyzeScore = require('../lib/score-analyzer');
-const analyzeBudgets = require('../lib/budgets-analyzer');
+const { calculateResults } = require('../lib/calculate-results');
 
 const spinner = ora({
   color: 'yellow',
@@ -192,7 +190,7 @@ Promise.resolve()
 
     if (!silent) {
       for (const category in categoryReport) {
-        if (!categoryReport[category]) {
+        if (typeof categoryReport[category] === 'undefined') {
           continue;
         }
 
@@ -213,30 +211,26 @@ Promise.resolve()
     return { categoryReport, budgetsReport };
   })
   .then(({ categoryReport, budgetsReport }) => {
-    let thresholds = scoreReducer(flags, getScores());
-
-    thresholds =
-      Object.keys(thresholds).length === 0
-        ? {
-            score: 100,
-          }
-        : thresholds;
-
-    if (thresholds && Object.keys(thresholds).length !== 0) {
-      const isScorePassing = analyzeScore(categoryReport, thresholds);
-      const areBudgetsPassing = analyzeBudgets(budgetsReport, failOnBudgets);
-
-      if (isScorePassing && areBudgetsPassing) {
-        console.log(chalk.green('All checks are passing. 🎉\n'));
-        return process.exit(0);
-      }
+    const result = calculateResults(flags, categoryReport, budgetsReport, failOnBudgets);
+
+    if (result.passed) {
+      console.log(chalk.green('\nAll checks are passing. 🎉\n'));
+      return process.exit(0);
+    }
+
+    console.log(chalk.red('\nFailed. ❌'));
+
+    if (result.score === false) {
+      throw new Error('Target score not reached.');
+    }
+    if (result.budget === false) {
+      throw new Error('Target budget not reached.');
     }
 
-    console.log(chalk.red('Failed. ❌\n'));
     throw new Error('lighthouse-ci test failed.');
   })
-  .catch(err => {
+  .catch((err) => {
     spinner.stop();
-    console.log(chalk.red(err));
+    console.log(chalk.red(err), '\n');
     return process.exit(1);
   });

lib/calculate-results.js

@@ -0,0 +1,46 @@
+/**
+ *  Copyright (c) 2018-2020 AndreaSonny <[email protected]> (https://github.com/andreasonny83)
+ *
+ * This software is released under the MIT License.
+ * https://opensource.org/licenses/MIT
+ */
+
+const { scoreReducer } = require('./helpers');
+const analyzeScore = require('./score-analyzer');
+const analyzeBudgets = require('./budgets-analyzer');
+const { getScores } = require('./config');
+
+const calculateResults = (flags, categoryReport, budgetsReport, failOnBudgets) => {
+  let thresholds = scoreReducer(flags, getScores());
+  thresholds =
+    Object.keys(thresholds).length === 0
+      ? {
+          score: 100,
+        }
+      : thresholds;
+
+  if (thresholds && Object.keys(thresholds).length !== 0) {
+    const isScorePassing = analyzeScore(categoryReport, thresholds);
+    const areBudgetsPassing = analyzeBudgets(budgetsReport, failOnBudgets);
+
+    if (isScorePassing && areBudgetsPassing) {
+      return {
+        passed: true,
+      };
+    }
+
+    return {
+      passed: false,
+      score: isScorePassing,
+      budget: areBudgetsPassing,
+    };
+  }
+
+  return {
+    passed: false,
+  };
+};
+
+module.exports = {
+  calculateResults,
+};