@percy/client 1.30.0 → 1.30.1

package/dist/client.js

@@ -105,21 +105,33 @@ export class PercyClient {
   }
 
   // Performs a GET request for an API endpoint with appropriate headers.
-  get(path) {
-    return request(`${this.apiUrl}/${path}`, {
-      headers: this.headers(),
-      method: 'GET'
+  // we create a copy of meta as we update it in request and we wont want those updates
+  // to go back to caller - should be only limited to current function
+  get(path, {
+    ...meta
+  } = {}) {
+    return logger.measure('client:get', meta.identifier, meta, () => {
+      return request(`${this.apiUrl}/${path}`, {
+        headers: this.headers(),
+        method: 'GET',
+        meta
+      });
     });
   }
 
   // Performs a POST request to a JSON API endpoint with appropriate headers.
-  post(path, body = {}) {
-    return request(`${this.apiUrl}/${path}`, {
-      headers: this.headers({
-        'Content-Type': 'application/vnd.api+json'
-      }),
-      method: 'POST',
-      body
+  post(path, body = {}, {
+    ...meta
+  } = {}) {
+    return logger.measure('client:post', meta.identifier || 'Unknown', meta, () => {
+      return request(`${this.apiUrl}/${path}`, {
+        headers: this.headers({
+          'Content-Type': 'application/vnd.api+json'
+        }),
+        method: 'POST',
+        body,
+        meta
+      });
     });
   }
 
@@ -185,7 +197,9 @@ export class PercyClient {
     validateId('build', buildId);
     let qs = all ? 'all-shards=true' : '';
     this.log.debug(`Finalizing build ${buildId}...`);
-    return this.post(`builds/${buildId}/finalize?${qs}`);
+    return this.post(`builds/${buildId}/finalize?${qs}`, {}, {
+      identifier: 'build.finalze'
+    });
   }
 
   // Retrieves build data by id. Requires a read access token.
@@ -327,7 +341,7 @@ export class PercyClient {
     sha,
     filepath,
     content
-  } = {}) {
+  } = {}, meta = {}) {
     validateId('build', buildId);
     if (filepath) {
       content = await fs.promises.readFile(filepath);
@@ -336,8 +350,8 @@ export class PercyClient {
       }
     }
     let encodedContent = base64encode(content);
-    this.log.debug(`Uploading ${formatBytes(encodedContent.length)} resource: ${url}...`);
-    this.mayBeLogUploadSize(encodedContent.length);
+    this.log.debug(`Uploading ${formatBytes(encodedContent.length)} resource: ${url}`, meta);
+    this.mayBeLogUploadSize(encodedContent.length, meta);
     return this.post(`builds/${buildId}/resources`, {
       data: {
         type: 'resources',
@@ -346,16 +360,25 @@ export class PercyClient {
           'base64-content': encodedContent
         }
       }
+    }, {
+      identifier: 'resource.post',
+      ...meta
     });
   }
 
   // Uploads resources to the active build concurrently, two at a time.
-  async uploadResources(buildId, resources) {
+  async uploadResources(buildId, resources, meta = {}) {
     validateId('build', buildId);
-    this.log.debug(`Uploading resources for ${buildId}...`);
+    this.log.debug(`Uploading resources for ${buildId}...`, meta);
     return pool(function* () {
       for (let resource of resources) {
-        yield this.uploadResource(buildId, resource);
+        let resourceMeta = {
+          url: resource.url,
+          sha: resource.sha,
+          ...meta
+        };
+        yield this.uploadResource(buildId, resource, resourceMeta);
+        this.log.debug(`Uploaded resource ${resource.url}`, resourceMeta);
       }
     }, this, 2);
   }
@@ -375,20 +398,22 @@ export class PercyClient {
     testCase,
     labels,
     thTestCaseExecutionId,
-    resources = []
+    resources = [],
+    meta
   } = {}) {
     validateId('build', buildId);
     this.addClientInfo(clientInfo);
     this.addEnvironmentInfo(environmentInfo);
     if (!this.clientInfo.size || !this.environmentInfo.size) {
-      this.log.warn('Warning: Missing `clientInfo` and/or `environmentInfo` properties');
+      this.log.warn('Warning: Missing `clientInfo` and/or `environmentInfo` properties', meta);
     }
     let tagsArr = tagsList(labels);
-    this.log.debug(`Creating snapshot: ${name}...`);
+    this.log.debug(`Validating resources: ${name}...`, meta);
     for (let resource of resources) {
       if (resource.sha || resource.content || !resource.filepath) continue;
       resource.content = await fs.promises.readFile(resource.filepath);
     }
+    this.log.debug(`Creating snapshot: ${name}...`, meta);
     return this.post(`builds/${buildId}/snapshots`, {
       data: {
         type: 'snapshots',
@@ -420,31 +445,44 @@ export class PercyClient {
           }
         }
       }
+    }, {
+      identifier: 'snapshot.post',
+      ...meta
     });
   }
 
   // Finalizes a snapshot.
-  async finalizeSnapshot(snapshotId) {
+  async finalizeSnapshot(snapshotId, meta = {}) {
     validateId('snapshot', snapshotId);
-    this.log.debug(`Finalizing snapshot ${snapshotId}...`);
-    return this.post(`snapshots/${snapshotId}/finalize`);
+    this.log.debug(`Finalizing snapshot ${snapshotId}...`, meta);
+    return this.post(`snapshots/${snapshotId}/finalize`, {}, {
+      identifier: 'snapshot.finalze',
+      ...meta
+    });
   }
 
   // Convenience method for creating a snapshot for the active build, uploading
   // missing resources for the snapshot, and finalizing the snapshot.
   async sendSnapshot(buildId, options) {
     var _snapshot$data$relati;
+    let {
+      meta = {}
+    } = options;
     let snapshot = await this.createSnapshot(buildId, options);
+    meta.snapshotId = snapshot.data.id;
     let missing = (_snapshot$data$relati = snapshot.data.relationships) === null || _snapshot$data$relati === void 0 || (_snapshot$data$relati = _snapshot$data$relati['missing-resources']) === null || _snapshot$data$relati === void 0 ? void 0 : _snapshot$data$relati.data;
+    this.log.debug(`${(missing === null || missing === void 0 ? void 0 : missing.length) || 0} Missing resources: ${options.name}...`, meta);
     if (missing !== null && missing !== void 0 && missing.length) {
       let resources = options.resources.reduce((acc, r) => Object.assign(acc, {
         [r.sha]: r
       }), {});
       await this.uploadResources(buildId, missing.map(({
         id
-      }) => resources[id]));
+      }) => resources[id]), meta);
     }
-    await this.finalizeSnapshot(snapshot.data.id);
+    this.log.debug(`Resources uploaded: ${options.name}...`, meta);
+    await this.finalizeSnapshot(snapshot.data.id, meta);
+    this.log.debug(`Finalized snapshot: ${options.name}...`, meta);
     return snapshot;
   }
   async createComparison(snapshotId, {
@@ -455,11 +493,12 @@ export class PercyClient {
     domInfoSha,
     consideredElementsData,
     metadata,
-    sync
+    sync,
+    meta = {}
   } = {}) {
     validateId('snapshot', snapshotId);
     // Remove post percy api deploy
-    this.log.debug(`Creating comparision: ${tag.name}...`);
+    this.log.debug(`Creating comparision: ${tag.name}...`, meta);
     for (let tile of tiles) {
       if (tile.sha) continue;
       if (tile.content && typeof tile.content === 'string') {
@@ -469,6 +508,7 @@ export class PercyClient {
         tile.content = await fs.promises.readFile(tile.filepath);
       }
     }
+    this.log.debug(`${tiles.length} tiles for comparision: ${tag.name}...`, meta);
     return this.post(`snapshots/${snapshotId}/comparisons`, {
       data: {
         type: 'comparisons',
@@ -512,6 +552,9 @@ export class PercyClient {
           }
         }
       }
+    }, {
+      identifier: 'comparison.post',
+      ...meta
     });
   }
   async uploadComparisonTile(comparisonId, {
@@ -520,14 +563,14 @@ export class PercyClient {
     filepath,
     content,
     sha
-  } = {}) {
+  } = {}, meta = {}) {
     validateId('comparison', comparisonId);
     if (sha) {
       return await this.verify(comparisonId, sha);
     }
     if (filepath && !content) content = await fs.promises.readFile(filepath);
     let encodedContent = base64encode(content);
-    this.log.debug(`Uploading ${formatBytes(encodedContent.length)} comparison tile: ${index + 1}/${total} (${comparisonId})...`);
+    this.log.debug(`Uploading ${formatBytes(encodedContent.length)} comparison tile: ${index + 1}/${total} (${comparisonId})...`, meta);
     this.mayBeLogUploadSize(encodedContent.length);
     return this.post(`comparisons/${comparisonId}/tiles`, {
       data: {
@@ -537,6 +580,9 @@ export class PercyClient {
           index
         }
       }
+    }, {
+      identifier: 'comparison.tile.post',
+      ...meta
     });
   }
 
@@ -559,9 +605,9 @@ export class PercyClient {
     }
     return true;
   }
