pagean 6.0.8 → 6.0.9

package/lib/link-utils.js

@@ -45,15 +45,14 @@ const noRetryResponses = new Set([httpResponse.tooManyRequests]);
  * @param {string} url  The URL to normalize.
  * @returns {string}    The normalized URL.
  */
-const normalizeLink = url => normalizeUrl(url,
-    {
+const normalizeLink = (url) =>
+    normalizeUrl(url, {
         defaultProtocol: 'https:',
         removeQueryParameters: [],
         stripHash: true,
         stripWWW: false
     });
 
-
 /**
  * Checks settings to determine if the provided link should be ignored.
  *
@@ -64,8 +63,8 @@ const normalizeLink = url => normalizeUrl(url,
  * @param   {string} link     The link to check against the ignore list.
  * @returns {boolean}         True if the link should be ignored, otherwise false.
  */
-const ignoreLink = (settings, link) => settings.ignoredLinks && settings.ignoredLinks.includes(link);
-
+const ignoreLink = (settings, link) =>
+    settings.ignoredLinks && settings.ignoredLinks.includes(link);
 
 /**
  * Checks a response to an HTTP request, either a response code or explicit error,
@@ -76,8 +75,9 @@ const ignoreLink = (settings, link) => settings.ignoredLinks && settings.ignored
  * @param   {(string|number)} response The response to an HTTP request to check for failure.
  * @returns {boolean}                  True if failed, otherwise false.
  */
-const isFailedResponse = response => Number.isNaN(Number(response.status)) || response.status >= httpResponse.badRequest;
-
+const isFailedResponse = (response) =>
+    Number.isNaN(Number(response.status)) ||
+    response.status >= httpResponse.badRequest;
 
 /**
  * Checks a Puppeteer page for the element specified in the hash of the provided link.
@@ -98,7 +98,6 @@ const checkSamePageLink = async (page, link) => {
     return element ? httpResponse.ok : `${selector} Not Found`;
 };
 
-
 /**
  * Checks the provided link for validity by loading in a Puppeteer page.
  *
@@ -115,8 +114,7 @@ const checkExternalPageLinkBrowser = async (page, link) => {
         const response = await testPage.goto(link);
         status = response.status();
         await testPage.close();
-    }
-    catch (error) {
+    } catch (error) {
         // Errors are returned in the format: "ENOTFOUND at https://this.url.does.not.exist/",
         // so extract error only and remove URL
         status = error.message.replace(/^(.*) at .*$/, '$1');
@@ -124,7 +122,6 @@ const checkExternalPageLinkBrowser = async (page, link) => {
     return status;
 };
 
-
 /**
  * Checks the provided link for validity by requesting with axios. If useGet if false,
  * a HEAD request is made for efficiency. If useGet is true, a full GET request is made.
@@ -142,7 +139,10 @@ const checkExternalPageLink = async (page, link, useGet = false) => {
     const userAgent = await page.evaluate('navigator.userAgent');
 
     try {
-        const options = { headers: { 'User-Agent': userAgent }, timeout: timeoutSeconds * msPerSec };
+        const options = {
+            headers: { 'User-Agent': userAgent },
+            timeout: timeoutSeconds * msPerSec
+        };
         // Using internal browser property since not exposed
         // eslint-disable-next-line no-underscore-dangle
         if (page.browser()._ignoreHTTPSErrors) {
@@ -152,12 +152,15 @@ const checkExternalPageLink = async (page, link, useGet = false) => {
         const httpMethod = useGet ? axios.get : axios.head;
         const response = await httpMethod(link, options);
         return response.status;
-    }
-    catch (error) {
+    } catch (error) {
         // Some servers respond invalid for head request (e.g. a lot of 405 Method
         // Not Allowed), so if a response was returned, is not a response that should
         // skip a retry (e.g. 429), and the request was head then retry with get.
-        if (error.response && !noRetryResponses.has(error.response.status) && !useGet) {
+        if (
+            error.response &&
+            !noRetryResponses.has(error.response.status) &&
+            !useGet
+        ) {
             return checkExternalPageLink(page, link, true);
         }
 
@@ -167,7 +170,6 @@ const checkExternalPageLink = async (page, link, useGet = false) => {
     }
 };
 
-
 /**
  * Factory function returning a linkChecker object with a {@link checkLink}
  * function that caches checked link results.
@@ -205,15 +207,17 @@ const createLinkChecker = () => {
                     return httpResponse.continue;
                 }
 
-                if (context.testSettings.ignoreDuplicates && checkedLinks.has(link)) {
+                if (
+                    context.testSettings.ignoreDuplicates &&
+                    checkedLinks.has(link)
+                ) {
                     return checkedLinks.get(link);
                 }
 
                 status = await (context.testSettings.checkWithBrowser
                     ? checkExternalPageLinkBrowser(context.page, normalizedLink)
                     : checkExternalPageLink(context.page, normalizedLink));
-            }
-            catch {
+            } catch {
                 status = httpResponse.unknownError;
             }
 

package/lib/logger.js

@@ -15,7 +15,7 @@ const testResultSymbols = Object.freeze({
     warning: ' ‼'
 });
 
-const nullFunction = () => { };
+const nullFunction = () => {};
 
 /**
  * Factory function that creates an instance of a
@@ -29,7 +29,9 @@ const nullFunction = () => { };
 module.exports = (config) => {
     const cliReporter = {
         // If cli reporter is enabled, set console log function, otherwise null function
-        log: config.reporters.includes(reporterTypes.cli) ? consoleLogger.log : nullFunction,
+        log: config.reporters.includes(reporterTypes.cli)
+            ? consoleLogger.log
+            : nullFunction,
         // The logAlways function provides a mechanism to log to the console even
         // when the cli reporter is disabled (e.g. returning the final results)
         logAlways: consoleLogger.log
@@ -87,7 +89,9 @@ module.exports = (config) => {
     };
 
     const outputTestSummary = () => {
-        cliReporter.logAlways({ message: `\n Tests: ${testResults.summary.tests}\n Passed: ${testResults.summary.passed}\n Warning: ${testResults.summary.warning}\n Failed: ${testResults.summary.failed}\n` });
+        cliReporter.logAlways({
+            message: `\n Tests: ${testResults.summary.tests}\n Passed: ${testResults.summary.passed}\n Warning: ${testResults.summary.warning}\n Failed: ${testResults.summary.failed}\n`
+        });
     };
 
     /**

package/lib/reporter.js

@@ -19,8 +19,10 @@ handlebars.registerHelper('json', (context) => {
 });
 
 const saveHtmlReport = (results) => {
-    const templateFile = path.resolve(path.join(__dirname, htmlReportTemplateName));
-    const htmlReportTemplate = fs.readFileSync(templateFile, 'utf-8');
+    const templateFile = path.resolve(
+        path.join(__dirname, htmlReportTemplateName)
+    );
+    const htmlReportTemplate = fs.readFileSync(templateFile, 'utf8');
     const template = handlebars.compile(htmlReportTemplate);
     const htmlReport = template(results);
     fs.writeFileSync(htmlReportFileName, htmlReport);

package/lib/schema-errors.js

@@ -16,13 +16,22 @@ const getDataKey = (instancePath) => {
     // Convert pointer to key be splitting by /, removing first value (since pointer
     // starts with /, so empty), unencoding values, and the re-assembling with different
     // formatting for numeric array indices versus properties.
-    // eslint-disable-next-line unicorn/no-array-reduce -- reduce for string concatenation
-    return baseKey + instancePath.split('/').slice(1).reduce((accumulator, currentValue) => {
-        // eslint-disable-next-line unicorn/prefer-string-replace-all -- requires Node 15
-        const unencodedValue = currentValue.replace(/~0/g, '~').replace(/~1/g, '/');
-        const encodedValue = Number.isNaN(Number(unencodedValue)) ? `.${unencodedValue}` : `[${unencodedValue}]`;
-        return `${accumulator}${encodedValue}`;
-    }, '');
+    return (
+        baseKey +
+        instancePath
+            .split('/')
+            .slice(1)
+            // eslint-disable-next-line unicorn/no-array-reduce -- reduce for string concatenation
+            .reduce((accumulator, currentValue) => {
+                const unencodedValue = currentValue
+                    .replace(/~0/g, '~')
+                    .replace(/~1/g, '/');
+                const encodedValue = Number.isNaN(Number(unencodedValue))
+                    ? `.${unencodedValue}`
+                    : `[${unencodedValue}]`;
+                return `${accumulator}${encodedValue}`;
+            }, '')
+    );
 };
 
 const processErrorParameters = (error) => {
@@ -54,7 +63,12 @@ const formatErrors = (errors) => {
             maxLength = error.dataKey.length;
         }
     }
-    return errors.map(error => `  ${error.dataKey.padEnd(maxLength + margin)}${red(error.formattedMessage)}`);
+    return errors.map(
+        (error) =>
+            `  ${error.dataKey.padEnd(maxLength + margin)}${red(
+                error.formattedMessage
+            )}`
+    );
 };
 
 module.exports.formatErrors = formatErrors;

package/lib/test-utils.js

@@ -14,7 +14,9 @@ const testResultStates = Object.freeze({
 
 const getTestSettings = (testSettingProperty, urlSettings) => {
     if (urlSettings[testSettingProperty] === undefined) {
-        throw new Error(`Property '${testSettingProperty}' could not be found in test settings`);
+        throw new Error(
+            `Property '${testSettingProperty}' could not be found in test settings`
+        );
     }
     return urlSettings[testSettingProperty];
 };
@@ -31,19 +33,29 @@ const getTestSettings = (testSettingProperty, urlSettings) => {
  * @param {string}   testSettingProperty The name of the config property
  *                                       with settings for the current test.
  */
-// eslint-disable-next-line sonarjs/cognitive-complexity -- Allow < 10
-const pageanTest = async (name, testFunction, testContext, testSettingProperty) => {
-    const testSettings = getTestSettings(testSettingProperty, testContext.urlSettings);
+const pageanTest = async (
+    name,
+    testFunction,
+    testContext,
+    testSettingProperty
+    // eslint-disable-next-line sonarjs/cognitive-complexity -- Allow < 10
+) => {
+    const testSettings = getTestSettings(
+        testSettingProperty,
+        testContext.urlSettings
+    );
     testContext.testSettings = testSettings;
     if (testSettings.enabled) {
         let results;
         try {
             results = await testFunction(testContext);
-        }
-        catch (error) {
+        } catch (error) {
             results = { result: testResultStates.failed, data: { error } };
         }
-        if (results.result === testResultStates.failed && testSettings.failWarn) {
+        if (
+            results.result === testResultStates.failed &&
+            testSettings.failWarn
+        ) {
             results.result = testResultStates.warning;
         }
         testContext.logger.logTestResults({

package/lib/tests.js

@@ -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,29 @@ 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(
+                // Object property names defined by puppeteer API
+                // eslint-disable-next-line no-underscore-dangle
+                (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 +107,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 +138,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 +181,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 +225,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;