Merge remote-tracking branch 'upstream/main'

Author: Mx-Iris

.github/workflows/ci.yml

@@ -37,27 +37,20 @@ jobs:
         run: make test-${{ matrix.variation }}
 
   wasm:
-    name: SwiftWasm
+    name: Wasm
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        include:
-          - toolchain: swift-DEVELOPMENT-SNAPSHOT-2024-09-12-a
-            swift-sdk: swift-wasm-DEVELOPMENT-SNAPSHOT-2024-09-12-a
-            checksum: 630ce23114580dfae029f832d8ccc8b1ba5136b7f915e82f8e405650e326b562
     steps:
       - uses: actions/checkout@v4
       - uses: bytecodealliance/actions/wasmtime/setup@v1
       - name: Install Swift and Swift SDK for WebAssembly
         run: |
           PREFIX=/opt/swift
-          SWIFT_TOOLCHAIN_TAG="${{ matrix.toolchain }}"
-          SWIFT_SDK_TAG="${{ matrix.swift-sdk }}"
           set -ex
-          curl -f -o /tmp/swift.tar.gz "https://download.swift.org/development/ubuntu2204/$SWIFT_TOOLCHAIN_TAG/$SWIFT_TOOLCHAIN_TAG-ubuntu22.04.tar.gz"
+          curl -f -o /tmp/swift.tar.gz "https://download.swift.org/swift-6.0.2-release/ubuntu2204/swift-6.0.2-RELEASE/swift-6.0.2-RELEASE-ubuntu22.04.tar.gz"
           sudo mkdir -p $PREFIX; sudo tar -xzf /tmp/swift.tar.gz -C $PREFIX --strip-component 1
-          $PREFIX/usr/bin/swift sdk install "https://github.com/swiftwasm/swift/releases/download/$SWIFT_SDK_TAG/$SWIFT_SDK_TAG-wasm32-unknown-wasi.artifactbundle.zip" --checksum ${{ matrix.checksum }}
+          $PREFIX/usr/bin/swift sdk install https://github.com/swiftwasm/swift/releases/download/swift-wasm-6.0.2-RELEASE/swift-wasm-6.0.2-RELEASE-wasm32-unknown-wasi.artifactbundle.zip --checksum 6ffedb055cb9956395d9f435d03d53ebe9f6a8d45106b979d1b7f53358e1dcb4
           echo "$PREFIX/usr/bin" >> $GITHUB_PATH
+
       - name: Build tests
         run: swift build --swift-sdk wasm32-unknown-wasi --build-tests -Xlinker -z -Xlinker stack-size=$((1024 * 1024))
       - name: Run tests

README.md

@@ -29,10 +29,6 @@ SwiftUI, UIKit, AppKit, and even non-Apple platforms.
 
 #### SwiftUI
 
-> [!IMPORTANT]
-> To get access to the tools described below you must depend on the SwiftNavigation package and
-> import the SwiftUINavigation library.
-
 SwiftUI already comes with incredibly powerful navigation APIs, but there are a few areas lacking
 that can be filled. In particular, driving navigation from enum state so that you can have
 compile-time guarantees that only one destination can be active at a time.
@@ -96,10 +92,16 @@ This is more concise, and we get compile-time verification that at most one dest
 active at a time. However, SwiftUI does not come with the tools to drive navigation from this 
 model. This is where the SwiftUINavigation tools becomes useful.
 
