[Flight] Implement prerender

Prerendering in flight is similar to prerendering in Fizz. Instead of receiving a result (the stream) immediately a promise is returned which resolves to the stream when the prerender is complete. The promise will reject if the flight render fatally errors otherwise it will resolve when the render is completed or is aborted.

packages/react-client/src/forks/ReactFlightClientConfig.dom-browser-esm.js

@@ -9,7 +9,7 @@
 
 export * from 'react-client/src/ReactFlightClientStreamConfigWeb';
 export * from 'react-client/src/ReactClientConsoleConfigBrowser';
-export * from 'react-server-dom-esm/src/ReactFlightClientConfigBundlerESM';
-export * from 'react-server-dom-esm/src/ReactFlightClientConfigTargetESMBrowser';
+export * from 'react-server-dom-esm/src/client/ReactFlightClientConfigBundlerESM';
+export * from 'react-server-dom-esm/src/client/ReactFlightClientConfigTargetESMBrowser';
 export * from 'react-dom-bindings/src/shared/ReactFlightClientConfigDOM';
 export const usedWithSSR = false;

packages/react-client/src/forks/ReactFlightClientConfig.dom-browser-turbopack.js

@@ -9,8 +9,8 @@
 
 export * from 'react-client/src/ReactFlightClientStreamConfigWeb';
 export * from 'react-client/src/ReactClientConsoleConfigBrowser';
-export * from 'react-server-dom-turbopack/src/ReactFlightClientConfigBundlerTurbopack';
-export * from 'react-server-dom-turbopack/src/ReactFlightClientConfigBundlerTurbopackBrowser';
-export * from 'react-server-dom-turbopack/src/ReactFlightClientConfigTargetTurbopackBrowser';
+export * from 'react-server-dom-turbopack/src/client/ReactFlightClientConfigBundlerTurbopack';
+export * from 'react-server-dom-turbopack/src/client/ReactFlightClientConfigBundlerTurbopackBrowser';
+export * from 'react-server-dom-turbopack/src/client/ReactFlightClientConfigTargetTurbopackBrowser';
 export * from 'react-dom-bindings/src/shared/ReactFlightClientConfigDOM';
 export const usedWithSSR = false;

packages/react-client/src/forks/ReactFlightClientConfig.dom-browser.js

@@ -9,8 +9,8 @@
 
 export * from 'react-client/src/ReactFlightClientStreamConfigWeb';
 export * from 'react-client/src/ReactClientConsoleConfigBrowser';
-export * from 'react-server-dom-webpack/src/ReactFlightClientConfigBundlerWebpack';
-export * from 'react-server-dom-webpack/src/ReactFlightClientConfigBundlerWebpackBrowser';
-export * from 'react-server-dom-webpack/src/ReactFlightClientConfigTargetWebpackBrowser';
+export * from 'react-server-dom-webpack/src/client/ReactFlightClientConfigBundlerWebpack';
+export * from 'react-server-dom-webpack/src/client/ReactFlightClientConfigBundlerWebpackBrowser';
+export * from 'react-server-dom-webpack/src/client/ReactFlightClientConfigTargetWebpackBrowser';
 export * from 'react-dom-bindings/src/shared/ReactFlightClientConfigDOM';
 export const usedWithSSR = false;

packages/react-client/src/forks/ReactFlightClientConfig.dom-edge-turbopack.js

@@ -9,8 +9,8 @@
 
 export * from 'react-client/src/ReactFlightClientStreamConfigWeb';
 export * from 'react-client/src/ReactClientConsoleConfigServer';
-export * from 'react-server-dom-turbopack/src/ReactFlightClientConfigBundlerTurbopack';
-export * from 'react-server-dom-turbopack/src/ReactFlightClientConfigBundlerTurbopackServer';
-export * from 'react-server-dom-turbopack/src/ReactFlightClientConfigTargetTurbopackServer';
+export * from 'react-server-dom-turbopack/src/client/ReactFlightClientConfigBundlerTurbopack';
+export * from 'react-server-dom-turbopack/src/client/ReactFlightClientConfigBundlerTurbopackServer';
+export * from 'react-server-dom-turbopack/src/client/ReactFlightClientConfigTargetTurbopackServer';
 export * from 'react-dom-bindings/src/shared/ReactFlightClientConfigDOM';
 export const usedWithSSR = true;

packages/react-client/src/forks/ReactFlightClientConfig.dom-edge-webpack.js

@@ -9,8 +9,8 @@
 
 export * from 'react-client/src/ReactFlightClientStreamConfigWeb';
 export * from 'react-client/src/ReactClientConsoleConfigServer';
