'use strict';
import fs from 'fs';
import os from 'os';
import path from 'path';
import {patchSetImmediate} from '../../../../scripts/jest/patchSetImmediate';
let clientExports;
let webpackMap;
let webpackModules;
let webpackModuleLoading;
let React;
let ReactDOMServer;
let ReactDOMFizzStatic;
let ReactServer;
let ReactServerDOMServer;
let ReactServerDOMStaticServer;
let ReactServerDOMClient;
let Stream;
let use;
let assertConsoleErrorDev;
let serverAct;
const streamOptions = {
objectMode: true,
};
describe('ReactFlightDOMNode', () => {
beforeEach(() => {
jest.resetModules();
patchSetImmediate();
serverAct = require('internal-test-utils').serverAct;
jest.mock('react', () => require('react/react.react-server'));
jest.mock('react-server-dom-webpack/server', () =>
jest.requireActual('react-server-dom-webpack/server.node'),
);
ReactServer = require('react');
ReactServerDOMServer = require('react-server-dom-webpack/server');
jest.mock('react-server-dom-webpack/static', () =>
jest.requireActual('react-server-dom-webpack/static.node'),
);
ReactServerDOMStaticServer = require('react-server-dom-webpack/static');
const WebpackMock = require('./utils/WebpackMock');
clientExports = WebpackMock.clientExports;
webpackMap = WebpackMock.webpackMap;
webpackModules = WebpackMock.webpackModules;
webpackModuleLoading = WebpackMock.moduleLoading;
jest.resetModules();
__unmockReact();
jest.unmock('react-server-dom-webpack/server');
jest.mock('react-server-dom-webpack/client', () =>
jest.requireActual('react-server-dom-webpack/client.node'),
);
React = require('react');
ReactDOMServer = require('react-dom/server.node');
ReactDOMFizzStatic = require('react-dom/static');
ReactServerDOMClient = require('react-server-dom-webpack/client');
Stream = require('stream');
use = React.use;
const InternalTestUtils = require('internal-test-utils');
assertConsoleErrorDev = InternalTestUtils.assertConsoleErrorDev;
});
function filterStackFrame(filename, functionName) {
return (
filename !== '' &&
!filename.startsWith('node:') &&
!filename.includes('node_modules') &&
(!filename.includes('/packages/') || filename.includes('/__tests__/')) &&
!filename.includes('/build/')
);
}
const relativeFilename = path.relative(__dirname, __filename);
function normalizeCodeLocInfo(str, {preserveLocation = false} = {}) {
return (
str &&
str.replace(
/^ +(?:at|in) ([\S]+) ([^\n]*)/gm,
function (m, name, location) {
return (
' in ' +
name +
(/:\d+:\d+/.test(m)
? preserveLocation
? ' ' + location.replace(__filename, relativeFilename)
: ' (at **)'
: '')
);
},
)
);
}
function ignoreListStack(str) {
if (!str) {
return str;
}
let ignoreListedStack = '';
const lines = str.split('\n');
for (const line of lines) {
if (line.indexOf(__filename) === -1) {
} else {
ignoreListedStack += '\n' + line.replace(__dirname, '.');
}
}
return ignoreListedStack;
}
function readResult(stream) {
return new Promise((resolve, reject) => {
let buffer = '';
const writable = new Stream.PassThrough(streamOptions);
writable.setEncoding('utf8');
writable.on('data', chunk => {
buffer += chunk;
});
writable.on('error', error => {
reject(error);
});
writable.on('end', () => {
resolve(buffer);
});
stream.pipe(writable);
});
}
async function readWebResult(webStream: ReadableStream<Uint8Array>) {
const reader = webStream.getReader();
let result = '';
while (true) {
const {done, value} = await reader.read();
if (done) {
return result;
}
result += Buffer.from(value).toString('utf8');
}
}
async function createBufferedUnclosingStream(
stream: ReadableStream<Uint8Array>,
): Promise<ReadableStream<Uint8Array>> {
const chunks: Array<Uint8Array> = [];
const reader = stream.getReader();
while (true) {
const {done, value} = await reader.read();
if (done) {
break;
} else {
chunks.push(value);
}
}
let i = 0;
return new ReadableStream({
async pull(controller) {
if (i < chunks.length) {
controller.enqueue(chunks[i++]);
}
},
});
}
function createDelayedStream() {
let resolveDelayedStream;
const promise = new Promise(resolve => (resolveDelayedStream = resolve));
const delayedStream = new Stream.Transform({
...streamOptions,
transform(chunk, encoding, callback) {
promise.then(() => {
this.push(chunk);
callback();
});
},
});
return {delayedStream, resolveDelayedStream};
}
it('should support web streams in node', async () => {
function Text({children}) {
return <span>{children}</span>;
}
const largeString = 'world'.repeat(1000);
function HTML() {
return (
<div>
<Text>hello</Text>
<Text>{largeString}</Text>
</div>
);
}
function App() {
const model = {
html: <HTML />,
};
return model;
}
const readable = await serverAct(() =>
ReactServerDOMServer.renderToReadableStream(<App />, webpackMap),
);
const response = ReactServerDOMClient.createFromReadableStream(readable, {
serverConsumerManifest: {
moduleMap: null,
moduleLoading: null,
},
});
const model = await response;
expect(model).toEqual({
html: (
<div>
<span>hello</span>
<span>{largeString}</span>
</div>
),
});
});
it('should allow an alternative module mapping to be used for SSR', async () => {
function ClientComponent() {
return <span>Client Component</span>;
}
const ClientComponentOnTheClient = clientExports(
ClientComponent,
123,
'path/to/chunk.js',
);
const ClientComponentOnTheServer = clientExports(ClientComponent);
const clientId = webpackMap[ClientComponentOnTheClient.$$id].id;
delete webpackModules[clientId];
const ssrMetadata = webpackMap[ClientComponentOnTheServer.$$id];
const translationMap = {
[clientId]: {
'*': ssrMetadata,
},
};
const serverConsumerManifest = {
moduleMap: translationMap,
moduleLoading: webpackModuleLoading,
};
function App() {
return <ClientComponentOnTheClient />;
}
const stream = await serverAct(() =>
ReactServerDOMServer.renderToPipeableStream(<App />, webpackMap),
);
const readable = new Stream.PassThrough(streamOptions);
let response;
stream.pipe(readable);
function ClientRoot() {
if (response) return use(response);
response = ReactServerDOMClient.createFromNodeStream(
readable,
serverConsumerManifest,
);
return use(response);
}
const ssrStream = await serverAct(() =>
ReactDOMServer.renderToPipeableStream(<ClientRoot />),
);
const result = await readResult(ssrStream);
expect(result).toEqual(
'<script src="/path/to/chunk.js" async=""></script><span>Client Component</span>',
);
});
it('should encode long string in a compact format', async () => {
const testString = '"\n\t'.repeat(500) + '🙃';
const stream = await serverAct(() =>
ReactServerDOMServer.renderToPipeableStream({
text: testString,
}),
);
const readable = new Stream.PassThrough(streamOptions);
const stringResult = readResult(readable);
const parsedResult = ReactServerDOMClient.createFromNodeStream(readable, {
moduleMap: {},
moduleLoading: webpackModuleLoading,
});
stream.pipe(readable);
const serializedContent = await stringResult;
expect(serializedContent.length).toBeLessThan(2000);
expect(serializedContent).not.toContain('\\n');
expect(serializedContent).not.toContain('\\t');
expect(serializedContent).not.toContain('\\"');
expect(serializedContent).toContain('\t');
const result = await parsedResult;
expect(result.text).toBe(testString);
});
it('should be able to serialize any kind of typed array', async () => {
const buffer = new Uint8Array([
123, 4, 10, 5, 100, 255, 244, 45, 56, 67, 43, 124, 67, 89, 100, 20,
]).buffer;
const buffers = [
buffer,
new Int8Array(buffer, 1),
new Uint8Array(buffer, 2),
new Uint8ClampedArray(buffer, 2),
new Int16Array(buffer, 2),
new Uint16Array(buffer, 2),
new Int32Array(buffer, 4),
new Uint32Array(buffer, 4),
new Float32Array(buffer, 4),
new Float64Array(buffer, 0),
new BigInt64Array(buffer, 0),
new BigUint64Array(buffer, 0),
new DataView(buffer, 3),
];
const stream = await serverAct(() =>
ReactServerDOMServer.renderToPipeableStream(buffers),
);
const readable = new Stream.PassThrough(streamOptions);
const promise = ReactServerDOMClient.createFromNodeStream(readable, {
moduleMap: {},
moduleLoading: webpackModuleLoading,
});
stream.pipe(readable);
const result = await promise;
expect(result).toEqual(buffers);
});
it('should allow accept a nonce option for Flight preinitialized scripts', async () => {
function ClientComponent() {
return <span>Client Component</span>;
}
const ClientComponentOnTheClient = clientExports(
ClientComponent,
123,
'path/to/chunk.js',
);
const ClientComponentOnTheServer = clientExports(ClientComponent);
const clientId = webpackMap[ClientComponentOnTheClient.$$id].id;
delete webpackModules[clientId];
const ssrMetadata = webpackMap[ClientComponentOnTheServer.$$id];
const translationMap = {
[clientId]: {
'*': ssrMetadata,
},
};
const serverConsumerManifest = {
moduleMap: translationMap,
moduleLoading: webpackModuleLoading,
};
function App() {
return <ClientComponentOnTheClient />;
}
const stream = await serverAct(() =>
ReactServerDOMServer.renderToPipeableStream(<App />, webpackMap),
);
const readable = new Stream.PassThrough(streamOptions);
let response;
stream.pipe(readable);
function ClientRoot() {
if (response) return use(response);
response = ReactServerDOMClient.createFromNodeStream(
readable,
serverConsumerManifest,
{
nonce: 'r4nd0m',
},
);
return use(response);
}
const ssrStream = await serverAct(() =>
ReactDOMServer.renderToPipeableStream(<ClientRoot />),
);
const result = await readResult(ssrStream);
expect(result).toEqual(
'<script src="/path/to/chunk.js" async="" nonce="r4nd0m"></script><span>Client Component</span>',
);
});
it('should cancel the underlying and transported ReadableStreams when we are cancelled', async () => {
let controller;
let cancelReason;
const s = new ReadableStream({
start(c) {
controller = c;
},
cancel(r) {
cancelReason = r;
},
});
const rscStream = await serverAct(() =>
ReactServerDOMServer.renderToPipeableStream(
s,
{},
{
onError(error) {
return error.message;
},
},
),
);
const readable = new Stream.PassThrough(streamOptions);
rscStream.pipe(readable);
const result = await ReactServerDOMClient.createFromNodeStream(readable, {
moduleMap: {},
moduleLoading: webpackModuleLoading,
});
const reader = result.getReader();
controller.enqueue('hi');
await serverAct(async () => {
expect(await reader.read()).toEqual({
value: 'hi',
done: false,
});
});
const reason = new Error('aborted');
readable.destroy(reason);
await new Promise(resolve => {
readable.on('error', () => {
resolve();
});
});
expect(cancelReason.message).toBe(
'The destination stream errored while writing data.',
);
let error = null;
try {
await reader.read();
} catch (x) {
error = x;
}
expect(error).toBe(reason);
});
it('should cancel the underlying and transported ReadableStreams when we abort', async () => {
const errors = [];
let controller;
let cancelReason;
const s = new ReadableStream({
start(c) {
controller = c;
},
cancel(r) {
cancelReason = r;
},
});
const rscStream = await serverAct(() =>
ReactServerDOMServer.renderToPipeableStream(
s,
{},
{
onError(x) {
errors.push(x);
return x.message;
},
},
),
);
const readable = new Stream.PassThrough(streamOptions);
rscStream.pipe(readable);
const result = await ReactServerDOMClient.createFromNodeStream(readable, {
moduleMap: {},
moduleLoading: webpackModuleLoading,
});
const reader = result.getReader();
controller.enqueue('hi');
const reason = new Error('aborted');
rscStream.abort(reason);
expect(cancelReason).toBe(reason);
let error = null;
try {
await reader.read();
} catch (x) {
error = x;
}
expect(error.digest).toBe('aborted');
expect(errors).toEqual([reason]);
});
it('can prerender', async () => {
let resolveGreeting;
const greetingPromise = new Promise(resolve => {
resolveGreeting = resolve;
});
function App() {
return (
<div>
<Greeting />
</div>
);
}
async function Greeting() {
await greetingPromise;
return 'hello world';
}
const {pendingResult} = await serverAct(async () => {
return {
pendingResult: ReactServerDOMStaticServer.prerenderToNodeStream(
<App />,
webpackMap,
),
};
});
resolveGreeting();
const {prelude} = await pendingResult;
function ClientRoot({response}) {
return use(response);
}
const response = ReactServerDOMClient.createFromNodeStream(prelude, {
serverConsumerManifest: {
moduleMap: null,
moduleLoading: null,
},
});
const ssrStream = await serverAct(() =>
ReactDOMServer.renderToPipeableStream(
React.createElement(ClientRoot, {response}),
),
);
const result = await readResult(ssrStream);
expect(result).toBe('<div>hello world</div>');
});
it('does not propagate abort reasons errors when aborting a prerender', async () => {
let resolveGreeting;
const greetingPromise = new Promise(resolve => {
resolveGreeting = resolve;
});
function App() {
return (
<div>
<ReactServer.Suspense fallback="loading...">
<Greeting />
</ReactServer.Suspense>
</div>
);
}
async function Greeting() {
await greetingPromise;
return 'hello world';
}
const controller = new AbortController();
const errors = [];
const {pendingResult} = await serverAct(async () => {
return {
pendingResult: ReactServerDOMStaticServer.prerenderToNodeStream(
<App />,
webpackMap,
{
signal: controller.signal,
onError(err) {
errors.push(err);
},
},
),
};
});
controller.abort('boom');
resolveGreeting();
const {prelude} = await serverAct(() => pendingResult);
expect(errors).toEqual([]);
function ClientRoot({response}) {
return use(response);
}
const response = ReactServerDOMClient.createFromNodeStream(prelude, {
serverConsumerManifest: {
moduleMap: null,
moduleLoading: null,
},
});
errors.length = 0;
const ssrStream = await serverAct(() =>
ReactDOMServer.renderToPipeableStream(
React.createElement(ClientRoot, {response}),
{
onError(error) {
errors.push(error);
},
},
),
);
ssrStream.abort('bam');
expect(errors).toEqual([new Error('Connection closed.')]);
const result = await readResult(ssrStream);
expect(result).toContain('loading...');
});
it('includes source locations in component and owner stacks for halted components', async () => {
async function Component() {
await new Promise(() => {});
return null;
}
function App() {
return ReactServer.createElement(
'html',
null,
ReactServer.createElement(
'body',
null,
ReactServer.createElement(
ReactServer.Suspense,
{fallback: 'Loading...'},
ReactServer.createElement(Component, null),
),
),
);
}
const errors = [];
const serverAbortController = new AbortController();
const {pendingResult} = await serverAct(async () => {
return {
pendingResult: ReactServerDOMStaticServer.prerender(
ReactServer.createElement(App, null),
webpackMap,
{
signal: serverAbortController.signal,
onError(error) {
errors.push(error);
},
},
),
};
});
await await serverAct(
async () =>
new Promise(resolve => {
setImmediate(() => {
serverAbortController.abort();
resolve();
});
}),
);
const {prelude} = await pendingResult;
expect(errors).toEqual([]);
function ClientRoot({response}) {
return use(response);
}
const prerenderResponse = ReactServerDOMClient.createFromReadableStream(
await createBufferedUnclosingStream(prelude),
{
serverConsumerManifest: {
moduleMap: null,
moduleLoading: null,
},
},
);
let componentStack;
let ownerStack;
const clientAbortController = new AbortController();
const fizzPrerenderStreamResult = ReactDOMFizzStatic.prerender(
React.createElement(ClientRoot, {response: prerenderResponse}),
{
signal: clientAbortController.signal,
onError(error, errorInfo) {
componentStack = errorInfo.componentStack;
ownerStack = React.captureOwnerStack
? React.captureOwnerStack()
: null;
},
},
);
await await serverAct(
async () =>
new Promise(resolve => {
setImmediate(() => {
clientAbortController.abort();
resolve();
});
}),
);
const fizzPrerenderStream = await fizzPrerenderStreamResult;
const prerenderHTML = await readWebResult(fizzPrerenderStream.prelude);
expect(prerenderHTML).toContain('Loading...');
if (__DEV__) {
expect(normalizeCodeLocInfo(componentStack)).toBe(
'\n' +
' in Component' +
(gate(flags => flags.enableAsyncDebugInfo) ? ' (at **)\n' : '\n') +
' in Suspense\n' +
' in body\n' +
' in html\n' +
' in App (at **)\n' +
' in ClientRoot (at **)',
);
} else {
expect(normalizeCodeLocInfo(componentStack)).toBe(
'\n in Suspense\n' +
' in body\n' +
' in html\n' +
' in ClientRoot (at **)',
);
}
if (__DEV__) {
if (gate(flags => flags.enableAsyncDebugInfo)) {
expect(normalizeCodeLocInfo(ownerStack)).toBe(
'\n in Component (at **)\n in App (at **)',
);
} else {
expect(normalizeCodeLocInfo(ownerStack)).toBe('\n in App (at **)');
}
} else {
expect(ownerStack).toBeNull();
}
});
it('includes source locations in component and owner stacks for halted Client components', async () => {
function SharedComponent({p1, p2, p3}) {
use(p1);
use(p2);
use(p3);
return <div>Hello, Dave!</div>;
}
const ClientComponentOnTheServer = clientExports(SharedComponent);
const ClientComponentOnTheClient = clientExports(
SharedComponent,
123,
'path/to/chunk.js',
);
let resolvePendingPromise;
function ServerComponent() {
const p1 = Promise.resolve();
const p2 = new Promise(resolve => {
resolvePendingPromise = value => {
p2.status = 'fulfilled';
p2.value = value;
resolve(value);
};
});
const p3 = new Promise(() => {});
return ReactServer.createElement(ClientComponentOnTheClient, {
p1: p1,
p2: p2,
p3: p3,
});
}
function App() {
return ReactServer.createElement(
'html',
null,
ReactServer.createElement(
'body',
null,
ReactServer.createElement(
ReactServer.Suspense,
{fallback: 'Loading...'},
ReactServer.createElement(ServerComponent, null),
),
),
);
}
const errors = [];
const rscStream = await serverAct(() =>
ReactServerDOMServer.renderToPipeableStream(
ReactServer.createElement(App, null),
webpackMap,
),
);
const readable = new Stream.PassThrough(streamOptions);
rscStream.pipe(readable);
function ClientRoot({response}) {
return use(response);
}
const serverConsumerManifest = {
moduleMap: {
[webpackMap[ClientComponentOnTheClient.$$id].id]: {
'*': webpackMap[ClientComponentOnTheServer.$$id],
},
},
moduleLoading: webpackModuleLoading,
};
expect(errors).toEqual([]);
function ClientRoot({response}) {
return use(response);
}
const response = ReactServerDOMClient.createFromNodeStream(
readable,
serverConsumerManifest,
);
let componentStack;
let ownerStack;
const clientAbortController = new AbortController();
const fizzPrerenderStreamResult = ReactDOMFizzStatic.prerender(
React.createElement(ClientRoot, {response}),
{
signal: clientAbortController.signal,
onError(error, errorInfo) {
componentStack = errorInfo.componentStack;
ownerStack = React.captureOwnerStack
? React.captureOwnerStack()
: null;
},
},
);
resolvePendingPromise('custom-instrum-resolve');
await serverAct(
async () =>
new Promise(resolve => {
setImmediate(() => {
clientAbortController.abort();
resolve();
});
}),
);
const fizzPrerenderStream = await fizzPrerenderStreamResult;
const prerenderHTML = await readWebResult(fizzPrerenderStream.prelude);
expect(prerenderHTML).toContain('Loading...');
if (__DEV__) {
expect(normalizeCodeLocInfo(componentStack)).toBe(
'\n' +
' in SharedComponent (at **)\n' +
' in ServerComponent' +
(gate(flags => flags.enableAsyncDebugInfo) ? ' (at **)' : '') +
'\n' +
' in Suspense\n' +
' in body\n' +
' in html\n' +
' in App (at **)\n' +
' in ClientRoot (at **)',
);
} else {
expect(normalizeCodeLocInfo(componentStack)).toBe(
'\n' +
' in SharedComponent (at **)\n' +
' in Suspense\n' +
' in body\n' +
' in html\n' +
' in ClientRoot (at **)',
);
}
if (__DEV__) {
expect(ignoreListStack(ownerStack)).toBe(
'' +
(gate(flags => flags.enableAsyncDebugInfo)
? '\n at SharedComponent (./ReactFlightDOMNode-test.js:817:7)'
: '') +
'\n at ServerComponent (file://./ReactFlightDOMNode-test.js:839:26)' +
'\n at App (file://./ReactFlightDOMNode-test.js:856:25)',
);
} else {
expect(ownerStack).toBeNull();
}
});
it('includes deeper location for aborted stacks', async () => {
async function getData() {
const signal = ReactServer.cacheSignal();
await new Promise((resolve, reject) => {
signal.addEventListener('abort', () => reject(signal.reason));
});
}
async function thisShouldNotBeInTheStack() {
await new Promise((resolve, reject) => {
resolve();
});
}
async function Component() {
try {
await getData();
} catch (x) {
await thisShouldNotBeInTheStack();
}
return null;
}
function App() {
return ReactServer.createElement(
'html',
null,
ReactServer.createElement(
'body',
null,
ReactServer.createElement(
ReactServer.Suspense,
{fallback: 'Loading...'},
ReactServer.createElement(Component, null),
),
),
);
}
const errors = [];
const serverAbortController = new AbortController();
const {pendingResult} = await serverAct(async () => {
return {
pendingResult: ReactServerDOMStaticServer.prerender(
ReactServer.createElement(App, null),
webpackMap,
{
signal: serverAbortController.signal,
onError(error) {
errors.push(error);
},
filterStackFrame,
},
),
};
});
await serverAct(
() =>
new Promise(resolve => {
setImmediate(() => {
serverAbortController.abort();
resolve();
});
}),
);
const {prelude} = await pendingResult;
expect(errors).toEqual([]);
function ClientRoot({response}) {
return use(response);
}
const prerenderResponse = ReactServerDOMClient.createFromReadableStream(
await createBufferedUnclosingStream(prelude),
{
serverConsumerManifest: {
moduleMap: null,
moduleLoading: null,
},
},
);
let componentStack;
let ownerStack;
const clientAbortController = new AbortController();
const fizzPrerenderStreamResult = ReactDOMFizzStatic.prerender(
React.createElement(ClientRoot, {response: prerenderResponse}),
{
signal: clientAbortController.signal,
onError(error, errorInfo) {
componentStack = errorInfo.componentStack;
ownerStack = React.captureOwnerStack
? React.captureOwnerStack()
: null;
},
},
);
await await serverAct(
async () =>
new Promise(resolve => {
setImmediate(() => {
clientAbortController.abort();
resolve();
});
}),
);
const fizzPrerenderStream = await fizzPrerenderStreamResult;
const prerenderHTML = await readWebResult(fizzPrerenderStream.prelude);
expect(prerenderHTML).toContain('Loading...');
if (__DEV__) {
expect(normalizeCodeLocInfo(componentStack)).toBe(
'\n' +
' in Component' +
(gate(flags => flags.enableAsyncDebugInfo) ? ' (at **)\n' : '\n') +
' in Suspense\n' +
' in body\n' +
' in html\n' +
' in App (at **)\n' +
' in ClientRoot (at **)',
);
} else {
expect(normalizeCodeLocInfo(componentStack)).toBe(
'\n in Suspense\n' +
' in body\n' +
' in html\n' +
' in ClientRoot (at **)',
);
}
if (__DEV__) {
if (gate(flags => flags.enableAsyncDebugInfo)) {
expect(normalizeCodeLocInfo(ownerStack)).toBe(
'' +
'\n in getData (at **)' +
'\n in Component (at **)' +
'\n in App (at **)',
);
} else {
expect(normalizeCodeLocInfo(ownerStack)).toBe(
'' + '\n in App (at **)',
);
}
} else {
expect(ownerStack).toBeNull();
}
});
it('can handle an empty prelude when prerendering', async () => {
function App() {
return null;
}
const serverAbortController = new AbortController();
serverAbortController.abort();
const errors = [];
const {pendingResult} = await serverAct(async () => {
return {
pendingResult: ReactServerDOMStaticServer.prerender(
ReactServer.createElement(App, null),
webpackMap,
{
signal: serverAbortController.signal,
onError(error) {
errors.push(error);
},
},
),
};
});
expect(errors).toEqual([]);
const {prelude} = await pendingResult;
const reader = prelude.getReader();
while (true) {
const {done} = await reader.read();
if (done) {
break;
}
}
});
it('can transport debug info through a separate debug channel', async () => {
function Thrower() {
throw new Error('ssr-throw');
}
const ClientComponentOnTheClient = clientExports(
Thrower,
123,
'path/to/chunk.js',
);
const ClientComponentOnTheServer = clientExports(Thrower);
function App() {
return ReactServer.createElement(
ReactServer.Suspense,
null,
ReactServer.createElement(ClientComponentOnTheClient, null),
);
}
const debugReadable = new Stream.PassThrough(streamOptions);
const rscStream = await serverAct(() =>
ReactServerDOMServer.renderToPipeableStream(
ReactServer.createElement(App, null),
webpackMap,
{
debugChannel: new Stream.Writable({
write(chunk, encoding, callback) {
debugReadable.write(chunk, encoding);
callback();
},
final() {
debugReadable.end();
},
}),
},
),
);
const {delayedStream, resolveDelayedStream} = createDelayedStream();
rscStream.pipe(delayedStream);
function ClientRoot({response}) {
return use(response);
}
const serverConsumerManifest = {
moduleMap: {
[webpackMap[ClientComponentOnTheClient.$$id].id]: {
'*': webpackMap[ClientComponentOnTheServer.$$id],
},
},
moduleLoading: webpackModuleLoading,
};
const response = ReactServerDOMClient.createFromNodeStream(
delayedStream,
serverConsumerManifest,
{debugChannel: debugReadable},
);
setTimeout(resolveDelayedStream);
let ownerStack;
const ssrStream = await serverAct(() =>
ReactDOMServer.renderToPipeableStream(
<ClientRoot response={response} />,
{
onError(err, errorInfo) {
ownerStack = React.captureOwnerStack
? React.captureOwnerStack()
: null;
},
},
),
);
const result = await readResult(ssrStream);
expect(normalizeCodeLocInfo(ownerStack)).toBe('\n in App (at **)');
expect(result).toContain(
'Switched to client rendering because the server rendering errored:\n\nssr-throw',
);
});
it('can transport debug info through a slow debug channel', async () => {
function Thrower() {
throw new Error('ssr-throw');
}
const ClientComponentOnTheClient = clientExports(
Thrower,
123,
'path/to/chunk.js',
);
const ClientComponentOnTheServer = clientExports(Thrower);
function App() {
return ReactServer.createElement(
ReactServer.Suspense,
null,
ReactServer.createElement(ClientComponentOnTheClient, null),
);
}
const {delayedStream, resolveDelayedStream} = createDelayedStream();
const rscStream = await serverAct(() =>
ReactServerDOMServer.renderToPipeableStream(
ReactServer.createElement(App, null),
webpackMap,
{
debugChannel: new Stream.Writable({
write(chunk, encoding, callback) {
delayedStream.write(chunk, encoding);
callback();
},
final() {
delayedStream.end();
},
}),
},
),
);
const readable = new Stream.PassThrough(streamOptions);
rscStream.pipe(readable);
function ClientRoot({response}) {
return use(response);
}
const serverConsumerManifest = {
moduleMap: {
[webpackMap[ClientComponentOnTheClient.$$id].id]: {
'*': webpackMap[ClientComponentOnTheServer.$$id],
},
},
moduleLoading: webpackModuleLoading,
};
const response = ReactServerDOMClient.createFromNodeStream(
readable,
serverConsumerManifest,
{debugChannel: delayedStream},
);
setTimeout(resolveDelayedStream);
let ownerStack;
const ssrStream = await serverAct(() =>
ReactDOMServer.renderToPipeableStream(
<ClientRoot response={response} />,
{
onError(err, errorInfo) {
ownerStack = React.captureOwnerStack
? React.captureOwnerStack()
: null;
},
},
),
);
const result = await readResult(ssrStream);
expect(normalizeCodeLocInfo(ownerStack)).toBe('\n in App (at **)');
expect(result).toContain(
'Switched to client rendering because the server rendering errored:\n\nssr-throw',
);
});
it('should not corrupt the Node.js Buffer pool by detaching ArrayBuffers when using Web Streams', async () => {
const file = path.join(os.tmpdir(), 'test.bin');
fs.writeFileSync(file, Buffer.alloc(4095));
const fileChunk = fs.readFileSync(file);
fs.unlinkSync(file);
expect(fileChunk.buffer.byteLength).toBe(8192);
const readable = await serverAct(() =>
ReactServerDOMServer.renderToReadableStream(fileChunk, webpackMap),
);
const writable = new WritableStream({
write(chunk) {
Buffer.allocUnsafe(1);
},
});
await readable.pipeTo(writable);
});
describe('with real timers', () => {
beforeEach(() => {
jest.useRealTimers();
});
afterEach(() => {
jest.useFakeTimers();
});
it('should use late-arriving I/O debug info to enhance component and owner stacks when aborting a prerender', async () => {
let resolveDynamicData1;
let resolveDynamicData2;
async function getDynamicData1() {
return new Promise(resolve => {
resolveDynamicData1 = resolve;
});
}
async function getDynamicData2() {
return new Promise(resolve => {
resolveDynamicData2 = resolve;
});
}
async function Dynamic() {
const data1 = await getDynamicData1();
const data2 = await getDynamicData2();
return ReactServer.createElement('p', null, data1, ' ', data2);
}
function App() {
return ReactServer.createElement(
'html',
null,
ReactServer.createElement(
'body',
null,
ReactServer.createElement(Dynamic),
),
);
}
let staticEndTime = -1;
const initialChunks = [];
const dynamicChunks = [];
await new Promise(resolve => {
setTimeout(async () => {
const stream = ReactServerDOMServer.renderToPipeableStream(
ReactServer.createElement(App),
webpackMap,
{filterStackFrame},
);
const passThrough = new Stream.PassThrough(streamOptions);
stream.pipe(passThrough);
passThrough.on('data', chunk => {
if (staticEndTime < 0) {
initialChunks.push(chunk);
} else {
dynamicChunks.push(chunk);
}
});
passThrough.on('end', resolve);
});
setTimeout(() => {
staticEndTime = performance.now() + performance.timeOrigin;
resolveDynamicData1('Hi');
setTimeout(() => {
resolveDynamicData2('Josh');
});
});
});
const readable = new Stream.Readable({...streamOptions, read() {}});
for (let i = 0; i < initialChunks.length; i++) {
readable.push(initialChunks[i]);
}
const abortController = new AbortController();
abortController.signal.addEventListener(
'abort',
() => {
for (let i = 0; i < dynamicChunks.length; i++) {
readable.push(dynamicChunks[i]);
}
},
{once: true},
);
const response = ReactServerDOMClient.createFromNodeStream(
readable,
{
serverConsumerManifest: {
moduleMap: null,
moduleLoading: null,
},
},
{
endTime: staticEndTime,
},
);
function ClientRoot() {
return use(response);
}
let componentStack;
let ownerStack;
const {prelude} = await new Promise(resolve => {
let result;
setTimeout(() => {
result = ReactDOMFizzStatic.prerenderToNodeStream(
React.createElement(ClientRoot),
{
signal: abortController.signal,
onError(error, errorInfo) {
componentStack = errorInfo.componentStack;
ownerStack = React.captureOwnerStack
? React.captureOwnerStack()
: null;
},
},
);
});
setTimeout(() => {
abortController.abort();
resolve(result);
});
});
const prerenderHTML = await readResult(prelude);
expect(prerenderHTML).toBe('');
if (__DEV__) {
expect(
normalizeCodeLocInfo(componentStack, {preserveLocation: true}),
).toBe(
'\n' +
' in Dynamic' +
(gate(flags => flags.enableAsyncDebugInfo)
? ' (file://ReactFlightDOMNode-test.js:1423:27)\n'
: '\n') +
' in body\n' +
' in html\n' +
' in App (file://ReactFlightDOMNode-test.js:1436:25)\n' +
' in ClientRoot (ReactFlightDOMNode-test.js:1511:16)',
);
} else {
expect(
normalizeCodeLocInfo(componentStack, {preserveLocation: true}),
).toBe(
'\n' +
' in body\n' +
' in html\n' +
' in ClientRoot (ReactFlightDOMNode-test.js:1511:16)',
);
}
if (__DEV__) {
if (gate(flags => flags.enableAsyncDebugInfo)) {
expect(
normalizeCodeLocInfo(ownerStack, {preserveLocation: true}),
).toBe(
'\n' +
' in Dynamic (file://ReactFlightDOMNode-test.js:1423:27)\n' +
' in App (file://ReactFlightDOMNode-test.js:1436:25)',
);
} else {
expect(
normalizeCodeLocInfo(ownerStack, {preserveLocation: true}),
).toBe(
'' +
'\n' +
' in App (file://ReactFlightDOMNode-test.js:1436:25)',
);
}
} else {
expect(ownerStack).toBeNull();
}
});
function createReadableWithLateRelease(initialChunks, lateChunks, signal) {
const readable = new Stream.Readable({...streamOptions, read() {}});
for (let i = 0; i < initialChunks.length; i++) {
readable.push(initialChunks[i]);
}
signal.addEventListener(
'abort',
() => {
for (let i = 0; i < lateChunks.length; i++) {
readable.push(lateChunks[i]);
}
setImmediate(() => {
readable.push(null);
});
},
{once: true},
);
return readable;
}
async function reencodeFlightStream(
staticChunks,
dynamicChunks,
startTime,
serverConsumerManifest,
) {
let staticEndTime = -1;
const chunks = {
static: [],
dynamic: [],
};
await new Promise(async resolve => {
const renderStageController = new AbortController();
const serverStream = createReadableWithLateRelease(
staticChunks,
dynamicChunks,
renderStageController.signal,
);
const decoded = await ReactServerDOMClient.createFromNodeStream(
serverStream,
serverConsumerManifest,
{
endTime: undefined,
},
);
setTimeout(async () => {
const stream = ReactServerDOMServer.renderToPipeableStream(
decoded,
webpackMap,
{
filterStackFrame,
startTime,
},
);
const passThrough = new Stream.PassThrough(streamOptions);
passThrough.on('data', chunk => {
if (!renderStageController.signal.aborted) {
chunks.static.push(chunk);
} else {
chunks.dynamic.push(chunk);
}
});
passThrough.on('end', resolve);
stream.pipe(passThrough);
});
setTimeout(() => {
staticEndTime = performance.now() + performance.timeOrigin;
renderStageController.abort();
});
});
return {chunks, staticEndTime};
}
it('can preserve old IO info when decoding and re-encoding a stream with options.startTime', async () => {
let resolveDynamicData;
function getDynamicData() {
return new Promise(resolve => {
resolveDynamicData = resolve;
});
}
async function Dynamic() {
const data = await getDynamicData();
return ReactServer.createElement('p', null, data);
}
function App() {
return ReactServer.createElement(
'html',
null,
ReactServer.createElement(
'body',
null,
ReactServer.createElement(
ReactServer.Suspense,
{fallback: 'Loading...'},
ReactServer.createElement(
'section',
null,
ReactServer.createElement(Dynamic),
),
),
),
);
}
const resolveDynamic = () => {
resolveDynamicData('Hi Janka');
};
let startTime = -1;
let isStatic = true;
const chunks1 = {
static: [],
dynamic: [],
};
await new Promise(resolve => {
setTimeout(async () => {
startTime = performance.now() + performance.timeOrigin;
const stream = ReactServerDOMServer.renderToPipeableStream(
ReactServer.createElement(App),
webpackMap,
{
filterStackFrame,
startTime,
environmentName() {
return isStatic ? 'Prerender' : 'Server';
},
},
);
const passThrough = new Stream.PassThrough(streamOptions);
passThrough.on('data', chunk => {
if (isStatic) {
chunks1.static.push(chunk);
} else {
chunks1.dynamic.push(chunk);
}
});
passThrough.on('end', resolve);
stream.pipe(passThrough);
});
setTimeout(() => {
isStatic = false;
resolveDynamic();
});
});
const serverConsumerManifest = {
moduleMap: null,
moduleLoading: null,
};
const {chunks: chunks2, staticEndTime: reencodeStaticEndTime} =
await reencodeFlightStream(
chunks1.static,
chunks1.dynamic,
startTime,
serverConsumerManifest,
);
function ClientRoot({response}) {
return use(response);
}
let ssrStream;
let ownerStack;
let componentStack;
await new Promise(async (resolve, reject) => {
const renderController = new AbortController();
const serverStream = createReadableWithLateRelease(
chunks2.static,
chunks2.dynamic,
renderController.signal,
);
const decodedPromise = ReactServerDOMClient.createFromNodeStream(
serverStream,
serverConsumerManifest,
{
endTime: reencodeStaticEndTime,
},
);
setTimeout(() => {
ssrStream = ReactDOMServer.renderToPipeableStream(
React.createElement(ClientRoot, {
response: decodedPromise,
}),
{
onError(err, errorInfo) {
componentStack = errorInfo.componentStack;
ownerStack = React.captureOwnerStack
? React.captureOwnerStack()
: null;
return null;
},
},
);
renderController.signal.addEventListener(
'abort',
() => {
const {reason} = renderController.signal;
ssrStream.abort(reason);
},
{
once: true,
},
);
});
setTimeout(() => {
renderController.abort(new Error('ssr-abort'));
resolve();
});
});
const result = await readResult(ssrStream);
expect(normalizeCodeLocInfo(componentStack)).toBe(
'\n' +
' in section\n' +
' in Suspense\n' +
' in body\n' +
' in html\n' +
' in App (at **)\n' +
' in ClientRoot (at **)',
);
expect(normalizeCodeLocInfo(ownerStack)).toBe(
'\n' +
gate(flags =>
flags.enableAsyncDebugInfo
? ' in Dynamic (at **)\n'
: ' in section\n',
) +
' in App (at **)',
);
expect(result).toContain(
'Switched to client rendering because the server rendering aborted due to:\n\n' +
'ssr-abort',
);
});
});
it('warns with a tailored message if eval is not available in dev', async () => {
const previousEval = globalThis.eval.bind(globalThis);
globalThis.eval = () => {
throw new Error('eval is disabled');
};
try {
const readable = await serverAct(() =>
ReactServerDOMServer.renderToReadableStream({}, webpackMap),
);
assertConsoleErrorDev([]);
await ReactServerDOMClient.createFromReadableStream(readable, {
serverConsumerManifest: {
moduleMap: null,
moduleLoading: null,
},
});
assertConsoleErrorDev([
'eval() is not supported in this environment. ' +
'This can happen if you started the Node.js process with --disallow-code-generation-from-strings, ' +
'or if `eval` was patched by other means. ' +
'React requires eval() in development mode for various debugging features ' +
'like reconstructing callstacks from a different environment.\n' +
'React will never use eval() in production mode',
]);
} finally {
globalThis.eval = previousEval;
}
});
});