Skip to content

[Fizz] Split ResponseState/Resources into RenderState/ResumableState #27268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 22, 2023
Merged

[Fizz] Split ResponseState/Resources into RenderState/ResumableState #27268

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f90fba7
Add postponed result to store resumable state
sebmarkbage Aug 19, 2023
ffcd249
NodeStreams -> NodeStream
sebmarkbage Aug 19, 2023
504e951
Add resume API
sebmarkbage Aug 19, 2023
e627723
Split ResponseState/Resources into RenderState/ResumableState
sebmarkbage Aug 21, 2023
c5abf7a
Expose resume() API but not in stable
sebmarkbage Aug 22, 2023
92d4029
Reunify createRequest
sebmarkbage Aug 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
NodeStreams -> NodeStream 
This was plural because in the future the result can contain multiple
streams but since it's mostly just one primary one it seems more confusion
that it's not similar to the other API.
  • Loading branch information
@sebmarkbage
sebmarkbage committed Aug 22, 2023
commit ffcd249e82d60f4241727da5d88978fa70cba383
2 changes: 1 addition & 1 deletion packages/react-dom/src/__tests__/ReactDOMFizzStatic-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ describe('ReactDOMFizzStatic', () => {
);
}

const promise = ReactDOMFizzStatic.prerenderToNodeStreams(<App />);
const promise = ReactDOMFizzStatic.prerenderToNodeStream(<App />);

resolveText('Hello');

Expand Down
28 changes: 14 additions & 14 deletions packages/react-dom/src/__tests__/ReactDOMFizzStaticNode-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ describe('ReactDOMFizzStaticNode', () => {
}

// @gate experimental
it('should call prerenderToNodeStreams', async () => {
const result = await ReactDOMFizzStatic.prerenderToNodeStreams(
it('should call prerenderToNodeStream', async () => {
const result = await ReactDOMFizzStatic.prerenderToNodeStream(
<div>hello world</div>,
);
const prelude = await readContent(result.prelude);
Expand All @@ -57,7 +57,7 @@ describe('ReactDOMFizzStaticNode', () => {

// @gate experimental
it('should emit DOCTYPE at the root of the document', async () => {
const result = await ReactDOMFizzStatic.prerenderToNodeStreams(
const result = await ReactDOMFizzStatic.prerenderToNodeStream(
<html>
<body>hello world</body>
</html>,
Expand All @@ -76,7 +76,7 @@ describe('ReactDOMFizzStaticNode', () => {

// @gate experimental
it('should emit bootstrap script src at the end', async () => {
const result = await ReactDOMFizzStatic.prerenderToNodeStreams(
const result = await ReactDOMFizzStatic.prerenderToNodeStream(
<div>hello world</div>,
{
bootstrapScriptContent: 'INIT();',
Expand All @@ -101,7 +101,7 @@ describe('ReactDOMFizzStaticNode', () => {
}
return 'Done';
}
const resultPromise = ReactDOMFizzStatic.prerenderToNodeStreams(
const resultPromise = ReactDOMFizzStatic.prerenderToNodeStream(
<div>
<Suspense fallback="Loading">
<Wait />
Expand All @@ -127,7 +127,7 @@ describe('ReactDOMFizzStaticNode', () => {
const reportedErrors = [];
let caughtError = null;
try {
await ReactDOMFizzStatic.prerenderToNodeStreams(
await ReactDOMFizzStatic.prerenderToNodeStream(
<div>
<Throw />
</div>,
Expand All @@ -149,7 +149,7 @@ describe('ReactDOMFizzStaticNode', () => {
const reportedErrors = [];
let caughtError = null;
try {
await ReactDOMFizzStatic.prerenderToNodeStreams(
await ReactDOMFizzStatic.prerenderToNodeStream(
<div>
<Suspense fallback={<Throw />}>
<InfiniteSuspend />
Expand All @@ -171,7 +171,7 @@ describe('ReactDOMFizzStaticNode', () => {
// @gate experimental
it('should not error the stream when an error is thrown inside suspense boundary', async () => {
const reportedErrors = [];
const result = await ReactDOMFizzStatic.prerenderToNodeStreams(
const result = await ReactDOMFizzStatic.prerenderToNodeStream(
<div>
<Suspense fallback={<div>Loading</div>}>
<Throw />
Expand All @@ -193,7 +193,7 @@ describe('ReactDOMFizzStaticNode', () => {
it('should be able to complete by aborting even if the promise never resolves', async () => {
const errors = [];
const controller = new AbortController();
const resultPromise = ReactDOMFizzStatic.prerenderToNodeStreams(
const resultPromise = ReactDOMFizzStatic.prerenderToNodeStream(
<div>
<Suspense fallback={<div>Loading</div>}>
<InfiniteSuspend />
Expand Down Expand Up @@ -223,7 +223,7 @@ describe('ReactDOMFizzStaticNode', () => {
it('should reject if aborting before the shell is complete', async () => {
const errors = [];
const controller = new AbortController();
const promise = ReactDOMFizzStatic.prerenderToNodeStreams(
const promise = ReactDOMFizzStatic.prerenderToNodeStream(
<div>
<InfiniteSuspend />
</div>,
Expand Down Expand Up @@ -262,7 +262,7 @@ describe('ReactDOMFizzStaticNode', () => {
</Suspense>
);
}
const streamPromise = ReactDOMFizzStatic.prerenderToNodeStreams(
const streamPromise = ReactDOMFizzStatic.prerenderToNodeStream(
<div>
<App />
</div>,
Expand Down Expand Up @@ -291,7 +291,7 @@ describe('ReactDOMFizzStaticNode', () => {
const theReason = new Error('aborted for reasons');
controller.abort(theReason);

const promise = ReactDOMFizzStatic.prerenderToNodeStreams(
const promise = ReactDOMFizzStatic.prerenderToNodeStream(
<div>
<Suspense fallback={<div>Loading</div>}>
<InfiniteSuspend />
Expand Down Expand Up @@ -342,7 +342,7 @@ describe('ReactDOMFizzStaticNode', () => {

const errors = [];
const controller = new AbortController();
const resultPromise = ReactDOMFizzStatic.prerenderToNodeStreams(<App />, {
const resultPromise = ReactDOMFizzStatic.prerenderToNodeStream(<App />, {
signal: controller.signal,
onError(x) {
errors.push(x);
Expand Down Expand Up @@ -384,7 +384,7 @@ describe('ReactDOMFizzStaticNode', () => {

const errors = [];
const controller = new AbortController();
const resultPromise = ReactDOMFizzStatic.prerenderToNodeStreams(<App />, {
const resultPromise = ReactDOMFizzStatic.prerenderToNodeStream(<App />, {
signal: controller.signal,
onError(x) {
errors.push(x.message);
Expand Down
4 changes: 2 additions & 2 deletions packages/react-dom/src/server/ReactDOMFizzStaticNode.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ function createFakeWritable(readable: any): Writable {
}: any);
}

function prerenderToNodeStreams(
function prerenderToNodeStream(
children: ReactNodeList,
options?: Options,
): Promise<StaticResult> {
Expand Down Expand Up @@ -120,4 +120,4 @@ function prerenderToNodeStreams(
});
}

export {prerenderToNodeStreams, ReactVersion as version};
export {prerenderToNodeStream, ReactVersion as version};
2 changes: 1 addition & 1 deletion packages/react-dom/static.node.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
*/

export {
prerenderToNodeStreams,
prerenderToNodeStream,
version,
} from './src/server/ReactDOMFizzStaticNode';