pagean 8.0.4 → 10.0.0

package/lib/config.js

@@ -6,13 +6,15 @@
  * @module config
  */
 
-const fs = require('fs');
-const path = require('path');
-const Ajv = require('ajv').default;
+const fs = require('node:fs');
+const path = require('node:path');
+const Ajv = require('ajv/dist/2019');
+const draft7MetaSchema = require('ajv/dist/refs/json-schema-draft-07.json');
 const ajvErrors = require('ajv-errors');
 const protocolify = require('protocolify');
 
 const { normalizeLink } = require('./link-utils');
+const { getUrlsFromSitemap } = require('./sitemap');
 
 const defaultConfig = require('./default-config.json');
 const defaultHtmlHintConfigFilename = './.htmlhintrc';
@@ -43,6 +45,8 @@ const processAllTestSettings = (settings) => {
     for (const key of Object.keys(settings)) {
         processedSettings[key] = processTestSetting(settings[key]);
     }
+    /* eslint-disable-next-line consistent-return -- return undefined
+       if no settings */
     return processedSettings;
 };
 
@@ -70,45 +74,75 @@ const consolidateTestSettings = (
     return processedSettings;
 };
 
-const processUrls = (config) => {
+const addSitemapUrls = (config, sitemapUrls) => {
+    if (config.urls) {
+        for (const url of config.urls) {
+            const { rawUrl } = getUrl(url);
+            const index = sitemapUrls.indexOf(rawUrl);
+            index > -1 && sitemapUrls.splice(index, 1);
+        }
+        config.urls.push(...sitemapUrls);
+    } else {
+        config.urls = sitemapUrls;
+    }
+};
+
+const processUrls = async (config) => {
     const processedConfigSettings = processAllTestSettings(config.settings);
+    if (config.sitemap) {
+        const sitemapUrls = await getUrlsFromSitemap(config.sitemap);
+        addSitemapUrls(config, sitemapUrls);
+    }
     return config.urls.map((testUrl) => {
         const { rawUrl, urlSettings } = getUrl(testUrl);
         return {
-            url: protocolify(rawUrl),
             rawUrl,
             settings: consolidateTestSettings(
                 defaultConfig.settings,
                 processedConfigSettings,
                 processAllTestSettings(urlSettings)
-            )
+            ),
+            url: protocolify(rawUrl)
         };
     });
 };
 
 const getHtmlHintConfig = (htmlHintConfigFilename) => {
+    // Allow users to specify a custom htmlhintrc file.
+    // nosemgrep: eslint.detect-non-literal-fs-filename
     if (!fs.existsSync(htmlHintConfigFilename)) {
         return;
     }
+    /* eslint-disable consistent-return -- return undefined if no settings */
+    // Allow users to specify a custom htmlhintrc file.
+    // nosemgrep: eslint.detect-non-literal-fs-filename
     return JSON.parse(fs.readFileSync(htmlHintConfigFilename, 'utf8'));
+    /* eslint-enable consistent-return -- return undefined if no settings */
 };
 
 const validateConfigSchema = (config) => {
     const schema = JSON.parse(
+        // All values hardcoded.
+        // nosemgrep: eslint.detect-non-literal-fs-filename
         fs.readFileSync(
             path.join(__dirname, '../', 'schemas', 'pageanrc.schema.json')
         )
     );
+    // Allow allErrors to lint the entire config file, although users could
+    // ReDoS themselves.
+    // nosemgrep: ajv-allerrors-true
     const ajv = new Ajv({ allErrors: true });
+    ajv.addMetaSchema(draft7MetaSchema);
     ajvErrors(ajv);
     const validate = ajv.compile(schema);
     const isValid = validate(config);
-    return { isValid, errors: validate.errors || [] };
+    return { errors: validate.errors || [], isValid };
 };
 
