Added PERCY_FORCE_PKG_VALUE in env file and using from there (#1800)

* Added PERCY_FORCE_PKG_VALUE in place of PERCY_FORCE_DIRNAME * Bumped the percy tag to 1.30.3-alpha.4 * Added PERCY_FORCE_PKG_VALUE in env file and using from there * Bumped the percy tag to 1.30.3-alpha.5 * fixed linting
percy · Nov 27, 2024 · b996f30 · b996f30
1 parent c524e28
commit b996f30
Show file tree

Hide file tree

Showing 21 changed files with 75 additions and 53 deletions.
diff --git a/lerna.json b/lerna.json
@@ -1,5 +1,5 @@
 {
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "packages": [
     "packages/*"
   ],

diff --git a/packages/cli-app/package.json b/packages/cli-app/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-app",
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -33,7 +33,7 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.30.3-alpha.4",
-    "@percy/cli-exec": "1.30.3-alpha.4"
+    "@percy/cli-command": "1.30.3-alpha.5",
+    "@percy/cli-exec": "1.30.3-alpha.5"
   }
 }
diff --git a/packages/cli-build/package.json b/packages/cli-build/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-build",
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -33,6 +33,6 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.30.3-alpha.4"
+    "@percy/cli-command": "1.30.3-alpha.5"
   }
 }
diff --git a/packages/cli-command/package.json b/packages/cli-command/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-command",
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -36,8 +36,8 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/config": "1.30.3-alpha.4",
-    "@percy/core": "1.30.3-alpha.4",
-    "@percy/logger": "1.30.3-alpha.4"
+    "@percy/config": "1.30.3-alpha.5",
+    "@percy/core": "1.30.3-alpha.5",
+    "@percy/logger": "1.30.3-alpha.5"
   }
 }
diff --git a/packages/cli-config/package.json b/packages/cli-config/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-config",
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -33,6 +33,6 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.30.3-alpha.4"
+    "@percy/cli-command": "1.30.3-alpha.5"
   }
 }
diff --git a/packages/cli-exec/package.json b/packages/cli-exec/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-exec",
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -33,8 +33,8 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.30.3-alpha.4",
-    "@percy/logger": "1.30.3-alpha.4",
+    "@percy/cli-command": "1.30.3-alpha.5",
+    "@percy/logger": "1.30.3-alpha.5",
     "cross-spawn": "^7.0.3",
     "which": "^2.0.2"
   }

diff --git a/packages/cli-snapshot/package.json b/packages/cli-snapshot/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-snapshot",
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -33,7 +33,7 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.30.3-alpha.4",
+    "@percy/cli-command": "1.30.3-alpha.5",
     "yaml": "^2.0.0"
   }
 }
diff --git a/packages/cli-upload/package.json b/packages/cli-upload/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-upload",
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -33,7 +33,7 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.30.3-alpha.4",
+    "@percy/cli-command": "1.30.3-alpha.5",
     "fast-glob": "^3.2.11",
     "image-size": "^1.0.0"
   }

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli",
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -31,14 +31,14 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/cli-app": "1.30.3-alpha.4",
-    "@percy/cli-build": "1.30.3-alpha.4",
-    "@percy/cli-command": "1.30.3-alpha.4",
-    "@percy/cli-config": "1.30.3-alpha.4",
-    "@percy/cli-exec": "1.30.3-alpha.4",
-    "@percy/cli-snapshot": "1.30.3-alpha.4",
-    "@percy/cli-upload": "1.30.3-alpha.4",
-    "@percy/client": "1.30.3-alpha.4",
-    "@percy/logger": "1.30.3-alpha.4"
+    "@percy/cli-app": "1.30.3-alpha.5",
+    "@percy/cli-build": "1.30.3-alpha.5",
+    "@percy/cli-command": "1.30.3-alpha.5",
+    "@percy/cli-config": "1.30.3-alpha.5",
+    "@percy/cli-exec": "1.30.3-alpha.5",
+    "@percy/cli-snapshot": "1.30.3-alpha.5",
+    "@percy/cli-upload": "1.30.3-alpha.5",
+    "@percy/client": "1.30.3-alpha.5",
+    "@percy/logger": "1.30.3-alpha.5"
   }
 }
diff --git a/packages/client/package.json b/packages/client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/client",
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -33,8 +33,8 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/env": "1.30.3-alpha.4",
-    "@percy/logger": "1.30.3-alpha.4",
+    "@percy/env": "1.30.3-alpha.5",
+    "@percy/logger": "1.30.3-alpha.5",
     "pac-proxy-agent": "^7.0.2",
     "pako": "^2.1.0"
   }

