Fix UIWindow dealloc issue (#439)

Kyle-Ye · web-flow · commit d43a72c84e2d · 2025-07-27T23:40:02.000+08:00
Add triggerLayoutWithWindow helper method
diff --git a/Sources/OpenSwiftUITestsSupport/Integration/PlatformAlias.swift b/Sources/OpenSwiftUITestsSupport/Integration/PlatformAlias.swift
@@ -10,6 +10,7 @@ package import SwiftUI
 
 #if os(iOS)
 package import UIKit
+package typealias PlatformWindow = UIWindow
 package typealias PlatformViewController = UIViewController
 package typealias PlatformView = UIView
 package typealias PlatformViewControllerRepresentable = UIViewControllerRepresentable
@@ -24,6 +25,7 @@ extension Color {
 }
 #elseif os(macOS)
 package import AppKit
+package typealias PlatformWindow = NSWindow
 package typealias PlatformViewController = NSViewController
 package typealias PlatformView = NSView
 // package typealias PlatformViewControllerRepresentable = NSViewControllerRepresentable
diff --git a/Sources/OpenSwiftUITestsSupport/Integration/PlatformHostingControllerHelper.swift b/Sources/OpenSwiftUITestsSupport/Integration/PlatformHostingControllerHelper.swift
@@ -4,12 +4,15 @@
 
 #if canImport(Darwin)
 #if os(iOS)
-import UIKit
+package import UIKit
 #elseif os(macOS)
-import AppKit
+package import AppKit
 #endif
 
+package import Testing
+
 extension PlatformViewController {
+    // NOTE: Remember to withExtendedLifetime for window to ensure it is not deallocated duration animation or update.
     package func triggerLayout() {
         #if os(iOS)
         let window = UIWindow(frame: CGRect(x: 0, y: 0, width: 100, height: 100))
@@ -29,4 +32,48 @@ extension PlatformViewController {
         #endif
     }
 }
+
+@MainActor
+package func triggerLayoutWithWindow(
+    expectedCount: Int = 1,
+    _ body: @escaping @MainActor (Confirmation) -> PlatformViewController
+) async throws {
+    var window: PlatformWindow!
+    await confirmation(expectedCount: expectedCount) { confirmation in
+        let vc = body(confirmation)
+        vc.triggerLayout()
+        window = vc.view.window
+    }
+    withExtendedLifetime(window) {}
+}
+
+@MainActor
+package func triggerLayoutWithWindow(
+    _ body: @escaping @MainActor (UnsafeContinuation<Void, Never>) -> PlatformViewController
+) async throws {
+    var window: PlatformWindow!
+    await withUnsafeContinuation { continuation in
+        let vc = body(continuation)
+        vc.triggerLayout()
+        window = vc.view.window
+    }
+    withExtendedLifetime(window) {}
+}
+
+@MainActor
+package func triggerLayoutWithWindow(
+    expectedCount: Int = 1,
+    _ body: @escaping @MainActor (Confirmation, UnsafeContinuation<Void, Never>) -> PlatformViewController
+) async throws {
+    var window: PlatformWindow!
+    await confirmation(expectedCount: expectedCount) { @MainActor confirmation in
+        await withUnsafeContinuation { (continuation: UnsafeContinuation<Void, Never>) in
+            let vc = body(confirmation, continuation)
+            vc.triggerLayout()
+            window = vc.view.window
+        }
+    }
+    withExtendedLifetime(window) {}
+}
+
 #endif
diff --git a/Tests/OpenSwiftUICompatibilityTests/Animation/Animation/AnimationCompletionCompatibilityTests.swift b/Tests/OpenSwiftUICompatibilityTests/Animation/Animation/AnimationCompletionCompatibilityTests.swift
@@ -47,7 +47,6 @@ struct AnimationCompletionCompatibilityTests {
                     }
                 }
             }
-
             struct RemovedCompletionView: View {
                 @State private var showRed = false
 
@@ -71,21 +70,14 @@ struct AnimationCompletionCompatibilityTests {
                 }
             }
         }
