mirror of
https://github.com/facebook/react.git
synced 2025-11-01 09:12:30 +00:00
Sebastian Markbåge
56389e81ff
Add aborting to the Flight Server. This encodes the reason as an "error" row that gets thrown client side. These are still exposed in prod which is a follow up we'll still have to do to encode them as digests instead. The error is encoded once and then referenced by each row that needs to be updated.
151 lines
3.0 KiB
JavaScript
151 lines
3.0 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 {stringToChunk} from './ReactServerStreamConfig';
|
|
|
|
import type {Chunk} from './ReactServerStreamConfig';
|
|
|
|
export type {Destination, Chunk} from './ReactServerStreamConfig';
|
|
|
|
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 stringToChunk(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 stringToChunk(row);
|
|
}
|
|
|
|
export function processReferenceChunk(
|
|
request: Request,
|
|
id: number,
|
|
reference: string,
|
|
): Chunk {
|
|
const json = stringify(reference);
|
|
const row = serializeRowHeader('J', id) + json + '\n';
|
|
return stringToChunk(row);
|
|
}
|
|
|
|
export function processModuleChunk(
|
|
request: Request,
|
|
id: number,
|
|
moduleMetaData: ReactModel,
|
|
): Chunk {
|
|
const json = stringify(moduleMetaData);
|
|
const row = serializeRowHeader('M', id) + json + '\n';
|
|
return stringToChunk(row);
|
|
}
|
|
|
|
export function processProviderChunk(
|
|
request: Request,
|
|
id: number,
|
|
contextName: string,
|
|
): Chunk {
|
|
const row = serializeRowHeader('P', id) + contextName + '\n';
|
|
return stringToChunk(row);
|
|
}
|
|
|
|
export function processSymbolChunk(
|
|
request: Request,
|
|
id: number,
|
|
name: string,
|
|
): Chunk {
|
|
const json = stringify(name);
|
|
const row = serializeRowHeader('S', id) + json + '\n';
|
|
return stringToChunk(row);
|
|
}
|
|
|
|
export {
|
|
scheduleWork,
|
|
flushBuffered,
|
|
beginWriting,
|
|
writeChunk,
|
|
writeChunkAndReturn,
|
|
completeWriting,
|
|
close,
|
|
closeWithError,
|
|
} from './ReactServerStreamConfig';
|