@percy/core 1.0.0-beta.8 → 1.0.1

package/dist/server.js

@@ -1,82 +1,430 @@
-"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
+function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(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 _classPrivateFieldGet(receiver, privateMap) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "get"); return _classApplyDescriptorGet(receiver, descriptor); }
+
+function _classApplyDescriptorGet(receiver, descriptor) { if (descriptor.get) { return descriptor.get.call(receiver); } return descriptor.value; }
+
+function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
+
+function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "set"); _classApplyDescriptorSet(receiver, descriptor, value); return value; }
+
+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 _classApplyDescriptorSet(receiver, descriptor, value) { 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; } }
+
+import fs from 'fs';
+import path from 'path';
+import http from 'http';
+import { WebSocketServer } from 'ws';
+import mime from 'mime-types';
+import disposition from 'content-disposition';
+import { pathToRegexp, match as pathToMatch, compile as makeToPath } from 'path-to-regexp'; // custom incoming message adds a `url` and `body` properties containing the parsed URL and message
+// buffer respectively; both available after the 'end' event is emitted
+
+export class IncomingMessage extends http.IncomingMessage {
+  constructor(socket) {
+    let buffer = [];
+    super(socket).on('data', d => buffer.push(d)).on('end', () => {
+      var _this$headers$content;
+
+      this.url = new URL(this.url, `http://${this.headers.host}`);
+      if (buffer.length) this.body = Buffer.concat(buffer);
+
+      if (this.body && (_this$headers$content = this.headers['content-type']) !== null && _this$headers$content !== void 0 && _this$headers$content.includes('json')) {
+        try {
+          this.body = JSON.parse(this.body);
+        } catch {}
+      }
+    });
+  }
+
+} // custom server response adds additional convenience methods
+
+export class ServerResponse extends http.ServerResponse {
+  // responds with a status, headers, and body; the second argument can be an content-type string,
+  // or a headers object, with content-length being automatically set when a `body` is provided
+  send(status, headers, body) {
+    if (typeof headers === 'string') {
+      this.setHeader('Content-Type', headers);
+      headers = null;
+    }
+
+    if (body != null && !this.hasHeader('Content-Length')) {
+      this.setHeader('Content-Length', Buffer.byteLength(body));
+    }
+
+    return this.writeHead(status, headers).end(body);
+  } // responds with a status and content with a plain/text content-type
+
+
+  text(status, content) {
+    if (arguments.length < 2) [status, content] = [200, status];
+    return this.send(status, 'text/plain', content.toString());
+  } // responds with a status and stringified `data` with a json content-type
+
+
+  json(status, data) {
+    if (arguments.length < 2) [status, data] = [200, status];
+    return this.send(status, 'application/json', JSON.stringify(data));
+  } // responds with a status and streams a file with appropriate headers
+
+
+  file(status, filepath) {
+    if (arguments.length < 2) [status, filepath] = [200, status];
+    filepath = path.resolve(filepath);
+    let {
+      size
+    } = fs.lstatSync(filepath);
+    let range = parseByteRange(this.req.headers.range, size); // support simple range requests
+
+    if (this.req.headers.range) {
+      let byteRange = range ? `${range.start}-${range.end}` : '*';
+      this.setHeader('Content-Range', `bytes ${byteRange}/${size}`);
+      if (!range) return this.send(416);
+    }
+
+    this.writeHead(range ? 206 : status, {
+      'Accept-Ranges': 'bytes',
+      'Content-Type': mime.contentType(path.extname(filepath)),
+      'Content-Length': range ? range.end - range.start + 1 : size,
+      'Content-Disposition': disposition(filepath, {
+        type: 'inline'
+      })
+    });
+    fs.createReadStream(filepath, range).pipe(this);
+    return this;
+  }
+
+} // custom server error with a status and default reason
+
+export class ServerError extends Error {
+  static throw(status, reason) {
+    throw new this(status, reason);
+  }
+
+  constructor(status = 500, reason) {
+    super(reason || http.STATUS_CODES[status]);
+    this.status = status;
+  }
+
+} // custom server class handles routing requests and provides alternate methods and properties
+
+var _sockets = /*#__PURE__*/new WeakMap();
+
+var _defaultPort = /*#__PURE__*/new WeakMap();
+
+var _up = /*#__PURE__*/new WeakMap();
+
+var _handleUpgrade = /*#__PURE__*/new WeakSet();
+
+var _routes = /*#__PURE__*/new WeakMap();
+
+var _route = /*#__PURE__*/new WeakSet();
+
+var _handleRequest = /*#__PURE__*/new WeakSet();
+
+export class Server extends http.Server {
+  constructor({
+    port
+  } = {}) {
+    super({
+      IncomingMessage,
+      ServerResponse
+    });
+
+    _classPrivateMethodInitSpec(this, _handleRequest);
+
+    _classPrivateMethodInitSpec(this, _route);
+
+    _classPrivateMethodInitSpec(this, _handleUpgrade);
+
+    _classPrivateFieldInitSpec(this, _sockets, {
+      writable: true,
+      value: new Set()
+    });
+
+    _classPrivateFieldInitSpec(this, _defaultPort, {
+      writable: true,
+      value: void 0
+    });
+
+    _classPrivateFieldInitSpec(this, _up, {
+      writable: true,
+      value: []
+    });
+
+    _classPrivateFieldInitSpec(this, _routes, {
+      writable: true,
+      value: [{
+        priority: -1,
+        handle: (req, res, next) => {
+          res.setHeader('Access-Control-Allow-Origin', '*');
+
+          if (req.method === 'OPTIONS') {
+            let allowHeaders = req.headers['access-control-request-headers'] || '*';
+            let allowMethods = [...new Set(_classPrivateFieldGet(this, _routes).flatMap(route => (!route.match || route.match(req.url.pathname)) && route.methods || []))].join(', ');
+            res.setHeader('Access-Control-Allow-Headers', allowHeaders);
+            res.setHeader('Access-Control-Allow-Methods', allowMethods);
+            res.writeHead(204).end();
+          } else {
+            res.setHeader('Access-Control-Expose-Headers', '*');
+            return next();
+          }
+        }
+      }, {
+        priority: 3,
+        handle: req => ServerError.throw(404)
+      }]
+    });
+
+    _classPrivateFieldSet(this, _defaultPort, port); // handle requests on end
+
+
+    this.on('request', (req, res) => {
+      req.on('end', () => _classPrivateMethodGet(this, _handleRequest, _handleRequest2).call(this, req, res));
+    }); // handle websocket upgrades
+
+    this.on('upgrade', (req, sock, head) => {
+      _classPrivateMethodGet(this, _handleUpgrade, _handleUpgrade2).call(this, req, sock, head);
+    }); // track open connections to terminate when the server closes
+
+    this.on('connection', socket => {
+      let handleClose = () => _classPrivateFieldGet(this, _sockets).delete(socket);
+
+      _classPrivateFieldGet(this, _sockets).add(socket.on('close', handleClose));
     });
-  }) // responds when idle
-  .get('/percy/idle', asyncRoute(async (_, res) => {
-    await percy.idle();
-    res.json({
-      success: true
+  } // return the listening port or any default port
+
+
+  get port() {
+    var _super$address;
+
+    return ((_super$address = super.address()) === null || _super$address === void 0 ? void 0 : _super$address.port) ?? _classPrivateFieldGet(this, _defaultPort);
+  } // return a string representation of the server address
+
+
+  address() {
+    let port = this.port;
+    let host = 'http://localhost';
+    return port ? `${host}:${port}` : host;
+  } // return a promise that resolves when the server is listening
+
+
+  listen(port = _classPrivateFieldGet(this, _defaultPort)) {
+    return new Promise((resolve, reject) => {
+      let handle = err => off() && err ? reject(err) : resolve(this);
+
+      let off = () => this.off('error', handle).off('listening', handle);
+
+      super.listen(port, handle).once('error', handle);
     });
-  })) // 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
+  } // return a promise that resolves when the server closes
+
+
+  close() {
+    return new Promise(resolve => {
+      _classPrivateFieldGet(this, _sockets).forEach(socket => socket.destroy());
+
+      super.close(resolve);
     });
-  })) // stops the instance
-  .post('/percy/stop', asyncRoute(async (_, res) => {
-    await percy.stop();
-    res.json({
-      success: true
+  } // handle websocket upgrades
+
+
+  websocket(pathname, handle) {
+    if (!handle) [pathname, handle] = [null, pathname];
+
+    _classPrivateFieldGet(this, _up).push({
+      match: pathname && pathToMatch(pathname),
+      handle: (req, sock, head) => new Promise(resolve => {
+        let wss = new WebSocketServer({
+          noServer: true,
+          clientTracking: false
+        });
+        wss.handleUpgrade(req, sock, head, resolve);
+      }).then(ws => handle(ws, req))
     });
-  })) // other routes 404
-  .use('*', (_, res) => {
-    res.status(404).json({
-      success: false,
-      error: 'Not found'
+
+    if (pathname) {
+      _classPrivateFieldGet(this, _up).sort((a, b) => (a.match ? -1 : 1) - (b.match ? -1 : 1));
+    }
+
+    return this;
+  }
+
+  // set request routing and handling for pathnames and methods
+  route(method, pathname, handle) {
+    if (arguments.length === 1) [handle, method] = [method];
+    if (arguments.length === 2) [handle, pathname] = [pathname];
+    if (arguments.length === 2 && !Array.isArray(method) && method[0] === '/') [pathname, method] = [method];
+    return _classPrivateMethodGet(this, _route, _route2).call(this, {
+      priority: !pathname ? 0 : !method ? 1 : 2,
+      methods: method && [].concat(method).map(m => m.toUpperCase()),
+      match: pathname && pathToMatch(pathname),
+      handle
+    });
+  } // install a route that serves requested files from the provided directory
+
+
+  serve(pathname, directory, options) {
+    var _options;
+
+    if (typeof directory !== 'string') [options, directory] = [directory];
+    if (!directory) [pathname, directory] = ['/', pathname];
+    let root = path.resolve(directory);
+    if (!fs.existsSync(root)) throw new Error(`Not found: ${directory}`);
+    let mountPattern = pathToRegexp(pathname, null, {
+      end: false
     });
-  }) // generic error handler
-  .use(({
-    message
-  }, req, res, next) => {
-    res.status(500).json({
-      success: false,
-      error: message
+    let rewritePath = createRewriter((_options = options) === null || _options === void 0 ? void 0 : _options.rewrites, (pathname, rewrite) => {
+      try {
+        let filepath = decodeURIComponent(pathname.replace(mountPattern, ''));
+        if (!isPathInside(root, filepath)) ServerError.throw();
+        return rewrite(filepath);
+      } catch {
+        throw new ServerError(400);
+      }
     });
-  });
-} // 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);
-  });
-}
+    return _classPrivateMethodGet(this, _route, _route2).call(this, {
+      priority: 2,
+      methods: ['GET'],
+      match: pathname => mountPattern.test(pathname),
+      handle: async (req, res, next) => {
+        try {
+          var _options2;
+
+          let pathname = rewritePath(req.url.pathname);
+          let file = await getFile(root, pathname, (_options2 = options) === null || _options2 === void 0 ? void 0 : _options2.cleanUrls);
+          if (!(file !== null && file !== void 0 && file.stats.isFile())) return await next();
+          return res.file(file.path);
+        } catch (err) {
+          let statusPage = path.join(root, `${err.status}.html`);
+          if (!fs.existsSync(statusPage)) throw err;
+          return res.file(err.status, statusPage);
+        }
+      }
+    });
+  } // route and respond to requests; handling errors if necessary
+
+
+} // create a url rewriter from provided rewrite rules
+
+function _handleUpgrade2(req, sock, head) {
+  let up = _classPrivateFieldGet(this, _up).find(u => !u.match || u.match(req.url));
+
+  if (up) return up.handle(req, sock, head);
+  sock.write(`HTTP/1.1 400 ${http.STATUS_CODES[400]}\r\n` + 'Connection: close\r\n\r\n');
+  sock.destroy();
+}
+
+function _route2(route) {
+  let i = _classPrivateFieldGet(this, _routes).findIndex(r => r.priority >= route.priority);
+
+  _classPrivateFieldGet(this, _routes).splice(i, 0, route);
+
+  return this;
+}
+
+async function _handleRequest2(req, res) {
+  // support node < 15.7.0
+  res.req ?? (res.req = req);
+
+  try {
+    // invoke routes like middleware
+    await async function cont(routes, i = 0) {
+      let next = () => cont(routes, i + 1);
+
+      let {
+        methods,
+        match,
+        handle
+      } = routes[i];
+      let result = !methods || methods.includes(req.method);
+      result && (result = !match || match(req.url.pathname));
+      if (result) req.params = result.params;
+      return result ? handle(req, res, next) : next();
+    }(_classPrivateFieldGet(this, _routes));
+  } catch (error) {
+    var _req$headers$accept, _req$headers$content;
+
+    let {
+      status = 500,
+      message
+    } = error; // fallback error handling
+
+    if ((_req$headers$accept = req.headers.accept) !== null && _req$headers$accept !== void 0 && _req$headers$accept.includes('json') || (_req$headers$content = req.headers['content-type']) !== null && _req$headers$content !== void 0 && _req$headers$content.includes('json')) {
+      res.json(status, {
+        error: message
+      });
+    } else {
+      res.text(status, message);
+    }
+  }
+}
+
+function createRewriter(rewrites = [], cb) {
+  let normalize = p => path.posix.normalize(path.posix.join('/', p));
+
+  if (!Array.isArray(rewrites)) rewrites = Object.entries(rewrites);
+  let rewrite = [{
+    // resolve and normalize the path before rewriting
+    apply: p => path.posix.resolve(normalize(p))
+  }].concat(rewrites.map(([src, dest]) => {
+    // compile rewrite rules into functions
+    let match = pathToMatch(normalize(src));
+    let toPath = makeToPath(normalize(dest));
+    return {
+      match,
+      apply: r => toPath(r.params)
+    };
+  })).reduceRight((next, rule) => pathname => {
+    var _rule$match;
+
+    // compose all rewrites into a single function
+    let result = ((_rule$match = rule.match) === null || _rule$match === void 0 ? void 0 : _rule$match.call(rule, pathname)) ?? pathname;
+    if (result) pathname = rule.apply(result);
+    return next(pathname);
+  }, p => p); // allow additional pathname processing around the rewriter
+
+  return p => cb(p, rewrite);
+} // returns true if the pathname is inside the root pathname
+
+
+function isPathInside(root, pathname) {
+  let abs = path.resolve(path.join(root, pathname));
+  return !abs.lastIndexOf(root, 0) && (abs[root.length] === path.sep || !abs[root.length]);
+} // get the absolute path and stats of a possible file
+
+
+async function getFile(root, pathname, cleanUrls) {
+  for (let filename of [pathname].concat(cleanUrls ? path.join(pathname, 'index.html') : [], cleanUrls && pathname.length > 2 ? pathname.replace(/\/?$/, '.html') : [])) {
+    let filepath = path.resolve(path.join(root, filename));
+    let stats = await fs.promises.lstat(filepath).catch(() => {});
+    if (stats !== null && stats !== void 0 && stats.isFile()) return {
+      path: filepath,
+      stats
+    };
+  }
+} // returns the start and end of a byte range or undefined if unable to parse
+
+
+const RANGE_REGEXP = /^bytes=(\d*)?-(\d*)?(?:\b|$)/;
+
+function parseByteRange(range, size) {
+  let [, start, end = size] = (range === null || range === void 0 ? void 0 : range.match(RANGE_REGEXP)) ?? [0, 0, 0];
+  start = Math.max(parseInt(start, 10), 0);
+  end = Math.min(parseInt(end, 10), size - 1);
+  if (isNaN(start)) [start, end] = [size - end, size - 1];
+  if (start >= 0 && start < end) return {
+    start,
+    end
+  };
+} // include ServerError and createRewriter as static properties
+
+
+Server.Error = ServerError;
+Server.createRewriter = createRewriter;
+export default Server;

