@percy/core 1.28.1-alpha.2 → 1.28.1-alpha.4

package/dist/config.js

@@ -71,6 +71,9 @@ export const configSchema = {
       sync: {
         type: 'boolean'
       },
+      testCase: {
+        type: 'string'
+      },
       fullPage: {
         type: 'boolean',
         onlyAutomate: true
@@ -249,10 +252,6 @@ export const configSchema = {
         type: 'integer',
         minimum: 1
       },
-      retry: {
-        type: 'boolean',
-        default: false
-      },
       launchOptions: {
         type: 'object',
         additionalProperties: false,
@@ -316,6 +315,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, withRetries } from './utils.js';
+import { normalizeURL, hostnameMatches, createResource, createRootResource, createPercyCSSResource, createLogResource, yieldAll, snapshotLogName } 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,8 +279,7 @@ 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,
-    retry
+    concurrency
   } = percy.config.discovery;
   let queue = new Queue('discovery');
   let cache;
@@ -297,11 +296,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);
@@ -318,53 +318,46 @@ 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}`);
-    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);
-            }
+    // 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.debug(`Retrying snapshot: ${snapshot.name}`, snapshot.meta);
       }
     });
+    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/network.js

@@ -28,7 +28,6 @@ export class Network {
   #requests = new Map();
   #authentications = new Set();
   #aborted = new Set();
-  #finishedUrls = new Set();
   constructor(page, options) {
     this.page = page;
     this.timeout = options.networkIdleTimeout ?? 100;
@@ -79,12 +78,6 @@ export class Network {
         throw new Error(`Network error: ${this.page.session.closedReason}`);
       }
       requests = Array.from(this.#requests.values()).filter(filter);
-      // remove requests which are finished at least once
-      // this happens when same request is made multiple times by browser in parallel and one of
-      // them gets stuck in pending state in browser [ need to debug why ]. So we dont receive
-      // loadingFinished event, causing it to show up in Active requests, but we can only store one
-      // response per url so as long as we have captured one, we dont care about other such requests
-      requests = requests.filter(req => !this.#finishedUrls.has(req.url));
       return requests.length === 0;
     }, {
       timeout: Network.TIMEOUT,
@@ -127,12 +120,10 @@ export class Network {
   // Called when a request should be removed from various trackers
   _forgetRequest({
     requestId,
-    interceptId,
-    url
+    interceptId
   }, keepPending) {
     this.#requests.delete(requestId);
     this.#authentications.delete(interceptId);
-    this.#finishedUrls.add(url);
     if (!keepPending) {
       this.#pending.delete(requestId);
     }

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,24 +328,12 @@ export function serializeFunction(fn) {
   }
   return fnbody;
 }
-export async function withRetries(fn, {
-  count,
-  onRetry
-}) {
-  count || (count = 1); // default a single try
-  let run = 0;
-  while (true) {
-    run += 1;
-    try {
-      return await generatePromise(fn);
-    } catch (e) {
-      if (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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.28.1-alpha.2",
+  "version": "1.28.1-alpha.4",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "alpha"
+    "tag": "beta"
   },
   "engines": {
     "node": ">=14"
@@ -43,11 +43,11 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/client": "1.28.1-alpha.2",
-    "@percy/config": "1.28.1-alpha.2",
-    "@percy/dom": "1.28.1-alpha.2",
-    "@percy/logger": "1.28.1-alpha.2",
-    "@percy/webdriver-utils": "1.28.1-alpha.2",
+    "@percy/client": "1.28.1-alpha.4",
+    "@percy/config": "1.28.1-alpha.4",
+    "@percy/dom": "1.28.1-alpha.4",
+    "@percy/logger": "1.28.1-alpha.4",
+    "@percy/webdriver-utils": "1.28.1-alpha.4",
     "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": "a3f2e709d0a6445e15a1128686578b1659243a95"
+  "gitHead": "90d1c1135441a631d5fdbbce0a7e2efbe8ab4e21"
 }