fix: prevent chrome storage resolving before entries are set #126
+82
−9
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
sameerank
commented
Dec 13, 2024
| chrome.storage.onChanged.removeListener(listener); | ||
| applicationLogger.warn('Chrome storage write timeout for key:', key); | ||
| resolve(); | ||
| }, 1000); |
There was a problem hiding this comment.
One second is probably too long, but we also never expect to end up in this situation of needing the timeout. It's a precaution
sameerank
commented
Dec 14, 2024
| (mockStorage.set as jest.Mock).mockResolvedValue(undefined); | ||
|
|
||
| // Start the set operation | ||
| const setPromise = storageMap.set(key, value); |
There was a problem hiding this comment.
This isn't exactly what I am hoping to test since the set operation isn't in progress, and I'm interested in testing that an entry hasn't been written yet between the time that the operation started and onChange was fired. I couldn't figure out how to write such a test.
sameerank
commented
Dec 14, 2024
|
|
||
| public constructor(private storageEngine: IStringStorageEngine, private cooldownSeconds = 0) {} | ||
|
|
||
| public isInitialized(): boolean { | ||
| return this.initialized; | ||
| } | ||
|
|
||
| public isInProcessOfInitializing(): boolean { |
There was a problem hiding this comment.
TODO add isInProcessOfInitializing to the IAsyncStore interface
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.
labels: mergeable
Fixes: #issue
Motivation and Context
We had a hypothesis in a debugging session that
await this.storage.setmay be resolving when the writing process starts, instead of when it finishes writing the fetched flags to storage and that this may be an idiosyncratic behavior of the Chrome storage implementation. If true, this could result in inconsistent, null assignments on application start if get assignment is called immediately afterawait initDescription
This is a draft of using an
isInProcessOfInitializingmethod to wait before deciding if the store is usableHow has this been tested?