@percy/core 1.8.1 → 1.10.0

package/dist/api.js

@@ -12,6 +12,18 @@ export function createPercyServer(percy, port) {
     port
   }) // facilitate logger websocket connections
   .websocket('/(logger)?', ws => {
+    var _percy$testing, _percy$testing2;
+
+    // support sabotaging remote logging connections in testing mode
+    if (((_percy$testing = percy.testing) === null || _percy$testing === void 0 ? void 0 : _percy$testing.remoteLogging) === false) return ws.terminate(); // track all remote logging connections in testing mode
+
+    if (percy.testing) ((_percy$testing2 = percy.testing).remoteLoggers || (_percy$testing2.remoteLoggers = new Set())).add(ws);
+    ws.addEventListener('close', () => {
+      var _percy$testing3, _percy$testing3$remot;
+
+      return (_percy$testing3 = percy.testing) === null || _percy$testing3 === void 0 ? void 0 : (_percy$testing3$remot = _percy$testing3.remoteLoggers) === null || _percy$testing3$remot === void 0 ? void 0 : _percy$testing3$remot.delete(ws);
+    }); // listen for messages with specific logging payloads
+
     ws.addEventListener('message', ({
       data
     }) => {
@@ -23,13 +35,14 @@ export function createPercyServer(percy, port) {
       for (let m of messages) logger.instance.messages.add(m);
 
       if (log) logger.instance.log(...log);
-    });
+    }); // respond with the current loglevel
+
     ws.send(JSON.stringify({
       loglevel: logger.loglevel()
     }));
   }) // general middleware
   .route((req, res, next) => {
-    var _percy$testing, _percy$testing3, _percy$testing3$api, _percy$testing4, _percy$testing4$api;
+    var _percy$testing4, _percy$testing7, _percy$testing7$api, _percy$testing8, _percy$testing8$api;
 
     // treat all request bodies as json
     if (req.body) try {
@@ -38,35 +51,55 @@ export function createPercyServer(percy, port) {
 
     res.setHeader('Access-Control-Expose-Headers', '*, X-Percy-Core-Version'); // skip or change api version header in testing mode
 
-    if (((_percy$testing = percy.testing) === null || _percy$testing === void 0 ? void 0 : _percy$testing.version) !== false) {
-      var _percy$testing2;
+    if (((_percy$testing4 = percy.testing) === null || _percy$testing4 === void 0 ? void 0 : _percy$testing4.version) !== false) {
+      var _percy$testing5;
 
-      res.setHeader('X-Percy-Core-Version', ((_percy$testing2 = percy.testing) === null || _percy$testing2 === void 0 ? void 0 : _percy$testing2.version) ?? pkg.version);
-    } // support sabotaging requests in testing mode
+      res.setHeader('X-Percy-Core-Version', ((_percy$testing5 = percy.testing) === null || _percy$testing5 === void 0 ? void 0 : _percy$testing5.version) ?? pkg.version);
+    } // track all api reqeusts in testing mode
 
 
-    if (((_percy$testing3 = percy.testing) === null || _percy$testing3 === void 0 ? void 0 : (_percy$testing3$api = _percy$testing3.api) === null || _percy$testing3$api === void 0 ? void 0 : _percy$testing3$api[req.url.pathname]) === 'error') {
-      return res.json(500, {
-        success: false,
-        error: 'Error: testing'
+    if (percy.testing && !req.url.pathname.startsWith('/test/')) {
+      var _percy$testing6;
+
+      ((_percy$testing6 = percy.testing).requests || (_percy$testing6.requests = [])).push({
+        url: `${req.url.pathname}${req.url.search}`,
+        method: req.method,
+        body: req.body
       });
-    } else if (((_percy$testing4 = percy.testing) === null || _percy$testing4 === void 0 ? void 0 : (_percy$testing4$api = _percy$testing4.api) === null || _percy$testing4$api === void 0 ? void 0 : _percy$testing4$api[req.url.pathname]) === 'disconnect') {
-      return req.connection.destroy();
+    } // support sabotaging requests in testing mode
+
+
+    if (((_percy$testing7 = percy.testing) === null || _percy$testing7 === void 0 ? void 0 : (_percy$testing7$api = _percy$testing7.api) === null || _percy$testing7$api === void 0 ? void 0 : _percy$testing7$api[req.url.pathname]) === 'error') {
+      next = () => {
+        var _percy$testing$build;
+
+        return Promise.reject(new Error(((_percy$testing$build = percy.testing.build) === null || _percy$testing$build === void 0 ? void 0 : _percy$testing$build.error) || 'testing'));
+      };
+    } else if (((_percy$testing8 = percy.testing) === null || _percy$testing8 === void 0 ? void 0 : (_percy$testing8$api = _percy$testing8.api) === null || _percy$testing8$api === void 0 ? void 0 : _percy$testing8$api[req.url.pathname]) === 'disconnect') {
+      next = () => req.connection.destroy();
     } // return json errors
 
 
-    return next().catch(e => res.json(e.status ?? 500, {
-      build: percy.build,
-      error: e.message,
-      success: false
-    }));
+    return next().catch(e => {
+      var _percy$testing9;
+
+      return res.json(e.status ?? 500, {
+        build: ((_percy$testing9 = percy.testing) === null || _percy$testing9 === void 0 ? void 0 : _percy$testing9.build) || percy.build,
+        error: e.message,
+        success: false
+      });
+    });
   }) // healthcheck returns basic information
-  .route('get', '/percy/healthcheck', (req, res) => res.json(200, {
-    loglevel: percy.loglevel(),
-    config: percy.config,
-    build: percy.build,
-    success: true
-  })) // get or set config options
+  .route('get', '/percy/healthcheck', (req, res) => {
+    var _percy$testing10;
+
+    return res.json(200, {
+      build: ((_percy$testing10 = percy.testing) === null || _percy$testing10 === void 0 ? void 0 : _percy$testing10.build) ?? percy.build,
+      loglevel: percy.loglevel(),
+      config: percy.config,
+      success: true
+    });
+  }) // get or set config options
   .route(['get', 'post'], '/percy/config', async (req, res) => res.json(200, {
     config: req.body ? await percy.setConfig(req.body) : percy.config,
     success: true
@@ -105,28 +138,46 @@ export function createPercyServer(percy, port) {
     }
   }, res) => {
     body = Buffer.isBuffer(body) ? body.toString() : body;
+    let {
+      remoteLoggers
+    } = percy.testing;
 
     if (cmd === 'reset') {
       // the reset command will reset testing mode and clear any logs
-      percy.testing = {};
+      percy.testing = remoteLoggers ? {
+        remoteLoggers
+      } : {};
       logger.instance.messages.clear();
     } else if (cmd === 'version') {
       // the version command will update the api version header for testing
       percy.testing.version = body;
     } else if (cmd === 'error' || cmd === 'disconnect') {
+      var _percy$testing11;
+
       // the error or disconnect commands will cause specific endpoints to fail
-      percy.testing.api = { ...percy.testing.api,
-        [body]: cmd
+      ((_percy$testing11 = percy.testing).api || (_percy$testing11.api = {}))[body] = cmd;
+    } else if (cmd === 'build-failure') {
+      // the build-failure command will cause api errors to include a failed build
+      percy.testing.build = {
+        failed: true,
+        error: 'Build failed'
       };
+    } else if (cmd === 'remote-logging') {
+      // the remote-logging command will toggle remote logging support
+      if (body === false) remoteLoggers === null || remoteLoggers === void 0 ? void 0 : remoteLoggers.forEach(ws => ws.terminate());
+      percy.testing.remoteLogging = body;
     } else {
       // 404 for unknown commands
       return res.send(404);
     }
 
     return res.json(200, {
-      testing: percy.testing
+      success: true
     });
-  }) // returns an array of raw logs from the logger
+  }) // returns an array of raw requests made to the api
+  .route('get', '/test/requests', (req, res) => res.json(200, {
+    requests: percy.testing.requests
+  })) // returns an array of raw logs from the logger
   .route('get', '/test/logs', (req, res) => res.json(200, {
     logs: Array.from(logger.instance.messages)
   })) // serves a very basic html page for testing snapshots
@@ -138,15 +189,17 @@ export function createPercyServer(percy, port) {
 export function createStaticServer(options) {
   let {
     serve: dir,
-    baseUrl = '/'
+    baseUrl = ''
   } = options;
-  let server = Server.createServer(options); // used when generating an automatic sitemap
+  let server = Server.createServer(options); // remove trailing slashes so the base snapshot name matches other snapshots
+
+  baseUrl = baseUrl.replace(/\/$/, ''); // used when generating an automatic sitemap
 
   let toURL = Server.createRewriter( // reverse rewrites' src, dest, & order
-  Object.entries((options === null || options === void 0 ? void 0 : options.rewrites) ?? {}).reduce((acc, rw) => [rw.reverse(), ...acc], []), (filename, rewrite) => new URL(path.posix.join(baseUrl, // cleanUrls will trim trailing .html/index.html from paths
+  Object.entries((options === null || options === void 0 ? void 0 : options.rewrites) ?? {}).reduce((acc, rw) => [rw.reverse(), ...acc], []), (filename, rewrite) => new URL(path.posix.join('/', baseUrl, // cleanUrls will trim trailing .html/index.html from paths
   !options.cleanUrls ? rewrite(filename) : rewrite(filename).replace(/(\/index)?\.html$/, '')), server.address())); // include automatic sitemap route
 
-  server.route('get', '/sitemap.xml', async (req, res) => {
+  server.route('get', `${baseUrl}/sitemap.xml`, async (req, res) => {
     let {
       default: glob
     } = await import('fast-glob');

package/dist/percy.js

@@ -31,7 +31,9 @@ export class Percy {
     deferUploads,
     // run without uploading anything
     skipUploads,
-    // implies `skipUploads` and also skips asset discovery
+    // run without asset discovery
+    skipDiscovery,
+    // implies `skipUploads` and `skipDiscovery`
     dryRun,
     // implies `dryRun`, silent logs, and adds extra api endpoints
     testing,
@@ -53,6 +55,7 @@ export class Percy {
     this.testing = testing ? {} : null;
     this.dryRun = !!testing || !!dryRun;
     this.skipUploads = this.dryRun || !!skipUploads;
+    this.skipDiscovery = this.dryRun || !!skipDiscovery;
     this.delayUploads = this.skipUploads || !!delayUploads;
     this.deferUploads = this.delayUploads || !!deferUploads;
     if (this.deferUploads) this.#uploads.stop();
@@ -150,7 +153,7 @@ export class Percy {
   // at a later time when uploads are deferred, or run immediately when not deferred.
 
 
-  async *start(options) {
+  async *start() {
     // already starting or started
     if (this.readyState != null) return;
     this.readyState = 0; // create a percy build as the first immediately queued task
@@ -193,10 +196,7 @@ export class Percy {
       // when not deferred, wait until the build is created first
       if (!this.deferUploads) await buildTask; // maybe launch the discovery browser
 
-      if (!this.dryRun && (options === null || options === void 0 ? void 0 : options.browser) !== false) {
-        yield this.browser.launch();
-      } // start the server after everything else is ready
-
+      if (!this.skipDiscovery) yield this.browser.launch(); // start the server after everything else is ready
 
       yield (_this$server2 = this.server) === null || _this$server2 === void 0 ? void 0 : _this$server2.listen(); // mark instance as started
 
@@ -234,8 +234,8 @@ export class Percy {
       if (this.#snapshots.size) {
         if (close) this.#snapshots.close();
         yield* this.#snapshots.flush(s => {
-          // do not log a count when not closing or while dry-running
-          if (!close || this.dryRun) return;
+          // do not log a count when not closing or if asset discovery is disabled
+          if (!close || this.skipDiscovery) return;
           this.log.progress(`Processing ${s} snapshot${s !== 1 ? 's' : ''}...`, !!s);
         });
       } // run, close, and wait for the upload queue to empty

package/dist/snapshot.js

@@ -117,6 +117,8 @@ export async function* gatherSnapshots(percy, options) {
 // other invalid options which are also scrubbed from the returned migrated options.
 
 export function validateSnapshotOptions(options) {
+  var _migrated$baseUrl;
+
   // decide which schema to validate against
   let schema = ['domSnapshot', 'dom-snapshot', 'dom_snapshot'].some(k => k in options) && '/snapshot/dom' || 'url' in options && '/snapshot' || 'sitemap' in options && '/snapshot/sitemap' || 'serve' in options && '/snapshot/server' || 'snapshots' in options && '/snapshot/list' || '/snapshot';
   let {
@@ -125,10 +127,12 @@ export function validateSnapshotOptions(options) {
     environmentInfo,
     snapshots,
     ...migrated
-  } = PercyConfig.migrate(options, schema); // gather info for validating individual snapshot URLs
+  } = PercyConfig.migrate(options, schema); // maintain a trailing slash for base URLs to normalize them
+
+  if (((_migrated$baseUrl = migrated.baseUrl) === null || _migrated$baseUrl === void 0 ? void 0 : _migrated$baseUrl.endsWith('/')) === false) migrated.baseUrl += '/';
+  let baseUrl = schema === '/snapshot/server' ? 'http://localhost/' : migrated.baseUrl; // gather info for validating individual snapshot URLs
 
   let isSnapshot = schema === '/snapshot/dom' || schema === '/snapshot';
-  let baseUrl = schema === '/snapshot/server' ? 'http://localhost' : options.baseUrl;
   let snaps = isSnapshot ? [migrated] : Array.isArray(snapshots) ? snapshots : [];
 
   for (let snap of snaps) validURL(typeof snap === 'string' ? snap : snap.url, baseUrl); // add back snapshots before validating and scrubbing; function snapshots are validated later
@@ -370,7 +374,14 @@ export async function* discoverSnapshotResources(percy, snapshot, callback) {
 
   let cache = percy[RESOURCE_CACHE_KEY] || (percy[RESOURCE_CACHE_KEY] = new Map()); // preload the root resource for existing dom snapshots
 
-  let resources = new Map(snapshot.domSnapshot && [createRootResource(snapshot.url, snapshot.domSnapshot)].map(resource => [resource.url, resource])); // open a new browser page
+  let resources = new Map(snapshot.domSnapshot && [createRootResource(snapshot.url, snapshot.domSnapshot)].map(resource => [resource.url, resource])); // when no discovery browser is available, do not attempt to discover other resources
+
+  if (percy.skipDiscovery && !snapshot.domSnapshot) {
+    throw new Error('Cannot capture DOM snapshot when asset discovery is disabled');
+  } else if (percy.skipDiscovery) {
+    return handleSnapshotResources(snapshot, resources, callback);
+  } // open a new browser page
+
 
   let page = yield percy.browser.page({
     enableJavaScript: snapshot.enableJavaScript ?? !snapshot.domSnapshot,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.8.1",
+  "version": "1.10.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -39,10 +39,10 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/client": "1.8.1",
-    "@percy/config": "1.8.1",
-    "@percy/dom": "1.8.1",
-    "@percy/logger": "1.8.1",
+    "@percy/client": "1.10.0",
+    "@percy/config": "1.10.0",
+    "@percy/dom": "1.10.0",
+    "@percy/logger": "1.10.0",
     "content-disposition": "^0.5.4",
     "cross-spawn": "^7.0.3",
     "extract-zip": "^2.0.1",
@@ -53,5 +53,5 @@
     "rimraf": "^3.0.2",
     "ws": "^8.0.0"
   },
-  "gitHead": "497772c62e2fa2d763b350c40a0cfec918f7125f"
+  "gitHead": "a6934eda4fc3b84845ae606d7f5a901f25e0a56f"
 }