@percy/core 1.12.0 → 1.13.0

package/dist/utils.js

@@ -1,12 +1,14 @@
 import EventEmitter from 'events';
 import { sha256hash } from '@percy/client/utils';
 export { request, getPackageJSON, hostnameMatches } from '@percy/client/utils';
-export { Server, createServer } from './server.js'; // Returns the hostname portion of a URL.
+export { Server, createServer } from './server.js';
 
+// Returns the hostname portion of a URL.
 export function hostname(url) {
   return new URL(url).hostname;
-} // Normalizes a URL by stripping hashes to ensure unique resources.
+}
 
+// Normalizes a URL by stripping hashes to ensure unique resources.
 export function normalizeURL(url) {
   let {
     protocol,
@@ -15,25 +17,29 @@ export function normalizeURL(url) {
     search
   } = new URL(url);
   return `${protocol}//${host}${pathname}${search}`;
-} // Creates a local resource object containing the resource URL, mimetype, content, sha, and any
-// other additional resources attributes.
+}
 
+// Creates a local resource object containing the resource URL, mimetype, content, sha, and any
+// other additional resources attributes.
 export function createResource(url, content, mimetype, attrs) {
-  return { ...attrs,
+  return {
+    ...attrs,
     sha: sha256hash(content),
     mimetype,
     content,
     url
   };
-} // Creates a root resource object with an additional `root: true` property. The URL is normalized
-// here as a convenience since root resources are usually created outside of asset discovery.
+}
 
+// Creates a root resource object with an additional `root: true` property. The URL is normalized
+// here as a convenience since root resources are usually created outside of asset discovery.
 export function createRootResource(url, content) {
   return createResource(normalizeURL(url), content, 'text/html', {
     root: true
   });
-} // Creates a Percy CSS resource object.
+}
 
+// Creates a Percy CSS resource object.
 export function createPercyCSSResource(url, css) {
   let {
     href,
@@ -42,21 +48,24 @@ export function createPercyCSSResource(url, css) {
   return createResource(href, css, 'text/css', {
     pathname
   });
-} // Creates a log resource object.
+}
 
+// Creates a log resource object.
 export function createLogResource(logs) {
   let [url, content] = [`/percy.${Date.now()}.log`, JSON.stringify(logs)];
   return createResource(url, content, 'text/plain', {
     log: true
   });
-} // Returns true or false if the provided object is a generator or not
+}
 
+// Returns true or false if the provided object is a generator or not
 export function isGenerator(subject) {
   return typeof (subject === null || subject === void 0 ? void 0 : subject.next) === 'function' && (typeof subject[Symbol.iterator] === 'function' || typeof subject[Symbol.asyncIterator] === 'function');
-} // Iterates over the provided generator and resolves to the final value when done. With an
+}
+
+// Iterates over the provided generator and resolves to the final value when done. With an
 // AbortSignal, the generator will throw with the abort reason when aborted. Also accepts an
 // optional node-style callback, called before the returned promise resolves.
-
 export async function generatePromise(gen, signal, cb) {
   try {
     if (typeof signal === 'function') [cb, signal] = [signal];
@@ -68,27 +77,24 @@ export async function generatePromise(gen, signal, cb) {
       done: true,
       value: await gen
     } : await gen.next();
-
     while (!done) {
       var _signal;
-
       ({
         done,
         value
       } = (_signal = signal) !== null && _signal !== void 0 && _signal.aborted ? await gen.throw(signal.reason) : await gen.next(value));
     }
-
     if (!cb) return value;
     return cb(null, value);
   } catch (error) {
     if (!cb) throw error;
     return cb(error);
   }
-} // Bare minimum AbortController polyfill for Node < 16.14
+}
 
