@percy/sdk-utils 1.1.0 → 1.1.3

package/dist/logger.js

@@ -0,0 +1,140 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+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,
+  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]: (...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 when not remote
+    let [debug, level, message, timestamp] = [ns, lvl, msg, Date.now()];
+    (log.history || (log.history = [])).push({
+      debug,
+      level,
+      message,
+      meta,
+      timestamp
+    });
+  } // check if the specific level is within the local loglevel range
+
+
+  if (LOG_LEVELS[lvl] != null && LOG_LEVELS[lvl] >= LOG_LEVELS[loglevel()]) {
+    var _msg;
+
+    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 = msg) === null || _msg === void 0 ? void 0 : _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
+
+
+async function createWebSocket(address, timeout = 1000) {
+  // attempt to import `ws` in node environments
+  let WebSocket = process.env.__PERCY_BROWSERIFIED__
+  /* eslint-disable-next-line import/no-extraneous-dependencies */
+  ? window.WebSocket : (await Promise.resolve().then(() => _interopRequireWildcard(require('ws')))).default;
+  let ws = new WebSocket(address.replace(/^http/, 'ws'));
+  return new Promise((resolve, reject) => {
+    let done = ws.onopen = ws.onerror = e => {
+      var _ws$_socket;
+
+      (_ws$_socket = ws._socket) === null || _ws$_socket === void 0 ? void 0 : _ws$_socket.unref();
+      clearTimeout(timeoutid);
+      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'
+    });
+  });
+} // 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); // accept loglevel updates
+
+    /* istanbul ignore next: difficult to test currently */
+
+    ws.onmessage = e => loglevel(JSON.parse(e.data).loglevel); // cleanup message handler on close
+
+
+    ws.onclose = () => remote.socket = ws.onmessage = ws.onclose = null; // 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-dom.js

@@ -1,12 +1,26 @@
-import percy from './percy-info.js';
-import request from './request.js'; // Fetch and cache the @percy/dom script
+"use strict";
 
