@percy/core 1.0.0-beta.76 → 1.0.0

package/dist/snapshot.js

@@ -1,279 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.discoverSnapshotResources = discoverSnapshotResources;
-exports.getSnapshotConfig = getSnapshotConfig;
-
-var _logger = _interopRequireDefault(require("@percy/logger"));
-
-var _config = _interopRequireDefault(require("@percy/config"));
-
-var _utils = require("@percy/config/dist/utils");
-
-var _utils2 = require("./utils");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-// Validates and returns snapshot options merged with percy config options.
-function getSnapshotConfig(percy, options) {
-  var _ref, _snapshot$widths;
-
-  if (!options.url) throw new Error('Missing required URL for snapshot');
-  let {
-    config
-  } = percy;
-  let uri = new URL(options.url);
-  let name = options.name || `${uri.pathname}${uri.search}${uri.hash}`;
-  let meta = {
-    snapshot: {
-      name
-    },
-    build: percy.build
-  };
-  let log = (0, _logger.default)('core:snapshot'); // migrate deprecated snapshot config options
-
-  let {
-    clientInfo,
-    environmentInfo,
-    ...snapshot
-  } = _config.default.migrate(options, '/snapshot'); // throw an error when missing required widths
-
-
-  if (!((_ref = (_snapshot$widths = snapshot.widths) !== null && _snapshot$widths !== void 0 ? _snapshot$widths : percy.config.snapshot.widths) !== null && _ref !== void 0 && _ref.length)) {
-    throw new Error('Missing required widths for snapshot');
-  } // validate and scrub according to dom snaphot presence
-
-
-  let errors = _config.default.validate(snapshot, snapshot.domSnapshot ? '/snapshot/dom' : '/snapshot');
-
-  if (errors) {
-    log.warn('Invalid snapshot options:', meta);
-
-    for (let e of errors) log.warn(`- ${e.path}: ${e.message}`, meta);
-  } // inherit options from the percy config
-
-
-  return (0, _utils.merge)([config.snapshot, {
-    name,
-    meta,
-    clientInfo,
-    environmentInfo,
-    // only specific discovery options are used per-snapshot
-    discovery: {
-      allowedHostnames: [uri.hostname, ...config.discovery.allowedHostnames],
-      networkIdleTimeout: config.discovery.networkIdleTimeout,
-      requestHeaders: config.discovery.requestHeaders,
-      authorization: config.discovery.authorization,
-      disableCache: config.discovery.disableCache,
-      userAgent: config.discovery.userAgent
-    }
-  }, snapshot], (path, prev, next) => {
-    switch (path.map(k => k.toString()).join('.')) {
-      case 'widths':
-        // override and sort widths
-        return [path, next.sort((a, b) => a - b)];
-
-      case 'percyCSS':
-        // concatenate percy css
-        return [path, [prev, next].filter(Boolean).join('\n')];
-
-      case 'execute':
-        // shorthand for execute.beforeSnapshot
-        return Array.isArray(next) || typeof next !== 'object' ? [path.concat('beforeSnapshot'), next] : [path];
-    } // ensure additional snapshots have complete names
-
-
-    if (path[0] === 'additionalSnapshots' && path.length === 2) {
-      let {
-        prefix = '',
-        suffix = '',
-        ...n
-      } = next;
-      next = {
-        name: `${prefix}${name}${suffix}`,
-        ...n
-      };
-      return [path, next];
-    }
-  });
-} // Returns a complete and valid snapshot config object and logs verbose debug logs detailing various
-// snapshot options. When `showInfo` is true, specific messages will be logged as info logs rather
-// than debug logs.
-
-
-function debugSnapshotConfig(snapshot, showInfo) {
-  let log = (0, _logger.default)('core:snapshot'); // log snapshot info
-
-  log.debug('---------', snapshot.meta);
-  if (showInfo) log.info(`Snapshot found: ${snapshot.name}`, snapshot.meta);else log.debug(`Handling snapshot: ${snapshot.name}`, snapshot.meta); // will log debug info for an object property if its value is defined
-
-  let debugProp = (obj, prop, format = String) => {
-    let val = prop.split('.').reduce((o, k) => o === null || o === void 0 ? void 0 : o[k], obj);
-
-    if (val != null) {
-      // join formatted array values with a space
-      val = [].concat(val).map(format).join(', ');
-      log.debug(`- ${prop}: ${val}`, snapshot.meta);
-    }
-  };
-
-  debugProp(snapshot, 'url');
-  debugProp(snapshot, 'widths', v => `${v}px`);
-  debugProp(snapshot, 'minHeight', v => `${v}px`);
-  debugProp(snapshot, 'enableJavaScript');
-  debugProp(snapshot, 'waitForTimeout');
-  debugProp(snapshot, 'waitForSelector');
-  debugProp(snapshot, 'execute.afterNavigation');
-  debugProp(snapshot, 'execute.beforeResize');
-  debugProp(snapshot, 'execute.afterResize');
-  debugProp(snapshot, 'execute.beforeSnapshot');
-  debugProp(snapshot, 'discovery.allowedHostnames');
-  debugProp(snapshot, 'discovery.requestHeaders', JSON.stringify);
-  debugProp(snapshot, 'discovery.authorization', JSON.stringify);
-  debugProp(snapshot, 'discovery.disableCache');
-  debugProp(snapshot, 'discovery.userAgent');
-  debugProp(snapshot, 'clientInfo');
-  debugProp(snapshot, 'environmentInfo');
-  debugProp(snapshot, 'domSnapshot', Boolean);
-
-  for (let added of snapshot.additionalSnapshots || []) {
-    if (showInfo) log.info(`Snapshot found: ${added.name}`, snapshot.meta);else log.debug(`Additional snapshot: ${added.name}`, snapshot.meta);
-    debugProp(added, 'waitForTimeout');
-    debugProp(added, 'waitForSelector');
-    debugProp(added, 'execute');
-  }
-} // Calls the provided callback with additional resources
-
-
-function handleSnapshotResources(snapshot, map, callback) {
-  let resources = [...map.values()]; // sort the root resource first
-
-  let [root] = resources.splice(resources.findIndex(r => r.root), 1);
-  resources.unshift(root); // inject Percy CSS
-
-  if (snapshot.percyCSS) {
-    let css = (0, _utils2.createPercyCSSResource)(root.url, snapshot.percyCSS);
-    resources.push(css); // replace root contents and associated properties
-
-    Object.assign(root, (0, _utils2.createRootResource)(root.url, root.content.replace(/(<\/body>)(?!.*\1)/is, `<link data-percy-specific-css rel="stylesheet" href="${css.pathname}"/>` + '$&')));
-  } // include associated snapshot logs matched by meta information
-
-
-  resources.push((0, _utils2.createLogResource)(_logger.default.query(log => {
-    var _log$meta$snapshot;
-
-    return ((_log$meta$snapshot = log.meta.snapshot) === null || _log$meta$snapshot === void 0 ? void 0 : _log$meta$snapshot.name) === snapshot.meta.snapshot.name;
-  })));
-  return callback(snapshot, resources);
-} // Wait for a page's asset discovery network to idle
-
-
-function waitForDiscoveryNetworkIdle(page, options) {
-  let {
-    allowedHostnames,
-    networkIdleTimeout
-  } = options;
-
-  let filter = r => (0, _utils2.hostnameMatches)(allowedHostnames, r.url);
-
-  return page.network.idle(filter, networkIdleTimeout);
-} // Used to cache resources across core instances
-
-
-const RESOURCE_CACHE_KEY = Symbol('resource-cache'); // Discovers resources for a snapshot using a browser page to intercept requests. The callback
-// function will be called with the snapshot name (for additional snapshots) and an array of
-// discovered resources. When additional snapshots are provided, the callback will be called once
-// for each snapshot.
-
-async function* discoverSnapshotResources(percy, snapshot, callback) {
-  var _snapshot$enableJavaS;
-
-  debugSnapshotConfig(snapshot, percy.dryRun); // when dry-running, invoke the callback for each snapshot and immediately return
-
-  let allSnapshots = [snapshot, ...(snapshot.additionalSnapshots || [])];
-  if (percy.dryRun) return allSnapshots.map(s => callback(s)); // keep a global resource cache across snapshots
-
-  let cache = percy[RESOURCE_CACHE_KEY] || (percy[RESOURCE_CACHE_KEY] = new Map()); // copy widths to prevent mutation later
-
-  let widths = snapshot.widths.slice(); // preload the root resource for existing dom snapshots
-
-  let resources = new Map(snapshot.domSnapshot && [(0, _utils2.createRootResource)(snapshot.url, snapshot.domSnapshot)].map(resource => [resource.url, resource])); // open a new browser page
-
-  let page = yield percy.browser.page({
-    enableJavaScript: (_snapshot$enableJavaS = snapshot.enableJavaScript) !== null && _snapshot$enableJavaS !== void 0 ? _snapshot$enableJavaS : !snapshot.domSnapshot,
-    networkIdleTimeout: snapshot.discovery.networkIdleTimeout,
-    requestHeaders: snapshot.discovery.requestHeaders,
-    authorization: snapshot.discovery.authorization,
-    userAgent: snapshot.discovery.userAgent,
-    meta: snapshot.meta,
-    // enable network inteception
-    intercept: {
-      enableJavaScript: snapshot.enableJavaScript,
-      disableCache: snapshot.discovery.disableCache,
-      allowedHostnames: snapshot.discovery.allowedHostnames,
-      getResource: u => resources.get(u) || cache.get(u),
-      saveResource: r => resources.set(r.url, r) && cache.set(r.url, r)
-    }
-  });
-
-  try {
-    var _snapshot$execute;
-
-    // set the initial page size
-    yield page.resize({
-      width: widths.shift(),
-      height: snapshot.minHeight
-    }); // navigate to the url
-
-    yield page.goto(snapshot.url);
-    yield page.evaluate((_snapshot$execute = snapshot.execute) === null || _snapshot$execute === void 0 ? void 0 : _snapshot$execute.afterNavigation); // trigger resize events for other widths
-
-    for (let width of widths) {
-      var _snapshot$execute2, _snapshot$execute3;
-
-      yield page.evaluate((_snapshot$execute2 = snapshot.execute) === null || _snapshot$execute2 === void 0 ? void 0 : _snapshot$execute2.beforeResize);
-      yield waitForDiscoveryNetworkIdle(page, snapshot.discovery);
-      yield page.resize({
-        width,
-        height: snapshot.minHeight
-      });
-      yield page.evaluate((_snapshot$execute3 = snapshot.execute) === null || _snapshot$execute3 === void 0 ? void 0 : _snapshot$execute3.afterResize);
-    }
-
-    if (snapshot.domSnapshot) {
-      // ensure discovery has finished and handle resources
-      yield waitForDiscoveryNetworkIdle(page, snapshot.discovery);
-      handleSnapshotResources(snapshot, resources, callback);
-    } else {
-      let {
-        enableJavaScript
-      } = snapshot; // capture snapshots sequentially
-
-      for (let snap of allSnapshots) {
-        // will wait for timeouts, selectors, and additional network activity
-        let {
-          url,
-          dom
-        } = yield page.snapshot({
-          enableJavaScript,
-          ...snap
-        });
-        resources.set(url, (0, _utils2.createRootResource)(url, dom)); // shallow merge with root snapshot options
-
-        handleSnapshotResources({ ...snapshot,
-          ...snap
-        }, resources, callback); // remove the previously captured dom snapshot
-
-        resources.delete(url);
-      }
-    } // page clean up
-
-
-    await page.close();
-  } catch (error) {
-    await page.close();
-    throw error;
-  }
-}

