Change freezeAnimation -> freezeAnimatedImage (#1382)

* Change freezeAnimation -> freezeAnimatedImage * Support backward compatibility for freezeAnimation
percy · Sep 27, 2023 · 0eeeb9a · 0eeeb9a
1 parent 19d8767
commit 0eeeb9a
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 6 deletions.
diff --git a/packages/core/src/config.js b/packages/core/src/config.js
@@ -50,10 +50,33 @@ export const configSchema = {
       scope: {
         type: 'string'
       },
-      freezeAnimation: {
+      freezeAnimation: { // for backward compatibility
         type: 'boolean',
         onlyAutomate: true
       },
+      freezeAnimatedImage: {
+        type: 'boolean',
+        onlyAutomate: true
+      },
+      freezeAnimatedImageOptions: {
+        type: 'object',
+        additionalProperties: false,
+        onlyAutomate: true,
+        properties: {
+          freezeImageBySelectors: {
+            type: 'array',
+            items: {
+              type: 'string'
+            }
+          },
+          freezeImageByXpaths: {
+            type: 'array',
+            items: {
+              type: 'string'
+            }
+          }
+        }
+      },
       ignoreRegions: {
         type: 'object',
         additionalProperties: false,

diff --git a/packages/core/src/utils.js b/packages/core/src/utils.js
@@ -42,7 +42,9 @@ export function percyAutomateRequestHandler(req, percy) {
 
   req.body.options = merge([{
     percyCSS: percy.config.snapshot.percyCSS,
-    freezeAnimation: percy.config.snapshot.freezeAnimation,
+    freezeAnimatedImage: percy.config.snapshot.freezeAnimatedImage || percy.config.snapshot.freezeAnimation,
+    freezeImageBySelectors: percy.config.snapshot.freezeAnimatedImageOptions?.freezeImageBySelectors,
+    freezeImageByXpaths: percy.config.snapshot.freezeAnimatedImageOptions?.freezeImageByXpaths,
     ignoreRegionSelectors: percy.config.snapshot.ignoreRegions?.ignoreRegionSelectors,
     ignoreRegionXpaths: percy.config.snapshot.ignoreRegions?.ignoreRegionXpaths,
     considerRegionSelectors: percy.config.snapshot.considerRegions?.considerRegionSelectors,

diff --git a/packages/core/test/api.test.js b/packages/core/test/api.test.js
@@ -275,7 +275,8 @@ describe('API Server', () => {
     await percy.start();
 
     percy.config.snapshot.percyCSS = '.global { color: blue }';
-    percy.config.snapshot.freezeAnimation = false;
+    percy.config.snapshot.freezeAnimatedImage = false;
+    percy.config.snapshot.freezeAnimatedImageOptions = { freezeImageByXpaths: ['/xpath-global'] };
     percy.config.snapshot.ignoreRegions = { ignoreRegionSelectors: ['.selector-global'] };
     percy.config.snapshot.considerRegions = { considerRegionXpaths: ['/xpath-global'] };
 
@@ -286,7 +287,8 @@ describe('API Server', () => {
         environment_info: 'environment',
         options: {
           percyCSS: '.percy-screenshot: { color: red }',
-          freeze_animation: true,
+          freeze_animated_image: true,
+          freezeImageBySelectors: ['.selector-per-screenshot'],
           ignore_region_xpaths: ['/xpath-per-screenshot'],
           consider_region_xpaths: ['/xpath-per-screenshot']
         }
@@ -299,7 +301,9 @@ describe('API Server', () => {
       environmentInfo: 'environment',
       buildInfo: { id: '123', url: 'https://percy.io/test/test/123', number: 1 },
       options: {
-        freezeAnimation: true,
+        freezeAnimatedImage: true,
+        freezeImageBySelectors: ['.selector-per-screenshot'],
+        freezeImageByXpaths: ['/xpath-global'],
         percyCSS: '.global { color: blue }\n.percy-screenshot: { color: red }',
         ignoreRegionSelectors: ['.selector-global'],
         ignoreRegionXpaths: ['/xpath-per-screenshot'],

diff --git a/packages/webdriver-utils/src/providers/genericProvider.js b/packages/webdriver-utils/src/providers/genericProvider.js
@@ -39,7 +39,7 @@ export default class GenericProvider {
   }
 
   addDefaultOptions() {
-    this.options.freezeAnimation = this.options.freezeAnimation || false;
+    this.options.freezeAnimation = this.options.freezeAnimatedImage || this.options.freezeAnimation || false;
   }
 
   async createDriver() {