@percy/core 1.31.2-beta.0 → 1.31.2-beta.2

package/README.md

@@ -56,12 +56,12 @@ The following options can also be defined within a Percy config file
   - `userAgent` — Custom user-agent string used when requesting assets
   - `cookies` — Browser cookies to use when requesting assets
   - `networkIdleTimeout` — Milliseconds to wait for the network to idle (**default** `100`)
-  - `concurrency` — Asset discovery concerrency (**default** `5`)
+  - `concurrency` — Asset discovery concurrency (**default** `5`)
   - `launchOptions` — Asset discovery browser launch options
     - `executable` — Browser executable path (**default** `process.env.PERCY_BROWSER_EXECUTABLE`)
     - `timeout` — Discovery launch timeout, in milliseconds (**default** `30000`)
     - `args` — Additional browser process arguments
-    - `headless` — Runs the browser headlessy (**default** `true`)
+    - `headless` — Runs the browser headlessly (**default** `true`)
     
 Additional Percy config file options are also allowed and will override any options defined by a
 local config file. These config file options are also made available to SDKs via the local API
@@ -282,7 +282,7 @@ environment variable.
 
 - Vist https://chromiumdash.appspot.com/releases?platform=Mac and check for current version in use.
 - Get Branch Base Position for that release.
-- Visit https://commondatastorage.googleapis.com/chromium-browser-snapshots/index.html?prefix=Mac/ and search for exact/neareast Branch Base Position.
+- Visit https://commondatastorage.googleapis.com/chromium-browser-snapshots/index.html?prefix=Mac/ and search for exact/nearest Branch Base Position.
 
 ### Excerpt
 

package/dist/api.js

@@ -54,7 +54,7 @@ export function createPercyServer(percy, port) {
       res.setHeader('X-Percy-Core-Version', ((_percy$testing2 = percy.testing) === null || _percy$testing2 === void 0 ? void 0 : _percy$testing2.version) ?? pkg.version);
     }
 
