@percy/core 1.28.3 → 1.28.4-alpha.0

package/dist/discovery.js

@@ -3,6 +3,7 @@ import Queue from './queue.js';
 import { normalizeURL, hostnameMatches, createResource, createRootResource, createPercyCSSResource, createLogResource, yieldAll, snapshotLogName, withRetries } 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) {
@@ -312,6 +313,7 @@ export function createDiscoveryQueue(percy) {
     concurrency
   } = percy.config.discovery;
   let queue = new Queue('discovery');
+  let timeit = new TimeIt();
   let cache;
   return queue.set({
     concurrency
@@ -342,54 +344,56 @@ export function createDiscoveryQueue(percy) {
   })
   // discovery resources for snapshots and call the callback for each discovered snapshot
   .handle('task', async function* (snapshot, callback) {
-    percy.log.debug(`Discovering resources: ${snapshot.name}`, snapshot.meta);
+    await timeit.measure('asset-discovery', snapshot.name, 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}`);
-    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);
+      // 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}`);
+      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,
+            captureForDevices: percy.deviceDetails || []
+          });
+        } finally {
+          // always close the page when done
+          await page.close();
         }
+      }, {
+        count: snapshot.discovery.retry ? 3 : 1,
+        onRetry: () => {
+          percy.log.info(`Retrying snapshot: ${snapshotLogName(snapshot.name, snapshot.meta)}`, snapshot.meta);
+        },
+        signal: snapshot._ctrl.signal,
+        throwOn: ['AbortError']
       });
