From 59b663f68e69f27a87b45de48cb63264b8194605 Mon Sep 17 00:00:00 2001
From: Brandon Williams <135203+mbrandonw@users.noreply.github.com>
Date: Mon, 27 Nov 2023 14:00:38 -0500
Subject: [PATCH] =?UTF-8?q?Improve=20the=20speed=20of=20comparing=20memory?=
 =?UTF-8?q?=20buffers=20by=20using=20a=20workaround=20t=E2=80=A6=20(#812)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Improve the speed of comparing memory buffers by using a workaround to a missed compiler optimization

Co-authored-by: Eric Jensen <eric@yetilabs.org>

* Update NSImage.swift

* Update UIImage.swift

* fix

---------

Co-authored-by: Eric Jensen <eric@yetilabs.org>
Co-authored-by: Stephen Celis <stephen@stephencelis.com>
---
 Sources/SnapshotTesting/Snapshotting/NSImage.swift | 10 ++++++++--
 Sources/SnapshotTesting/Snapshotting/UIImage.swift | 10 ++++++++--
 2 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/Sources/SnapshotTesting/Snapshotting/NSImage.swift b/Sources/SnapshotTesting/Snapshotting/NSImage.swift
index 0f1d5b481..be4fd7cd4 100644
--- a/Sources/SnapshotTesting/Snapshotting/NSImage.swift
+++ b/Sources/SnapshotTesting/Snapshotting/NSImage.swift
@@ -118,8 +118,14 @@
       let newRep = NSBitmapImageRep(cgImage: newerCgImage).bitmapData!
       let byteCountThreshold = Int((1 - precision) * Float(byteCount))
       var differentByteCount = 0
-      for offset in 0..<byteCount {
-        if oldRep[offset] != newRep[offset] {
+      // NB: We are purposely using a verbose 'while' loop instead of a 'for in' loop.  When the
+      //     compiler doesn't have optimizations enabled, like in test targets, a `while` loop is
+      //     significantly faster than a `for` loop for iterating through the elements of a memory
+      //     buffer. Details can be found in [SR-6983](https://github.com/apple/swift/issues/49531)
+      var index = 0
+      while index < byteCount {
+        defer { index += 1 }
+        if oldRep[index] != newRep[index] {
           differentByteCount += 1
         }
       }
diff --git a/Sources/SnapshotTesting/Snapshotting/UIImage.swift b/Sources/SnapshotTesting/Snapshotting/UIImage.swift
index 33472d3af..e5fc4262e 100644
--- a/Sources/SnapshotTesting/Snapshotting/UIImage.swift
+++ b/Sources/SnapshotTesting/Snapshotting/UIImage.swift
@@ -140,8 +140,14 @@
     } else {
       let byteCountThreshold = Int((1 - precision) * Float(byteCount))
       var differentByteCount = 0
-      for offset in 0..<byteCount {
-        if oldBytes[offset] != newerBytes[offset] {
+      // NB: We are purposely using a verbose 'while' loop instead of a 'for in' loop.  When the
+      //     compiler doesn't have optimizations enabled, like in test targets, a `while` loop is
+      //     significantly faster than a `for` loop for iterating through the elements of a memory
+      //     buffer. Details can be found in [SR-6983](https://github.com/apple/swift/issues/49531)
+      var index = 0
+      while index < byteCount {
+        defer { index += 1 }
+        if oldBytes[index] != newerBytes[index] {
           differentByteCount += 1
         }
       }