@percy/client 1.31.0-alpha.3 → 1.31.1-beta.0

package/dist/client.js

@@ -3,13 +3,13 @@ import PercyEnv from '@percy/env';
 import { git } from '@percy/env/utils';
 import logger from '@percy/logger';
 import Pako from 'pako';
-import { pool, request, formatBytes, sha256hash, base64encode, getPackageJSON, waitForTimeout, validateTiles, formatLogErrors, tagsList } from './utils.js';
+import { pool, request, formatBytes, sha256hash, base64encode, getPackageJSON, waitForTimeout, validateTiles, formatLogErrors, tagsList, normalizeBrowsers } from './utils.js';
 
 // Default client API URL can be set with an env var for API development
 const {
   PERCY_CLIENT_API_URL = 'https://percy.io/api/v1'
 } = process.env;
-const pkg = getPackageJSON(import.meta.url);
+let pkg = getPackageJSON(import.meta.url);
 // minimum polling interval milliseconds
 const MIN_POLLING_INTERVAL = 1_000;
 const INVALID_TOKEN_ERROR_MESSAGE = 'Unable to retrieve snapshot details with write access token. Kindly use a full access token for retrieving snapshot details with Synchronous CLI.';
@@ -21,6 +21,25 @@ function validateId(type, id) {
     throw new Error(`Invalid ${type} ID`);
   }
 }
