html-snapshots 1.2.0 → 1.3.1

package/lib/input-generators/_base.js

@@ -27,6 +27,7 @@ const defaults = Object.freeze({
   useJQuery: false,
   verbose: false,
   phantomjsOptions: "",
+  puppeteerLaunchOptions: {},
   debug: {
     flag: "false",
     slowMo: 500
@@ -86,6 +87,23 @@ function supplyMissingDefault (options, name) {
   }
 }
 
+/**
+ * Prepare single Object options so that it is always used for all pages (globally).
+ *
+ * @param {String} name - The property name.
+ * @param {Object} options - Input generator options.
+ */
+function prepSingleObjectOptions (name, options) {
+  const objectOpt = options[name];
+  const toString = Object.prototype.toString;
+  const isObj = toString.call(objectOpt) === "[object Object]";
+  if (isObj) {
+    options[name] = {
+      __default: objectOpt
+    };
+  }
+}
+
 /**
  * Prepare options for use by an input generator.
  *
@@ -96,11 +114,20 @@ function prepOptions (options, listener) {
   // Ensure defaults are represented
   common.ensure(options, defaults);
 
+  // Prep single, global object options for normalization.
+  [
+    "puppeteerLaunchOptions"
+  ]
+  .forEach((optionName) => {
+    prepSingleObjectOptions(optionName, options);  
+  });
+
   // Normalize certain arguments if they are not functions.
   // The certain arguments are per-page options.
   // However, outputPath is a special case
   [
-    "selector", "timeout", "useJQuery", "verbose", "phantomjsOptions"
+    "selector", "timeout", "useJQuery", "verbose", "phantomjsOptions",
+    "puppeteerLaunchOptions"
   ]
   .forEach((perPageOption) => {
     options[perPageOption] = normalize(options[perPageOption]);
@@ -228,7 +255,8 @@ module.exports = {
    * @param {Function} options.userJQuery - Produces a jquery bool given a page url.
    * @param {Function} options.verbose - Produces a verbose bool given a page url.
    * @param {Function} options.phantomjsOptions - Produces phantomjs options given a page url.
-   * @param {Function} options.debug - Produces debug options given a page url.
+   * @param {Function} options.puppeteerLaunchOptions - Produces puppeteer launch options given a page url.
+   * @param {Object} options.debug - Produces debug options given a page url.
    * @param {Function} options._inputEmitter - The EventEmitter to generate input.
    * @param {String} page - The url to the page resource.
    * @returns {String} The full output file path.
@@ -262,7 +290,9 @@ module.exports = {
         verbose: options.verbose(page),
         // map the input page to phantomJS options
         phantomjsOptions: options.phantomjsOptions(page),
-        // useful for testing, debugging
+        // map the input page to puppeteer launch options
+        puppeteerLaunchOptions: options.puppeteerLaunchOptions(page),
+        // useful for puppeteer testing, debugging
         debug: options.debug,
         __page: page
       });

package/lib/puppeteer/index.js

@@ -12,6 +12,7 @@
  * [6] - filter
  * [7] - debug
  * [8] - slowMo
+ * [9] - arbitrary launchOptions
  */
 const puppeteer = require('puppeteer');
 const path = require('path');
@@ -31,13 +32,17 @@ const options = {
   timeout: process.argv[5] ? parseInt(process.argv[5], 10) : 10000,
   filter: process.argv[6] && process.argv[6] !== 'false' ? process.argv[6] : null,
   debug: process.argv[7] && process.argv[7].toLowerCase() === 'true' ? true : false,
-  slowMo: process.argv[8] ? parseInt(process.argv[8], 10) : 500
+  slowMo: process.argv[8] ? parseInt(process.argv[8], 10) : 500,
+  launchOpts: process.argv[9] ? JSON.parse(process.argv[9]) : null
+};
+const launchOptions = {
+  ...(options.debug ? {
+    headless: false,
+    slowMo: options.slowMo,
+    devtools: true
+  } : {}),
+  ...(options.launchOpts ?? {})
 };
-const launchOptions = options.debug ? {
-  headless: false,
-  slowMo: options.slowMo,
-  devtools: true
-} : {};
 
 /**
  * Run the snapshot script.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-snapshots",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "author": {
     "name": "Alex Grant",
     "email": "alex@localnerve.com",
@@ -57,14 +57,14 @@
     "lodash": "4.17.21",
     "mkdirp": "1.0.4",
     "phantomjs-prebuilt": "2.1.16",
-    "puppeteer": "^19.0.0",
+    "puppeteer": "^19.2.0",
     "rimraf": "3.0.2",
     "xml2js": "0.4.23"
   },
   "devDependencies": {
-    "eslint": "8.25.0",
+    "eslint": "8.26.0",
     "express": "4.18.2",
-    "mocha": "10.0.0",
+    "mocha": "10.1.0",
     "c8": "7.12.0",
     "precommit-hook": "3.0.0",
     "server-destroy": "1.0.1",

package/test/mocha/browsers/puppeteer.js

@@ -43,7 +43,7 @@ function puppeteerTests () {
     });
     
     it("should succeed with minimal args", function (done) {
-      this.timeout(5000);
+      this.timeout(4000);
 
       rimraf(outputDir);
 
@@ -54,6 +54,28 @@ function puppeteerTests () {
       ], done);
     });
 
+    it("should succeed with stringified puppeteerLaunchOptions", function (done) {
+      this.timeout(4000);
+      rimraf(outputDir);
+
+      // override the debug options to prove stringified launch opts worked.
+      const puppeteerLaunchOptions = {
+        headless: true,
+        devTools: false
+      };
+
+      spawnPuppeteer([
+        outputFile,
+        `http://localhost:${port}/`,
+        "body",
+        4000,
+        "false",
+        "true",
+        10,
+        JSON.stringify(puppeteerLaunchOptions)
+      ], done);
+    });
+
     it("should fail if insufficient input args", function (done) {
       rimraf(outputDir);
       
@@ -98,6 +120,7 @@ function puppeteerTests () {
         10
       ], done);
     });
+
   };
 }
 

package/test/mocha/input-generators/test.js

@@ -921,6 +921,96 @@ describe("input-generator", function () {
 
       });
 
+      describe("puppeteerLaunchOptions option", function () {
+        it("should accept a single object and apply globally", function (done) {
+          let count = 0;
+          const puppeteerLaunchOptions = {
+            one: 'one',
+            two: 2,
+            three: ['three', 'four', 'five'],
+            six: {
+              seven: 'seven'
+            }
+          };
+
+          const result = gen.run(options.decorate({
+            source,
+            puppeteerLaunchOptions,
+            outputDir: thisOutputDir
+          }), function (input) {
+            const classString = Object.prototype.toString;
+
+            assert.equal(classString.call(input.puppeteerLaunchOptions), classString.call(puppeteerLaunchOptions),
+              `${input.__page}:\ninput.puppeteerLaunchOptions should be an object:\n${
+                require("util").inspect(input.puppeteerLaunchOptions)
+              }`
+            );
+
+            assert.deepEqual(input.puppeteerLaunchOptions, puppeteerLaunchOptions,
+              `${input.__page}:\ninput.puppeteerLaunchOptions should be equal to the original input`);
+
+            count++;
+            if (count === urls) {
+              done();
+            }
+          });
+
+          result
+            .then(function () {
+              assert.ok(true);
+            })
+            .catch(function (err) {
+              assert.fail(`Run should not fail: ${err.toString()}`);
+            });
+        });
+
+        it("should accept a function and apply per url", function (done) {
+          const plo1 = { one: "one" },
+            plo2 = { two: "two" },
+            plo3 = { three: "three" };
+
+          const globalOptions = {
+            "/": plo1,
+            "/contact": plo2,
+            "/services/carpets": plo3
+          };
+          const localOptions = {
+            "http://northstar.local/": plo1,
+            "http://northstar.local/contact": plo2,
+            "http://northstar.local/services/carpets": plo3
+          };
+          const opts = globalUrl ? globalOptions : localOptions;
+          let count = 0;
+          const ploFn = function (url) {
+            return opts[url];
+          };
+
+          const result = gen.run(options.decorate({
+            source: source,
+            outputDir: thisOutputDir,
+            puppeteerLaunchOptions: ploFn
+          }), function (input) {
+            const testOption = opts[input.__page] ? opts[input.__page] : base.defaults({}).puppeteerLaunchOptions;
+
+            assert.deepEqual(input.puppeteerLaunchOptions, testOption,
+              `${input.__page}:\ninput.puppeteerLaunchOptions: ${input.puppeteerLaunchOptions} != testPuppeteerLaunchOption: ${testOption}`);
+
+            count++;
+            if (count === urls) {
+              done();
+            }
+          });
+
+          result
+            .then(function () {
+              assert.ok(true);
+            })
+            .catch(function (err) {
+              assert.fail(`Run should not fail: ${err.toString()}`);
+            });
+        });
+      });
+
       describe("url behavior", function () {
 
         it("should replace the default hostname in results", function (done) {