fix: do not generate diff image on retries

Author: eWert-Online

lib/OSnap_Diff/OSnap_Diff.ml

@@ -13,6 +13,7 @@ let diff
   ~output
   ?(ignoreRegions = [])
   ?(threshold = 0)
+  ~generateDiffImage
   ~diffPixel
   ~original_image_data
   ~new_image_data
@@ -26,99 +27,101 @@ let diff
     try Io.loadImage new_image_data |> Result.ok with
     | _ -> Result.error Io
   in
-  let free_images () =
-    Io.freeImage original_image;
-    Io.freeImage new_image
+  let diff_result =
+    Diff.diff
+      original_image
+      new_image
+      ~outputDiffMask:true
+      ~threshold:0.1
+      ~failOnLayoutChange:false
+      ~antialiasing:true
+      ~ignoreRegions
+      ~diffPixel
+      ()
   in
-  Diff.diff
-    original_image
-    new_image
-    ~outputDiffMask:true
-    ~threshold:0.1
-    ~failOnLayoutChange:false
-    ~antialiasing:true
-    ~ignoreRegions
-    ~diffPixel
-    ()
-  |> function
-  | Pixel (_, diffCount, _, _) when diffCount <= threshold ->
-    free_images ();
-    Result.ok ()
-  | Layout ->
-    free_images ();
-    Result.error Layout
+  match diff_result with
+  | Pixel (_, diffCount, _, _) when diffCount <= threshold -> Result.ok ()
+  | Layout -> Result.error Layout
   | Pixel (diff_mask, diffCount, diffPercentage, _) ->
-    let border_width = 5 in
-    let complete_width =
-      original_image.width
-      + border_width
-      + diff_mask.width
-      + border_width
-      + new_image.width
-    in
-    let complete_height =
-      original_image.height |> max diff_mask.height |> max new_image.height
-    in
-    let complete_image =
-      Array1.create int32 c_layout (complete_width * complete_height * 4)
-    in
-    let original_image_start = 0 in
-    let original_image_end = original_image.width in
-    let diff_mask_start = original_image_end + border_width in
-    let diff_mask_end = diff_mask_start + diff_mask.width in
-    let new_image_start = diff_mask_end + border_width in
-    let new_image_end = new_image_start + new_image.width in
-    for offset = 0 to Array1.dim complete_image / 4 do
-      let row = offset / complete_width in
-      let col = offset mod complete_width in
-      let fill_with =
-        if col >= original_image_start
-           && col < original_image_end
-           && row < original_image.height
-        then Array1.get original_image.image ((row * original_image.width) + col)
-        else if col > diff_mask_start && col < diff_mask_end
-        then (
-          let diff_pixel =
-            if row < diff_mask.height
+    let () =
+      if generateDiffImage
+      then (
+        let border_width = 5 in
+        let complete_width =
+          original_image.width
+          + border_width
+          + diff_mask.width
+          + border_width
+          + new_image.width
+        in
+        let complete_height =
+          original_image.height |> max diff_mask.height |> max new_image.height
+        in
+        let complete_image =
+          Array1.create int32 c_layout (complete_width * complete_height * 4)
+        in
+        let original_image_start = 0 in
+        let original_image_end = original_image.width in
+        let diff_mask_start = original_image_end + border_width in
+        let diff_mask_end = diff_mask_start + diff_mask.width in
+        let new_image_start = diff_mask_end + border_width in
+        let new_image_end = new_image_start + new_image.width in
+        for offset = 0 to Array1.dim complete_image / 4 do
+          let row = offset / complete_width in
+          let col = offset mod complete_width in
+          let fill_with =
+            if col >= original_image_start
+               && col < original_image_end
+               && row < original_image.height
+            then Array1.get original_image.image ((row * original_image.width) + col)
+            else if col > diff_mask_start && col < diff_mask_end
+            then (
+              let diff_pixel =
+                if row < diff_mask.height
+                then
+                  Array1.get
+                    diff_mask.image
+                    ((row * diff_mask.width) + (col - diff_mask_start))
+                else 0x00000000l
+              in
+              if not (Int32.equal diff_pixel 0x00000000l)
+              then diff_pixel
+              else if row < original_image.height
+              then (
+                let pixel =
+                  Array1.get
+                    original_image.image
+                    ((row * original_image.width) + (col - diff_mask_start))
+                  |> Int32.to_int
+                in
+                let a = (pixel lsr 24) land 0xFF in
+                let b = (pixel lsr 16) land 0xFF in
+                let g = (pixel lsr 8) land 0xFF in
+                let r = (pixel lsr 0) land 0xFF in
+                let brightness = ((r * 54) + (g * 182) + (b * 19)) / 255 in
+                let mono = min 255 (brightness + 80) in
+                let a = (a land 0xFF) lsl 24 in
+                let b = (mono land 0xFF) lsl 16 in
+                let g = (mono land 0xFF) lsl 8 in
+                let r = (mono land 0xFF) lsl 0 in
+                Int32.of_int (a lor b lor g lor r))
+              else 0x00000000l)
+            else if col > new_image_start
+                    && col <= new_image_end
+                    && row < new_image.height
             then
               Array1.get
-                diff_mask.image
-                ((row * diff_mask.width) + (col - diff_mask_start))
+                new_image.image
+                ((row * new_image.width) + (col - new_image_start))
             else 0x00000000l
           in
-          if not (Int32.equal diff_pixel 0x00000000l)
-          then diff_pixel
-          else if row < original_image.height
-          then (
-            let pixel =
-              Array1.get
-                original_image.image
-                ((row * original_image.width) + (col - diff_mask_start))
-              |> Int32.to_int
-            in
-            let a = (pixel lsr 24) land 0xFF in
-            let b = (pixel lsr 16) land 0xFF in
-            let g = (pixel lsr 8) land 0xFF in
-            let r = (pixel lsr 0) land 0xFF in
-            let brightness = ((r * 54) + (g * 182) + (b * 19)) / 255 in
-            let mono = min 255 (brightness + 80) in
-            let a = (a land 0xFF) lsl 24 in
-            let b = (mono land 0xFF) lsl 16 in
-            let g = (mono land 0xFF) lsl 8 in
-            let r = (mono land 0xFF) lsl 0 in
-            Int32.of_int (a lor b lor g lor r))
-          else 0x00000000l)
-        else if col > new_image_start && col <= new_image_end && row < new_image.height
-        then Array1.get new_image.image ((row * new_image.width) + (col - new_image_start))
-        else 0x00000000l
-      in
-      Array1.set complete_image offset fill_with
-    done;
-    free_images ();
-    Osnap_Diff_Png.PngIo.write_png_bigarray
-      output
-      complete_image
-      complete_width
-      complete_height;
+          Array1.set complete_image offset fill_with
+        done;
+        Osnap_Diff_Png.PngIo.write_png_bigarray
+          output
+          complete_image
+          complete_width
+          complete_height)
+    in
     Result.error (Pixel (diffCount, diffPercentage))
 ;;