-
-        var vc: PlatformViewController!
-        await confirmation(expectedCount: 2) { @MainActor confirmation in
-            await withUnsafeContinuation { (continuation: UnsafeContinuation<Void, Never>) in
-                vc = PlatformHostingController(
-                    rootView: ContentView(
-                        confirmation: confirmation,
-                        continuation: continuation
-                    )
+        
+        try await triggerLayoutWithWindow(expectedCount: 2) { confirmation, continuation in
+            PlatformHostingController(
+                rootView: ContentView(
+                    confirmation: confirmation,
+                    continuation: continuation
                 )
-                vc.triggerLayout()
-            }
-        }
-        withExtendedLifetime(vc) {
-            #expect(Helper.values == [1, 2])
+            )
         }
     }
 }
diff --git a/Tests/OpenSwiftUICompatibilityTests/Data/State/StateCompatibilityTests.swift b/Tests/OpenSwiftUICompatibilityTests/Data/State/StateCompatibilityTests.swift
@@ -23,11 +23,13 @@ struct StateCompatibilityTests {
                     }
             }
         }
-        var vc: PlatformViewController!
-        await confirmation { @MainActor confirmation in
-            vc = PlatformHostingController(rootView: ContentView(confirmation: confirmation))
-            vc.triggerLayout()
+        
+        try await triggerLayoutWithWindow { confirmation in
+            PlatformHostingController(
+                rootView: ContentView(
+                    confirmation: confirmation
+                )
+            )
         }
-        withExtendedLifetime(vc) {}
     }
 }
diff --git a/Tests/OpenSwiftUICompatibilityTests/Integration/PlatformHostingControllerCompatibilityTests.swift b/Tests/OpenSwiftUICompatibilityTests/Integration/PlatformHostingControllerCompatibilityTests.swift
@@ -22,7 +22,6 @@ struct PlatformHostingControllerCompatibilityTests {
         }
         let vc = PlatformHostingController(rootView: ContentView())
         vc.triggerLayout()
-        withExtendedLifetime(vc) {}
     }
 
     @Test(
@@ -41,6 +40,5 @@ struct PlatformHostingControllerCompatibilityTests {
         }
         let vc = PlatformHostingController(rootView: ContentView())
         vc.triggerLayout()
-        withExtendedLifetime(vc) {}
     }
 }
diff --git a/Tests/OpenSwiftUICompatibilityTests/Modifier/ViewModifier/AppearanceActionModifierCompatibilityTests.swift b/Tests/OpenSwiftUICompatibilityTests/Modifier/ViewModifier/AppearanceActionModifierCompatibilityTests.swift
@@ -21,12 +21,14 @@ struct AppearanceActionModifierCompatibilityTests {
                     }
             }
         }
-        var vc: PlatformViewController!
-        await confirmation { @MainActor confirmation in
-            vc = PlatformHostingController(rootView: ContentView(confirmation: confirmation))
-            vc.triggerLayout()
+        
+        try await triggerLayoutWithWindow { confirmation in
+            PlatformHostingController(
+                rootView: ContentView(
+                    confirmation: confirmation
+                )
+            )
         }
-        withExtendedLifetime(vc) {}
     }
 
     @Test
