@percy/core 1.28.0 → 1.28.1-alpha.2

package/dist/api.js

@@ -117,10 +117,10 @@ export function createPercyServer(percy, port) {
       const snapshotPromise = new Promise((resolve, reject) => percy.upload(req.body, {
         resolve,
         reject
-      }));
+      }, 'app'));
       data = await handleSyncJob(snapshotPromise, percy, 'comparison');
     } else {
-      let upload = percy.upload(req.body);
+      let upload = percy.upload(req.body, null, 'app');
       if (req.url.searchParams.has('await')) await upload;
     }
 
@@ -164,10 +164,10 @@ export function createPercyServer(percy, port) {
       const snapshotPromise = new Promise((resolve, reject) => percy.upload(comparisonData, {
         resolve,
         reject
-      }));
+      }, 'automate'));
       data = await handleSyncJob(snapshotPromise, percy, 'comparison');
     } else {
-      percy.upload(comparisonData);
+      percy.upload(comparisonData, null, 'automate');
     }
     res.json(200, {
       success: true,

package/dist/config.js

@@ -249,6 +249,10 @@ export const configSchema = {
         type: 'integer',
         minimum: 1
       },
+      retry: {
+        type: 'boolean',
+        default: false
+      },
       launchOptions: {
         type: 'object',
         additionalProperties: false,

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, withRetries } from './utils.js';
 
 // Logs verbose debug logs detailing various snapshot options.
 function debugSnapshotOptions(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;
@@ -317,39 +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}`);
-    // 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.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

package/dist/network.js

@@ -28,6 +28,7 @@ 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;
@@ -78,6 +79,12 @@ 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,
@@ -120,10 +127,12 @@ export class Network {
   // Called when a request should be removed from various trackers
   _forgetRequest({
     requestId,
-    interceptId
+    interceptId,
+    url
   }, keepPending) {
     this.#requests.delete(requestId);
     this.#authentications.delete(interceptId);
+    this.#finishedUrls.add(url);
     if (!keepPending) {
       this.#pending.delete(requestId);
     }

package/dist/percy.js

@@ -333,7 +333,7 @@ export class Percy {
   }
 
   // Uploads one or more snapshots directly to the current Percy build
-  upload(options, callback = null) {
+  upload(options, callback = null, screenshotFlow = null) {
     if (this.readyState !== 1) {
       throw new Error('Not running');
     } else if (Array.isArray(options)) {
@@ -364,6 +364,7 @@ export class Percy {
     // add client & environment info
     this.client.addClientInfo(options.clientInfo);
     this.client.addEnvironmentInfo(options.environmentInfo);
+    this.client.screenshotFlow = screenshotFlow;
 
     // Sync CLI support, attached resolve, reject promise
     if (this.syncMode(options)) {

package/dist/snapshot.js

@@ -344,6 +344,7 @@ export function createSnapshotsQueue(percy) {
   // on start, create a new Percy build
   .handle('start', async () => {
     try {
+      var _data$attributes;
       build = percy.build = {};
       let {
         data
@@ -352,6 +353,7 @@ export function createSnapshotsQueue(percy) {
       });
       let url = data.attributes['web-url'];
       let number = data.attributes['build-number'];
+      percy.client.buildType = (_data$attributes = data.attributes) === null || _data$attributes === void 0 ? void 0 : _data$attributes.type;
       Object.assign(build, {
         id: data.id,
         url,
@@ -420,7 +422,11 @@ export function createSnapshotsQueue(percy) {
       name,
       meta
     } = snapshot;
-
+    if (percy.client.screenshotFlow === 'automate' && percy.client.buildType !== 'automate') {
+      throw new Error(`Cannot run automate screenshots in ${percy.client.buildType} project. Please use automate project token`);
+    } else if (percy.client.screenshotFlow === 'app' && percy.client.buildType !== 'app') {
+      throw new Error(`Cannot run App Percy screenshots in ${percy.client.buildType} project. Please use App Percy project token`);
+    }
     // yield to evaluated snapshot resources
     snapshot.resources = typeof resources === 'function' ? yield* yieldTo(resources()) : resources;
 

package/dist/utils.js

@@ -328,6 +328,25 @@ 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;
+    }
+  }
+}
 
 // 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.0",
+  "version": "1.28.1-alpha.2",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "latest"
+    "tag": "alpha"
   },
   "engines": {
     "node": ">=14"
@@ -43,11 +43,11 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/client": "1.28.0",
-    "@percy/config": "1.28.0",
-    "@percy/dom": "1.28.0",
-    "@percy/logger": "1.28.0",
-    "@percy/webdriver-utils": "1.28.0",
+    "@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",
     "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": "9d95f18e45e37aa3683e5b8276fd85cf07dba8cb"
+  "gitHead": "a3f2e709d0a6445e15a1128686578b1659243a95"
 }