feat: add Effect.observe for @Observable store observation#6
Merged
Conversation
Add ObservationHelpers.swift to the library with two public APIs: - Effect.observe(_:keyPath:name:priority:handler:) — observes a key path on an @observable object passed directly. Returns a named, cancellable task effect. - Effect.observe(_envKeyPath:keyPath:name:priority:handler:) — env key path overload; resolves the object from Env inside the task, so nothing is captured at update time. - observeKeyPath(_:keyPath:handler:) — free function for use inside custom .task effects. On macOS/iOS 26+ uses Observations.untilFinished (structured, cooperative cancellation). On earlier OS versions falls back to recursive withObservationTracking. KeyPath sendability is handled internally via a private SendableKeyPath<Root, Value>: @unchecked Sendable wrapper, so callers require no SE-0418 flag and no & Sendable annotation. Package.swift: enable InferSendableFromCaptures for both targets. README.md: update Recipes section with the Observe an external @observable store recipe, covering both overloads. Add RemoteCounter example demonstrating the pattern: a @mainactor CounterStore observed via .observe(\.store, keyPath: \.count), with all writes going through the store's own event API. Add Documentation/ArchitecturalComparison.md comparing EffectView against MVVM, Redux, TCA, Elm, and Elixir/GenServer across state model, effect model, task lifecycle, dispatch semantics, and testability.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add ObservationHelpers.swift to the library with two public APIs:
Effect.observe(_:keyPath:name:priority:handler:) — observes a key path on an @observable object passed directly. Returns a named, cancellable task effect.
Effect.observe(_envKeyPath:keyPath:name:priority:handler:) — env key path overload; resolves the object from Env inside the task, so nothing is captured at update time.
observeKeyPath(_:keyPath:handler:) — free function for use inside custom .task effects.
On macOS/iOS 26+ uses Observations.untilFinished (structured, cooperative cancellation). On earlier OS versions falls back to recursive withObservationTracking. KeyPath sendability is handled internally via a private SendableKeyPath<Root, Value>: @unchecked Sendable wrapper, so callers require no SE-0418 flag and no & Sendable annotation.
Package.swift: enable InferSendableFromCaptures for both targets.
README.md: update Recipes section with the Observe an external @observable store recipe, covering both overloads.
Add RemoteCounter example demonstrating the pattern: a @mainactor CounterStore observed via .observe(.store, keyPath: .count), with all writes going through the store's own event API.
Add Documentation/ArchitecturalComparison.md comparing EffectView against MVVM, Redux, TCA, Elm, and Elixir/GenServer across state model, effect model, task lifecycle, dispatch semantics, and testability.