Deprecate `renderToStaticNodeStream` (#28872)
This commit adds warnings indicating that `renderToStaticNodeStream` will be removed in an upcoming React release. This API has been legacy, is not widely used (renderToStaticMarkup is more common) and has semantically eqiuvalent implementations with renderToReadableStream and renderToPipeableStream.
Josh Story committed
Apr 18, 2024 at 18:33 UTC
d329ff9d9e87f3f909f98cf63701ef3795cf2584
2 files changed
+41
-10
packages/react-dom/src/__tests__/ReactServerRendering-test.js
+28
-10
@@ -580,16 +580,28 @@ describe('ReactDOMServer', () => {
580
describe('renderToStaticNodeStream', () => {
581
it('should generate simple markup', () => {
582
const SuccessfulElement = React.createElement(() => <img />);
583
- const response =
584
- ReactDOMServer.renderToStaticNodeStream(SuccessfulElement);
585
- expect(response.read().toString()).toMatch(new RegExp('<img' + '/>'));
583
+ expect(() => {
584
+ const response =
585
+ ReactDOMServer.renderToStaticNodeStream(SuccessfulElement);
586
+ expect(response.read().toString()).toMatch(new RegExp('<img' + '/>'));
587
+ }).toErrorDev(
588
+ 'ReactDOMServer.renderToStaticNodeStream() is deprecated and will be removed in an upcomingrelease of React',
589
+ {withoutStack: true},
590
+ );
591
});
592
593
it('should handle errors correctly', () => {
594
const FailingElement = React.createElement(() => {
595
throw new Error('An Error');
596
});
592
- const response = ReactDOMServer.renderToStaticNodeStream(FailingElement);
597
+
598
+ let response;
599
+ expect(() => {
600
+ response = ReactDOMServer.renderToStaticNodeStream(FailingElement);
601
+ }).toErrorDev(
602
+ 'ReactDOMServer.renderToStaticNodeStream() is deprecated and will be removed in an upcomingrelease of React',
603
+ {withoutStack: true},
604
+ );
605
return new Promise(resolve => {
606
response.once('error', () => {
607
resolve();
@@ -614,12 +626,18 @@ describe('ReactDOMServer', () => {
626
throw promise;
627
}
628
617
- const response = ReactDOMServer.renderToStaticNodeStream(
618
- <div>
619
- <React.Suspense fallback={'fallback'}>
620
- <Suspender />
621
- </React.Suspense>
622
- </div>,
629
+ let response;
630
+ expect(() => {
631
+ response = ReactDOMServer.renderToStaticNodeStream(
632
+ <div>
633
+ <React.Suspense fallback={'fallback'}>
634
+ <Suspender />
635
+ </React.Suspense>
636
+ </div>,
637
+ );
638
+ }).toErrorDev(
639
+ 'ReactDOMServer.renderToStaticNodeStream() is deprecated and will be removed in an upcomingrelease of React',
640
+ {withoutStack: true},
641
);
642
await resolve();
643
expect(response.read().toString()).toEqual('<div>resolved</div>');
packages/react-dom/src/server/ReactDOMLegacyServerNodeStream.js
+13
@@ -59,10 +59,23 @@ function onError() {
59
// Non-fatal errors are ignored.
60
}
61
62
+let didWarnAboutDeprecatedRenderToStaticNodeStream = false;
63
+
64
function renderToStaticNodeStream(
65
children: ReactNodeList,
66
options?: ServerOptions,
67
): Readable {
68
+ if (__DEV__) {
69
+ if (!didWarnAboutDeprecatedRenderToStaticNodeStream) {
70
+ didWarnAboutDeprecatedRenderToStaticNodeStream = true;
71
+ console.error(
72
+ 'ReactDOMServer.renderToStaticNodeStream() is deprecated and will be removed in an upcoming' +
73
+ 'release of React. Use ReactDOMServer.renderToPipeableStream() and wait to `pipe` until the `onAllReady`' +
74
+ ' callback has been called to produce a document suitable for static use cases.',
75
+ );
76
+ }
77
+ }
78
+
79
function onAllReady() {
80
// We wait until everything has loaded before starting to write.
81
// That way we only end up with fully resolved HTML even if we suspend.