-const getConfigFromFile = (configFileName) => {
-    return JSON.parse(fs.readFileSync(configFileName, 'utf8'));
-};
+const getConfigFromFile = (configFileName) =>
+    // Allow users to specify config filename.
+    // nosemgrep: eslint.detect-non-literal-fs-filename
+    JSON.parse(fs.readFileSync(configFileName, 'utf8'));
 
 /**
  * Loads config from file and returns consolidated config with
@@ -116,10 +150,12 @@ const getConfigFromFile = (configFileName) => {
  *
  * @param   {string}    configFileName Pagean configuration file name.
  * @returns {object}                   Consolidated Pagean configuration.
+ * @async
  * @throws  {TypeError}                Throws if config file has an invalid schema.
  * @static
+ * @public
  */
-const processConfig = (configFileName) => {
+const processConfig = async (configFileName) => {
     const config = getConfigFromFile(configFileName);
     const { isValid } = validateConfigSchema(config);
     if (!isValid) {
@@ -128,13 +164,16 @@ const processConfig = (configFileName) => {
         );
     }
     return {
-        project: config.project || '',
-        puppeteerLaunchOptions: config.puppeteerLaunchOptions,
-        urls: processUrls(config),
         htmlHintConfig: getHtmlHintConfig(
             config.htmlhintrc || defaultHtmlHintConfigFilename
         ),
-        reporters: config.reporters || defaultConfig.reporters
+        project: config.project || '',
+        puppeteerLaunchOptions: {
+            ...defaultConfig.puppeteerLaunchOptions,
+            ...config.puppeteerLaunchOptions
+        },
+        reporters: config.reporters || defaultConfig.reporters,
+        urls: await processUrls(config)
     };
 };
 

package/lib/default-config.json

@@ -32,6 +32,9 @@
       "ignoreDuplicates": true
     }
   },
+  "puppeteerLaunchOptions": {
+    "headless": "new"
+  },
   "reporters": ["cli", "html", "json"],
   "urls": ["ignored, required to validate schema"]
 }

package/lib/external-file-utils.js

@@ -5,8 +5,8 @@
  *
  * @module external-file-utils
  */
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 
 const axios = require('axios');
 
@@ -48,10 +48,16 @@ const saveExternalScript = async (script) => {
             scriptUrl.hostname,
             scriptUrl.pathname
         );
+        // Path generated above from URL, not from user input.
+        // nosemgrep: eslint.detect-non-literal-fs-filename
         if (!fs.existsSync(pathName)) {
             // Axios will throw for any error response
             const response = await axios.get(script);
+            // Path generated above from URL, not from user input.
+            // nosemgrep: eslint.detect-non-literal-fs-filename
             fs.mkdirSync(path.dirname(pathName), { recursive: true });
+            // Path generated above from URL, not from user input.
+            // nosemgrep: eslint.detect-non-literal-fs-filename
             fs.writeFileSync(pathName, response.data);
         }
         result.localFile = pathName;

package/lib/link-utils.js

@@ -6,7 +6,7 @@
  * @module link-utils
  */
 
-const https = require('https');
+const https = require('node:https');
 const axios = require('axios');
 const normalizeUrl = require('normalize-url');
 const cssesc = require('cssesc');
@@ -24,6 +24,7 @@ const timeoutSeconds = 120;
 const httpResponse = Object.freeze({
     continue: 100,
     ok: 200,
+    // eslint-disable-next-line sort-keys -- order by response code
     badRequest: 400,
     notFound: 404,
     tooManyRequests: 429,
@@ -52,7 +53,6 @@ const normalizeLink = (url) =>
         stripHash: true,
         stripWWW: false
     });
