Skip to content

Commit 10ce129

Browse files
committed
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`.
1 parent 8fa41ff commit 10ce129

30 files changed

+149
-147
lines changed

fixtures/flight/server/global.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ app.all('/', async function (req, res, next) {
122122
virtualFs = fs;
123123
buildPath = path.join(__dirname, '../build/');
124124
}
125-
// Read the module map from the virtual file system.
126-
const moduleMap = JSON.parse(
125+
// Read the SSR manifest from the virtual file system.
126+
const ssrManifest = JSON.parse(
127127
await virtualFs.readFile(
128128
path.join(buildPath, 'react-ssr-manifest.json'),
129129
'utf8'
@@ -140,7 +140,7 @@ app.all('/', async function (req, res, next) {
140140
// For HTML, we're a "client" emulator that runs the client code,
141141
// so we start by consuming the RSC payload. This needs a module
142142
// map that reverse engineers the client-side path to the SSR path.
143-
const root = await createFromNodeStream(rscResponse, moduleMap);
143+
const root = await createFromNodeStream(rscResponse, ssrManifest);
144144
// Render it into HTML by resolving the client components
145145
res.set('Content-type', 'text/html');
146146
const {pipe} = renderToPipeableStream(root, {

fixtures/flight/server/region.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ app.get('/', async function (req, res) {
5252
// const m = require('../src/App.js');
5353
const m = await import('../src/App.js');
5454

55-
let moduleMap;
55+
let clientManifest;
5656
let mainCSSChunks;
5757
if (process.env.NODE_ENV === 'development') {
58-
// Read the module map from the HMR server in development.
59-
moduleMap = await (
58+
// Read the client manifest from the HMR server in development.
59+
clientManifest = await (
6060
await fetch('http://localhost:3000/react-client-manifest.json')
6161
).json();
6262
mainCSSChunks = (
@@ -65,8 +65,8 @@ app.get('/', async function (req, res) {
6565
).json()
6666
).main.css;
6767
} else {
68-
// Read the module map from the static build in production.
69-
moduleMap = JSON.parse(
68+
// Read the client manifest from the static build in production.
69+
clientManifest = JSON.parse(
7070
await readFile(
7171
path.resolve(__dirname, `../build/react-client-manifest.json`),
7272
'utf8'
@@ -91,7 +91,7 @@ app.get('/', async function (req, res) {
9191
),
9292
React.createElement(App),
9393
];
94-
const {pipe} = renderToPipeableStream(root, moduleMap);
94+
const {pipe} = renderToPipeableStream(root, clientManifest);
9595
pipe(res);
9696
});
9797

packages/react-client/src/ReactFlightClient.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ Chunk.prototype.then = function <T>(
151151
};
152152

153153
export type ResponseBase = {
154-
_bundlerConfig: SSRManifest,
154+
_ssrManifest: SSRManifest,
155155
_callServer: CallServerCallback,
156156
_chunks: Map<number, SomeChunk<any>>,
157157
...
@@ -619,12 +619,12 @@ function missingCall() {
619619
}
620620

621621
export function createResponse(
622-
bundlerConfig: SSRManifest,
622+
ssrManifest: SSRManifest,
623623
callServer: void | CallServerCallback,
624624
): ResponseBase {
625625
const chunks: Map<number, SomeChunk<any>> = new Map();
626626
const response = {
627-
_bundlerConfig: bundlerConfig,
627+
_ssrManifest: ssrManifest,
628628
_callServer: callServer !== undefined ? callServer : missingCall,
629629
_chunks: chunks,
630630
};
@@ -657,7 +657,7 @@ export function resolveModule(
657657
model,
658658
);
659659
const clientReference = resolveClientReference<$FlowFixMe>(
660-
response._bundlerConfig,
660+
response._ssrManifest,
661661
clientReferenceMetadata,
662662
);
663663

packages/react-client/src/ReactFlightClientStream.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,13 +121,13 @@ function createFromJSONCallback(response: Response) {
121121
}
122122

123123
export function createResponse(
124-
bundlerConfig: SSRManifest,
124+
ssrManifest: SSRManifest,
125125
callServer: void | CallServerCallback,
126126
): Response {
127127
// NOTE: CHECK THE COMPILER OUTPUT EACH TIME YOU CHANGE THIS.
128128
// It should be inlined to one object literal but minor changes can break it.
129129
const stringDecoder = supportsBinaryStreams ? createStringDecoder() : null;
130-
const response: any = createResponseBase(bundlerConfig, callServer);
130+
const response: any = createResponseBase(ssrManifest, callServer);
131131
response._partialRow = '';
132132
if (supportsBinaryStreams) {
133133
response._stringDecoder = stringDecoder;

packages/react-noop-renderer/src/ReactNoopFlightClient.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ type Source = Array<string>;
2222

2323
const {createResponse, processStringChunk, getRoot, close} = ReactFlightClient({
2424
supportsBinaryStreams: false,
25-
resolveClientReference(bundlerConfig: null, idx: string) {
25+
resolveClientReference(ssrManifest: null, idx: string) {
2626
return idx;
2727
},
2828
preloadModule(idx: string) {},

packages/react-noop-renderer/src/ReactNoopFlightServer.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,14 @@ const ReactNoopFlightServer = ReactFlightServer({
5454
isServerReference(reference: Object): boolean {
5555
return reference.$$typeof === Symbol.for('react.server.reference');
5656
},
57-
getClientReferenceKey(reference: Object): Object {
58-
return reference;
57+
getClientReferenceKey(clientReference: Object): Object {
58+
return clientReference;
5959
},
6060
resolveClientReferenceMetadata(
61-
config: void,
62-
reference: {$$typeof: symbol, value: any},
61+
clientManifest: void,
62+
clientReference: {$$typeof: symbol, value: any},
6363
) {
64-
return saveModule(reference.value);
64+
return saveModule(clientReference.value);
6565
},
6666
});
6767

@@ -73,10 +73,10 @@ type Options = {
7373

7474
function render(model: ReactClientValue, options?: Options): Destination {
7575
const destination: Destination = [];
76-
const bundlerConfig = undefined;
76+
const clientManifest = undefined;
7777
const request = ReactNoopFlightServer.createRequest(
7878
model,
79-
bundlerConfig,
79+
clientManifest,
8080
options ? options.onError : undefined,
8181
options ? options.context : undefined,
8282
options ? options.identifierPrefix : undefined,

packages/react-server-dom-relay/src/ReactFlightDOMRelayClientHostConfig.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,14 @@ export type UninitializedModel = JSONValue;
4040
export type Response = ResponseBase;
4141

4242
export function resolveClientReference<T>(
43-
bundlerConfig: SSRManifest,
43+
ssrManifest: SSRManifest,
4444
metadata: ClientReferenceMetadata,
4545
): ClientReference<T> {
4646
return resolveClientReferenceImpl(metadata);
4747
}
4848

4949
export function resolveServerReference<T>(
50-
bundlerConfig: ServerManifest,
50+
serverManifest: ServerManifest,
5151
id: ServerReferenceId,
5252
): ClientReference<T> {
5353
throw new Error('Not implemented.');

packages/react-server-dom-relay/src/ReactFlightDOMRelayServer.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ type Options = {
2727
function render(
2828
model: ReactClientValue,
2929
destination: Destination,
30-
config: ClientManifest,
30+
clientManifest: ClientManifest,
3131
options?: Options,
3232
): void {
3333
const request = createRequest(
3434
model,
35-
config,
35+
clientManifest,
3636
options ? options.onError : undefined,
3737
undefined, // not currently set up to supply context overrides
3838
options ? options.identifierPrefix : undefined,

packages/react-server-dom-relay/src/ReactFlightDOMRelayServerHostConfig.js

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export type ServerReferenceId = {};
2626

2727
import type {
2828
Destination,
29-
BundlerConfig as ClientManifest,
29+
ClientManifest,
3030
ClientReferenceMetadata,
3131
} from 'ReactFlightDOMRelayServerIntegration';
3232

@@ -40,7 +40,7 @@ import {
4040

4141
export type {
4242
Destination,
43-
BundlerConfig as ClientManifest,
43+
ClientManifest,
4444
ClientReferenceMetadata,
4545
} from 'ReactFlightDOMRelayServerIntegration';
4646

@@ -55,30 +55,30 @@ export function isServerReference(reference: Object): boolean {
5555
export type ClientReferenceKey = ClientReference<any>;
5656

5757
export function getClientReferenceKey(
58-
reference: ClientReference<any>,
58+
clientReference: ClientReference<any>,
5959
): ClientReferenceKey {
6060
// We use the reference object itself as the key because we assume the
6161
// object will be cached by the bundler runtime.
62-
return reference;
62+
return clientReference;
6363
}
6464

6565
export function resolveClientReferenceMetadata<T>(
66-
config: ClientManifest,
67-
resource: ClientReference<T>,
66+
clientManifest: ClientManifest,
67+
clientReference: ClientReference<T>,
6868
): ClientReferenceMetadata {
69-
return resolveClientReferenceMetadataImpl(config, resource);
69+
return resolveClientReferenceMetadataImpl(clientManifest, clientReference);
7070
}
7171

7272
export function getServerReferenceId<T>(
73-
config: ClientManifest,
74-
resource: ServerReference<T>,
73+
clientManifest: ClientManifest,
74+
serverReference: ServerReference<T>,
7575
): ServerReferenceId {
7676
throw new Error('Not implemented.');
7777
}
7878

7979
export function getServerReferenceBoundArguments<T>(
80-
config: ClientManifest,
81-
resource: ServerReference<T>,
80+
clientManifest: ClientManifest,
81+
serverReference: ServerReference<T>,
8282
): Array<ReactClientValue> {
8383
throw new Error('Not implemented.');
8484
}

packages/react-server-dom-relay/src/__mocks__/ReactFlightDOMRelayServerIntegration.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ const ReactFlightDOMRelayServerIntegration = {
1212
destination.push(json);
1313
},
1414
close(destination) {},
15-
resolveClientReferenceMetadata(config, resource) {
16-
return resource._moduleId;
15+
resolveClientReferenceMetadata(clientManifest, clientReference) {
16+
return clientReference._moduleId;
1717
},
1818
};
1919

packages/react-server-dom-webpack/src/ReactFlightClientNodeBundlerConfig.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ export opaque type ClientReference<T> = {
3636
};
3737

3838
export function resolveClientReference<T>(
39-
bundlerConfig: SSRManifest,
39+
ssrManifest: SSRManifest,
4040
metadata: ClientReferenceMetadata,
4141
): ClientReference<T> {
42-
const resolvedModuleData = bundlerConfig[metadata.id][metadata.name];
42+
const resolvedModuleData = ssrManifest[metadata.id][metadata.name];
4343
return resolvedModuleData;
4444
}
4545

4646
export function resolveServerReference<T>(
47-
bundlerConfig: ServerManifest,
47+
serverManifest: ServerManifest,
4848
id: ServerReferenceId,
4949
): ClientReference<T> {
5050
const idx = id.lastIndexOf('#');

packages/react-server-dom-webpack/src/ReactFlightClientWebpackBundlerConfig.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ export opaque type ClientReferenceMetadata = {
3636
export opaque type ClientReference<T> = ClientReferenceMetadata;
3737

3838
export function resolveClientReference<T>(
39-
bundlerConfig: SSRManifest,
39+
ssrManifest: SSRManifest,
4040
metadata: ClientReferenceMetadata,
4141
): ClientReference<T> {
42-
if (bundlerConfig) {
43-
const resolvedModuleData = bundlerConfig[metadata.id][metadata.name];
42+
if (ssrManifest) {
43+
const resolvedModuleData = ssrManifest[metadata.id][metadata.name];
4444
if (metadata.async) {
4545
return {
4646
id: resolvedModuleData.id,
@@ -56,11 +56,11 @@ export function resolveClientReference<T>(
5656
}
5757

5858
export function resolveServerReference<T>(
59-
bundlerConfig: ServerManifest,
59+
serverManifest: ServerManifest,
6060
id: ServerReferenceId,
6161
): ClientReference<T> {
6262
// This needs to return async: true if it's an async module.
63-
return bundlerConfig[id];
63+
return serverManifest[id];
6464
}
6565

6666
// The chunk cache contains all the chunks we've preloaded so far.

packages/react-server-dom-webpack/src/ReactFlightDOMClientEdge.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ function noServerCall() {
3030
}
3131

3232
export type Options = {
33-
moduleMap?: $NonMaybeType<SSRManifest>,
33+
ssrManifest?: $NonMaybeType<SSRManifest>,
3434
};
3535

3636
function createResponseFromOptions(options: void | Options) {
3737
return createResponse(
38-
options && options.moduleMap ? options.moduleMap : null,
38+
options && options.ssrManifest ? options.ssrManifest : null,
3939
noServerCall,
4040
);
4141
}

packages/react-server-dom-webpack/src/ReactFlightDOMClientNode.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ function noServerCall() {
3434

3535
function createFromNodeStream<T>(
3636
stream: Readable,
37-
moduleMap: $NonMaybeType<SSRManifest>,
37+
ssrManifest: $NonMaybeType<SSRManifest>,
3838
): Thenable<T> {
39-
const response: Response = createResponse(moduleMap, noServerCall);
39+
const response: Response = createResponse(ssrManifest, noServerCall);
4040
stream.on('data', chunk => {
4141
if (typeof chunk === 'string') {
4242
processStringChunk(response, chunk, 0);

packages/react-server-dom-webpack/src/ReactFlightDOMServerBrowser.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@ type Options = {
3636

3737
function renderToReadableStream(
3838
model: ReactClientValue,
39-
webpackMap: ClientManifest,
39+
clientManifest: ClientManifest,
4040
options?: Options,
4141
): ReadableStream {
4242
const request = createRequest(
4343
model,
44-
webpackMap,
44+
clientManifest,
4545
options ? options.onError : undefined,
4646
options ? options.context : undefined,
4747
options ? options.identifierPrefix : undefined,
@@ -77,9 +77,9 @@ function renderToReadableStream(
7777

7878
function decodeReply<T>(
7979
body: string | FormData,
80-
webpackMap: ServerManifest,
80+
serverManifest: ServerManifest,
8181
): Thenable<T> {
82-
const response = createResponse(webpackMap);
82+
const response = createResponse(serverManifest);
8383
if (typeof body === 'string') {
8484
resolveField(response, 0, body);
8585
} else {

packages/react-server-dom-webpack/src/ReactFlightDOMServerEdge.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@ type Options = {
3636

3737
function renderToReadableStream(
3838
model: ReactClientValue,
39-
webpackMap: ClientManifest,
39+
clientManifest: ClientManifest,
4040
options?: Options,
4141
): ReadableStream {
4242
const request = createRequest(
4343
model,
44-
webpackMap,
44+
clientManifest,
4545
options ? options.onError : undefined,
4646
options ? options.context : undefined,
4747
options ? options.identifierPrefix : undefined,
@@ -77,9 +77,9 @@ function renderToReadableStream(
7777

7878
function decodeReply<T>(
7979
body: string | FormData,
80-
webpackMap: ServerManifest,
80+
serverManifest: ServerManifest,
8181
): Thenable<T> {
82-
const response = createResponse(webpackMap);
82+
const response = createResponse(serverManifest);
8383
if (typeof body === 'string') {
8484
resolveField(response, 0, body);
8585
} else {

0 commit comments

Comments
 (0)