-      try {
-        yield* captureSnapshotResources(page, snapshot, {
-          captureWidths: !snapshot.domSnapshot && percy.deferUploads,
-          capture: callback,
-          captureForDevices: percy.deviceDetails || []
-        });
-      } finally {
-        // always close the page when done
-        await page.close();
-      }
-    }, {
-      count: snapshot.discovery.retry ? 3 : 1,
-      onRetry: () => {
-        percy.log.info(`Retrying snapshot: ${snapshotLogName(snapshot.name, snapshot.meta)}`, snapshot.meta);
-      },
-      signal: snapshot._ctrl.signal,
-      throwOn: ['AbortError']
     });
   }).handle('error', ({
     name,

package/dist/percy.js

@@ -2,10 +2,11 @@ import PercyClient from '@percy/client';
 import PercyConfig from '@percy/config';
 import logger from '@percy/logger';
 import Browser from './browser.js';
+import Pako from 'pako';
+import { base64encode, generatePromise, yieldAll, yieldTo, redactSecrets } from './utils.js';
 import { createPercyServer, createStaticServer } from './api.js';
 import { gatherSnapshots, createSnapshotsQueue, validateSnapshotOptions } from './snapshot.js';
 import { discoverSnapshotResources, createDiscoveryQueue } from './discovery.js';
-import { generatePromise, yieldAll, yieldTo } from './utils.js';
 import { WaitForJob } from './wait-for-job.js';
 
 // A Percy instance will create a new build when started, handle snapshot creation, asset discovery,
@@ -146,6 +147,9 @@ export class Percy {
     this.readyState = 0;
     try {
       var _this$build;
+      if (process.env.PERCY_CLIENT_ERROR_LOGS !== 'false') {
+        this.log.warn('Notice: Percy collects CI logs for service improvement, stored for 30 days. Opt-out anytime with export PERCY_CLIENT_ERROR_LOGS=false');
+      }
       // start the snapshots queue immediately when not delayed or deferred
       if (!this.delayUploads && !this.deferUploads) yield this.#snapshots.start();
       // do not start the discovery queue when not needed
@@ -206,54 +210,61 @@ export class Percy {
   // Stops the local API server and closes the browser and internal queues once snapshots have
   // completed. Does nothing if not running. When `force` is true, any queued snapshots are cleared.
   async *stop(force) {
-    var _this$server3;
     // not started, but the browser was launched
-    if (!this.readyState && this.browser.isConnected()) {
-      await this.browser.close();
-    }
-    if (this.syncQueue) this.syncQueue.stop();
-    // not started or already stopped
-    if (!this.readyState || this.readyState > 2) return;
-
-    // close queues asap
-    if (force) {
-      this.#discovery.close(true);
-      this.#snapshots.close(true);
-    }
+    try {
+      var _this$server3;
+      if (!this.readyState && this.browser.isConnected()) {
+        await this.browser.close();
+      }
+      if (this.syncQueue) this.syncQueue.stop();
+      // not started or already stopped
+      if (!this.readyState || this.readyState > 2) return;
+
+      // close queues asap
+      if (force) {
+        this.#discovery.close(true);
+        this.#snapshots.close(true);
+      }
 
-    // already stopping
-    if (this.readyState === 2) return;
-    this.readyState = 2;
+      // already stopping
+      if (this.readyState === 2) return;
+      this.readyState = 2;
 
-    // log when force stopping
-    if (force) this.log.info('Stopping percy...');
+      // log when force stopping
+      if (force) this.log.info('Stopping percy...');
 
-    // used to log snapshot count information
-    let info = (state, size) => `${state} ` + `${size} snapshot${size !== 1 ? 's' : ''}`;
-    try {
-      // flush discovery and snapshot queues
-      yield* this.yield.flush((state, size) => {
-        this.log.progress(`${info(state, size)}...`, !!size);
-      });
-    } catch (error) {
-      // reset ready state when aborted
-      /* istanbul ignore else: all errors bubble */
-      if (error.name === 'AbortError') this.readyState = 1;
-      throw error;
-    }
+      // used to log snapshot count information
+      let info = (state, size) => `${state} ` + `${size} snapshot${size !== 1 ? 's' : ''}`;
+      try {
+        // flush discovery and snapshot queues
+        yield* this.yield.flush((state, size) => {
+          this.log.progress(`${info(state, size)}...`, !!size);
+        });
+      } catch (error) {
+        // reset ready state when aborted
+        /* istanbul ignore else: all errors bubble */
+        if (error.name === 'AbortError') this.readyState = 1;
+        throw error;
+      }
 
-    // if dry-running, log the total number of snapshots
-    if (this.dryRun && this.#snapshots.size) {
-      this.log.info(info('Found', this.#snapshots.size));
-    }
+      // if dry-running, log the total number of snapshots
+      if (this.dryRun && this.#snapshots.size) {
+        this.log.info(info('Found', this.#snapshots.size));
+      }
 
-    // close server and end queues
-    await ((_this$server3 = this.server) === null || _this$server3 === void 0 ? void 0 : _this$server3.close());
-    await this.#discovery.end();
-    await this.#snapshots.end();
+      // close server and end queues
+      await ((_this$server3 = this.server) === null || _this$server3 === void 0 ? void 0 : _this$server3.close());
+      await this.#discovery.end();
+      await this.#snapshots.end();
 
-    // mark instance as stopped
-    this.readyState = 3;
+      // mark instance as stopped
+      this.readyState = 3;
+    } catch (err) {
+      this.log.error(err);
+      throw err;
+    } finally {
+      await this.sendBuildLogs();
+    }
   }
 
   // Takes one or more snapshots of a page while discovering resources to upload with the resulting
@@ -412,5 +423,34 @@ export class Percy {
     if (syncMode) options.sync = syncMode;
     return syncMode;
   }
+  async sendBuildLogs() {
+    if (!process.env.PERCY_TOKEN) return;
+    try {
+      var _this$build3, _this$build4, _this$build5, _this$build6;
+      const logsObject = {
+        clilogs: logger.query(() => true)
+      };
+      // Only add CI logs if not disabled voluntarily.
+      const sendCILogs = process.env.PERCY_CLIENT_ERROR_LOGS !== 'false';
+      if (sendCILogs) {
+        const redactedContent = redactSecrets(logger.query(() => true, true));
+        logsObject.cilogs = redactedContent;
+      }
+      const content = base64encode(Pako.gzip(JSON.stringify(logsObject)));
+      const referenceId = (_this$build3 = this.build) !== null && _this$build3 !== void 0 && _this$build3.id ? `build_${(_this$build4 = this.build) === null || _this$build4 === void 0 ? void 0 : _this$build4.id}` : (_this$build5 = this.build) === null || _this$build5 === void 0 ? void 0 : _this$build5.id;
+      const eventObject = {
+        content: content,
+        build_id: (_this$build6 = this.build) === null || _this$build6 === void 0 ? void 0 : _this$build6.id,
+        reference_id: referenceId,
+        service_name: 'cli',
+        base64encoded: true
+      };
+      // Ignore this will update once I implement logs controller.
+      const logsSHA = await this.client.sendBuildLogs(eventObject);
+      this.log.info(`Build's CLI${sendCILogs ? ' and CI' : ''} logs sent successfully. Please share this log ID with Percy team in case of any issues - ${logsSHA}`);
+    } catch (err) {
+      this.log.warn('Could not send the builds logs');
+    }
+  }
 }
 export default Percy;