Add PlatformHostingControllerHelper to add NSHostingController test support (#321)

Kyle-Ye · web-flow · commit 049612bfad1e · 2025-06-09T04:53:49.000+08:00
diff --git a/Example/HostingExample/ViewController.swift b/Example/HostingExample/ViewController.swift
@@ -66,6 +66,7 @@ class ViewController: NSViewController {
 
 struct ContentView: View {
     var body: some View {
-        Color.red.frame(width: 10, height: 10)
+        Color.red
+            .frame(width: 200, height: 200)
     }
 }
diff --git a/Package.swift b/Package.swift
@@ -541,9 +541,7 @@ if swiftCryptoCondition {
 
 let compatibilityTestCondition = envEnable("OPENSWIFTUI_COMPATIBILITY_TEST")
 if compatibilityTestCondition {
-    var swiftSettings: [SwiftSetting] = (openSwiftUICompatibilityTestTarget.swiftSettings ?? [])
-    swiftSettings.append(.define("OPENSWIFTUI_COMPATIBILITY_TEST"))
-    openSwiftUICompatibilityTestTarget.swiftSettings = swiftSettings
+    sharedSwiftSettings.append(.define("OPENSWIFTUI_COMPATIBILITY_TEST"))
 } else {
     openSwiftUICompatibilityTestTarget.dependencies.append("OpenSwiftUI")
 }
diff --git a/Sources/OpenSwiftUITestsSupport/Export.swift b/Sources/OpenSwiftUITestsSupport/Export.swift
@@ -0,0 +1,11 @@
+//
+//  Export.swift
+//  OpenSwiftUITestsSupport
+
+#if OPENSWIFTUI_COMPATIBILITY_TEST
+@_exported import SwiftUI
+let compatibilityTestEnabled = true
+#else
+@_exported import OpenSwiftUI
+let compatibilityTestEnabled = false
+#endif
diff --git a/Sources/OpenSwiftUITestsSupport/Integration/PlatformAlias.swift b/Sources/OpenSwiftUITestsSupport/Integration/PlatformAlias.swift
@@ -0,0 +1,20 @@
+//
+//  PlatformAlias.swift
+//  OpenSwiftUITestsSupport
+
+package import OpenSwiftUI
+#if os(iOS)
+package import UIKit
+package typealias PlatformViewController = UIViewController
+package typealias PlatformView = UIView
+package typealias PlatformViewControllerRepresentable = UIViewControllerRepresentable
+package typealias PlatformViewRepresentable = UIViewRepresentable
+package typealias PlatformHostingController = UIHostingController
+#elseif os(macOS)
+package import AppKit
+package typealias PlatformViewController = NSViewController
+package typealias PlatformView = NSView
+// package typealias PlatformViewControllerRepresentable = NSViewControllerRepresentable
+// package typealias PlatformViewRepresentable = NSViewRepresentable
+package typealias PlatformHostingController = NSHostingController
+#endif
diff --git a/Sources/OpenSwiftUITestsSupport/Integration/PlatformHostingControllerHelper.swift b/Sources/OpenSwiftUITestsSupport/Integration/PlatformHostingControllerHelper.swift
@@ -0,0 +1,48 @@
+//
+//  PlatformHostingControllerHelper.swift
+//  OpenSwiftUITestsSupport
+
+#if canImport(Darwin)
+#if os(iOS)
+import UIKit
+#elseif os(macOS)
+import AppKit
+#endif
+
+extension PlatformHostingController {
+    package func triggerLayout() {
+        #if os(iOS)
+        let window = UIWindow(frame: CGRect(x: 0, y: 0, width: 100, height: 100))
+        window.rootViewController = self
+        window.makeKeyAndVisible()
+        view.layoutSubviews()
+        #else
+        let window = NSWindow(
+            contentRect: CGRect(x: 0, y: 0, width: 100, height: 100),
+            styleMask: [.titled, .closable, .resizable],
+            backing: .buffered,
+            defer: false
+        )
+        window.contentViewController = self
+        window.makeKeyAndOrderFront(nil)
+        view.layout()
+        #endif
+    }
+}
+
+// FIXME: A workaround to bypass the Issue #87
+package func workaroundIssue87(_ vc: PlatformViewController) {
+    if compatibilityTestEnabled {
+        return
+    } else {
+        // TODO: Use swift-test exist test feature to detect the crash instead or sliently workaroun it
+        CrashWorkaround.shared.objects.append(vc)
+    }
+}
+
+private final class CrashWorkaround {
+    private init() {}
+    static let shared = CrashWorkaround()
+    var objects: [Any?] = []
+}
+#endif
diff --git a/Tests/OpenSwiftUICompatibilityTests/Export.swift b/Tests/OpenSwiftUICompatibilityTests/Export.swift
@@ -2,7 +2,6 @@
 //  Export.swift
 //  OpenSwiftUICompatibilityTests
 
-
 #if OPENSWIFTUI_COMPATIBILITY_TEST
 @_exported import SwiftUI
 let compatibilityTestEnabled = true
diff --git a/Tests/OpenSwiftUICompatibilityTests/SwiftUI/Integration/PlatformHostingControllerTests.swift b/Tests/OpenSwiftUICompatibilityTests/SwiftUI/Integration/PlatformHostingControllerTests.swift
@@ -1,13 +1,13 @@
 //
-//  UIHostingControllerTests.swift
+//  PlatformHostingControllerTests.swift
 //  OpenSwiftUICompatibilityTests
 
-#if os(iOS)
+#if canImport(Darwin)
 import Testing
-import UIKit
+import OpenSwiftUITestsSupport
 
 @MainActor
-struct UIHostingControllerTests {
+struct PlatformHostingControllerTests {
     @Test(
         .bug(
             "https://github.com/OpenSwiftUIProject/OpenGraph/issues/",
@@ -16,18 +16,12 @@ struct UIHostingControllerTests {
         )
     )
     func testBasicAnyView() throws {
-        guard #unavailable(iOS 18) else {
-            withKnownIssue {
-                Issue.record("Known crash issue on iOS 18")
-            }
-            return
-        }
         struct ContentView: View {
             var body: some View {
                 AnyView(EmptyView())
             }
         }
-        let vc = UIHostingController(rootView: ContentView())
+        let vc = PlatformHostingController(rootView: ContentView())
         vc.triggerLayout()
         workaroundIssue87(vc)
     }
@@ -40,19 +34,13 @@ struct UIHostingControllerTests {
         )
     )
     func testBasicAnyViewWithProperty() throws {
-        guard #unavailable(iOS 18) else {
-            withKnownIssue {
-                Issue.record("Known crash issue on iOS 18")
-            }
-            return
-        }
         struct ContentView: View {
             var name = ""
             var body: some View {
                 AnyView(EmptyView())
             }
         }
-        let vc = UIHostingController(rootView: ContentView())
+        let vc = PlatformHostingController(rootView: ContentView())
         vc.triggerLayout()
         workaroundIssue87(vc)
     }
diff --git a/Tests/OpenSwiftUICompatibilityTests/SwiftUI/Integration/UIKit/UIHostingController+Helper.swift b/Tests/OpenSwiftUICompatibilityTests/SwiftUI/Integration/UIKit/UIHostingController+Helper.swift
diff --git a/Tests/OpenSwiftUICompatibilityTests/SwiftUI/View/Debug/ChangedBodyPropertyTests.swift b/Tests/OpenSwiftUICompatibilityTests/SwiftUI/View/Debug/ChangedBodyPropertyTests.swift
@@ -5,10 +5,7 @@
 #if canImport(Darwin) && !OPENSWIFTUI_SWIFT_LOG
 import Testing
 import OSLog
-
-#if os(iOS)
-import UIKit
-#endif
+import OpenSwiftUITestsSupport
 
 @MainActor
 struct ChangedBodyPropertyTests {
@@ -35,24 +32,16 @@ struct ChangedBodyPropertyTests {
     #endif
     @Test
     func zeroPropertyView() throws {
-        guard #unavailable(iOS 18) else {
-            withKnownIssue {
-                Issue.record("Known crash issue on iOS 18")
-            }
-            return
-        }
         struct ContentView: View {
             var body: some View {
                 let _ = Self._logChanges()
                 AnyView(EmptyView())
             }
         }
-        #if os(iOS)
-        let vc = UIHostingController(rootView: ContentView())
+        let vc = PlatformHostingController(rootView: ContentView())
         vc.triggerLayout()
         workaroundIssue87(vc)
         try verifyLog(expected: "ChangedBodyPropertyTests.ContentView: @self changed.")
-        #endif
     }
     
     #if OPENSWIFTUI_COMPATIBILITY_TEST
@@ -62,25 +51,17 @@ struct ChangedBodyPropertyTests {
     #endif
     @Test
     func propertyView() throws {
-        guard #unavailable(iOS 18) else {
-            withKnownIssue {
-                Issue.record("Known crash issue on iOS 18")
-            }
-            return
-        }
         struct ContentView: View {
             var name = ""
             var body: some View {
                 let _ = Self._logChanges()
                 AnyView(EmptyView())
             }
         }
-        #if os(iOS)
-        let vc = UIHostingController(rootView: ContentView())
+        let vc = PlatformHostingController(rootView: ContentView())
         vc.triggerLayout()
         workaroundIssue87(vc)
         try verifyLog(expected: "ChangedBodyPropertyTests.ContentView: @self changed.")
-        #endif
     }
     
     #if OPENSWIFTUI_COMPATIBILITY_TEST
@@ -90,25 +71,17 @@ struct ChangedBodyPropertyTests {
     #endif
     @Test
     func statePropertyView() throws {
-        guard #unavailable(iOS 18) else {
-            withKnownIssue {
-                Issue.record("Known crash issue on iOS 18")
-            }
-            return
-        }
         struct ContentView: View {
             @State var name = ""
             var body: some View {
                 let _ = Self._logChanges()
                 AnyView(EmptyView())
             }
         }
-        #if os(iOS)
-        let vc = UIHostingController(rootView: ContentView())
+        let vc = PlatformHostingController(rootView: ContentView())
         vc.triggerLayout()
         workaroundIssue87(vc)
         try verifyLog(expected: "ChangedBodyPropertyTests.ContentView: @self, @identity, _name changed.")
-        #endif
     }
 }
 #endif
diff --git a/Tests/OpenSwiftUICompatibilityTests/SwiftUICore/Data/State/StateTests.swift b/Tests/OpenSwiftUICompatibilityTests/SwiftUICore/Data/State/StateTests.swift
@@ -3,6 +3,7 @@
 //  OpenSwiftUICompatibilityTests
 
 import Testing
+import OpenSwiftUITestsSupport
 
 #if canImport(Darwin)
 struct StateTests {
@@ -23,16 +24,11 @@ struct StateTests {
                     }
             }
         }
-
-        #if os(iOS)
         await confirmation { @MainActor confirmation in
-            let vc = UIHostingController(rootView: ContentView(confirmation: confirmation))
+            let vc = PlatformHostingController(rootView: ContentView(confirmation: confirmation))
             vc.triggerLayout()
             workaroundIssue87(vc)
         }
-        #endif
     }
-    
-    // TODO: Add disappear support and test case
 }
 #endif