@@ -38,29 +40,36 @@ struct AppearanceActionModifierCompatibilityTests {
 
         struct ContentView: View {
             @State private var toggle = false
+            var continuation: UnsafeContinuation<Void, Never>
 
             var body: some View {
                 Color.red
                     .onAppear {
-                        Helper.result += "A"
-                        DispatchQueue.main.asyncAfter(deadline: .now() + 0.1) {
-                            toggle.toggle()
+                        if Helper.result.isEmpty {
+                            DispatchQueue.main.asyncAfter(deadline: .now() + 0.1) {
+                                toggle.toggle()
+                            }
+                        } else {
+                            DispatchQueue.main.asyncAfter(deadline: .now() + 0.1) {
+                                continuation.resume()
+                            }
                         }
+                        Helper.result += "A"
                     }
                     .onDisappear {
                         Helper.result += "D"
                     }
                     .id(toggle)
             }
         }
-        let vc = PlatformHostingController(rootView: ContentView())
-        vc.triggerLayout()
-        #expect(Helper.result.hasPrefix("A"))
-        var timeout = 5
-        while !Helper.result.hasPrefix("AAD"), timeout > 0 {
-            try await Task.sleep(for: .seconds(1))
-            timeout -= 1
+
+        try await triggerLayoutWithWindow { continuation in
+            PlatformHostingController(
+                rootView: ContentView(
+                    continuation: continuation
+                )
+            )
         }
-        withExtendedLifetime(vc) {}
+        #expect(Helper.result == "AADD")
     }
 }
diff --git a/Tests/OpenSwiftUICompatibilityTests/Modifier/ViewModifier/TaskModifierCompatibilityTests.swift b/Tests/OpenSwiftUICompatibilityTests/Modifier/ViewModifier/TaskModifierCompatibilityTests.swift
@@ -22,19 +22,14 @@ struct TaskModifierCompatibilityTests {
             }
         }
 
-        var vc: PlatformViewController!
-        await confirmation(expectedCount: 1) { @MainActor confirmation in
-            await withUnsafeContinuation { (continuation: UnsafeContinuation<Void, Never>) in
-                vc = PlatformHostingController(
-                    rootView: ContentView(
-                        confirmation: confirmation,
-                        continuation: continuation
-                    )
+        try await triggerLayoutWithWindow { confirmation, continuation in
+            PlatformHostingController(
+                rootView: ContentView(
+                    confirmation: confirmation,
+                    continuation: continuation
                 )
-                vc.triggerLayout()
-            }
+            )
         }
-        withExtendedLifetime(vc) {}
     }
 
     @Test
@@ -59,19 +54,14 @@ struct TaskModifierCompatibilityTests {
                     }
             }
         }
-
-        var vc: PlatformViewController!
-        await confirmation(expectedCount: 2) { @MainActor confirmation in
-            await withUnsafeContinuation { (continuation: UnsafeContinuation<Void, Never>) in
-                vc = PlatformHostingController(
-                    rootView: ContentView(
-                        confirmation: confirmation,
-                        continuation: continuation
-                    )
+        
+        try await triggerLayoutWithWindow(expectedCount: 2) { confirmation, continuation in
+            PlatformHostingController(
+                rootView: ContentView(
+                    confirmation: confirmation,
+                    continuation: continuation
                 )
-                vc.triggerLayout()
-            }
+            )
         }
-        withExtendedLifetime(vc) {}
     }
 }
