@percy/core 1.29.4-beta.1 → 1.29.4-beta.3

package/dist/config.js

@@ -205,6 +205,14 @@ export const configSchema = {
         maximum: 750,
         minimum: 1
       },
+      waitForSelector: {
+        type: 'string'
+      },
+      waitForTimeout: {
+        type: 'integer',
+        minimum: 1,
+        maximum: 30000
+      },
       disableCache: {
         type: 'boolean'
       },
@@ -363,6 +371,12 @@ export const snapshotSchema = {
             requestHeaders: {
               $ref: '/config/discovery#/properties/requestHeaders'
             },
+            waitForSelector: {
+              $ref: '/config/discovery#/properties/waitForSelector'
+            },
+            waitForTimeout: {
+              $ref: '/config/discovery#/properties/waitForTimeout'
+            },
             authorization: {
               $ref: '/config/discovery#/properties/authorization'
             },

package/dist/discovery.js

@@ -1,6 +1,7 @@
 import logger from '@percy/logger';
 import Queue from './queue.js';
-import { normalizeURL, hostnameMatches, createResource, createRootResource, createPercyCSSResource, createLogResource, yieldAll, snapshotLogName, withRetries } from './utils.js';
+import Page from './page.js';
+import { normalizeURL, hostnameMatches, createResource, createRootResource, createPercyCSSResource, createLogResource, yieldAll, snapshotLogName, waitForTimeout, withRetries, waitForSelectorInsideBrowser } from './utils.js';
 import { sha256hash } from '@percy/client/utils';
 import Pako from 'pako';
 import TimeIt from './timing.js';
@@ -60,6 +61,19 @@ function debugSnapshotOptions(snapshot) {
   }
 }
 
