ffd8423356
* Refactor Flight to require a module reference to be brand checked This exposes a host environment (bundler) specific hook to check if an object is a module reference. This will be used so that they can be passed directly into Flight without needing additional wrapper objects. * Emit module references as a special type of value We already have JSON and errors as special types of "rows". This encodes module references as a special type of row value. This was always the intention because it allows those values to be emitted first in the stream so that as a large models stream down, we can start preloading as early as possible. We preload the module when they resolve but we lazily require them as they are referenced. * Emit module references where ever they occur This emits module references where ever they occur. In blocks or even directly in elements. * Don't special case the root row I originally did this so that a simple stream is also just plain JSON. However, since we might want to emit things like modules before the root module in the stream, this gets unnecessarily complicated. We could add this back as a special case if it's the first byte written but meh. * Update the protocol * Add test for using a module reference as a client component * Relax element type check Since Flight now accepts a module reference as returned by any bundler system, depending on the renderer running. We need to drastically relax the check to include all of them. We can add more as we discover them. * Move flow annotation Seems like our compiler is not happy with stripping this. * Some bookkeeping bug * Can't use the private field to check
120 lines
2.3 KiB
JavaScript
120 lines
2.3 KiB
JavaScript
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @flow
|
|
*/
|
|
|
|
// This file is an intermediate layer to translate between Flight
|
|
// calls to stream output over a binary stream.
|
|
|
|
/*
|
|
FLIGHT PROTOCOL GRAMMAR
|
|
|
|
Response
|
|
- RowSequence
|
|
|
|
RowSequence
|
|
- Row RowSequence
|
|
- Row
|
|
|
|
Row
|
|
- "J" RowID JSONData
|
|
- "M" RowID JSONModuleData
|
|
- "H" RowID HTMLData
|
|
- "B" RowID BlobData
|
|
- "U" RowID URLData
|
|
- "E" RowID ErrorData
|
|
|
|
RowID
|
|
- HexDigits ":"
|
|
|
|
HexDigits
|
|
- HexDigit HexDigits
|
|
- HexDigit
|
|
|
|
HexDigit
|
|
- 0-F
|
|
|
|
URLData
|
|
- (UTF8 encoded URL) "\n"
|
|
|
|
ErrorData
|
|
- (UTF8 encoded JSON: {message: "...", stack: "..."}) "\n"
|
|
|
|
JSONData
|
|
- (UTF8 encoded JSON) "\n"
|
|
- String values that begin with $ are escaped with a "$" prefix.
|
|
- References to other rows are encoding as JSONReference strings.
|
|
|
|
JSONReference
|
|
- "$" HexDigits
|
|
|
|
HTMLData
|
|
- ByteSize (UTF8 encoded HTML)
|
|
|
|
BlobData
|
|
- ByteSize (Binary Data)
|
|
|
|
ByteSize
|
|
- (unsigned 32-bit integer)
|
|
*/
|
|
|
|
// TODO: Implement HTMLData, BlobData and URLData.
|
|
|
|
import type {Request, ReactModel} from 'react-server/src/ReactFlightServer';
|
|
|
|
import {convertStringToBuffer} from './ReactServerStreamConfig';
|
|
|
|
export type {Destination} from './ReactServerStreamConfig';
|
|
|
|
export type Chunk = Uint8Array;
|
|
|
|
const stringify = JSON.stringify;
|
|
|
|
function serializeRowHeader(tag: string, id: number) {
|
|
return tag + id.toString(16) + ':';
|
|
}
|
|
|
|
export function processErrorChunk(
|
|
request: Request,
|
|
id: number,
|
|
message: string,
|
|
stack: string,
|
|
): Chunk {
|
|
const errorInfo = {message, stack};
|
|
const row = serializeRowHeader('E', id) + stringify(errorInfo) + '\n';
|
|
return convertStringToBuffer(row);
|
|
}
|
|
|
|
export function processModelChunk(
|
|
request: Request,
|
|
id: number,
|
|
model: ReactModel,
|
|
): Chunk {
|
|
const json = stringify(model, request.toJSON);
|
|
const row = serializeRowHeader('J', id) + json + '\n';
|
|
return convertStringToBuffer(row);
|
|
}
|
|
|
|
export function processModuleChunk(
|
|
request: Request,
|
|
id: number,
|
|
moduleMetaData: ReactModel,
|
|
): Chunk {
|
|
const json = stringify(moduleMetaData);
|
|
const row = serializeRowHeader('M', id) + json + '\n';
|
|
return convertStringToBuffer(row);
|
|
}
|
|
|
|
export {
|
|
scheduleWork,
|
|
flushBuffered,
|
|
beginWriting,
|
|
writeChunk,
|
|
completeWriting,
|
|
close,
|
|
} from './ReactServerStreamConfig';
|