Add support for Xcode 14 (#33)

ra1028 · web-flow · commit 374aee20e1a8 · 2022-10-08T19:41:14.000+09:00
* Fix compilation

* Fix compilation warnings

* Update development tools

* Remove workarounds from example app that are fixed in iOS16

* Run unit tests with Xcode14

* Reorder modifiers as iOS16 propergates refreshable context to a screen presented with sheet

* Ignore lint warning for rule AllPublicDeclarationsHaveDocumentation in example app

* Update simulator device name format
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -17,6 +17,7 @@ jobs:
       matrix:
         xcode_version:
           - 13.3
+          - 14.0.1
     env:
       DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode_version }}.app
     steps:
@@ -34,7 +35,7 @@ jobs:
     name: Validation
     runs-on: macos-12
     env:
-      DEVELOPER_DIR: /Applications/Xcode_13.3.app
+      DEVELOPER_DIR: /Applications/Xcode_14.0.1.app
     steps:
       - uses: actions/checkout@v2
       - name: Validate lint
diff --git a/Examples/App.xcodeproj/project.pbxproj b/Examples/App.xcodeproj/project.pbxproj
@@ -267,7 +267,7 @@
 				CODE_SIGN_IDENTITY = "-";
 				CODE_SIGN_STYLE = Manual;
 				INFOPLIST_FILE = "App/Info-iOS.plist";
-				IPHONEOS_DEPLOYMENT_TARGET = 15.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 16.0;
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",
@@ -336,7 +336,7 @@
 				CODE_SIGN_IDENTITY = "-";
 				CODE_SIGN_STYLE = Manual;
 				INFOPLIST_FILE = "App/Info-iOS.plist";
