@percy/core 1.29.0 → 1.29.1-beta.0

package/dist/config.js

@@ -7,6 +7,10 @@ export const configSchema = {
       deferUploads: {
         type: 'boolean'
       },
+      useSystemProxy: {
+        type: 'boolean',
+        default: false
+      },
       token: {
         type: 'string'
       },
@@ -584,6 +588,9 @@ export const snapshotSchema = {
                   type: 'string'
                 }
               },
+              cookies: {
+                type: 'string'
+              },
               resources: {
                 type: 'array',
                 items: {

package/dist/network.js

@@ -1,7 +1,7 @@
 import { request as makeRequest } from '@percy/client/utils';
 import logger from '@percy/logger';
 import mime from 'mime-types';
-import { DefaultMap, createResource, hostnameMatches, normalizeURL, waitFor } from './utils.js';
+import { DefaultMap, createResource, decodeAndEncodeURLWithLogging, hostnameMatches, normalizeURL, waitFor } from './utils.js';
 const MAX_RESOURCE_SIZE = 25 * 1024 ** 2; // 25MB
 const ALLOWED_STATUSES = [200, 201, 301, 302, 304, 307, 308];
 const ALLOWED_RESOURCES = ['Document', 'Stylesheet', 'Image', 'Media', 'Font', 'Other'];
@@ -213,6 +213,17 @@ export class Network {
 
     // do not handle data urls
     if (request.url.startsWith('data:')) return;
+
+    // Browsers handle URL encoding leniently, but invalid characters can break tools like Jackproxy.
+    // This code checks for issues such as `%` and leading spaces and warns the user accordingly.
+    decodeAndEncodeURLWithLogging(request.url, this.log, {
+      meta: {
+        ...this.meta,
+        url: request.url
+      },
+      shouldLogWarning: true,
+      warningMessage: `An invalid URL was detected for url: ${request.url} - the snapshot may fail on Percy. Please verify that your asset URL is valid.`
+    });
     if (this.intercept) {
       this.#pending.set(requestId, event);
       if (this.captureMockedServiceWorker) {

package/dist/percy.js

@@ -17,7 +17,7 @@ import logger from '@percy/logger';
 import { getProxy } from '@percy/client/utils';
 import Browser from './browser.js';
 import Pako from 'pako';
-import { base64encode, generatePromise, yieldAll, yieldTo, redactSecrets } from './utils.js';
+import { base64encode, generatePromise, yieldAll, yieldTo, redactSecrets, detectSystemProxyAndLog } from './utils.js';
 import { createPercyServer, createStaticServer } from './api.js';
 import { gatherSnapshots, createSnapshotsQueue, validateSnapshotOptions } from './snapshot.js';
 import { discoverSnapshotResources, createDiscoveryQueue } from './discovery.js';
@@ -179,6 +179,9 @@ export class Percy {
       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');
       }
+      // Not awaiting proxy check as this can be asyncronous when not enabled
+      const detectProxy = detectSystemProxyAndLog(this.config.percy.useSystemProxy);
+      if (this.config.percy.useSystemProxy) await detectProxy;
       // start the snapshots queue immediately when not delayed or deferred
       if (!this.delayUploads && !this.deferUploads) yield _classPrivateFieldGet2(this, _snapshots).start();
       // do not start the discovery queue when not needed

package/dist/snapshot.js

@@ -3,7 +3,7 @@ import PercyConfig from '@percy/config';
 import micromatch from 'micromatch';
 import { configSchema } from './config.js';
 import Queue from './queue.js';
-import { request, hostnameMatches, yieldTo, snapshotLogName } from './utils.js';
+import { request, hostnameMatches, yieldTo, snapshotLogName, decodeAndEncodeURLWithLogging } from './utils.js';
 import { JobData } from './wait-for-job.js';
 
 // Throw a better error message for missing or invalid urls
@@ -17,6 +17,23 @@ function validURL(url, base) {
     throw new Error(`Invalid snapshot URL: ${e.input}`);
   }
 }
+function validateAndFixSnapshotUrl(snapshot) {
+  let log = logger('core:snapshot');
+  // encoding snapshot url, if contians invalid URI characters/syntax
+  let modifiedURL = decodeAndEncodeURLWithLogging(snapshot.url, log, {
+    meta: {
+      snapshot: {
+        name: snapshot.name || snapshot.url
+      }
+    },
+    shouldLogWarning: true,
+    warningMessage: `Invalid URL detected for url: ${snapshot.url} - the snapshot may fail on Percy. Please confirm that your website URL is valid.`
+  });
+  if (modifiedURL !== snapshot.url) {
+    log.debug(`Snapshot URL modified to: ${modifiedURL}`);
+    snapshot.url = modifiedURL;
+  }
+}
 
 // used to deserialize regular expression strings
 const RE_REGEXP = /^\/(.+)\/(\w+)?$/;
@@ -86,9 +103,9 @@ function mapSnapshotOptions(snapshots, context) {
     if (typeof snapshot === 'string') snapshot = {
       url: snapshot
     };
-
-    // normalize the snapshot url and use it for the default name
+    validateAndFixSnapshotUrl(snapshot);
     let url = validURL(snapshot.url, context === null || context === void 0 ? void 0 : context.baseUrl);
+    // normalize the snapshot url and use it for the default name
     (_snapshot = snapshot).name || (_snapshot.name = `${url.pathname}${url.search}${url.hash}`);
     snapshot.url = url.href;
 

package/dist/utils.js

@@ -5,6 +5,8 @@ import YAML from 'yaml';
 import path from 'path';
 import url from 'url';
 import { readFileSync } from 'fs';
+import logger from '@percy/logger';
+import DetectProxy from '@percy/client/detect-proxy';
 export { request, getPackageJSON, hostnameMatches } from '@percy/client/utils';
 export { Server, createServer } from './server.js';
 
@@ -377,6 +379,35 @@ export function redactSecrets(data) {
 export function base64encode(content) {
   return Buffer.from(content).toString('base64');
 }
+
+// This function replaces invalid character that are not the
+// part of valid URI syntax with there correct encoded value.
+// Also, if a character is a part of valid URI syntax, those characters
+// are not encoded
+// Eg: [abc] -> gets encoded to %5Babc%5D
+// ab c -> ab%20c
+export function decodeAndEncodeURLWithLogging(url, logger, options = {}) {
+  // In case the url is partially encoded, then directly using encodeURI()
+  // will encode those characters again. Therefore decodeURI once helps is decoding
+  // partially encoded URL and then after encoding it again, full URL get encoded
+  // correctly.
+  const {
+    meta,
+    shouldLogWarning,
+    warningMessage
+  } = options;
+  try {
+    let decodedURL = decodeURI(url); // This can throw error, so handle it will trycatch
+    let encodedURL = encodeURI(decodedURL);
+    return encodedURL;
+  } catch (error) {
+    logger.debug(error, meta);
+    if (error.name === 'URIError' && shouldLogWarning) {
+      logger.warn(warningMessage);
+    }
+    return url;
+  }
+}
 export function snapshotLogName(name, meta) {
   var _meta$snapshot;
   if (meta !== null && meta !== void 0 && (_meta$snapshot = meta.snapshot) !== null && _meta$snapshot !== void 0 && _meta$snapshot.testCase) {
@@ -384,6 +415,34 @@ export function snapshotLogName(name, meta) {
   }
   return name;
 }
+export async function detectSystemProxyAndLog(applyProxy) {
+  // if proxy is already set no need to check again
+  if (process.env.HTTPS_PROXY || process.env.HTTP_PROXY) return;
+  let proxyPresent = false;
+  const log = logger('core:utils');
+  // Checking proxy shouldn't cause failure
+  try {
+    const detectProxy = new DetectProxy();
+    const proxies = await detectProxy.getSystemProxy();
+    proxyPresent = proxies.length !== 0;
+    if (proxyPresent) {
+      if (applyProxy) {
+        proxies.forEach(proxy => {
+          if (proxy.type === 'HTTPS') {
+            process.env.HTTPS_PROXY = 'https://' + proxy.host + ':' + proxy.port;
+          } else if (proxy.type === 'HTTP') {
+            process.env.HTTP_PROXY = 'http://' + proxy.host + ':' + proxy.port;
+          }
+        });
+      } else {
+        log.warn('We have detected a system level proxy in your system. use HTTP_PROXY or HTTPS_PROXY env vars or To auto apply proxy set useSystemProxy: true under percy in config file');
+      }
+    }
+  } catch (e) {
+    log.debug(`Failed to detect system proxy ${e}`);
+  }
+  return proxyPresent;
+}
 
 // DefaultMap, which returns a default value for an uninitialized key
 // Similar to defaultDict in python

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.29.0",
+  "version": "1.29.1-beta.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "latest"
+    "tag": "beta"
   },
   "engines": {
     "node": ">=14"
@@ -43,11 +43,11 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/client": "1.29.0",
-    "@percy/config": "1.29.0",
-    "@percy/dom": "1.29.0",
-    "@percy/logger": "1.29.0",
-    "@percy/webdriver-utils": "1.29.0",
+    "@percy/client": "1.29.1-beta.0",
+    "@percy/config": "1.29.1-beta.0",
+    "@percy/dom": "1.29.1-beta.0",
+    "@percy/logger": "1.29.1-beta.0",
+    "@percy/webdriver-utils": "1.29.1-beta.0",
     "content-disposition": "^0.5.4",
     "cross-spawn": "^7.0.3",
     "extract-zip": "^2.0.1",
@@ -60,5 +60,5 @@
     "ws": "^8.17.1",
     "yaml": "^2.4.1"
   },
-  "gitHead": "5fed3bcc30798d4447b70ee57ea6331e8ec9b501"
+  "gitHead": "d325b7bbe56764dbde494477d1f4f3bfdc562d6e"
 }