Deprecate Refreshable and Resettable #185
Merged
Conversation
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
ra1028
force-pushed
the
deprecate-refreshable-resettable
branch
from
7fbd2b2 to
27775aa
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR deprecates the Refreshable and Resettable functionality by adding @available deprecation attributes throughout the codebase. The key changes include:
- Adding deprecation annotations to test atoms and production APIs.
- Removing Refreshable and Resettable conformance from certain test types.
- Updating API documentation and error messages to reflect the removal of these behaviors.
Reviewed Changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| Tests/AtomsTests/Utilities/TestAtom.swift | Added deprecation annotations for test atoms using Refreshable/Resettable. |
| Tests/AtomsTests/Core/StoreContextTests.swift | Removed Refreshable and Resettable conformance in test Atom and updated tests accordingly. |
| Tests/AtomsTests/Context/AtomViewContextTests.swift | Marked custom refresh/reset tests as deprecated. |
| Tests/AtomsTests/Context/AtomTransactionContextTests.swift | Marked custom refresh/reset tests as deprecated. |
| Tests/AtomsTests/Context/AtomTestContextTests.swift | Marked custom refresh/reset tests as deprecated. |
| Tests/AtomsTests/Context/AtomCurrentContextTests.swift | Marked custom refresh/reset tests as deprecated. |
| Sources/Atoms/Core/StoreContext.swift | Added deprecation annotations for refresh and reset methods. |
| Sources/Atoms/Context/AtomViewContext.swift | Added deprecation annotations for refresh and reset methods with a custom deprecation message. |
| Sources/Atoms/Context/AtomTransactionContext.swift | Added deprecation annotations for refresh and reset methods with a custom deprecation message. |
| Sources/Atoms/Context/AtomTestContext.swift | Added deprecation annotations for refresh and reset methods with a custom deprecation message. |
| Sources/Atoms/Context/AtomCurrentContext.swift | Added deprecation annotations for refresh and reset methods with a custom deprecation message. |
| Sources/Atoms/Context/AtomContext.swift | Added deprecation annotations for refresh and reset methods with a custom deprecation message. |
| Sources/Atoms/Attribute/Resettable.swift | Deprecated the Resettable protocol with a message advising a custom reset function alternative. |
| Sources/Atoms/Attribute/Refreshable.swift | Deprecated the Refreshable protocol with a message advising a custom refresh function alternative. |
ra1028
force-pushed
the
deprecate-refreshable-resettable
branch
from
27775aa to
3f09f37
Compare
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.
Pull Request Type
Description
With the introduction of
AsyncPhaseAtom, there is not so much demand to make it possible to define atoms that wrap other atoms. Now that the cost of maintaining the stability and code maintainability of theRefreshableandResettablebehavior is no longer worth their convenience, they're being deprecated in this version and removed in the next version.