@percy/core 1.28.1-alpha.1 → 1.28.1-alpha.3

package/dist/config.js

@@ -71,6 +71,9 @@ export const configSchema = {
       sync: {
         type: 'boolean'
       },
+      testCase: {
+        type: 'string'
+      },
       fullPage: {
         type: 'boolean',
         onlyAutomate: true
@@ -249,6 +252,10 @@ export const configSchema = {
         type: 'integer',
         minimum: 1
       },
+      retry: {
+        type: 'boolean',
+        default: false
+      },
       launchOptions: {
         type: 'object',
         additionalProperties: false,
@@ -312,6 +319,9 @@ export const snapshotSchema = {
         sync: {
           $ref: '/config/snapshot#/properties/sync'
         },
+        testCase: {
+          $ref: '/config/snapshot#/properties/testCase'
+        },
         reshuffleInvalidTags: {
           $ref: '/config/snapshot#/properties/reshuffleInvalidTags'
         },

package/dist/discovery.js

@@ -1,6 +1,6 @@
 import logger from '@percy/logger';
 import Queue from './queue.js';
-import { normalizeURL, hostnameMatches, createResource, createRootResource, createPercyCSSResource, createLogResource, yieldAll } from './utils.js';
+import { normalizeURL, hostnameMatches, createResource, createRootResource, createPercyCSSResource, createLogResource, yieldAll, snapshotLogName, withRetries } from './utils.js';
 
 // Logs verbose debug logs detailing various snapshot options.
 function debugSnapshotOptions(snapshot) {
@@ -139,8 +139,8 @@ function processSnapshotResources({
 
   // include associated snapshot logs matched by meta information
   resources.push(createLogResource(logger.query(log => {
-    var _log$meta$snapshot;
-    return ((_log$meta$snapshot = log.meta.snapshot) === null || _log$meta$snapshot === void 0 ? void 0 : _log$meta$snapshot.name) === snapshot.meta.snapshot.name;
+    var _log$meta$snapshot, _log$meta$snapshot2;
+    return ((_log$meta$snapshot = log.meta.snapshot) === null || _log$meta$snapshot === void 0 ? void 0 : _log$meta$snapshot.testCase) === snapshot.meta.snapshot.testCase && ((_log$meta$snapshot2 = log.meta.snapshot) === null || _log$meta$snapshot2 === void 0 ? void 0 : _log$meta$snapshot2.name) === snapshot.meta.snapshot.name;
   })));
   return {
     ...snapshot,
@@ -279,7 +279,8 @@ export const RESOURCE_CACHE_KEY = Symbol('resource-cache');
 // snapshot which is used to intercept and capture snapshot resource requests.
 export function createDiscoveryQueue(percy) {
   let {
-    concurrency
+    concurrency,
+    retry
   } = percy.config.discovery;
   let queue = new Queue('discovery');
   let cache;
@@ -296,11 +297,12 @@ export function createDiscoveryQueue(percy) {
   .handle('end', async () => {
     await percy.browser.close();
   })
-  // snapshots are unique by name; when deferred also by widths
+  // snapshots are unique by name and testCase; when deferred also by widths
   .handle('find', ({
     name,
+    testCase,
     widths
-  }, snapshot) => snapshot.name === name && (!percy.deferUploads || !widths || widths.join() === snapshot.widths.join()))
+  }, snapshot) => snapshot.testCase === testCase && snapshot.name === name && (!percy.deferUploads || !widths || widths.join() === snapshot.widths.join()))
   // initialize the resources for DOM snapshots
   .handle('push', snapshot => {
     let resources = parseDomResources(snapshot);
@@ -317,46 +319,55 @@ export function createDiscoveryQueue(percy) {
     /* istanbul ignore next: tested, but coverage is stripped */
     let assetDiscoveryPageEnableJS = snapshot.cliEnableJavaScript && !snapshot.domSnapshot || (snapshot.enableJavaScript ?? !snapshot.domSnapshot);
     percy.log.debug(`Asset discovery Browser Page enable JS: ${assetDiscoveryPageEnableJS}`);
-    // create a new browser page
-    let page = yield percy.browser.page({
-      enableJavaScript: assetDiscoveryPageEnableJS,
-      networkIdleTimeout: snapshot.discovery.networkIdleTimeout,
-      requestHeaders: snapshot.discovery.requestHeaders,
-      authorization: snapshot.discovery.authorization,
-      userAgent: snapshot.discovery.userAgent,
-      captureMockedServiceWorker: snapshot.discovery.captureMockedServiceWorker,
-      meta: snapshot.meta,
-      // enable network inteception
-      intercept: {
-        enableJavaScript: snapshot.enableJavaScript,
-        disableCache: snapshot.discovery.disableCache,
-        allowedHostnames: snapshot.discovery.allowedHostnames,
-        disallowedHostnames: snapshot.discovery.disallowedHostnames,
-        getResource: u => snapshot.resources.get(u) || cache.get(u),
-        saveResource: r => {
-          snapshot.resources.set(r.url, r);
-          if (!r.root) {
-            cache.set(r.url, r);
+    await withRetries(async function* () {
+      // create a new browser page
+      let page = yield percy.browser.page({
+        enableJavaScript: assetDiscoveryPageEnableJS,
+        networkIdleTimeout: snapshot.discovery.networkIdleTimeout,
+        requestHeaders: snapshot.discovery.requestHeaders,
+        authorization: snapshot.discovery.authorization,
+        userAgent: snapshot.discovery.userAgent,
+        captureMockedServiceWorker: snapshot.discovery.captureMockedServiceWorker,
+        meta: snapshot.meta,
+        // enable network inteception
+        intercept: {
+          enableJavaScript: snapshot.enableJavaScript,
+          disableCache: snapshot.discovery.disableCache,
+          allowedHostnames: snapshot.discovery.allowedHostnames,
+          disallowedHostnames: snapshot.discovery.disallowedHostnames,
+          getResource: u => snapshot.resources.get(u) || cache.get(u),
+          saveResource: r => {
+            snapshot.resources.set(r.url, r);
+            if (!r.root) {
+              cache.set(r.url, r);
+            }
           }
         }
+      });
+      try {
+        yield* captureSnapshotResources(page, snapshot, {
+          captureWidths: !snapshot.domSnapshot && percy.deferUploads,
+          capture: callback
+        });
+      } finally {
+        // always close the page when done
+        await page.close();
       }
+    }, {
+      count: retry ? 3 : 1,
+      onRetry: () => {
+        percy.log.info(`Retrying snapshot: ${snapshotLogName(snapshot.name, snapshot.meta)}`, snapshot.meta);
+      },
+      signal: snapshot._ctrl.signal,
+      throwOn: ['AbortError']
     });
-    try {
-      yield* captureSnapshotResources(page, snapshot, {
-        captureWidths: !snapshot.domSnapshot && percy.deferUploads,
-        capture: callback
-      });
-    } finally {
-      // always close the page when done
-      await page.close();
-    }
   }).handle('error', ({
     name,
     meta
   }, error) => {
     if (error.name === 'AbortError' && queue.readyState < 3) {
       // only error about aborted snapshots when not closed
-      percy.log.error('Received a duplicate snapshot, ' + `the previous snapshot was aborted: ${name}`, meta);
+      percy.log.error('Received a duplicate snapshot, ' + `the previous snapshot was aborted: ${snapshotLogName(name, meta)}`, meta);
     } else {
       // log all other encountered errors
       percy.log.error(`Encountered an error taking snapshot: ${name}`, meta);

package/dist/queue.js

@@ -122,9 +122,15 @@ export class Queue {
 
     // call or set up other handlers
     let exists = this.cancel(item);
+    task.ctrl = new AbortController();
+    // duplicate abortion controller on task, so it can can be used in further
+    // generators and can be cancelled internally
+    // TODO fix this for non object item usecase
+    if (typeof item === 'object' && !Array.isArray(item) && item !== null) {
+      item._ctrl = task.ctrl;
+    }
     task.item = item = _classPrivateFieldGet(this, _handlers).push ? _classPrivateFieldGet(this, _handlers).push(item, exists) : item;
     task.handler = () => _classPrivateFieldGet(this, _handlers).task ? _classPrivateFieldGet(this, _handlers).task(item, ...args) : item;
-    task.ctrl = new AbortController();
 
     // queue this task & maybe dequeue the next task
     _classPrivateFieldGet(this, _queued).add(task);

package/dist/snapshot.js

@@ -3,7 +3,7 @@ import PercyConfig from '@percy/config';
 import micromatch from 'micromatch';
 import { configSchema } from './config.js';
 import Queue from './queue.js';
-import { request, hostnameMatches, yieldTo } from './utils.js';
+import { request, hostnameMatches, yieldTo, snapshotLogName } from './utils.js';
 import { JobData } from './wait-for-job.js';
 
 // Throw a better error message for missing or invalid urls
@@ -113,7 +113,8 @@ function getSnapshotOptions(options, {
     meta: {
       ...meta,
       snapshot: {
-        name: options.name
+        name: options.name,
+        testCase: options.testCase
       }
     }
   }, config.snapshot, {
@@ -391,10 +392,11 @@ export function createSnapshotsQueue(percy) {
       });
     }
   })
-  // snapshots are unique by name alone
+  // snapshots are unique by name and testCase both
   .handle('find', ({
-    name
-  }, snapshot) => snapshot.name === name)
+    name,
+    testCase
+  }, snapshot) => snapshot.testCase === testCase && snapshot.name === name)
   // when pushed, maybe flush old snapshots or possibly merge with existing snapshots
   .handle('push', (snapshot, existing) => {
     let {
@@ -403,8 +405,8 @@ export function createSnapshotsQueue(percy) {
     } = snapshot;
 
     // log immediately when not deferred or dry-running
-    if (!percy.deferUploads) percy.log.info(`Snapshot taken: ${name}`, meta);
-    if (percy.dryRun) percy.log.info(`Snapshot found: ${name}`, meta);
+    if (!percy.deferUploads) percy.log.info(`Snapshot taken: ${snapshotLogName(name, meta)}`, meta);
+    if (percy.dryRun) percy.log.info(`Snapshot found: ${snapshotLogName(name, meta)}`, meta);
 
     // immediately flush when uploads are delayed but not skipped
     if (percy.delayUploads && !percy.deferUploads) queue.flush();

package/dist/utils.js

@@ -328,6 +328,36 @@ export function serializeFunction(fn) {
   }
   return fnbody;
 }
+export async function withRetries(fn, {
+  count,
+  onRetry,
+  signal,
+  throwOn
+}) {
+  count || (count = 1); // default a single try
+  let run = 0;
+  while (true) {
+    run += 1;
+    try {
+      return await generatePromise(fn, signal);
+    } catch (e) {
+      // if this error should not be retried on, we want to skip errors
+      let throwError = throwOn === null || throwOn === void 0 ? void 0 : throwOn.includes(e.name);
+      if (!throwError && run < count) {
+        await (onRetry === null || onRetry === void 0 ? void 0 : onRetry());
+        continue;
+      }
+      throw e;
+    }
+  }
+}
+export function snapshotLogName(name, meta) {
+  var _meta$snapshot;
+  if (meta !== null && meta !== void 0 && (_meta$snapshot = meta.snapshot) !== null && _meta$snapshot !== void 0 && _meta$snapshot.testCase) {
+    return `testCase: ${meta.snapshot.testCase}, ${name}`;
+  }
+  return name;
+}
 
 // DefaultMap, which returns a default value for an uninitialized key
 // Similar to defaultDict in python

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.28.1-alpha.1",
+  "version": "1.28.1-alpha.3",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -43,11 +43,11 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/client": "1.28.1-alpha.1",
-    "@percy/config": "1.28.1-alpha.1",
-    "@percy/dom": "1.28.1-alpha.1",
-    "@percy/logger": "1.28.1-alpha.1",
-    "@percy/webdriver-utils": "1.28.1-alpha.1",
+    "@percy/client": "1.28.1-alpha.3",
+    "@percy/config": "1.28.1-alpha.3",
+    "@percy/dom": "1.28.1-alpha.3",
+    "@percy/logger": "1.28.1-alpha.3",
+    "@percy/webdriver-utils": "1.28.1-alpha.3",
     "content-disposition": "^0.5.4",
     "cross-spawn": "^7.0.3",
     "extract-zip": "^2.0.1",
@@ -58,5 +58,5 @@
     "rimraf": "^3.0.2",
     "ws": "^8.0.0"
   },
-  "gitHead": "a8ac47269d65a7cf88658c8899c61bef1808c2d0"
+  "gitHead": "46d1e874e1092fee45899d70cd97cf793db17de5"
 }