lib/OSnap_Diff/OSnap_Diff.mli

@@ -7,6 +7,7 @@ val diff
   :  output:string
   -> ?ignoreRegions:((int * int) * (int * int)) list
   -> ?threshold:int
+  -> generateDiffImage:bool
   -> diffPixel:int32
   -> original_image_data:string
   -> new_image_data:string

lib/OSnap_Test/OSnap_Test.ml

@@ -183,7 +183,13 @@ let run ~env (global_config : Config.Types.global) target test =
         then (
           Printer.success_message ~name:test.name ~width:test.width ~height:test.height;
           Result.ok `Passed)
-        else
+        else (
+          let should_retry =
+            match test.result with
+            | None -> Some 1
+            | Some (`Retry i) when i < test.retry -> Some (succ i)
+            | _ -> None
+          in
           let*? ignoreRegions =
             test.ignore_regions |> get_ignore_regions ~document target test.size_name
           in
@@ -195,6 +201,7 @@ let run ~env (global_config : Config.Types.global) target test =
               ~output:(Eio.Path.native_exn diff_image)
               ~original_image_data
               ~new_image_data:screenshot
+              ~generateDiffImage:(Option.is_none should_retry)
           in
           match diff () with
           | Ok () ->
@@ -216,22 +223,15 @@ let run ~env (global_config : Config.Types.global) target test =
             let*? () = save_screenshot screenshot ~path:updated_snapshot in
             Result.ok (`Failed `Layout)
           | Error (Pixel (diffCount, diffPercentage)) ->
-            (match test.result with
-             | None ->
+            (match should_retry with
+             | Some i ->
                Printer.retry_message
-                 ~count:1
+                 ~count:i
                  ~name:test.name
                  ~width:test.width
                  ~height:test.height;
-               Result.ok (`Retry 1)
-             | Some (`Retry i) when i < test.retry ->
-               Printer.retry_message
-                 ~count:(succ i)
-                 ~name:test.name
-                 ~width:test.width
-                 ~height:test.height;
-               Result.ok (`Retry (succ i))
-             | _ ->
+               Result.ok (`Retry i)
+             | None ->
                Printer.diff_message
                  ~print_head:true
                  ~name:test.name
@@ -240,7 +240,7 @@ let run ~env (global_config : Config.Types.global) target test =
                  ~diffCount
                  ~diffPercentage;
                let*? () = save_screenshot screenshot ~path:updated_snapshot in
-               Result.ok (`Failed (`Pixel (diffCount, diffPercentage))))
+               Result.ok (`Failed (`Pixel (diffCount, diffPercentage)))))
     in
     { test with result = Some result } |> Result.ok)
 ;;