@percy/sdk-utils 1.10.3 → 1.11.0

package/dist/bundle.js

@@ -24,43 +24,34 @@
           return logger.log(namespace, lvl, ...a);
         }
       }), {});
-    } // Set and/or return the local loglevel
-
-    const loglevel = logger.loglevel = lvl => {
-      return loglevel.lvl = lvl || loglevel.lvl || process.env.PERCY_LOGLEVEL || 'info';
-    }; // Track and send/write logs for the specified namespace and log level
-
-
-    const log = logger.log = (ns, lvl, msg, meta) => {
-      let err = typeof msg !== 'string' && (lvl === 'error' || lvl === 'debug'); // keep log history of full message
-
-      let message = err ? msg.stack : msg.toString();
-      let [debug, level, timestamp, error] = [ns, lvl, Date.now(), !!err];
-      (log.history || (log.history = [])).push({
-        debug,
-        level,
-        message,
-        meta,
-        timestamp,
-        error
-      }); // check if the specific level is within the local loglevel range
-
-      if (LOG_LEVELS[lvl] != null && LOG_LEVELS[lvl] >= LOG_LEVELS[loglevel()]) {
-        let debug = loglevel() === 'debug';
-        let label = debug ? `percy:${ns}` : 'percy'; // colorize the label when possible for consistency with the CLI logger
-
-        if (!process.env.__PERCY_BROWSERIFIED__) label = `\u001b[95m${label}\u001b[39m`;
-        msg = `[${label}] ${err && debug && msg.stack || msg}`;
-
-        if (process.env.__PERCY_BROWSERIFIED__) {
-          // use console[warn|error|log] in browsers
-          console[['warn', 'error'].includes(lvl) ? lvl : 'log'](msg);
-        } else {
-          // use process[stdout|stderr].write in node
-          process[lvl === 'info' ? 'stdout' : 'stderr'].write(msg + '\n');
+    }
+    Object.assign(logger, {
+      // Set and/or return the local loglevel
+      loglevel: function () {
+        let lvl = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : logger.loglevel.lvl;
+        return logger.loglevel.lvl = lvl || process.env.PERCY_LOGLEVEL || 'info';
+      },
+      // Track and send/write logs for the specified namespace and log level
+      log: (ns, lvl, msg, meta) => {
+        let err = typeof msg !== 'string' && (lvl === 'error' || lvl === 'debug'); // check if the specific level is within the local loglevel range
+
+        if (LOG_LEVELS[lvl] != null && LOG_LEVELS[lvl] >= LOG_LEVELS[logger.loglevel()]) {
+          let debug = logger.loglevel() === 'debug';
+          let label = debug ? `percy:${ns}` : 'percy'; // colorize the label when possible for consistency with the CLI logger
+
+          if (!process.env.__PERCY_BROWSERIFIED__) label = `\u001b[95m${label}\u001b[39m`;
+          msg = `[${label}] ${err && debug && msg.stack || msg}`;
+
+          if (process.env.__PERCY_BROWSERIFIED__) {
+            // use console[warn|error|log] in browsers
+            console[['warn', 'error'].includes(lvl) ? lvl : 'log'](msg);
+          } else {
+            // use process[stdout|stderr].write in node
+            process[lvl === 'info' ? 'stdout' : 'stderr'].write(msg + '\n');
+          }
         }
       }
-    };
+    });
 
     // helper to create a version object from a string
     function toVersion(str) {
@@ -232,7 +223,7 @@
       return info.domScript;
     }
 
-    // error message, signal that Percy has been disabled.
+    // indicate that Percy has been disabled.
 
     async function postSnapshot(options, params) {
       let query = params ? `?${new URLSearchParams(params)}` : '';
@@ -247,6 +238,33 @@
       });
     }
 
