Skip to content

Revert "Expose prerender() for SSG in stable" #31394

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

Closed
wants to merge 1 commit into from
Closed

Revert "Expose prerender() for SSG in stable" #31394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 9 additions & 7 deletions 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 @@ -32,7 +32,9 @@ describe('ReactDOMFizzStatic', () => {
React = require('react');
ReactDOM = require('react-dom');
ReactDOMClient = require('react-dom/client');
ReactDOMFizzStatic = require('react-dom/static');
if (__EXPERIMENTAL__) {
ReactDOMFizzStatic = require('react-dom/static');
}
Stream = require('stream');
Suspense = React.Suspense;

Expand Down Expand Up @@ -210,6 +212,7 @@ describe('ReactDOMFizzStatic', () => {
return readText(text);
}

// @gate experimental
it('should render a fully static document, send it and then hydrate it', async () => {
function App() {
return (
Expand All @@ -227,11 +230,7 @@ describe('ReactDOMFizzStatic', () => {

const result = await promise;

expect(result.postponed).toBe(
gate(flags => flags.enableHalt || flags.enablePostpone)
? null
: undefined,
);
expect(result.postponed).toBe(null);

await act(async () => {
result.prelude.pipe(writable);
Expand All @@ -245,6 +244,7 @@ describe('ReactDOMFizzStatic', () => {
expect(getVisibleChildren(container)).toEqual(<div>Hello</div>);
});

// @gate experimental
it('should support importMap option', async () => {
const importMap = {
foo: 'path/to/foo.js',
Expand All @@ -265,6 +265,7 @@ describe('ReactDOMFizzStatic', () => {
]);
});

// @gate experimental
it('supports onHeaders', async () => {
let headers;
function onHeaders(x) {
Expand Down Expand Up @@ -299,7 +300,7 @@ describe('ReactDOMFizzStatic', () => {
expect(getVisibleChildren(container)).toEqual('hello');
});

// @gate enablePostpone
// @gate experimental && enablePostpone
it('includes stylesheet preloads in onHeaders when postponing in the Shell', async () => {
let headers;
function onHeaders(x) {
Expand Down Expand Up @@ -335,6 +336,7 @@ describe('ReactDOMFizzStatic', () => {
expect(getVisibleChildren(container)).toEqual(undefined);
});

// @gate experimental
it('will prerender Suspense fallbacks before children', async () => {
const values = [];
function Indirection({children}) {
Expand Down
24 changes: 18 additions & 6 deletions packages/react-dom/src/__tests__/ReactDOMFizzStaticBrowser-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ describe('ReactDOMFizzStaticBrowser', () => {
React = require('react');
ReactDOM = require('react-dom');
ReactDOMFizzServer = require('react-dom/server.browser');
ReactDOMFizzStatic = require('react-dom/static.browser');
if (__EXPERIMENTAL__) {
ReactDOMFizzStatic = require('react-dom/static.browser');
}
Suspense = React.Suspense;
container = document.createElement('div');
document.body.appendChild(container);
Expand Down Expand Up @@ -129,6 +131,7 @@ describe('ReactDOMFizzStaticBrowser', () => {
await insertNodesAndExecuteScripts(temp, container, null);
}

// @gate experimental
it('should call prerender', async () => {
const result = await serverAct(() =>
ReactDOMFizzStatic.prerender(<div>hello world</div>),
Expand All @@ -137,6 +140,7 @@ describe('ReactDOMFizzStaticBrowser', () => {
expect(prelude).toMatchInlineSnapshot(`"<div>hello world</div>"`);
});

// @gate experimental
it('should emit DOCTYPE at the root of the document', async () => {
const result = await serverAct(() =>
ReactDOMFizzStatic.prerender(
Expand All @@ -151,6 +155,7 @@ describe('ReactDOMFizzStaticBrowser', () => {
);
});

// @gate experimental
it('should emit bootstrap script src at the end', async () => {
const result = await serverAct(() =>
ReactDOMFizzStatic.prerender(<div>hello world</div>, {
Expand All @@ -165,6 +170,7 @@ describe('ReactDOMFizzStaticBrowser', () => {
);
});

// @gate experimental
it('emits all HTML as one unit', async () => {
let hasLoaded = false;
let resolve;
Expand Down Expand Up @@ -196,6 +202,7 @@ describe('ReactDOMFizzStaticBrowser', () => {
expect(prelude).toMatchInlineSnapshot(`"<div><!--$-->Done<!--/$--></div>"`);
});

// @gate experimental
it('should reject the promise when an error is thrown at the root', async () => {
const reportedErrors = [];
let caughtError = null;
Expand All @@ -219,6 +226,7 @@ describe('ReactDOMFizzStaticBrowser', () => {
expect(reportedErrors).toEqual([theError]);
});

// @gate experimental
it('should reject the promise when an error is thrown inside a fallback', async () => {
const reportedErrors = [];
let caughtError = null;
Expand All @@ -244,6 +252,7 @@ describe('ReactDOMFizzStaticBrowser', () => {
expect(reportedErrors).toEqual([theError]);
});

// @gate experimental
it('should not error the stream when an error is thrown inside suspense boundary', async () => {
const reportedErrors = [];
const result = await serverAct(() =>
Expand All @@ -266,6 +275,7 @@ describe('ReactDOMFizzStaticBrowser', () => {
expect(reportedErrors).toEqual([theError]);
});

// @gate experimental
it('should be able to complete by aborting even if the promise never resolves', async () => {
const errors = [];
const controller = new AbortController();
Expand Down Expand Up @@ -296,6 +306,7 @@ describe('ReactDOMFizzStaticBrowser', () => {
expect(errors).toEqual(['The operation was aborted.']);
});

// @gate experimental
// @gate !enableHalt
it('should reject if aborting before the shell is complete and enableHalt is disabled', async () => {
const errors = [];
Expand Down Expand Up @@ -365,6 +376,7 @@ describe('ReactDOMFizzStaticBrowser', () => {
expect(content).toBe('');
});

// @gate experimental
it('should be able to abort before something suspends', async () => {
const errors = [];
const controller = new AbortController();
Expand Down Expand Up @@ -407,6 +419,7 @@ describe('ReactDOMFizzStaticBrowser', () => {
}
});

// @gate experimental
// @gate !enableHalt
it('should reject if passing an already aborted signal and enableHalt is disabled', async () => {
const errors = [];
Expand Down Expand Up @@ -480,6 +493,7 @@ describe('ReactDOMFizzStaticBrowser', () => {
expect(content).toBe('');
});

// @gate experimental
it('supports custom abort reasons with a string', async () => {
const promise = new Promise(r => {});
function Wait() {
Expand Down Expand Up @@ -522,6 +536,7 @@ describe('ReactDOMFizzStaticBrowser', () => {
expect(errors).toEqual(['foobar', 'foobar']);
});

// @gate experimental
it('supports custom abort reasons with an Error', async () => {
const promise = new Promise(r => {});
function Wait() {
Expand Down Expand Up @@ -1595,6 +1610,7 @@ describe('ReactDOMFizzStaticBrowser', () => {
);
});

// @gate experimental
it('logs an error if onHeaders throws but continues the prerender', async () => {
const errors = [];
function onError(error) {
Expand All @@ -1611,11 +1627,7 @@ describe('ReactDOMFizzStaticBrowser', () => {
onError,
}),
);
expect(prerendered.postponed).toBe(
gate(flags => flags.enableHalt || flags.enablePostpone)
? null
: undefined,
);
expect(prerendered.postponed).toBe(null);
expect(errors).toEqual(['bad onHeaders']);

await readIntoContainer(prerendered.prelude);
Expand Down
15 changes: 4 additions & 11 deletions packages/react-dom/src/server/ReactDOMFizzStaticBrowser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ import {
createRootFormatContext,
} from 'react-dom-bindings/src/server/ReactFizzConfigDOM';

import {enablePostpone, enableHalt} from 'shared/ReactFeatureFlags';

import {ensureCorrectIsomorphicReactVersion} from '../shared/ensureCorrectIsomorphicReactVersion';
ensureCorrectIsomorphicReactVersion();

Expand Down Expand Up @@ -87,15 +85,10 @@ function prerender(
{highWaterMark: 0},
);

const result: StaticResult =
enablePostpone || enableHalt
? {
postponed: getPostponedState(request),
prelude: stream,
}
: ({
prelude: stream,
}: any);
const result = {
postponed: getPostponedState(request),
prelude: stream,
};
resolve(result);
}

Expand Down
15 changes: 4 additions & 11 deletions packages/react-dom/src/server/ReactDOMFizzStaticEdge.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ import {
createRootFormatContext,
} from 'react-dom-bindings/src/server/ReactFizzConfigDOM';

import {enablePostpone, enableHalt} from 'shared/ReactFeatureFlags';

import {ensureCorrectIsomorphicReactVersion} from '../shared/ensureCorrectIsomorphicReactVersion';
ensureCorrectIsomorphicReactVersion();

Expand Down Expand Up @@ -87,15 +85,10 @@ function prerender(
{highWaterMark: 0},
);

const result: StaticResult =
enablePostpone || enableHalt
? {
postponed: getPostponedState(request),
prelude: stream,
}
: ({
prelude: stream,
}: any);
const result = {
postponed: getPostponedState(request),
prelude: stream,
};
resolve(result);
}

Expand Down
15 changes: 4 additions & 11 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 @@ -39,8 +39,6 @@ import {
createRootFormatContext,
} from 'react-dom-bindings/src/server/ReactFizzConfigDOM';

import {enablePostpone, enableHalt} from 'shared/ReactFeatureFlags';

import {ensureCorrectIsomorphicReactVersion} from '../shared/ensureCorrectIsomorphicReactVersion';
ensureCorrectIsomorphicReactVersion();

Expand Down Expand Up @@ -96,15 +94,10 @@ function prerenderToNodeStream(
});
const writable = createFakeWritable(readable);

const result: StaticResult =
enablePostpone || enableHalt
? {
postponed: getPostponedState(request),
prelude: readable,
}
: ({
prelude: readable,
}: any);
const result = {
postponed: getPostponedState(request),
prelude: readable,
};
resolve(result);
}
const resumableState = createResumableState(
Expand Down
1 change: 0 additions & 1 deletion packages/react-dom/src/server/react-dom-server.browser.stable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,3 @@
*/

export {renderToReadableStream, version} from './ReactDOMFizzServerBrowser.js';
export {prerender} from './ReactDOMFizzStaticBrowser.js';
1 change: 0 additions & 1 deletion packages/react-dom/src/server/react-dom-server.edge.stable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,3 @@
*/

export {renderToReadableStream, version} from './ReactDOMFizzServerEdge.js';
export {prerender} from './ReactDOMFizzStaticEdge.js';
1 change: 0 additions & 1 deletion packages/react-dom/src/server/react-dom-server.node.stable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,3 @@
*/

export {renderToPipeableStream, version} from './ReactDOMFizzServerNode.js';
export {prerenderToNodeStream} from './ReactDOMFizzStaticNode.js';
Loading