package/dist/utils.js

@@ -1,170 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createLogResource = createLogResource;
-exports.createPercyCSSResource = createPercyCSSResource;
-exports.createResource = createResource;
-exports.createRootResource = createRootResource;
-exports.generatePromise = generatePromise;
-exports.hostname = hostname;
-Object.defineProperty(exports, "hostnameMatches", {
-  enumerable: true,
-  get: function () {
-    return _utils.hostnameMatches;
-  }
-});
-exports.normalizeURL = normalizeURL;
-Object.defineProperty(exports, "request", {
-  enumerable: true,
-  get: function () {
-    return _request.request;
-  }
-});
-exports.waitFor = waitFor;
-
-var _utils = require("@percy/client/dist/utils");
-
-var _request = require("@percy/client/dist/request");
-
-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; }
-
-// Returns the hostname portion of a URL.
-function hostname(url) {
-  return new URL(url).hostname;
-} // Normalizes a URL by stripping hashes to ensure unique resources.
-
-
-function normalizeURL(url) {
-  let {
-    protocol,
-    host,
-    pathname,
-    search
-  } = new URL(url);
-  return `${protocol}//${host}${pathname}${search}`;
-} // Creates a local resource object containing the resource URL, mimetype, content, sha, and any
-// other additional resources attributes.
-
-
-function createResource(url, content, mimetype, attrs) {
-  return { ...attrs,
-    sha: (0, _utils.sha256hash)(content),
-    mimetype,
-    content,
-    url
-  };
-} // Creates a root resource object with an additional `root: true` property. The URL is normalized
-// here as a convenience since root resources are usually created outside of asset discovery.
-
-
-function createRootResource(url, content) {
-  return createResource(normalizeURL(url), content, 'text/html', {
-    root: true
-  });
-} // Creates a Percy CSS resource object.
-
-
-function createPercyCSSResource(url, css) {
-  let {
-    href,
-    pathname
-  } = new URL(`/percy-specific.${Date.now()}.css`, url);
-  return createResource(href, css, 'text/css', {
-    pathname
-  });
-} // Creates a log resource object.
-
-
-function createLogResource(logs) {
-  return createResource(`/percy.${Date.now()}.log`, JSON.stringify(logs), 'text/plain');
-} // Creates a thennable, cancelable, generator instance
-
-
-function generatePromise(gen) {
-  var _gen, _gen2;
-
-  // ensure a generator is provided
-  if (typeof gen === 'function') gen = gen();
-  if (typeof ((_gen = gen) === null || _gen === void 0 ? void 0 : _gen.then) === 'function') return gen;
-  if (typeof ((_gen2 = gen) === null || _gen2 === void 0 ? void 0 : _gen2.next) !== 'function' || !(typeof gen[Symbol.iterator] === 'function' || typeof gen[Symbol.asyncIterator] === 'function')) return Promise.resolve(gen); // used to trigger cancelation
-
-  class Canceled extends Error {
-    constructor(...args) {
-      super(...args);
-
-      _defineProperty(this, "name", 'Canceled');
-
-      _defineProperty(this, "canceled", true);
-    }
-
-  } // recursively runs the generator, maybe throwing an error when canceled
-
-
-  let handleNext = async (g, last) => {
-    let canceled = g.cancel.triggered;
-    let {
-      done,
-      value
-    } = canceled ? await g.throw(canceled) : await g.next(last);
-    if (canceled) delete g.cancel.triggered;
-    return done ? value : handleNext(g, value);
-  }; // handle cancelation errors by calling any cancel handlers
-
-
-  let cancelable = async function* () {
-    try {
-      return yield* gen;
-    } catch (error) {
-      if (error.canceled) {
-        let cancelers = cancelable.cancelers || [];
-
-        for (let c of cancelers) await c(error);
-      }
-
-      throw error;
-    }
-  }(); // augment the cancelable generator with promise-like and cancel methods
-
-
-  return Object.assign(cancelable, {
-    run: () => cancelable.promise || (cancelable.promise = handleNext(cancelable)),
-    then: (resolve, reject) => cancelable.run().then(resolve, reject),
-    catch: reject => cancelable.run().catch(reject),
-    cancel: message => {
-      cancelable.cancel.triggered = new Canceled(message);
-      return cancelable;
-    },
-    canceled: handler => {
-      (cancelable.cancelers || (cancelable.cancelers = [])).push(handler);
-      return cancelable;
-    }
-  });
-} // Resolves when the predicate function returns true within the timeout. If an idle option is
-// provided, the predicate will be checked again before resolving, after the idle period. The poll
-// option determines how often the predicate check will be run.
-
-
-function waitFor(predicate, options) {
-  let {
-    poll = 10,
-    timeout,
-    idle
-  } = Number.isInteger(options) ? {
-    timeout: options
-  } : options || {};
-  return generatePromise(async function* check(start, done) {
-    while (true) {
-      if (timeout && Date.now() - start >= timeout) {
-        throw new Error(`Timeout of ${timeout}ms exceeded.`);
-      } else if (!predicate()) {
-        yield new Promise(r => setTimeout(r, poll, done = false));
-      } else if (idle && !done) {
-        yield new Promise(r => setTimeout(r, idle, done = true));
-      } else {
-        return;
-      }
-    }
-  }(Date.now()));
-}

