Check the version of the state object #587
Merged
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
Drop the previously saved state if the version is different This is a crude way to handle state migrations. I'd like to think this through more, but at least there are no startup errors when you upgrade versions now.
jameskerr
changed the title
jameskerr
commented
Apr 9, 2020
| @@ -5,7 +5,12 @@ import throttle from "lodash/throttle" | |||
|
|
|||
| import type {State} from "../state/types" | |||
|
|
|||
| export const VERSION = "5" | |||
| export const VERSION = "6" | |||
There was a problem hiding this comment.
This version string is just an arbitrary number, not tied to our app versions in any way.
There was a problem hiding this comment.
Both the global reducer and the window reducer import this same constant.
jameskerr
commented
Apr 9, 2020
| import globalReducer, {type GlobalState} from "./globalReducer" | ||
|
|
||
| export default function(initialState: GlobalState | void) { | ||
| export default function(prevState: GlobalState | void) { | ||
| let initState = isCurrentVersion(prevState) ? prevState : undefined |
There was a problem hiding this comment.
I figure it was best to let each store creation be responsible for dealing with its version.
mason-fish
approved these changes
Apr 9, 2020
|
@mason-fish Yes, that is the plan for the time being. |
Closed
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.
Drop the previously saved state if the version is different
This is a crude way to handle state migrations. I'd like to
think this through more, but at least there are no startup
errors when you upgrade versions now.
Going forward, we'll need to increment this VERSION string each time we mess with the shape of the state.
I think it would be good to write a test that does some of the common operations on the redux store, the saves the resulting state in a snapshot. Then each time we make changes to the state shape, hopefully that test will fail with a message like "update the state version".
Depending on how critical it is for users to save state, like their history and in the future, their saved queries. We may want to write more code to migrate data and what not.
fixes #584