Implement debugMode to verify container uses a backing field
#121
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
TWiStErRob
reviewed
Apr 19, 2023
| @@ -79,13 +79,14 @@ public interface Container<STATE : Any, SIDE_EFFECT : Any> { | |||
| * @property idlingRegistry The registry used by the container for signalling idling for UI tests | |||
| * @property intentDispatcher The dispatcher used for handling incoming [orbit] intents | |||
| * @property repeatOnSubscribedStopTimeout A delay (in milliseconds) between the disappearance of the last subscriber and | |||
| * the stopping of the repeatOnSubscribed block | |||
| * @property debugMode Enables additional guardrail checks | |||
There was a problem hiding this comment.
I would recommend branding this as StrictMode, the Fragment library also uses that pattern.
https://developer.android.com/reference/androidx/fragment/app/strictmode/FragmentStrictMode
| public fun <STATE : Any, SIDE_EFFECT : Any> ContainerHost<STATE, SIDE_EFFECT>.debugModeContainerHostVerification() { | ||
| if (container.settings.debugMode) { | ||
| // | ||
| if (container != container) { |
There was a problem hiding this comment.
Have you thought about a bundled lint check? I think it could check all the container() calls and check their PSI parent to be a property without a getter.
The benefit of that is contextual quick fix intentions in IDEA (Alt+Enter, Enter).
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.
Fixes #117
So the checks aren't duplicated I've had to make
debugModeContainerHostVerificationpublic.This PR only introduces a guardrail for ensuring
containeruses a backing field