feat: support multiple audits urls and paths (#45)

erezrokah · web-flow · commit 74dd46d5e36b · 2020-07-12T16:57:40.000+03:00
diff --git a/.env.example b/.env.example
@@ -1,6 +1,6 @@
-# Url to audit
-AUDIT_URL=https://www.example.com
-# Ignored when AUDIT_URL is configured
+# Audits
+AUDITS=[{"url":"https://www.example.com","thresholds":{"performance":0.5}},{"path":""},{"path":"route1"},{"path":"route2"}]
+# Ignored when a url is configured for an audit
 PUBLISH_DIR=FULL_PATH_TO_LOCAL_BUILD_DIRECTORY
 # JSON string of thresholds to enforce
 THRESHOLDS={"performance":0.9,"accessibility":0.9,"best-practices":0.9,"seo":0.9,"pwa":0.9}
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -3,6 +3,7 @@ module.exports = {
     commonjs: true,
     es6: true,
     node: true,
+    jest: true,
   },
   extends: 'eslint:recommended',
   globals: {
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -40,3 +40,5 @@ jobs:
         run: yarn lint
       - name: check formatting
         run: yarn format:ci
+      - name: run tests
+        run: yarn test
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,6 @@
 node_modules
 .env
 .vscode
-yarn-error.log
+yarn-error.log
+# Local Netlify folder
+.netlify
diff --git a/README.md b/README.md
@@ -10,14 +10,12 @@ This plugin can be included via npm. Install it as a dependency with the followi
 npm install --save "@netlify/plugin-lighthouse"
 ```
 
-To use a build plugin, create a `plugins` in your `netlify.toml` like so:
+Add the plugin to your `netlify.toml` configuration file:
 
 ```toml
 [[plugins]]
-package = "@netlify/plugin-lighthouse"
-  [plugins.inputs]
-  # optional, defaults to scanning the current built version of the site
-  audit_url = 'https://www.my-custom-site.com'
+  package = "@netlify/plugin-lighthouse"
+
   # optional, fails build when a category is below a threshold
   [plugins.inputs.thresholds]
     performance = 0.9
@@ -27,6 +25,30 @@ package = "@netlify/plugin-lighthouse"
     pwa = 0.9
 ```
 
+By default, the plugin will serve and audit the build directory of the site.
+You can customize the behavior via the `audits` input:
+
+```toml
+[[plugins]]
+  package = "@netlify/plugin-lighthouse"
+
+  [plugins.inputs.thresholds]
+    performance = 0.9
+
+  # to audit a sub path of the build directory
+  # route1 audit will use the top level thresholds
+  [[plugins.inputs.audits]]
+    path = "route1"
+
+  # to audit a specific absolute url
+  [[plugins.inputs.audits]]
+    url = "https://www.example.com"
+
+    # you can specify thresholds per audit
+    [plugins.inputs.audits.thresholds]
+      performance = 0.8
+```
+
 ## Running Locally
 
 Create a `.env` file based on the [example](.env.example) and run
diff --git a/example/route1/index.html b/example/route1/index.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>Route 1</title>
+  </head>
+  <body>
+    Route 1
+  </body>
+</html>
diff --git a/example/route2/index.html b/example/route2/index.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>Route 2</title>
+  </head>
+  <body>
+    Route 2
+  </body>
+</html>
diff --git a/manifest.yml b/manifest.yml
@@ -1,8 +1,14 @@
 name: netlify-plugin-lighthouse
 inputs:
+  # Deprecated, use audits
   - name: audit_url
     required: false
     description: Url of the site to audit, defaults to scanning the current built version of the site
+
   - name: thresholds
     required: false
-    description: Key value mapping of thresholds that will fail the build when not passed
+    description: Key value mapping of thresholds that will fail the build when not passed.
+
+  - 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.
diff --git a/netlify.toml b/netlify.toml
@@ -7,10 +7,15 @@
     YARN_VERSION = "1.22.4"
     
 [[plugins]]
-package = "./src/index.js"
+  package = "./src/index.js"
+
   [plugins.inputs.thresholds]
     performance = 0.9
-    accessibility = 0.9
-    best-practices = 0.9
-    seo = 0.9
-    pwa = 0.9
+
+  [[plugins.inputs.audits]]
+    path = "route1"
+  [[plugins.inputs.audits]]
+    path = "route2"
+  [[plugins.inputs.audits]]
+    path = ""
+    
diff --git a/package.json b/package.json
@@ -7,6 +7,7 @@
     "local": "node -e 'require(\"./src/index.js\").onSuccess()'",
     "lint": "eslint 'src/**/*.js'",
     "format": "prettier --write 'src/**/*.js'",
+    "test": "jest",
     "format:ci": "prettier --check 'src/**/*.js'",
     "release": "HUSKY_SKIP_HOOKS=1 CI=true semantic-release && npm publish"
   },
@@ -46,6 +47,7 @@
     "@semantic-release/git": "^9.0.0",
     "eslint": "^7.0.0",
     "husky": "^4.0.7",
+    "jest": "^26.1.0",
     "prettier": "^2.0.0",
     "semantic-release": "^17.0.8"
   },
diff --git a/src/config.js b/src/config.js
@@ -0,0 +1,66 @@
+const chalk = require('chalk');
+const { join } = require('path');
+
+const getServePath = (dir, path) => {
+  if (typeof path !== 'string' || typeof dir !== 'string') {
+    return { path: undefined };
+  }
+
+  const resolvedPath = join(dir, path);
+  if (!resolvedPath.startsWith(dir)) {
+    throw new Error(
+      chalk.red(
+        `resolved path for ${chalk.red(
+          path,
+        )} is outside publish directory ${chalk.red(dir)}`,
+      ),
+    );
+  }
+
+  return { path: resolvedPath };
+};
+
+const getConfiguration = ({ constants, inputs } = {}) => {
+  const serveDir =
+    (constants && constants.PUBLISH_DIR) || process.env.PUBLISH_DIR;
+
+  const auditUrl = (inputs && inputs.audit_url) || process.env.AUDIT_URL;
+
+  if (auditUrl) {
+    console.warn(
+      `${chalk.yellow(
+        'inputs.audit_url',
+      )} is deprecated, please use ${chalk.green('inputs.audits')}`,
+    );
+  }
+
+  let thresholds =
+    (inputs && inputs.thresholds) || process.env.THRESHOLDS || {};
+
+  if (typeof thresholds === 'string') {
+    thresholds = JSON.parse(thresholds);
+  }
+
+  let audits = (inputs && inputs.audits) || process.env.AUDITS;
+  if (typeof audits === 'string') {
+    audits = JSON.parse(audits);
+  }
+
+  if (!Array.isArray(audits)) {
+    audits = [{ path: serveDir, url: auditUrl, thresholds }];
+  } else {
+    audits = audits.map((a) => {
+      return {
+        ...a,
+        thresholds: a.thresholds || thresholds,
+        ...getServePath(serveDir, a.path),
+      };
+    });
+  }
+
+  return { audits };
+};
+
+module.exports = {
+  getConfiguration,
+};
diff --git a/src/config.test.js b/src/config.test.js
@@ -0,0 +1,140 @@
+const { getConfiguration } = require('./config');
+
+jest.spyOn(console, 'warn').mockImplementation(() => {});
+jest.mock('chalk', () => {
+  return {
+    green: (m) => m,
+    yellow: (m) => m,
+    red: (m) => m,
+  };
+});
+
+describe('config', () => {
+  beforeEach(() => {
+    delete process.env.PUBLISH_DIR;
+    delete process.env.AUDIT_URL;
+    delete process.env.THRESHOLDS;
+    delete process.env.AUDITS;
+    jest.clearAllMocks();
+  });
+  it('should empty config when constants, inputs are undefined', () => {
+    const config = getConfiguration();
+
+    expect(config).toEqual({
+      audits: [
+        {
+          path: undefined,
+          url: undefined,
+          thresholds: {},
+        },
+      ],
+    });
+  });
+
+  it('should return config from process.env when constants, inputs are undefined', () => {
+    process.env.PUBLISH_DIR = 'PUBLISH_DIR';
+    process.env.AUDIT_URL = 'AUDIT_URL';
+    process.env.THRESHOLDS = JSON.stringify({ performance: 0.9 });
+    const config = getConfiguration();
+
+    expect(config).toEqual({
+      audits: [
+        {
+          path: 'PUBLISH_DIR',
+          url: 'AUDIT_URL',
+          thresholds: { performance: 0.9 },
+        },
+      ],
+    });
+  });
+
+  it('should return config from process.env.AUDITS', () => {
+    process.env.PUBLISH_DIR = 'PUBLISH_DIR';
+    process.env.AUDITS = JSON.stringify([
+      { url: 'https://www.test.com', thresholds: { performance: 0.9 } },
+      { path: 'route1', thresholds: { seo: 0.9 } },
+    ]);
+    const config = getConfiguration();
+
+    expect(config).toEqual({
+      audits: [
+        { url: 'https://www.test.com', thresholds: { performance: 0.9 } },
+        { path: 'PUBLISH_DIR/route1', thresholds: { seo: 0.9 } },
+      ],
+    });
+  });
+
+  it('should print deprecated warning when using audit_url', () => {
+    const constants = {};
+    const inputs = { audit_url: 'url' };
+    getConfiguration({ constants, inputs });
+
+    expect(console.warn).toHaveBeenCalledTimes(1);
+    expect(console.warn).toHaveBeenCalledWith(
+      'inputs.audit_url is deprecated, please use inputs.audits',
+    );
+  });
+
+  it('should return config from constants and inputs', () => {
+    const constants = { PUBLISH_DIR: 'PUBLISH_DIR' };
+    const inputs = { audit_url: 'url', thresholds: { seo: 1 } };
+    const config = getConfiguration({ constants, inputs });
+
+    expect(config).toEqual({
+      audits: [{ path: 'PUBLISH_DIR', url: 'url', thresholds: { seo: 1 } }],
+    });
+  });
+
+  it('should append audits path to PUBLISH_DIR', () => {
+    const constants = { PUBLISH_DIR: 'PUBLISH_DIR' };
+    const inputs = { audits: [{ path: 'route1', thresholds: { seo: 1 } }] };
+    const config = getConfiguration({ constants, inputs });
+
+    expect(config).toEqual({
+      audits: [{ path: 'PUBLISH_DIR/route1', thresholds: { seo: 1 } }],
+    });
+  });
+
+  it('should use default thresholds when no audit thresholds is configured', () => {
+    const constants = { PUBLISH_DIR: 'PUBLISH_DIR' };
+    const inputs = {
+      thresholds: { performance: 1 },
+      audits: [{ path: 'route1', thresholds: { seo: 1 } }, { path: 'route2' }],
+    };
+    const config = getConfiguration({ constants, inputs });
+
+    expect(config).toEqual({
+      audits: [
+        { path: 'PUBLISH_DIR/route1', thresholds: { seo: 1 } },
+        { path: 'PUBLISH_DIR/route2', thresholds: { performance: 1 } },
+      ],
+    });
+  });
+
+  it('should throw error on path traversal', () => {
+    const constants = { PUBLISH_DIR: 'PUBLISH_DIR' };
+    const inputs = {
+      thresholds: { performance: 1 },
+      audits: [{ path: '../' }],
+    };
+
+    expect(() => getConfiguration({ constants, inputs })).toThrow(
+      new Error(
+        'resolved path for ../ is outside publish directory PUBLISH_DIR',
+      ),
+    );
+  });
+
+  it('should treat audit path as relative path', () => {
+    const constants = { PUBLISH_DIR: 'PUBLISH_DIR' };
+    const inputs = {
+      audits: [{ path: '/a/b' }],
+    };
+
+    const config = getConfiguration({ constants, inputs });
+
+    expect(config).toEqual({
+      audits: [{ path: 'PUBLISH_DIR/a/b', thresholds: {} }],
+    });
+  });
+});
diff --git a/src/index.js b/src/index.js
diff --git a/yarn.lock b/yarn.lock
