This repository has been archived by the owner on Dec 30, 2022. It is now read-only.
feat(getServerState): allow users to inject renderToString #3658
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
There are some cases where the combination of trying to make sure renderToString doesn't end up in a browser bundle, being runnable on esm + cjs, react 17 and 18, .js extension etc. blows up. One of those is pnpm caching removing "unused" packages.
This PR introduces a new argument `renderToString` to `getServerState` so you can inject the dependency yourself, meaning the import is within your own code and won't be purged.
```js
import { renderToString } from 'react-dom/server';
await getServerState(<App/>, renderToString);
await getServerState(<App/>, import('react-dom/server').then(mod => mod.renderToString));
```
fixes #3633
closes #3618
see vercel/next.js#40067
Haroenv
requested review from
a team,
dhayab and
aymeric-giraudet
and removed request for
a team
|
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 8a21a6f:
|
✅ Deploy Preview for react-instantsearch ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
aymeric-giraudet
approved these changes
Oct 19, 2022
|
Don't we want to be more cautious and have it in a param object? await getServerState(<App/>, { renderToString }); |
dhayab
reviewed
Oct 19, 2022
| import type { | ||
| InstantSearchServerContextApi, | ||
| InstantSearchServerState, | ||
| } from 'react-instantsearch-hooks'; | ||
|
|
||
| type SearchRef = { current: InstantSearch | undefined }; | ||
|
|
||
| export type RenderToString = (element: JSX.Element) => unknown; |
There was a problem hiding this comment.
Suggested change
| export type RenderToString = (element: JSX.Element) => unknown; | |
| export type RenderToString = (element: JSX.Element) => string; |
There was a problem hiding this comment.
I left unknown as you should be able to use this argument with renderToStream or something as well, because we don't use the string
There was a problem hiding this comment.
renderToReadableStream() will probably create issues for example. But as long as its typed as a synchronous method it should be fine indeed.
There was a problem hiding this comment.
I was more thinking if there's in theory another method that traverses the tree, but doesn't render, it is also sufficient for this method
packages/react-instantsearch-hooks-server/src/getServerState.tsx
Outdated
Show resolved
Hide resolved
packages/react-instantsearch-hooks-server/src/__tests__/modules-none.test.tsx
Outdated
Show resolved
Hide resolved
packages/react-instantsearch-hooks-server/src/__tests__/modules-none.test.tsx
Outdated
Show resolved
Hide resolved
francoischalifour
approved these changes
Oct 20, 2022
packages/react-instantsearch-hooks-server/src/__tests__/modules-none.test.tsx
Outdated
Show resolved
Hide resolved
…s-none.test.tsx Co-authored-by: François Chalifour <francoischalifour@users.noreply.github.com>
dhayab
approved these changes
Oct 20, 2022
Haroenv
added a commit
that referenced
this pull request
Oct 20, 2022
Followup on #3658, to be merged close to the release
Haroenv
added a commit
to algolia/doc-code-samples
that referenced
this pull request
Oct 20, 2022
follow up on algolia/react-instantsearch#3658 to be merged once this is released
Haroenv
added a commit
that referenced
this pull request
Oct 20, 2022
Followup on #3658, to be merged close to the release EDIT: actually this can be merged before the release already as previously the unused argument wasn't used
Haroenv
added a commit
to algolia/doc-code-samples
that referenced
this pull request
Oct 25, 2022
follow up on algolia/react-instantsearch#3658 to be merged once this is released
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.
Summary
There are some cases where the combination of trying to make sure renderToString doesn't end up in a browser bundle, being runnable on esm + cjs, react 17 and 18, .js extension etc. blows up.
One of those is pnpm/vercel removing "unused" packages.
Result
This PR introduces a new argument
renderToStringtogetServerStateso you can inject the dependency yourself, meaning the import is within your own code and won't be purged.fixes #3633
closes #3618
see vercel/next.js#40067
FX-1869