@percy/core 1.30.0 → 1.30.1

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) {
@@ -419,7 +418,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 +451,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/network.js

@@ -515,6 +515,7 @@ async function saveResponseResource(network, request) {
       if (mimeType !== null && mimeType !== void 0 && mimeType.includes('font') || detectedMime && detectedMime.includes('font')) {
         log.debug('- Requesting asset directly', meta);
         body = await makeDirectRequest(network, request);
+        log.debug('- Got direct response', meta);
       }
       resource = createResource(url, body, mimeType, {
         status: response.status,
@@ -533,6 +534,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.1",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -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.1",
+    "@percy/config": "1.30.1",
+    "@percy/dom": "1.30.1",
+    "@percy/logger": "1.30.1",
+    "@percy/webdriver-utils": "1.30.1",
     "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": "2f8fc42f57c3989de0c5ceca207854d8f66272d3"
 }

package/dist/timing.js

@@ -1,21 +0,0 @@
-import logger from '@percy/logger';
-export default class TimeIt {
-  log = logger('timer');
-  // returns a singleton instance
-  constructor() {
-    let {
-      instance = this
-    } = this.constructor;
-    this.constructor.instance = instance;
-    return instance;
-  }
-  async measure(name, identifier, callback) {
-    const startTime = Date.now();
-    try {
-      return await callback();
-    } finally {
-      const duration = Date.now() - startTime;
-      this.log.debug(`${name} - ${identifier} - ${duration / 1000}s`);
-    }
-  }
-}