diff --git a/Tests/OpenSwiftUICompatibilityTests/SwiftUICore/Modifier/ViewModifier/AppearanceActionModifierTests.swift b/Tests/OpenSwiftUICompatibilityTests/SwiftUICore/Modifier/ViewModifier/AppearanceActionModifierTests.swift
@@ -6,9 +6,7 @@
 import Testing
 
 import Foundation
-#if os(iOS)
-import UIKit
-#endif
+import OpenSwiftUITestsSupport
 
 @MainActor
 struct AppearanceActionModifierTests {
@@ -24,14 +22,11 @@ struct AppearanceActionModifierTests {
                     }
             }
         }
-
-        #if os(iOS)
         await confirmation { @MainActor confirmation in
-            let vc = UIHostingController(rootView: ContentView(confirmation: confirmation))
+            let vc = PlatformHostingController(rootView: ContentView(confirmation: confirmation))
             vc.triggerLayout()
             workaroundIssue87(vc)
         }
-        #endif
     }
 
     @Test
@@ -48,7 +43,7 @@ struct AppearanceActionModifierTests {
                 Color.red
                     .onAppear {
                         Helper.result += "A"
-                        DispatchQueue.main.asyncAfter(deadline: .now() + 0.5) {
+                        DispatchQueue.main.asyncAfter(deadline: .now() + 0.1) {
                             toggle.toggle()
                         }
                     }
@@ -58,13 +53,16 @@ struct AppearanceActionModifierTests {
                     .id(toggle)
             }
         }
-        #if os(iOS)
-        let vc = UIHostingController(rootView: ContentView())
+        let vc = PlatformHostingController(rootView: ContentView())
         vc.triggerLayout()
         workaroundIssue87(vc)
-        try await Task.sleep(nanoseconds: 1 * 1_000_000_000)
+        #expect(Helper.result.hasPrefix("A"))
+        var timeout = 5
+        while !Helper.result.hasPrefix("AAD") && timeout > 0{
+            try await Task.sleep(for: .seconds(1))
+            timeout -= 1
+        }
         #expect(Helper.result.hasPrefix("AAD"))
-        #endif
     }
 }
 #endif

Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,7 @@ class ViewController: NSViewController {`
`66`	`66`
`67`	`67`	`struct ContentView: View {`
`68`	`68`	`var body: some View {`
`69`		`- Color.red.frame(width: 10, height: 10)`
	`69`	`+ Color.red`
	`70`	`+ .frame(width: 200, height: 200)`
`70`	`71`	`}`
`71`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`// OpenSwiftUICompatibilityTests`
`4`	`4`
`5`	`5`	`import Testing`
	`6`	`+import OpenSwiftUITestsSupport`
`6`	`7`
`7`	`8`	`#if canImport(Darwin)`
`8`	`9`	`struct StateTests {`
`@@ -23,16 +24,11 @@ struct StateTests {`
`23`	`24`	`}`
`24`	`25`	`}`
`25`	`26`	`}`
`26`		`-`
`27`		`- #if os(iOS)`
`28`	`27`	`await confirmation { @MainActor confirmation in`
`29`		`- let vc = UIHostingController(rootView: ContentView(confirmation: confirmation))`
	`28`	`+ let vc = PlatformHostingController(rootView: ContentView(confirmation: confirmation))`
`30`	`29`	`vc.triggerLayout()`
`31`	`30`	`workaroundIssue87(vc)`
`32`	`31`	`}`
`33`		`- #endif`
`34`	`32`	`}`
`35`		`-`
`36`		`- // TODO: Add disappear support and test case`
`37`	`33`	`}`
`38`	`34`	`#endif`
Original file line number	Diff line number	Diff line change
`@@ -6,9 +6,7 @@`
`6`	`6`	`import Testing`
`7`	`7`
`8`	`8`	`import Foundation`
`9`		`-#if os(iOS)`
`10`		`-import UIKit`
`11`		`-#endif`
	`9`	`+import OpenSwiftUITestsSupport`
`12`	`10`
`13`	`11`	`@MainActor`
`14`	`12`	`struct AppearanceActionModifierTests {`
`@@ -24,14 +22,11 @@ struct AppearanceActionModifierTests {`
`24`	`22`	`}`
`25`	`23`	`}`
`26`	`24`	`}`
`27`		`-`
`28`		`- #if os(iOS)`
`29`	`25`	`await confirmation { @MainActor confirmation in`
`30`		`- let vc = UIHostingController(rootView: ContentView(confirmation: confirmation))`
	`26`	`+ let vc = PlatformHostingController(rootView: ContentView(confirmation: confirmation))`
`31`	`27`	`vc.triggerLayout()`
`32`	`28`	`workaroundIssue87(vc)`
`33`	`29`	`}`
`34`		`- #endif`
`35`	`30`	`}`
`36`	`31`
`37`	`32`	`@Test`
`@@ -48,7 +43,7 @@ struct AppearanceActionModifierTests {`
`48`	`43`	`Color.red`
`49`	`44`	`.onAppear {`
`50`	`45`	`Helper.result += "A"`
`51`		`- DispatchQueue.main.asyncAfter(deadline: .now() + 0.5) {`
	`46`	`+ DispatchQueue.main.asyncAfter(deadline: .now() + 0.1) {`
`52`	`47`	`toggle.toggle()`
`53`	`48`	`}`
`54`	`49`	`}`
`@@ -58,13 +53,16 @@ struct AppearanceActionModifierTests {`
`58`	`53`	`.id(toggle)`
`59`	`54`	`}`
`60`	`55`	`}`
`61`		`- #if os(iOS)`
`62`		`- let vc = UIHostingController(rootView: ContentView())`
	`56`	`+ let vc = PlatformHostingController(rootView: ContentView())`
`63`	`57`	`vc.triggerLayout()`
`64`	`58`	`workaroundIssue87(vc)`
`65`		`- try await Task.sleep(nanoseconds: 1 * 1_000_000_000)`
	`59`	`+ #expect(Helper.result.hasPrefix("A"))`
	`60`	`+ var timeout = 5`
	`61`	`+ while !Helper.result.hasPrefix("AAD") && timeout > 0{`
	`62`	`+ try await Task.sleep(for: .seconds(1))`
	`63`	`+ timeout -= 1`
	`64`	`+ }`
`66`	`65`	`#expect(Helper.result.hasPrefix("AAD"))`
`67`		`- #endif`
`68`	`66`	`}`
`69`	`67`	`}`
`70`	`68`	`#endif`