-export async function fetchPercyDOM() {
-  if (percy.domScript == null) {
-    let response = await request('/percy/dom.js');
-    percy.domScript = response.body;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.fetchPercyDOM = fetchPercyDOM;
+
+var _percyInfo = _interopRequireDefault(require("./percy-info.js"));
+
+var _request = _interopRequireDefault(require("./request.js"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Fetch and cache the @percy/dom script
+async function fetchPercyDOM() {
+  if (_percyInfo.default.domScript == null) {
+    let response = await (0, _request.default)('/percy/dom.js');
+    _percyInfo.default.domScript = response.body;
   }
 
-  return percy.domScript;
+  return _percyInfo.default.domScript;
 }
-export default fetchPercyDOM;
+
+var _default = fetchPercyDOM;
+exports.default = _default;

package/dist/percy-enabled.js

@@ -1,55 +1,51 @@
-import logger from '@percy/logger';
-import percy from './percy-info.js';
-import request from './request.js'; // Create a socket to connect to a remote logger
-
-async function connectRemoteLogger() {
-  await logger.remote(async () => {
-    let url = percy.address.replace('http', 'ws');
-
-    if (process.env.__PERCY_BROWSERIFIED__) {
-      return new window.WebSocket(url);
-    } else {
-      /* eslint-disable-next-line import/no-extraneous-dependencies */
-      let {
-        default: WebSocket
-      } = await import('ws');
-      let ws = new WebSocket(url); // allow node to exit with an active connection
-
-      return ws.once('open', () => ws._socket.unref());
-    }
-  });
-} // Check if Percy is enabled using the healthcheck endpoint
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.isPercyEnabled = isPercyEnabled;
+
+var _percyInfo = _interopRequireDefault(require("./percy-info.js"));
 
+var _request = _interopRequireDefault(require("./request.js"));
 
-export async function isPercyEnabled() {
-  if (percy.enabled == null) {
-    let log = logger('utils');
+var _logger = _interopRequireDefault(require("./logger.js"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Check if Percy is enabled using the healthcheck endpoint
+async function isPercyEnabled() {
+  if (_percyInfo.default.enabled == null) {
+    let log = (0, _logger.default)('utils');
     let error;
 
     try {
-      let response = await request('/percy/healthcheck');
-      percy.version = response.headers['x-percy-core-version'];
-      percy.config = response.body.config;
-      percy.enabled = true;
+      let response = await (0, _request.default)('/percy/healthcheck');
+      _percyInfo.default.version = response.headers['x-percy-core-version'];
+      _percyInfo.default.config = response.body.config;
+      _percyInfo.default.enabled = true;
     } catch (e) {
-      percy.enabled = false;
+      _percyInfo.default.enabled = false;
       error = e;
     }
 
-    if (percy.enabled && percy.version.major !== 1) {
+    if (_percyInfo.default.enabled && _percyInfo.default.version.major !== 1) {
       log.info('Unsupported Percy CLI version, disabling snapshots');
-      log.debug(`Found version: ${percy.version}`);
-      percy.enabled = false;
-    } else if (!percy.enabled) {
+      log.debug(`Found version: ${_percyInfo.default.version}`);
+      _percyInfo.default.enabled = false;
+    } else if (!_percyInfo.default.enabled) {
       log.info('Percy is not running, disabling snapshots');
       log.debug(error);
     }
 
-    if (percy.enabled) {
-      await connectRemoteLogger();
+    if (_percyInfo.default.enabled) {
+      await _logger.default.remote();
     }
   }
 
-  return percy.enabled;
+  return _percyInfo.default.enabled;
 }
-export default isPercyEnabled;
+
+var _default = isPercyEnabled;
+exports.default = _default;

package/dist/percy-idle.js

@@ -1,10 +1,24 @@
-import request from './request.js';
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.waitForPercyIdle = waitForPercyIdle;
+
+var _request = _interopRequireDefault(require("./request.js"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
 const RETRY_ERROR_CODES = ['ECONNRESET', 'ETIMEDOUT'];
-export async function waitForPercyIdle() {
+
+async function waitForPercyIdle() {
   try {
-    return !!(await request('/percy/idle'));
+    return !!(await (0, _request.default)('/percy/idle'));
   } catch (e) {
     return RETRY_ERROR_CODES.includes(e.code) && waitForPercyIdle();
   }
 }
-export default waitForPercyIdle;
+
+var _default = waitForPercyIdle;
+exports.default = _default;

package/dist/percy-info.js

@@ -1,3 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
 // helper to create a version object from a string
 function toVersion(str) {
   str || (str = '0.0.0');
@@ -56,4 +63,5 @@ const info = {
   }
 
 };
-export default info;
+var _default = info;
+exports.default = _default;

package/dist/post-snapshot.js

@@ -1,17 +1,31 @@
-import percy from './percy-info.js';
-import request from './request.js'; // Post snapshot data to the snapshot endpoint. If the snapshot endpoint responds with a closed
-// error message, signal that Percy has been disabled.
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.postSnapshot = postSnapshot;
+
+var _percyInfo = _interopRequireDefault(require("./percy-info.js"));
+
+var _request = _interopRequireDefault(require("./request.js"));
 
-export async function postSnapshot(options, params) {
+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.
+async function postSnapshot(options, params) {
   let query = params ? `?${new URLSearchParams(params)}` : '';
-  await request.post(`/percy/snapshot${query}`, options).catch(err => {
+  await _request.default.post(`/percy/snapshot${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) {
-      percy.enabled = false;
+      _percyInfo.default.enabled = false;
     } else {
       throw err;
     }
   });
 }
-export default postSnapshot;
+
+var _default = postSnapshot;
+exports.default = _default;

package/dist/request.js

@@ -1,7 +1,22 @@
-import percy from './percy-info.js'; // Helper to send a request to the local CLI API
+"use strict";
 
-export async function request(path, options = {}) {
-  let response = await request.fetch(`${percy.address}${path}`, options); // maybe parse response body as json
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.request = request;
+
+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; }
+
+// Helper to send a request to the local CLI API
+async function request(path, options = {}) {
+  let response = await request.fetch(`${_percyInfo.default.address}${path}`, options); // maybe parse response body as json
 
   if (typeof response.body === 'string' && response.headers['content-type'] === 'application/json') {
     try {
@@ -46,7 +61,7 @@ if (process.env.__PERCY_BROWSERIFIED__) {
   request.fetch = async function fetch(url, options) {
     let {
       default: http
-    } = await import('http');
+    } = await Promise.resolve().then(() => _interopRequireWildcard(require('http')));
     return new Promise((resolve, reject) => {
       http.request(url, options).on('response', response => {
         let body = '';
@@ -62,4 +77,5 @@ if (process.env.__PERCY_BROWSERIFIED__) {
   };
 }
 
-export default request;
+var _default = request;
+exports.default = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/sdk-utils",
-  "version": "1.1.0",
+  "version": "1.1.3",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -21,7 +21,6 @@
   ],
   "main": "./dist/index.js",
   "browser": "./dist/bundle.js",
-  "type": "module",
   "exports": {
     ".": "./dist/index.js",
     "./test/server": "./test/server.js",
@@ -47,18 +46,9 @@
     },
     "test": {
       "external": [
-        "@percy/logger",
         "test/server(.js)?"
-      ],
-      "output": {
-        "globals": {
-          "@percy/logger": "PercySDKUtils.logger"
-        }
-      }
+      ]
     }
   },
-  "dependencies": {
-    "@percy/logger": "1.1.0"
-  },
-  "gitHead": "bf551295a8a618502bb2db92ff302e19dc956b51"
+  "gitHead": "05f91ff29b613bde1c740c120c5d23a6722d3606"
 }