add "Reactor" product with experimental @observable support

Author: oanhof

Example/AsyncReactorExample.xcodeproj/project.pbxproj

@@ -14,6 +14,8 @@
 		80D30FC62A1CDBC200C653B0 /* RepositoryDescriptionSheet.swift in Sources */ = {isa = PBXBuildFile; fileRef = 80D30FC52A1CDBC200C653B0 /* RepositoryDescriptionSheet.swift */; };
 		80E8B9D12A1BAE2800E4B3CC /* RepositorySearchView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 80E8B9D02A1BAE2800E4B3CC /* RepositorySearchView.swift */; };
 		80E8B9D32A1BAEC200E4B3CC /* RepositoryDetailView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 80E8B9D22A1BAEC200E4B3CC /* RepositoryDetailView.swift */; };
+		B4A9DDD22CF23EF2008CA694 /* Reactor in Frameworks */ = {isa = PBXBuildFile; productRef = B4A9DDD12CF23EF2008CA694 /* Reactor */; };
+		B4C46AC02CEF7CA300CC2BE7 /* ObservableTestView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B4C46ABF2CEF7CA300CC2BE7 /* ObservableTestView.swift */; };
 		B4ECB0B02A1250AE00B0CAAE /* AsyncReactorExampleApp.swift in Sources */ = {isa = PBXBuildFile; fileRef = B4ECB0AF2A1250AE00B0CAAE /* AsyncReactorExampleApp.swift */; };
 		B4ECB0B22A1250AE00B0CAAE /* ContentView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B4ECB0B12A1250AE00B0CAAE /* ContentView.swift */; };
 		B4ECB0B42A1250AF00B0CAAE /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = B4ECB0B32A1250AF00B0CAAE /* Assets.xcassets */; };
@@ -31,6 +33,7 @@
 		80D30FC52A1CDBC200C653B0 /* RepositoryDescriptionSheet.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RepositoryDescriptionSheet.swift; sourceTree = "<group>"; };
 		80E8B9D02A1BAE2800E4B3CC /* RepositorySearchView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RepositorySearchView.swift; sourceTree = "<group>"; };
 		80E8B9D22A1BAEC200E4B3CC /* RepositoryDetailView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RepositoryDetailView.swift; sourceTree = "<group>"; };
+		B4C46ABF2CEF7CA300CC2BE7 /* ObservableTestView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ObservableTestView.swift; sourceTree = "<group>"; };
 		B4ECB0AC2A1250AE00B0CAAE /* AsyncReactorExample.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = AsyncReactorExample.app; sourceTree = BUILT_PRODUCTS_DIR; };
 		B4ECB0AF2A1250AE00B0CAAE /* AsyncReactorExampleApp.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AsyncReactorExampleApp.swift; sourceTree = "<group>"; };
 		B4ECB0B12A1250AE00B0CAAE /* ContentView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ContentView.swift; sourceTree = "<group>"; };
@@ -46,6 +49,7 @@
 			isa = PBXFrameworksBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				B4A9DDD22CF23EF2008CA694 /* Reactor in Frameworks */,
 				B4ECB0C82A12520700B0CAAE /* Logging in Frameworks */,
 				B4ECB0C12A1250E000B0CAAE /* AsyncReactor in Frameworks */,
 			);
@@ -125,6 +129,7 @@
 				809CDDE42A1B9591001D17BE /* Models */,
 				B4ECB0AF2A1250AE00B0CAAE /* AsyncReactorExampleApp.swift */,
 				B4ECB0B12A1250AE00B0CAAE /* ContentView.swift */,
+				B4C46ABF2CEF7CA300CC2BE7 /* ObservableTestView.swift */,
 				B4ECB0B32A1250AF00B0CAAE /* Assets.xcassets */,
 				B4ECB0B52A1250AF00B0CAAE /* AsyncReactorExample.entitlements */,
 				B4ECB0B62A1250AF00B0CAAE /* Preview Content */,
@@ -166,6 +171,7 @@
 			packageProductDependencies = (
 				B4ECB0C02A1250E000B0CAAE /* AsyncReactor */,
 				B4ECB0C72A12520700B0CAAE /* Logging */,
+				B4A9DDD12CF23EF2008CA694 /* Reactor */,
 			);
 			productName = AsyncReactorExample;
 			productReference = B4ECB0AC2A1250AE00B0CAAE /* AsyncReactorExample.app */;
@@ -234,6 +240,7 @@
 				80D30FBE2A1BBD8000C653B0 /* RepositoryDetailReactor.swift in Sources */,
 				80E8B9D12A1BAE2800E4B3CC /* RepositorySearchView.swift in Sources */,
 				80D30FC42A1BC07B00C653B0 /* RepositoryItem.swift in Sources */,
+				B4C46AC02CEF7CA300CC2BE7 /* ObservableTestView.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -458,6 +465,10 @@
 /* End XCRemoteSwiftPackageReference section */
 
 /* Begin XCSwiftPackageProductDependency section */