package/post-install.js

@@ -1,23 +0,0 @@
-// Automatically download and install Chromium if the PERCY_POSTINSTALL_BROWSER environment variable
-// is present and truthy, or if this module is required directly from within another module. Useful
-// when running in CI environments with heavy caching of node_modules.
-if (process.env.PERCY_POSTINSTALL_BROWSER || require.main !== module) {
-  const fs = require('fs');
-  const path = require('path');
-
-  // the src directory indicates postinstall during development
-  const isDev = fs.existsSync(path.join(__dirname, 'src'));
-
-  // register babel transforms for development install
-  if (isDev) require('../../scripts/babel-register');
-
-  // require dev or production modules
-  const install = require(isDev ? './src/install' : './dist/install');
-  const log = require(isDev ? '../logger/src' : '@percy/logger')('core:post-install');
-
-  // install chromium
-  install.chromium().catch(error => {
-    log.error('Encountered an error while installing Chromium');
-    log.error(error);
-  });
-}

package/test/helpers/server.js

@@ -1,35 +0,0 @@
-// aliased to src for coverage during tests without needing to compile this file
-const { default: Server } = require('@percy/core/dist/server');
-
-function createTestServer({ default: defaultReply, ...replies }, port = 8000) {
-  let server = new Server();
-
-  // alternate route handling
-  let handleReply = reply => async (req, res) => {
-    let [status, headers, body] = typeof reply === 'function' ? await reply(req) : reply;
-    if (!Buffer.isBuffer(body) && typeof body !== 'string') body = JSON.stringify(body);
-    return res.send(status, headers, body);
-  };
-
-  // map replies to alternate route handlers
-  server.reply = (p, reply) => (replies[p] = handleReply(reply));
-  for (let [p, reply] of Object.entries(replies)) server.reply(p, reply);
-  if (defaultReply) defaultReply = handleReply(defaultReply);
-
-  // track requests and route replies
-  server.requests = [];
-  server.route(async (req, res, next) => {
-    let pathname = req.url.pathname;
-    if (req.url.search) pathname += req.url.search;
-    server.requests.push(req.body ? [pathname, req.body] : [pathname]);
-    let reply = replies[req.url.pathname] || defaultReply;
-    return reply ? await reply(req, res) : next();
-  });
-
-  // automatically listen
-  return server.listen(port);
-};
-
-// support commonjs environments
-module.exports = createTestServer;
-module.exports.createTestServer = createTestServer;