+function makeRegions(regions, algorithm, algorithmConfiguration) {
+  let regionObj;
+  if (algorithm) {
+    regionObj = {};
+    regionObj.algorithm = algorithm;
+    regionObj.configuration = algorithmConfiguration;
+  }
+  if (!Array.isArray(regions) && !regionObj) return null;
+  if (regionObj) {
+    regions || (regions = []);
+    regions.push(regionObj);
+  }
+  return regions.map(region => ({
+    ...region,
+    elementSelector: region.elementSelector || {
+      fullpage: true
+    }
+  }));
+}
 
 // Validate project path arguments
 function validateProjectPath(path) {
@@ -77,6 +96,9 @@ export class PercyClient {
 
   // Stringifies client and environment info.
   userAgent() {
+    // forcedPkgValue has been added since when percy package is bundled inside Electron app (LCNC)
+    // we can't read Percy's package json for package name and version, so we are passing it via env variables
+    if (this.env.forcedPkgValue) pkg = this.env.forcedPkgValue;
     let client = new Set([`Percy/${/\w+$/.exec(this.apiUrl)}`].concat(`${pkg.name}/${pkg.version}`, ...this.clientInfo).filter(Boolean));
     let environment = new Set([...this.environmentInfo].concat(`node/${process.version}`, this.env.info).filter(Boolean));
     return `${[...client].join(' ')} (${[...environment].join('; ')})`;
@@ -146,7 +168,9 @@ export class PercyClient {
     var _this$config$percy2;
     this.log.debug('Creating a new build...');
     let source = 'user_created';
-    if (process.env.PERCY_AUTO_ENABLED_GROUP_BUILD === 'true') {
+    if (process.env.PERCY_ORIGINATED_SOURCE) {
+      source = 'bstack_sdk_created';
+    } else if (process.env.PERCY_AUTO_ENABLED_GROUP_BUILD === 'true') {
       source = 'auto_enabled_group';
     }
     let tagsArr = tagsList(this.labels);
@@ -172,7 +196,8 @@ export class PercyClient {
           tags: tagsArr,
           'cli-start-time': cliStartTime,
           source: source,
-          'skip-base-build': (_this$config$percy2 = this.config.percy) === null || _this$config$percy2 === void 0 ? void 0 : _this$config$percy2.skipBaseBuild
+          'skip-base-build': (_this$config$percy2 = this.config.percy) === null || _this$config$percy2 === void 0 ? void 0 : _this$config$percy2.skipBaseBuild,
+          'testhub-build-uuid': this.env.testhubBuildUuid
         },
         relationships: {
           resources: {
@@ -380,8 +405,10 @@ export class PercyClient {
           sha: resource.sha,
           ...meta
         };
-        yield this.uploadResource(buildId, resource, resourceMeta);
-        this.log.debug(`Uploaded resource ${resource.url}`, resourceMeta);
+        yield this.uploadResource(buildId, resource, resourceMeta).then(result => {
+          this.log.debug(`Uploaded resource ${resource.url}`, resourceMeta);
+          return result;
+        });
       }
     }, this, uploadConcurrency);
   }
@@ -401,6 +428,10 @@ export class PercyClient {
     testCase,
     labels,
     thTestCaseExecutionId,
+    browsers,
+    regions,
+    algorithm,
+    algorithmConfiguration,
     resources = [],
     meta
   } = {}) {
@@ -411,6 +442,7 @@ export class PercyClient {
       this.log.warn('Warning: Missing `clientInfo` and/or `environmentInfo` properties', meta);
     }
     let tagsArr = tagsList(labels);
+    let regionsArr = makeRegions(regions, algorithm, algorithmConfiguration);
     this.log.debug(`Validating resources: ${name}...`, meta);
     for (let resource of resources) {
       if (resource.sha || resource.content || !resource.filepath) continue;
@@ -428,10 +460,12 @@ export class PercyClient {
           'test-case': testCase || null,
           tags: tagsArr,
           'scope-options': scopeOptions || {},
+          regions: regionsArr || null,
           'minimum-height': minHeight || null,
           'enable-javascript': enableJavaScript || null,
           'enable-layout': enableLayout || false,
-          'th-test-case-execution-id': thTestCaseExecutionId || null
+          'th-test-case-execution-id': thTestCaseExecutionId || null,
+          browsers: normalizeBrowsers(browsers) || null
         },
         relationships: {
           resources: {
@@ -497,6 +531,9 @@ export class PercyClient {
     consideredElementsData,
     metadata,
     sync,
+    regions,
+    algorithm,
+    algorithmConfiguration,
     meta = {}
   } = {}) {
     validateId('snapshot', snapshotId);
@@ -511,6 +548,7 @@ export class PercyClient {
         tile.content = await fs.promises.readFile(tile.filepath);
       }
     }
+    let regionsArr = makeRegions(regions, algorithm, algorithmConfiguration);
     this.log.debug(`${tiles.length} tiles for comparision: ${tag.name}...`, meta);
     return this.post(`snapshots/${snapshotId}/comparisons`, {
       data: {
@@ -518,6 +556,7 @@ export class PercyClient {
         attributes: {
           'external-debug-url': externalDebugUrl || null,
           'ignore-elements-data': ignoredElementsData || null,
+          regions: regionsArr || null,
           'consider-elements-data': consideredElementsData || null,
           'dom-info-sha': domInfoSha || null,
           sync: !!sync,
@@ -719,6 +758,8 @@ export class PercyClient {
         return 'generic';
       case 'vmw':
         return 'visual_scanner';
+      case 'res':
+        return 'responsive_scanner';
       default:
         return 'web';
     }

package/dist/proxy.js

@@ -4,9 +4,26 @@ import http from 'http';
 import https from 'https';
 import logger from '@percy/logger';
 import { stripQuotesAndSpaces } from '@percy/env/utils';
+import { PacProxyAgent } from 'pac-proxy-agent';
 const CRLF = '\r\n';
 const STATUS_REG = /^HTTP\/1.[01] (\d*)/;
 
+// function to create PAC proxy agent
+export function createPacAgent(pacUrl, options = {}) {
+  pacUrl = stripQuotesAndSpaces(pacUrl);
+  try {
+    const agent = new PacProxyAgent(pacUrl, {
+      keepAlive: true,
+      ...options
+    });
+    logger('client:proxy').info(`Successfully loaded PAC file from: ${pacUrl}`);
+    return agent;
+  } catch (error) {
+    logger('client:proxy').error(`Failed to load PAC file, error message: ${error.message},  stack: ${error.stack}`);
+    throw new Error(`Failed to initialize PAC proxy: ${error.message}`);
+  }
+}
+
 // Returns true if the URL hostname matches any patterns
 export function hostnameMatches(patterns, url) {
   let subject = new URL(url);
@@ -196,8 +213,29 @@ export function proxyAgentFor(url, options) {
     hostname
   } = new URL(url);
   let cachekey = `${protocol}//${hostname}`;
-  if (!cache.has(cachekey)) {
-    cache.set(cachekey, protocol === 'https:' ? new ProxyHttpsAgent(options) : new ProxyHttpAgent(options));
+
+  // If we already have a cached agent, return it
+  if (cache.has(cachekey)) {
+    return cache.get(cachekey);
+  }
+  try {
+    let agent;
+    const pacUrl = process.env.PERCY_PAC_FILE_URL;
+
+    // If PAC URL is provided, use PAC proxy
+    if (pacUrl) {
+      logger('client:proxy').info(`Using PAC file from: ${pacUrl}`);
+      agent = createPacAgent(pacUrl, options);
+    } else {
+      // Fall back to other proxy configuration
+      agent = protocol === 'https:' ? new ProxyHttpsAgent(options) : new ProxyHttpAgent(options);
+    }
+
+    // Cache the created agent
+    cache.set(cachekey, agent);
+    return agent;
+  } catch (error) {
+    logger('client:proxy').error(`Failed to create proxy agent: ${error.message}`);
+    throw error;
   }
-  return cache.get(cachekey);
 }

package/dist/utils.js

@@ -4,6 +4,7 @@ import url from 'url';
 import path from 'path';
 import crypto from 'crypto';
 import logger from '@percy/logger';
+import { snakecase } from '@percy/config/utils';
 
 // Formats a raw byte integer as a string
 export function formatBytes(int) {
@@ -141,9 +142,11 @@ export async function request(url, options = {}, callback) {
   } = new URL(url);
 
   // reference the default export so tests can mock it
+  // bundling cli inside electron or another package fails if we import it
+  // like this: await import(protocol === 'https:' ? 'https' : 'http');
   let {
     default: http
-  } = await import(protocol === 'https:' ? 'https' : 'http');
+  } = protocol === 'https:' ? await import('https') : await import('http');
   let {
     proxyAgentFor
   } = await import('./proxy.js');
@@ -278,4 +281,8 @@ export function tagsList(tags) {
   }
   return tagsArr;
 }
+export function normalizeBrowsers(browserValues) {
+  if (!browserValues) return null;
+  return browserValues.map(browser => snakecase(browser));
+}
 export { hostnameMatches, getProxy, ProxyHttpAgent, ProxyHttpsAgent, proxyAgentFor } from './proxy.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/client",
-  "version": "1.31.0-alpha.3",
+  "version": "1.31.1-beta.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "alpha"
+    "tag": "beta"
   },
   "engines": {
     "node": ">=14"
@@ -33,9 +33,10 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/env": "1.31.0-alpha.3",
-    "@percy/logger": "1.31.0-alpha.3",
+    "@percy/env": "1.31.1-beta.0",
+    "@percy/logger": "1.31.1-beta.0",
+    "pac-proxy-agent": "^7.0.2",
     "pako": "^2.1.0"
   },
-  "gitHead": "14ae0b4319c1c2ae28729d56cba3b159e80386a8"
+  "gitHead": "0bd4ee85db05f5adb8376d1ef09627c04cff5fb1"
 }