Changed typings of updateQuery's previousQueryResult to be potentially undefined #12276
+45
−18
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
👷 Deploy request for apollo-client-docs pending review.Visit the deploys page to approve it
|
✅ Docs preview has no changesThe preview was not built because there were no changes. Build ID: 126f5a5c81a60f85bbd31129 |
🦋 Changeset detectedLatest commit: 6af8e64 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Cellule
force-pushed
the
update-query-typings
branch
from
3a4c44f to
d9cfe5d
Compare
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.
Related to #12228
There's an outstanding issue where
previousQueryResultsometimes, flakily, ends upundefinedThis change aims to have the typings reflect the actual runtime behavior allowing devs to write safe code that can handle the missing
previousQueryResultAn alternative could be to simply not call
mapFnifpreviousQueryResultis missing. While neither is ideal nor fixes the underlying issue of "why"previousQueryResultisundefined. At least it would avoid bad crashes.I've been rolling with this patch for years now and I haven't seen any bad side-effects so far. As far as I can tell, the case where
previousQueryResultcan be safely ignored and is likely going to be called again with actual data when it mattersTypings Update for
updateQuery:updateQuery'spreviousQueryResultto be potentially undefined in@apollo/client.updateQuerymethod insrc/core/ObservableQuery.tsto reflect the new typings.UpdateQueryFntype insrc/core/watchQueryOptions.tsto allowpreviousQueryResultto be undefined.ObservableQueryFieldsinterface insrc/react/types/types.tsto reflect the new typings.VSCode Configuration:
editor.codeActionsOnSavesetting to disable organizing imports on save in.vscode/settings.json.