+> [!IMPORTANT]
+> To get access to the tools described below you must depend on the SwiftNavigation package
+> (see [Installation](#installation)) and import the **SwiftUINavigation** library.
+
 We start by annotating the `Destination` enum with the `@CasePathable` macro, which allows one to
 refer to the cases of an enum with dot-syntax just like one does with structs and properties:
 
 ```diff
++import SwiftNavigation 
+
 +@CasePathable
  enum Destination {
    // ...
@@ -110,6 +112,8 @@ And now one can use simple dot-chaining syntax to derive a binding from a partic
 the `destination` property:
 
 ```swift
+import SwiftUINavigation 
+// ...
 .sheet(item: $model.destination.addItem) { addItemModel in
   AddItemView(model: addItemModel)
 }
@@ -133,7 +137,7 @@ we can still use SwiftUI's navigation APIs.
 
 > [!IMPORTANT]
 > To get access to the tools described below you must depend on the SwiftNavigation package and
-> import the UIKitNavigation library.
+> import the **UIKitNavigation** library.
 
 Unlike SwiftUI, UIKit does not come with state-driven navigation tools. Its navigation tools are
 "fire-and-forget", meaning you simply invoke a method to trigger a navigation, but there is 
@@ -151,17 +155,20 @@ This makes it easy to get started with navigation, but as SwiftUI has taught us,
 powerful to be able to drive navigation from state. It allows you to encapsulate more of your 
 feature's logic in an isolated and testable domain, and it unlocks deep linking for free since one
 just needs to construct a piece of state that represents where you want to navigate to, hand it to
-SwiftUI, and let SwiftUI handle the rest.
+SwiftUI, and let it handle the rest.
 
 The UIKitNavigation library brings a powerful suite of navigation tools to UIKit that are heavily
 inspired by SwiftUI. For example, if you have a feature model like the one discussed above in
 the [SwiftUI](#swiftui) section:
 
 ```swift
+import SwiftNavigation 
+
 @Observable
 class FeatureModel {
   var destination: Destination?
 
+  @CasePathable
   enum Destination {
     case addItem(AddItemModel)
     case deleteItemAlert
@@ -173,6 +180,8 @@ class FeatureModel {
 …then one can drive navigation in a _view controller_ using tools in the library: 
 
 ```swift
+import UIKitNavigation 
+
 class FeatureViewController: UIViewController {
   @UIBindable var model: FeatureModel
 
@@ -184,7 +193,7 @@ class FeatureViewController: UIViewController {
     present(item: $model.destination.addItem) { addItemModel in
       AddItemViewController(model: addItemModel)
     }
-    present(isPresented: Binding($model.destination.deleteItemAlert)) {
+    present(isPresented: UIBinding($model.destination.deleteItemAlert)) {
       let alert = UIAlertController(title: "Delete?", message: message, preferredStyle: .alert)
       alert.addAction(UIAlertAction(title: "Yes", style: .destructive))
       alert.addAction(UIAlertAction(title: "No", style: .cancel))

Sources/SwiftNavigation/Internal/KeyPath+Sendable.swift

@@ -7,14 +7,29 @@
   public typealias _SendableWritableKeyPath<Root, Value> = WritableKeyPath<Root, Value>
 #endif
 
-func sendableKeyPath<Root, Value>(
-  _ keyPath: KeyPath<Root, Value>
-) -> _SendableKeyPath<Root, Value> {
-  unsafeBitCast(keyPath, to: _SendableKeyPath<Root, Value>.self)
-}
+// NB: Dynamic member lookup does not currently support sendable key paths and even breaks
+//     autocomplete.
+//
+//     * https://github.com/swiftlang/swift/issues/77035
+//     * https://github.com/swiftlang/swift/issues/77105
+extension _AppendKeyPath {
+  @_transparent
+  func unsafeSendable<Root, Value>() -> _SendableKeyPath<Root, Value>
+  where Self == KeyPath<Root, Value> {
+    #if compiler(>=6)
+      unsafeBitCast(self, to: _SendableKeyPath<Root, Value>.self)
+    #else
+      self
+    #endif
+  }
 
-func sendableKeyPath<Root, Value>(
-  _ keyPath: WritableKeyPath<Root, Value>
-) -> _SendableWritableKeyPath<Root, Value> {
-  unsafeBitCast(keyPath, to: _SendableWritableKeyPath<Root, Value>.self)
+  @_transparent
+  func unsafeSendable<Root, Value>() -> _SendableWritableKeyPath<Root, Value>
+  where Self == WritableKeyPath<Root, Value> {
+    #if compiler(>=6)
+      unsafeBitCast(self, to: _SendableWritableKeyPath<Root, Value>.self)
+    #else
+      self
+    #endif
+  }
 }

Sources/SwiftNavigation/Observe.swift

@@ -172,9 +172,9 @@ private func onChange(
 ///   }
 /// }
 /// ```
-public final class ObserveToken: @unchecked Sendable, HashableObject {
+public final class ObserveToken: Sendable, HashableObject {
   fileprivate let _isCancelled = LockIsolated(false)
-  public var onCancel: @Sendable () -> Void
+  public let onCancel: @Sendable () -> Void
 
   public var isCancelled: Bool {
     _isCancelled.withValue { $0 }

Sources/SwiftNavigation/UIBinding.swift

@@ -1,6 +1,10 @@
 import ConcurrencyExtras
 import IssueReporting
 
+#if canImport(Observation)
+  import Observation
+#endif
+
 /// A property wrapper type that can read and write an observable value.
 ///
 /// Like SwiftUI's `Binding`, but works for UIKit, AppKit, and non-Apple platforms such as
@@ -378,7 +382,7 @@ public struct UIBinding<Value>: Sendable {
   ) -> UIBinding<Member> {
     func open(_ location: some _UIBinding<Value>) -> UIBinding<Member> {
       UIBinding<Member>(
-        location: _UIBindingAppendKeyPath(base: location, keyPath: sendableKeyPath(keyPath)),
+        location: _UIBindingAppendKeyPath(base: location, keyPath: keyPath.unsafeSendable()),
         transaction: transaction
       )
     }
@@ -396,7 +400,7 @@ public struct UIBinding<Value>: Sendable {
   where Value: CasePathable {
     func open(_ location: some _UIBinding<Value>) -> UIBinding<Member?> {
       UIBinding<Member?>(
-        location: _UIBindingEnumToOptionalCase(base: location, keyPath: sendableKeyPath(keyPath)),
+        location: _UIBindingEnumToOptionalCase(base: location, keyPath: keyPath.unsafeSendable()),
         transaction: transaction
       )
     }
@@ -413,7 +417,7 @@ public struct UIBinding<Value>: Sendable {
   where Value == Wrapped? {
     func open(_ location: some _UIBinding<Value>) -> UIBinding<Member?> {
       UIBinding<Member?>(
-        location: _UIBindingOptionalToMember(base: location, keyPath: sendableKeyPath(keyPath)),
+        location: _UIBindingOptionalToMember(base: location, keyPath: keyPath.unsafeSendable()),
         transaction: transaction
       )
     }
@@ -430,7 +434,7 @@ public struct UIBinding<Value>: Sendable {
   where Value == V? {
     func open(_ location: some _UIBinding<Value>) -> UIBinding<Member?> {
       UIBinding<Member?>(
-        location: _UIBindingOptionalEnumToCase(base: location, keyPath: sendableKeyPath(keyPath)),
+        location: _UIBindingOptionalEnumToCase(base: location, keyPath: keyPath.unsafeSendable()),
         transaction: transaction
       )
     }
@@ -560,14 +564,34 @@ private final class _UIBindingWeakRoot<Root: AnyObject, Value>: _UIBinding, @unc
   }
 }
 
-@Perceptible
-private final class _UIBindingWrapper<Value> {
-  var value: Value
+private final class _UIBindingWrapper<Value>: Perceptible {
+  var _value: Value
+  var value: Value {
+    get {
+      _$perceptionRegistrar.access(self, keyPath: \.value)
+      return _value
+    }
+    set {
+      _$perceptionRegistrar.withMutation(of: self, keyPath: \.value) {
+        _value = newValue
+      }
+    }
+    _modify {
+      _$perceptionRegistrar.willSet(self, keyPath: \.value)
+      defer { _$perceptionRegistrar.didSet(self, keyPath: \.value) }
+      yield &_value
+    }
+  }
+  let _$perceptionRegistrar = PerceptionRegistrar()
   init(_ value: Value) {
-    self.value = value
+    self._value = value
   }
 }
 
+#if canImport(Observation)
+  extension _UIBindingWrapper: Observable {}
+#endif
+
 private final class _UIBindingConstant<Value>: _UIBinding, @unchecked Sendable {
   let value: Value
   init(_ value: Value) {