diff --git a/Tests/OpenSwiftUICompatibilityTests/Modifier/ViewModifier/ValueActionModifierCompatibilityTests.swift b/Tests/OpenSwiftUICompatibilityTests/Modifier/ViewModifier/ValueActionModifierCompatibilityTests.swift
diff --git a/Tests/OpenSwiftUICompatibilityTests/View/Debug/ChangedBodyPropertyCompatibilityTests.swift b/Tests/OpenSwiftUICompatibilityTests/View/Debug/ChangedBodyPropertyCompatibilityTests.swift
diff --git a/Tests/OpenSwiftUICompatibilityTests/View/EquatableViewCompatibilityTests.swift b/Tests/OpenSwiftUICompatibilityTests/View/EquatableViewCompatibilityTests.swift

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,6 @@ struct AnimationCompletionCompatibilityTests {`
`47`	`47`	`}`
`48`	`48`	`}`
`49`	`49`	`}`
`50`		`-`
`51`	`50`	`struct RemovedCompletionView: View {`
`52`	`51`	`@State private var showRed = false`
`53`	`52`
`@@ -71,21 +70,14 @@ struct AnimationCompletionCompatibilityTests {`
`71`	`70`	`}`
`72`	`71`	`}`
`73`	`72`	`}`
`74`		`-`
`75`		`- var vc: PlatformViewController!`
`76`		`- await confirmation(expectedCount: 2) { @MainActor confirmation in`
`77`		`- await withUnsafeContinuation { (continuation: UnsafeContinuation<Void, Never>) in`
`78`		`- vc = PlatformHostingController(`
`79`		`- rootView: ContentView(`
`80`		`- confirmation: confirmation,`
`81`		`- continuation: continuation`
`82`		`- )`
	`73`	`+`
	`74`	`+ try await triggerLayoutWithWindow(expectedCount: 2) { confirmation, continuation in`
	`75`	`+ PlatformHostingController(`
	`76`	`+ rootView: ContentView(`
	`77`	`+ confirmation: confirmation,`
	`78`	`+ continuation: continuation`
`83`	`79`	`)`
`84`		`- vc.triggerLayout()`
`85`		`- }`
`86`		`- }`
`87`		`- withExtendedLifetime(vc) {`
`88`		`- #expect(Helper.values == [1, 2])`
	`80`	`+ )`
`89`	`81`	`}`
`90`	`82`	`}`
`91`	`83`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,11 +23,13 @@ struct StateCompatibilityTests {`
`23`	`23`	`}`
`24`	`24`	`}`
`25`	`25`	`}`
`26`		`- var vc: PlatformViewController!`
`27`		`- await confirmation { @MainActor confirmation in`
`28`		`- vc = PlatformHostingController(rootView: ContentView(confirmation: confirmation))`
`29`		`- vc.triggerLayout()`
	`26`	`+`
	`27`	`+ try await triggerLayoutWithWindow { confirmation in`
	`28`	`+ PlatformHostingController(`
	`29`	`+ rootView: ContentView(`
	`30`	`+ confirmation: confirmation`
	`31`	`+ )`
	`32`	`+ )`
`30`	`33`	`}`
`31`		`- withExtendedLifetime(vc) {}`
`32`	`34`	`}`
`33`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,6 @@ struct PlatformHostingControllerCompatibilityTests {`
`22`	`22`	`}`
`23`	`23`	`let vc = PlatformHostingController(rootView: ContentView())`
`24`	`24`	`vc.triggerLayout()`
`25`		`- withExtendedLifetime(vc) {}`
`26`	`25`	`}`
`27`	`26`
`28`	`27`	`@Test(`
`@@ -41,6 +40,5 @@ struct PlatformHostingControllerCompatibilityTests {`
`41`	`40`	`}`
`42`	`41`	`let vc = PlatformHostingController(rootView: ContentView())`
`43`	`42`	`vc.triggerLayout()`
`44`		`- withExtendedLifetime(vc) {}`
`45`	`43`	`}`
`46`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,12 +21,14 @@ struct AppearanceActionModifierCompatibilityTests {`
`21`	`21`	`}`
`22`	`22`	`}`
`23`	`23`	`}`
`24`		`- var vc: PlatformViewController!`
`25`		`- await confirmation { @MainActor confirmation in`
`26`		`- vc = PlatformHostingController(rootView: ContentView(confirmation: confirmation))`
`27`		`- vc.triggerLayout()`
	`24`	`+`
	`25`	`+ try await triggerLayoutWithWindow { confirmation in`
	`26`	`+ PlatformHostingController(`
	`27`	`+ rootView: ContentView(`
	`28`	`+ confirmation: confirmation`
	`29`	`+ )`
	`30`	`+ )`
`28`	`31`	`}`
`29`		`- withExtendedLifetime(vc) {}`
`30`	`32`	`}`
`31`	`33`
`32`	`34`	`@Test`
`@@ -38,29 +40,36 @@ struct AppearanceActionModifierCompatibilityTests {`
`38`	`40`
`39`	`41`	`struct ContentView: View {`
`40`	`42`	`@State private var toggle = false`
	`43`	`+ var continuation: UnsafeContinuation<Void, Never>`
`41`	`44`
`42`	`45`	`var body: some View {`
`43`	`46`	`Color.red`
`44`	`47`	`.onAppear {`
`45`		`- Helper.result += "A"`
`46`		`- DispatchQueue.main.asyncAfter(deadline: .now() + 0.1) {`
`47`		`- toggle.toggle()`
	`48`	`+ if Helper.result.isEmpty {`
	`49`	`+ DispatchQueue.main.asyncAfter(deadline: .now() + 0.1) {`
	`50`	`+ toggle.toggle()`
	`51`	`+ }`
	`52`	`+ } else {`
	`53`	`+ DispatchQueue.main.asyncAfter(deadline: .now() + 0.1) {`
	`54`	`+ continuation.resume()`
	`55`	`+ }`
`48`	`56`	`}`
	`57`	`+ Helper.result += "A"`
`49`	`58`	`}`
`50`	`59`	`.onDisappear {`
`51`	`60`	`Helper.result += "D"`
`52`	`61`	`}`
`53`	`62`	`.id(toggle)`
`54`	`63`	`}`
`55`	`64`	`}`
`56`		`- let vc = PlatformHostingController(rootView: ContentView())`
`57`		`- vc.triggerLayout()`
`58`		`- #expect(Helper.result.hasPrefix("A"))`
`59`		`- var timeout = 5`
`60`		`- while !Helper.result.hasPrefix("AAD"), timeout > 0 {`
`61`		`- try await Task.sleep(for: .seconds(1))`
`62`		`- timeout -= 1`
	`65`	`+`
	`66`	`+ try await triggerLayoutWithWindow { continuation in`
	`67`	`+ PlatformHostingController(`
	`68`	`+ rootView: ContentView(`
	`69`	`+ continuation: continuation`
	`70`	`+ )`
	`71`	`+ )`
`63`	`72`	`}`
`64`		`- withExtendedLifetime(vc) {}`
	`73`	`+ #expect(Helper.result == "AADD")`
`65`	`74`	`}`
`66`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,19 +22,14 @@ struct TaskModifierCompatibilityTests {`
`22`	`22`	`}`
`23`	`23`	`}`
`24`	`24`
`25`		`- var vc: PlatformViewController!`
`26`		`- await confirmation(expectedCount: 1) { @MainActor confirmation in`
`27`		`- await withUnsafeContinuation { (continuation: UnsafeContinuation<Void, Never>) in`
`28`		`- vc = PlatformHostingController(`
`29`		`- rootView: ContentView(`
`30`		`- confirmation: confirmation,`
`31`		`- continuation: continuation`
`32`		`- )`
	`25`	`+ try await triggerLayoutWithWindow { confirmation, continuation in`
	`26`	`+ PlatformHostingController(`
	`27`	`+ rootView: ContentView(`
	`28`	`+ confirmation: confirmation,`
	`29`	`+ continuation: continuation`
`33`	`30`	`)`
`34`		`- vc.triggerLayout()`
`35`		`- }`
	`31`	`+ )`
`36`	`32`	`}`
`37`		`- withExtendedLifetime(vc) {}`
`38`	`33`	`}`
`39`	`34`
`40`	`35`	`@Test`
`@@ -59,19 +54,14 @@ struct TaskModifierCompatibilityTests {`
`59`	`54`	`}`
`60`	`55`	`}`
`61`	`56`	`}`
`62`		`-`
`63`		`- var vc: PlatformViewController!`
`64`		`- await confirmation(expectedCount: 2) { @MainActor confirmation in`
`65`		`- await withUnsafeContinuation { (continuation: UnsafeContinuation<Void, Never>) in`
`66`		`- vc = PlatformHostingController(`
`67`		`- rootView: ContentView(`
`68`		`- confirmation: confirmation,`
`69`		`- continuation: continuation`
`70`		`- )`
	`57`	`+`
	`58`	`+ try await triggerLayoutWithWindow(expectedCount: 2) { confirmation, continuation in`
	`59`	`+ PlatformHostingController(`
	`60`	`+ rootView: ContentView(`
	`61`	`+ confirmation: confirmation,`
	`62`	`+ continuation: continuation`
`71`	`63`	`)`
`72`		`- vc.triggerLayout()`
`73`		`- }`
	`64`	`+ )`
`74`	`65`	`}`
`75`		`- withExtendedLifetime(vc) {}`
`76`	`66`	`}`
`77`	`67`	`}`