+// Bare minimum AbortController polyfill for Node < 16.14
 export class AbortController {
   signal = new EventEmitter();
-
   abort(reason = new AbortError()) {
     if (this.signal.aborted) return;
     Object.assign(this.signal, {
@@ -97,9 +103,9 @@ export class AbortController {
     });
     this.signal.emit('abort', reason);
   }
+}
 
-} // Similar to DOMException[AbortError] but accepts additional properties
-
+// Similar to DOMException[AbortError] but accepts additional properties
 export class AbortError extends Error {
   constructor(msg = 'This operation was aborted', props) {
     Object.assign(super(msg), {
@@ -107,44 +113,44 @@ export class AbortError extends Error {
       ...props
     });
   }
+}
 
-} // An async generator that yields after every event loop until the promise settles
-
+// An async generator that yields after every event loop until the promise settles
 export async function* yieldTo(subject) {
   // yield to any provided generator or return non-promise values
   if (isGenerator(subject)) return yield* subject;
-  if (typeof (subject === null || subject === void 0 ? void 0 : subject.then) !== 'function') return subject; // update local variables with the provided promise
+  if (typeof (subject === null || subject === void 0 ? void 0 : subject.then) !== 'function') return subject;
 
+  // update local variables with the provided promise
   let result,
-      error,
-      pending = !!subject.then(r => result = r, e => error = e).finally(() => pending = false);
-  /* eslint-disable-next-line no-unmodified-loop-condition */
+    error,
+    pending = !!subject.then(r => result = r, e => error = e).finally(() => pending = false);
 
+  /* eslint-disable-next-line no-unmodified-loop-condition */
   while (pending) yield new Promise(r => setImmediate(r));
-
   if (error) throw error;
   return result;
-} // An async generator that runs provided generators concurrently
+}
 
+// An async generator that runs provided generators concurrently
 export async function* yieldAll(all) {
   let res = new Array(all.length).fill();
   all = all.map(yieldTo);
-
   while (true) {
     res = await Promise.all(all.map((g, i) => {
       var _res$i, _res$i2;
-
       return (_res$i = res[i]) !== null && _res$i !== void 0 && _res$i.done ? res[i] : g.next((_res$i2 = res[i]) === null || _res$i2 === void 0 ? void 0 : _res$i2.value);
     }));
     let vals = res.map(r => r === null || r === void 0 ? void 0 : r.value);
     if (res.some(r => !(r !== null && r !== void 0 && r.done))) yield vals;else return vals;
   }
-} // An async generator that infinitely yields to the predicate function until a truthy value is
+}
+
+// An async generator that infinitely yields to the predicate function until a truthy value is
 // returned. When a timeout is provided, an error will be thrown during the next iteration after the
 // timeout has been exceeded. If an idle option is provided, the predicate will be yielded to a
 // second time, after the idle period, to ensure the yielded value is still truthy. The poll option
 // determines how long to wait before yielding to the predicate function during each iteration.
-
 export async function* yieldFor(predicate, options = {}) {
   if (Number.isInteger(options)) options = {
     timeout: options
@@ -156,7 +162,6 @@ export async function* yieldFor(predicate, options = {}) {
   } = options;
   let start = Date.now();
   let done, value;
-
   while (true) {
     if (timeout && Date.now() - start >= timeout) {
       throw new Error(`Timeout of ${timeout}ms exceeded.`);
@@ -168,88 +173,85 @@ export async function* yieldFor(predicate, options = {}) {
       return value;
     }
   }
-} // Promisified version of `yieldFor` above.
+}
 
+// Promisified version of `yieldFor` above.
 export function waitFor() {
   return generatePromise(yieldFor(...arguments));
-} // Promisified version of `setTimeout` (no callback argument).
+}
 
+// Promisified version of `setTimeout` (no callback argument).
 export function waitForTimeout() {
   return new Promise(resolve => setTimeout(resolve, ...arguments));
-} // Browser-specific util to wait for a query selector to exist within an optional timeout.
+}
 
+// Browser-specific util to wait for a query selector to exist within an optional timeout.
 /* istanbul ignore next: tested, but coverage is stripped */
-
 async function waitForSelector(selector, timeout) {
   try {
     return await waitFor(() => document.querySelector(selector), timeout);
   } catch {
     throw new Error(`Unable to find: ${selector}`);
   }
-} // Browser-specific util to wait for an xpath selector to exist within an optional timeout.
+}
 
+// Browser-specific util to wait for an xpath selector to exist within an optional timeout.
 /* istanbul ignore next: tested, but coverage is stripped */
