Throw when writing inconsistent query/data to InMemoryCache. #6055
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
benjamn
force-pushed
the
error-on-invalid-cache-writes
branch
from
0c4a6ef
to
05c5fee
Compare
The changes in src/cache/inmemory/writeToStore.ts make it an error rather than just a warning to write a result into the InMemoryCache with missing data fields, addressing an old TODO that was grandfathered into the StoreWriter class. This will be a *breaking change* for any code that was previously ignoring the warning, which means this change is appropriate for Apollo Client 3.0, but likely will not require any migration steps for most applications. While updating the relevant tests, I realized that the withWarning pattern could (and should) be eliminated.
benjamn
force-pushed
the
error-on-invalid-cache-writes
branch
from
05c5fee
to
7282a5b
Compare
benjamn
commented
Mar 16, 2020
Comment on lines
-240
to
-243
| // XXX We'd like to throw an error, but for backwards compatibility's sake | ||
| // we just print a warning for the time being. | ||
| //throw new WriteError(`Missing field ${resultFieldKey} in ${JSON.stringify(result, null, 2).substring(0, 100)}`); | ||
| invariant.warn( |
There was a problem hiding this comment.
Here's the old // XXX comment that this PR addresses.
Codecov Report
@@ Coverage Diff @@
## master #6055 +/- ##
==========================================
+ Coverage 95.37% 95.42% +0.04%
==========================================
Files 88 88
Lines 3658 3650 -8
Branches 863 891 +28
==========================================
- Hits 3489 3483 -6
+ Misses 148 146 -2
Partials 21 21
Continue to review full report at Codecov.
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The changes in
src/cache/inmemory/writeToStore.tsmake it an error rather than just a warning to write a result into theInMemoryCachewith missing data fields, addressing an old// XXXcomment that was grandfathered into theStoreWriterclass.This will be a breaking change for any code that was previously ignoring the warning, which means this change is appropriate for Apollo Client 3.0, but likely will not require any migration steps for most applications.
While updating the relevant tests, I realized that the
withWarningpattern could (and should) be eliminated.