Cancel TestStore effects when root feature is dismissed
#3044
Conversation
This file contains 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
Right now, if a leaf feature is tested and it dismisses itself while effects are in-flight, the only way to get tests passing is to explicitly tell the store or any tasks returned by `store.send` to cancel. Further, you must use an expectation in such tests to assert that `dismiss` was called in the first place. This PR changes this behavior to automatically cancel a test store's effects if it is dismissed, and it prohibits sending more actions to it after dismiss has been called.
mbrandonw
approved these changes
May 2, 2024
cgrindel-self-hosted-renovate bot
added a commit
to cgrindel/rules_swift_package_manager
that referenced
this pull request
May 9, 2024
…ure to from: "1.10.3" (#1063) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [pointfreeco/swift-composable-architecture](https://togithub.com/pointfreeco/swift-composable-architecture) | patch | `from: "1.10.2"` -> `from: "1.10.3"` | --- ### Release Notes <details> <summary>pointfreeco/swift-composable-architecture (pointfreeco/swift-composable-architecture)</summary> ### [`v1.10.3`](https://togithub.com/pointfreeco/swift-composable-architecture/releases/tag/1.10.3) [Compare Source](https://togithub.com/pointfreeco/swift-composable-architecture/compare/1.10.2...1.10.3) #### What's Changed - Fixed: Automatically cancel in-flight `TestStore` effects when its root feature is dismissed ([pointfreeco/swift-composable-architecture#3044). - Fixed: Propagate current dependencies to `Store.init` ([pointfreeco/swift-composable-architecture#3049). - Fixed: Runtime warn when stack integration is detected to be missing from store's reducer ([pointfreeco/swift-composable-architecture#3048). - Fixed: `TestStore.finish()` should assert against unreceived actions ([pointfreeco/swift-composable-architecture#3054). - Fixed: Precondition when conflicting persistence keys must match value by [@​stephencelis](https://togithub.com/stephencelis) in [pointfreeco/swift-composable-architecture#3051. > **Important:** > If you have defined a custom persistence key, you may need to explicitly conform it to `Hashable` after upgrading to this version. - Fixed: `@Shared` no longer eagerly evaluates its initial value (thanks [@​seanmrich](https://togithub.com/seanmrich), [pointfreeco/swift-composable-architecture#3057). - Infrastructure: Added a brand new tutorial: Building SyncUps ([pointfreeco/swift-composable-architecture#3039). - Infrastructure: Add store invalidation test ([pointfreeco/swift-composable-architecture#3038). - Infrastructure: Document `@CasePathable @​dynamicMemberLookup` in 1.4 migration guide ([pointfreeco/swift-composable-architecture#3043). - Infrastructure: Document nested enum reducers ([pointfreeco/swift-composable-architecture#3050). #### New Contributors - [@​seanmrich](https://togithub.com/seanmrich) made their first contribution in [pointfreeco/swift-composable-architecture#3057 **Full Changelog**: pointfreeco/swift-composable-architecture@1.10.2...1.10.3 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://togithub.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4xMDkuNCIsInVwZGF0ZWRJblZlciI6IjM2LjEwOS40IiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: Self-hosted Renovate Bot <361546+cgrindel-self-hosted-renovate[bot]@users.noreply.github.enterprise.com>
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Right now, if a leaf feature is tested and it dismisses itself while effects are in-flight, the only way to get tests passing is to explicitly tell the store or any tasks returned by
store.sendto cancel. Further, you must use an expectation in such tests to assert thatdismisswas called in the first place.This PR changes this behavior to automatically cancel a test store's effects if it is dismissed, and it prohibits sending more actions to it after dismiss has been called.