Skip to content

Commit a127ca0

Browse files
sebmarkbagesebmarkbage
committed
Rename to renderToPipeableStream
This mimics the renderToReadableStream API for the browser.
1 parent 460b829 commit a127ca0

File tree

10 files changed

+74
-60
lines changed

10 files changed

+74
-60
lines changed

‎fixtures/flight/server/handler.server.js

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
'use strict';
22

3-
const {renderToNodePipe} = require('react-server-dom-webpack/writer');
3+
const {renderToPipeableStream} = require('react-server-dom-webpack/writer');
44
const {readFile} = require('fs');
55
const {resolve} = require('path');
66
const React = require('react');
@@ -20,7 +20,10 @@ module.exports = function(req, res) {
2020
const App = m.default.default || m.default;
2121
res.setHeader('Access-Control-Allow-Origin', '*');
2222
const moduleMap = JSON.parse(data);
23-
const {pipe} = renderToNodePipe(React.createElement(App), moduleMap);
23+
const {pipe} = renderToPipeableStream(
24+
React.createElement(App),
25+
moduleMap
26+
);
2427
pipe(res);
2528
}
2629
);

‎fixtures/ssr/server/render.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import React from 'react';
2-
import {renderToNodePipe} from 'react-dom/server';
2+
import {renderToPipeableStream} from 'react-dom/server';
33

44
import App from '../src/components/App';
55

