Allow missing __typename if field added by addTypenameToDocument. #5787
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
Solves #5781 by keeping data written by cache.writeData from appearing incomplete just because it does not have __typename fields that were not explicitly present in the original query. Since InMemoryCache#transformDocument is responsible for adding these __typename fields automatically, it makes sense for the StoreReader belonging to the InMemoryCache to detect and ignore those fields later, rather than handling this somewhere else, like the QueryManager#transform method, where transformDocument is called. @hwillson Another way of looking at this issue is that this bit of code in the queryListenerForObserver callback is mishandling "incomplete" data, as we've observed before: const resultFromStore: ApolloQueryResult<T> = { data: stale ? lastResult && lastResult.data : data, ... The changes in this commit work around the problem by removing a category of __typename-related reasons why stale might be true here, but I think we still need to decide what staleness should mean for this logic.
benjamn
commented
Jan 13, 2020
| @@ -681,8 +681,15 @@ describe('Writing cache data from resolvers', () => { | |||
| console.warn = originalWarn; | |||
|
|
|||
| cache.writeData({ | |||
| id: '$ROOT_QUERY.obj', | |||
| data: { field: { field2: 2, __typename: 'Field' } }, | |||
There was a problem hiding this comment.
This test began displaying a warning as a result of these changes, but I noticed it was incorrectly using the old generated ID style with $ROOT_QUERY.obj, so it was not really testing what it claimed to be testing. Fixing that problem silenced the warning.
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.
Solves #5781 by keeping data written by
cache.writeDatafrom appearing incomplete just because it does not have__typenamefields that were not explicitly present in the original query.Since
InMemoryCache#transformDocumentis responsible for adding these__typenamefields automatically, it makes sense for theStoreReaderbelonging to theInMemoryCacheto detect and ignore those fields later, rather than handling this somewhere else, such as theQueryManager#transformmethod, wheretransformDocumentis called.@hwillson Another way of looking at this issue is that this bit of code in the
queryListenerForObservercallback is mishandling "incomplete" data, as we've observed before:The changes in this commit work around the problem by removing a category of
__typename-related reasons whystalemight be true here, but I think we still need to decide what staleness should mean for this logic.