Clean up inconsistent naming in Flight implementation, part 1

Since `ClientManifest` and `SSRManifest` are now clearly differentiated in their structure (via facebook#26300) and type names (via facebook#26351), this opened up the opportunity to clean up some inconsistencies in how parameters, variables and properties were named (e.g. `config`, `bundlerConfig`, `moduleMap`, `webpackMap`, ...). To improve readability and avoid confusion between the two different types of objects we now always name them either `clientManifest` or `ssrManifest`.
unstubbable · Mar 9, 2023 · 5392e75 · 5392e75
1 parent 3706edb
commit 5392e75
Show file tree

Hide file tree

Showing 29 changed files with 132 additions and 130 deletions.
diff --git a/fixtures/flight/server/global.js b/fixtures/flight/server/global.js
@@ -122,8 +122,8 @@ app.all('/', async function (req, res, next) {
         virtualFs = fs;
         buildPath = path.join(__dirname, '../build/');
       }
-      // Read the module map from the virtual file system.
-      const moduleMap = JSON.parse(
+      // Read the SSR manifest from the virtual file system.
+      const ssrManifest = JSON.parse(
         await virtualFs.readFile(
           path.join(buildPath, 'react-ssr-manifest.json'),
           'utf8'
@@ -140,7 +140,7 @@ app.all('/', async function (req, res, next) {
       // For HTML, we're a "client" emulator that runs the client code,
       // so we start by consuming the RSC payload. This needs a module
       // map that reverse engineers the client-side path to the SSR path.
-      const root = await createFromNodeStream(rscResponse, moduleMap);
+      const root = await createFromNodeStream(rscResponse, ssrManifest);
       // Render it into HTML by resolving the client components
       res.set('Content-type', 'text/html');
       const {pipe} = renderToPipeableStream(root, {

diff --git a/fixtures/flight/server/region.js b/fixtures/flight/server/region.js
@@ -51,11 +51,11 @@ app.get('/', async function (req, res) {
   // const m = require('../src/App.js');
   const m = await import('../src/App.js');
 
-  let moduleMap;
+  let clientManifest;
   let mainCSSChunks;
   if (process.env.NODE_ENV === 'development') {
-    // Read the module map from the HMR server in development.
-    moduleMap = await (
+    // Read the client manifest from the HMR server in development.
+    clientManifest = await (
       await fetch('http://localhost:3000/react-client-manifest.json')
     ).json();
     mainCSSChunks = (
@@ -64,8 +64,8 @@ app.get('/', async function (req, res) {
       ).json()
     ).main.css;
   } else {
-    // Read the module map from the static build in production.
-    moduleMap = JSON.parse(
+    // Read the client manifest from the static build in production.
+    clientManifest = JSON.parse(
       await readFile(
         path.resolve(__dirname, `../build/react-client-manifest.json`),
         'utf8'
@@ -90,7 +90,7 @@ app.get('/', async function (req, res) {
     ),
     React.createElement(App),
   ];
-  const {pipe} = renderToPipeableStream(root, moduleMap);
+  const {pipe} = renderToPipeableStream(root, clientManifest);
   pipe(res);
 });
 

diff --git a/packages/react-client/src/ReactFlightClient.js b/packages/react-client/src/ReactFlightClient.js
@@ -149,7 +149,7 @@ Chunk.prototype.then = function <T>(
 };
 
 export type ResponseBase = {
-  _bundlerConfig: SSRManifest,
+  _ssrManifest: SSRManifest,
   _callServer: CallServerCallback,
   _chunks: Map<number, SomeChunk<any>>,
   ...
@@ -611,12 +611,12 @@ function missingCall() {
 }
 
 export function createResponse(
-  bundlerConfig: SSRManifest,
+  ssrManifest: SSRManifest,
   callServer: void | CallServerCallback,
 ): ResponseBase {
   const chunks: Map<number, SomeChunk<any>> = new Map();
   const response = {
-    _bundlerConfig: bundlerConfig,
+    _ssrManifest: ssrManifest,
     _callServer: callServer !== undefined ? callServer : missingCall,
     _chunks: chunks,
   };
@@ -649,7 +649,7 @@ export function resolveModule(
     model,
   );
   const clientReference = resolveClientReference<$FlowFixMe>(
-    response._bundlerConfig,
+    response._ssrManifest,
     clientReferenceMetadata,
   );
 

diff --git a/packages/react-client/src/ReactFlightClientStream.js b/packages/react-client/src/ReactFlightClientStream.js
@@ -121,13 +121,13 @@ function createFromJSONCallback(response: Response) {
 }
 
 export function createResponse(
-  bundlerConfig: SSRManifest,
+  ssrManifest: SSRManifest,
   callServer: void | CallServerCallback,
 ): Response {
   // NOTE: CHECK THE COMPILER OUTPUT EACH TIME YOU CHANGE THIS.
   // It should be inlined to one object literal but minor changes can break it.
   const stringDecoder = supportsBinaryStreams ? createStringDecoder() : null;
-  const response: any = createResponseBase(bundlerConfig, callServer);
+  const response: any = createResponseBase(ssrManifest, callServer);
   response._partialRow = '';
   if (supportsBinaryStreams) {
     response._stringDecoder = stringDecoder;

diff --git a/packages/react-noop-renderer/src/ReactNoopFlightClient.js b/packages/react-noop-renderer/src/ReactNoopFlightClient.js
@@ -22,7 +22,7 @@ type Source = Array<string>;
 
 const {createResponse, processStringChunk, getRoot, close} = ReactFlightClient({
   supportsBinaryStreams: false,
-  resolveClientReference(bundlerConfig: null, idx: string) {
+  resolveClientReference(ssrManifest: null, idx: string) {
     return idx;
   },
   preloadModule(idx: string) {},

diff --git a/packages/react-noop-renderer/src/ReactNoopFlightServer.js b/packages/react-noop-renderer/src/ReactNoopFlightServer.js
@@ -54,14 +54,14 @@ const ReactNoopFlightServer = ReactFlightServer({
   isServerReference(reference: Object): boolean {
     return reference.$$typeof === Symbol.for('react.server.reference');
   },
-  getClientReferenceKey(reference: Object): Object {
-    return reference;
+  getClientReferenceKey(clientReference: Object): Object {
+    return clientReference;
   },
   resolveClientReferenceMetadata(
-    config: void,
-    reference: {$$typeof: symbol, value: any},
+    clientManifest: void,
+    clientReference: {$$typeof: symbol, value: any},
   ) {
-    return saveModule(reference.value);
+    return saveModule(clientReference.value);
   },
 });
 
@@ -73,10 +73,10 @@ type Options = {
 
 function render(model: ReactClientValue, options?: Options): Destination {
   const destination: Destination = [];
-  const bundlerConfig = undefined;
+  const clientManifest = undefined;
   const request = ReactNoopFlightServer.createRequest(
     model,
-    bundlerConfig,
+    clientManifest,
     options ? options.onError : undefined,
     options ? options.context : undefined,
     options ? options.identifierPrefix : undefined,

diff --git a/packages/react-server-dom-relay/src/ReactFlightDOMRelayClientHostConfig.js b/packages/react-server-dom-relay/src/ReactFlightDOMRelayClientHostConfig.js
@@ -38,7 +38,7 @@ export type UninitializedModel = JSONValue;
 export type Response = ResponseBase;
 
 export function resolveClientReference<T>(
-  bundlerConfig: SSRManifest,
+  ssrManifest: SSRManifest,
   metadata: ClientReferenceMetadata,
 ): ClientReference<T> {
   return resolveClientReferenceImpl(metadata);

diff --git a/packages/react-server-dom-relay/src/ReactFlightDOMRelayServer.js b/packages/react-server-dom-relay/src/ReactFlightDOMRelayServer.js
@@ -27,12 +27,12 @@ type Options = {
 function render(
   model: ReactClientValue,
   destination: Destination,
-  config: ClientManifest,
+  clientManifest: ClientManifest,
   options?: Options,
 ): void {
   const request = createRequest(
     model,
-    config,
+    clientManifest,
     options ? options.onError : undefined,
     undefined, // not currently set up to supply context overrides
     options ? options.identifierPrefix : undefined,

diff --git a/packages/react-server-dom-relay/src/ReactFlightDOMRelayServerHostConfig.js b/packages/react-server-dom-relay/src/ReactFlightDOMRelayServerHostConfig.js
@@ -26,7 +26,7 @@ export type ServerReferenceId = {};
 
 import type {
   Destination,
-  BundlerConfig as ClientManifest,
+  ClientManifest,
   ClientReferenceMetadata,
 } from 'ReactFlightDOMRelayServerIntegration';
 
@@ -40,7 +40,7 @@ import {
 
 export type {
   Destination,
-  BundlerConfig as ClientManifest,
+  ClientManifest,
   ClientReferenceMetadata,
 } from 'ReactFlightDOMRelayServerIntegration';
 
@@ -55,30 +55,30 @@ export function isServerReference(reference: Object): boolean {
 export type ClientReferenceKey = ClientReference<any>;
 
 export function getClientReferenceKey(
-  reference: ClientReference<any>,
+  clientReference: ClientReference<any>,
 ): ClientReferenceKey {
   // We use the reference object itself as the key because we assume the
   // object will be cached by the bundler runtime.
-  return reference;
+  return clientReference;
 }
 
 export function resolveClientReferenceMetadata<T>(
-  config: ClientManifest,
-  resource: ClientReference<T>,
+  clientManifest: ClientManifest,
+  clientReference: ClientReference<T>,
 ): ClientReferenceMetadata {
-  return resolveClientReferenceMetadataImpl(config, resource);
+  return resolveClientReferenceMetadataImpl(clientManifest, clientReference);
 }
 
 export function getServerReferenceId<T>(
-  config: ClientManifest,
-  resource: ServerReference<T>,
+  clientManifest: ClientManifest,
+  serverReference: ServerReference<T>,
 ): ServerReferenceId {
   throw new Error('Not implemented.');
 }
 
 export function getServerReferenceBoundArguments<T>(
-  config: ClientManifest,
-  resource: ServerReference<T>,
+  clientManifest: ClientManifest,
+  serverReference: ServerReference<T>,
 ): Array<ReactClientValue> {
   throw new Error('Not implemented.');
 }

diff --git a/packages/react-server-dom-relay/src/__mocks__/ReactFlightDOMRelayServerIntegration.js b/packages/react-server-dom-relay/src/__mocks__/ReactFlightDOMRelayServerIntegration.js
@@ -12,8 +12,8 @@ const ReactFlightDOMRelayServerIntegration = {
     destination.push(json);
   },
   close(destination) {},
-  resolveClientReferenceMetadata(config, resource) {
-    return resource._moduleId;
+  resolveClientReferenceMetadata(clientManifest, clientReference) {
+    return clientReference._moduleId;
   },
 };
 

diff --git a/packages/react-server-dom-webpack/src/ReactFlightClientNodeBundlerConfig.js b/packages/react-server-dom-webpack/src/ReactFlightClientNodeBundlerConfig.js
@@ -32,10 +32,10 @@ export opaque type ClientReference<T> = {
 };
 
 export function resolveClientReference<T>(
-  bundlerConfig: SSRManifest,
+  ssrManifest: SSRManifest,
   metadata: ClientReferenceMetadata,
 ): ClientReference<T> {
-  const resolvedModuleData = bundlerConfig[metadata.id][metadata.name];
+  const resolvedModuleData = ssrManifest[metadata.id][metadata.name];
   return resolvedModuleData;
 }
 

diff --git a/packages/react-server-dom-webpack/src/ReactFlightClientWebpackBundlerConfig.js b/packages/react-server-dom-webpack/src/ReactFlightClientWebpackBundlerConfig.js
@@ -30,11 +30,11 @@ export opaque type ClientReferenceMetadata = {
 export opaque type ClientReference<T> = ClientReferenceMetadata;
 
 export function resolveClientReference<T>(
-  bundlerConfig: SSRManifest,
+  ssrManifest: SSRManifest,
   metadata: ClientReferenceMetadata,
 ): ClientReference<T> {
-  if (bundlerConfig) {
-    const resolvedModuleData = bundlerConfig[metadata.id][metadata.name];
+  if (ssrManifest) {
+    const resolvedModuleData = ssrManifest[metadata.id][metadata.name];
     if (metadata.async) {
       return {
         id: resolvedModuleData.id,

diff --git a/packages/react-server-dom-webpack/src/ReactFlightDOMClientEdge.js b/packages/react-server-dom-webpack/src/ReactFlightDOMClientEdge.js
@@ -30,12 +30,12 @@ function noServerCall() {
 }
 
 export type Options = {
-  moduleMap?: SSRManifest,
+  ssrManifest?: SSRManifest,
 };
 
 function createResponseFromOptions(options: void | Options) {
   return createResponse(
-    options && options.moduleMap ? options.moduleMap : null,
+    options && options.ssrManifest ? options.ssrManifest : null,
     noServerCall,
   );
 }

diff --git a/packages/react-server-dom-webpack/src/ReactFlightDOMClientNode.js b/packages/react-server-dom-webpack/src/ReactFlightDOMClientNode.js
@@ -34,9 +34,9 @@ function noServerCall() {
 
 function createFromNodeStream<T>(
   stream: Readable,
-  moduleMap: $NonMaybeType<SSRManifest>,
+  ssrManifest: $NonMaybeType<SSRManifest>,
 ): Thenable<T> {
-  const response: Response = createResponse(moduleMap, noServerCall);
+  const response: Response = createResponse(ssrManifest, noServerCall);
   stream.on('data', chunk => {
     if (typeof chunk === 'string') {
       processStringChunk(response, chunk, 0);

diff --git a/packages/react-server-dom-webpack/src/ReactFlightDOMServerBrowser.js b/packages/react-server-dom-webpack/src/ReactFlightDOMServerBrowser.js
@@ -27,12 +27,12 @@ type Options = {
 
 function renderToReadableStream(
   model: ReactClientValue,
-  webpackMap: ClientManifest,
+  clientManifest: ClientManifest,
   options?: Options,
 ): ReadableStream {
   const request = createRequest(
     model,
-    webpackMap,
+    clientManifest,
     options ? options.onError : undefined,
     options ? options.context : undefined,
     options ? options.identifierPrefix : undefined,

diff --git a/packages/react-server-dom-webpack/src/ReactFlightDOMServerEdge.js b/packages/react-server-dom-webpack/src/ReactFlightDOMServerEdge.js
@@ -27,12 +27,12 @@ type Options = {
 
 function renderToReadableStream(
   model: ReactClientValue,
-  webpackMap: ClientManifest,
+  clientManifest: ClientManifest,
   options?: Options,
 ): ReadableStream {
   const request = createRequest(
     model,
-    webpackMap,
+    clientManifest,
     options ? options.onError : undefined,
     options ? options.context : undefined,
     options ? options.identifierPrefix : undefined,

diff --git a/packages/react-server-dom-webpack/src/ReactFlightDOMServerNode.js b/packages/react-server-dom-webpack/src/ReactFlightDOMServerNode.js
@@ -40,12 +40,12 @@ type PipeableStream = {
 
 function renderToPipeableStream(
   model: ReactClientValue,
-  webpackMap: ClientManifest,
+  clientManifest: ClientManifest,
   options?: Options,
 ): PipeableStream {
   const request = createRequest(
     model,
-    webpackMap,
+    clientManifest,
     options ? options.onError : undefined,
     options ? options.context : undefined,
     options ? options.identifierPrefix : undefined,

diff --git a/packages/react-server-dom-webpack/src/ReactFlightServerWebpackBundlerConfig.js b/packages/react-server-dom-webpack/src/ReactFlightServerWebpackBundlerConfig.js
@@ -41,9 +41,11 @@ const CLIENT_REFERENCE_TAG = Symbol.for('react.client.reference');
 const SERVER_REFERENCE_TAG = Symbol.for('react.server.reference');
 
 export function getClientReferenceKey(
-  reference: ClientReference<any>,
+  clientReference: ClientReference<any>,
 ): ClientReferenceKey {
-  return reference.$$async ? reference.$$id + '#async' : reference.$$id;
+  return clientReference.$$async
+    ? clientReference.$$id + '#async'
+    : clientReference.$$id;
 }
 
 export function isClientReference(reference: Object): boolean {
@@ -55,10 +57,10 @@ export function isServerReference(reference: Object): boolean {
 }
 
 export function resolveClientReferenceMetadata<T>(
-  config: ClientManifest,
+  clientManifest: ClientManifest,
   clientReference: ClientReference<T>,
 ): ClientReferenceMetadata {
-  const resolvedModuleData = config[clientReference.$$id];
+  const resolvedModuleData = clientManifest[clientReference.$$id];
   if (clientReference.$$async) {
     return {
       id: resolvedModuleData.id,
@@ -72,14 +74,14 @@ export function resolveClientReferenceMetadata<T>(
 }
 
 export function getServerReferenceId<T>(
-  config: ClientManifest,
+  clientManifest: ClientManifest,
   serverReference: ServerReference<T>,
 ): ServerReferenceId {
   return serverReference.$$id;
 }
 
 export function getServerReferenceBoundArguments<T>(
-  config: ClientManifest,
+  clientManifest: ClientManifest,
   serverReference: ServerReference<T>,
 ): null | Array<ReactClientValue> {
   return serverReference.$$bound;

diff --git a/packages/react-server-dom-webpack/src/ReactFlightWebpackPlugin.js b/packages/react-server-dom-webpack/src/ReactFlightWebpackPlugin.js
@@ -213,7 +213,7 @@ export default class ReactFlightWebpackPlugin {
           if (clientFileNameFound === false) {
             compilation.warnings.push(
               new WebpackError(
-                `Client runtime at ${clientImportName} was not found. React Server Components module map file ${_this.clientManifestFilename} was not created.`,
+                `Client runtime at ${clientImportName} was not found. React Server Components client manifest file ${_this.clientManifestFilename} was not created.`,
               ),
             );
             return;