@percy/core 1.5.1 → 1.6.0

package/dist/api.js

@@ -8,7 +8,7 @@ export const PERCY_DOM = createRequire(import.meta.url).resolve('@percy/dom'); /
 
 export function createPercyServer(percy, port) {
   let pkg = getPackageJSON(import.meta.url);
-  return Server.createServer({
+  let server = Server.createServer({
     port
   }) // facilitate logger websocket connections
   .websocket('/(logger)?', ws => {
@@ -29,13 +29,31 @@ export function createPercyServer(percy, port) {
     }));
   }) // general middleware
   .route((req, res, next) => {
+    var _percy$testing, _percy$testing3, _percy$testing3$api, _percy$testing4, _percy$testing4$api;
+
     // treat all request bodies as json
     if (req.body) try {
       req.body = JSON.parse(req.body);
     } catch {} // add version header
 
-    res.setHeader('Access-Control-Expose-Headers', '*, X-Percy-Core-Version');
-    res.setHeader('X-Percy-Core-Version', pkg.version); // return json errors
+    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;
+
+      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
+
+
+    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'
+      });
+    } 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();
+    } // return json errors
+
 
     return next().catch(e => res.json(e.status ?? 500, {
       build: percy.build,
@@ -77,6 +95,42 @@ export function createPercyServer(percy, port) {
     return res.json(200, {
       success: true
     });
+  }); // add test endpoints only in testing mode
+
+  return !percy.testing ? server : server // manipulates testing mode configuration to trigger specific scenarios
+  .route('/test/api/:cmd', ({
+    body,
+    params: {
+      cmd
+    }
+  }, res) => {
+    body = Buffer.isBuffer(body) ? body.toString() : body;
+
+    if (cmd === 'reset') {
+      // the reset command will reset testing mode to its default options
+      percy.testing = {};
+    } 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') {
+      // the error or disconnect commands will cause specific endpoints to fail
+      percy.testing.api = { ...percy.testing.api,
+        [body]: cmd
+      };
+    } else {
+      // 404 for unknown commands
+      return res.send(404);
+    }
+
+    return res.json(200, {
+      testing: percy.testing
+    });
+  }) // 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
+  .route('get', '/test/snapshot', (req, res) => {
+    return res.send(200, 'text/html', '<p>Snapshot Me!</p>');
   });
 } // Create a static server instance with an automatic sitemap
 

package/dist/percy.js

@@ -31,6 +31,8 @@ export class Percy {
     skipUploads,
     // implies `skipUploads` and also skips asset discovery
     dryRun,
+    // implies `dryRun`, silent logs, and adds extra api endpoints
+    testing,
     // configuration filepath
     config,
     // provided to @percy/client
@@ -44,8 +46,10 @@ export class Percy {
     // options which will become accessible via the `.config` property
     ...options
   } = {}) {
+    if (testing) loglevel = 'silent';
     if (loglevel) this.loglevel(loglevel);
-    this.dryRun = !!dryRun;
+    this.testing = testing ? {} : null;
+    this.dryRun = !!testing || !!dryRun;
     this.skipUploads = this.dryRun || !!skipUploads;
     this.deferUploads = this.skipUploads || !!deferUploads;
     if (this.deferUploads) this.#uploads.stop();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -39,10 +39,10 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/client": "1.5.1",
-    "@percy/config": "1.5.1",
-    "@percy/dom": "1.5.1",
-    "@percy/logger": "1.5.1",
+    "@percy/client": "1.6.0",
+    "@percy/config": "1.6.0",
+    "@percy/dom": "1.6.0",
+    "@percy/logger": "1.6.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": "c67c0d482d3da18e529f7bc2e1c219c04e59bbea"
+  "gitHead": "dd03aec4a68a26425cda3afd10fa142011198b5f"
 }

package/test/helpers/request.js

@@ -7,7 +7,7 @@ export async function request(url, method = 'GET', handle) {
   try {
     return await request(url, options, cb);
   } catch (error) {
-    if (typeof handle !== 'boolean') throw error;
+    if (!error.response || typeof handle !== 'boolean') throw error;
     return handle ? [error.response.body, error.response] : error.response;
   }
 }