Documentation for custom FieldPolicy read and merge functions. #5677
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
commented
Dec 12, 2019
This comment has been minimized.
This comment has been minimized.
benjamn
changed the base branch from
storage-and-invalidation-for-read-functions
to
release-3.0
benjamn
force-pushed
the
docs-for-custom-read-and-merge-functions
branch
from
273b30d to
0f8cf03
Compare
benjamn
force-pushed
the
docs-for-custom-read-and-merge-functions
branch
from
0ebaf8d to
c4625dd
Compare
benjamn
force-pushed
the
docs-for-custom-read-and-merge-functions
branch
2 times, most recently
from
933528f to
829f399
Compare
benjamn
added a commit
that referenced
this pull request
Jan 23, 2020
One consequence of #5603 is that replacing non-normalized data in the cache can result in loss of useful data. In almost every case, the right solution is to make sure the data can be normalized, or (if that isn't possible) to define a custom merge function for the replaced field, within the parent TypePolicy. It turns out we can give a very detailed warning in all such situations, so that's what this commit does. Looking at the output for our test suite, every warning is legitimate and worth fixing. I will resolve the warnings and test failures that our test suite generates in subsequent commits. TODO Update the documentation URLs after #5677 is merged.
4 tasks
The warnings mentioned in this section are TBD, because the warning message needs to be able to link to this documentation for further explanation.
benjamn
force-pushed
the
docs-for-custom-read-and-merge-functions
branch
from
7e66008 to
48fc3ba
Compare
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.
Now that we are finally firming up these APIs, after extensive research, experimentation, and subjective evaluation, I feel comfortable beginning to document them properly.