@percy/core 1.0.0-beta.76 → 1.0.0

package/dist/network.js

@@ -1,365 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = exports.Network = void 0;
-
-var _logger = _interopRequireDefault(require("@percy/logger"));
-
-var _utils = require("./utils");
-
-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); }
-
-function _classExtractFieldDescriptor(receiver, privateMap, action) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to " + action + " private field on non-instance"); } return privateMap.get(receiver); }
-
-function _classApplyDescriptorGet(receiver, descriptor) { if (descriptor.get) { return descriptor.get.call(receiver); } return descriptor.value; }
-
-var _pending = /*#__PURE__*/new WeakMap();
-
-var _requests = /*#__PURE__*/new WeakMap();
-
-var _intercepts = /*#__PURE__*/new WeakMap();
-
-var _authentications = /*#__PURE__*/new WeakMap();
-
-// The Interceptor class creates common handlers for dealing with intercepting asset requests
-// for a given page using various devtools protocol events and commands.
-class Network {
-  constructor(page, options) {
-    var _options$networkIdleT, _options$requestHeade, _options$userAgent;
-
-    _defineProperty(this, "log", (0, _logger.default)('core:network'));
-
-    _classPrivateFieldInitSpec(this, _pending, {
-      writable: true,
-      value: new Map()
-    });
-
-    _classPrivateFieldInitSpec(this, _requests, {
-      writable: true,
-      value: new Map()
-    });
-
-    _classPrivateFieldInitSpec(this, _intercepts, {
-      writable: true,
-      value: new Map()
-    });
-
-    _classPrivateFieldInitSpec(this, _authentications, {
-      writable: true,
-      value: new Set()
-    });
-
-    _defineProperty(this, "_handleAuthRequired", async (session, event) => {
-      var _this$authorization;
-
-      let {
-        username,
-        password
-      } = (_this$authorization = this.authorization) !== null && _this$authorization !== void 0 ? _this$authorization : {};
-      let {
-        requestId
-      } = event;
-      let response = 'Default';
-
-      if (_classPrivateFieldGet(this, _authentications).has(requestId)) {
-        response = 'CancelAuth';
-      } else if (username || password) {
-        response = 'ProvideCredentials';
-
-        _classPrivateFieldGet(this, _authentications).add(requestId);
-      }
-
-      await session.send('Fetch.continueWithAuth', {
-        requestId: event.requestId,
-        authChallengeResponse: {
-          response,
-          username,
-          password
-        }
-      });
-    });
-
-    _defineProperty(this, "_handleRequestPaused", async (session, event) => {
-      let {
-        networkId: requestId,
-        requestId: interceptId,
-        resourceType
-      } = event;
-
-      let pending = _classPrivateFieldGet(this, _pending).get(requestId);
-
-      _classPrivateFieldGet(this, _pending).delete(requestId); // guard against redirects with the same requestId
-
-
-      if ((pending === null || pending === void 0 ? void 0 : pending.request.url) === event.request.url && pending.request.method === event.request.method) {
-        await this._handleRequest(session, { ...pending,
-          resourceType,
-          interceptId
-        });
-      } else {
-        // track the session that intercepted the request
-        _classPrivateFieldGet(this, _intercepts).set(requestId, { ...event,
-          session
-        });
-      }
-    });
-
-    _defineProperty(this, "_handleRequestWillBeSent", async event => {
-      let {
-        requestId,
-        request
-      } = event; // do not handle data urls
-
-      if (request.url.startsWith('data:')) return;
-
-      if (this.interceptEnabled) {
-        let intercept = _classPrivateFieldGet(this, _intercepts).get(requestId);
-
-        _classPrivateFieldGet(this, _pending).set(requestId, event);
-
-        if (intercept) {
-          // handle the request with the session that intercepted it
-          let {
-            session,
-            requestId: interceptId,
-            resourceType
-          } = intercept;
-          await this._handleRequest(session, { ...event,
-            resourceType,
-            interceptId
-          });
-
-          _classPrivateFieldGet(this, _intercepts).delete(requestId);
-        }
-      }
-    });
-
-    _defineProperty(this, "_handleRequest", async (session, event) => {
-      var _this$onRequest;
-
-      let {
-        request,
-        requestId,
-        interceptId,
-        resourceType
-      } = event;
-      let redirectChain = []; // if handling a redirected request, associate the response and add to its redirect chain
-
-      if (event.redirectResponse && _classPrivateFieldGet(this, _requests).has(requestId)) {
-        let req = _classPrivateFieldGet(this, _requests).get(requestId);
-
-        redirectChain = [...req.redirectChain, req]; // clean up interim requests
-
-        this._forgetRequest(req, true);
-      }
-
-      request.type = resourceType;
-      request.requestId = requestId;
-      request.interceptId = interceptId;
-      request.redirectChain = redirectChain;
-
-      _classPrivateFieldGet(this, _requests).set(requestId, request);
-
-      await ((_this$onRequest = this.onRequest) === null || _this$onRequest === void 0 ? void 0 : _this$onRequest.call(this, { ...request,
-        // call to continue the request as-is
-        continue: () => session.send('Fetch.continueRequest', {
-          requestId: interceptId
-        }),
-        // call to respond with a specific status, content, and headers
-        respond: ({
-          status,
-          content,
-          headers
-        }) => session.send('Fetch.fulfillRequest', {
-          requestId: interceptId,
-          responseCode: status || 200,
-          body: Buffer.from(content).toString('base64'),
-          responseHeaders: Object.entries(headers || {}).map(([name, value]) => {
-            return {
-              name: name.toLowerCase(),
-              value: String(value)
-            };
-          })
-        }),
-        // call to fail or abort the request
-        abort: error => session.send('Fetch.failRequest', {
-          requestId: interceptId,
-          // istanbul note: this check used to be necessary and might be again in the future if we
-          // ever need to abort a request due to reasons other than failures
-          errorReason: error ? 'Failed' :
-          /* istanbul ignore next */
-          'Aborted'
-        })
-      }));
-    });
-
-    _defineProperty(this, "_handleResponseReceived", (session, event) => {
-      let {
-        requestId,
-        response
-      } = event;
-
-      let request = _classPrivateFieldGet(this, _requests).get(requestId);
-      /* istanbul ignore if: race condition paranioa */
-
-
-      if (!request) return;
-      request.response = response;
-
-      request.response.buffer = async () => {
-        let result = await session.send('Network.getResponseBody', {
-          requestId
-        });
-        return Buffer.from(result.body, result.base64Encoded ? 'base64' : 'utf8');
-      };
-    });
-
-    _defineProperty(this, "_handleEventSourceMessageReceived", event => {
-      let request = _classPrivateFieldGet(this, _requests).get(event.requestId);
-      /* istanbul ignore else: race condition paranioa */
-
-
-      if (request) this._forgetRequest(request);
-    });
-
-    _defineProperty(this, "_handleLoadingFinished", async event => {
-      var _this$onRequestFinish;
-
-      let request = _classPrivateFieldGet(this, _requests).get(event.requestId);
-      /* istanbul ignore if: race condition paranioa */
-
-
-      if (!request) return;
-      await ((_this$onRequestFinish = this.onRequestFinished) === null || _this$onRequestFinish === void 0 ? void 0 : _this$onRequestFinish.call(this, request));
-
-      this._forgetRequest(request);
-    });
-
-    _defineProperty(this, "_handleLoadingFailed", async event => {
-      var _this$onRequestFailed;
-
-      let request = _classPrivateFieldGet(this, _requests).get(event.requestId);
-      /* istanbul ignore if: race condition paranioa */
-
-
-      if (!request) return;
-      request.error = event.errorText;
-      await ((_this$onRequestFailed = this.onRequestFailed) === null || _this$onRequestFailed === void 0 ? void 0 : _this$onRequestFailed.call(this, request));
-
-      this._forgetRequest(request);
-    });
-
-    this.page = page;
-    this.timeout = (_options$networkIdleT = options.networkIdleTimeout) !== null && _options$networkIdleT !== void 0 ? _options$networkIdleT : 100;
-    this.authorization = options.authorization;
-    this.requestHeaders = (_options$requestHeade = options.requestHeaders) !== null && _options$requestHeade !== void 0 ? _options$requestHeade : {};
-    this.userAgent = (_options$userAgent = options.userAgent) !== null && _options$userAgent !== void 0 ? _options$userAgent : // by default, emulate a non-headless browser
-    page.session.browser.version.userAgent.replace('Headless', '');
-    this.interceptEnabled = !!options.intercept;
-    this.meta = options.meta;
-
-    if (this.interceptEnabled) {
-      this.onRequest = (0, _discovery.createRequestHandler)(this, options.intercept);
-      this.onRequestFinished = (0, _discovery.createRequestFinishedHandler)(this, options.intercept);
-      this.onRequestFailed = (0, _discovery.createRequestFailedHandler)(this, options.intercept);
-    }
-  }
-
-  watch(session) {
-    session.on('Network.requestWillBeSent', this._handleRequestWillBeSent);
-    session.on('Network.responseReceived', this._handleResponseReceived.bind(this, session));
-    session.on('Network.eventSourceMessageReceived', this._handleEventSourceMessageReceived);
-    session.on('Network.loadingFinished', this._handleLoadingFinished);
-    session.on('Network.loadingFailed', this._handleLoadingFailed);
-    let commands = [session.send('Network.enable'), session.send('Network.setBypassServiceWorker', {
-      bypass: true
-    }), session.send('Network.setCacheDisabled', {
-      cacheDisabled: true
-    }), session.send('Network.setUserAgentOverride', {
-      userAgent: this.userAgent
-    }), session.send('Network.setExtraHTTPHeaders', {
-      headers: this.requestHeaders
-    })];
-
-    if (this.interceptEnabled && session.isDocument) {
-      session.on('Fetch.requestPaused', this._handleRequestPaused.bind(this, session));
-      session.on('Fetch.authRequired', this._handleAuthRequired.bind(this, session));
-      commands.push(session.send('Fetch.enable', {
-        handleAuthRequests: true,
-        patterns: [{
-          urlPattern: '*'
-        }]
-      }));
-    }
-
-    return Promise.all(commands);
-  } // Resolves after the timeout when there are no more in-flight requests.
-
-
-  async idle(filter = () => true, timeout = this.timeout) {
-    let requests = [];
-    this.log.debug(`Wait for ${timeout}ms idle`, this.meta);
-    await (0, _utils.waitFor)(() => {
-      if (this.page.session.closedReason) {
-        throw new Error(`Network error: ${this.page.session.closedReason}`);
-      }
-
-      requests = Array.from(_classPrivateFieldGet(this, _requests).values()).filter(filter);
-      return requests.length === 0;
-    }, {
-      timeout: Network.TIMEOUT,
-      idle: timeout
-    }).catch(error => {
-      // throw a better timeout error
-      if (error.message.startsWith('Timeout')) {
-        let msg = 'Timed out waiting for network requests to idle.';
-
-        if (this.log.shouldLog('debug')) {
-          msg += `\n\n  ${['Active requests:', ...requests.map(r => r.url)].join('\n  - ')}\n`;
-        }
-
-        throw new Error(msg);
-      } else {
-        throw error;
-      }
-    });
-  } // Called when a request should be removed from various trackers
-
-
-  _forgetRequest({
-    requestId,
-    interceptId
-  }, keepPending) {
-    _classPrivateFieldGet(this, _requests).delete(requestId);
-
-    _classPrivateFieldGet(this, _authentications).delete(interceptId);
-
-    if (!keepPending) {
-      _classPrivateFieldGet(this, _pending).delete(requestId);
-
-      _classPrivateFieldGet(this, _intercepts).delete(requestId);
-    }
-  } // Called when a request requires authentication. Responds to the auth request with any
-  // provided authorization credentials.
-
-
-}
-
-exports.Network = Network;
-
-_defineProperty(Network, "TIMEOUT", 30000);
-
-var _default = Network;
-exports.default = _default;

