Repository navigation
fix(state): initialize maps omitted from the persisted state - #1117
Open
Vivek1106-04 wants to merge 1 commit into
Open
Vivek1106-04 wants to merge 1 commit into
Vivek1106-04 wants to merge 1 commit into
Conversation
ReadState on a state document that omits data, changes or tasks (for
example "{}") left those maps nil, so a later Set, NewTask or NewChange
panicked with an assignment to entry in nil map.
Fixes canonical#1017
This branch has not been deployed
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
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 #1017.
State.UnmarshalJSONassigned the decodedData,ChangesandTasksmaps directly, so a valid state document that omits them (for example{}) left those maps nil. A laterSet,NewTaskorNewChangethen panicked withassignment to entry in nil map.This initializes any of the three maps that are nil after decoding. Notices were already safe, since
unflattenNoticesalways makes a new map. The fix is inUnmarshalJSONrather thanReadState, so any path that decodes aStategets it.Testing
TestReadStateOmittedFields: reads{}and then callsSet,NewTask,NewChangeandAddTask. It panicked before the fix and passes after.go test -race ./internals/overlord/state/passes.