@percy/core 1.0.0-beta.69 → 1.0.0-beta.72

package/dist/browser.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.default = exports.Browser = void 0;
 
 var _os = _interopRequireDefault(require("os"));
 
@@ -29,6 +29,10 @@ var _page = _interopRequireDefault(require("./page"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
+
+function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
+
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
 function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "set"); _classApplyDescriptorSet(receiver, descriptor, value); return value; }
@@ -59,14 +63,16 @@ class Browser extends _events.default {
 
     _defineProperty(this, "sessions", new Map());
 
+    _defineProperty(this, "readyState", null);
+
     _defineProperty(this, "closed", false);
 
-    _callbacks.set(this, {
+    _classPrivateFieldInitSpec(this, _callbacks, {
       writable: true,
       value: new Map()
     });
 
-    _lastid.set(this, {
+    _classPrivateFieldInitSpec(this, _lastid, {
       writable: true,
       value: 0
     });
@@ -74,7 +80,8 @@ class Browser extends _events.default {
     _defineProperty(this, "args", [// disable the translate popup
     '--disable-features=Translate', // disable several subsystems which run network requests in the background
     '--disable-background-networking', // disable task throttling of timer tasks from background pages
-    '--disable-background-timer-throttling', // disable backgrounding renderers for occluded windows (reduce nondeterminism)
+    '--disable-background-timer-throttling', // disable backgrounding renderer processes
+    '--disable-renderer-backgrounding', // disable backgrounding renderers for occluded windows (reduce nondeterminism)
     '--disable-backgrounding-occluded-windows', // disable crash reporting
     '--disable-breakpad', // disable client side phishing detection
     '--disable-client-side-phishing-detection', // disable default component extensions with background pages for performance
@@ -112,7 +119,9 @@ class Browser extends _events.default {
   }
 
   async launch() {
-    if (this.isConnected()) return; // check if any provided executable exists
+    // already launching or launched
+    if (this.readyState != null) return;
+    this.readyState = 0; // check if any provided executable exists
 
     if (this.executable && !(0, _fs.existsSync)(this.executable)) {
       this.log.error(`Browser executable not found: ${this.executable}`);
@@ -122,10 +131,10 @@ class Browser extends _events.default {
 
     this.executable || (this.executable = await _install.default.chromium()); // create a temporary profile directory
 
-    this.profile = await _fs.promises.mkdtemp(_path.default.join(_os.default.tmpdir(), 'percy-browser-')); // collect args to pass to the browser process
-
-    let args = [...this.args, `--user-data-dir=${this.profile}`]; // spawn the browser process detached in its own group and session
+    this.profile = await _fs.promises.mkdtemp(_path.default.join(_os.default.tmpdir(), 'percy-browser-')); // spawn the browser process detached in its own group and session
 
+    let args = this.args.concat(`--user-data-dir=${this.profile}`);
+    this.log.debug('Launching browser');
     this.process = (0, _crossSpawn.default)(this.executable, args, {
       detached: process.platform !== 'win32'
     }); // connect a websocket to the devtools address
@@ -139,6 +148,8 @@ class Browser extends _events.default {
     this.ws.on('message', data => this._handleMessage(data)); // get version information
 
     this.version = await this.send('Browser.getVersion');
+    this.log.debug(`Browser connected [${this.process.pid}]: ${this.version.product}`);
+    this.readyState = 1;
   }
 
   isConnected() {
@@ -150,7 +161,10 @@ class Browser extends _events.default {
   async close() {
     var _this$process4, _this$ws2;
 
-    if (this._closed) return this._closed; // resolves when the browser has closed
+    // not running, already closed, or closing
+    if (this._closed) return this._closed;
+    this.readyState = 2;
+    this.log.debug('Closing browser'); // resolves when the browser has closed
 
     this._closed = Promise.all([new Promise(resolve => {
       /* istanbul ignore next: race condition paranoia */
@@ -177,6 +191,9 @@ class Browser extends _events.default {
           this.log.debug(error);
         });
       }
+    }).then(() => {
+      this.log.debug('Browser closed');
+      this.readyState = 3;
     }); // reject any pending callbacks
 
     for (let callback of _classPrivateFieldGet(this, _callbacks).values()) {
@@ -273,34 +290,28 @@ class Browser extends _events.default {
         let match = chunk.match(/^DevTools listening on (ws:\/\/.*)$/m);
         if (match) cleanup(() => resolve(match[1]));
       };
-      /* istanbul ignore next: for sanity */
-
 
-      let handleExit = () => handleError();
+      let handleExitClose = () => handleError();
 
-      let handleClose = () => handleError();
+      let handleError = error => cleanup(() => {
+        var _error$message;
 
-      let handleError = error => {
-        cleanup(() => {
-          var _error$message;
-
-          return reject(new Error(`Failed to launch browser. ${(_error$message = error === null || error === void 0 ? void 0 : error.message) !== null && _error$message !== void 0 ? _error$message : ''}\n${stderr}'\n\n`));
-        });
-      };
+        return reject(new Error(`Failed to launch browser. ${(_error$message = error === null || error === void 0 ? void 0 : error.message) !== null && _error$message !== void 0 ? _error$message : ''}\n${stderr}'\n\n`));
+      });
 
       let cleanup = callback => {
         clearTimeout(timeoutId);
         this.process.stderr.off('data', handleData);
-        this.process.stderr.off('close', handleClose);
-        this.process.off('exit', handleExit);
+        this.process.stderr.off('close', handleExitClose);
+        this.process.off('exit', handleExitClose);
         this.process.off('error', handleError);
         callback();
       };
 
       let timeoutId = setTimeout(() => handleError(new Error(`Timed out after ${timeout}ms`)), timeout);
       this.process.stderr.on('data', handleData);
-      this.process.stderr.on('close', handleClose);
-      this.process.on('exit', handleExit);
+      this.process.stderr.on('close', handleExitClose);
+      this.process.on('exit', handleExitClose);
       this.process.on('error', handleError);
     }));
     return this._address;
@@ -347,4 +358,6 @@ class Browser extends _events.default {
 
 }
 
-exports.default = Browser;
+exports.Browser = Browser;
+var _default = Browser;
+exports.default = _default;

package/dist/config.js

@@ -296,9 +296,12 @@ const snapshotDOMSchema = {
     // schemas have no concept of inheritance, but we can leverage JS for brevity
     ...snapshotSchema.properties
   }
-}; // Config migrate function
+}; // Grouped schemas for easier registration
 
 exports.snapshotDOMSchema = snapshotDOMSchema;
+const schemas = [configSchema, snapshotSchema, snapshotDOMSchema]; // Config migrate function
+
+exports.schemas = schemas;
 
 function configMigration(config, util) {
   /* eslint-disable curly */
@@ -348,10 +351,8 @@ function snapshotMigration(config, util) {
     map: 'additionalSnapshots',
     ...notice
   });
-} // Convinient references for schema registrations
+} // Grouped migrations for easier registration
 
 
-const schemas = [configSchema, snapshotSchema, snapshotDOMSchema];
-exports.schemas = schemas;
 const migrations = [['/config', configMigration], ['/snapshot', snapshotMigration]];
 exports.migrations = migrations;

package/dist/index.js

@@ -1,13 +1,15 @@
 "use strict";
 
-// Register core config options
-const {
-  default: PercyConfig
-} = require('@percy/config');
+const PercyConfig = require('@percy/config');
 
 const CoreConfig = require('./config');
 
+const {
+  Percy
+} = require('./percy');
+
 PercyConfig.addSchema(CoreConfig.schemas);
-PercyConfig.addMigration(CoreConfig.migrations); // Export the Percy class with commonjs compatibility
+PercyConfig.addMigration(CoreConfig.migrations); // export the Percy class with commonjs compatibility
 
-module.exports = require('./percy').default;
+module.exports = Percy;
+module.exports.Percy = Percy;

package/dist/network.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.default = exports.Network = void 0;
 
 var _logger = _interopRequireDefault(require("@percy/logger"));
 
@@ -13,6 +13,10 @@ var _discovery = require("./discovery");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
+
+function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
+
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
 function _classPrivateFieldGet(receiver, privateMap) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "get"); return _classApplyDescriptorGet(receiver, descriptor); }
@@ -37,22 +41,22 @@ class Network {
 
     _defineProperty(this, "log", (0, _logger.default)('core:network'));
 
-    _pending.set(this, {
+    _classPrivateFieldInitSpec(this, _pending, {
       writable: true,
       value: new Map()
     });
 
-    _requests.set(this, {
+    _classPrivateFieldInitSpec(this, _requests, {
       writable: true,
       value: new Map()
     });
 
-    _intercepts.set(this, {
+    _classPrivateFieldInitSpec(this, _intercepts, {
       writable: true,
       value: new Map()
     });
 
-    _authentications.set(this, {
+    _classPrivateFieldInitSpec(this, _authentications, {
       writable: true,
       value: new Set()
     });
@@ -353,6 +357,9 @@ class Network {
 
 }
 
-exports.default = Network;
+exports.Network = Network;
+
+_defineProperty(Network, "TIMEOUT", 30000);
 
-_defineProperty(Network, "TIMEOUT", 30000);
+var _default = Network;
+exports.default = _default;

package/dist/page.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.default = exports.Page = void 0;
 
 var _fs = require("fs");
 
@@ -179,7 +179,14 @@ class Page {
     } // wrap the function body with percy helpers
 
 
-    fnbody = 'function withPercyHelpers() {' + (`return (${fnbody})({` + `waitFor: ${_utils.waitFor}` + '}, ...arguments)') + '}'; // send the call function command
+    fnbody = 'function withPercyHelpers() {\n' + [`return (${fnbody})({ generatePromise, waitFor }, ...arguments);`, `${_utils.generatePromise}`, `${_utils.waitFor}`].join('\n\n') + '}';
+    /* istanbul ignore else: ironic. */
+
+    if (fnbody.includes('cov_')) {
+      // remove coverage statements during testing
+      fnbody = fnbody.replace(/cov_.*?(;\n?|,)\s*/g, '');
+    } // send the call function command
+
 
     let {
       result,
@@ -214,7 +221,7 @@ class Page {
 
     for (let script of scripts) {
       if (typeof script === 'string') {
-        script = `async eval({ waitFor }) {\n${script}\n}`;
+        script = `async eval() {\n${script}\n}`;
       }
 
       await this.eval(script);
@@ -250,7 +257,7 @@ class Page {
     } // execute any javascript
 
 
-    await this.evaluate(typeof execute === 'function' ? execute : execute === null || execute === void 0 ? void 0 : execute.beforeSnapshot); // wait for any final network activity before capturing the dom snapshot
+    await this.evaluate(typeof execute === 'object' && !Array.isArray(execute) ? execute.beforeSnapshot : execute); // wait for any final network activity before capturing the dom snapshot
 
     await this.network.idle(); // inject @percy/dom for serialization by evaluating the file contents which adds a global
     // PercyDOM object that we can later check against
@@ -278,6 +285,9 @@ class Page {
 
 }
 
-exports.default = Page;
+exports.Page = Page;
+
+_defineProperty(Page, "TIMEOUT", 30000);
 
-_defineProperty(Page, "TIMEOUT", 30000);
+var _default = Page;
+exports.default = _default;