package/dist/page.js

@@ -1,293 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = exports.Page = void 0;
-
-var _fs = require("fs");
-
-var _logger = _interopRequireDefault(require("@percy/logger"));
-
-var _network = _interopRequireDefault(require("./network"));
-
-var _utils = require("./utils");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-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; }
-
-class Page {
-  constructor(_session, options) {
-    var _options$enableJavaSc;
-
-    _defineProperty(this, "log", (0, _logger.default)('core:page'));
-
-    _defineProperty(this, "_handleAttachedToTarget", event => {
-      let session = !event ? this.session : this.session.children.get(event.sessionId);
-      /* istanbul ignore if: sanity check */
-
-      if (!session) return;
-      let commands = [this.network.watch(session)];
-
-      if (session.isDocument) {
-        session.on('Target.attachedToTarget', this._handleAttachedToTarget);
-        commands.push(session.send('Page.enable'), session.send('Page.setLifecycleEventsEnabled', {
-          enabled: true
-        }), session.send('Security.setIgnoreCertificateErrors', {
-          ignore: true
-        }), session.send('Emulation.setScriptExecutionDisabled', {
-          value: !this.enableJavaScript
-        }), session.send('Target.setAutoAttach', {
-          waitForDebuggerOnStart: false,
-          autoAttach: true,
-          flatten: true
-        }));
-      }
-
-      return Promise.all(commands).catch(session._handleClosedError);
-    });
-
-    _defineProperty(this, "_handleExecutionContextCreated", event => {
-      if (this.session.targetId === event.context.auxData.frameId) {
-        this.contextId = event.context.id;
-      }
-    });
-
-    _defineProperty(this, "_handleExecutionContextDestroyed", event => {
-      /* istanbul ignore next: context cleared is usually called first */
-      if (this.contextId === event.executionContextId) {
-        this.contextId = null;
-      }
-    });
-
-    _defineProperty(this, "_handleExecutionContextsCleared", () => {
-      this.contextId = null;
-    });
-
-    this.session = _session;
-    this.enableJavaScript = (_options$enableJavaSc = options.enableJavaScript) !== null && _options$enableJavaSc !== void 0 ? _options$enableJavaSc : true;
-    this.network = new _network.default(this, options);
-    this.meta = options.meta;
-
-    _session.on('Runtime.executionContextCreated', this._handleExecutionContextCreated);
-
-    _session.on('Runtime.executionContextDestroyed', this._handleExecutionContextDestroyed);
-
-    _session.on('Runtime.executionContextsCleared', this._handleExecutionContextsCleared);
-
-    _session.send('Runtime.enable').catch(_session._handleClosedError);
-
-    this.log.debug('Page created');
-  } // Close the page
-
-
-  async close() {
-    await this.session.close();
-    this.log.debug('Page closed', this.meta);
-  } // Resize the page to the specified width and height
-
-
-  async resize({
-    width,
-    height
-  }) {
-    this.log.debug(`Resize page to ${width}x${height}`);
-    await this.session.send('Emulation.setDeviceMetricsOverride', {
-      deviceScaleFactor: 1,
-      mobile: false,
-      height,
-      width
-    });
-  } // Go to a URL and wait for navigation to occur
-
-
-  async goto(url, {
-    waitUntil = 'load'
-  } = {}) {
-    this.log.debug(`Navigate to: ${url}`, this.meta);
-
-    let navigate = async () => {
-      // set cookies before navigation so we can default the domain to this hostname
-      if (this.session.browser.cookies.length) {
-        let defaultDomain = (0, _utils.hostname)(url);
-        await this.session.send('Network.setCookies', {
-          // spread is used to make a shallow copy of the cookie
-          cookies: this.session.browser.cookies.map(({ ...cookie
-          }) => {
-            if (!cookie.url) cookie.domain || (cookie.domain = defaultDomain);
-            return cookie;
-          })
-        });
-      } // handle navigation errors
-
-
-      let res = await this.session.send('Page.navigate', {
-        url
-      });
-      if (res.errorText) throw new Error(res.errorText);
-    };
-
-    let handlers = [// wait until navigation and the correct lifecycle
-    ['Page.frameNavigated', e => this.session.targetId === e.frame.id], ['Page.lifecycleEvent', e => this.session.targetId === e.frameId && e.name === waitUntil]].map(([name, cond]) => {
-      let handler = e => cond(e) && (handler.finished = true) && handler.off();
-
-      handler.off = () => this.session.off(name, handler);
-
-      this.session.on(name, handler);
-      return handler;
-    });
-
-    try {
-      // trigger navigation and poll for handlers to have finished
-      await Promise.all([navigate(), (0, _utils.waitFor)(() => {
-        if (this.session.closedReason) {
-          throw new Error(this.session.closedReason);
-        }
-
-        return handlers.every(handler => handler.finished);
-      }, Page.TIMEOUT)]);
-    } catch (error) {
-      // remove handlers and modify the error message
-      for (let handler of handlers) handler.off();
-
-      throw Object.assign(error, {
-        message: `Navigation failed: ${error.message}`
-      });
-    }
-
-    this.log.debug('Page navigated', this.meta);
-  } // Evaluate JS functions within the page's execution context
-
-
-  async eval(fn, ...args) {
-    let fnbody = fn.toString(); // we might have a function shorthand if this fails
-
-    /* eslint-disable-next-line no-new, no-new-func */
-
-    try {
-      new Function(`(${fnbody})`);
-    } catch (error) {
-      fnbody = fnbody.startsWith('async ') ? fnbody.replace(/^async/, 'async function') : `function ${fnbody}`;
-      /* eslint-disable-next-line no-new, no-new-func */
-
-      try {
-        new Function(`(${fnbody})`);
-      } catch (error) {
-        throw new Error('The provided function is not serializable');
-      }
-    } // wrap the function body with percy helpers
-
-
-    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,
-      exceptionDetails
-    } = await this.session.send('Runtime.callFunctionOn', {
-      functionDeclaration: fnbody,
-      arguments: args.map(value => ({
-        value
-      })),
-      executionContextId: this.contextId,
-      returnByValue: true,
-      awaitPromise: true,
-      userGesture: true
-    });
-
-    if (exceptionDetails) {
-      throw exceptionDetails.exception.description;
-    } else {
-      return result.value;
-    }
-  } // Evaluate one or more scripts in succession
-
-
-  async evaluate(scripts) {
-    var _scripts;
-
-    scripts && (scripts = [].concat(scripts));
-    if (!((_scripts = scripts) !== null && _scripts !== void 0 && _scripts.length)) return;
-    this.log.debug('Evaluate JavaScript', { ...this.meta,
-      scripts
-    });
-
-    for (let script of scripts) {
-      if (typeof script === 'string') {
-        script = `async eval() {\n${script}\n}`;
-      }
-
-      await this.eval(script);
-    }
-  } // Take a snapshot after waiting for any timeout, waiting for any selector, executing any scripts,
-  // and waiting for the network idle
-
-
-  async snapshot({
-    name,
-    waitForTimeout,
-    waitForSelector,
-    execute,
-    ...options
-  }) {
-    this.log.debug(`Taking snapshot: ${name}`, this.meta); // wait for any specified timeout
-
-    if (waitForTimeout) {
-      this.log.debug(`Wait for ${waitForTimeout}ms timeout`, this.meta);
-      await new Promise(resolve => setTimeout(resolve, waitForTimeout));
-    } // wait for any specified selector
-
-
-    if (waitForSelector) {
-      this.log.debug(`Wait for selector: ${waitForSelector}`, this.meta);
-      /* istanbul ignore next: no instrumenting injected code */
-
-      await this.eval(function waitForSelector({
-        waitFor
-      }, selector, timeout) {
-        return waitFor(() => !!document.querySelector(selector), timeout).catch(() => Promise.reject(new Error(`Failed to find "${selector}"`)));
-      }, waitForSelector, Page.TIMEOUT);
-    } // execute any javascript
-
-
-    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
-
-    /* istanbul ignore next: no instrumenting injected code */
-
-    if (await this.eval(() => !window.PercyDOM)) {
-      this.log.debug('Inject @percy/dom', this.meta);
-      let script = await _fs.promises.readFile(require.resolve('@percy/dom'), 'utf-8');
-      await this.eval(new Function(script));
-      /* eslint-disable-line no-new-func */
-    } // serialize and capture a DOM snapshot
-
-
-    this.log.debug('Serialize DOM', this.meta);
-    /* istanbul ignore next: no instrumenting injected code */
-
-    return await this.eval((_, options) => ({
-      /* eslint-disable-next-line no-undef */
-      dom: PercyDOM.serialize(options),
-      url: document.URL
-    }), options);
-  } // Initialize newly attached pages and iframes with page options
-
-
-}
-
-exports.Page = Page;
-
-_defineProperty(Page, "TIMEOUT", 30000);
-
-var _default = Page;
-exports.default = _default;