-				IPHONEOS_DEPLOYMENT_TARGET = 15.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 16.0;
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",
diff --git a/Examples/Packages/CrossPlatform/Sources/ExampleTodo/Screens.swift b/Examples/Packages/CrossPlatform/Sources/ExampleTodo/Screens.swift
@@ -34,7 +34,7 @@ struct TodoListScreen: View {
 
         #if os(iOS)
             .listStyle(.insetGrouped)
-                .buttonStyle(.borderless)
+            .buttonStyle(.borderless)
         #elseif !os(tvOS)
             .buttonStyle(.borderless)
         #endif
diff --git a/Examples/Packages/iOS/Sources/ExampleMovieDB/Screens/MoviesScreen.swift b/Examples/Packages/iOS/Sources/ExampleMovieDB/Screens/MoviesScreen.swift
@@ -63,13 +63,13 @@ struct MoviesScreen: View {
             text: $searchQuery,
             placement: .navigationBarDrawer(displayMode: .always)
         )
-        .onSubmit(of: .search) { [$isShowingSearchScreen] in
-            $isShowingSearchScreen.wrappedValue = true
+        .onSubmit(of: .search) {
+            isShowingSearchScreen = true
         }
         .task(id: loader.filter) {
             await loader.refresh()
         }
-        .refreshable { [context] in
+        .refreshable {
             // NB: Implicitly capturing `self` causes memory leak with `refreshable`,
             // and also capturing `loader` makes refresh doesn't work, so here reads
             // `MovieLoader` via context.
diff --git a/Examples/Packages/iOS/Sources/ExampleMovieDB/Screens/SearchScreen.swift b/Examples/Packages/iOS/Sources/ExampleMovieDB/Screens/SearchScreen.swift
@@ -35,12 +35,12 @@ struct SearchScreen: View {
         }
         .navigationTitle("Search Results")
         .listStyle(.insetGrouped)
+        .refreshable {
+            await context.refresh(SearchMoviesAtom())
+        }
         .sheet(item: $selectedMovie) { movie in
             DetailScreen(movie: movie)
         }
-        .refreshable { [context] in
-            await context.refresh(SearchMoviesAtom())
-        }
     }
 }
 
diff --git a/Examples/project.yml b/Examples/project.yml
@@ -46,7 +46,7 @@ targets:
     templates:
       - App
     platform: iOS
-    deploymentTarget: 15.0
+    deploymentTarget: 16.0
     dependencies:
       - package: iOSApp
     sources:
diff --git a/Makefile b/Makefile
@@ -4,7 +4,7 @@ SWIFT_FILE_PATHS = Package.swift Sources Tests Examples
 TEST_PLATFORM_IOS = iOS Simulator,name=iPhone 13 Pro
 TEST_PLATFORM_MACOS = macOS
 TEST_PLATFORM_TVOS = tvOS Simulator,name=Apple TV 4K (at 1080p) (2nd generation)
-TEST_PLATFORM_WATCHOS = watchOS Simulator,name=Apple Watch Series 7 - 45mm
+TEST_PLATFORM_WATCHOS = watchOS Simulator,name=Apple Watch Series 7 (45mm)
 
 .PHONY: proj
 proj:
diff --git a/Package.swift b/Package.swift
@@ -27,7 +27,7 @@ let package = Package(
 if ProcessInfo.processInfo.environment["SWIFTUI_ATOM_PROPERTIES_DEVELOPMENT"] != nil {
     package.dependencies.append(contentsOf: [
         .package(url: "https://github.com/apple/swift-docc-plugin", exact: "1.0.0"),
-        .package(url: "https://github.com/apple/swift-format.git", exact: "0.50600.1"),
+        .package(url: "https://github.com/apple/swift-format.git", exact: "0.50700.0"),
         .package(url: "https://github.com/yonaskolb/XcodeGen.git", exact: "2.32.0"),
     ])
 }
diff --git a/README.md b/README.md
@@ -948,7 +948,7 @@ struct BooksView: View {
             }
         }
         .searchable(text: searchQuery)
-        .refreshable { [context] in  // NB: Unfortunately, SwiftUI has a memory leak when capturing `self` implicitly inside a `refreshable` modifier.
+        .refreshable {
             // refresh
             await context.refresh(FetchBooksAtom())
         }
@@ -1437,7 +1437,7 @@ In the above example, the initial state of the atom is retrieved from UserDefaul
 
 ### Dealing with Known SwiftUI Bugs
 
-#### In iOS14, modal presentation causes assertionFailure when dismissing it
+#### Modal presentation causes assertionFailure when dismissing it (Fixed in iOS15)
 
 <details><summary><code>💡 Click to expand workaround</code></summary>
 
@@ -1464,10 +1464,10 @@ struct RootView: View {
 
 </details>
 
-Unfortunately, SwiftUI has a bug in iOS14 where the `EnvironmentValue` is removed from a screen presented with `.sheet` just before dismissing it. Since this library is designed based on `EnvironmentValue`, this bug end up triggering the friendly `assertionFailure` that is added so that developers can easily aware of forgotten `AtomRoot` implementation.  
+Unfortunately, SwiftUI has a bug in iOS14 or lower where the `EnvironmentValue` is removed from a screen presented with `.sheet` just before dismissing it. Since this library is designed based on `EnvironmentValue`, this bug end up triggering the friendly `assertionFailure` that is added so that developers can easily aware of forgotten `AtomRoot` implementation.  
 As a workaround, `AtomRelay` has the ability to explicitly inherit the internal store through `AtomViewContext` from the parent view.
 
-#### Some SwiftUI modifiers cause memory leak
+#### Some SwiftUI modifiers cause memory leak (Fixed in iOS16)
 
 <details><summary><code>💡 Click to expand workaround</code></summary>
 
@@ -1495,7 +1495,7 @@ var isShowingSearchScreen = false
 
 </details>
 
-Some modifiers in SwiftUI seem to cause an internal memory leak if it captures `self` implicitly or explicitly. To avoid that bug, make sure that `self` is not captured when using those modifiers.  
+In iOS 15 or lower, some modifiers in SwiftUI seem to cause an internal memory leak if it captures `self` implicitly or explicitly. To avoid that bug, make sure that `self` is not captured when using those modifiers.  
 Below are the list of modifiers I found that cause memory leaks:
 
 - [`refreshable(action:)`](https://developer.apple.com/documentation/SwiftUI/View/refreshable(action:))
diff --git a/Sources/Atoms/Context/AtomTestContext.swift b/Sources/Atoms/Context/AtomTestContext.swift
@@ -216,7 +216,7 @@ public struct AtomTestContext: AtomWatchableContext {
     public func watch<Node: ObservableObjectAtom>(_ atom: Node) -> Node.Loader.Value {
         state.store.watch(atom, container: state.container) { [weak state] in
             // Ensures that the observable object is updated before notifying updates.
-            RunLoop.current.perform {
+            RunLoop.current.perform { [weak state] in
                 state?.notifyUpdate()
             }
         }
@@ -260,7 +260,6 @@ public struct AtomTestContext: AtomWatchableContext {
 }
 
 private extension AtomTestContext {
-    @MainActor
     final class State {
         private let _store = Store()
         private let _container = SubscriptionContainer()
@@ -278,6 +277,7 @@ private extension AtomTestContext {
             StoreContext(_store, overrides: overrides)
         }
 
+        @MainActor
         var container: SubscriptionContainer.Wrapper {
             _container.wrapper(location: location)
         }
diff --git a/Sources/Atoms/Core/AtomCache.swift b/Sources/Atoms/Core/AtomCache.swift
@@ -21,5 +21,3 @@ internal struct AtomCache<Node: Atom>: AtomCacheBase, CustomStringConvertible {
         store.reset(atom)
     }
 }
-
-extension AtomCache: Equatable where Node: Equatable, Node.Loader.Value: Equatable {}
diff --git a/Tests/AtomsTests/Utilities/Util.swift b/Tests/AtomsTests/Utilities/Util.swift
@@ -70,3 +70,11 @@ extension SubscriptionContainer {
         return wrapper(location: location)
     }
 }
+
+extension AtomCache: Equatable where Node: Equatable, Node.Loader.Value: Equatable {
+    // NB: Synthesized Equatable conformance doesn't work well in Xcode 14.0.1.
+    // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
+    public static func == (lhs: Self, rhs: Self) -> Bool {
+        lhs.atom == rhs.atom && lhs.value == rhs.value
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -63,13 +63,13 @@ struct MoviesScreen: View {`
`63`	`63`	`text: $searchQuery,`
`64`	`64`	`placement: .navigationBarDrawer(displayMode: .always)`
`65`	`65`	`)`
`66`		`- .onSubmit(of: .search) { [$isShowingSearchScreen] in`
`67`		`- $isShowingSearchScreen.wrappedValue = true`
	`66`	`+ .onSubmit(of: .search) {`
	`67`	`+ isShowingSearchScreen = true`
`68`	`68`	`}`
`69`	`69`	`.task(id: loader.filter) {`
`70`	`70`	`await loader.refresh()`
`71`	`71`	`}`
`72`		`- .refreshable { [context] in`
	`72`	`+ .refreshable {`
`73`	`73`	// NB: Implicitly capturing `self` causes memory leak with `refreshable`,
`74`	`74`	// and also capturing `loader` makes refresh doesn't work, so here reads
`75`	`75`	// `MovieLoader` via context.
Original file line number	Diff line number	Diff line change
`@@ -35,12 +35,12 @@ struct SearchScreen: View {`
`35`	`35`	`}`
`36`	`36`	`.navigationTitle("Search Results")`
`37`	`37`	`.listStyle(.insetGrouped)`
	`38`	`+ .refreshable {`
	`39`	`+ await context.refresh(SearchMoviesAtom())`
	`40`	`+ }`
`38`	`41`	`.sheet(item: $selectedMovie) { movie in`
`39`	`42`	`DetailScreen(movie: movie)`
`40`	`43`	`}`
`41`		`- .refreshable { [context] in`
`42`		`- await context.refresh(SearchMoviesAtom())`
`43`		`- }`
`44`	`44`	`}`
`45`	`45`	`}`
`46`	`46`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ let package = Package(`
`27`	`27`	`if ProcessInfo.processInfo.environment["SWIFTUI_ATOM_PROPERTIES_DEVELOPMENT"] != nil {`
`28`	`28`	`package.dependencies.append(contentsOf: [`
`29`	`29`	`.package(url: "https://github.com/apple/swift-docc-plugin", exact: "1.0.0"),`
`30`		`- .package(url: "https://github.com/apple/swift-format.git", exact: "0.50600.1"),`
	`30`	`+ .package(url: "https://github.com/apple/swift-format.git", exact: "0.50700.0"),`
`31`	`31`	`.package(url: "https://github.com/yonaskolb/XcodeGen.git", exact: "2.32.0"),`
`32`	`32`	`])`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -216,7 +216,7 @@ public struct AtomTestContext: AtomWatchableContext {`
`216`	`216`	`public func watch<Node: ObservableObjectAtom>(_ atom: Node) -> Node.Loader.Value {`
`217`	`217`	`state.store.watch(atom, container: state.container) { [weak state] in`
`218`	`218`	`// Ensures that the observable object is updated before notifying updates.`
`219`		`- RunLoop.current.perform {`
	`219`	`+ RunLoop.current.perform { [weak state] in`
`220`	`220`	`state?.notifyUpdate()`
`221`	`221`	`}`
`222`	`222`	`}`
`@@ -260,7 +260,6 @@ public struct AtomTestContext: AtomWatchableContext {`
`260`	`260`	`}`
`261`	`261`
`262`	`262`	`private extension AtomTestContext {`
`263`		`- @MainActor`
`264`	`263`	`final class State {`
`265`	`264`	`private let _store = Store()`
`266`	`265`	`private let _container = SubscriptionContainer()`
`@@ -278,6 +277,7 @@ private extension AtomTestContext {`
`278`	`277`	`StoreContext(_store, overrides: overrides)`
`279`	`278`	`}`
`280`	`279`
	`280`	`+ @MainActor`
`281`	`281`	`var container: SubscriptionContainer.Wrapper {`
`282`	`282`	`_container.wrapper(location: location)`
`283`	`283`	`}`