@percy/core 1.30.0 → 1.30.2-alpha.0

package/dist/discovery.js

@@ -4,7 +4,6 @@ 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';
 
 // Logs verbose debug logs detailing various snapshot options.
 function debugSnapshotOptions(snapshot) {
@@ -76,7 +75,8 @@ function parseCookies(cookies) {
     return cookies.map(c => ({
       name: c.name,
       value: c.value,
-      secure: c.secure
+      secure: c.secure,
+      domain: c.domain
     }));
   }
   if (!(typeof cookies === 'string' && cookies !== '')) return null;
@@ -244,7 +244,7 @@ async function* captureSnapshotResources(page, snapshot, options) {
     mobile,
     captureForDevices
   } = options;
-  let cookies = (snapshot === null || snapshot === void 0 || (_snapshot$domSnapshot = snapshot.domSnapshot) === null || _snapshot$domSnapshot === void 0 ? void 0 : _snapshot$domSnapshot.cookies) || (snapshot === null || snapshot === void 0 || (_snapshot$domSnapshot2 = snapshot.domSnapshot) === null || _snapshot$domSnapshot2 === void 0 || (_snapshot$domSnapshot2 = _snapshot$domSnapshot2[0]) === null || _snapshot$domSnapshot2 === void 0 ? void 0 : _snapshot$domSnapshot2.cookies);
+  let cookies = ((_snapshot$domSnapshot = snapshot.domSnapshot) === null || _snapshot$domSnapshot === void 0 ? void 0 : _snapshot$domSnapshot.cookies) || ((_snapshot$domSnapshot2 = snapshot.domSnapshot) === null || _snapshot$domSnapshot2 === void 0 || (_snapshot$domSnapshot2 = _snapshot$domSnapshot2[0]) === null || _snapshot$domSnapshot2 === void 0 ? void 0 : _snapshot$domSnapshot2.cookies);
   cookies = parseCookies(cookies);
 
   // iterate over device to trigger reqeusts and capture other dpr width
@@ -419,7 +419,6 @@ export function createDiscoveryQueue(percy) {
     concurrency
   } = percy.config.discovery;
   let queue = new Queue('discovery');
-  let timeit = new TimeIt();
   let cache;
   return queue.set({
     concurrency
@@ -453,13 +452,13 @@ export function createDiscoveryQueue(percy) {
   })
   // discovery resources for snapshots and call the callback for each discovered snapshot
   .handle('task', async function* (snapshot, callback) {
-    await timeit.measure('asset-discovery', snapshot.name, async () => {
+    await logger.measure('asset-discovery', snapshot.name, snapshot.meta, async () => {
       percy.log.debug(`Discovering resources: ${snapshot.name}`, snapshot.meta);
 
       // expectation explained in tests
       /* 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}`);
+      percy.log.debug(`Asset discovery Browser Page enable JS: ${assetDiscoveryPageEnableJS}`, snapshot.meta);
       await withRetries(async function* () {
         // create a new browser page
         let page = yield percy.browser.page({

package/dist/findRevision.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+function download_url {
+  if [[ "$OS" == "Linux" ]]; then
+    echo "https://www.googleapis.com/download/storage/v1/b/chromium-browser-snapshots/o/Linux_x64%2F${1}%2Fchrome-linux.zip?alt=media"
+  elif [[ "$OS" == "Mac" ]] || [[ "$OS" == "Mac_Arm" ]]; then
+    echo "https://www.googleapis.com/download/storage/v1/b/chromium-browser-snapshots/o/$OS%2F${1}%2Fchrome-mac.zip?alt=media"
+  elif [[ "$OS" == "Win" ]] || [[ "$OS" == "Win_x64" ]]; then
+    echo "https://www.googleapis.com/download/storage/v1/b/chromium-browser-snapshots/o/$OS%2F${1}%2Fchrome-win.zip?alt=media"
+  fi
+}
+
+function get_closest_rev {
+  while true; do
+    curl -I 2>/dev/null `download_url $REVISION` | head -1 | grep 404 >/dev/null
+    if (($? == 1)); then
+      break
+    fi
+    REVISION=$(($REVISION-1))
+  done
+  echo $REVISION
+}
+
+
+if (($# < 1)); then
+  printf "usage: \n"
+  printf "  ./get_chromuim [-r] rev    - will get chromium by revision\n"
+  exit 1
+fi
+
+export REVISION=$1
+
+for os in "Linux" "Mac" "Mac_Arm" "Win" "Win_x64";
+do
+  export OS=$os
+  echo "$OS" `get_closest_rev`
+done

package/dist/network.js

@@ -46,7 +46,7 @@ export class Network {
     session.on('Network.requestWillBeSent', this._handleRequestWillBeSent);
     session.on('Network.responseReceived', this._handleResponseReceived.bind(this, session));
     session.on('Network.eventSourceMessageReceived', this._handleEventSourceMessageReceived);
-    session.on('Network.loadingFinished', this._handleLoadingFinished);
+    session.on('Network.loadingFinished', this._handleLoadingFinished.bind(this, session));
     session.on('Network.loadingFailed', this._handleLoadingFailed);
     let commands = [session.send('Network.enable'), session.send('Network.setBypassServiceWorker', {
       bypass: !this.captureMockedServiceWorker
@@ -309,7 +309,7 @@ export class Network {
 
   // Called when a request has finished loading which triggers the this.onrequestfinished
   // callback. The request should have an associated response and be finished with any redirects.
-  _handleLoadingFinished = async event => {
+  _handleLoadingFinished = async (session, event) => {
     let {
       requestId
     } = event;
@@ -318,7 +318,7 @@ export class Network {
     let request = this.#requests.get(requestId);
     /* istanbul ignore if: race condition paranioa */
     if (!request) return;
-    await saveResponseResource(this, request);
+    await saveResponseResource(this, request, session);
     this._forgetRequest(request);
   };
 
@@ -441,10 +441,16 @@ async function sendResponseResource(network, request, session) {
 }
 
 // Make a new request with Node based on a network request
-function makeDirectRequest(network, request) {
+async function makeDirectRequest(network, request, session) {
   var _network$authorizatio;
+  const {
+    cookies
+  } = await session.send('Network.getCookies', {
+    urls: [request.url]
+  });
   let headers = {
-    ...request.headers
+    ...request.headers,
+    cookie: cookies.map(cookie => `${cookie.name}=${cookie.value}`).join('; ')
   };
   if ((_network$authorizatio = network.authorization) !== null && _network$authorizatio !== void 0 && _network$authorizatio.username) {
     // include basic authorization username and password
@@ -462,7 +468,7 @@ function makeDirectRequest(network, request) {
 }
 
 // Save a resource from a request, skipping it if specific paramters are not met
-async function saveResponseResource(network, request) {
+async function saveResponseResource(network, request, session) {
   let {
     disableCache,
     allowedHostnames,
@@ -514,7 +520,8 @@ async function saveResponseResource(network, request) {
       // so request them directly.
       if (mimeType !== null && mimeType !== void 0 && mimeType.includes('font') || detectedMime && detectedMime.includes('font')) {
         log.debug('- Requesting asset directly', meta);
-        body = await makeDirectRequest(network, request);
+        body = await makeDirectRequest(network, request, session);
+        log.debug('- Got direct response', meta);
       }
       resource = createResource(url, body, mimeType, {
         status: response.status,
@@ -533,6 +540,7 @@ async function saveResponseResource(network, request) {
     }
   }
   if (resource && !resource.root) {
+    log.debug('- Saving resource', meta);
     network.intercept.saveResource(resource);
   }
 }

package/dist/page.js

@@ -17,7 +17,7 @@ export class Page {
     session.on('Runtime.executionContextDestroyed', this._handleExecutionContextDestroyed);
     session.on('Runtime.executionContextsCleared', this._handleExecutionContextsCleared);
     session.send('Runtime.enable').catch(session._handleClosedError);
-    this.log.debug('Page created');
+    this.log.debug('Page created', this.meta);
   }
 
   // Close the page
@@ -33,7 +33,7 @@ export class Page {
     deviceScaleFactor = 1,
     mobile = false
   }) {
-    this.log.debug(`Resize page to ${width}x${height} @${deviceScaleFactor}x`);
+    this.log.debug(`Resize page to ${width}x${height} @${deviceScaleFactor}x`, this.meta);
     await this.session.send('Emulation.setDeviceMetricsOverride', {
       deviceScaleFactor,
       mobile,

package/dist/percy.js

@@ -383,12 +383,12 @@ export class Percy {
 
   // Uploads one or more snapshots directly to the current Percy build
   upload(options, callback = null, screenshotFlow = null) {
+    var _options$tag2;
     if (this.readyState !== 1) {
       throw new Error('Not running');
     } else if (Array.isArray(options)) {
       return yieldAll(options.map(o => this.yield.upload(o)));
     }
-
     // validate comparison uploads and warn about any errors
 
     // we are having two similar attrs in options: tags & tag
@@ -416,6 +416,15 @@ export class Percy {
       }
     }
 
+    // set meta for logging
+    options.meta = {
+      snapshot: {
+        name: options.name,
+        testCase: options.testCase,
+        tag: (_options$tag2 = options.tag) === null || _options$tag2 === void 0 ? void 0 : _options$tag2.name
+      }
+    };
+
     // add client & environment info
     this.client.addClientInfo(options.clientInfo);
     this.client.addEnvironmentInfo(options.environmentInfo);
@@ -555,7 +564,7 @@ function _displaySuggestionLogs(suggestions, options = {}) {
     const suggestion = item === null || item === void 0 ? void 0 : item.suggestion;
     const referenceDocLinks = item === null || item === void 0 ? void 0 : item.reference_doc_link;
     if (options !== null && options !== void 0 && options.snapshotLevel) {
-      this.log.warn(`Detected erorr for Snapshot: ${options === null || options === void 0 ? void 0 : options.snapshotName}`);
+      this.log.warn(`Detected error for Snapshot: ${options === null || options === void 0 ? void 0 : options.snapshotName}`);
     } else {
       this.log.warn('Detected error for percy build');
     }

package/dist/snapshot.js

@@ -465,7 +465,7 @@ export function createSnapshotsQueue(percy) {
     // Pushing to syncQueue, that will check for
     // snapshot processing status, and will resolve once done
     if (snapshot.sync) {
-      percy.log.info(`Waiting for snapshot '${name}' to be completed`);
+      percy.log.info(`Waiting for snapshot '${name}' to be completed`, meta);
       const data = new JobData(response.data.id, null, snapshot.resolve, snapshot.reject);
       percy.syncQueue.push(data);
     }
@@ -501,7 +501,7 @@ export function createSnapshotsQueue(percy) {
     if (duplicate) {
       if (process.env.PERCY_IGNORE_DUPLICATES !== 'true') {
         let errMsg = `Ignored duplicate snapshot. ${errors[1].detail}`;
-        percy.log.warn(errMsg);
+        percy.log.warn(errMsg, meta);
         await percy.suggestionsForFix(errMsg, {
           snapshotLevel: true,
           snapshotName: name

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.30.0",
+  "version": "1.30.2-alpha.0",
   "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.30.0",
-    "@percy/config": "1.30.0",
-    "@percy/dom": "1.30.0",
-    "@percy/logger": "1.30.0",
-    "@percy/webdriver-utils": "1.30.0",
+    "@percy/client": "1.30.2-alpha.0",
+    "@percy/config": "1.30.2-alpha.0",
+    "@percy/dom": "1.30.2-alpha.0",
+    "@percy/logger": "1.30.2-alpha.0",
+    "@percy/webdriver-utils": "1.30.2-alpha.0",
     "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": "0f9c627b5100eaf4d7262c6671764ffb38d23d33"
+  "gitHead": "5cf337161a28fe90a670b009f2d2149663734047"
 }

package/test/helpers/server.js

@@ -21,7 +21,7 @@ export function createTestServer({ default: defaultReply, ...replies }, port = 8
   server.route(async (req, res, next) => {
     let pathname = req.url.pathname;
     if (req.url.search) pathname += req.url.search;
-    server.requests.push(req.body ? [pathname, req.body] : [pathname]);
+    server.requests.push(req.body ? [pathname, req.body, req.headers] : [pathname, req.headers]);
     let reply = replies[pathname] || defaultReply;
     return reply ? await reply(req, res) : next();
   });