@percy/core 1.28.8-beta.4 → 1.28.8

package/dist/config.js

@@ -9,6 +9,9 @@ export const configSchema = {
       },
       token: {
         type: 'string'
+      },
+      labels: {
+        type: 'string'
       }
     }
   },
@@ -74,6 +77,9 @@ export const configSchema = {
       testCase: {
         type: 'string'
       },
+      labels: {
+        type: 'string'
+      },
       thTestCaseExecutionId: {
         type: 'string'
       },
@@ -328,6 +334,9 @@ export const snapshotSchema = {
         testCase: {
           $ref: '/config/snapshot#/properties/testCase'
         },
+        labels: {
+          $ref: '/config/snapshot#/properties/labels'
+        },
         thTestCaseExecutionId: {
           $ref: '/config/snapshot#/properties/thTestCaseExecutionId'
         },

package/dist/percy.js

@@ -38,6 +38,7 @@ export class Percy {
     // implies `skipUploads` and `skipDiscovery`
     dryRun,
     // implies `dryRun`, silent logs, and adds extra api endpoints
+    labels,
     testing,
     // configuration filepath
     config: configFile,
@@ -53,12 +54,13 @@ export class Percy {
     // options which will become accessible via the `.config` property
     ...options
   } = {}) {
-    var _config$percy;
+    var _config$percy, _config$percy2;
     let config = PercyConfig.load({
       overrides: options,
       path: configFile
     });
-    deferUploads ?? (deferUploads = (_config$percy = config.percy) === null || _config$percy === void 0 ? void 0 : _config$percy.deferUploads);
+    labels ?? (labels = (_config$percy = config.percy) === null || _config$percy === void 0 ? void 0 : _config$percy.labels);
+    deferUploads ?? (deferUploads = (_config$percy2 = config.percy) === null || _config$percy2 === void 0 ? void 0 : _config$percy2.deferUploads);
     this.config = config;
     if (testing) loglevel = 'silent';
     if (loglevel) this.loglevel(loglevel);
@@ -69,11 +71,13 @@ export class Percy {
     this.skipDiscovery = this.dryRun || !!skipDiscovery;
     this.delayUploads = this.skipUploads || !!delayUploads;
     this.deferUploads = this.skipUploads || !!deferUploads;
+    this.labels = labels;
     this.client = new PercyClient({
       token,
       clientInfo,
       environmentInfo,
-      config
+      config,
+      labels
     });
     if (server) this.server = createPercyServer(this, port);
     this.browser = new Browser(this);
@@ -358,6 +362,12 @@ export class Percy {
     }
 
     // validate comparison uploads and warn about any errors
+
+    // we are having two similar attrs in options: tags & tag
+    // tags: is used as labels and is string comma-separated like "tag1,tag"
+    // tag: is comparison-tag used by app-percy & poa and this is used to create a comparison-tag in BE
+    // its format is object like {name: "", os:"", os_version:"", device:""}
+    // DO NOT GET CONFUSED!!! :)
     if ('tag' in options || 'tiles' in options) {
       var _options$tag;
       // throw when missing required snapshot or tag name

package/dist/queue.js

@@ -1,13 +1,16 @@
-function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
-function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
-function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "set"); _classApplyDescriptorSet(receiver, descriptor, value); return value; }
-function _classApplyDescriptorSet(receiver, descriptor, value) { if (descriptor.set) { descriptor.set.call(receiver, value); } else { if (!descriptor.writable) { throw new TypeError("attempted to set read only private field"); } descriptor.value = value; } }
-function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
-function _classPrivateFieldGet(receiver, privateMap) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "get"); return _classApplyDescriptorGet(receiver, descriptor); }
-function _classExtractFieldDescriptor(receiver, privateMap, action) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to " + action + " private field on non-instance"); } return privateMap.get(receiver); }
-function _classApplyDescriptorGet(receiver, descriptor) { if (descriptor.get) { return descriptor.get.call(receiver); } return descriptor.value; }
+function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
+function _classPrivateFieldInitSpec(e, t, a) { _checkPrivateRedeclaration(e, t), t.set(e, a); }
+function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _classPrivateFieldSet(e, t, r) { var s = _classPrivateFieldGet2(t, e); return _classApplyDescriptorSet(e, s, r), r; }
+function _classApplyDescriptorSet(e, t, l) { if (t.set) t.set.call(e, l);else { if (!t.writable) throw new TypeError("attempted to set read only private field"); t.value = l; } }
+function _classPrivateMethodGet(s, a, r) { return _assertClassBrand(a, s), r; }
+function _classPrivateFieldGet(e, t) { var r = _classPrivateFieldGet2(t, e); return _classApplyDescriptorGet(e, r); }
+function _classPrivateFieldGet2(s, a) { return s.get(_assertClassBrand(s, a)); }
+function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
+function _classApplyDescriptorGet(e, t) { return t.get ? t.get.call(e) : t.value; }
 import { yieldFor, generatePromise, AbortController } from './utils.js';
 import logger from '@percy/logger';
 
@@ -160,24 +163,26 @@ export class Queue {
 
   // Returns an item task matching the provided subject.
 
+  // keep track of start and end tasks
+
   // Initialize a starting task or return an existing one.
   start() {
-    var _classPrivateFieldGet2;
+    var _classPrivateFieldGet3;
     _classPrivateFieldGet(this, _start) ?? _classPrivateFieldSet(this, _start, deferred({
       readyState: 1
     }));
-    (_classPrivateFieldGet2 = _classPrivateFieldGet(this, _start)).handler ?? (_classPrivateFieldGet2.handler = _classPrivateFieldGet(this, _end) // wait for any ending task to complete first
+    (_classPrivateFieldGet3 = _classPrivateFieldGet(this, _start)).handler ?? (_classPrivateFieldGet3.handler = _classPrivateFieldGet(this, _end) // wait for any ending task to complete first
     ? () => _classPrivateFieldGet(this, _end).promise.then(_classPrivateFieldGet(this, _handlers).start) : _classPrivateFieldGet(this, _handlers).start);
     return _classPrivateMethodGet(this, _process, _process2).call(this, _classPrivateFieldGet(this, _start)).deferred;
   }
 
   // intialize an ending task or return an existing one
   end() {
-    var _classPrivateFieldGet3;
+    var _classPrivateFieldGet4;
     _classPrivateFieldGet(this, _end) ?? _classPrivateFieldSet(this, _end, deferred({
       readyState: 0
     }));
-    (_classPrivateFieldGet3 = _classPrivateFieldGet(this, _end)).handler ?? (_classPrivateFieldGet3.handler = _classPrivateFieldGet(this, _start) // wait for any starting task to complete first
+    (_classPrivateFieldGet4 = _classPrivateFieldGet(this, _end)).handler ?? (_classPrivateFieldGet4.handler = _classPrivateFieldGet(this, _start) // wait for any starting task to complete first
     ? () => _classPrivateFieldGet(this, _start).promise.then(_classPrivateFieldGet(this, _handlers).end) : _classPrivateFieldGet(this, _handlers).end);
     return _classPrivateMethodGet(this, _process, _process2).call(this, _classPrivateFieldGet(this, _end)).deferred;
   }
@@ -202,9 +207,9 @@ export class Queue {
 
   // close a running queue, optionally aborting it
   close(abort) {
-    var _classPrivateFieldGet4;
+    var _classPrivateFieldGet5;
     // when starting, state is updated afterwards
-    if ((_classPrivateFieldGet4 = _classPrivateFieldGet(this, _start)) !== null && _classPrivateFieldGet4 !== void 0 && _classPrivateFieldGet4.pending) _classPrivateFieldGet(this, _start).readyState = 3;
+    if ((_classPrivateFieldGet5 = _classPrivateFieldGet(this, _start)) !== null && _classPrivateFieldGet5 !== void 0 && _classPrivateFieldGet5.pending) _classPrivateFieldGet(this, _start).readyState = 3;
     if (this.readyState < 3) this.readyState = 3;
     if (abort) this.clear();
     return this;
@@ -223,10 +228,10 @@ export class Queue {
 
   // process a single item task when started
   process(item) {
-    var _classPrivateFieldGet5;
+    var _classPrivateFieldGet6;
     let task = _classPrivateMethodGet(this, _find, _find2).call(this, item);
     if (task && !_classPrivateFieldGet(this, _start)) this.start();
-    (_classPrivateFieldGet5 = _classPrivateFieldGet(this, _start)) === null || _classPrivateFieldGet5 === void 0 ? void 0 : _classPrivateFieldGet5.promise.then(() => _classPrivateMethodGet(this, _process, _process2).call(this, task));
+    (_classPrivateFieldGet6 = _classPrivateFieldGet(this, _start)) === null || _classPrivateFieldGet6 === void 0 ? void 0 : _classPrivateFieldGet6.promise.then(() => _classPrivateMethodGet(this, _process, _process2).call(this, task));
     return task === null || task === void 0 ? void 0 : task.deferred;
   }
 
@@ -236,9 +241,9 @@ export class Queue {
   // callback every 10ms during checks with the current number of pending tasks
   idle(callback) {
     return yieldFor(() => {
-      var _classPrivateFieldGet6;
+      var _classPrivateFieldGet7;
       callback === null || callback === void 0 ? void 0 : callback(_classPrivateFieldGet(this, _pending).size);
-      let starting = ((_classPrivateFieldGet6 = _classPrivateFieldGet(this, _start)) === null || _classPrivateFieldGet6 === void 0 ? void 0 : _classPrivateFieldGet6.pending) === true;
+      let starting = ((_classPrivateFieldGet7 = _classPrivateFieldGet(this, _start)) === null || _classPrivateFieldGet7 === void 0 ? void 0 : _classPrivateFieldGet7.pending) === true;
       return !starting && !_classPrivateFieldGet(this, _pending).size;
     }, {
       idle: 10
@@ -324,8 +329,8 @@ function _process2(task) {
 async function* _until2(task, callback) {
   try {
     yield* yieldFor(() => {
-      var _classPrivateFieldGet7;
-      if ((_classPrivateFieldGet7 = _classPrivateFieldGet(this, _start)) !== null && _classPrivateFieldGet7 !== void 0 && _classPrivateFieldGet7.pending) return false;
+      var _classPrivateFieldGet8;
+      if ((_classPrivateFieldGet8 = _classPrivateFieldGet(this, _start)) !== null && _classPrivateFieldGet8 !== void 0 && _classPrivateFieldGet8.pending) return false;
       let queued,
         pending = _classPrivateFieldGet(this, _pending).size;
       // calculate the position within queued when not pending

package/dist/server.js

@@ -1,12 +1,13 @@
-function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
-function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
-function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
-function _classPrivateFieldGet(receiver, privateMap) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "get"); return _classApplyDescriptorGet(receiver, descriptor); }
-function _classApplyDescriptorGet(receiver, descriptor) { if (descriptor.get) { return descriptor.get.call(receiver); } return descriptor.value; }
-function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
-function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "set"); _classApplyDescriptorSet(receiver, descriptor, value); return value; }
-function _classExtractFieldDescriptor(receiver, privateMap, action) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to " + action + " private field on non-instance"); } return privateMap.get(receiver); }
-function _classApplyDescriptorSet(receiver, descriptor, value) { if (descriptor.set) { descriptor.set.call(receiver, value); } else { if (!descriptor.writable) { throw new TypeError("attempted to set read only private field"); } descriptor.value = value; } }
+function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
+function _classPrivateFieldInitSpec(e, t, a) { _checkPrivateRedeclaration(e, t), t.set(e, a); }
+function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
+function _classPrivateFieldGet2(e, t) { var r = _classPrivateFieldGet(t, e); return _classApplyDescriptorGet(e, r); }
+function _classApplyDescriptorGet(e, t) { return t.get ? t.get.call(e) : t.value; }
+function _classPrivateMethodGet(s, a, r) { return _assertClassBrand(a, s), r; }
+function _classPrivateFieldSet(e, t, r) { var s = _classPrivateFieldGet(t, e); return _classApplyDescriptorSet(e, s, r), r; }
+function _classPrivateFieldGet(s, a) { return s.get(_assertClassBrand(s, a)); }
+function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
+function _classApplyDescriptorSet(e, t, l) { if (t.set) t.set.call(e, l);else { if (!t.writable) throw new TypeError("attempted to set read only private field"); t.value = l; } }
 import fs from 'fs';
 import path from 'path';
 import http from 'http';
@@ -130,7 +131,7 @@ export class Server extends http.Server {
           res.setHeader('Access-Control-Allow-Origin', '*');
           if (req.method === 'OPTIONS') {
             let allowHeaders = req.headers['access-control-request-headers'] || '*';
-            let allowMethods = [...new Set(_classPrivateFieldGet(this, _routes).flatMap(route => (!route.match || route.match(req.url.pathname)) && route.methods || []))].join(', ');
+            let allowMethods = [...new Set(_classPrivateFieldGet2(this, _routes).flatMap(route => (!route.match || route.match(req.url.pathname)) && route.methods || []))].join(', ');
             res.setHeader('Access-Control-Allow-Headers', allowHeaders);
             res.setHeader('Access-Control-Allow-Methods', allowMethods);
             res.writeHead(204).end();
@@ -152,8 +153,8 @@ export class Server extends http.Server {
     });
     // track open connections to terminate when the server closes
     this.on('connection', socket => {
-      let handleClose = () => _classPrivateFieldGet(this, _sockets).delete(socket);
-      _classPrivateFieldGet(this, _sockets).add(socket.on('close', handleClose));
+      let handleClose = () => _classPrivateFieldGet2(this, _sockets).delete(socket);
+      _classPrivateFieldGet2(this, _sockets).add(socket.on('close', handleClose));
     });
   }
 
@@ -165,7 +166,7 @@ export class Server extends http.Server {
   // return the listening port or any default port
   get port() {
     var _super$address;
-    return ((_super$address = super.address()) === null || _super$address === void 0 ? void 0 : _super$address.port) ?? _classPrivateFieldGet(this, _defaultPort);
+    return ((_super$address = super.address()) === null || _super$address === void 0 ? void 0 : _super$address.port) ?? _classPrivateFieldGet2(this, _defaultPort);
   }
 
   // return a string representation of the server address
@@ -180,7 +181,7 @@ export class Server extends http.Server {
   }
 
   // return a promise that resolves when the server is listening
-  listen(port = _classPrivateFieldGet(this, _defaultPort)) {
+  listen(port = _classPrivateFieldGet2(this, _defaultPort)) {
     return new Promise((resolve, reject) => {
       let handle = err => off() && err ? reject(err) : resolve(this);
       let off = () => this.off('error', handle).off('listening', handle);
@@ -191,13 +192,15 @@ export class Server extends http.Server {
   // return a promise that resolves when the server closes
   close() {
     return new Promise(resolve => {
-      _classPrivateFieldGet(this, _sockets).forEach(socket => socket.destroy());
+      _classPrivateFieldGet2(this, _sockets).forEach(socket => socket.destroy());
       super.close(resolve);
     });
   }
 
   // initial routes include cors and 404 handling
 
+  // adds a route in the correct priority order
+
   // set request routing and handling for pathnames and methods
   route(method, pathname, handle) {
     if (arguments.length === 1) [handle, method] = [method];
@@ -255,8 +258,8 @@ export class Server extends http.Server {
 
 // create a url rewriter from provided rewrite rules
 function _route2(route) {
-  let i = _classPrivateFieldGet(this, _routes).findIndex(r => r.priority >= route.priority);
-  _classPrivateFieldGet(this, _routes).splice(i, 0, route);
+  let i = _classPrivateFieldGet2(this, _routes).findIndex(r => r.priority >= route.priority);
+  _classPrivateFieldGet2(this, _routes).splice(i, 0, route);
   return this;
 }
 async function _handleRequest2(req, res) {
@@ -275,7 +278,7 @@ async function _handleRequest2(req, res) {
       result && (result = !match || match(req.url.pathname));
       if (result) req.params = result.params;
       return result ? handle(req, res, next) : next();
-    }(_classPrivateFieldGet(this, _routes));
+    }(_classPrivateFieldGet2(this, _routes));
   } catch (error) {
     var _req$headers$accept, _req$headers$content;
     let {

package/dist/snapshot.js

@@ -114,7 +114,8 @@ function getSnapshotOptions(options, {
       ...meta,
       snapshot: {
         name: options.name,
-        testCase: options.testCase
+        testCase: options.testCase,
+        labels: options.labels
       }
     }
   }, config.snapshot, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.28.8-beta.4",
+  "version": "1.28.8",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "beta"
+    "tag": "latest"
   },
   "engines": {
     "node": ">=14"
@@ -43,22 +43,22 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/client": "1.28.8-beta.4",
-    "@percy/config": "1.28.8-beta.4",
-    "@percy/dom": "1.28.8-beta.4",
-    "@percy/logger": "1.28.8-beta.4",
-    "@percy/webdriver-utils": "1.28.8-beta.4",
+    "@percy/client": "1.28.8",
+    "@percy/config": "1.28.8",
+    "@percy/dom": "1.28.8",
+    "@percy/logger": "1.28.8",
+    "@percy/webdriver-utils": "1.28.8",
     "content-disposition": "^0.5.4",
     "cross-spawn": "^7.0.3",
     "extract-zip": "^2.0.1",
     "fast-glob": "^3.2.11",
-    "micromatch": "^4.0.4",
+    "micromatch": "^4.0.6",
     "mime-types": "^2.1.34",
     "pako": "^2.1.0",
     "path-to-regexp": "^6.2.0",
     "rimraf": "^3.0.2",
-    "ws": "^8.0.0",
+    "ws": "^8.17.1",
     "yaml": "^2.4.1"
   },
-  "gitHead": "0ea30a56b97b5a5dab6ddc1282f71f1ecf07df2d"
+  "gitHead": "1b93761a01b608afadf8d4efccacc11f925396bd"
 }