@percy/core 1.32.0-beta.3 → 1.32.0-beta.4

package/dist/api.js

@@ -16,6 +16,7 @@ import { Readable } from 'stream';
 // 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';
+import { configSchema } from './config.js';
 export const getPercyDomPath = url => {
   try {
     return createRequire(url).resolve('@percy/dom');
@@ -35,6 +36,57 @@ function encodeURLSearchParams(subj, prefix) {
   return typeof subj === 'object' ? Object.entries(subj).map(([key, value]) => encodeURLSearchParams(value, prefix ? `${prefix}[${key}]` : key)).join('&') : `${prefix}=${encodeURIComponent(subj)}`;
 }
 
+// Walks the config schema and collects dot-paths of any fields marked `httpReadOnly: true`
+// that are present in `body`. Driving this from the schema means new HTTP-blocked fields
+// only need a one-line annotation next to their definition — no list to keep in sync here.
+function findHttpReadOnlyPaths(body, schema, path = '') {
+  if (!body || typeof body !== 'object' || !(schema !== null && schema !== void 0 && schema.properties)) return [];
+  let paths = [];
+  for (let [key, propSchema] of Object.entries(schema.properties)) {
+    if (!Object.prototype.hasOwnProperty.call(body, key)) continue;
+    let childPath = path ? `${path}.${key}` : key;
+    if (propSchema !== null && propSchema !== void 0 && propSchema.httpReadOnly) {
+      paths.push(childPath);
+    } else {
+      paths.push(...findHttpReadOnlyPaths(body[key], propSchema, childPath));
+    }
+  }
+  return paths;
+}
+
+// Top-level configSchema is a map of subschemas keyed by top-level config namespace
+// (`discovery`, `snapshot`, …). Wrap it as a single object schema so the walker can recurse
+// uniformly from the root.
+const ROOT_CONFIG_SCHEMA = {
+  type: 'object',
+  properties: configSchema
+};
+
+// Removes each dot-path's leaf from a deep clone of `body` and logs a warning per path.
+// Returns the original `body` unchanged when `paths` is empty so we don't pay for a clone
+// on every config request. Exported for unit testing: the `?.` chain in the reduce is a
+// defensive guard for paths whose ancestor is absent from `body`. Through the production
+// caller (stripBlockedConfigFields → findHttpReadOnlyPaths) every intermediate is verified
+// present, so the guard is unreachable in normal use — but the explicit paths parameter
+// lets a unit test exercise it without contorting the schema.
+export function _applyHttpReadOnlyStripping(body, paths, log) {
+  if (!paths.length) return body;
+  let stripped = JSON.parse(JSON.stringify(body));
+  for (let p of paths) {
+    let parts = p.split('.');
+    let leaf = parts.pop();
+    let parent = parts.reduce((o, k) => o === null || o === void 0 ? void 0 : o[k], stripped);
+    if (parent && typeof parent === 'object') delete parent[leaf];
+    log.warn(`Ignoring \`${p}\` from /percy/config request: this field can only be set via the config file or CLI at startup.`);
+  }
+  return stripped;
+}
+
+// Returns a body with `httpReadOnly` fields removed. Caller guarantees `body` is truthy.
+function stripBlockedConfigFields(body, log) {
+  return _applyHttpReadOnlyStripping(body, findHttpReadOnlyPaths(body, ROOT_CONFIG_SCHEMA), log);
+}
+
 // Parse PNG IHDR chunk for the screenshot's actual rendered dimensions.
 // Returns { width, height } when the buffer is a valid PNG with non-zero
 // dimensions, or null otherwise (non-PNG signature, truncated file, zero
@@ -297,10 +349,13 @@ export function createPercyServer(percy, port) {
     });
   })
   // get or set config options
-  .route(['get', 'post'], '/percy/config', async (req, res) => res.json(200, {
-    config: req.body ? percy.set(req.body) : percy.config,
-    success: true
-  }))
+  .route(['get', 'post'], '/percy/config', async (req, res) => {
+    let body = req.body && stripBlockedConfigFields(req.body, logger('core:server'));
+    return res.json(200, {
+      config: body ? percy.set(body) : percy.config,
+      success: true
+    });
+  })
   // responds once idle (may take a long time)
   .route('get', '/percy/idle', async (req, res) => res.json(200, {
     success: await percy.idle().then(() => true)

package/dist/config.js

@@ -597,8 +597,12 @@ export const configSchema = {
         type: 'object',
         additionalProperties: false,
         properties: {
+          // httpReadOnly: never settable over /percy/config — accepting these would let any
+          // local process execute arbitrary code as the Percy user via flags like
+          // --renderer-cmd-prefix / --gpu-launcher. Must be set via static config or CLI.
           executable: {
-            type: 'string'
+            type: 'string',
+            httpReadOnly: true
           },
           timeout: {
             type: 'integer'
@@ -607,7 +611,8 @@ export const configSchema = {
             type: 'array',
             items: {
               type: 'string'
-            }
+            },
+            httpReadOnly: true
           },
           headless: {
             type: 'boolean'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.32.0-beta.3",
+  "version": "1.32.0-beta.4",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -46,12 +46,12 @@
   "dependencies": {
     "@grpc/grpc-js": "^1.14.3",
     "@grpc/proto-loader": "^0.8.0",
-    "@percy/client": "1.32.0-beta.3",
-    "@percy/config": "1.32.0-beta.3",
-    "@percy/dom": "1.32.0-beta.3",
-    "@percy/logger": "1.32.0-beta.3",
-    "@percy/monitoring": "1.32.0-beta.3",
-    "@percy/webdriver-utils": "1.32.0-beta.3",
+    "@percy/client": "1.32.0-beta.4",
+    "@percy/config": "1.32.0-beta.4",
+    "@percy/dom": "1.32.0-beta.4",
+    "@percy/logger": "1.32.0-beta.4",
+    "@percy/monitoring": "1.32.0-beta.4",
+    "@percy/webdriver-utils": "1.32.0-beta.4",
     "busboy": "^1.6.0",
     "content-disposition": "^0.5.4",
     "cross-spawn": "^7.0.3",
@@ -67,7 +67,7 @@
     "yaml": "^2.4.1"
   },
   "optionalDependencies": {
-    "@percy/cli-doctor": "1.32.0-beta.3"
+    "@percy/cli-doctor": "1.32.0-beta.4"
   },
-  "gitHead": "7244de79269a8dddc4bd7883208bfbe4058fb382"
+  "gitHead": "2e5b1654806b609f961890f1a49fbc4154da1de2"
 }