-export * from 'react-server-dom-webpack/src/ReactFlightClientConfigBundlerWebpack';
-export * from 'react-server-dom-webpack/src/ReactFlightClientConfigBundlerWebpackServer';
-export * from 'react-server-dom-webpack/src/ReactFlightClientConfigTargetWebpackServer';
+export * from 'react-server-dom-webpack/src/client/ReactFlightClientConfigBundlerWebpack';
+export * from 'react-server-dom-webpack/src/client/ReactFlightClientConfigBundlerWebpackServer';
+export * from 'react-server-dom-webpack/src/client/ReactFlightClientConfigTargetWebpackServer';
 export * from 'react-dom-bindings/src/shared/ReactFlightClientConfigDOM';
 export const usedWithSSR = true;

packages/react-client/src/forks/ReactFlightClientConfig.dom-node-esm.js

@@ -9,7 +9,7 @@
 
 export * from 'react-client/src/ReactFlightClientStreamConfigNode';
 export * from 'react-client/src/ReactClientConsoleConfigServer';
-export * from 'react-server-dom-esm/src/ReactFlightClientConfigBundlerESM';
-export * from 'react-server-dom-esm/src/ReactFlightClientConfigTargetESMServer';
+export * from 'react-server-dom-esm/src/client/ReactFlightClientConfigBundlerESM';
+export * from 'react-server-dom-esm/src/client/ReactFlightClientConfigTargetESMServer';
 export * from 'react-dom-bindings/src/shared/ReactFlightClientConfigDOM';
 export const usedWithSSR = true;

packages/react-client/src/forks/ReactFlightClientConfig.dom-node-turbopack-bundled.js

@@ -9,8 +9,8 @@
 
 export * from 'react-client/src/ReactFlightClientStreamConfigNode';
 export * from 'react-client/src/ReactClientConsoleConfigServer';
-export * from 'react-server-dom-turbopack/src/ReactFlightClientConfigBundlerTurbopack';
-export * from 'react-server-dom-turbopack/src/ReactFlightClientConfigBundlerTurbopackServer';
-export * from 'react-server-dom-turbopack/src/ReactFlightClientConfigTargetTurbopackServer';
+export * from 'react-server-dom-turbopack/src/client/ReactFlightClientConfigBundlerTurbopack';
+export * from 'react-server-dom-turbopack/src/client/ReactFlightClientConfigBundlerTurbopackServer';
+export * from 'react-server-dom-turbopack/src/client/ReactFlightClientConfigTargetTurbopackServer';
 export * from 'react-dom-bindings/src/shared/ReactFlightClientConfigDOM';
 export const usedWithSSR = true;

packages/react-client/src/forks/ReactFlightClientConfig.dom-node-turbopack.js

@@ -9,7 +9,7 @@
 
 export * from 'react-client/src/ReactFlightClientStreamConfigNode';
 export * from 'react-client/src/ReactClientConsoleConfigServer';
-export * from 'react-server-dom-turbopack/src/ReactFlightClientConfigBundlerNode';
-export * from 'react-server-dom-turbopack/src/ReactFlightClientConfigTargetTurbopackServer';
+export * from 'react-server-dom-turbopack/src/client/ReactFlightClientConfigBundlerNode';
+export * from 'react-server-dom-turbopack/src/client/ReactFlightClientConfigTargetTurbopackServer';
 export * from 'react-dom-bindings/src/shared/ReactFlightClientConfigDOM';
 export const usedWithSSR = true;

packages/react-client/src/forks/ReactFlightClientConfig.dom-node-webpack.js

@@ -9,8 +9,8 @@
 
 export * from 'react-client/src/ReactFlightClientStreamConfigNode';
 export * from 'react-client/src/ReactClientConsoleConfigServer';
-export * from 'react-server-dom-webpack/src/ReactFlightClientConfigBundlerWebpack';
-export * from 'react-server-dom-webpack/src/ReactFlightClientConfigBundlerWebpackServer';
-export * from 'react-server-dom-webpack/src/ReactFlightClientConfigTargetWebpackServer';
+export * from 'react-server-dom-webpack/src/client/ReactFlightClientConfigBundlerWebpack';
+export * from 'react-server-dom-webpack/src/client/ReactFlightClientConfigBundlerWebpackServer';
+export * from 'react-server-dom-webpack/src/client/ReactFlightClientConfigTargetWebpackServer';
 export * from 'react-dom-bindings/src/shared/ReactFlightClientConfigDOM';
 export const usedWithSSR = true;

packages/react-client/src/forks/ReactFlightClientConfig.dom-node.js

@@ -9,7 +9,7 @@
 
 export * from 'react-client/src/ReactFlightClientStreamConfigNode';
 export * from 'react-client/src/ReactClientConsoleConfigServer';
