chore: strict concurrency in Swift 5.10 (#20)

* chore: strict concurrency in Swift 5.10

* chore: set exact version as 1.14

* chore: attempt to force 5.10.0

* chore: don’t specify a swift version for latest xcode

* chore: makes mutating state functions public

* chore: update pre-commit

* chore: add test for cancel

---------

Co-authored-by: danthorpe <[email protected]>

Author: danthorpe

.github/workflows/main.yml

@@ -28,7 +28,6 @@ jobs:
             },
             {
               "os": "macos-14",
-              "swift": "5.10",
               "xcode": "15.4"
             }
           ]

.pre-commit-config.yaml

@@ -11,11 +11,11 @@ repos:
       - id: check-executables-have-shebangs
       - id: check-shebang-scripts-are-executable
   - repo: https://github.com/realm/SwiftLint
-    rev: 0.54.0
+    rev: 0.57.0
     hooks:
       - id: swiftlint
         entry: swiftlint --fix --strict
   - repo: https://github.com/danthorpe/swift-format
-    rev: 756fbb36972bd4ddcb6b3923ad38c0f8efda2d89
+    rev: feba87c2da2a64e8aeff4ae00c9e65962a7f2f75
     hooks:
       - id: swift-format

Package.swift

@@ -14,28 +14,31 @@ var package = Package(
   ],
   dependencies: [
     .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.3.0"),
-    .package(url: "https://github.com/pointfreeco/swift-composable-architecture", from: "1.15.0"),
+    .package(url: "https://github.com/pointfreeco/swift-composable-architecture", exact: "1.14.0"),
   ],
   targets: [
     .target(
       name: "ComposableLoadable",
       dependencies: [
         .composableArchitecture
-      ]
+      ],
+      swiftSettings: .concurrency
     ),
     .target(
       name: "CommonTestHelpers",
       dependencies: [
         "ComposableLoadable",
         .composableArchitecture,
-      ]
+      ],
+      swiftSettings: .concurrency
     ),
     .testTarget(
       name: "ComposableLoadableTests",
       dependencies: [
         "CommonTestHelpers",
         "ComposableLoadable",
-      ]
+      ],
+      swiftSettings: .concurrency
     ),
   ]
 )
@@ -45,3 +48,17 @@ extension Target.Dependency {
     name: "ComposableArchitecture", package: "swift-composable-architecture"
   )
 }
+
+extension [SwiftSetting] {
+  #if compiler(>=6)
+  static let concurrency: Self = [
+    .enableUpcomingFeature("StrictConcurrency")
+      .enableUpcomingFeature("InferSendableFromCaptures")
+  ]
+  #else
+  static let concurrency: Self = [
+    .enableExperimentalFeature("StrictConcurrency"),
+    .enableExperimentalFeature("InferSendableFromCaptures"),
+  ]
+  #endif
+}

Sources/CommonTestHelpers/KeyPath+.swift

@@ -0,0 +1,4 @@
+#if compiler(<6.0) || !hasFeature(InferSendableFromCaptures)
+#warning("Workaround for a bunch of Strict Concurrency related warnings. To be removed when Swift 6.0 is available.")
+extension KeyPath: @unchecked Sendable {}
+#endif

Sources/CommonTestHelpers/TestFeatureClient.swift

