initial commit

percy · Sep 11, 2023 · 1792bac · 1792bac
1 parent b898956
commit 1792bac
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 13 deletions.
diff --git a/packages/core/src/api.js b/packages/core/src/api.js
@@ -117,7 +117,7 @@ export function createPercyServer(percy, port) {
       success: await percy.flush(req.body).then(() => true)
     }))
     .route('post', '/percy/automateScreenshot', async (req, res) => {
-      req = percyAutomateRequestHandler(req, percy.build);
+      req = percyAutomateRequestHandler(req, percy);
       res.json(200, {
         success: await (percy.upload(await new WebdriverUtils(req.body).automateScreenshot())).then(() => true)
       });

diff --git a/packages/core/src/config.js b/packages/core/src/config.js
@@ -49,6 +49,53 @@ export const configSchema = {
       },
       scope: {
         type: 'string'
+      },
+      freezeAnimation: {
+        type: 'boolean',
+        default: false,
+        onlyAutomate: true
+      },
+      ignoreRegions: {
+        type: 'object',
+        additionalProperties: false,
+        onlyAutomate: true,
+        properties: {
+          ignoreRegionSelectors: {
+            type: 'array',
+            default: [],
+            items: {
+              type: 'string'
+            }
+          },
+          ignoreRegionXpaths: {
+            type: 'array',
+            default: [],
+            items: {
+              type: 'string'
+            }
+          }
+        }
+      },
+      considerRegions: {
+        type: 'object',
+        additionalProperties: false,
+        onlyAutomate: true,
+        properties: {
+          considerRegionSelectors: {
+            type: 'array',
+            default: [],
+            items: {
+              type: 'string'
+            }
+          },
+          considerRegionXPaths: {
+            type: 'array',
+            default: [],
+            items: {
+              type: 'string'
+            }
+          }
+        }
       }
     }
   },

diff --git a/packages/core/src/utils.js b/packages/core/src/utils.js
@@ -1,5 +1,6 @@
 import EventEmitter from 'events';
 import { sha256hash } from '@percy/client/utils';
+import { camelcase, merge } from '@percy/config/utils';
 
 export {
   request,
@@ -24,17 +25,32 @@ export function normalizeURL(url) {
 }
 
 // Returns the body for automateScreenshot in structure
-export function percyAutomateRequestHandler(req, buildInfo) {
+export function percyAutomateRequestHandler(req, percy) {
   if (req.body.client_info) {
     req.body.clientInfo = req.body.client_info;
   }
   if (req.body.environment_info) {
     req.body.environmentInfo = req.body.environment_info;
   }
-  if (!req.body.options) {
-    req.body.options = {};
-  }
-  req.body.buildInfo = buildInfo;
+
+  // combines array and overrides global config with per-screenshot config
+  let camelCasedOptions = {};
+  Object.entries(req.body.options || {}).forEach(([key, value]) => {
+    camelCasedOptions[camelcase(key)] = value;
+  });
+
+  req.body.options = merge([{
+    percyCSS: percy.config.snapshot.percyCSS,
+    freezeAnimation: percy.config.snapshot.freezeAnimation,
+    ignoreRegionSelectors: percy.config.snapshot.ignoreRegions.ignoreRegionSelectors,
+    ignoreRegionXpaths: percy.config.snapshot.ignoreRegions.ignoreRegionXpaths,
+    considerRegionSelectors: percy.config.snapshot.considerRegions.considerRegionSelectors,
+    considerRegionXPaths: percy.config.snapshot.considerRegions.considerRegionXPaths
+  },
+  camelCasedOptions
+  ]);
+
+  req.body.buildInfo = percy.build;
   return req;
 }
 

diff --git a/packages/webdriver-utils/src/index.js b/packages/webdriver-utils/src/index.js
@@ -1,6 +1,5 @@
 import ProviderResolver from './providers/providerResolver.js';
 import utils from '@percy/sdk-utils';
-import { camelcase } from '@percy/config/utils';
 
 export default class WebdriverUtils {
   log = utils.logger('webdriver-utils:main');
@@ -21,12 +20,7 @@ export default class WebdriverUtils {
     this.capabilities = capabilities;
     this.sessionCapabilites = sessionCapabilites;
     this.snapshotName = snapshotName;
-    const camelCasedOptions = {};
-    Object.keys(options).forEach((key) => {
-      let newKey = camelcase(key);
-      camelCasedOptions[newKey] = options[key];
-    });
-    this.options = camelCasedOptions;
+    this.options = options;
     this.clientInfo = clientInfo;
     this.environmentInfo = environmentInfo;
     this.buildInfo = buildInfo;