-
Notifications
You must be signed in to change notification settings - Fork 263
fix(web): move react-router deps to devDependencies #1265
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@workflow/web": patch | ||
| --- | ||
|
|
||
| Add custom `entry.server.tsx` and move `@react-router/node`, `isbot`, `react-router`, and `@react-router/express` to devDependencies since the build process bundles them entirely at build time |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| import { PassThrough } from 'node:stream'; | ||
| import { createReadableStreamFromReadable } from '@react-router/node'; | ||
| import { isbot } from 'isbot'; | ||
| import type { RenderToPipeableStreamOptions } from 'react-dom/server'; | ||
| import { renderToPipeableStream } from 'react-dom/server'; | ||
| import type { AppLoadContext, EntryContext } from 'react-router'; | ||
| import { ServerRouter } from 'react-router'; | ||
|
|
||
| export const streamTimeout = 5_000; | ||
|
|
||
| /** | ||
| * This custom base request handler is based on the default react-router template, modified so that the `@react-router/dev` build plugin no longer requires `@react-router/node` and `isbot` in the dependencies field of `package.json`, allowing us to extract them as peer dependencies. | ||
| */ | ||
| export default function handleRequest( | ||
| request: Request, | ||
| responseStatusCode: number, | ||
| responseHeaders: Headers, | ||
| routerContext: EntryContext, | ||
| loadContext: AppLoadContext | ||
| ) { | ||
| // https://httpwg.org/specs/rfc9110.html#HEAD | ||
| if (request.method.toUpperCase() === 'HEAD') { | ||
| return new Response(null, { | ||
| status: responseStatusCode, | ||
| headers: responseHeaders, | ||
| }); | ||
| } | ||
|
|
||
| return new Promise((resolve, reject) => { | ||
| let shellRendered = false; | ||
| const userAgent = request.headers.get('user-agent'); | ||
|
|
||
| // Ensure requests from bots and SPA Mode renders wait for all content to load before responding | ||
| // https://react.dev/reference/react-dom/server/renderToPipeableStream#waiting-for-all-content-to-load-for-crawlers-and-static-generation | ||
| const readyOption: keyof RenderToPipeableStreamOptions = | ||
| (userAgent && isbot(userAgent)) || routerContext.isSpaMode | ||
| ? 'onAllReady' | ||
| : 'onShellReady'; | ||
|
|
||
| // Abort the rendering stream after the `streamTimeout` so it has time to | ||
| // flush down the rejected boundaries | ||
| let timeoutId: ReturnType<typeof setTimeout> | undefined = setTimeout( | ||
| () => abort(), | ||
| streamTimeout + 1000 | ||
| ); | ||
|
|
||
| const { pipe, abort } = renderToPipeableStream( | ||
| <ServerRouter context={routerContext} url={request.url} />, | ||
| { | ||
| [readyOption]() { | ||
| shellRendered = true; | ||
| const body = new PassThrough({ | ||
| final(callback) { | ||
| // Clear the timeout to prevent retaining the closure and memory leak | ||
| clearTimeout(timeoutId); | ||
| timeoutId = undefined; | ||
| callback(); | ||
| }, | ||
| }); | ||
| const stream = createReadableStreamFromReadable(body); | ||
|
|
||
| responseHeaders.set('Content-Type', 'text/html'); | ||
|
|
||
| pipe(body); | ||
|
|
||
| resolve( | ||
| new Response(stream, { | ||
| headers: responseHeaders, | ||
| status: responseStatusCode, | ||
| }) | ||
| ); | ||
| }, | ||
| onShellError(error: unknown) { | ||
| reject(error); | ||
| }, | ||
| onError(error: unknown) { | ||
| responseStatusCode = 500; | ||
| // Log streaming rendering errors from inside the shell. Don't log | ||
| // errors encountered during initial shell rendering since they'll | ||
| // reject and get logged in handleDocumentRequest. | ||
| if (shellRendered) { | ||
| console.error(error); | ||
| } | ||
| }, | ||
| } | ||
| ); | ||
| }); | ||
| } | ||
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.