@percy/client 1.27.6 → 1.27.7

package/dist/client.js

@@ -2,7 +2,7 @@ import fs from 'fs';
 import PercyEnv from '@percy/env';
 import { git } from '@percy/env/utils';
 import logger from '@percy/logger';
-import { pool, request, sha256hash, base64encode, getPackageJSON, waitForTimeout } from './utils.js';
+import { pool, request, formatBytes, sha256hash, base64encode, getPackageJSON, waitForTimeout } from './utils.js';
 
 // Default client API URL can be set with an env var for API development
 const {
@@ -269,14 +269,16 @@ export class PercyClient {
     content
   } = {}) {
     validateId('build', buildId);
-    this.log.debug(`Uploading resource: ${url}...`);
     if (filepath) content = await fs.promises.readFile(filepath);
+    let encodedContent = base64encode(content);
+    this.log.debug(`Uploading ${formatBytes(encodedContent.length)} resource: ${url}...`);
+    this.mayBeLogUploadSize(encodedContent.length);
     return this.post(`builds/${buildId}/resources`, {
       data: {
         type: 'resources',
         id: sha || sha256hash(content),
         attributes: {
-          'base64-content': base64encode(content)
+          'base64-content': encodedContent
         }
       }
     });
@@ -444,16 +446,18 @@ export class PercyClient {
     sha
   } = {}) {
     validateId('comparison', comparisonId);
-    this.log.debug(`Uploading comparison tile: ${index + 1}/${total} (${comparisonId})...`);
-    if (filepath && !content) content = await fs.promises.readFile(filepath);
     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.mayBeLogUploadSize(encodedContent.length);
     return this.post(`comparisons/${comparisonId}/tiles`, {
       data: {
         type: 'tiles',
         attributes: {
-          'base64-content': base64encode(content),
+          'base64-content': encodedContent,
           index
         }
       }
@@ -526,6 +530,13 @@ export class PercyClient {
       data: body
     });
   }
+  mayBeLogUploadSize(contentSize) {
+    if (contentSize >= 25 * 1024 * 1024) {
+      this.log.error('Uploading resource above 25MB might fail the build...');
+    } else if (contentSize >= 20 * 1024 * 1024) {
+      this.log.warn('Uploading resource above 20MB might slow the build...');
+    }
+  }
 
   // decides project type
   tokenType() {

package/dist/utils.js

@@ -4,6 +4,16 @@ import url from 'url';
 import path from 'path';
 import crypto from 'crypto';
 
+// Formats a raw byte integer as a string
+export function formatBytes(int) {
+  let units = ['kB', 'MB', 'GB'];
+  let base = 1024;
+  let u = -1;
+  if (Math.abs(int) < base) return `${int}B`;
+  while (Math.abs(int) >= base && u++ < 2) int /= base;
+  return `${int.toFixed(1)}${units[u]}`;
+}
+
 // Returns a sha256 hash of a string.
 export function sha256hash(content) {
   return crypto.createHash('sha256').update(content, 'utf-8').digest('hex');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/client",
-  "version": "1.27.6",
+  "version": "1.27.7",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -32,8 +32,8 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/env": "1.27.6",
-    "@percy/logger": "1.27.6"
+    "@percy/env": "1.27.7",
+    "@percy/logger": "1.27.7"
   },
-  "gitHead": "4f0f287ba8beec5a7bad9adc3dd91eef98fa0a75"
+  "gitHead": "eba048142b27b317491f15364b34764371fc0670"
 }