pagean 6.0.7 → 7.0.0

package/lib/tests.js

@@ -7,9 +7,9 @@
  */
 const { HTMLHint } = require('htmlhint');
 
-const { testResultStates, pageanTest } = require('./testUtils');
-const fileUtils = require('./externalFileUtils');
-const { isFailedResponse } = require('./linkUtils');
+const { testResultStates, pageanTest } = require('./test-utils');
+const fileUtils = require('./external-file-utils');
+const { isFailedResponse } = require('./link-utils');
 
 const msPerSec = 1000;
 
@@ -20,15 +20,25 @@ const msPerSec = 1000;
  * @param {object} context Test execution context.
  */
 const horizontalScrollbarTest = async (context) => {
-    // eslint-disable-next-line no-shadow -- less intuitive
-    await pageanTest('should not have a horizontal scrollbar', async (context) => {
-        // istanbul ignore next: injects script causing puppeteer error, see #48
-        const scrollbar = await context.page.evaluate(() => {
-            document.scrollingElement.scrollLeft = 1;
-            return document.scrollingElement.scrollLeft === 1;
-        });
-        return { result: scrollbar === false ? testResultStates.passed : testResultStates.failed };
-    }, context, 'horizontalScrollbarTest');
+    await pageanTest(
+        'should not have a horizontal scrollbar',
+        // eslint-disable-next-line no-shadow -- less intuitive
+        async (context) => {
+            // istanbul ignore next: injects script causing puppeteer error, see #48
+            const scrollbar = await context.page.evaluate(() => {
+                document.scrollingElement.scrollLeft = 1;
+                return document.scrollingElement.scrollLeft === 1;
+            });
+            return {
+                result:
+                    scrollbar === false
+                        ? testResultStates.passed
+                        : testResultStates.failed
+            };
+        },
+        context,
+        'horizontalScrollbarTest'
+    );
 };
 
 /**
@@ -38,14 +48,24 @@ const horizontalScrollbarTest = async (context) => {
  * @param {object} context Test execution context.
  */
 const consoleOutputTest = (context) => {
-    // eslint-disable-next-line no-shadow -- less intuitive
-    pageanTest('should not have console output', (context) => {
-        const testResult = { result: context.consoleLog.length === 0 ? testResultStates.passed : testResultStates.failed };
-        if (testResult.result === testResultStates.failed) {
-            testResult.data = context.consoleLog;
-        }
-        return testResult;
-    }, context, 'consoleOutputTest');
+    pageanTest(
+        'should not have console output',
+        // eslint-disable-next-line no-shadow -- less intuitive
+        (context) => {
+            const testResult = {
+                result:
+                    context.consoleLog.length === 0
+                        ? testResultStates.passed
+                        : testResultStates.failed
+            };
+            if (testResult.result === testResultStates.failed) {
+                testResult.data = context.consoleLog;
+            }
+            return testResult;
+        },
+        context,
+        'consoleOutputTest'
+    );
 };
 
 /**
@@ -55,17 +75,27 @@ const consoleOutputTest = (context) => {
  * @param {object} context Test execution context.
  */
 const consoleErrorTest = (context) => {
-    // eslint-disable-next-line no-shadow -- less intuitive
-    pageanTest('should not have console errors', (context) => {
-        // Object property names defined by puppeteer API
-        // eslint-disable-next-line no-underscore-dangle
-        const browserErrorLog = context.consoleLog.filter(log => log._type === 'error');
-        const testResult = { result: browserErrorLog.length === 0 ? testResultStates.passed : testResultStates.failed };
-        if (testResult.result === testResultStates.failed) {
-            testResult.data = browserErrorLog;
-        }
-        return testResult;
-    }, context, 'consoleErrorTest');
+    pageanTest(
+        'should not have console errors',
+        // eslint-disable-next-line no-shadow -- less intuitive
+        (context) => {
+            const browserErrorLog = context.consoleLog.filter(
+                (log) => log.type === 'error'
+            );
+            const testResult = {
+                result:
+                    browserErrorLog.length === 0
+                        ? testResultStates.passed
+                        : testResultStates.failed
+            };
+            if (testResult.result === testResultStates.failed) {
+                testResult.data = browserErrorLog;
+            }
+            return testResult;
+        },
+        context,
+        'consoleErrorTest'
+    );
 };
 
 /**
@@ -75,16 +105,29 @@ const consoleErrorTest = (context) => {
  * @param {object} context Test execution context.
  */
 const renderedHtmlTest = async (context) => {
-    // eslint-disable-next-line no-shadow -- less intuitive
-    await pageanTest('should have valid rendered HTML', async (context) => {
-        const html = await context.page.content();
-        const lintResults = HTMLHint.verify(html, context.urlSettings.htmlHintConfig);
-        const testResult = { result: lintResults.length === 0 ? testResultStates.passed : testResultStates.failed };
-        if (testResult.result === testResultStates.failed) {
-            testResult.data = lintResults;
-        }
-        return testResult;
-    }, context, 'renderedHtmlTest');
+    await pageanTest(
+        'should have valid rendered HTML',
+        // eslint-disable-next-line no-shadow -- less intuitive
+        async (context) => {
+            const html = await context.page.content();
+            const lintResults = HTMLHint.verify(
+                html,
+                context.urlSettings.htmlHintConfig
+            );
+            const testResult = {
+                result:
+                    lintResults.length === 0
+                        ? testResultStates.passed
+                        : testResultStates.failed
+            };
+            if (testResult.result === testResultStates.failed) {
+                testResult.data = lintResults;
+            }
+            return testResult;
+        },
+        context,
+        'renderedHtmlTest'
+    );
 };
 
 /**
@@ -93,23 +136,40 @@ const renderedHtmlTest = async (context) => {
  * @static
  * @param {object} context Test execution context.
  */