+// parse browser cookies in correct format if flag is enabled
+// it assumes that cookiesStr is string returned by document.cookie
+function parseCookies(cookiesStr) {
+  if (process.env.PERCY_DO_NOT_USE_CAPTURED_COOKIES === 'true' || !(typeof cookiesStr === 'string' && cookiesStr !== '')) return null;
+  return cookiesStr.split('; ').map(c => {
+    const eqIdx = c.indexOf('=');
+    return {
+      name: c.substring(0, eqIdx),
+      value: c.substring(eqIdx + 1)
+    };
+  });
+}
+
 // Wait for a page's asset discovery network to idle
 function waitForDiscoveryNetworkIdle(page, options) {
   let {
@@ -162,6 +176,7 @@ function processSnapshotResources({
 // Triggers the capture of resource requests for a page by iterating over snapshot widths to resize
 // the page and calling any provided execute options.
 async function* captureSnapshotResources(page, snapshot, options) {
+  var _snapshot$domSnapshot;
   const log = logger('core:discovery');
   let {
     discovery,
@@ -175,20 +190,7 @@ async function* captureSnapshotResources(page, snapshot, options) {
     mobile,
     captureForDevices
   } = options;
-  let cookies;
-  if (process.env.PERCY_DO_NOT_USE_CAPTURED_COOKIES !== 'true') {
-    var _snapshot$domSnapshot;
-    cookies = snapshot === null || snapshot === void 0 ? void 0 : (_snapshot$domSnapshot = snapshot.domSnapshot) === null || _snapshot$domSnapshot === void 0 ? void 0 : _snapshot$domSnapshot.cookies;
-  }
-  if (typeof cookies === 'string' && cookies !== '') {
-    cookies = cookies.split('; ').map(c => c.split('='));
-    cookies = cookies.map(([key, value]) => {
-      return {
-        name: key,
-        value: value
-      };
-    });
-  }
+  let cookies = parseCookies(snapshot === null || snapshot === void 0 ? void 0 : (_snapshot$domSnapshot = snapshot.domSnapshot) === null || _snapshot$domSnapshot === void 0 ? void 0 : _snapshot$domSnapshot.cookies);
 
   // iterate over device to trigger reqeusts and capture other dpr width
   async function* captureResponsiveAssets() {
@@ -238,6 +240,18 @@ async function* captureSnapshotResources(page, snapshot, options) {
   yield page.goto(snapshot.url, {
     cookies
   });
+
+  // wait for any specified timeout
+  if (snapshot.discovery.waitForTimeout && page.enableJavaScript) {
+    log.debug(`Wait for ${snapshot.discovery.waitForTimeout}ms timeout`);
+    await waitForTimeout(snapshot.discovery.waitForTimeout);
+  }
+
+  // wait for any specified selector
+  if (snapshot.discovery.waitForSelector && page.enableJavaScript) {
+    log.debug(`Wait for selector: ${snapshot.discovery.waitForSelector}`);
+    await waitForSelectorInsideBrowser(page, snapshot.discovery.waitForSelector, Page.TIMEOUT);
+  }
   if (snapshot.execute) {
     // when any execute options are provided, inject snapshot options
     /* istanbul ignore next: cannot detect coverage of injected code */

package/dist/network.js

@@ -510,7 +510,7 @@ async function saveResponseResource(network, request) {
       // font anyway as font responses from the browser may not be properly encoded,
       // so request them directly.
       if (mimeType !== null && mimeType !== void 0 && mimeType.includes('font') || detectedMime && detectedMime.includes('font')) {
-        log.debug('- Requesting asset directly');
+        log.debug('- Requesting asset directly', meta);
         body = await makeDirectRequest(network, request);
       }
       resource = createResource(url, body, mimeType, {
@@ -525,7 +525,7 @@ async function saveResponseResource(network, request) {
       log.debug(`- mimetype: ${resource.mimetype}`, meta);
     } catch (error) {
       log.debug(`Encountered an error processing resource: ${url}`, meta);
-      log.debug(error);
+      log.debug(error, meta);
     }
   }
   if (resource) {

package/dist/snapshot.js

@@ -142,6 +142,8 @@ function getSnapshotOptions(options, {
       allowedHostnames: config.discovery.allowedHostnames,
       disallowedHostnames: config.discovery.disallowedHostnames,
       networkIdleTimeout: config.discovery.networkIdleTimeout,
+      waitForTimeout: config.discovery.waitForTimeout,
+      waitForSelector: config.discovery.waitForSelector,
       devicePixelRatio: config.discovery.devicePixelRatio,
       requestHeaders: config.discovery.requestHeaders,
       authorization: config.discovery.authorization,

package/dist/utils.js

@@ -274,6 +274,15 @@ async function waitForSelector(selector, timeout) {
   }
 }
 
+// wait for a query selector to exist within an optional timeout inside browser
+export async function waitForSelectorInsideBrowser(page, selector, timeout) {
+  try {
+    return page.eval(`await waitForSelector(${JSON.stringify(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.
 /* istanbul ignore next: tested, but coverage is stripped */
 async function waitForXPath(selector, timeout) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.29.4-beta.1",
+  "version": "1.29.4-beta.3",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -43,11 +43,11 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/client": "1.29.4-beta.1",
-    "@percy/config": "1.29.4-beta.1",
-    "@percy/dom": "1.29.4-beta.1",
-    "@percy/logger": "1.29.4-beta.1",
-    "@percy/webdriver-utils": "1.29.4-beta.1",
+    "@percy/client": "1.29.4-beta.3",
+    "@percy/config": "1.29.4-beta.3",
+    "@percy/dom": "1.29.4-beta.3",
+    "@percy/logger": "1.29.4-beta.3",
+    "@percy/webdriver-utils": "1.29.4-beta.3",
     "content-disposition": "^0.5.4",
     "cross-spawn": "^7.0.3",
     "extract-zip": "^2.0.1",
@@ -60,5 +60,5 @@
     "ws": "^8.17.1",
     "yaml": "^2.4.1"
   },
-  "gitHead": "4f97ecb89a592d4631c3de8ecade09a1477413aa"
+  "gitHead": "8c61c0ad7a8a1b61f199a2a011ac296764cdc2eb"
 }