+		B4A9DDD12CF23EF2008CA694 /* Reactor */ = {
+			isa = XCSwiftPackageProductDependency;
+			productName = Reactor;
+		};
 		B4ECB0C02A1250E000B0CAAE /* AsyncReactor */ = {
 			isa = XCSwiftPackageProductDependency;
 			productName = AsyncReactor;

Example/AsyncReactorExample/ObservableTestView.swift

@@ -0,0 +1,76 @@
+//
+//  ObservableTestView.swift
+//  AsyncReactorExample
+//
+//  Created by Dominik Arnhof on 21.11.24.
+//
+
+import SwiftUI
+import Reactor
+
+@available(iOS 17.0, *)
+@Observable
+class ObservableTestReactor: Reactor {
+    enum SyncAction {
+        case count
+        case enterText(String)
+    }
+    
+    @Observable
+    class State {
+        var count = 0
+        var text = "test"
+    }
+    
+    private(set) var state = State()
+    
+    init(state: State = State()) {
+        self.state = state
+        print("reactor init")
+    }
+    
+    func action(_ action: SyncAction) {
+        switch action {
+        case .count:
+            state.count += 1
+        case .enterText(let text):
+            state.text = text
+        }
+    }
+}
+
+@available(iOS 17.0, *)
+struct ObservableTestView: View {
+    @Environment(ObservableTestReactor.self)
+    private var reactor
+    
+    @ActionBinding(ObservableTestReactor.self, keyPath: \.text, action: ObservableTestReactor.SyncAction.enterText)
+    private var text: String
+    
+    var body: some View {
+        let _ = Self._printChanges()
+        VStack {
+            Text(reactor.count.formatted())
+            
+            Button {
+                reactor.action(.count)
+            } label: {
+                Text("+")
+            }
+            
+            Text(reactor.text)
+
+            TextField("Text", text: $text)
+                .textFieldStyle(.roundedBorder)
+                .padding()
+        }
+    }
+}
+
+#Preview {
+    if #available(iOS 17.0, *) {
+        ReactorView(ObservableTestReactor()) {
+            ObservableTestView()
+        }
+    }
+}

Package.swift

