|
| 1 | +import { PassThrough } from "node:stream"; |
| 2 | + |
| 3 | +import type { AppLoadContext, EntryContext } from "@remix-run/node"; |
| 4 | +import { createReadableStreamFromReadable } from "@remix-run/node"; |
| 5 | +import { RemixServer } from "@remix-run/react"; |
| 6 | +import { config } from "dotenv"; |
| 7 | +import * as isbotModule from "isbot"; |
| 8 | +import { renderToPipeableStream } from "react-dom/server"; |
| 9 | + |
| 10 | +// Load .env variables |
| 11 | +config(); |
| 12 | + |
| 13 | +const ABORT_DELAY = 5_000; |
| 14 | + |
| 15 | +export default function handleRequest( |
| 16 | + request: Request, |
| 17 | + responseStatusCode: number, |
| 18 | + responseHeaders: Headers, |
| 19 | + remixContext: EntryContext, |
| 20 | + loadContext: AppLoadContext, |
| 21 | +) { |
| 22 | + const prohibitOutOfOrderStreaming = |
| 23 | + isBotRequest(request.headers.get("user-agent")) || remixContext.isSpaMode; |
| 24 | + |
| 25 | + return prohibitOutOfOrderStreaming |
| 26 | + ? handleBotRequest( |
| 27 | + request, |
| 28 | + responseStatusCode, |
| 29 | + responseHeaders, |
| 30 | + remixContext, |
| 31 | + ) |
| 32 | + : handleBrowserRequest( |
| 33 | + request, |
| 34 | + responseStatusCode, |
| 35 | + responseHeaders, |
| 36 | + remixContext, |
| 37 | + ); |
| 38 | +} |
| 39 | + |
| 40 | +// We have some Remix apps in the wild already running with isbot@3 so we need |
| 41 | +// to maintain backwards compatibility even though we want new apps to use |
| 42 | +// isbot@4. That way, we can ship this as a minor Semver update to @remix-run/dev. |
| 43 | +function isBotRequest(userAgent: string | null) { |
| 44 | + if (!userAgent) { |
| 45 | + return false; |
| 46 | + } |
| 47 | + |
| 48 | + // isbot >= 3.8.0, >4 |
| 49 | + if ("isbot" in isbotModule && typeof isbotModule.isbot === "function") { |
| 50 | + return isbotModule.isbot(userAgent); |
| 51 | + } |
| 52 | + |
| 53 | + // isbot < 3.8.0 |
| 54 | + if ("default" in isbotModule && typeof isbotModule.default === "function") { |
| 55 | + return isbotModule.default(userAgent); |
| 56 | + } |
| 57 | + |
| 58 | + return false; |
| 59 | +} |
| 60 | + |
| 61 | +function handleBotRequest( |
| 62 | + request: Request, |
| 63 | + responseStatusCode: number, |
| 64 | + responseHeaders: Headers, |
| 65 | + remixContext: EntryContext, |
| 66 | +) { |
| 67 | + return new Promise((resolve, reject) => { |
| 68 | + let shellRendered = false; |
| 69 | + const { pipe, abort } = renderToPipeableStream( |
| 70 | + <RemixServer |
| 71 | + context={remixContext} |
| 72 | + url={request.url} |
| 73 | + abortDelay={ABORT_DELAY} |
| 74 | + />, |
| 75 | + { |
| 76 | + onAllReady() { |
| 77 | + shellRendered = true; |
| 78 | + const body = new PassThrough(); |
| 79 | + const stream = createReadableStreamFromReadable(body); |
| 80 | + |
| 81 | + responseHeaders.set("Content-Type", "text/html"); |
| 82 | + |
| 83 | + resolve( |
| 84 | + new Response(stream, { |
| 85 | + headers: responseHeaders, |
| 86 | + status: responseStatusCode, |
| 87 | + }), |
| 88 | + ); |
| 89 | + |
| 90 | + pipe(body); |
| 91 | + }, |
| 92 | + onShellError(error: unknown) { |
| 93 | + reject(error); |
| 94 | + }, |
| 95 | + onError(error: unknown) { |
| 96 | + responseStatusCode = 500; |
| 97 | + // Log streaming rendering errors from inside the shell. Don't log |
| 98 | + // errors encountered during initial shell rendering since they'll |
| 99 | + // reject and get logged in handleDocumentRequest. |
| 100 | + if (shellRendered) { |
| 101 | + console.error(error); |
| 102 | + } |
| 103 | + }, |
| 104 | + }, |
| 105 | + ); |
| 106 | + |
| 107 | + setTimeout(abort, ABORT_DELAY); |
| 108 | + }); |
| 109 | +} |
| 110 | + |
| 111 | +function handleBrowserRequest( |
| 112 | + request: Request, |
| 113 | + responseStatusCode: number, |
| 114 | + responseHeaders: Headers, |
| 115 | + remixContext: EntryContext, |
| 116 | +) { |
| 117 | + return new Promise((resolve, reject) => { |
| 118 | + let shellRendered = false; |
| 119 | + const { pipe, abort } = renderToPipeableStream( |
| 120 | + <RemixServer |
| 121 | + context={remixContext} |
| 122 | + url={request.url} |
| 123 | + abortDelay={ABORT_DELAY} |
| 124 | + />, |
| 125 | + { |
| 126 | + onShellReady() { |
| 127 | + shellRendered = true; |
| 128 | + const body = new PassThrough(); |
| 129 | + const stream = createReadableStreamFromReadable(body); |
| 130 | + |
| 131 | + responseHeaders.set("Content-Type", "text/html"); |
| 132 | + |
| 133 | + resolve( |
| 134 | + new Response(stream, { |
| 135 | + headers: responseHeaders, |
| 136 | + status: responseStatusCode, |
| 137 | + }), |
| 138 | + ); |
| 139 | + |
| 140 | + pipe(body); |
| 141 | + }, |
| 142 | + onShellError(error: unknown) { |
| 143 | + reject(error); |
| 144 | + }, |
| 145 | + onError(error: unknown) { |
| 146 | + responseStatusCode = 500; |
| 147 | + // Log streaming rendering errors from inside the shell. Don't log |
| 148 | + // errors encountered during initial shell rendering since they'll |
| 149 | + // reject and get logged in handleDocumentRequest. |
| 150 | + if (shellRendered) { |
| 151 | + console.error(error); |
| 152 | + } |
| 153 | + }, |
| 154 | + }, |
| 155 | + ); |
| 156 | + |
| 157 | + setTimeout(abort, ABORT_DELAY); |
| 158 | + }); |
| 159 | +} |
0 commit comments