-
-
 async function waitForXPath(selector, timeout) {
   try {
     let xpath = () => document.evaluate(selector, document, null, 9, null);
-
     return await waitFor(() => xpath().singleNodeValue, timeout);
   } catch {
     throw new Error(`Unable to find: ${selector}`);
   }
-} // Browser-specific util to scroll to the bottom of a page, optionally calling the provided function
-// after each window segment has been scrolled.
+}
 
+// Browser-specific util to scroll to the bottom of a page, optionally calling the provided function
+// after each window segment has been scrolled.
 /* istanbul ignore next: tested, but coverage is stripped */
-
-
 async function scrollToBottom(options, onScroll) {
   if (typeof options === 'function') [onScroll, options] = [options];
-
   let size = () => Math.ceil(document.body.scrollHeight / window.innerHeight);
-
   for (let s, i = 1; i < (s = size()); i++) {
     var _onScroll;
-
-    window.scrollTo({ ...options,
+    window.scrollTo({
+      ...options,
       top: window.innerHeight * i
     });
     await ((_onScroll = onScroll) === null || _onScroll === void 0 ? void 0 : _onScroll(i, s));
   }
-} // Used to test if a string looks like a function
-
+}
 
-const FUNC_REG = /^(async\s+)?(function\s*)?(\w+\s*)?\(.*?\)\s*(\{|=>)/is; // Serializes the provided function with percy helpers for use in evaluating browser scripts
+// Used to test if a string looks like a function
+const FUNC_REG = /^(async\s+)?(function\s*)?(\w+\s*)?\(.*?\)\s*(\{|=>)/is;
 
+// Serializes the provided function with percy helpers for use in evaluating browser scripts
 export function serializeFunction(fn) {
   // stringify or convert a function body into a complete function
-  let fnbody = typeof fn === 'string' && !FUNC_REG.test(fn) ? `async function eval() {\n${fn}\n}` : fn.toString(); // we might have a function shorthand if this fails
+  let fnbody = typeof fn === 'string' && !FUNC_REG.test(fn) ? `async function eval() {\n${fn}\n}` : fn.toString();
 
+  // we might have a function shorthand if this fails
   /* eslint-disable-next-line no-new, no-new-func */
-
   try {
     new Function(`(${fnbody})`);
   } catch (error) {
     fnbody = fnbody.startsWith('async ') ? fnbody.replace(/^async/, 'async function') : `function ${fnbody}`;
-    /* eslint-disable-next-line no-new, no-new-func */
 
+    /* eslint-disable-next-line no-new, no-new-func */
     try {
       new Function(`(${fnbody})`);
     } catch (error) {
       throw new Error('The provided function is not serializable');
     }
-  } // wrap the function body with percy helpers
-
+  }
 
+  // wrap the function body with percy helpers
   fnbody = 'function withPercyHelpers() {\n' + ['const { config, snapshot } = window.__PERCY__ ?? {};', `return (${fnbody})({`, '  config, snapshot, generatePromise, yieldFor,', '  waitFor, waitForTimeout, waitForSelector, waitForXPath,', '  scrollToBottom', '}, ...arguments);', `${isGenerator}`, `${generatePromise}`, `${yieldFor}`, `${waitFor}`, `${waitForTimeout}`, `${waitForSelector}`, `${waitForXPath}`, `${scrollToBottom}`].join('\n') + '\n}';
-  /* istanbul ignore else: ironic. */
 
+  /* istanbul ignore else: ironic. */
   if (fnbody.includes('cov_')) {
     // remove coverage statements during testing
     fnbody = fnbody.replace(/cov_.*?(;\n?|,)\s*/g, '');
   }
-
   return fnbody;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -39,10 +39,10 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/client": "1.12.0",
-    "@percy/config": "1.12.0",
-    "@percy/dom": "1.12.0",
-    "@percy/logger": "1.12.0",
+    "@percy/client": "1.13.0",
+    "@percy/config": "1.13.0",
+    "@percy/dom": "1.13.0",
+    "@percy/logger": "1.13.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": "4303b74df91f60e36065141289d2ef2277d1d6fc"
+  "gitHead": "d2e812d14aa446fa580ffa75144a6280627b5a27"
 }