diff --git a/packages/client/src/client.js b/packages/client/src/client.js
@@ -19,7 +19,7 @@ import {
 
 // 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.';
@@ -83,6 +83,8 @@ export class PercyClient {
 
   // Stringifies client and environment info.
   userAgent() {
+    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));

diff --git a/packages/client/src/utils.js b/packages/client/src/utils.js
@@ -38,7 +38,7 @@ export function waitForTimeout() {
 // Returns the package.json content at the package path.
 export function getPackageJSON(rel) {
   /* istanbul ignore else: sanity check */
-  if (process.env.PERCY_FORCE_PKG_VALUE) return JSON.parse(process.env.PERCY_FORCE_PKG_VALUE);
+  if (rel.startsWith('file:')) rel = url.fileURLToPath(rel);
 
   /* istanbul ignore else: sanity check */
   if (rel.startsWith('file:')) rel = url.fileURLToPath(rel);

diff --git a/packages/config/package.json b/packages/config/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/config",
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -38,7 +38,7 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/logger": "1.30.3-alpha.4",
+    "@percy/logger": "1.30.3-alpha.5",
     "ajv": "^8.6.2",
     "cosmiconfig": "^8.0.0",
     "yaml": "^2.0.0"

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -43,11 +43,11 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/client": "1.30.3-alpha.4",
-    "@percy/config": "1.30.3-alpha.4",
-    "@percy/dom": "1.30.3-alpha.4",
-    "@percy/logger": "1.30.3-alpha.4",
-    "@percy/webdriver-utils": "1.30.3-alpha.4",
+    "@percy/client": "1.30.3-alpha.5",
+    "@percy/config": "1.30.3-alpha.5",
+    "@percy/dom": "1.30.3-alpha.5",
+    "@percy/logger": "1.30.3-alpha.5",
+    "@percy/webdriver-utils": "1.30.3-alpha.5",
     "content-disposition": "^0.5.4",
     "cross-spawn": "^7.0.3",
     "extract-zip": "^2.0.1",

diff --git a/packages/core/src/api.js b/packages/core/src/api.js
@@ -12,10 +12,23 @@ import { handleSyncJob } from './snapshot.js';
 // This change ensures better compatibility and avoids relying on Node.js-specific APIs that might cause issues in ESM environments.
 import { fileURLToPath } from 'url';
 
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
+const getPercyDomPath = () => {
+  try {
+    const { createRequire } = require('module');
+    return createRequire(import.meta.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');
+};
 
-export const PERCY_DOM = resolve(__dirname, 'node_modules/@percy/dom');
+// Resolved path for PERCY_DOM
+export const PERCY_DOM = getPercyDomPath();
 
 // Returns a URL encoded string of nested query params
 function encodeURLSearchParams(subj, prefix) {

diff --git a/packages/dom/package.json b/packages/dom/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/dom",
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "license": "MIT",
   "repository": {
     "type": "git",

diff --git a/packages/env/package.json b/packages/env/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/env",
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -32,6 +32,6 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/logger": "1.30.3-alpha.4"
+    "@percy/logger": "1.30.3-alpha.5"
   }
 }
diff --git a/packages/env/src/environment.js b/packages/env/src/environment.js
@@ -290,6 +290,13 @@ export class PercyEnv {
   get token() {
     return this.vars.PERCY_TOKEN || null;
   }
+
+  // PERCY_FORCE_PKG_VALUE for forcing package.json values
+  // to be used as the current environment values in client
+  get forcedPkgValue() {
+    let pkg = this.vars.PERCY_FORCE_PKG_VALUE;
+    return JSON.parse(pkg) || null;
+  }
 }
 
 // cache getters on initial call so subsequent calls are not re-computed

diff --git a/packages/logger/package.json b/packages/logger/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/logger",
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "license": "MIT",
   "repository": {
     "type": "git",

diff --git a/packages/sdk-utils/package.json b/packages/sdk-utils/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/sdk-utils",
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "license": "MIT",
   "repository": {
     "type": "git",

diff --git a/packages/webdriver-utils/package.json b/packages/webdriver-utils/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/webdriver-utils",
-  "version": "1.30.3-alpha.4",
+  "version": "1.30.3-alpha.5",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -29,7 +29,7 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/config": "1.30.3-alpha.4",
-    "@percy/sdk-utils": "1.30.3-alpha.4"
+    "@percy/config": "1.30.3-alpha.5",
+    "@percy/sdk-utils": "1.30.3-alpha.5"
   }
 }