feat(server): reset scheduleSearch only after all components mount #6650
Conversation
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
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 8d69685:
|
Haroenv
changed the title
because we're in ssr, there's no notion of eg useEffect and we also don't search twice
Haroenv
commented
Jun 12, 2025
| defer(() => { | ||
| this.scheduleSearch = originalScheduleSearch; | ||
| })(); | ||
| if (this._manuallyResetScheduleSearch) { |
There was a problem hiding this comment.
I think it would be nicer if this is required, but for now I didn't find a good way in Vue InstantSearch to call this, also it would be a breaking change.
Haroenv
requested review from
a team,
aymeric-giraudet and
shaejaz
and removed request for
a team
Haroenv
changed the title
aymeric-giraudet
approved these changes
Jun 16, 2025
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.
In Remix a bug was reported CR-8629, which said that there's an edge case happening where (not always) the hydrating DOM does not match the server DOM. This is caused by InfiniteHits that does not give hits if we are currently searching. Why are we searching? Because the
scheduleSearchfunction is reset before all widgets are mounted. Until now we rely ondeferto reset the function only once all widgets are mounted, but that's not reliable.The solution: reset
scheduleSearchonly after thechildrenof theInstantSearchcomponent have been mounted. For that two new private properties are added to InstantSearch:_manuallyResetScheduleSearch(set in the useInstantSearchApi hook wheninitialResultsare set) and a new function_resetScheduleSearch. We call this function if it exists after children have been mounted.In this test I've updated the InitializePromise synthetic test, as it was using
renderfrom testing-library/react, which evaluates effects, which in real server environments doesn't happen.