@percy/core 1.30.6 → 1.30.7-beta.1

package/dist/api.js

@@ -1,13 +1,30 @@
 import fs from 'fs';
-import path from 'path';
-import { createRequire } from 'module';
+import path, { dirname, resolve } from 'path';
 import logger from '@percy/logger';
 import { normalize } from '@percy/config/utils';
 import { getPackageJSON, Server, percyAutomateRequestHandler, percyBuildEventHandler } from './utils.js';
 import WebdriverUtils from '@percy/webdriver-utils';
 import { handleSyncJob } from './snapshot.js';
-// need require.resolve until import.meta.resolve can be transpiled
-export const PERCY_DOM = createRequire(import.meta.url).resolve('@percy/dom');
+// Previously, we used `createRequire(import.meta.url).resolve` to resolve the path to the module.
+// This approach relied on `createRequire`, which is Node.js-specific and less compatible with modern ESM (ECMAScript Module) standards.
+// This was leading to hard coded paths when CLI is used as a dependency in another project.
+// Now, we use `fileURLToPath` and `path.resolve` to determine the absolute path in a way that's more aligned with ESM conventions.
+// This change ensures better compatibility and avoids relying on Node.js-specific APIs that might cause issues in ESM environments.
+import { fileURLToPath } from 'url';
+import { createRequire } from 'module';
+export const getPercyDomPath = url => {
+  try {
+    return createRequire(url).resolve('@percy/dom');
+  } catch (error) {
+    logger('core:server').warn(['Failed to resolve @percy/dom path using createRequire.', 'Falling back to using fileURLToPath and path.resolve.'].join(' '));
+  }
+  const __filename = fileURLToPath(import.meta.url);
+  const __dirname = dirname(__filename);
+  return resolve(__dirname, 'node_modules/@percy/dom');
+};
+
+// Resolved path for PERCY_DOM
+export const PERCY_DOM = getPercyDomPath(import.meta.url);
 
 // Returns a URL encoded string of nested query params
 function encodeURLSearchParams(subj, prefix) {

package/dist/discovery.js

@@ -1,7 +1,7 @@
 import logger from '@percy/logger';
 import Queue from './queue.js';
 import Page from './page.js';
-import { normalizeURL, hostnameMatches, createResource, createRootResource, createPercyCSSResource, createLogResource, yieldAll, snapshotLogName, waitForTimeout, withRetries, waitForSelectorInsideBrowser } from './utils.js';
+import { normalizeURL, hostnameMatches, createResource, createRootResource, createPercyCSSResource, createLogResource, yieldAll, snapshotLogName, waitForTimeout, withRetries, waitForSelectorInsideBrowser, isGzipped } from './utils.js';
 import { sha256hash } from '@percy/client/utils';
 import Pako from 'pako';
 
@@ -222,8 +222,12 @@ function processSnapshotResources({
   })));
   if (process.env.PERCY_GZIP) {
     for (let index = 0; index < resources.length; index++) {
-      resources[index].content = Pako.gzip(resources[index].content);
-      resources[index].sha = sha256hash(resources[index].content);
+      const alreadyZipped = isGzipped(resources[index].content);
+      /* istanbul ignore next: very hard to mock true */
+      if (!alreadyZipped) {
+        resources[index].content = Pako.gzip(resources[index].content);
+        resources[index].sha = sha256hash(resources[index].content);
+      }
     }
   }
   return {

package/dist/utils.js

@@ -389,6 +389,20 @@ export function redactSecrets(data) {
 export function base64encode(content) {
   return Buffer.from(content).toString('base64');
 }
+
+// It checks if content is already gzipped or not.
+// We don't want to gzip already gzipped content.
+export function isGzipped(content) {
+  if (!(content instanceof Uint8Array || content instanceof ArrayBuffer)) {
+    return false;
+  }
+
+  // Ensure content is a Uint8Array
+  const data = content instanceof ArrayBuffer ? new Uint8Array(content) : content;
+
+  // Gzip magic number: 0x1f8b
+  return data.length > 2 && data[0] === 0x1f && data[1] === 0x8b;
+}
 const RESERVED_CHARACTERS = {
   '%3A': ':',
   '%23': '#',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.30.6",
+  "version": "1.30.7-beta.1",
   "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.30.6",
-    "@percy/config": "1.30.6",
-    "@percy/dom": "1.30.6",
-    "@percy/logger": "1.30.6",
-    "@percy/webdriver-utils": "1.30.6",
+    "@percy/client": "1.30.7-beta.1",
+    "@percy/config": "1.30.7-beta.1",
+    "@percy/dom": "1.30.7-beta.1",
+    "@percy/logger": "1.30.7-beta.1",
+    "@percy/webdriver-utils": "1.30.7-beta.1",
     "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": "4f08c2841c452d1d445077a8e465641100b712de"
+  "gitHead": "b9a15ba7853ff350b7d7b7c3364700e70ca66643"
 }