+// eslint-disable-next-line max-lines-per-function
 const pageLoadTimeTest = async (context) => {
     const testSettingName = 'pageLoadTimeTest';
-    // eslint-disable-next-line no-shadow -- less intuitive
-    await pageanTest('should load page within timeout', async (context) => {
-        const { pageLoadTimeThreshold } = context.testSettings;
-        const name = `should load page within ${pageLoadTimeThreshold} sec`;
-        // istanbul ignore next: injects script causing puppeteer error, see #48
-        const performanceTiming = JSON.parse(await context.page.evaluate(
-            () => JSON.stringify(window.performance)
-        ));
-        const loadTimeSec = (performanceTiming.timing.loadEventEnd - performanceTiming.timing.navigationStart) / msPerSec;
-        const testResult = { name, result: loadTimeSec < pageLoadTimeThreshold ? testResultStates.passed : testResultStates.failed };
-        if (testResult.result === testResultStates.failed) {
-            testResult.data = { pageLoadTime: loadTimeSec };
-        }
-        return testResult;
-    }, context, testSettingName);
+    await pageanTest(
+        'should load page within timeout',
+        // eslint-disable-next-line no-shadow -- less intuitive
+        async (context) => {
+            const { pageLoadTimeThreshold } = context.testSettings;
+            const name = `should load page within ${pageLoadTimeThreshold} sec`;
+            // istanbul ignore next: injects script causing puppeteer error, see #48
+            const performanceTiming = JSON.parse(
+                await context.page.evaluate(() =>
+                    JSON.stringify(window.performance)
+                )
+            );
+            const loadTimeSec =
+                (performanceTiming.timing.loadEventEnd -
+                    performanceTiming.timing.navigationStart) /
+                msPerSec;
+            const testResult = {
+                name,
+                result:
+                    loadTimeSec < pageLoadTimeThreshold
+                        ? testResultStates.passed
+                        : testResultStates.failed
+            };
+            if (testResult.result === testResultStates.failed) {
+                testResult.data = { pageLoadTime: loadTimeSec };
+            }
+            return testResult;
+        },
+        context,
+        testSettingName
+    );
 };
 
 /**
@@ -119,23 +179,42 @@ const pageLoadTimeTest = async (context) => {
  * @static
  * @param {object} context Test execution context.
  */
+// eslint-disable-next-line max-lines-per-function
 const externalScriptTest = async (context) => {
-    // eslint-disable-next-line no-shadow -- less intuitive
-    await pageanTest('should not have external scripts', async (context) => {
-        // istanbul ignore next: injects script causing puppeteer error, see #48
-        const scripts = await context.page.evaluate(() => {
-            return [...document.querySelectorAll('script[src]')].map(s => s.src);
-        });
+    await pageanTest(
+        'should not have external scripts',
+        // eslint-disable-next-line no-shadow -- less intuitive
+        async (context) => {
+            // istanbul ignore next: injects script causing puppeteer error, see #48
+            const scripts = await context.page.evaluate(() => {
+                return [...document.querySelectorAll('script[src]')].map(
+                    (s) => s.src
+                );
+            });
 
-        const pageUrl = context.page.url();
-        const externalScripts = scripts.filter(script => fileUtils.shouldSaveFile(script, pageUrl));
-        const scriptResults = await Promise.all(externalScripts.map(script => fileUtils.saveExternalScript(script)));
-        const testResult = { result: scriptResults.length > 0 ? testResultStates.failed : testResultStates.passed };
-        if (testResult.result === testResultStates.failed) {
-            testResult.data = scriptResults;
-        }
-        return testResult;
-    }, context, 'externalScriptTest');
+            const pageUrl = context.page.url();
+            const externalScripts = scripts.filter((script) =>
+                fileUtils.shouldSaveFile(script, pageUrl)
+            );
+            const scriptResults = await Promise.all(
+                externalScripts.map((script) =>
+                    fileUtils.saveExternalScript(script)
+                )
+            );
+            const testResult = {
+                result:
+                    scriptResults.length > 0
+                        ? testResultStates.failed
+                        : testResultStates.passed
+            };
+            if (testResult.result === testResultStates.failed) {
+                testResult.data = scriptResults;
+            }
+            return testResult;
+        },
+        context,
+        'externalScriptTest'
+    );
 };
 
 /**
@@ -144,33 +223,54 @@ const externalScriptTest = async (context) => {
  * @static
  * @param {object} context Test execution context.
  */