+    // indicate that Percy has been disabled.
+
+    async function postComparison(options, params) {
+      let query = params ? `?${new URLSearchParams(params)}` : '';
+      await request.post(`/percy/comparison${query}`, options).catch(err => {
+        var _err$response, _err$response$body, _err$response$body$bu;
+
+        if ((_err$response = err.response) !== null && _err$response !== void 0 && (_err$response$body = _err$response.body) !== null && _err$response$body !== void 0 && (_err$response$body$bu = _err$response$body.build) !== null && _err$response$body$bu !== void 0 && _err$response$body$bu.error) {
+          info.enabled = false;
+        } else {
+          throw err;
+        }
+      });
+    }
+
+    // will be flushed. Does nothing when Percy is not enabled.
+
+    async function flushSnapshots(options) {
+      if (info.enabled) {
+        // accept one or more snapshot names
+        options && (options = [].concat(options).map(o => typeof o === 'string' ? {
+          name: o
+        } : o));
+        await request.post('/percy/flush', options);
+      }
+    }
+
     var index = /*#__PURE__*/Object.freeze({
       __proto__: null,
       logger: logger,
@@ -256,14 +274,18 @@
       waitForPercyIdle: waitForPercyIdle,
       fetchPercyDOM: fetchPercyDOM,
       postSnapshot: postSnapshot,
+      postComparison: postComparison,
+      flushSnapshots: flushSnapshots,
       'default': index
     });
 
     exports["default"] = index;
     exports.fetchPercyDOM = fetchPercyDOM;
+    exports.flushSnapshots = flushSnapshots;
     exports.isPercyEnabled = isPercyEnabled;
     exports.logger = logger;
     exports.percy = info;
+    exports.postComparison = postComparison;
     exports.postSnapshot = postSnapshot;
     exports.request = request;
     exports.waitForPercyIdle = waitForPercyIdle;