-export * from 'react-server-dom-webpack/src/ReactFlightClientConfigBundlerNode';
-export * from 'react-server-dom-webpack/src/ReactFlightClientConfigTargetWebpackServer';
+export * from 'react-server-dom-webpack/src/client/ReactFlightClientConfigBundlerNode';
+export * from 'react-server-dom-webpack/src/client/ReactFlightClientConfigTargetWebpackServer';
 export * from 'react-dom-bindings/src/shared/ReactFlightClientConfigDOM';
 export const usedWithSSR = true;

packages/react-server-dom-esm/client.browser.js

@@ -7,4 +7,4 @@
  * @flow
  */
 
-export * from './src/ReactFlightDOMClientBrowser';
+export * from './src/client/ReactFlightDOMClientBrowser';

packages/react-server-dom-esm/client.node.js

@@ -7,4 +7,4 @@
  * @flow
  */
 
-export * from './src/ReactFlightDOMClientNode';
+export * from './src/client/ReactFlightDOMClientNode';

packages/react-server-dom-esm/npm/server.node.js

@@ -1,7 +1,18 @@
 'use strict';
 
+var s;
 if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./cjs/react-server-dom-esm-server.node.production.js');
+  s = require('./cjs/react-server-dom-turbopack-server.node.production.js');
 } else {
-  module.exports = require('./cjs/react-server-dom-esm-server.node.development.js');
+  s = require('./cjs/react-server-dom-turbopack-server.node.development.js');
 }
+
+exports.renderToPipeableStream = s.renderToPipeableStream;
+exports.decodeReplyFromBusboy = s.decodeReplyFromBusboy;
+exports.decodeReply = s.decodeReply;
+exports.decodeAction = s.decodeAction;
+exports.decodeFormState = s.decodeFormState;
+exports.registerServerReference = s.registerServerReference;
+exports.registerClientReference = s.registerClientReference;
+exports.createClientModuleProxy = s.createClientModuleProxy;
+exports.createTemporaryReferenceSet = s.createTemporaryReferenceSet;

packages/react-server-dom-esm/npm/static.js

@@ -0,0 +1,6 @@
+'use strict';
+
+throw new Error(
+  'The React Server Writer cannot be used outside a react-server environment. ' +
+    'You must configure Node.js using the `--conditions react-server` flag.'
+);

packages/react-server-dom-esm/npm/static.node.js

@@ -0,0 +1,12 @@
+'use strict';
+
+var s;
+if (process.env.NODE_ENV === 'production') {
+  s = require('./cjs/react-server-dom-esm-server.node.production.js');
+} else {
+  s = require('./cjs/react-server-dom-esm-server.node.development.js');
+}
+
+if (s.prerenderToNodeStream) {
+  exports.prerenderToNodeStream = s.prerenderToNodeStream;
+}

packages/react-server-dom-esm/package.json

@@ -17,6 +17,8 @@
     "client.node.js",
     "server.js",
     "server.node.js",
+    "static.js",
+    "static.node.js",
     "cjs/",
     "esm/"
   ],
@@ -33,6 +35,11 @@
       "default": "./server.js"
     },
     "./server.node": "./server.node.js",
+    "./static": {
+      "react-server": "./static.node.js",
+      "default": "./static.js"
+    },
+    "./static.node": "./static.node.js",
     "./node-loader": "./esm/react-server-dom-esm-node-loader.production.js",
     "./src/*": "./src/*.js",
     "./package.json": "./package.json"

packages/react-server-dom-esm/server.node.js

@@ -7,4 +7,13 @@
  * @flow
  */
 
-export * from './src/ReactFlightDOMServerNode';
+export {
+  renderToPipeableStream,
+  decodeReplyFromBusboy,
+  decodeReply,
+  decodeAction,
+  decodeFormState,
+  registerServerReference,
+  registerClientReference,
+  createTemporaryReferenceSet,
+} from './src/server/react-flight-dom-server.node';

packages/react-server-dom-esm/src/ReactFlightDOMServerNode.js → packages/react-server-dom-esm/src/server/ReactFlightDOMServerNode.js

@@ -18,6 +18,8 @@ import type {Busboy} from 'busboy';
 import type {Writable} from 'stream';
 import type {Thenable} from 'shared/ReactTypes';
 
+import {Readable} from 'stream';
+
 import {
   createRequest,
   startWork,
@@ -45,7 +47,7 @@ import {
 export {
   registerServerReference,
   registerClientReference,
-} from './ReactFlightESMReferences';
+} from '../ReactFlightESMReferences';
 
 import type {TemporaryReferenceSet} from 'react-server/src/ReactFlightServerTemporaryReferences';
 
@@ -123,6 +125,80 @@ function renderToPipeableStream(
     },
   };
 }
