Optionally run onSuccess (#558)

Reworks internal logic to allow running against either onPostBuild, or onSuccess

Author: jackbrewer

.gitignore

@@ -2,6 +2,8 @@ node_modules
 .env
 .vscode
 yarn-error.log
+.DS_Store
+
 # Local Netlify folder
 .netlify
 reports

manifest.yml

@@ -1,5 +1,9 @@
 name: netlify-plugin-lighthouse
 inputs:
+  - name: audits
+    required: false
+    description: A list of audits to perform. Each list item is an object with either a url/path to scan and an optional thresholds mapping.
+
   # Deprecated, use audits
   - name: audit_url
     required: false
@@ -13,10 +17,10 @@ inputs:
     required: false
     description: Path to save the generated HTML Lighthouse report
 
-  - name: audits
-    required: false
-    description: A list of audits to perform. Each list item is an object with either a url/path to scan and an optional thresholds mapping.
-
   - name: settings
     required: false
     description: Lighthouse-specific settings, used to modify reporting criteria
+
+  - name: run_on_success
+    required: false
+    description: (Beta) Run Lighthouse against the deployed site

package.json

@@ -4,7 +4,8 @@
   "description": "Netlify Plugin to run Lighthouse on each build",
   "main": "src/index.js",
   "scripts": {
-    "local": "node -e 'import(\"./src/index.js\").then(index => index.onPostBuild());'",
+    "local": "node -e 'import(\"./src/index.js\").then(index => index.default()).then(events => events.onPostBuild());'",
+    "local-onsuccess": "RUN_ON_SUCCESS=true node -e 'import(\"./src/index.js\").then(index => index.default()).then(events => events.onSuccess());'",
     "lint": "eslint 'src/**/*.js'",
     "format": "prettier --write 'src/**/*.js'",
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --collect-coverage",

src/index.js

@@ -1,95 +1,46 @@
-import chalk from 'chalk';
 import * as dotenv from 'dotenv';
 
-import processResults from './lib/process-results/index.js';
+import runEvent from './lib/run-event/index.js';
 import getUtils from './lib/get-utils/index.js';
-import getConfiguration from './lib/get-configuration/index.js';
-import getSettings from './lib/get-settings/index.js';
-import runAudit from './lib/run-audit/index.js';
 
 dotenv.config();
 
-export const onPostBuild = async ({ constants, utils, inputs } = {}) => {
-  const { failBuild, show } = getUtils({ utils });
-  let errorMetadata = [];
-
-  try {
-    const { audits } = getConfiguration({
-      constants,
-      inputs,
-    });
-
-    const settings = getSettings(inputs?.settings);
-
-    const allErrors = [];
-    const data = [];
-    for (const { serveDir, path, url, thresholds, output_path } of audits) {
-      const { errors, summary, shortSummary, details, report, runtimeError } =
-        await runAudit({
-          serveDir,
-          path,
-          url,
-          thresholds,
-          output_path,
-          settings,
+export default function lighthousePlugin(inputs) {
+  // Run onPostBuild by default, unless RUN_ON_SUCCESS is set to true
+  const defaultEvent =
+    inputs?.run_on_success === 'true' || process.env.RUN_ON_SUCCESS === 'true'
+      ? 'onSuccess'
+      : 'onPostBuild';
+
+  if (defaultEvent === 'onSuccess') {
+    return {
+      onSuccess: async ({ constants, utils, inputs } = {}) => {
+        // Mock the required `utils` functions if running locally
+        const { failPlugin, show } = getUtils({ utils });
+
+        await runEvent({
+          event: 'onSuccess',
+          constants,
+          inputs,
+          onComplete: show,
+          onFail: failPlugin,
         });
-
-      if (summary && !runtimeError) {
-        console.log({ results: summary });
-      }
-      if (runtimeError) {
-        console.log({ runtimeError });
-      }
-
-      const fullPath = [serveDir, path].join('/');
-      if (report) {
-        const size = Buffer.byteLength(JSON.stringify(report));
-        console.log(
-          `Report collected: audited_uri: '${chalk.magenta(
-            url || fullPath,
-          )}', html_report_size: ${chalk.magenta(
-            +(size / 1024).toFixed(2),
-          )} KiB`,
-        );
-      }
-
-      if (Array.isArray(errors) && errors.length > 0) {
-        allErrors.push({ serveDir, url, errors });
-      }
-      data.push({
-        path: fullPath,
-        url,
-        summary,
-        shortSummary,
-        details,
-        report,
-        runtimeError,
-      });
-    }
-
-    const { error, summary, extraData } = processResults({
-      data,
-      errors: allErrors,
-      show,
-    });
-    errorMetadata.push(...extraData);
-
-    if (error && Object.keys(error).length !== 0) {
-      throw error;
-    }
-
-    show({ summary, extraData });
-  } catch (error) {
-    if (error.details) {
-      console.error(error.details);
-      failBuild(`${chalk.red('Failed with error:\n')}${error.message}`, {
-        errorMetadata,
-      });
-    } else {
-      failBuild(`${chalk.red('Failed with error:\n')}`, {
-        error,
-        errorMetadata,
-      });
-    }
+      },
+    };
+  } else {
+    return {
+      onPostBuild: async ({ constants, utils, inputs } = {}) => {
+        // Mock the required `utils` functions if running locally
+        const { failBuild, show } = getUtils({ utils });
+
+        await runEvent({
+          event: 'onPostBuild',
+          constants,
+          inputs,
+          onComplete: show,
+          onFail: failBuild,
+        });
+      },
+    };
   }
-};
+}

src/lib/get-configuration/get-configuration.test.js

@@ -23,7 +23,7 @@ describe('config', () => {
     const config = getConfiguration();
 
     expect(config).toEqual({
-      audits: [
+      auditConfigs: [
         {
           serveDir: undefined,
           url: undefined,
@@ -40,7 +40,7 @@ describe('config', () => {
     const config = getConfiguration();
 
     expect(config).toEqual({
-      audits: [
+      auditConfigs: [
         {
           serveDir: 'PUBLISH_DIR',
           url: 'AUDIT_URL',
@@ -59,7 +59,7 @@ describe('config', () => {
     const config = getConfiguration();
 
     expect(config).toEqual({
-      audits: [
+      auditConfigs: [
         {
           url: 'https://www.test.com',
           thresholds: { performance: 0.9 },
@@ -93,7 +93,7 @@ describe('config', () => {
     const config = getConfiguration({ constants, inputs });
 
     expect(config).toEqual({
-      audits: [
+      auditConfigs: [
         {
           serveDir: 'PUBLISH_DIR',
           url: 'url',
@@ -106,11 +106,15 @@ describe('config', () => {
 
   it('should append audits serveDir to PUBLISH_DIR', () => {
     const constants = { PUBLISH_DIR: 'PUBLISH_DIR' };
-    const inputs = { audits: [{ serveDir: 'route1', thresholds: { seo: 1 } }] };
+    const inputs = {
+      audits: [{ serveDir: 'route1', thresholds: { seo: 1 } }],
+    };
     const config = getConfiguration({ constants, inputs });
 
     expect(config).toEqual({
-      audits: [{ serveDir: 'PUBLISH_DIR/route1', thresholds: { seo: 1 } }],
+      auditConfigs: [
+        { serveDir: 'PUBLISH_DIR/route1', thresholds: { seo: 1 } },
+      ],
     });
   });
 
@@ -126,7 +130,7 @@ describe('config', () => {
     const config = getConfiguration({ constants, inputs });
 
     expect(config).toEqual({
-      audits: [
+      auditConfigs: [
         { serveDir: 'PUBLISH_DIR/route1', thresholds: { seo: 1 } },
         { serveDir: 'PUBLISH_DIR/route2', thresholds: { performance: 1 } },
       ],
@@ -156,7 +160,7 @@ describe('config', () => {
     const config = getConfiguration({ constants, inputs });
 
     expect(config).toEqual({
-      audits: [{ serveDir: 'PUBLISH_DIR/a/b', thresholds: {} }],
+      auditConfigs: [{ serveDir: 'PUBLISH_DIR/a/b', thresholds: {} }],
     });
   });
 
@@ -196,7 +200,7 @@ describe('config', () => {
     const config = getConfiguration({ constants, inputs });
 
     expect(config).toEqual({
-      audits: [
+      auditConfigs: [
         {
           serveDir: 'PUBLISH_DIR/route1',
           output_path: 'reports/lighthouse.html',

src/lib/get-configuration/index.js

@@ -2,14 +2,14 @@ import chalk from 'chalk';
 
 import getServePath from '../get-serve-path/index.js';
 
-const getConfiguration = ({ constants, inputs } = {}) => {
+const getConfiguration = ({ constants, inputs, deployUrl } = {}) => {
+  const useDeployUrl = !!deployUrl;
+
   const serveDir =
     (constants && constants.PUBLISH_DIR) || process.env.PUBLISH_DIR;
 
   const auditUrl = (inputs && inputs.audit_url) || process.env.AUDIT_URL;
 
-  const output_path = (inputs && inputs.output_path) || process.env.OUTPUT_PATH;
-
   if (auditUrl) {
     console.warn(
       `${chalk.yellow(
@@ -18,6 +18,8 @@ const getConfiguration = ({ constants, inputs } = {}) => {
     );
   }
 
+  const output_path = (inputs && inputs.output_path) || process.env.OUTPUT_PATH;
+
   let thresholds =
     (inputs && inputs.thresholds) || process.env.THRESHOLDS || {};
 
@@ -38,20 +40,37 @@ const getConfiguration = ({ constants, inputs } = {}) => {
     }
   }
 
+  let auditConfigs = [];
+
+  /** TODO: Simplify this…
+   *  When using a deployUrl (testing against the live deployed site), we don't
+   *  need to serve the site, so we can skip the serveDir and output_path
+   */
+
   if (!Array.isArray(audits)) {
-    audits = [{ serveDir, url: auditUrl, thresholds, output_path }];
+    auditConfigs = [
+      {
+        serveDir: useDeployUrl ? undefined : serveDir,
+        url: useDeployUrl ? deployUrl : auditUrl,
+        thresholds,
+        output_path: useDeployUrl ? undefined : output_path,
+      },
+    ];
   } else {
-    audits = audits.map((a) => {
+    auditConfigs = audits.map((a) => {
       return {
         ...a,
         thresholds: a.thresholds || thresholds,
-        output_path: a.output_path || output_path,
-        ...getServePath(serveDir, a.serveDir ?? ''),
+        output_path: useDeployUrl ? undefined : a.output_path || output_path,
+        url: useDeployUrl ? deployUrl : a.url,
+        serveDir: useDeployUrl
+          ? undefined
+          : getServePath(serveDir, a.serveDir ?? ''),
       };
     });
   }
 
-  return { audits };
+  return { auditConfigs };
 };
 
 export default getConfiguration;

src/lib/get-serve-path/get-serve-path.test.js

@@ -2,16 +2,14 @@ import getServePath from '.';
 
 describe('getServePath', () => {
   it('returns undefined for dir thats not a string', () => {
-    expect(getServePath(2)).toEqual({ serveDir: undefined });
+    expect(getServePath(2)).toEqual(undefined);
   });
 
   it('returns undefined for subdir thats not a string', () => {
-    expect(getServePath(2, 2)).toEqual({ serveDir: undefined });
+    expect(getServePath(2, 2)).toEqual(undefined);
   });
 
   it('returns joined path for serveDir', () => {
-    expect(getServePath('example', 'path')).toEqual({
-      serveDir: 'example/path',
-    });
+    expect(getServePath('example', 'path')).toEqual('example/path');
   });
 });

src/lib/get-serve-path/index.js

@@ -4,7 +4,7 @@ import chalk from 'chalk';
 
 const getServePath = (dir, subDir) => {
   if (typeof subDir !== 'string' || typeof dir !== 'string') {
-    return { serveDir: undefined };
+    return undefined;
   }
 
   const resolvedPath = join(dir, subDir);
@@ -18,7 +18,7 @@ const getServePath = (dir, subDir) => {
     );
   }
 
-  return { serveDir: resolvedPath };
+  return resolvedPath;
 };
 
 export default getServePath;