pagean 6.0.7 → 6.0.8

package/bin/pagean.js

@@ -20,6 +20,6 @@ try {
     const config = getConfig(options.config);
     pagean.executeAllTests(config);
 }
-catch (err) {
-    log({ message: `Error executing pagean tests\n${err.message}`, level: levels.error, exitOnError: true, errorCode: 1 });
+catch (error) {
+    log({ message: `Error executing pagean tests\n${error.message}`, level: levels.error, exitOnError: true, errorCode: 1 });
 }

package/bin/pageanrc-lint.js

@@ -5,7 +5,7 @@ const { log, levels } = require('ci-logger');
 const program = require('commander');
 const { green, underline } = require('kleur');
 const { lintConfigFile } = require('../lib/config');
-const { formatErrors } = require('../lib/schemaErrors');
+const { formatErrors } = require('../lib/schema-errors');
 const pkg = require('../package.json');
 
 const defaultConfigFileName = './.pageanrc.json';
@@ -37,7 +37,9 @@ const outputConsoleResults = (configFileName, lintResults) => {
     }
     else {
         logError(`\n${underline(configFileName)}`, false);
-        formatErrors(lintResults.errors).forEach(error => logError(error, false));
+        for (const error of formatErrors(lintResults.errors)) {
+            logError(error, false);
+        }
         // Add line for spacing and error exits process
         logError('');
     }
@@ -54,6 +56,6 @@ try {
         outputConsoleResults(configFileName, lintResults);
     }
 }
-catch (err) {
-    logError(`Error linting pageanrc file\n${err.message}`);
+catch (error) {
+    logError(`Error linting pageanrc file\n${error.message}`);
 }

package/index.js

@@ -10,7 +10,7 @@ const puppeteer = require('puppeteer');
 const testLogger = require('./lib/logger');
 const testReporter = require('./lib/reporter');
 const { ...testFunctions } = require('./lib/tests');
-const { createLinkChecker } = require('./lib/linkUtils');
+const { createLinkChecker } = require('./lib/link-utils');
 
 /**
  * Executes Pagean tests as specified in config and reports results.
@@ -30,7 +30,7 @@ const executeAllTests = async (config) => {
         const page = await browser.newPage();
         // Object property names defined by puppeteer API
         // eslint-disable-next-line no-underscore-dangle
-        page.on('console', msg => consoleLog.push({ _type: msg._type, _text: msg._text, _stackTraceLocations: msg._stackTraceLocations }));
+        page.on('console', message => consoleLog.push({ _type: message._type, _text: message._text, _stackTraceLocations: message._stackTraceLocations }));
         await page.goto(testUrl.url, { waitUntil: 'load' });
 
         const testContext = {
@@ -49,7 +49,7 @@ const executeAllTests = async (config) => {
 
     if (testResults.summary.failed > 0) {
         // For test harness want process to exit with error code
-        // eslint-disable-next-line no-process-exit, no-magic-numbers
+        // eslint-disable-next-line unicorn/no-process-exit, no-process-exit, no-magic-numbers
         process.exit(2);
     }
 };

package/lib/config.js

@@ -12,7 +12,7 @@ const Ajv = require('ajv').default;
 const ajvErrors = require('ajv-errors');
 const protocolify = require('protocolify');
 
-const { normalizeLink } = require('./linkUtils');
+const { normalizeLink } = require('./link-utils');
 
 const defaultConfig = require('./default-config.json');
 const defaultHtmlHintConfigFilename = './.htmlhintrc';

package/lib/{externalFileUtils.js → external-file-utils.js}

@@ -48,8 +48,8 @@ const saveExternalScript = async (script) => {
         }
         result.localFile = pathName;
     }
-    catch (err) {
-        result.error = err.message;
+    catch (error) {
+        result.error = error.message;
     }
     return result;
 };

package/lib/{linkUtils.js → link-utils.js}

@@ -3,7 +3,7 @@
 /**
  * Utilities for checking page links.
  *
- * @module linkUtils
+ * @module link-utils
  */
 
 const https = require('https');
@@ -29,7 +29,7 @@ const httpResponse = Object.freeze({
     unknownError: 999
 });
 
-const noRetryResponses = [httpResponse.tooManyRequests];
+const noRetryResponses = new Set([httpResponse.tooManyRequests]);
 
 // eslint-disable-next-line jsdoc/require-description-complete-sentence
 /**
@@ -76,7 +76,7 @@ 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 => isNaN(response.status) || response.status >= httpResponse.badRequest;
+const isFailedResponse = response => Number.isNaN(Number(response.status)) || response.status >= httpResponse.badRequest;
 
 
 /**
@@ -116,10 +116,10 @@ const checkExternalPageLinkBrowser = async (page, link) => {
         status = response.status();
         await testPage.close();
     }
-    catch (err) {
+    catch (error) {
         // Errors are returned in the format: "ENOTFOUND at https://this.url.does.not.exist/",
         // so extract error only and remove URL
-        status = err.message.replace(/^(.*) at .*$/, '$1');
+        status = error.message.replace(/^(.*) at .*$/, '$1');
     }
     return status;
 };
@@ -153,17 +153,17 @@ const checkExternalPageLink = async (page, link, useGet = false) => {
         const response = await httpMethod(link, options);
         return response.status;
     }
-    catch (err) {
+    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 (err.response && !noRetryResponses.includes(err.response.status) && !useGet) {
+        if (error.response && !noRetryResponses.has(error.response.status) && !useGet) {
             return checkExternalPageLink(page, link, true);
         }
 
         // Axios will throw for failed response (code >= 400), so return
         // that response code or the error code if execution error
-        return err.response ? err.response.status : err.code;
+        return error.response ? error.response.status : error.code;
     }
 };
 
@@ -176,7 +176,6 @@ const checkExternalPageLink = async (page, link, useGet = false) => {
  * @static
  * @returns {object} Link checker object.
  */
-// eslint-disable-next-line max-lines-per-function
 const createLinkChecker = () => {
     const checkedLinks = new Map();
 
@@ -210,12 +209,9 @@ const createLinkChecker = () => {
                     return checkedLinks.get(link);
                 }
 
-                if (context.testSettings.checkWithBrowser) {
-                    status = await checkExternalPageLinkBrowser(context.page, normalizedLink);
-                }
-                else {
-                    status = await checkExternalPageLink(context.page, normalizedLink);
-                }
+                status = await (context.testSettings.checkWithBrowser
+                    ? checkExternalPageLinkBrowser(context.page, normalizedLink)
+                    : checkExternalPageLink(context.page, normalizedLink));
             }
             catch {
                 status = httpResponse.unknownError;

package/lib/{schemaErrors.js → schema-errors.js}

@@ -16,14 +16,16 @@ 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, '/');
-        // eslint-disable-next-line sonarjs/no-nested-template-literals -- less intuitive
-        return `${accumulator}${isNaN(unencodedValue) ? `.${unencodedValue}` : `[${unencodedValue}]`}`;
+        const encodedValue = Number.isNaN(Number(unencodedValue)) ? `.${unencodedValue}` : `[${unencodedValue}]`;
+        return `${accumulator}${encodedValue}`;
     }, '');
 };
 
