@percy/client 1.30.6 → 1.30.7-beta.0

package/dist/client.js

@@ -9,7 +9,7 @@ import { pool, request, formatBytes, sha256hash, base64encode, getPackageJSON, w
 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.';
@@ -77,6 +77,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('; ')})`;

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

@@ -141,9 +141,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');

package/package.json

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