@percy/sdk-utils 1.10.2 → 1.10.4

package/README.md

@@ -43,8 +43,7 @@ percy.domScript === fs.readFile(require.resolve('@percy/dom'))
 Returns `true` or `false` if the Percy CLI API server is running. Calls the server's `/healthcheck`
 endpoint and populates information for the [`percy`](#percy) property. The result of this function
 is cached and subsequent calls will return the first cached result. If the healthcheck fails, will
-log a message unless the CLI loglevel is `quiet` or `silent`. Upon a successful health check, a
-remote logging connection is also established.
+log a message unless the CLI loglevel is `quiet` or `silent`.
 
 ``` js
 import { isPercyEnabled } from '@percy/sdk-utils'

package/dist/bundle.js

@@ -6,6 +6,53 @@
     process.env = process.env || {};
     process.env.__PERCY_BROWSERIFIED__ = true;
 
+    // Used when determining if a message should be logged
+    const LOG_LEVELS = {
+      debug: 0,
+      info: 1,
+      warn: 2,
+      error: 3
+    }; // Create a small logger util using the specified namespace
+
+    function logger(namespace) {
+      return Object.keys(LOG_LEVELS).reduce((ns, lvl) => Object.assign(ns, {
+        [lvl]: function () {
+          for (var _len = arguments.length, a = new Array(_len), _key = 0; _key < _len; _key++) {
+            a[_key] = arguments[_key];
+          }
+
+          return logger.log(namespace, lvl, ...a);
+        }
+      }), {});
+    }
+    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) {
       str || (str = '0.0.0');
@@ -65,145 +112,6 @@
 
     };
 
-    const LOG_LEVELS = {
-      debug: 0,
-      info: 1,
-      warn: 2,
-      error: 3
-    }; // Create a small logger util using the specified namespace
-
-    function logger(namespace) {
-      return Object.keys(LOG_LEVELS).reduce((ns, lvl) => Object.assign(ns, {
-        [lvl]: function () {
-          for (var _len = arguments.length, a = new Array(_len), _key = 0; _key < _len; _key++) {
-            a[_key] = arguments[_key];
-          }
-
-          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');
-      meta = {
-        remote: true,
-        ...meta
-      };
-
-      if (remote.socket) {
-        // prefer remote logging when available and serialize any errors
-        if (err) msg = {
-          name: msg.name,
-          message: msg.message,
-          stack: msg.stack
-        };
-        return remote.socket.send(JSON.stringify({
-          log: [ns, lvl, msg, meta]
-        }));
-      } else {
-        // keep log history of full message when not remote
-        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');
-        }
-      }
-    }; // Create a new WebSocket and resolve with it once connected
-
-
-    function createWebSocket(address) {
-      let timeout = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 1000;
-      return new Promise((resolve, reject) => {
-        let ws;
-
-        let done = e => {
-          var _ws, _ws$_socket;
-
-          (_ws = ws) === null || _ws === void 0 ? void 0 : (_ws$_socket = _ws._socket) === null || _ws$_socket === void 0 ? void 0 : _ws$_socket.unref();
-          clearTimeout(timeoutid);
-          /* istanbul ignore else: edge case */
-
-          if (ws) ws.onopen = ws.onerror = null;
-          if (!e.error && e.type !== 'error') return resolve(ws);else reject(e.error || 'Error: Socket connection failed');
-        };
-
-        let timeoutid = setTimeout(done, timeout, {
-          error: 'Error: Socket connection timed out'
-        });
-        Promise.resolve(process.env.__PERCY_BROWSERIFIED__
-        /* eslint-disable-next-line import/no-extraneous-dependencies */
-        ? {
-          default: window.WebSocket
-        } : ({})).then(_ref => {
-          let {
-            default: WS
-          } = _ref;
-          ws = new WS(address.replace(/^http/, 'ws'));
-          ws.onopen = ws.onerror = done;
-        }, reject);
-      });
-    } // Connect to a remote logger at the specified address within the timeout
-
-
-    const remote = logger.remote = async timeout => {
-      try {
-        var _remote$socket;
-
-        // already connected
-        if (((_remote$socket = remote.socket) === null || _remote$socket === void 0 ? void 0 : _remote$socket.readyState) === 1) return; // connect to namespaced logging address
-
-        let address = new URL('/logger', info.address).href; // create and cache a websocket connection
-
-        let ws = remote.socket = await createWebSocket(address, timeout);
-        await new Promise((resolve, reject) => {
-          // accept loglevel updates and resolve after first message
-          ws.onmessage = e => resolve(loglevel(JSON.parse(e.data).loglevel));
-
-          ws.onclose = () => {
-            // cleanup listeners and reject if not resolved
-            remote.socket = ws.onmessage = ws.onclose = null;
-            reject(new Error('Connection closed'));
-          };
-        }); // send any messages already logged in this environment
-
-        if (log.history) ws.send(JSON.stringify({
-          messages: log.history
-        }));
-      } catch (err) {
-        // there was an error connecting, will fallback to minimal logging
-        logger.log('utils', 'debug', 'Unable to connect to remote logger');
-        logger.log('utils', 'debug', err);
-      }
-    };
-
     async function request(path) {
       let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
       let response = await request.fetch(`${info.address}${path}`, options); // maybe parse response body as json
@@ -292,10 +200,6 @@
           log.info('Percy is not running, disabling snapshots');
           log.debug(error);
         }
-
-        if (info.enabled) {
-          await logger.remote();
-        }
       }
 
       return info.enabled;

package/dist/logger.js

@@ -5,15 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 exports.logger = logger;
-
-var _percyInfo = _interopRequireDefault(require("./percy-info.js"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
 // Used when determining if a message should be logged
 const LOG_LEVELS = {
   debug: 0,
@@ -26,126 +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');
-  meta = {
-    remote: true,
-    ...meta
-  };
-
-  if (remote.socket) {
-    // prefer remote logging when available and serialize any errors
-    if (err) msg = {
-      name: msg.name,
-      message: msg.message,
-      stack: msg.stack
-    };
-    return remote.socket.send(JSON.stringify({
-      log: [ns, lvl, msg, meta]
-    }));
-  } else {
-    // keep log history of full message when not remote
-    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');
+      }
     }
   }
-}; // Create a new WebSocket and resolve with it once connected
-
-
-function createWebSocket(address, timeout = 1000) {
-  return new Promise((resolve, reject) => {
-    let ws;
-
-    let done = e => {
-      var _ws, _ws$_socket;
-
-      (_ws = ws) === null || _ws === void 0 ? void 0 : (_ws$_socket = _ws._socket) === null || _ws$_socket === void 0 ? void 0 : _ws$_socket.unref();
-      clearTimeout(timeoutid);
-      /* istanbul ignore else: edge case */
-
-      if (ws) ws.onopen = ws.onerror = null;
-      if (!e.error && e.type !== 'error') return resolve(ws);else reject(e.error || 'Error: Socket connection failed');
-    };
-
-    let timeoutid = setTimeout(done, timeout, {
-      error: 'Error: Socket connection timed out'
-    });
-    Promise.resolve(process.env.__PERCY_BROWSERIFIED__
-    /* eslint-disable-next-line import/no-extraneous-dependencies */
-    ? {
-      default: window.WebSocket
-    } : Promise.resolve().then(() => _interopRequireWildcard(require('ws')))).then(({
-      default: WS
-    }) => {
-      ws = new WS(address.replace(/^http/, 'ws'));
-      ws.onopen = ws.onerror = done;
-    }, reject);
-  });
-} // Connect to a remote logger at the specified address within the timeout
-
-
-const remote = logger.remote = async timeout => {
-  try {
-    var _remote$socket;
-
-    // already connected
-    if (((_remote$socket = remote.socket) === null || _remote$socket === void 0 ? void 0 : _remote$socket.readyState) === 1) return; // connect to namespaced logging address
-
-    let address = new URL('/logger', _percyInfo.default.address).href; // create and cache a websocket connection
-
-    let ws = remote.socket = await createWebSocket(address, timeout);
-    await new Promise((resolve, reject) => {
-      // accept loglevel updates and resolve after first message
-      ws.onmessage = e => resolve(loglevel(JSON.parse(e.data).loglevel));
-
-      ws.onclose = () => {
-        // cleanup listeners and reject if not resolved
-        remote.socket = ws.onmessage = ws.onclose = null;
-        reject(new Error('Connection closed'));
-      };
-    }); // send any messages already logged in this environment
-
-    if (log.history) ws.send(JSON.stringify({
-      messages: log.history
-    }));
-  } catch (err) {
-    // there was an error connecting, will fallback to minimal logging
-    logger.log('utils', 'debug', 'Unable to connect to remote logger');
-    logger.log('utils', 'debug', err);
-  }
-};
-
+});
 var _default = logger;
 exports.default = _default;

package/dist/percy-enabled.js

@@ -38,10 +38,6 @@ async function isPercyEnabled() {
       log.info('Percy is not running, disabling snapshots');
       log.debug(error);
     }
-
-    if (_percyInfo.default.enabled) {
-      await _logger.default.remote();
-    }
   }
 
   return _percyInfo.default.enabled;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/sdk-utils",
-  "version": "1.10.2",
+  "version": "1.10.4",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -50,5 +50,5 @@
       ]
     }
   },
-  "gitHead": "66527175cdac3848157be7dd8368f5845d98e77e"
+  "gitHead": "16a9a410bfcb8eab51b86a08cff12d8d35e4747e"
 }

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,8 +27,9 @@
         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');
-        await utils.logger.remote();
       },
 
       async test(cmd, arg) {
@@ -41,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,8 +10,9 @@ 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');
-    await utils.logger.remote();
   },
 
   async test(cmd, arg) {
@@ -27,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');
+    }
   }
 };