Bump Sharing requirement to include 2.0.0 (#3546)

stephencelis · web-flow · commit ff1a875668a6 · 2025-01-07T09:23:11.000-08:00
* Bump Sharing requirement to include 2.0.0

* Add migration guide

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip
diff --git a/.github/package.xcworkspace/xcshareddata/swiftpm/Package.resolved b/.github/package.xcworkspace/xcshareddata/swiftpm/Package.resolved
diff --git a/ComposableArchitecture.xcworkspace/xcshareddata/swiftpm/Package.resolved b/ComposableArchitecture.xcworkspace/xcshareddata/swiftpm/Package.resolved
diff --git a/Examples/CaseStudies/SwiftUICaseStudiesTests/01-GettingStarted-AnimationsTests.swift b/Examples/CaseStudies/SwiftUICaseStudiesTests/01-GettingStarted-AnimationsTests.swift
@@ -56,7 +56,7 @@ struct AnimationTests {
       $0.circleColor = .black
     }
 
-    await clock.run()
+    await clock.run(timeout: .seconds(7))
   }
 
   @Test
diff --git a/Examples/SyncUps/SyncUps/AppFeature.swift b/Examples/SyncUps/SyncUps/AppFeature.swift
@@ -54,9 +54,7 @@ struct AppView: View {
 
   var body: some View {
     NavigationStack(path: $store.scope(state: \.path, action: \.path)) {
-      SyncUpsListView(
-        store: store.scope(state: \.syncUpsList, action: \.syncUpsList)
-      )
+      SyncUpsListView(store: store.scope(state: \.syncUpsList, action: \.syncUpsList))
     } destination: { store in
       switch store.case {
       case let .detail(store):
diff --git a/Examples/SyncUps/SyncUps/RecordMeeting.swift b/Examples/SyncUps/SyncUps/RecordMeeting.swift
@@ -72,7 +72,7 @@ struct RecordMeeting {
             ? speechClient.requestAuthorization()
             : speechClient.authorizationStatus()
 
-          await withTaskGroup(of: Void.self) { group in
+          await withDiscardingTaskGroup { group in
             if authorization == .authorized {
               group.addTask {
                 await startSpeechRecognition(send: send)
diff --git a/Package.resolved b/Package.resolved
diff --git a/Package.swift b/Package.swift
@@ -28,7 +28,7 @@ let package = Package(
     .package(url: "https://github.com/pointfreeco/swift-macro-testing", from: "0.2.0"),
     .package(url: "https://github.com/pointfreeco/swift-navigation", from: "2.2.2"),
     .package(url: "https://github.com/pointfreeco/swift-perception", from: "1.3.4"),
-    .package(url: "https://github.com/pointfreeco/swift-sharing", "0.1.2"..<"2.0.0"),
+    .package(url: "https://github.com/pointfreeco/swift-sharing", "0.1.2"..<"3.0.0"),
     .package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "1.3.0"),
     .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.0.0"),
     .package(url: "https://github.com/swiftlang/swift-syntax", "509.0.0"..<"601.0.0"),
diff --git a/Package@swift-6.0.swift b/Package@swift-6.0.swift
@@ -28,7 +28,7 @@ let package = Package(
     .package(url: "https://github.com/pointfreeco/swift-macro-testing", from: "0.2.0"),
     .package(url: "https://github.com/pointfreeco/swift-navigation", from: "2.2.2"),
     .package(url: "https://github.com/pointfreeco/swift-perception", from: "1.3.4"),
-    .package(url: "https://github.com/pointfreeco/swift-sharing", "0.1.2"..<"2.0.0"),
+    .package(url: "https://github.com/pointfreeco/swift-sharing", "0.1.2"..<"3.0.0"),
     .package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "1.3.0"),
     .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.0.0"),
     .package(url: "https://github.com/swiftlang/swift-syntax", "509.0.0"..<"601.0.0"),
diff --git a/Sources/ComposableArchitecture/Documentation.docc/Articles/MigrationGuides.md b/Sources/ComposableArchitecture/Documentation.docc/Articles/MigrationGuides.md
@@ -14,6 +14,7 @@ APIs, and these guides contain tips to do so.
 
 ## Topics
 
+- <doc:MigratingTo1.17.1>
 - <doc:MigratingTo1.17>
 - <doc:MigratingTo1.16>
 - <doc:MigratingTo1.15>
diff --git a/Sources/ComposableArchitecture/Documentation.docc/Articles/MigrationGuides/MigratingTo1.17.1.md b/Sources/ComposableArchitecture/Documentation.docc/Articles/MigrationGuides/MigratingTo1.17.1.md
@@ -0,0 +1,30 @@
+# Migrating to 1.17.1
+
+The Sharing library has graduated, with backwards-incompatible changes, to 2.0, and the Composable
+Architecture has been updated to extend support to this new version.
+
+## Overview
+
+The [Sharing][sharing-gh] package is a general purpose, state-sharing and persistence toolkit that
+works on all platforms supported by Swift, including iOS/macOS, Linux, Windows, Wasm, and more.
+
+A [2.0][2.0-release] has introduced new features and functionality, and the Composable Architecture
+1.17.1 includes support for this release.
+
+While many of Sharing 2.0's APIs are backwards-compatible with 1.0, if you have defined any of your
+own custom persistence strategies via the `SharedKey` or `SharedReaderKey` protocols, you will need
+to migrate them in order to support the brand new error handling and async functionality.
+
+If you are not ready to migrate, then you can add an explicit dependency on the library to pin to
+any version less than 2.0:
+
+```swift
+.package(url: "https://github.com/pointfreeco/swift-sharing", from: "0.1.0"),
+```
+
+If you are ready to upgrade to 2.0, then you can follow the [2.0 migration guide][2.0-migration]
+from that package.
+
+[sharing-gh]: https://github.com/pointfreeco/swift-sharing
+[1.0-migration]: https://swiftpackageindex.com/pointfreeco/swift-sharing/main/documentation/sharing/migratingto2.0
+[2.0-release]: https://github.com/pointfreeco/swift-sharing/releases/2.0.0
diff --git a/Sources/ComposableArchitecture/Sharing/AppStorageKeyPathKey.swift b/Sources/ComposableArchitecture/Sharing/AppStorageKeyPathKey.swift
@@ -39,30 +39,57 @@ public struct AppStorageKeyPathKey<Value: Sendable>: Sendable {
 
 @available(*, deprecated, message: "Use an 'AppStorageKey', instead")
 extension AppStorageKeyPathKey: SharedKey, Hashable {
-  public func load(initialValue _: Value?) -> Value? {
-    self.store.wrappedValue[keyPath: self.keyPath]
-  }
+  #if canImport(Sharing2)
+    public func load(context: LoadContext<Value>, continuation: LoadContinuation<Value>) {
+      continuation.resume(returning: self.store.wrappedValue[keyPath: self.keyPath])
+    }
 
-  public func save(_ newValue: Value, immediately: Bool) {
-    SharedAppStorageLocals.$isSetting.withValue(true) {
-      self.store.wrappedValue[keyPath: self.keyPath] = newValue
+    public func subscribe(context: LoadContext<Value>, subscriber: SharedSubscriber<Value>)
+      -> SharedSubscription
+    {
+      let observer = self.store.wrappedValue.observe(self.keyPath, options: .new) { _, change in
+        guard
+          !SharedAppStorageLocals.isSetting
+        else { return }
+        subscriber.yield(with: Result { change.newValue })
+      }
+      return SharedSubscription {
+        observer.invalidate()
+      }
     }
-  }
 
-  public func subscribe(
-    initialValue: Value?,
-    didSet receiveValue: @escaping @Sendable (_ newValue: Value?) -> Void
-  ) -> SharedSubscription {
-    let observer = self.store.wrappedValue.observe(self.keyPath, options: .new) { _, change in
-      guard
-        !SharedAppStorageLocals.isSetting
-      else { return }
-      receiveValue(change.newValue ?? initialValue)
+    public func save(_ value: Value, context: SaveContext, continuation: SaveContinuation) {
+      SharedAppStorageLocals.$isSetting.withValue(true) {
+        self.store.wrappedValue[keyPath: self.keyPath] = value
+      }
+      continuation.resume()
     }
-    return SharedSubscription {
-      observer.invalidate()
+  #else
+    public func load(initialValue _: Value?) -> Value? {
+      self.store.wrappedValue[keyPath: self.keyPath]
     }
-  }
+
+    public func subscribe(
+      initialValue: Value?,
+      didSet receiveValue: @escaping @Sendable (_ newValue: Value?) -> Void
+    ) -> SharedSubscription {
+      let observer = self.store.wrappedValue.observe(self.keyPath, options: .new) { _, change in
+        guard
+          !SharedAppStorageLocals.isSetting
+        else { return }
+        receiveValue(change.newValue ?? initialValue)
+      }
+      return SharedSubscription {
+        observer.invalidate()
+      }
+    }
+
+    public func save(_ newValue: Value, immediately: Bool) {
+      SharedAppStorageLocals.$isSetting.withValue(true) {
+        self.store.wrappedValue[keyPath: self.keyPath] = newValue
+      }
+    }
+  #endif
 }
 
 // NB: This is mainly used for tests, where observer notifications can bleed across cases.

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ struct AnimationTests {`
`56`	`56`	`$0.circleColor = .black`
`57`	`57`	`}`
`58`	`58`
`59`		`- await clock.run()`
	`59`	`+ await clock.run(timeout: .seconds(7))`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`@Test`