@@ -15,7 +15,12 @@ let package = Package(
         // Products define the executables and libraries a package produces, and make them visible to other packages.
         .library(
             name: "AsyncReactor",
-            targets: ["AsyncReactor"]),
+            targets: ["AsyncReactor"]
+        ),
+        .library(
+            name: "Reactor",
+            targets: ["Reactor"]
+        )
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
@@ -24,10 +29,17 @@ let package = Package(
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
         // Targets can depend on other targets in this package, and on products in packages this package depends on.
+        .target(
+            name: "ReactorBase",
+            dependencies: []
+        ),
+        .target(
+            name: "Reactor",
+            dependencies: ["ReactorBase"]
+        ),
         .target(
             name: "AsyncReactor",
-            dependencies: [],
-            path: "Sources"
+            dependencies: ["ReactorBase"]
         ),
         .testTarget(
             name: "AsyncReactorTests",

Sources/AsyncReactor/AsyncReactor+SwiftUI.swift

@@ -7,42 +7,7 @@
 
 #if canImport(SwiftUI)
 import SwiftUI
-
-extension AsyncReactor {
-    @MainActor
-    public func bind<T>(_ keyPath: KeyPath<State, T>, cancelId: CancelId? = nil, action: @escaping (T) -> Action) -> Binding<T> {
-        Binding {
-            self.state[keyPath: keyPath]
-        } set: { newValue in
-            Task {
-                if let cancelId {
-                    await self.action(action(newValue), id: cancelId)
-                } else {
-                    await self.action(action(newValue))
-                }
-            }
-        }
-    }
-    
-    @MainActor
-    public func bind<T>(_ keyPath: KeyPath<State, T>, cancelId: CancelId? = nil, action: @escaping @autoclosure () -> Action) -> Binding<T> {
-        bind(keyPath, cancelId: cancelId) { _ in action() }
-    }
-    
-    @MainActor
-    public func bind<T>(_ keyPath: KeyPath<State, T>, action: @escaping (T) -> SyncAction) -> Binding<T> {
-        Binding {
-            self.state[keyPath: keyPath]
-        } set: { newValue in
-            self.action(action(newValue))
-        }
-    }
-    
-    @MainActor
-    public func bind<T>(_ keyPath: KeyPath<State, T>, action: @escaping @autoclosure () -> SyncAction) -> Binding<T> {
-        bind(keyPath) { _ in action() }
-    }
-}
+import ReactorBase
 
 /// Property wrapper to get a binding to a state keyPath and a associated Action
 /// Can be used and behaves like the `@State` property wrapper
@@ -123,40 +88,4 @@ public struct ReactorView<Content: View, R: AsyncReactor>: View {
             .reactorLifecycle(definesLifecycle ? reactor : nil)
     }
 }
-
-private class LifecycleModel: ObservableObject {
-    let onDeinit: () -> Void
-    
-    init(onDeinit: @escaping () -> Void) {
-        self.onDeinit = onDeinit
-    }
-    
-    deinit {
-        onDeinit()
-    }
-}
-
-struct ReactorLifecycleCancel: ViewModifier {
-    @StateObject
-    private var model: LifecycleModel
-    
-    init(reactor: (any AsyncReactor)?) {
-        _model = StateObject(wrappedValue: LifecycleModel(onDeinit: {
-            reactor?.cancelLifecycleTasks()
-        }))
-    }
-    
-    func body(content: Content) -> some View {
-        content
-            .task {
-                // empty task because when not modifying the content at all, SwiftUI seems to optimise away the modifier
-            }
-    }
-}
-
-extension View {
-    public func reactorLifecycle(_ reactor: (any AsyncReactor)?) -> some View {
-        modifier(ReactorLifecycleCancel(reactor: reactor))
-    }
-}
 #endif

Sources/AsyncReactor/AsyncReactor.swift

@@ -6,130 +6,7 @@
 //
 
 import Foundation
+import ReactorBase
 
-@MainActor
 @dynamicMemberLookup
-public protocol AsyncReactor: ObservableObject {
-    associatedtype Action
-    associatedtype SyncAction = Never
-    associatedtype State
-    
-    var state: State { get }
-    
-    func action(_ action: Action) async
-    
-    func action(_ action: SyncAction)
-    
-    subscript<Value>(dynamicMember keyPath: KeyPath<State, Value>) -> Value { get }
-}
-
-extension AsyncReactor {
-    @MainActor
-    public func send(_ action: Action) {
-        Task { await self.action(action) }
-    }
-}
-
-extension AsyncReactor where SyncAction == Never {
-    public func action(_ action: SyncAction) {
-        
-    }
-}
-
-// MARK: - DynamicMemberLookup
-
-extension AsyncReactor {
-    @MainActor
-    public subscript<Value>(dynamicMember keyPath: KeyPath<State, Value>) -> Value {
-        state[keyPath: keyPath]
-    }
-}
-
-// MARK: - Cancellation Support
-
-public struct CancelId: Hashable {
-    let id: AnyHashable
-    let mode: Mode
-    
-    public init(id: AnyHashable, mode: Mode) {
-        self.id = id
-        self.mode = mode
-    }
-    
-    public struct Mode: OptionSet, Hashable {
-        public let rawValue: Int
-        
-        public init(rawValue: Int) {
-            self.rawValue = rawValue
-        }
-        
-        public static let lifecycle = Mode(rawValue: 1 << 0)
-        public static let inFlight  = Mode(rawValue: 1 << 1)
-    }
-}
-
-private struct TasksHolder {
-    @MainActor
-    static var tasks = [TaskKey: Task<Void, Never>]()
-}
-
-private struct TaskKey: Hashable {
-    let reactorId: ObjectIdentifier
-    let id: CancelId
-    
-    init(reactor: AnyObject, id: CancelId) {
-        reactorId = ObjectIdentifier(reactor)
-        self.id = id
-    }
-}
-
-extension AsyncReactor {
-    @MainActor
-    public func action(_ action: Action, id: CancelId) async {
-        let key = TaskKey(reactor: self, id: id)
-        
-        if id.mode.contains(.inFlight) {
-            TasksHolder.tasks[key]?.cancel()
-        }
-        
-        let task = Task {
-            await self.action(action)
-        }
-        
-        TasksHolder.tasks[key] = task
-        
-        await task.value
-        
-        if !task.isCancelled {
-            TasksHolder.tasks.removeValue(forKey: key)
-        }
-    }
-    
-    public func send(_ action: Action, id: CancelId) {
-        Task { await self.action(action, id: id) }
-    }
-    
-    public func lifecycleTask(_ action: @escaping @Sendable () async -> Void) {
-        Task { @MainActor in
-            let key = TaskKey(reactor: self, id: .init(id: UUID(), mode: .lifecycle))
-            
-            let task = Task.detached {
-                await action()
-                await MainActor.run { _ = TasksHolder.tasks.removeValue(forKey: key) }
-            }
-            
-            TasksHolder.tasks[key] = task
-        }
-    }
-    
-    public func cancelLifecycleTasks() {
-        Task { @MainActor in
-            let keys = TasksHolder.tasks.keys.filter { $0.id.mode.contains(.lifecycle) && $0.reactorId == ObjectIdentifier(self) }
-            
-            for key in keys {
-                TasksHolder.tasks[key]?.cancel()
-                TasksHolder.tasks.removeValue(forKey: key)
-            }
-        }
-    }
-}
+public protocol AsyncReactor: ObservableObject, ReactorBase {}