package/types/index.d.ts

@@ -1,101 +0,0 @@
-// utility types
-type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };
-type XOR<T, U> = (T | U) extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
-
-type LogLevel = 'error' | 'warn' | 'info' | 'debug' | 'silent';
-
-interface Pojo {
-  [x: string]: any;
-}
-
-interface AuthCredentials {
-  username: string;
-  password: string;
-}
-
-interface DiscoveryOptions {
-  requestHeaders?: Pojo;
-  authorization?: AuthCredentials;
-  allowedHostnames?: string[];
-  disableCache?: boolean;
-}
-
-interface DiscoveryLaunchOptions {
-  executable?: string;
-  args?: string[];
-  timeout?: number;
-  headless?: boolean;
-}
-
-interface AllDiscoveryOptions extends DiscoveryOptions {
-  networkIdleTimeout?: number;
-  concurrency?: number;
-  launchOptions?: DiscoveryLaunchOptions;
-}
-
-interface CommonSnapshotOptions {
-  widths?: number[];
-  minHeight?: number;
-  percyCSS?: string;
-  enableJavaScript?: boolean;
-}
-
-export interface SnapshotOptions extends CommonSnapshotOptions {
-  discovery?: DiscoveryOptions;
-}
-
-type ClientEnvInfo = {
-  clientInfo?: string,
-  environmentInfo?: string
-}
-
-export type PercyConfigOptions<C = Pojo> = C & {
-  snapshot?: CommonSnapshotOptions,
-  discovery?: AllDiscoveryOptions
-}
-
-export type PercyOptions<C = Pojo> = {
-  token?: string,
-  server?: boolean,
-  port?: number,
-  concurrency?: number,
-  loglevel?: LogLevel,
-  config?: undefined | string | false
-} & ClientEnvInfo & PercyConfigOptions<C>;
-
-type SnapshotExec = () => void | Promise<void>;
-
-type AdditionalSnapshot = (XOR<XOR<
-  { name: string },
-  { prefix: string, suffix?: string }>,
-  { suffix: string, prefix?: string }>
-) & { execute: SnapshotExec };
-
-declare class Percy {
-  static start(options?: PercyOptions): Promise<Percy>;
-  constructor(options?: PercyOptions);
-  loglevel(): LogLevel;
-  loglevel(level: LogLevel): void;
-  config: PercyConfigOptions;
-  setConfig(config: ClientEnvInfo & PercyConfigOptions): PercyConfigOptions;
-  start(): Promise<void>;
-  stop(force?: boolean): Promise<void>;
-  idle(): Promise<void>;
-  close(): void;
-
-  snapshot(options: {
-    url: string,
-    name?: string,
-    clientInfo?: string,
-    environmentInfo?: string
-  } & XOR<{
-    domSnapshot: string
-  }, {
-    waitForTimeout?: number,
-    waitForSelector?: string,
-    execute?: SnapshotExec,
-    additionalSnapshots?: AdditionalSnapshot[]
-  }> & SnapshotOptions): Promise<void>;
-}
-
-export default Percy;