-/* eslint-enable jsdoc/require-description-complete-sentence */
 
 /**
  * Checks settings to determine if the provided link should be ignored.
@@ -99,7 +99,6 @@ const checkSamePageLink = async (page, link) => {
         isIdentifier: true
     })}`;
     const element = await page.$(escapedSelector);
-    // const element = await page.$(selector);
     return element ? httpResponse.ok : `${selector} Not Found`;
 };
 
@@ -122,7 +121,7 @@ const checkExternalPageLinkBrowser = async (page, link) => {
     } 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');
+        status = error.message.replace(/^(?<message>.*) at .*$/, '$1');
     }
     return status;
 };
@@ -149,15 +148,16 @@ const checkExternalPageLink = async (page, link, useGet = false) => {
 
     try {
         const options = {
+            decompress: false,
             headers: { 'User-Agent': userAgent },
-            timeout: timeoutSeconds * msPerSec,
+            timeout: timeoutSeconds * msPerSec
             // Axios can generate an error trying to decompress an empty compressed
             // HEAD response, see https://github.com/axios/axios/issues/5102.
             // The response body is also not used, so more efficient to skip.
-            decompress: false
         };
         // Using internal browser property since not exposed
-        // eslint-disable-next-line no-underscore-dangle
+        /* eslint-disable-next-line no-underscore-dangle -- require to match
+           Puppeteer API */
         if (page.browser()._ignoreHTTPSErrors) {
             const agent = new https.Agent({ rejectUnauthorized: false });
             options.httpsAgent = agent;
@@ -184,7 +184,7 @@ const checkExternalPageLink = async (page, link, useGet = false) => {
 };
 
 /**
- * Factory function returning a linkChecker object with a {@link checkLink}
+ * Factory function returning a linkChecker object with a checkLink
  * function that caches checked link results.
  *
  * @returns {object} Link checker object.
@@ -205,7 +205,7 @@ const createLinkChecker = () => {
          * @returns {(string|number)}         The link status (HTTP response code or error).
          * @public
          */
-        // eslint-disable-next-line sonarjs/cognitive-complexity
+        // eslint-disable-next-line sonarjs/cognitive-complexity -- allow < 10
         checkLink: async (context, link) => {
             let status = httpResponse.unknownError;
             try {

package/lib/logger.js

@@ -10,8 +10,8 @@ const consoleLogger = require('ci-logger');
 const { reporterTypes } = require('../lib/reporter');
 
 const testResultSymbols = Object.freeze({
-    passed: ' √',
     failed: ' ×',
+    passed: ' √',
     warning: ' ‼'
 });
 
@@ -25,7 +25,7 @@ const nullFunction = () => {};
  * @returns {object}        A logger object.
  * @static
  */
-// eslint-disable-next-line max-lines-per-function
+// eslint-disable-next-line max-lines-per-function -- factory function with state
 module.exports = (config) => {
     const cliReporter = {
         // If cli reporter is enabled, set console log function, otherwise null function
@@ -38,15 +38,15 @@ module.exports = (config) => {
     };
 
     const testResults = {
-        project: config.project,
         executionStart: new Date(),
+        project: config.project,
+        results: [],
         summary: {
-            tests: 0,
+            failed: 0,
             passed: 0,
-            warning: 0,
-            failed: 0
-        },
-        results: []
+            tests: 0,
+            warning: 0
+        }
     };
 
     let currentUrlTests;
@@ -59,8 +59,8 @@ module.exports = (config) => {
      */
     const startUrlTests = (url) => {
         const urlTestResults = {
-            url,
-            tests: []
+            tests: [],
+            url
         };
         testResults.results.push(urlTestResults);
         currentUrlTests = urlTestResults;
@@ -72,7 +72,7 @@ module.exports = (config) => {
      * by the last call to StartUrlTests).
      *
      * @instance
-     * @param {object} testResult The test results.
+     * @param {object} testResult The test results object.
      */
     const logTestResults = (testResult) => {
         if (testResult) {
@@ -81,8 +81,8 @@ module.exports = (config) => {
             testResults.summary[testResult.result]++;
 
             cliReporter.log({
-                message: `${testResult.name} (${testResult.result})`,
                 isResult: true,
+                message: `${testResult.name} (${testResult.result})`,
                 resultPrefix: testResultSymbols[testResult.result]
             });
         }
@@ -107,8 +107,8 @@ module.exports = (config) => {
     };
 
     return {
-        startUrlTests,
+        getTestResults,
         logTestResults,
-        getTestResults
+        startUrlTests
     };
 };

package/lib/report-template.handlebars

@@ -4,25 +4,40 @@
 <head>
 	<title>Pagean Results</title>
 	<style>
+		:root {
+			/* Default colors */
+			--color-text-default: #333333;
+			--color-background-data-hover: rgba(255 255 255 / 10%);
+			--color-background-summary: #f4f4f4;
+			--color-border-summary: #333333;
+
+			/* Test result colors */
+			--color-background-passed: #dff2bf;
+			--color-text-passed: #44760f;
+			--color-background-failed: #ffbaba;
+			--color-text-failed: #ad000c;
+			--color-background-warning: #fdec96;
+			--color-text-warning: #7e6902;
+		}
+
 		html {
 			margin: 0;
 			padding: 0;
 		}
 
 		body {
-			color: #333333;
-			font-family: Arial, Helvetica, sans-serif;
+			color: var(--color-text-default);
+			font-family: system-ui, sans-serif;
 			font-size: 0.85rem;
 			margin: auto;
-			max-width: 1000px;
+			max-inline-size: 1000px;
 			padding: 1rem;
 		}
 
 		ul {
-			margin: 0;
 			margin-block: 0;
 			margin-inline: 0;
-			padding: 0;
+			padding-block: 0;
 			padding-inline: 0;
 		}
 
@@ -31,7 +46,6 @@
 		}
 
 		h1 {
-			margin: 1rem 0 0.75rem;
 			margin-block: 0;
 			margin-inline: 0;
 		}
@@ -48,62 +62,68 @@
 		.project,
 		.started {
 			margin: 0;
-			padding-bottom: 0.5rem;
+			padding-block-end: 0.5rem;
 		}
 
 		.test-summary {
 			display: flex;
 			flex-direction: row;
-			margin-bottom: 2rem;
-			max-width: 50%;
+			margin-block-end: 2rem;
+			max-inline-size: 50%;
 		}
 
 		.summary {
-			background-color: #f4f4f4;
-			border: 1px solid #333333;
+			background-color: var(--color-background-summary);
+			border: 1px solid var(--color-border-summary);
 			display: inline-block;
 			flex: 1 1 10%;
-			margin: 0 0.25rem;
-			padding: 0.25rem 0.5rem;
+			margin-block: 0;
+			margin-inline: 0.25rem;
+			padding-block: 0.25rem;
+			padding-inline: 0.5rem;
 		}
 
 		.summary:first-of-type {
-			margin-left: 0;
+			margin-inline-start: 0;
 		}
 
 		.summary:last-of-type {
-			margin-right: 0;
+			margin-inline-end: 0;
 		}
 
 		.passed {
-			background-color: #dff2bf;
-			border: 1px solid #44760f;
-			color: #44760f;
+			background-color: var(--color-background-passed);
+			border: 1px solid var(--color-text-passed);
+			color: var(--color-text-passed);
 		}
 
 		.failed {
-			background-color: #ffbaba;
-			border: 1px solid #ad000c;
-			color: #ad000c;
+			background-color: var(--color-background-failed);
+			border: 1px solid var(--color-text-failed);
+			color: var(--color-text-failed);
 		}
 
 		.warning {
-			background-color: #fdec96;
-			border: 1px solid #7e6902;
-			color: #7e6902;
+			background-color: var(--color-background-warning);
+			border: 1px solid var(--color-text-warning);
+			color: var(--color-text-warning);
 		}
 
 		.test-results h2 {
-			margin-block-end: 0;
-			margin-block-start: 1rem;
+			margin-block: 1rem 0;
 		}
 
-		details summary .name::after {
-			content: " ⏵";
+		details summary .name::after,
+		details[open] summary .name::after {
+			content: "+";
+			font-family: monospace;
+			font-weight: bold;
+			opacity: 0.8;
+    		padding-inline-start: 0.5rem;
 		}
 
 		details[open] summary .name::after {
-			content: " ⏷";
+			content: "–";
 		}
 
 		summary {
@@ -116,8 +136,10 @@
 		}
 
 		li.test {
-			margin: 0.25rem 0;
-			padding: 0.5rem 1rem;
+			margin-block: 0.25rem;
+			margin-inline: 0;
+			padding-block: 0.5rem;
+			padding-inline: 1rem;
 		}
 
 		.test .header {
@@ -131,20 +153,20 @@
 
 		.test .header .result {
 			flex: 1 1 25%;
-			text-align: right;
+			text-align: end;
 		}
 
 		.test .data,
 		.test .time,
 		.test .error {
-			padding-left: 10px;
+			padding-inline-start: 0.75rem;
 		}
 
 		.test .data h3 {
 			font-size: inherit;
 			font-weight: normal;
-			margin: 0.25rem 0 0;
 			margin-block: 0;
+			margin-inline: 0;
 		}
 
 		.test .data li {
@@ -154,18 +176,20 @@
 		}
 
 		.test .data li:hover {
-			background-color: rgba(255 255 255 / 10%);
+			background-color: var(--color-background-data-hover);
 			border: 1px dotted;
-			border-right: 4px solid;
+			border-inline-end: 4px solid;
 			padding: calc(0.25rem - 1px);
 		}
 
 		.test .data .pre {
-			margin: 0 0 0.25rem;
+			margin-block: 0 0.25rem;
+			margin-inline: 0;
 		}
 
 		.test .time {
-			margin: 0.25rem 0 0;
+			margin-block: 0.25rem 0;
+			margin-inline: 0;
 		}
 	</style>
 </head>
@@ -192,7 +216,7 @@
 				<li class="test {{result}}">
 					{{#if data}}
 					<details>
-						<summary class="header">
+						<summary class="header" title="Show/hide details">
 							<div class="name">{{name}}</div>
 							<div class="result">{{result}}</div>
 						</summary>

package/lib/reporter.js

@@ -5,23 +5,25 @@
  *
  * @module reporter
  */
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 const handlebars = require('handlebars');
 
 const htmlReportTemplateName = 'report-template.handlebars';
 const htmlReportFileName = './pagean-results.html';
 const jsonReportFileName = './pagean-results.json';
 
-handlebars.registerHelper('json', (context) => {
-    // eslint-disable-next-line no-magic-numbers -- count
-    return JSON.stringify(context, undefined, 2);
-});
+handlebars.registerHelper('json', (context) =>
+    // eslint-disable-next-line no-magic-numbers -- no-magic-numbers - count
+    JSON.stringify(context, undefined, 2)
+);
 
 const saveHtmlReport = (results) => {
     const templateFile = path.resolve(
         path.join(__dirname, htmlReportTemplateName)
     );
+    // Path hardcoded above, not from user input.
+    // nosemgrep: eslint.detect-non-literal-fs-filename
     const htmlReportTemplate = fs.readFileSync(templateFile, 'utf8');
     const template = handlebars.compile(htmlReportTemplate);
     const htmlReport = template(results);

package/lib/schema-errors.js

@@ -24,8 +24,8 @@ const getDataKey = (instancePath) => {
             // eslint-disable-next-line unicorn/no-array-reduce -- reduce for string concatenation
             .reduce((accumulator, currentValue) => {
                 const unencodedValue = currentValue
-                    .replace(/~0/g, '~')
-                    .replace(/~1/g, '/');
+                    .replaceAll('~0', '~')
+                    .replaceAll('~1', '/');
                 const encodedValue = Number.isNaN(Number(unencodedValue))
                     ? `.${unencodedValue}`
                     : `[${unencodedValue}]`;