@@ -1,7 +1,7 @@
 import ComposableArchitecture
 
 struct TestFeatureClient: TestDependencyKey {
-  static var testValue = TestFeatureClient(
+  static let testValue = TestFeatureClient(
     getValue: unimplemented("TestFeatureClient.getValue")
   )
   var getValue: @Sendable (String) async throws -> Int

Sources/ComposableLoadable/Loadable/LoadableClient.swift

@@ -10,7 +10,7 @@ package protocol LoadableClient<Request, State, Value> {
   var load: @Sendable (Request, State) async throws -> Value { get }
 }
 
-public struct EmptyLoadRequest: Equatable {
+public struct EmptyLoadRequest: Equatable, Sendable {
   public init() {}
 }
 

Sources/ComposableLoadable/Loadable/LoadableState.swift

@@ -199,15 +199,15 @@ public struct LoadableState<Request, Value> {
     }
   }
 
-  mutating func becomeActive(_ request: Request) {
+  mutating public func becomeActive(_ request: Request) {
     current = .active(request)
   }
 
-  mutating func cancel() {
+  mutating public func cancel() {
     current = previous ?? .pending
   }
 
-  mutating func finish(
+  mutating public func finish(
     _ request: Request,
     result: Result<Value, Error>
   ) {

Sources/ComposableLoadable/Loadable/LoadingAction.swift

@@ -2,7 +2,7 @@ import ComposableArchitecture
 import Foundation
 
 @CasePathable
-public enum LoadingAction<Request, Value, Action> {
+public enum LoadingAction<Request: Sendable, Value: Sendable, Action> {
   case cancel
   case finished(Request, didRefresh: Bool, TaskResult<Value>)
   case load(Request)
@@ -22,6 +22,8 @@ extension LoadingAction where Request == EmptyLoadRequest {
 
 // MARK: - Conformances
 
+extension LoadingAction: Sendable where Request: Sendable, Value: Sendable, Action: Sendable {}
+
 extension LoadingAction: Equatable where Value: Equatable {
   // NOTE: Define conformance here, but implementation is below
 }

Sources/ComposableLoadable/Loadable/LoadingReducer.swift

@@ -6,7 +6,12 @@ import Foundation
 extension Reducer {
 
   /// Integrate a Loadable child domain with a generic Request type
-  public func loadable<ChildState, ChildAction, Child: Reducer, Request>(
+  public func loadable<
+    ChildState: Sendable,
+    ChildAction,
+    Child: Reducer,
+    Request: Sendable
+  >(
     _ toLoadableState: WritableKeyPath<State, LoadableState<Request, ChildState>>,
     action toLoadingAction: CaseKeyPath<Action, LoadingAction<Request, ChildState, ChildAction>>,
     @ReducerBuilder<ChildState, ChildAction> child: () -> Child,
@@ -25,7 +30,11 @@ extension Reducer {
   }
 
   /// Integrate a Loadable child domain which does not require a Request type
-  public func loadable<ChildState, ChildAction, Child: Reducer>(
+  public func loadable<
+    ChildState: Sendable,
+    ChildAction,
+    Child: Reducer
+  >(
     _ toLoadableState: WritableKeyPath<State, LoadableState<EmptyLoadRequest, ChildState>>,
     action toLoadingAction: CaseKeyPath<
       Action, LoadingAction<EmptyLoadRequest, ChildState, ChildAction>
@@ -46,7 +55,10 @@ extension Reducer {
   }
 
   /// Integrate some LoadableState which does not require a child domain
-  public func loadable<ChildState, Request>(
+  public func loadable<
+    ChildState: Sendable,
+    Request: Sendable
+  >(
     _ toLoadableState: WritableKeyPath<State, LoadableState<Request, ChildState>>,
     action toLoadingAction: CaseKeyPath<Action, LoadingAction<Request, ChildState, NoLoadingAction>>,
     load: @escaping @Sendable (Request, State) async throws -> ChildState,
@@ -71,7 +83,7 @@ extension Reducer {
 
   fileprivate func loadable<
     Child: Reducer,
-    Request,
+    Request: Sendable,
     Client: LoadableClient<Request, State, Child.State>
   >(
     fileID: StaticString,
@@ -80,7 +92,7 @@ extension Reducer {
     action toLoadingAction: CaseKeyPath<Action, LoadingAction<Request, Child.State, Child.Action>>,
     client: Client,
     @ReducerBuilder<Child.State, Child.Action> child: () -> Child
-  ) -> LoadingReducer<Self, Child, Request, Client> {
+  ) -> LoadingReducer<Self, Child, Request, Client> where Client.State: Sendable {
     LoadingReducer(
       parent: self,
       child: child(),
@@ -98,9 +110,9 @@ extension Reducer {
 private struct LoadingReducer<
   Parent: Reducer,
   Child: Reducer,
-  Request,
+  Request: Sendable,
   Client: LoadableClient<Request, Parent.State, Child.State>
->: Reducer {
+>: Reducer where Child.State: Sendable {
 
   typealias State = Parent.State
   typealias Action = Parent.Action
@@ -155,16 +167,16 @@ private struct LoadingReducer<
   struct CancelID: Hashable {}
 
   func reduce(into state: inout State, action: Action) -> Effect<Action> {
-    let parentState = state
+    let parentState = UncheckedSendable(state)
     return CombineReducers {
       Scope(state: toLoadableState, action: toLoadingAction) {
         Reduce { loadableState, loadingAction in
 
           func send(refresh: Bool, _ request: Request) -> Effect<ThisLoadingAction> {
             loadableState.becomeActive(request)
             return
-              .run { send in
-                let value = try await client.load(request, parentState)
+              .run { [load = client.load] send in
+                let value = try await load(request, parentState.value)
                 await send(.finished(request, didRefresh: refresh, .success(value)))
               } catch: { error, send in
                 await send(.finished(request, didRefresh: refresh, .failure(error)))

Sources/ComposableLoadable/Pagination/PaginationContext.swift

@@ -14,7 +14,7 @@ import Foundation
 ///   let searchId: String
 /// }
 /// ```
-public protocol PaginationContext: Equatable {
+public protocol PaginationContext: Equatable, Sendable {
 
   /// A convenience to determine equality between any two
   /// contexts.