fix: gracefully ignore bad JSON in localstorage #385
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
Don't crash (catch the exception) if the localstorage value does not contain valid JSON.
tvanier
reviewed
Dec 13, 2019
| @@ -44,13 +44,13 @@ function get(key) { | |||
| if (!isLocalStorageSupported) return | |||
| try { | |||
| var value = window.localStorage[`${NAMESPACE}.${key}`] | |||
|
|
|||
| if (value) { | |||
| return JSON.parse(value) | |||
There was a problem hiding this comment.
Could/should it be _JSON like in the set function?
There was a problem hiding this comment.
I think that _JSON should be removed entirely; not sure why it's there.
tvanier
reviewed
Dec 13, 2019
| @@ -44,13 +44,13 @@ function get(key) { | |||
| if (!isLocalStorageSupported) return | |||
| try { | |||
| var value = window.localStorage[`${NAMESPACE}.${key}`] | |||
|
|
|||
| if (value) { | |||
| return JSON.parse(value) | |||
There was a problem hiding this comment.
Could/should it be _JSON like in the set function?
tvanier
reviewed
Dec 13, 2019
|
|
||
| if (value) { | ||
| return JSON.parse(value) | ||
| } |
There was a problem hiding this comment.
Catch as much as possible?
function get(key) {
try {
if (getter) {
return getter(key)
}
if (!isLocalStorageSupported) return
var value = window.localStorage[`${NAMESPACE}.${key}`]
if (value) {
return _JSON.parse(value)
}
} catch (e) {
return
}
}There was a problem hiding this comment.
This seems like a good idea given that on some environments (e.g. iOS Safari in "no cookies" mode) localStorage throws an error if you try to access it.
|
LGTM! Thanks |
Merged
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.
Background
We were previously using an Angular port of emoji-mart, then we migrated our application to React, and began using the original emoji-mart. That port used the
emoji-mart.lastlocalstorage item slightly differently, by not JSON-encoding it. After the migration, our app would crash while rendering emoji-mart, as it attempted to parse the stale value from our users' localstorage.Changes
This PR changes the store's behaviour to discard invalid JSON values instead of raising an error through
JSON.parse. That way, if those values ever become corrupt or otherwise invalid for some reason, things like recent emoji just get forgotten, instead of the app inexplicably crashing.