pagean 8.0.0 → 8.0.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 - 2022 Aaron Goldenthal
+Copyright (c) 2019 - 2023 Aaron Goldenthal
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -142,6 +142,8 @@ For any failing test, the `data` array in the test report includes the original
 ]
 ```
 
+Note: This test will check all links on the page, and does not respect mechanisms inteded to limit web crawlers such as `robots.txt` or `noindex` tags.
+
 ## Reports
 
 Based on the `reporters` configuration, Pagean results may be displayed in the console and saved in two reports in the project root directory (any or all of the three):
@@ -254,6 +256,10 @@ Provided with the Pagean project are Docker images configured to run the tests.
 
 **Note:** Any images in the `gitlab-ci-utils/pagean/tmp` repository are temporary images used during the build process and may be deleted at any point.
 
+### Puppeteer Cache Location
+
+In [Puppeteer v19](https://github.com/puppeteer/puppeteer/releases/tag/v19.0.0) the default cache location for installing the Chrome binary was changed from within the project's `node_modules` folder to `~/.cache/puppeteer`. To simplify execution in a container, the `PUPPETEER_CACHE_DIR` environment variable is set to install the Chrome binaries in `/home/pptruser/.cache/puppeteer` during container build, so setting to another value before execution can cause errors where Puppeteer cannot find the Chrome binary.
+
 ## GitLab CI Configuration
 
 The following is an example job from a .gitlab-ci.yml file to use this image to run Pagean against another project in GitLab CI:

package/bin/pageanrc-lint.js

@@ -25,7 +25,7 @@ const logError = (message, exitOnError = true) => {
 const outputJsonResults = (configFileName, lintResults) => {
     // Log JSON to stdout for consistency, and eliminates extraneous stderr
     // output in PowerShell which produces invalid JSON if piped to file.
-    // eslint-disable-next-line no-magic-numbers
+    // eslint-disable-next-line no-magic-numbers -- index
     log({ message: JSON.stringify(lintResults.errors, undefined, 2) });
     if (!lintResults.isValid) {
         logError(`Errors found in file ${configFileName}`);

package/index.js

@@ -60,7 +60,7 @@ const executeAllTests = async (config) => {
 
     if (testResults.summary.failed > 0) {
         // For test harness want process to exit with error code
-        // eslint-disable-next-line unicorn/no-process-exit, no-process-exit, no-magic-numbers
+        // eslint-disable-next-line unicorn/no-process-exit, no-magic-numbers -- exit code
         process.exit(2);
     }
 };

package/lib/link-utils.js

@@ -141,7 +141,11 @@ const checkExternalPageLink = async (page, link, useGet = false) => {
     try {
         const options = {
             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

package/lib/reporter.js

@@ -14,7 +14,7 @@ const htmlReportFileName = './pagean-results.html';
 const jsonReportFileName = './pagean-results.json';
 
 handlebars.registerHelper('json', (context) => {
-    // eslint-disable-next-line no-magic-numbers
+    // eslint-disable-next-line no-magic-numbers -- count
     return JSON.stringify(context, undefined, 2);
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pagean",
-  "version": "8.0.0",
+  "version": "8.0.2",
   "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",
@@ -51,28 +51,28 @@
   },
   "homepage": "https://gitlab.com/gitlab-ci-utils/pagean",
   "devDependencies": {
-    "@aarongoldenthal/eslint-config-standard": "^17.0.1",
-    "@aarongoldenthal/stylelint-config-standard": "^11.2.1",
+    "@aarongoldenthal/eslint-config-standard": "^19.0.2",
+    "@aarongoldenthal/stylelint-config-standard": "^12.0.1",
     "bin-tester": "^3.0.0",
-    "eslint": "^8.26.0",
-    "jest": "^29.2.2",
-    "jest-junit": "^14.0.1",
-    "markdownlint-cli": "^0.32.2",
-    "prettier": "^2.7.1",
+    "eslint": "^8.32.0",
+    "jest": "^29.3.1",
+    "jest-junit": "^15.0.0",
+    "markdownlint-cli": "^0.33.0",
+    "prettier": "^2.8.3",
     "strip-ansi": "^6.0.1",
-    "stylelint": "^14.14.0"
+    "stylelint": "^14.16.1"
   },
   "dependencies": {
-    "ajv": "^8.11.0",
+    "ajv": "^8.12.0",
     "ajv-errors": "^3.0.0",
-    "axios": "^1.1.3",
+    "axios": "^1.2.2",
     "ci-logger": "^5.1.0",
-    "commander": "^9.4.1",
+    "commander": "^10.0.0",
     "handlebars": "^4.7.7",
     "htmlhint": "^1.1.4",
     "kleur": "^4.1.5",
     "normalize-url": "^6.1.0",
     "protocolify": "^3.0.0",
-    "puppeteer": "^19.2.0"
+    "puppeteer": "^19.5.2"
   }
 }