@@ -20,7 +20,7 @@ export default function render(url, res) {
2020
console.error('Fatal', error);
2121
});
2222
let didError = false;
23-
const {pipe, abort} = renderToNodePipe(<App assets={assets} />, {
23+
const {pipe, abort} = renderToPipeableStream(<App assets={assets} />, {
2424
onCompleteShell() {
2525
// If something errored before we started streaming, we set the error code appropriately.
2626
res.statusCode = didError ? 500 : 200;

‎fixtures/ssr2/server/render.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
import * as React from 'react';
1010
// import {renderToString} from 'react-dom/server';
11-
import {renderToNodePipe} from 'react-dom/server';
11+
import {renderToPipeableStream} from 'react-dom/server';
1212
import App from '../src/App';
1313
import {DataProvider} from '../src/data';
1414
import {API_DELAY, ABORT_DELAY} from './delays';
@@ -37,7 +37,7 @@ module.exports = function render(url, res) {
3737
});
3838
let didError = false;
3939
const data = createServerData();
40-
const {pipe, abort} = renderToNodePipe(
40+
const {pipe, abort} = renderToPipeableStream(
4141
<DataProvider data={data}>
4242
<App assets={assets} />
4343
</DataProvider>,

‎packages/react-dom/npm/server.node.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ exports.renderToString = l.renderToString;
1414
exports.renderToStaticMarkup = l.renderToStaticMarkup;
1515
exports.renderToNodeStream = l.renderToNodeStream;
1616
exports.renderToStaticNodeStream = l.renderToStaticNodeStream;
17-
exports.renderToNodePipe = s.renderToNodePipe;
17+
exports.renderToPipeableStream = s.renderToPipeableStream;

‎packages/react-dom/server.node.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ export function renderToStaticNodeStream() {
3636
);
3737
}
3838

39-
export function renderToNodePipe() {
40-
return require('./src/server/ReactDOMFizzServerNode').renderToNodePipe.apply(
39+
export function renderToPipeableStream() {
40+
return require('./src/server/ReactDOMFizzServerNode').renderToPipeableStream.apply(
4141
this,
4242
arguments,
4343
);

‎packages/react-dom/src/__tests__/ReactDOMFizzServer-test.js

+26-26
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ describe('ReactDOMFizzServer', () => {
239239
};
240240

241241
await act(async () => {
242-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
242+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
243243
<div>
244244
<div>
245245
<Suspense fallback={<Text text="Loading..." />}>
@@ -303,7 +303,7 @@ describe('ReactDOMFizzServer', () => {
303303
}
304304

305305
await act(async () => {
306-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
306+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
307307
<App isClient={false} />,
308308

309309
{
@@ -355,7 +355,7 @@ describe('ReactDOMFizzServer', () => {
355355
});
356356

357357
await act(async () => {
358-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
358+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
359359
<div>
360360
<Suspense fallback={<Text text="Loading..." />}>
361361
{lazyElement}
@@ -394,7 +394,7 @@ describe('ReactDOMFizzServer', () => {
394394
}
395395

396396
await act(async () => {
397-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
397+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
398398
<App isClient={false} />,
399399

400400
{
@@ -439,7 +439,7 @@ describe('ReactDOMFizzServer', () => {
439439
// @gate experimental
440440
it('should asynchronously load the suspense boundary', async () => {
441441
await act(async () => {
442-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
442+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
443443
<div>
444444
<Suspense fallback={<Text text="Loading..." />}>
445445
<AsyncText text="Hello World" />
@@ -472,7 +472,7 @@ describe('ReactDOMFizzServer', () => {
472472
}
473473

474474
await act(async () => {
475-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(<App />);
475+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(<App />);
476476
pipe(writable);
477477
});
478478

@@ -544,7 +544,7 @@ describe('ReactDOMFizzServer', () => {
544544

545545
// We originally suspend the boundary and start streaming the loading state.
546546
await act(async () => {
547-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
547+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
548548
<App />,
549549

550550
{
@@ -627,7 +627,7 @@ describe('ReactDOMFizzServer', () => {
627627

628628
// We originally suspend the boundary and start streaming the loading state.
629629
await act(async () => {
630-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
630+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
631631
<App showMore={false} />,
632632
);
633633
pipe(writable);
@@ -694,7 +694,7 @@ describe('ReactDOMFizzServer', () => {
694694

695695
let controls;
696696
await act(async () => {
697-
controls = ReactDOMFizzServer.renderToNodePipe(<App />);
697+
controls = ReactDOMFizzServer.renderToPipeableStream(<App />);
698698
controls.pipe(writable);
699699
});
700700

@@ -746,7 +746,7 @@ describe('ReactDOMFizzServer', () => {
746746
};
747747

748748
await act(async () => {
749-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
749+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
750750
// We use two nested boundaries to flush out coverage of an old reentrancy bug.
751751
<Suspense fallback="Loading...">
752752
<Suspense fallback={<Text text="Loading A..." />}>
@@ -770,7 +770,7 @@ describe('ReactDOMFizzServer', () => {
770770
});
771771

772772
await act(async () => {
773-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
773+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
774774
<Suspense fallback={<Text text="Loading B..." />}>
775775
<Text text="This will show B: " />
776776
<div>
@@ -867,7 +867,7 @@ describe('ReactDOMFizzServer', () => {
867867
}
868868

869869
await act(async () => {
870-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(<App />);
870+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(<App />);
871871
pipe(writable);
872872
});
873873

@@ -955,7 +955,7 @@ describe('ReactDOMFizzServer', () => {
955955
}
956956

957957
await act(async () => {
958-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(<App />);
958+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(<App />);
959959
pipe(writable);
960960
});
961961

@@ -1009,7 +1009,7 @@ describe('ReactDOMFizzServer', () => {
10091009
}
10101010

10111011
await act(async () => {
1012-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
1012+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
10131013
<App />,
10141014

10151015
{
@@ -1096,7 +1096,7 @@ describe('ReactDOMFizzServer', () => {
10961096

10971097
try {
10981098
await act(async () => {
1099-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(<A />);
1099+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(<A />);
11001100
pipe(writable);
11011101
});
11021102

@@ -1195,7 +1195,7 @@ describe('ReactDOMFizzServer', () => {
11951195
}
11961196

11971197
await act(async () => {
1198-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
1198+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
11991199
<TestProvider ctx="A">
12001200
<div>
12011201
<Suspense fallback={[<Text text="Loading: " />, <TestConsumer />]}>
@@ -1253,7 +1253,7 @@ describe('ReactDOMFizzServer', () => {
12531253
}
12541254

12551255
await act(async () => {
1256-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
1256+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
12571257
<div>
12581258
<PrintA />
12591259
<div>
@@ -1315,7 +1315,7 @@ describe('ReactDOMFizzServer', () => {
13151315

13161316
const loggedErrors = [];
13171317
await act(async () => {
1318-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
1318+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
13191319
<div>
13201320
<PrintA />
13211321
<div>
@@ -1376,7 +1376,7 @@ describe('ReactDOMFizzServer', () => {
13761376
const loggedErrors = [];
13771377
let controls;
13781378
await act(async () => {
1379-
controls = ReactDOMFizzServer.renderToNodePipe(
1379+
controls = ReactDOMFizzServer.renderToPipeableStream(
13801380
<App isClient={false} />,
13811381

13821382
{
@@ -1436,7 +1436,7 @@ describe('ReactDOMFizzServer', () => {
14361436
// @gate experimental
14371437
it('should be able to abort the fallback if the main content finishes first', async () => {
14381438
await act(async () => {
1439-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
1439+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
14401440
<Suspense fallback={<Text text="Loading Outer" />}>
14411441
<div>
14421442
<Suspense
@@ -1533,7 +1533,7 @@ describe('ReactDOMFizzServer', () => {
15331533
await jest.runAllTimers();
15341534

15351535
await act(async () => {
1536-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
1536+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
15371537
<App isClient={false} />,
15381538
);
15391539
pipe(writable);
@@ -1647,7 +1647,7 @@ describe('ReactDOMFizzServer', () => {
16471647

16481648
const loggedErrors = [];
16491649
await act(async () => {
1650-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
1650+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
16511651
<Suspense fallback="Loading...">
16521652
<App />
16531653
</Suspense>,
@@ -1730,7 +1730,7 @@ describe('ReactDOMFizzServer', () => {
17301730

17311731
const loggedErrors = [];
17321732
await act(async () => {
1733-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(
1733+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(
17341734
<Suspense fallback="Loading...">
17351735
<App />
17361736
</Suspense>,
@@ -1816,7 +1816,7 @@ describe('ReactDOMFizzServer', () => {
18161816
}
18171817

18181818
await act(async () => {
1819-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(<App />);
1819+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(<App />);
18201820
pipe(writable);
18211821
});
18221822
expect(Scheduler).toHaveYielded(['Yay!']);
@@ -1897,7 +1897,7 @@ describe('ReactDOMFizzServer', () => {
18971897
}
18981898

18991899
await act(async () => {
1900-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(<App />);
1900+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(<App />);
19011901
pipe(writable);
19021902
});
19031903
expect(Scheduler).toHaveYielded(['Yay!']);
@@ -1969,7 +1969,7 @@ describe('ReactDOMFizzServer', () => {
19691969
}
19701970

19711971
await act(async () => {
1972-
const {pipe} = ReactDOMFizzServer.renderToNodePipe(<App />);
1972+
const {pipe} = ReactDOMFizzServer.renderToPipeableStream(<App />);
19731973
pipe(writable);
19741974
});
19751975
expect(Scheduler).toHaveYielded(['Yay!']);

0 commit comments

Comments
 (0)