-  async verifyComparisonTile(comparisonId, sha) {
+  async verifyComparisonTile(comparisonId, sha, meta = {}) {
     validateId('comparison', comparisonId);
-    this.log.debug(`Verifying comparison tile with sha: ${sha}`);
+    this.log.debug(`Verifying comparison tile with sha: ${sha}`, meta);
     try {
       return await this.post(`comparisons/${comparisonId}/tiles/verify`, {
         data: {
@@ -570,6 +616,9 @@ export class PercyClient {
             sha: sha
           }
         }
+      }, {
+        identifier: 'comparison.tile.verify',
+        ...meta
       });
     } catch (error) {
       this.log.error(error);
@@ -592,46 +641,63 @@ export class PercyClient {
       }
     }, this, 2);
   }
-  async finalizeComparison(comparisonId) {
+  async finalizeComparison(comparisonId, meta = {}) {
     validateId('comparison', comparisonId);
     this.log.debug(`Finalizing comparison ${comparisonId}...`);
-    return this.post(`comparisons/${comparisonId}/finalize`);
+    return this.post(`comparisons/${comparisonId}/finalize`, {}, {
+      identifier: 'comparison.finalize',
+      ...meta
+    });
   }
   async sendComparison(buildId, options) {
+    let {
+      meta
+    } = options;
     if (!validateTiles(options.tiles)) {
       throw new Error('sha, filepath or content should be present in tiles object');
     }
     let snapshot = await this.createSnapshot(buildId, options);
     let comparison = await this.createComparison(snapshot.data.id, options);
     await this.uploadComparisonTiles(comparison.data.id, options.tiles);
+    this.log.debug(`Created comparison: ${comparison.data.id} ${options.tag.name}`, meta);
     await this.finalizeComparison(comparison.data.id);
+    this.log.debug(`Finalized comparison: ${comparison.data.id} ${options.tag.name}`, meta);
     return comparison;
   }
-  async sendBuildEvents(buildId, body) {
+  async sendBuildEvents(buildId, body, meta = {}) {
     validateId('build', buildId);
     this.log.debug('Sending Build Events');
     return this.post(`builds/${buildId}/send-events`, {
       data: body
+    }, {
+      identifier: 'build.send_events',
+      ...meta
     });
   }
-  async sendBuildLogs(body) {
-    this.log.debug('Sending Build Logs');
+  async sendBuildLogs(body, meta = {}) {
+    this.log.debug('Sending Build Logs', meta);
     return this.post('logs', {
       data: body
+    }, {
+      identifier: 'build.send_logs',
+      ...meta
     });
   }
-  async getErrorAnalysis(errors) {
+  async getErrorAnalysis(errors, meta = {}) {
     const errorLogs = formatLogErrors(errors);
-    this.log.debug('Sending error logs for analysis');
+    this.log.debug('Sending error logs for analysis', meta);
     return this.post('suggestions/from_logs', {
       data: errorLogs
+    }, {
+      identifier: 'error.analysis.get',
+      ...meta
     });
   }
-  mayBeLogUploadSize(contentSize) {
+  mayBeLogUploadSize(contentSize, meta = {}) {
     if (contentSize >= 25 * 1024 * 1024) {
-      this.log.error('Uploading resource above 25MB might fail the build...');
+      this.log.error('Uploading resource above 25MB might fail the build...', meta);
     } else if (contentSize >= 20 * 1024 * 1024) {
-      this.log.warn('Uploading resource above 20MB might slow the build...');
+      this.log.warn('Uploading resource above 20MB might slow the build...', meta);
     }
   }
 

package/dist/utils.js

@@ -128,6 +128,7 @@ export async function request(url, options = {}, callback) {
     interval,
     noProxy,
     buffer,
+    meta = {},
     ...requestOptions
   } = options;
   let {
@@ -169,9 +170,17 @@ export async function request(url, options = {}, callback) {
     let handleError = error => {
       if (handleError.handled) return;
       handleError.handled = true;
+      const response = error.response;
+      meta.responseCode = error.code;
+      meta.errorCount = (meta.errorCount || 0) + 1;
+      if (response) {
+        meta.responseCode = response.statusCode;
+        meta.xRequestId = response.headers['x-request-id'];
+        meta.cfRay = response.headers['cf-ray'];
+      }
 
       // maybe retry 404s, always retry 500s, or retry specific errors
-      let shouldRetry = error.response ? retryNotFound && error.response.statusCode === 404 || error.response.statusCode >= 500 && error.response.statusCode < 600 : !!error.code && RETRY_ERROR_CODES.includes(error.code);
+      let shouldRetry = response ? retryNotFound && response.statusCode === 404 || response.statusCode >= 500 && response.statusCode < 600 : !!error.code && RETRY_ERROR_CODES.includes(error.code);
       return shouldRetry ? retry(error) : reject(error);
     };
     let handleFinished = async (body, res) => {
@@ -183,6 +192,9 @@ export async function request(url, options = {}, callback) {
 
       // only return a buffer when requested
       if (buffer !== true) body = raw;
+      meta.responseCode = statusCode;
+      meta.xRequestId = headers['x-request-id'];
+      meta.cfRay = headers['cf-ray'];
 
       // attempt to parse the body as json
       try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/client",
-  "version": "1.30.0",
+  "version": "1.30.1",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -33,9 +33,9 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/env": "1.30.0",
-    "@percy/logger": "1.30.0",
+    "@percy/env": "1.30.1",
+    "@percy/logger": "1.30.1",
     "pako": "^2.1.0"
   },
-  "gitHead": "0f9c627b5100eaf4d7262c6671764ffb38d23d33"
+  "gitHead": "2f8fc42f57c3989de0c5ceca207854d8f66272d3"
 }