+// eslint-disable-next-line max-lines-per-function
 const brokenLinkTest = async (context) => {
-    // eslint-disable-next-line no-shadow -- less intuitive
-    await pageanTest('should not have broken links', async (context) => {
-        // istanbul ignore next: injects script causing puppeteer error, see #48
-        const links = await context.page.evaluate(() => {
-            return [...document.querySelectorAll('a[href]')].map(a => a.href);
-        });
+    await pageanTest(
+        'should not have broken links',
+        // eslint-disable-next-line no-shadow -- less intuitive
+        async (context) => {
+            // istanbul ignore next: injects script causing puppeteer error, see #48
+            const links = await context.page.evaluate(() => {
+                return [...document.querySelectorAll('a[href]')].map(
+                    (a) => a.href
+                );
+            });
 
-        // All links are returned from puppeteer as absolute links, so this filters out
-        // javascript and other values and leaves only pages to request.
-        const httpLinks = links.filter(link => link.match(/(http(s?)|file):\/\//));
-        // Reduce to unique page links so only checked once
-        const uniqueHttpLinks = [...new Set(httpLinks)];
+            // All links are returned from puppeteer as absolute links, so this filters out
+            // javascript and other values and leaves only pages to request.
+            const httpLinks = links.filter((link) =>
+                link.match(/(http(s?)|file):\/\//)
+            );
+            // Reduce to unique page links so only checked once
+            const uniqueHttpLinks = [...new Set(httpLinks)];
 
-        // Check each link includes check against ignored list, and if not checks
-        // both links within the page as well as to other pages
-        const linkResponses = await Promise.all(uniqueHttpLinks.map(async (link) =>
-            ({ href: link, status: await context.linkChecker.checkLink(context, link) })));
+            // Check each link includes check against ignored list, and if not checks
+            // both links within the page as well as to other pages
+            const linkResponses = await Promise.all(
+                uniqueHttpLinks.map(async (link) => ({
+                    href: link,
+                    status: await context.linkChecker.checkLink(context, link)
+                }))
+            );
 
-        // Returned results includes status for all links, so filter down to only failed
-        const failedLinkResponses = linkResponses.filter(result => isFailedResponse(result));
-        const testResult = { result: failedLinkResponses.length > 0 ? testResultStates.failed : testResultStates.passed };
-        if (testResult.result === testResultStates.failed) {
-            testResult.data = failedLinkResponses;
-        }
-        return testResult;
-    }, context, 'brokenLinkTest');
+            // Returned results includes status for all links, so filter down to only failed
+            const failedLinkResponses = linkResponses.filter((result) =>
+                isFailedResponse(result)
+            );
+            const testResult = {
+                result:
+                    failedLinkResponses.length > 0
+                        ? testResultStates.failed
+                        : testResultStates.passed
+            };
+            if (testResult.result === testResultStates.failed) {
+                testResult.data = failedLinkResponses;
+            }
+            return testResult;
+        },
+        context,
+        'brokenLinkTest'
+    );
 };
 
 module.exports.consoleErrorTest = consoleErrorTest;

package/package.json

@@ -1,22 +1,25 @@
 {
   "name": "pagean",
-  "version": "6.0.7",
+  "version": "7.0.0",
   "description": "Pagean is a web page analysis tool designed to automate tests requiring web pages to be loaded in a browser window (e.g. horizontal scrollbar, console errors)",
   "bin": {
     "pagean": "./bin/pagean.js",
     "pageanrc-lint": "./bin/pageanrc-lint.js"
   },
   "scripts": {
-    "start": "node ./bin/pagean.js",
-    "start-lint": "node ./bin/pageanrc-lint.js",
-    "start-lint-all": "npm run start-lint && npm run start-lint -c static-server.pageanrc.json && npm run start-lint -c ./lib/default-config.json",
-    "test": "jest --ci --config jest.config.json",
+    "hooks-pre-commit": "npm run lint && npm run prettier-check",
+    "hooks-pre-push": "npm audit --audit-level=high && npm test",
+    "lint": "npm run lint-css && npm run lint-html && npm run lint-js && npm run lint-md",
     "lint-css": "stylelint ./lib/report-template.handlebars",
     "lint-html": "htmlhint ./lib/report-template.handlebars",
     "lint-js": "eslint \"**/*.js\"",
     "lint-md": "markdownlint **/*.md --ignore node_modules",
-    "lint": "npm run lint-css && npm run lint-html && npm run lint-js && npm run lint-md",
-    "push": "npm run start-lint-all && npm audit --audit-level=critical"
+    "prettier-check": "prettier --check .",
+    "prettier-fix": "prettier --write .",
+    "start": "node ./bin/pagean.js",
+    "start-lint": "node ./bin/pageanrc-lint.js",
+    "start-lint-all": "npm run start-lint && npm run start-lint -c static-server.pageanrc.json && npm run start-lint -c ./lib/default-config.json",
+    "test": "jest --ci --config jest.config.json"
   },
   "repository": {
     "type": "git",
@@ -34,7 +37,7 @@
   "author": "Aaron Goldenthal <npm@aarongoldenthal.com>",
   "license": "MIT",
   "engines": {
-    "node": "^12.20.0 || ^14.15.0 || >=16.0.0"
+    "node": "^14.15.0 || ^16.13.0 || >=18.0.0"
   },
   "files": [
     "index.js",
@@ -46,29 +49,30 @@
   "bugs": {
     "url": "https://gitlab.com/gitlab-ci-utils/pagean/issues"
   },
-  "homepage": "https://gitlab.com/gitlab-ci-utils/pagean#readme",
+  "homepage": "https://gitlab.com/gitlab-ci-utils/pagean",
   "devDependencies": {
-    "@aarongoldenthal/eslint-config-standard": "^11.0.0",
-    "@aarongoldenthal/stylelint-config-standard": "^7.0.0",
+    "@aarongoldenthal/eslint-config-standard": "^15.0.0",
+    "@aarongoldenthal/stylelint-config-standard": "^9.0.0",
     "bin-tester": "^2.0.1",
-    "eslint": "^8.8.0",
-    "jest": "^27.5.1",
-    "jest-junit": "^13.0.0",
+    "eslint": "^8.17.0",
+    "jest": "^28.1.1",
+    "jest-junit": "^13.2.0",
     "markdownlint-cli": "^0.31.1",
+    "prettier": "^2.7.0",
     "strip-ansi": "^6.0.1",
-    "stylelint": "^14.5.0"
+    "stylelint": "^14.9.1"
   },
   "dependencies": {
-    "ajv": "^8.10.0",
+    "ajv": "^8.11.0",
     "ajv-errors": "^3.0.0",
-    "axios": "^0.25.0",
-    "ci-logger": "^4.0.1",
-    "commander": "^9.0.0",
+    "axios": "^0.27.2",
+    "ci-logger": "^5.0.0",
+    "commander": "^9.3.0",
     "handlebars": "^4.7.7",
-    "htmlhint": "^1.1.2",
+    "htmlhint": "^1.1.4",
     "kleur": "^4.1.4",
     "normalize-url": "^6.1.0",
     "protocolify": "^3.0.0",
-    "puppeteer": "^13.3.1"
+    "puppeteer": "^14.4.0"
   }
 }

package/schemas/pageanrc.schema.json

@@ -22,11 +22,7 @@
       "description": "Reporters to use when returning the results of the Pagean tests.",
       "type": "array",
       "items": {
-        "enum": [
-          "cli",
-          "html",
-          "json"
-        ]
+        "enum": ["cli", "html", "json"]
       },
       "minItems": 1
     },
@@ -60,9 +56,7 @@
               "not": true,
               "errorMessage": "must NOT contain additional properties: ${0#}"
             },
-            "required": [
-              "url"
-            ],
+            "required": ["url"],
             "errorMessage": {
               "required": "must have required property 'url'"
             }
@@ -77,9 +71,7 @@
     "not": true,
     "errorMessage": "must NOT contain additional properties: ${0#}"
   },
-  "required": [
-    "urls"
-  ],
+  "required": ["urls"],
   "definitions": {
     "detailedSetting": {
       "description": "The complete set of test-specific settings for most tests.",