+function createFakeWritable(readable: any): Writable {
+  // The current host config expects a Writable so we create
+  // a fake writable for now to push into the Readable.
+  return ({
+    write(chunk) {
+      return readable.push(chunk);
+    },
+    end() {
+      readable.push(null);
+    },
+    destroy(error) {
+      readable.destroy(error);
+    },
+  }: any);
+}
+
+type PrerenderOptions = {
+  environmentName?: string | (() => string),
+  filterStackFrame?: (url: string, functionName: string) => boolean,
+  onError?: (error: mixed) => void,
+  onPostpone?: (reason: string) => void,
+  identifierPrefix?: string,
+  temporaryReferences?: TemporaryReferenceSet,
+  signal?: AbortSignal,
+};
+
+type StaticResult = {
+  prelude: Readable,
+};
+
+function prerenderToNodeStream(
+  model: ReactClientValue,
+  moduleBasePath: ClientManifest,
+  options?: PrerenderOptions,
+): Promise<StaticResult> {
+  return new Promise((resolve, reject) => {
+    const onFatalError = reject;
+    function onAllReady() {
+      const readable: Readable = new Readable({
+        read() {
+          startFlowing(request, writable);
+        },
+      });
+      const writable = createFakeWritable(readable);
+      resolve({prelude: readable});
+    }
+
+    const request = createRequest(
+      model,
+      moduleBasePath,
+      options ? options.onError : undefined,
+      options ? options.identifierPrefix : undefined,
+      options ? options.onPostpone : undefined,
+      options ? options.temporaryReferences : undefined,
+      __DEV__ && options ? options.environmentName : undefined,
+      __DEV__ && options ? options.filterStackFrame : undefined,
+      onAllReady,
+      onFatalError,
+    );
+    if (options && options.signal) {
+      const signal = options.signal;
+      if (signal.aborted) {
+        abort(request, (signal: any).reason);
+      } else {
+        const listener = () => {
+          abort(request, (signal: any).reason);
+          signal.removeEventListener('abort', listener);
+        };
+        signal.addEventListener('abort', listener);
+      }
+    }
+    startWork(request);
+  });
+}
 
 function decodeReplyFromBusboy<T>(
   busboyStream: Busboy,
@@ -207,6 +283,7 @@ function decodeReply<T>(
 
 export {
   renderToPipeableStream,
+  prerenderToNodeStream,
   decodeReplyFromBusboy,
   decodeReply,
   decodeAction,

packages/react-server-dom-esm/src/ReactFlightServerConfigESMBundler.js → packages/react-server-dom-esm/src/server/ReactFlightServerConfigESMBundler.js

@@ -12,7 +12,7 @@ import type {ReactClientValue} from 'react-server/src/ReactFlightServer';
 import type {
   ClientReference,
   ServerReference,
-} from './ReactFlightESMReferences';
+} from '../ReactFlightESMReferences';
 
 export type {ClientReference, ServerReference};
 
@@ -27,7 +27,10 @@ export type ClientReferenceMetadata = [
 
 export type ClientReferenceKey = string;
 
-export {isClientReference, isServerReference} from './ReactFlightESMReferences';
+export {
+  isClientReference,
+  isServerReference,
+} from '../ReactFlightESMReferences';
 
 export function getClientReferenceKey(
   reference: ClientReference<any>,

packages/react-server-dom-esm/src/server/react-flight-dom-server.node.js

@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow
+ */
+
+export {
+  renderToPipeableStream,
+  prerenderToNodeStream,
+  decodeReplyFromBusboy,
+  decodeReply,
+  decodeAction,
+  decodeFormState,
+  registerServerReference,
+  registerClientReference,
+  createTemporaryReferenceSet,
+} from './ReactFlightDOMServerNode';

packages/react-server-dom-esm/src/server/react-flight-dom-server.node.stable.js

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow
+ */
+
+export {
+  renderToPipeableStream,
+  decodeReplyFromBusboy,
+  decodeReply,
+  decodeAction,
+  decodeFormState,
+  registerServerReference,
+  registerClientReference,
+  createTemporaryReferenceSet,
+} from './ReactFlightDOMServerNode';

packages/react-server-dom-esm/static.js

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow
+ */
+
+throw new Error(
+  'The React Server cannot be used outside a react-server environment. ' +
+    'You must configure Node.js using the `--conditions react-server` flag.',
+);

packages/react-server-dom-esm/static.node.js

@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow
+ */
+
+export {prerenderToNodeStream} from './src/server/react-flight-dom-server.node';