package/dist/flush-snapshots.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.flushSnapshots = flushSnapshots;
+
+var _percyInfo = _interopRequireDefault(require("./percy-info.js"));
+
+var _request = _interopRequireDefault(require("./request.js"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Posts to the local Percy server one or more snapshots to flush. Given no arguments, all snapshots
+// will be flushed. Does nothing when Percy is not enabled.
+async function flushSnapshots(options) {
+  if (_percyInfo.default.enabled) {
+    // accept one or more snapshot names
+    options && (options = [].concat(options).map(o => typeof o === 'string' ? {
+      name: o
+    } : o));
+    await _request.default.post('/percy/flush', options);
+  }
+}
+
+var _default = flushSnapshots;
+exports.default = _default;

package/dist/index.js

@@ -10,6 +10,12 @@ Object.defineProperty(exports, "fetchPercyDOM", {
     return _percyDom.default;
   }
 });
+Object.defineProperty(exports, "flushSnapshots", {
+  enumerable: true,
+  get: function () {
+    return _flushSnapshots.default;
+  }
+});
 Object.defineProperty(exports, "isPercyEnabled", {
   enumerable: true,
   get: function () {
@@ -28,6 +34,12 @@ Object.defineProperty(exports, "percy", {
     return _percyInfo.default;
   }
 });
+Object.defineProperty(exports, "postComparison", {
+  enumerable: true,
+  get: function () {
+    return _postComparison.default;
+  }
+});
 Object.defineProperty(exports, "postSnapshot", {
   enumerable: true,
   get: function () {
@@ -61,6 +73,10 @@ var _percyDom = _interopRequireDefault(require("./percy-dom.js"));
 
 var _postSnapshot = _interopRequireDefault(require("./post-snapshot.js"));
 
+var _postComparison = _interopRequireDefault(require("./post-comparison.js"));
+
+var _flushSnapshots = _interopRequireDefault(require("./flush-snapshots.js"));
+
 var _default = _interopRequireWildcard(require("./index.js"));
 
 exports.default = _default;

package/dist/logger.js

@@ -17,44 +17,33 @@ function logger(namespace) {
   return Object.keys(LOG_LEVELS).reduce((ns, lvl) => Object.assign(ns, {
     [lvl]: (...a) => logger.log(namespace, lvl, ...a)
   }), {});
-} // Set and/or return the local loglevel
-
-
-const loglevel = logger.loglevel = lvl => {
-  return loglevel.lvl = lvl || loglevel.lvl || process.env.PERCY_LOGLEVEL || 'info';
-}; // Track and send/write logs for the specified namespace and log level
-
-
-const log = logger.log = (ns, lvl, msg, meta) => {
-  let err = typeof msg !== 'string' && (lvl === 'error' || lvl === 'debug'); // keep log history of full message
-
-  let message = err ? msg.stack : msg.toString();
-  let [debug, level, timestamp, error] = [ns, lvl, Date.now(), !!err];
-  (log.history || (log.history = [])).push({
-    debug,
-    level,
-    message,
-    meta,
-    timestamp,
-    error
-  }); // check if the specific level is within the local loglevel range
-
-  if (LOG_LEVELS[lvl] != null && LOG_LEVELS[lvl] >= LOG_LEVELS[loglevel()]) {
-    let debug = loglevel() === 'debug';
-    let label = debug ? `percy:${ns}` : 'percy'; // colorize the label when possible for consistency with the CLI logger
-
-    if (!process.env.__PERCY_BROWSERIFIED__) label = `\u001b[95m${label}\u001b[39m`;
-    msg = `[${label}] ${err && debug && msg.stack || msg}`;
-
-    if (process.env.__PERCY_BROWSERIFIED__) {
-      // use console[warn|error|log] in browsers
-      console[['warn', 'error'].includes(lvl) ? lvl : 'log'](msg);
-    } else {
-      // use process[stdout|stderr].write in node
-      process[lvl === 'info' ? 'stdout' : 'stderr'].write(msg + '\n');
+}
+
+Object.assign(logger, {
+  // Set and/or return the local loglevel
+  loglevel: (lvl = logger.loglevel.lvl) => {
+    return logger.loglevel.lvl = lvl || process.env.PERCY_LOGLEVEL || 'info';
+  },
+  // Track and send/write logs for the specified namespace and log level
+  log: (ns, lvl, msg, meta) => {
+    let err = typeof msg !== 'string' && (lvl === 'error' || lvl === 'debug'); // check if the specific level is within the local loglevel range
+
+    if (LOG_LEVELS[lvl] != null && LOG_LEVELS[lvl] >= LOG_LEVELS[logger.loglevel()]) {
+      let debug = logger.loglevel() === 'debug';
+      let label = debug ? `percy:${ns}` : 'percy'; // colorize the label when possible for consistency with the CLI logger
+
+      if (!process.env.__PERCY_BROWSERIFIED__) label = `\u001b[95m${label}\u001b[39m`;
+      msg = `[${label}] ${err && debug && msg.stack || msg}`;
+
+      if (process.env.__PERCY_BROWSERIFIED__) {
+        // use console[warn|error|log] in browsers
+        console[['warn', 'error'].includes(lvl) ? lvl : 'log'](msg);
+      } else {
+        // use process[stdout|stderr].write in node
+        process[lvl === 'info' ? 'stdout' : 'stderr'].write(msg + '\n');
+      }
     }
   }
-};
-
+});
 var _default = logger;
 exports.default = _default;

package/dist/post-comparison.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.postComparison = postComparison;
+
+var _percyInfo = _interopRequireDefault(require("./percy-info.js"));
+
+var _request = _interopRequireDefault(require("./request.js"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Post snapshot data to the CLI snapshot endpoint. If the endpoint responds with a build error,
+// indicate that Percy has been disabled.
+async function postComparison(options, params) {
+  let query = params ? `?${new URLSearchParams(params)}` : '';
+  await _request.default.post(`/percy/comparison${query}`, options).catch(err => {
+    var _err$response, _err$response$body, _err$response$body$bu;
+
+    if ((_err$response = err.response) !== null && _err$response !== void 0 && (_err$response$body = _err$response.body) !== null && _err$response$body !== void 0 && (_err$response$body$bu = _err$response$body.build) !== null && _err$response$body$bu !== void 0 && _err$response$body$bu.error) {
+      _percyInfo.default.enabled = false;
+    } else {
+      throw err;
+    }
+  });
+}
+
+var _default = postComparison;
+exports.default = _default;

package/dist/post-snapshot.js

@@ -12,8 +12,8 @@ var _request = _interopRequireDefault(require("./request.js"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-// Post snapshot data to the snapshot endpoint. If the snapshot endpoint responds with a closed
-// error message, signal that Percy has been disabled.
+// Post snapshot data to the CLI snapshot endpoint. If the endpoint responds with a build error,
+// indicate that Percy has been disabled.
 async function postSnapshot(options, params) {
   let query = params ? `?${new URLSearchParams(params)}` : '';
   await _request.default.post(`/percy/snapshot${query}`, options).catch(err => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/sdk-utils",
-  "version": "1.10.3",
+  "version": "1.11.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -50,5 +50,5 @@
       ]
     }
   },
-  "gitHead": "a9858d20a9b9708da0464c0617b32b2ee1c97433"
+  "gitHead": "0a5043cd677266390889063924f342af9b347055"
 }

package/test/client.js

@@ -16,6 +16,9 @@
     const utils = require$$0__default["default"];
     const helpers = {
       async setupTest() {
+        let {
+          logger = true
+        } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
         utils.percy.version = '';
         delete utils.percy.config;
         delete utils.percy.enabled;
@@ -24,6 +27,8 @@
         delete utils.logger.loglevel.lvl;
         delete process.env.PERCY_LOGLEVEL;
         delete process.env.PERCY_SERVER_ADDRESS;
+        utils.logger.log = helpers.logger.__log__;
+        if (logger) helpers.logger.mock();
         await helpers.test('reset');
       },
 
@@ -40,8 +45,32 @@
 
       get testSnapshotURL() {
         return `${utils.percy.address}/test/snapshot`;
-      }
+      },
+
+      logger: {
+        __log__: utils.logger.log,
+        loglevel: utils.logger.loglevel,
+        stdout: [],
+        stderr: [],
+
+        mock() {
+          helpers.logger.reset();
 
+          utils.logger.log = (ns, lvl, msg) => {
+            if (lvl === 'debug' && helpers.logger.loglevel.lvl !== 'debug') return;
+            msg = `[percy${lvl === 'debug' ? `:${ns}` : ''}] ${msg}`;
+            let io = lvl === 'info' ? 'stdout' : 'stderr';
+            helpers.logger[io].push(msg);
+          };
+        },
+
+        reset() {
+          helpers.logger.stdout = [];
+          helpers.logger.stderr = [];
+          helpers.logger.loglevel('info');
+        }
+
+      }
     };
     var helpers_1 = helpers;
 

package/test/helpers.js

@@ -1,7 +1,7 @@
 const utils = require('@percy/sdk-utils');
 
 const helpers = {
-  async setupTest() {
+  async setupTest({ logger = true } = {}) {
     utils.percy.version = '';
     delete utils.percy.config;
     delete utils.percy.enabled;
@@ -10,6 +10,8 @@ const helpers = {
     delete utils.logger.loglevel.lvl;
     delete process.env.PERCY_LOGLEVEL;
     delete process.env.PERCY_SERVER_ADDRESS;
+    utils.logger.log = helpers.logger.__log__;
+    if (logger) helpers.logger.mock();
     await helpers.test('reset');
   },
 
@@ -26,6 +28,30 @@ const helpers = {
 
   get testSnapshotURL() {
     return `${utils.percy.address}/test/snapshot`;
+  },
+
+  logger: {
+    __log__: utils.logger.log,
+    loglevel: utils.logger.loglevel,
+    stdout: [],
+    stderr: [],
+
+    mock() {
+      helpers.logger.reset();
+
+      utils.logger.log = (ns, lvl, msg) => {
+        if (lvl === 'debug' && helpers.logger.loglevel.lvl !== 'debug') return;
+        msg = `[percy${lvl === 'debug' ? `:${ns}` : ''}] ${msg}`;
+        let io = (lvl === 'info') ? 'stdout' : 'stderr';
+        helpers.logger[io].push(msg);
+      };
+    },
+
+    reset() {
+      helpers.logger.stdout = [];
+      helpers.logger.stderr = [];
+      helpers.logger.loglevel('info');
+    }
   }
 };