-    // track all api reqeusts in testing mode
+    // track all api requests in testing mode
     if (percy.testing && !req.url.pathname.startsWith('/test/')) {
       var _percy$testing3;
       ((_percy$testing3 = percy.testing).requests || (_percy$testing3.requests = [])).push({
@@ -119,7 +119,7 @@ export function createPercyServer(percy, port) {
     logger('core:server').deprecated(['It looks like you’re using @percy/cli with an older SDK.', 'Please upgrade to the latest version to fix this warning.', 'See these docs for more info: https://www.browserstack.com/docs/percy/migration/migrate-to-cli'].join(' '));
     let content = await fs.promises.readFile(PERCY_DOM, 'utf-8');
     let wrapper = '(window.PercyAgent = class { snapshot(n, o) { return PercyDOM.serialize(o); } });';
-    return res.send(200, 'applicaton/javascript', content.concat(wrapper));
+    return res.send(200, 'application/javascript', content.concat(wrapper));
   })
   // post one or more snapshots, optionally async
   .route('post', '/percy/snapshot', async (req, res) => {

package/dist/discovery.js

@@ -259,7 +259,7 @@ async function* captureSnapshotResources(page, snapshot, options) {
   let cookies = ((_snapshot$domSnapshot = snapshot.domSnapshot) === null || _snapshot$domSnapshot === void 0 ? void 0 : _snapshot$domSnapshot.cookies) || ((_snapshot$domSnapshot2 = snapshot.domSnapshot) === null || _snapshot$domSnapshot2 === void 0 || (_snapshot$domSnapshot2 = _snapshot$domSnapshot2[0]) === null || _snapshot$domSnapshot2 === void 0 ? void 0 : _snapshot$domSnapshot2.cookies);
   cookies = parseCookies(cookies);
 
-  // iterate over device to trigger reqeusts and capture other dpr width
+  // iterate over device to trigger requests and capture other dpr width
   async function* captureResponsiveAssets() {
     for (const device of captureForDevices) {
       discovery = {
@@ -354,7 +354,7 @@ async function* captureSnapshotResources(page, snapshot, options) {
     } = snap;
     let [width] = widths;
 
-    // iterate over widths to trigger reqeusts and capture other widths
+    // iterate over widths to trigger requests and capture other widths
     if (isBaseSnapshot || captureWidths) {
       for (let i = 0; i < widths.length - 1; i++) {
         if (captureWidths) yield* takeSnapshot(snap, width);

package/dist/install.js

@@ -6,7 +6,7 @@ import logger from '@percy/logger';
 import cp from 'child_process';
 import { ProxyHttpsAgent, formatBytes } from '@percy/client/utils';
 
-// Formats milleseconds as "MM:SS"
+// Formats milliseconds as "MM:SS"
 function formatTime(ms) {
   let minutes = (ms / 1000 / 60).toString().split('.')[0].padStart(2, '0');
   let seconds = (ms / 1000 % 60).toFixed().padStart(2, '0');

package/dist/network.js

@@ -289,10 +289,10 @@ export class Network {
       response
     } = event;
     // await on requestWillBeSent
-    // no explicitly wait on requestWillBePaused as we implictly wait on it, since it manipulates the lifeCycle of request using Fetch module
+    // no explicitly wait on requestWillBePaused as we implicitly wait on it, since it manipulates the lifeCycle of request using Fetch module
     await this.#requestsLifeCycleHandler.get(requestId).requestWillBeSent;
     let request = this.#requests.get(requestId);
-    /* istanbul ignore if: race condition paranioa */
+    /* istanbul ignore if: race condition paranoia */
     if (!request) return;
     request.response = response;
     request.response.buffer = async () => {
@@ -314,7 +314,7 @@ export class Network {
     // wait for request to be sent
     await this.#requestsLifeCycleHandler.get(requestId).requestWillBeSent;
     let request = this.#requests.get(requestId);
-    /* istanbul ignore else: race condition paranioa */
+    /* istanbul ignore else: race condition paranoia */
     if (request) this._forgetRequest(request);
   };
 
@@ -327,7 +327,7 @@ export class Network {
     // wait for upto 2 seconds or check if response has been sent
     await this.#requestsLifeCycleHandler.get(requestId).responseReceived;
     let request = this.#requests.get(requestId);
-    /* istanbul ignore if: race condition paranioa */
+    /* istanbul ignore if: race condition paranoia */
     if (!request) return;
     await saveResponseResource(this, request, session);
     this._forgetRequest(request);
@@ -344,7 +344,7 @@ export class Network {
     // and in any case, order of processing for responseReceived and loadingFailed does not matter, as response capturing is done in loadingFinished
     await this.#requestsLifeCycleHandler.get(requestId).requestWillBeSent;
     let request = this.#requests.get(event.requestId);
-    /* istanbul ignore if: race condition paranioa */
+    /* istanbul ignore if: race condition paranoia */
     if (!request) return;
 
     // If request was aborted, keep track of it as we need to cancel any in process callbacks for
@@ -489,7 +489,7 @@ async function makeDirectRequest(network, request, session) {
   });
 }
 
-// Save a resource from a request, skipping it if specific paramters are not met
+// Save a resource from a request, skipping it if specific parameters are not met
 async function saveResponseResource(network, request, session) {
   var _response$headers;
   let {
@@ -505,7 +505,7 @@ async function saveResponseResource(network, request, session) {
     url,
     responseStatus: response === null || response === void 0 ? void 0 : response.status
   };
-  // Checing for content length more than 100MB, to prevent websocket error which is governed by
+  // Checking for content length more than 100MB, to prevent websocket error which is governed by
   // maxPayload option of websocket defaulted to 100MB.
   // If content-length is more than our allowed 25MB, no need to process that resouce we can return log.
   let contentLength = (_response$headers = response.headers) === null || _response$headers === void 0 ? void 0 : _response$headers[Object.keys(response.headers).find(key => key.toLowerCase() === 'content-length')];

package/dist/percy.js

@@ -13,7 +13,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, detectSystemProxyAndLog } from './utils.js';
+import { base64encode, generatePromise, yieldAll, yieldTo, redactSecrets, detectSystemProxyAndLog, checkSDKVersion } from './utils.js';
 import { createPercyServer, createStaticServer } from './api.js';
 import { gatherSnapshots, createSnapshotsQueue, validateSnapshotOptions } from './snapshot.js';
 import { discoverSnapshotResources, createDiscoveryQueue } from './discovery.js';
@@ -113,6 +113,7 @@ export class Percy {
     // if there is none, stop it
     this.resetMonitoringId = null;
     this.monitoringCheckLastExecutedAt = null;
+    this.sdkInfoDisplayed = false;
 
     // generator methods are wrapped to autorun and return promises
     for (let m of ['start', 'stop', 'flush', 'idle', 'snapshot', 'upload']) {
@@ -212,7 +213,7 @@ export class Percy {
       if (process.env.PERCY_CLIENT_ERROR_LOGS !== 'false') {
         this.log.warn('Notice: Percy collects CI logs to improve service and enhance your experience. These logs help us debug issues and provide insights on your dashboards, making it easier to optimize the product experience. Logs are stored securely for 30 days. You can opt out anytime with export PERCY_CLIENT_ERROR_LOGS=false, but keeping this enabled helps us offer the best support and features.');
       }
-      // Not awaiting proxy check as this can be asyncronous when not enabled
+      // Not awaiting proxy check as this can be asynchronous 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
@@ -372,7 +373,7 @@ export class Percy {
     if (cpuInfo.currentUsagePercent >= 80 || memoryUsageInfo.currentUsagePercent >= 80) {
       let currentConcurrent = _classPrivateFieldGet(_discovery, this).concurrency;
 
-      // concurrency must be betweeen [1, (default/user defined value)]
+      // concurrency must be between [1, (default/user defined value)]
       let newConcurrency = Math.max(1, parseInt(currentConcurrent / 2));
       newConcurrency = Math.min(this.discoveryMaxConcurrency, newConcurrency);
       this.log.debug(`Downscaling discovery browser concurrency from ${_classPrivateFieldGet(_discovery, this).concurrency} to ${newConcurrency}`);
@@ -383,7 +384,7 @@ export class Percy {
       let currentConcurrent = _classPrivateFieldGet(_discovery, this).concurrency;
       let newConcurrency = currentConcurrent + 2;
 
-      // concurrency must be betweeen [1, (default/user-defined value)]
+      // concurrency must be between [1, (default/user-defined value)]
       newConcurrency = Math.min(this.discoveryMaxConcurrency, newConcurrency);
       newConcurrency = Math.max(1, newConcurrency);
       this.log.debug(`Upscaling discovery browser concurrency from ${_classPrivateFieldGet(_discovery, this).concurrency} to ${newConcurrency}`);
@@ -429,10 +430,15 @@ export class Percy {
       throw new Error('Cannot capture DOM snapshots when asset discovery is disabled');
     }
 
-    // return an async generator to allow cancelation
+    // return an async generator to allow cancellation
     return async function* () {
       let server;
       try {
+        // Check SDK version
+        if (!this.sdkInfoDisplayed && options.clientInfo) {
+          await checkSDKVersion(options.clientInfo);
+          this.sdkInfoDisplayed = true;
+        }
         if ('serve' in options) {
           // create and start a static server
           let {
@@ -533,7 +539,7 @@ export class Percy {
       });
     }
 
-    // return an async generator to allow cancelation
+    // return an async generator to allow cancellation
     return async function* () {
       try {
         return yield* yieldTo(_classPrivateFieldGet(_snapshots, this).push(options));
@@ -615,7 +621,7 @@ export class Percy {
         // This can be due to proxy issue
         this.log.error('percy.io might not be reachable, check network connection, proxy and ensure that percy.io is whitelisted.');
         if (!_assertClassBrand(_Percy_brand, this, _proxyEnabled).call(this)) {
-          this.log.error('If inside a proxied envirnment, please configure the following environment variables: HTTP_PROXY, [ and optionally HTTPS_PROXY if you need it ]. Refer to our documentation for more details');
+          this.log.error('If inside a proxied environment, please configure the following environment variables: HTTP_PROXY, [ and optionally HTTPS_PROXY if you need it ]. Refer to our documentation for more details');
         }
       }
       this.log.error('Unable to analyze error logs');

package/dist/queue.js

@@ -211,7 +211,7 @@ export class Queue {
 
   // processes tasks using a generator promise, allowing task handlers to be cancelable
 
-  // returns a generator that yeilds until started and no longer pending, calling the
+  // returns a generator that yields until started and no longer pending, calling the
   // callback every 10ms during checks with the current number of pending tasks
   idle(callback) {
     return yieldFor(() => {

package/dist/snapshot.js

@@ -19,7 +19,7 @@ function validURL(url, base) {
 }
 function validateAndFixSnapshotUrl(snapshot) {
   let log = logger('core:snapshot');
-  // encoding snapshot url, if contians invalid URI characters/syntax
+  // encoding snapshot url, if contains invalid URI characters/syntax
   let modifiedURL = decodeAndEncodeURLWithLogging(snapshot.url, log, {
     meta: {
       snapshot: {
@@ -93,7 +93,7 @@ function mapSnapshotOptions(snapshots, context) {
     exclude,
     ...opts
   }) => snap => next(
-  // assign additional options to included snaphots
+  // assign additional options to included snapshots
   snapshotMatches(snap, include, exclude) ? Object.assign(snap, opts) : snap), snap => getSnapshotOptions(snap, context));
 
   // reduce snapshots with options
@@ -326,7 +326,7 @@ function mergeSnapshotOptions(prev = {}, next) {
     ...incoming
   } = next;
 
-  // prioritize singular widths over mutilple widths
+  // prioritize singular widths over multiple widths
   widths = width ? [width] : widths;
 
   // deduplicate resources by associated widths and url

package/dist/utils.js

@@ -1,5 +1,5 @@
 import EventEmitter from 'events';
-import { sha256hash } from '@percy/client/utils';
+import { sha256hash, request } from '@percy/client/utils';
 import { camelcase, merge } from '@percy/config/utils';
 import YAML from 'yaml';
 import path from 'path';
@@ -576,4 +576,68 @@ export async function* maybeScrollToBottom(page, discovery) {
   if (discovery.scrollToBottom && page.enableJavaScript) {
     yield page.eval('await scrollToBottom()');
   }
+}
+
+// Package to GitHub repo mapping
+const PACKAGE_TO_REPO = {
+  '@percy/selenium-webdriver': 'percy-selenium-js',
+  '@percy/playwright': 'percy-playwright',
+  '@percy/appium-app': 'percy-appium-js',
+  '@percy/storybook': 'percy-storybook',
+  '@percy/ember': 'percy-ember',
+  '@percy/cypress': 'percy-cypress',
+  '@percy/puppeteer': 'percy-puppeteer',
+  '@percy/testcafe': 'percy-testcafe',
+  '@percy/nightwatch': 'percy-nightwatch',
+  'percy-java-selenium': 'percy-selenium-java',
+  'percy-playwright-java': 'percy-playwright-java',
+  'percy-appium-dotnet': 'percy-appium-dotnet',
+  'percy-selenium-dotnet': 'percy-selenium-dotnet',
+  'percy-playwright-dotnet': 'percy-playwright-dotnet',
+  'percy-playwright-python': 'percy-playwright-python',
+  'percy-selenium-python': 'percy-selenium-python',
+  'percy-selenium-ruby': 'percy-selenium-ruby',
+  'percy-capybara': 'percy-capybara'
+};
+
+// Utility function to check SDK version updates
+export async function checkSDKVersion(clientInfo) {
+  const log = logger('core:sdk-version');
+  try {
+    // Split on the last '/' to get package name and version
+    const lastSlashIndex = clientInfo.lastIndexOf('/');
+    if (lastSlashIndex === -1) {
+      log.debug(`Invalid clientInfo format: ${clientInfo}`);
+      return;
+    }
+    const packageName = clientInfo.substring(0, lastSlashIndex);
+    const currentVersion = clientInfo.substring(lastSlashIndex + 1);
+
+    // Get GitHub repo name from mapping
+    const repoName = PACKAGE_TO_REPO[packageName];
+    if (!repoName) {
+      log.debug(`No repo mapping found for package: ${packageName}`);
+      return;
+    }
+
+    // Fetch latest version from GitHub releases
+    const githubData = await request(`https://api.github.com/repos/percy/${repoName}/releases?page=1`, {
+      headers: {
+        'User-Agent': '@percy/cli'
+      },
+      retries: 0
+    });
+    const latestRelease = githubData.find(r => !r.prerelease);
+    if (!latestRelease) {
+      return;
+    }
+    const latestVersion = latestRelease.tag_name.replace(/^v/, ''); // Remove 'v' prefix if present
+
+    log.debug(`[SDK Version Check] Current: ${currentVersion}, Latest: ${latestVersion}`);
+    if (currentVersion !== latestVersion) {
+      log.warn(`[SDK Update Available] ${packageName}: ${currentVersion} -> ${latestVersion}`);
+    }
+  } catch (error) {
+    log.debug('Could not check SDK version', error);
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.31.2-beta.0",
+  "version": "1.31.2-beta.2",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -43,12 +43,12 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/client": "1.31.2-beta.0",
-    "@percy/config": "1.31.2-beta.0",
-    "@percy/dom": "1.31.2-beta.0",
-    "@percy/logger": "1.31.2-beta.0",
-    "@percy/monitoring": "1.31.2-beta.0",
-    "@percy/webdriver-utils": "1.31.2-beta.0",
+    "@percy/client": "1.31.2-beta.2",
+    "@percy/config": "1.31.2-beta.2",
+    "@percy/dom": "1.31.2-beta.2",
+    "@percy/logger": "1.31.2-beta.2",
+    "@percy/monitoring": "1.31.2-beta.2",
+    "@percy/webdriver-utils": "1.31.2-beta.2",
     "content-disposition": "^0.5.4",
     "cross-spawn": "^7.0.3",
     "extract-zip": "^2.0.1",
@@ -61,5 +61,5 @@
     "ws": "^8.17.1",
     "yaml": "^2.4.1"
   },
-  "gitHead": "6d36e464efaa1261bf1f1e7c7302c64cc85eccc7"
+  "gitHead": "3002538e11412bea43ddc5e15da7ce338ff44b4f"
 }