-const processErrorParams = (error) => {
+const processErrorParameters = (error) => {
     let formattedMessage = error.message;
     // Ajv includes all allowed values in params.allowedValues,
     // so add to message if available.
@@ -44,14 +46,14 @@ const processErrorParams = (error) => {
 const formatErrors = (errors) => {
     const margin = 2;
     let maxLength = 0;
-    errors.forEach(error => {
+    for (const error of errors) {
         error.dataKey = getDataKey(error.instancePath);
-        error.formattedMessage = processErrorParams(error);
+        error.formattedMessage = processErrorParameters(error);
         // Get max dataKey length for all errors to line up column in final output
         if (error.dataKey.length > maxLength) {
             maxLength = error.dataKey.length;
         }
-    });
+    }
     return errors.map(error => `  ${error.dataKey.padEnd(maxLength + margin)}${red(error.formattedMessage)}`);
 };
 

package/lib/{testUtils.js → test-utils.js}

@@ -40,8 +40,8 @@ const pageanTest = async (name, testFunction, testContext, testSettingProperty)
         try {
             results = await testFunction(testContext);
         }
-        catch (err) {
-            results = { result: testResultStates.failed, data: { error: err } };
+        catch (error) {
+            results = { result: testResultStates.failed, data: { error } };
         }
         if (results.result === testResultStates.failed && testSettings.failWarn) {
             results.result = testResultStates.warning;

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;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pagean",
-  "version": "6.0.7",
+  "version": "6.0.8",
   "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",
@@ -46,29 +46,29 @@
   "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/eslint-config-standard": "^12.0.2",
     "@aarongoldenthal/stylelint-config-standard": "^7.0.0",
     "bin-tester": "^2.0.1",
-    "eslint": "^8.8.0",
+    "eslint": "^8.12.0",
     "jest": "^27.5.1",
     "jest-junit": "^13.0.0",
     "markdownlint-cli": "^0.31.1",
     "strip-ansi": "^6.0.1",
-    "stylelint": "^14.5.0"
+    "stylelint": "^14.6.1"
   },
   "dependencies": {
-    "ajv": "^8.10.0",
+    "ajv": "^8.11.0",
     "ajv-errors": "^3.0.0",
-    "axios": "^0.25.0",
+    "axios": "^0.26.1",
     "ci-logger": "^4.0.1",
-    "commander": "^9.0.0",
+    "commander": "^9.1.0",
     "handlebars": "^4.7.7",
-    "htmlhint": "^1.1.2",
+    "htmlhint": "^1.1.3",
     "kleur": "^4.1.4",
     "normalize-url": "^6.1.0",
     "protocolify": "^3.0.0",
-    "puppeteer": "^13.3.1"
+    "puppeteer": "^13.5.1"
   }
 }