Support multiple resizing calls during the same animation (#2337)

Author: OdNairy

CHANGELOG.md

@@ -4,6 +4,8 @@ Mapbox welcomes participation and contributions from everyone.
 
 ## main
 
+* Fix the bug when MapView would ignore the new bounds size if there are more than a single resizing event in the animation.
+
 ## 11.8.0-beta.1 - 14 October, 2024
 
 * [SwiftUI] Fixed crash when ForEvery was used with duplicated IDs.

Sources/MapboxMaps/Foundation/SizeTrackingLayer.swift

@@ -21,6 +21,8 @@ class SizeTrackingLayer: CALayer {
 
     private var sizeAnimationIsActive = false
 
+    private let loggerCategory = "SizeTrackingLayer"
+
     override func add(_ anim: CAAnimation, forKey key: String?) {
         if anim.isAnimatingBounds {
             sizeAnimationIsActive = true
@@ -30,6 +32,13 @@ class SizeTrackingLayer: CALayer {
 
     override var bounds: CGRect {
         didSet {
+            Log.debug(forMessage: """
+                \(SizeTrackingLayer.self) did resize
+                    Layer: \(self)
+                    Old size: \(oldValue.size)
+                    New size: \(bounds.size)
+                    Animation is \(sizeAnimationIsActive ? "" : "NOT ")active
+                """, category: loggerCategory)
             guard oldValue.size != bounds.size else { return }
             guard sizeAnimationIsActive else {
                 sizeTrackingDelegate?.sizeTrackingLayer(layer: self, completeResizingFrom: oldValue.size, to: bounds.size)
@@ -39,6 +48,26 @@ class SizeTrackingLayer: CALayer {
             CATransaction.setCompletionBlock { [bounds, weak self] in
                 guard let self else { return }
 
+                // In case there were more than one resizing in the same animation period, the last resizing should win
+                // CATransaction completionBlock's get called in the reverse mode.
+                guard self.bounds.size == bounds.size else {
+                    Log.debug(forMessage: """
+                        Skipping bounds resize completion of \(self) due to mismatched bounds.
+                            Layer: \(self)
+                            Old size: \(oldValue.size)
+                            Expected size: \(bounds.size)
+                            Actual size: \(self.bounds.size)
+                        """, category: loggerCategory)
+                    return
+                }
+
+                Log.debug(forMessage: """
+                    \(SizeTrackingLayer.self) animation completed
+                        layer: \(self)
+                        Old size: \(oldValue.size)
+                        New size: \(bounds.size)
+                    """, category: loggerCategory)
+
                 self.sizeTrackingDelegate?.sizeTrackingLayer(layer: self, completeResizingFrom: oldValue.size, to: bounds.size)
 
                 self.sizeAnimationIsActive = false