Ensures observers receive correct initial value #24
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.
Description
The changes in this PR ensure that observers installed with
spiceStore.$myValue.sink { ... }
receive the correct value upon subscribing rather than the default value of the spice.The value can only be provided when the spice store has been prepared, which happens automatically when reading or writing the value of a spice (e.g.,
_ = spiceStore.myValue
orspiceStore.myValue = newValue
), but not when accessing the projected value (spiceStore.$myValue
).As a result,
prepareIfNeeded()
has been made public, enabling users of Spices to call the function prior to setting up an observer. This is only needed once.In order to enforce that
prepareIfNeeded()
is called,projectedValue
on a Spice will assert if the underlying storage has not been prepared.Motivation and Context
Prior to these changes, observers set up with
spiceStore.$myValue
would receive an incorrect value upon subscribing.Screenshots (if appropriate):
Types of changes