package/dist/session.js

@@ -0,0 +1,103 @@
+import EventEmitter from 'events';
+import logger from '@percy/logger';
+export class Session extends EventEmitter {
+  #callbacks = new Map();
+  log = logger('core:session');
+  children = new Map();
+
+  constructor(browser, {
+    params,
+    sessionId: parentId
+  }) {
+    var _this$parent;
+
+    super();
+    this.browser = browser;
+    this.sessionId = params.sessionId;
+    this.targetId = params.targetInfo.targetId;
+    this.type = params.targetInfo.type;
+    this.isDocument = this.type === 'page' || this.type === 'iframe';
+    this.parent = browser.sessions.get(parentId);
+    (_this$parent = this.parent) === null || _this$parent === void 0 ? void 0 : _this$parent.children.set(this.sessionId, this);
+    this.on('Inspector.targetCrashed', this._handleTargetCrashed);
+  }
+
+  async close() {
+    if (!this.browser) return;
+    await this.browser.send('Target.closeTarget', {
+      targetId: this.targetId
+    }).catch(this._handleClosedError);
+  }
+
+  async send(method, params) {
+    /* istanbul ignore next: race condition paranoia */
+    if (this.closedReason) {
+      throw new Error(`Protocol error (${method}): ${this.closedReason}`);
+    } // send a raw message to the browser so we can provide a sessionId
+
+
+    let id = await this.browser.send({
+      sessionId: this.sessionId,
+      method,
+      params
+    }); // will resolve or reject when a matching response is received
+
+    return new Promise((resolve, reject) => {
+      this.#callbacks.set(id, {
+        error: new Error(),
+        resolve,
+        reject,
+        method
+      });
+    });
+  }
+
+  _handleMessage(data) {
+    if (data.id && this.#callbacks.has(data.id)) {
+      // resolve or reject a pending promise created with #send()
+      let callback = this.#callbacks.get(data.id);
+      this.#callbacks.delete(data.id);
+      /* istanbul ignore next: races with browser._handleMessage() */
+
+      if (data.error) {
+        callback.reject(Object.assign(callback.error, {
+          message: `Protocol error (${callback.method}): ${data.error.message}` + ('data' in data.error ? `: ${data.error.data}` : '')
+        }));
+      } else {
+        callback.resolve(data.result);
+      }
+    } else {
+      // emit the message as an event
+      this.emit(data.method, data.params);
+    }
+  }
+
+  _handleClose() {
+    var _this$parent2;
+
+    this.closedReason || (this.closedReason = 'Session closed.'); // reject any pending callbacks
+
+    for (let callback of this.#callbacks.values()) {
+      callback.reject(Object.assign(callback.error, {
+        message: `Protocol error (${callback.method}): ${this.closedReason}`
+      }));
+    }
+
+    this.#callbacks.clear();
+    (_this$parent2 = this.parent) === null || _this$parent2 === void 0 ? void 0 : _this$parent2.children.delete(this.sessionId);
+    this.browser = null;
+  }
+
+  _handleTargetCrashed = () => {
+    this.closedReason = 'Session crashed!';
+    this.close();
+  };
+  /* istanbul ignore next: encountered during closing races */
+
+  _handleClosedError = error => {
+    if (!error.message.endsWith(this.closedReason)) {
+      this.log.debug(error, this.meta);
+    }
+  };
+}
+export default Session;