@percy/core 1.0.0-beta.9 → 1.0.0

package/dist/percy.js

@@ -1,428 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _client = _interopRequireDefault(require("@percy/client"));
-
-var _config = _interopRequireDefault(require("@percy/config"));
-
-var _logger = _interopRequireDefault(require("@percy/logger"));
-
-var _config2 = require("./config");
-
-var _discoverer = _interopRequireDefault(require("./discoverer"));
-
-var _percyCss = _interopRequireDefault(require("./percy-css"));
-
-var _server = require("./server");
-
-var _queue = _interopRequireDefault(require("./queue"));
-
-var _assert = _interopRequireDefault(require("./utils/assert"));
-
-var _resources = require("./utils/resources");
-
-var _url = require("./utils/url");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _classPrivateFieldGet(receiver, privateMap) { var descriptor = privateMap.get(receiver); if (!descriptor) { throw new TypeError("attempted to get private field on non-instance"); } if (descriptor.get) { return descriptor.get.call(receiver); } return descriptor.value; }
-
-function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = privateMap.get(receiver); if (!descriptor) { throw new TypeError("attempted to set private field on non-instance"); } if (descriptor.set) { descriptor.set.call(receiver, value); } else { if (!descriptor.writable) { throw new TypeError("attempted to set read only private field"); } descriptor.value = value; } return value; }
-
-// Register core config options
-_config.default.addSchema(_config2.schema); // A Percy instance will create a new build when started, handle snapshot
-// creation, asset discovery, and resource uploads, and will finalize the build
-// when stopped. Snapshots are processed concurrently and the build is not
-// finalized until all snapshots have been handled.
-
-
-var _captures = new WeakMap();
-
-var _snapshots = new WeakMap();
-
-var _stopping = new WeakMap();
-
-var _running = new WeakMap();
-
-class Percy {
-  // Static shortcut to create and start an instance in one call
-  static async start(options) {
-    let instance = new this(options);
-    await instance.start();
-    return instance;
-  }
-
-  constructor({
-    // provided to @percy/client
-    token,
-    clientInfo = '',
-    environmentInfo = '',
-    // snapshot server options
-    server = true,
-    port = 5338,
-    // capture concurrency
-    concurrency = 5,
-    // initial log level
-    loglevel,
-    // configuration filepath
-    config,
-    // options such as `snapshot` and `discovery` that are valid Percy config
-    // options which will become accessible via the `#config` property
-    ...options
-  } = {}) {
-    _captures.set(this, {
-      writable: true,
-      value: null
-    });
-
-    _snapshots.set(this, {
-      writable: true,
-      value: null
-    });
-
-    _stopping.set(this, {
-      writable: true,
-      value: false
-    });
-
-    _running.set(this, {
-      writable: true,
-      value: false
-    });
-
-    if (loglevel) {
-      this.loglevel(loglevel);
-    }
-
-    if (server) {
-      this.port = port;
-      this.app = (0, _server.createServerApp)(this);
-    }
-
-    _classPrivateFieldSet(this, _snapshots, new _queue.default());
-
-    _classPrivateFieldSet(this, _captures, new _queue.default(concurrency));
-
-    this.config = config === false ? _config.default.getDefaults(options) : _config.default.load({
-      path: config,
-      overrides: options
-    });
-    this.discoverer = new _discoverer.default(this.config.discovery);
-    this.client = new _client.default({
-      token,
-      clientInfo,
-      environmentInfo
-    });
-  } // Shortcut for controlling the global logger's log level.
-
-
-  loglevel(level) {
-    return _logger.default.loglevel(level);
-  } // Snapshot server API address
-
-
-  apiAddress() {
-    var _this$server, _address;
-
-    let {
-      address
-    } = ((_this$server = this.server) === null || _this$server === void 0 ? void 0 : _this$server.address()) || {};
-    address = ((_address = address) === null || _address === void 0 ? void 0 : _address.includes(':')) ? `[${address}]` : address;
-    return address && `http://${address}:${this.port}/percy`;
-  } // Returns a boolean indicating if this instance is running.
-
-
-  isRunning() {
-    return _classPrivateFieldGet(this, _running);
-  } // Starts the local API server, the asset discovery process, and creates a new
-  // Percy build. When an error is encountered, the discoverer and server are closed.
-
-
-  async start() {
-    // throws when the token is missing
-    this.client.getToken();
-
-    try {
-      // if there is an exress app, a server should be started
-      if (this.app) {
-        this.server = await (0, _server.startServer)(this.app, this.port);
-      } // launch the discoverer browser and create a percy build
-
-
-      await this.discoverer.launch();
-      await this.client.createBuild(); // log build details
-
-      let build = this.client.build;
-      let meta = {
-        build: {
-          id: build.id
-        }
-      };
-
-      _logger.default.info('Percy has started!', meta);
-
-      _logger.default.info(`Created build #${build.number}: ${build.url}`, meta); // mark this process as running
-
-
-      _classPrivateFieldSet(this, _running, true);
-    } catch (error) {
-      var _this$server2;
-
-      // on error, close any running browser or server
-      await this.discoverer.close();
-      (_this$server2 = this.server) === null || _this$server2 === void 0 ? void 0 : _this$server2.close(); // throw an easier-to understand error when the port is taken
-
-      if (error.code === 'EADDRINUSE') {
-        throw new Error('Percy is already running or the port is in use');
-      } else {
-        throw error;
-      }
-    }
-  } // Stops the local API server and discoverer once snapshots have completed and
-  // finalizes the Percy build. Does nothing if not running.
-
-
-  async stop() {
-    // do nothing if not running or already stopping
-    if (this.isRunning() && !_classPrivateFieldGet(this, _stopping)) {
-      var _this$server3;
-
-      _classPrivateFieldSet(this, _stopping, true);
-
-      let build = this.client.build;
-      let meta = {
-        build: {
-          id: build.id
-        }
-      };
-
-      _logger.default.info('Stopping percy...', meta); // log about queued captures or uploads
-
-
-      if (_classPrivateFieldGet(this, _captures).length) {
-        _logger.default.info(`Waiting for ${_classPrivateFieldGet(this, _captures).length} page(s) to finish snapshotting`, meta);
-      } else if (_classPrivateFieldGet(this, _snapshots).length) {
-        _logger.default.info(`Waiting for ${_classPrivateFieldGet(this, _snapshots).length} snapshot(s) to finish uploading`, meta);
-      } // wait for any queued captures or snapshots
-
-
-      await this.idle(); // close the server and browser
-
-      (_this$server3 = this.server) === null || _this$server3 === void 0 ? void 0 : _this$server3.close();
-      await this.discoverer.close();
-
-      _classPrivateFieldSet(this, _running, false); // log build info
-
-
-      await this.client.finalizeBuild();
-
-      _logger.default.info(`Finalized build #${build.number}: ${build.url}`, meta);
-
-      _logger.default.info('Done!');
-    }
-  } // Resolves when captures and snapshots are idle.
-
-
-  async idle() {
-    await Promise.all([_classPrivateFieldGet(this, _captures).idle(), _classPrivateFieldGet(this, _snapshots).idle()]);
-  } // Handles asset discovery for the URL and DOM snapshot at each requested
-  // width with the provided options. Resolves when the snapshot has been taken
-  // and asset discovery is finished, but does not gaurantee that the snapshot
-  // will be succesfully uploaded.
-
-
-  snapshot({
-    url,
-    name,
-    domSnapshot,
-    widths,
-    minHeight,
-    percyCSS,
-    requestHeaders,
-    enableJavaScript,
-    clientInfo,
-    environmentInfo
-  }) {
-    var _widths, _widths2, _minHeight, _ref, _enableJavaScript;
-
-    // required assertions
-    (0, _assert.default)(this.isRunning(), 'Not running');
-    (0, _assert.default)(url, 'Missing required argument: url');
-    (0, _assert.default)(name, 'Missing required argument: name');
-    (0, _assert.default)(domSnapshot, 'Missing required argument: domSnapshot'); // fallback to instance snapshot widths
-
-    widths = ((_widths = widths) === null || _widths === void 0 ? void 0 : _widths.length) ? widths : this.config.snapshot.widths;
-    (0, _assert.default)((_widths2 = widths) === null || _widths2 === void 0 ? void 0 : _widths2.length, 'Missing required argument: widths');
-    (0, _assert.default)(widths.length <= 10, 'too many widths'); // normalize the URL
-
-    url = (0, _url.normalizeURL)(url); // fallback to instance minimum height
-
-    minHeight = (_minHeight = minHeight) !== null && _minHeight !== void 0 ? _minHeight : this.config.snapshot.minHeight; // combine snapshot Percy CSS with instance Percy CSS
-
-    percyCSS = [this.config.snapshot.percyCSS, percyCSS].filter(Boolean).join('\n'); // combine snapshot request headers with instance request headers
-
-    requestHeaders = { ...this.config.snapshot.requestHeaders,
-      ...requestHeaders
-    }; // fallback to instance enable JS flag
-
-    enableJavaScript = (_ref = (_enableJavaScript = enableJavaScript) !== null && _enableJavaScript !== void 0 ? _enableJavaScript : this.config.snapshot.enableJavaScript) !== null && _ref !== void 0 ? _ref : false; // useful meta info for the logfile
-
-    let meta = {
-      snapshot: {
-        name
-      },
-      build: {
-        id: this.client.build.id
-      }
-    };
-
-    _logger.default.debug('---------');
-
-    _logger.default.debug('Handling snapshot:', meta);
-
-    _logger.default.debug(`-> name: ${name}`, meta);
-
-    _logger.default.debug(`-> url: ${url}`, meta);
-
-    _logger.default.debug(`-> widths: ${widths.join('px, ')}px`, meta);
-
-    _logger.default.debug(`-> clientInfo: ${clientInfo}`, meta);
-
-    _logger.default.debug(`-> environmentInfo: ${environmentInfo}`, meta);
-
-    _logger.default.debug(`-> requestHeaders: ${JSON.stringify(requestHeaders)}`, meta);
-
-    _logger.default.debug(`-> domSnapshot:\n${domSnapshot.length <= 1024 ? domSnapshot : domSnapshot.substr(0, 1024) + '... [truncated]'}`, meta); // use a promise as a try-catch so we can do the remaining work
-    // asynchronously, but perform the above synchronously
-
-
-    return Promise.resolve().then(async () => {
-      // inject Percy CSS
-      let [percyDOM, percyCSSResource] = (0, _percyCss.default)(url, domSnapshot, percyCSS, meta); // use a map so resources remain unique by url
-
-      let resources = new Map([[url, (0, _resources.createRootResource)(url, percyDOM)]]); // include the Percy CSS resource if there was one
-
-      if (percyCSSResource) resources.set('percy-css', percyCSSResource); // gather resources at each width concurrently
-
-      await Promise.all(widths.map(width => this.discoverer.gatherResources(resources, {
-        rootUrl: url,
-        rootDom: domSnapshot,
-        enableJavaScript,
-        requestHeaders,
-        width,
-        meta
-      }))); // include a log resource for debugging
-
-      let logs = await _logger.default.query({
-        filter: ({
-          snapshot: s
-        }) => (s === null || s === void 0 ? void 0 : s.name) === name
-      });
-      resources.set('percy-logs', (0, _resources.createLogResource)(logs)); // log that the snapshot has been taken before uploading it
-
-      _logger.default.info(`Snapshot taken: ${name}`, meta); // upload within the async snapshot queue
-
-
-      _classPrivateFieldGet(this, _snapshots).push(() => this.client.sendSnapshot({
-        name,
-        widths,
-        minHeight,
-        enableJavaScript,
-        clientInfo,
-        environmentInfo,
-        resources: Array.from(resources.values())
-      }).catch(error => {
-        _logger.default.error(`Encountered an error uploading snapshot: ${name}`, meta);
-
-        _logger.default.error(error);
-      }));
-    }).catch(error => {
-      _logger.default.error(`Encountered an error taking snapshot: ${name}`, meta);
-
-      _logger.default.error(error);
-    });
-  }
-
-  capture({
-    url,
-    name,
-    waitFor,
-    execute,
-    snapshots = [],
-    ...options
-  }) {
-    (0, _assert.default)(this.isRunning(), 'Not running');
-    (0, _assert.default)(url, `Missing URL for${name ? ` ${name}` : ' snapshots'}`);
-    snapshots = name ? [{
-      name,
-      execute
-    }].concat(snapshots) : snapshots;
-    (0, _assert.default)(snapshots.length && snapshots.every(s => s.name), `Missing name for ${url}`); // the entire capture process happens within the async capture queue
-
-    return _classPrivateFieldGet(this, _captures).push(async () => {
-      let results = [];
-      let page;
-
-      try {
-        // borrow a page from the discoverer
-        page = await this.discoverer.page(); // allow @percy/dom injection
-
-        await page.setBypassCSP(true); // set any request headers
-
-        await page.setExtraHTTPHeaders(options.requestHeaders || {}); // @todo - resize viewport
-        // go to and wait for network idle
-
-        await page.goto(url, {
-          waitUntil: 'networkidle2'
-        }); // inject @percy/dom for serialization
-
-        await page.addScriptTag({
-          path: require.resolve('@percy/dom')
-        }); // wait for any other elements or timeout before snapshotting
-
-        if (waitFor) await page.waitFor(waitFor); // multiple snapshots can be captured on a single page
-
-        for (let {
-          name,
-          execute
-        } of snapshots) {
-          // optionally execute a script to interact with the page
-          if (execute) await execute(page); // serialize and capture a DOM snapshot
-
-          /* istanbul ignore next: no instrumenting injected code */
-
-          let domSnapshot = await page.evaluate(({
-            enableJavaScript
-          }) =>
-          /* eslint-disable-next-line no-undef */
-          PercyDOM.serialize({
-            enableJavaScript
-          }), options); // snapshots are awaited on concurrently after sequentially capturing their DOM
-
-          results.push(this.snapshot({ ...options,
-            url,
-            name,
-            domSnapshot
-          }));
-        }
-      } catch (error) {
-        _logger.default.error(`Encountered an error for page: ${url}`);
-
-        _logger.default.error(error);
-      } finally {
-        var _page;
-
-        // await on any resulting snapshots
-        await Promise.all(results);
-        await ((_page = page) === null || _page === void 0 ? void 0 : _page.close());
-      }
-    });
-  }
-
-}
-
-exports.default = Percy;

