Fix misc hydration bugs - #9157
Merged
Merged
Conversation
* Do not hydrate older promises * Do not infinite loop on hydrating failed promises * Hydrate already resolved promises immediately
|
View your CI Pipeline Execution ↗ for commit fd7a6e0.
☁️ Nx Cloud last updated this comment at |
Ephem
marked this pull request as draft
May 16, 2025 15:26
* Include dehydratedAt and ignore hydrating old promises * This is an approximation of dataUpdatedAt, but is not perfect * Refactor checks for if we should hydrate promises or not to fix infinite loop bug on failed queries * Hydrate already resolved promises synchronously
Ephem
force-pushed
the
fredrik/fix-hydration-bugs
branch
from
May 16, 2025 16:14
27d8d67 to
13c3232
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #9157 +/- ##
===========================================
+ Coverage 45.00% 59.46% +14.46%
===========================================
Files 206 138 -68
Lines 8219 5482 -2737
Branches 1836 1471 -365
===========================================
- Hits 3699 3260 -439
+ Misses 4080 1925 -2155
+ Partials 440 297 -143 🚀 New features to boost your workflow:
|
Ephem
marked this pull request as ready for review
May 16, 2025 17:20
TkDodo
reviewed
May 21, 2025
Comment on lines
+101
to
+102
| // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition | ||
| ?.catch(() => {}) |
Collaborator
There was a problem hiding this comment.
using noop from query-core should get rid of the eslint-disable:
Suggested change
| // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition | |
| ?.catch(() => {}) | |
| ?.catch(noop) |
Collaborator
Author
There was a problem hiding this comment.
It doesn't get rid of the lint warning unfortunately, that's warning about the "unnecessary" ?. here (this is typed as a promise, but might be a kind of thenable without .catch).
Still a good idea to use the noop, and I updated the comment to mention .catch specifically to make it a tiny bit clearer.
|
Is this going to be a part of next release? |
Collaborator
|
It's already released |
1 task
blitzy Bot
pushed a commit
to blitzy-research/query
that referenced
this pull request
Jul 21, 2026
… branch (P4-1) The whole-client hydrate() new-query build branch forced `status: data !== undefined ? 'success' : state.status`, which silently rewrote a restored error-with-data snapshot (a refetch error) or a pending-with-data snapshot into a clean 'success'. This dropped the persisted error/pending status and made `isRefetchError` false on restore, diverging from the fine-grained one-at-a-time (Query.fetch adoption) and bulk (restoreQueries) restore paths, which both adopt the persisted status verbatim. Fix: only force 'success' when the snapshot carried no data of its own (`state.data === undefined`) but a resolved streamed promise supplied `data` (preserving the TanStack#9157 resolved-promise behavior); otherwise preserve the persisted `state.status`. This makes all three restore paths deterministic (R2) and keeps full observable state on restore (R1/R4), applying to every status value (C2). Adds an isolated, add-only regression test (C7) covering error-with-data -> refetch error, pending-with-data -> pending, error-without-data, success control, and a streamed-promise pending -> success guard. Addresses QA finding P4-1 (Final Acceptance report).
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR:
At the point of hydrating a promise, we don't know when the promise will finish, that is, we don't know the
dataUpdatedAtof the hydrated query, so we can't compare that to the existing query. The PR sidesteps this by introducingdehydratedAtas an approximation. This is not perfect, but is an improvement.To fix the infinite loop bug I also opted to never hydrate promises if the existing query is already pending, as there is no way to know which of these pending queries will finish first or have the newest data. We could do fancier things like a
Promise.raceand use whatever finishes first, but that seemed like overengineering at this point.