set default diffingMethod to Balanced

saucelabs · Aug 21, 2024 · a3f9d5c · a3f9d5c
1 parent 1b8ae7d
commit a3f9d5c
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 10 deletions.
diff --git a/visual-dotnet/SauceLabs.Visual/VisualClient.cs b/visual-dotnet/SauceLabs.Visual/VisualClient.cs
@@ -173,7 +173,7 @@ private async Task<string> VisualCheckAsync(string name, VisualCheckOptions opti
                 buildUuid: Build.Id,
                 name: name,
                 jobId: _jobId,
-                diffingMethod: options.DiffingMethod ?? DiffingMethod.Simple,
+                diffingMethod: options.DiffingMethod ?? DiffingMethod.Balanced,
                 regions: ignoredRegions.RegionsIn,
                 ignoredElements: ignoredRegions.ElementsIn,
                 sessionId: _sessionId,

diff --git a/visual-java/src/main/java/com/saucelabs/visual/VisualApi.java b/visual-java/src/main/java/com/saucelabs/visual/VisualApi.java
@@ -431,16 +431,16 @@ public void sauceVisualCheck(String snapshotName, CheckOptions options) {
 
   private static DiffingMethod toDiffingMethod(CheckOptions options) {
     if (options == null || options.getDiffingMethod() == null) {
-      return null;
+      return DiffingMethod.BALANCED;
     }
 
     switch (options.getDiffingMethod()) {
-      case BALANCED:
-        return DiffingMethod.BALANCED;
+      case SIMPLE:
+        return DiffingMethod.SIMPLE;
       case EXPERIMENTAL:
         return DiffingMethod.EXPERIMENTAL;
       default:
-        return DiffingMethod.SIMPLE;
+        return DiffingMethod.BALANCED;
     }
   }
 

diff --git a/visual-java/src/test/java/com/saucelabs/visual/SmokeTest.java b/visual-java/src/test/java/com/saucelabs/visual/SmokeTest.java
@@ -51,7 +51,7 @@ void testBuildSnapshotAndResults() throws InterruptedException {
     WebElement cookieBanner = driver.findElement(By.id("onetrust-banner-sdk"));
 
     CheckOptions checkOptions = new CheckOptions();
-    checkOptions.setDiffingMethod(DiffingMethod.EXPERIMENTAL);
+    checkOptions.setDiffingMethod(DiffingMethod.BALANCED);
     checkOptions.setIgnoreRegions(
         IgnoreRegion.forElement(driver, Arrays.asList(header, caroussel, cookieBanner)));
 

diff --git a/visual-js/visual-cypress/src/index.ts b/visual-js/visual-cypress/src/index.ts
@@ -381,7 +381,10 @@ Sauce Labs Visual: Unable to create new build.
             ? `Desktop  (${metadata.viewport.width}x${metadata.viewport.height})`
             : 'Desktop',
           devicePixelRatio: metadata.devicePixelRatio,
-          diffingMethod: metadata.diffingMethod || this.diffingMethod,
+          diffingMethod:
+            metadata.diffingMethod ||
+            this.diffingMethod ||
+            DiffingMethod.Balanced,
           jobUrl: this.jobId ? this.region.jobUrl(this.jobId) : undefined,
         });
         logger.info(`    ${chalk.green('✔')} ${metadata.name} `);

diff --git a/visual-js/visual-cypress/src/types.ts b/visual-js/visual-cypress/src/types.ts
@@ -62,15 +62,15 @@ export type VisualCheckOptions = {
    */
   ignoredRegions?: (PlainRegion | Cypress.Chainable)[];
   /**
-   * The diffing method we should use when finding visual changes. Defaults to DiffingMethod.Simple.
+   * The diffing method we should use when finding visual changes. Defaults to DiffingMethod.Balanced
    */
   diffingMethod?: DiffingMethod;
   /**
    * The diffing options that should be applied by default.
    */
   diffingOptions?: DiffingOptionsIn;
   /**
-   * The diffing method we should use when finding visual changes. Defaults to DiffingMethod.Simple.
+   * The diffing method we should use when finding visual changes. Defaults to DiffingMethod.Balanced
    */
   regions?: VisualRegion[];
   /**

diff --git a/visual-js/visual-nightwatch/src/nightwatch/commands/sauceVisualCheck.ts b/visual-js/visual-nightwatch/src/nightwatch/commands/sauceVisualCheck.ts
@@ -1,4 +1,5 @@
 import {
+  DiffingMethod,
   ElementIn,
   ensureError,
   getFullPageConfig,
@@ -151,6 +152,7 @@ class SauceVisualCheck implements NightwatchCustomCommandsModel {
         clipElement:
           (await options.clipElement?.getId()) ?? clipElementFromClipSelector,
         captureDom: options.captureDom ?? globalCaptureDom,
+        diffingMethod: options.diffingMethod ?? DiffingMethod.Balanced,
       });
 
       global.uploadedDiffIds.push(

diff --git a/visual-js/visual-wdio/src/SauceVisualService.ts b/visual-js/visual-wdio/src/SauceVisualService.ts
@@ -433,7 +433,8 @@ export default class SauceVisualService implements Services.ServiceInstance {
           disableOnly: options.disable ?? [],
         }),
         sessionMetadata: metaInfo,
-        diffingMethod: options.diffingMethod || this.diffingMethod,
+        diffingMethod:
+          options.diffingMethod || this.diffingMethod || DiffingMethod.Balanced,
         suiteName: this.test?.parent,
         testName: this.test?.title,
         fullPageConfig: getFullPageConfig(this.fullPage, options.fullPage),