package/dist/queue.js

@@ -1,103 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _idle = _interopRequireDefault(require("./utils/idle"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = privateMap.get(receiver); if (!descriptor) { throw new TypeError("attempted to set private field on non-instance"); } if (descriptor.set) { descriptor.set.call(receiver, value); } else { if (!descriptor.writable) { throw new TypeError("attempted to set read only private field"); } descriptor.value = value; } return value; }
-
-function _classPrivateFieldGet(receiver, privateMap) { var descriptor = privateMap.get(receiver); if (!descriptor) { throw new TypeError("attempted to get private field on non-instance"); } if (descriptor.get) { return descriptor.get.call(receiver); } return descriptor.value; }
-
-var _queue = new WeakMap();
-
-var _pending = new WeakMap();
-
-// Concurrent task-based queue for handling snapshots and asset discovery.
-class Queue {
-  // Defaults to inifinite concurrency
-  constructor(concurrency = Infinity) {
-    _queue.set(this, {
-      writable: true,
-      value: []
-    });
-
-    _pending.set(this, {
-      writable: true,
-      value: 0
-    });
-
-    this.concurrency = concurrency;
-  } // Pushing a new task to the queue will attempt to run it unless the
-  // concurrency limit has been reached. The returned promise will resolve or
-  // reject when the task has succeeded or thrown an error.
-
-
-  push(task) {
-    return new Promise((resolve, reject) => {
-      _classPrivateFieldGet(this, _queue).push({
-        task,
-        resolve,
-        reject
-      });
-
-      this._dequeue();
-    });
-  } // Returns the amount of queued and pending tasks.
-
-
-  get length() {
-    return _classPrivateFieldGet(this, _queue).length + _classPrivateFieldGet(this, _pending);
-  } // Resolves when there are no more queued or pending tasks.
-
-
-  idle() {
-    return (0, _idle.default)(() => this.length);
-  } // Clears the active queue. Tasks that were queued will not be executed and
-  // tasks that are pending (have already executed) will be allowed to finish.
-
-
-  clear() {
-    _classPrivateFieldSet(this, _queue, []);
-
-    return this.length;
-  } // Begins processing the queue by running the oldest task first. Pending tasks
-  // are tracked and no tasks will run unless there are less pending than the
-  // concurrency limit. More tasks are dequeued when the current task
-  // finishes. Resolves when the current task finishes although this method
-  // should never be awaited on so multiple tasks can run concurrently.
-
-
-  async _dequeue() {
-    var _this$pending;
-
-    if (_classPrivateFieldGet(this, _pending) >= this.concurrency) return;
-
-    let item = _classPrivateFieldGet(this, _queue).shift();
-
-    if (!item) return;
-    _classPrivateFieldSet(this, _pending, (_this$pending = +_classPrivateFieldGet(this, _pending)) + 1), _this$pending;
-
-    try {
-      var _this$pending2;
-
-      let value = await item.task();
-      _classPrivateFieldSet(this, _pending, (_this$pending2 = +_classPrivateFieldGet(this, _pending)) - 1), _this$pending2;
-      item.resolve(value);
-    } catch (error) {
-      var _this$pending3;
-
-      _classPrivateFieldSet(this, _pending, (_this$pending3 = +_classPrivateFieldGet(this, _pending)) - 1), _this$pending3;
-      item.reject(error);
-    } finally {
-      this._dequeue();
-    }
-  }
-
-}
-
-exports.default = Queue;

package/dist/server.js

@@ -1,82 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createServerApp = createServerApp;
-exports.startServer = startServer;
-
-// Handles async routes with a middleware pattern to catch and forward errors
-function asyncRoute(handler) {
-  return (req, res, next) => handler(req, res, next).catch(next);
-} // Lazily creates and returns an express app for communicating with the Percy
-// instance using a local API
-
-
-function createServerApp(percy) {
-  // lazily required to speed up imports when the server is not needed
-  let express = require('express');
-
-  let cors = require('cors');
-
-  let bodyParser = require('body-parser');
-
-  return express().use(cors()).use(bodyParser.urlencoded({
-    extended: true
-  })).use(bodyParser.json({
-    limit: '50mb'
-  })) // healthcheck returns meta info as well
-  .get('/percy/healthcheck', (_, res) => {
-    res.json({
-      success: true,
-      config: percy.config,
-      loglevel: percy.loglevel(),
-      build: percy.client.build
-    });
-  }) // responds when idle
-  .get('/percy/idle', asyncRoute(async (_, res) => {
-    await percy.idle();
-    res.json({
-      success: true
-    });
-  })) // serves @percy/dom as a convenience
-  .get('/percy/dom.js', (_, res) => {
-    res.sendFile(require.resolve('@percy/dom'));
-  }) // forward snapshot requests
-  .post('/percy/snapshot', asyncRoute(async (req, res) => {
-    await percy.snapshot(req.body);
-    res.json({
-      success: true
-    });
-  })) // stops the instance
-  .post('/percy/stop', asyncRoute(async (_, res) => {
-    await percy.stop();
-    res.json({
-      success: true
-    });
-  })) // other routes 404
-  .use('*', (_, res) => {
-    res.status(404).json({
-      success: false,
-      error: 'Not found'
-    });
-  }) // generic error handler
-  .use(({
-    message
-  }, req, res, next) => {
-    res.status(500).json({
-      success: false,
-      error: message
-    });
-  });
-} // Promised based helper for starting an app at the specified port. Resolves
-// when the server is listening, rejects if there are any errors when starting.
-
-
-function startServer(app, port) {
-  return new Promise((resolve, reject) => {
-    let server = app.listen(port);
-    server.once('listening', () => resolve(server));
-    server.once('error', reject);
-  });
-}

package/dist/utils/assert.js

@@ -1,50 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = percyAssert;
-
-var _assert = require("assert");
-
-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; }
-
-// Percy assertions errors contain extra meta data and have specific lookup keys
-// for different computed assertion error messages.
-class PercyAssertionError extends Error {
-  constructor(lookup, meta = {}) {
-    var _PercyAssertionError$, _PercyAssertionError$2, _PercyAssertionError$3;
-
-    super((_PercyAssertionError$ = (_PercyAssertionError$2 = (_PercyAssertionError$3 = PercyAssertionError.dict)[lookup]) === null || _PercyAssertionError$2 === void 0 ? void 0 : _PercyAssertionError$2.call(_PercyAssertionError$3, meta)) !== null && _PercyAssertionError$ !== void 0 ? _PercyAssertionError$ : lookup);
-    this.name = this.constructor.name;
-    this.meta = meta;
-  }
-
-  toString() {
-    return this.message;
-  }
-
-} // Wraps native assert to throw a Percy assertion error with optional meta.
-
-
-_defineProperty(PercyAssertionError, "dict", {
-  'disallowed status': ({
-    status
-  }) => `Disallowed response status [${status}]`,
-  'is empty': () => 'Empty response',
-  'is remote': () => 'Remote resource',
-  'no response': () => 'No response',
-  'too many bytes': ({
-    size
-  }) => `Max file size exceeded [${size}]`,
-  'too many redirects': ({
-    length
-  }) => `Too many redirects [${length}]`,
-  'too many widths': ({
-    widths
-  }) => `Too many widths requested: maximum is 10, requested ${widths}`
-});
-
-function percyAssert(condition, lookup, meta) {
-  (0, _assert.strict)(condition, new PercyAssertionError(lookup, meta));
-}

package/dist/utils/bytes.js

@@ -1,24 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = readableBytes;
-
-// Converts a raw byte integer into a human readable string.
-function readableBytes(bytes) {
-  let units = ['kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
-  let thresh = 1024;
-  let u = -1;
-
-  if (Math.abs(bytes) < thresh) {
-    return `${bytes}B`;
-  }
-
-  while (Math.abs(bytes) >= thresh && u < units.length - 1) {
-    bytes /= thresh;
-    ++u;
-  }
-
-  return `${bytes.toFixed(1)}${units[u]}`;
-}