[Fizz][Legacy] Remove renderToNodeStream

renderToNodeStream has been deprecated since React 18 with a warning indicating users should upgrade to renderToPipeableStream. This change removes renderToNodeStream
facebook · Mar 27, 2024 · ad3be49 · ad3be49
1 parent 2b036d3
commit ad3be49
Show file tree

Hide file tree

Showing 16 changed files with 17 additions and 191 deletions.
diff --git a/packages/react-dom/npm/server.browser.js b/packages/react-dom/npm/server.browser.js
@@ -12,7 +12,6 @@ if (process.env.NODE_ENV === 'production') {
 exports.version = l.version;
 exports.renderToString = l.renderToString;
 exports.renderToStaticMarkup = l.renderToStaticMarkup;
-exports.renderToNodeStream = l.renderToNodeStream;
 exports.renderToStaticNodeStream = l.renderToStaticNodeStream;
 exports.renderToReadableStream = s.renderToReadableStream;
 if (s.resume) {

diff --git a/packages/react-dom/npm/server.bun.js b/packages/react-dom/npm/server.bun.js
@@ -15,7 +15,6 @@ exports.renderToReadableStream = b.renderToReadableStream;
 if (b.resume) {
   exports.resume = b.resume;
 }
-exports.renderToNodeStream = b.renderToNodeStream;
 exports.renderToStaticNodeStream = b.renderToStaticNodeStream;
 exports.renderToString = l.renderToString;
 exports.renderToStaticMarkup = l.renderToStaticMarkup;
diff --git a/packages/react-dom/npm/server.edge.js b/packages/react-dom/npm/server.edge.js
@@ -12,7 +12,6 @@ if (process.env.NODE_ENV === 'production') {
 
 exports.version = b.version;
 exports.renderToReadableStream = b.renderToReadableStream;
-exports.renderToNodeStream = b.renderToNodeStream;
 exports.renderToStaticNodeStream = b.renderToStaticNodeStream;
 exports.renderToString = l.renderToString;
 exports.renderToStaticMarkup = l.renderToStaticMarkup;

diff --git a/packages/react-dom/npm/server.node.js b/packages/react-dom/npm/server.node.js
@@ -12,7 +12,6 @@ if (process.env.NODE_ENV === 'production') {
 exports.version = l.version;
 exports.renderToString = l.renderToString;
 exports.renderToStaticMarkup = l.renderToStaticMarkup;
-exports.renderToNodeStream = l.renderToNodeStream;
 exports.renderToStaticNodeStream = l.renderToStaticNodeStream;
 exports.renderToPipeableStream = s.renderToPipeableStream;
 if (s.resumeToPipeableStream) {

diff --git a/packages/react-dom/server.browser.js b/packages/react-dom/server.browser.js
@@ -23,12 +23,6 @@ export function renderToStaticMarkup() {
     arguments,
   );
 }
-export function renderToNodeStream() {
-  return require('./src/server/ReactDOMLegacyServerBrowser').renderToNodeStream.apply(
-    this,
-    arguments,
-  );
-}
 export function renderToStaticNodeStream() {
   return require('./src/server/ReactDOMLegacyServerBrowser').renderToStaticNodeStream.apply(
     this,

diff --git a/packages/react-dom/server.bun.js b/packages/react-dom/server.bun.js
@@ -18,13 +18,6 @@ export function renderToReadableStream() {
   );
 }
 
-export function renderToNodeStream() {
-  return require('./src/server/react-dom-server.bun').renderToNodeStream.apply(
-    this,
-    arguments,
-  );
-}
-
 export function renderToStaticNodeStream() {
   return require('./src/server/react-dom-server.bun').renderToStaticNodeStream.apply(
     this,

diff --git a/packages/react-dom/server.edge.js b/packages/react-dom/server.edge.js
@@ -18,13 +18,6 @@ export function renderToReadableStream() {
   );
 }
 
-export function renderToNodeStream() {
-  return require('./src/server/react-dom-server.edge').renderToNodeStream.apply(
-    this,
-    arguments,
-  );
-}
-
 export function renderToStaticNodeStream() {
   return require('./src/server/react-dom-server.edge').renderToStaticNodeStream.apply(
     this,

diff --git a/packages/react-dom/server.node.js b/packages/react-dom/server.node.js
@@ -23,12 +23,6 @@ export function renderToStaticMarkup() {
     arguments,
   );
 }
-export function renderToNodeStream() {
-  return require('./src/server/ReactDOMLegacyServerNode').renderToNodeStream.apply(
-    this,
-    arguments,
-  );
-}
 export function renderToStaticNodeStream() {
   return require('./src/server/ReactDOMLegacyServerNode').renderToStaticNodeStream.apply(
     this,

diff --git a/packages/react-dom/src/__tests__/ReactDOMServerIntegrationNewContext-test.js b/packages/react-dom/src/__tests__/ReactDOMServerIntegrationNewContext-test.js
@@ -338,24 +338,12 @@ describe('ReactDOMServerIntegration', () => {
         </LoggedInUser.Provider>
       );
 
-      let streamAmy;
-      let streamBob;
-      expect(() => {
-        streamAmy = ReactDOMServer.renderToNodeStream(
-          AppWithUser('Amy'),
-        ).setEncoding('utf8');
-      }).toErrorDev(
-        'renderToNodeStream is deprecated. Use renderToPipeableStream instead.',
-        {withoutStack: true},
-      );
-      expect(() => {
-        streamBob = ReactDOMServer.renderToNodeStream(
-          AppWithUser('Bob'),
-        ).setEncoding('utf8');
-      }).toErrorDev(
-        'renderToNodeStream is deprecated. Use renderToPipeableStream instead.',
-        {withoutStack: true},
-      );
+      const streamAmy = ReactDOMServer.renderToStaticNodeStream(
+        AppWithUser('Amy'),
+      ).setEncoding('utf8');
+      const streamBob = ReactDOMServer.renderToStaticNodeStream(
+        AppWithUser('Bob'),
+      ).setEncoding('utf8');
 
       // Testing by filling the buffer using internal _read() with a small
       // number of bytes to avoid a test case which needs to align to a
@@ -390,14 +378,9 @@ describe('ReactDOMServerIntegration', () => {
       const streamCount = 34;
 
       for (let i = 0; i < streamCount; i++) {
-        expect(() => {
-          streams[i] = ReactDOMServer.renderToNodeStream(
-            NthRender(i % 2 === 0 ? 'Expected to be recreated' : i),
-          ).setEncoding('utf8');
-        }).toErrorDev(
-          'renderToNodeStream is deprecated. Use renderToPipeableStream instead.',
-          {withoutStack: true},
-        );
+        streams[i] = ReactDOMServer.renderToStaticNodeStream(
+          NthRender(i % 2 === 0 ? 'Expected to be recreated' : i),
+        ).setEncoding('utf8');
       }
 
       // Testing by filling the buffer using internal _read() with a small
@@ -414,14 +397,9 @@ describe('ReactDOMServerIntegration', () => {
 
       // Recreate those same streams.
       for (let i = 0; i < streamCount; i += 2) {
-        expect(() => {
-          streams[i] = ReactDOMServer.renderToNodeStream(
-            NthRender(i),
-          ).setEncoding('utf8');
-        }).toErrorDev(
-          'renderToNodeStream is deprecated. Use renderToPipeableStream instead.',
-          {withoutStack: true},
-        );
+        streams[i] = ReactDOMServer.renderToStaticNodeStream(
+          NthRender(i),
+        ).setEncoding('utf8');
       }
 
       // Read a bit from all streams again.

diff --git a/packages/react-dom/src/__tests__/ReactServerRendering-test.js b/packages/react-dom/src/__tests__/ReactServerRendering-test.js
@@ -578,74 +578,6 @@ describe('ReactDOMServer', () => {
     });
   });
 
-  describe('renderToNodeStream', () => {
-    it('should generate simple markup', () => {
-      const SuccessfulElement = React.createElement(() => <img />);
-      let response;
-      expect(() => {
-        response = ReactDOMServer.renderToNodeStream(SuccessfulElement);
-      }).toErrorDev(
-        'renderToNodeStream is deprecated. Use renderToPipeableStream instead.',
-        {withoutStack: true},
-      );
-      expect(response.read().toString()).toMatch(new RegExp('<img' + '/>'));
-    });
-
-    it('should handle errors correctly', () => {
-      const FailingElement = React.createElement(() => {
-        throw new Error('An Error');
-      });
-      let response;
-      expect(() => {
-        response = ReactDOMServer.renderToNodeStream(FailingElement);
-      }).toErrorDev(
-        'renderToNodeStream is deprecated. Use renderToPipeableStream instead.',
-        {withoutStack: true},
-      );
-      return new Promise(resolve => {
-        response.once('error', () => {
-          resolve();
-        });
-        expect(response.read()).toBeNull();
-      });
-    });
-
-    it('should refer users to new apis when using suspense', async () => {
-      let resolve = null;
-      const promise = new Promise(res => {
-        resolve = () => {
-          resolved = true;
-          res();
-        };
-      });
-      let resolved = false;
-      function Suspender() {
-        if (resolved) {
-          return 'resolved';
-        }
-        throw promise;
-      }
-
-      let response;
-      expect(() => {
-        response = ReactDOMServer.renderToNodeStream(
-          <div>
-            <React.Suspense fallback={'fallback'}>
-              <Suspender />
-            </React.Suspense>
-          </div>,
-        );
-      }).toErrorDev(
-        'renderToNodeStream is deprecated. Use renderToPipeableStream instead.',
-        {withoutStack: true},
-      );
-      await resolve();
-      expect(response.read().toString()).toEqual(
-        '<div><!--$-->resolved<!-- --><!--/$--></div>',
-      );
-    });
-  });
-
   describe('renderToStaticNodeStream', () => {
     it('should generate simple markup', () => {
       const SuccessfulElement = React.createElement(() => <img />);

diff --git a/packages/react-dom/src/__tests__/ReactServerRenderingBrowser-test.js b/packages/react-dom/src/__tests__/ReactServerRenderingBrowser-test.js
@@ -45,17 +45,4 @@ describe('ReactServerRenderingBrowser', () => {
       ReactDOMServer.renderToStaticMarkup(<Greeting />),
     );
   });
-
-  it('throws meaningfully for server-only APIs', () => {
-    expect(() => ReactDOMServerBrowser.renderToNodeStream(<div />)).toThrow(
-      'ReactDOMServer.renderToNodeStream(): The streaming API is not available ' +
-        'in the browser. Use ReactDOMServer.renderToString() instead.',
-    );
-    expect(() =>
-      ReactDOMServerBrowser.renderToStaticNodeStream(<div />),
-    ).toThrow(
-      'ReactDOMServer.renderToStaticNodeStream(): The streaming API is not available ' +
-        'in the browser. Use ReactDOMServer.renderToStaticMarkup() instead.',
-    );
-  });
 });
diff --git a/packages/react-dom/src/server/ReactDOMFizzServerBun.js b/packages/react-dom/src/server/ReactDOMFizzServerBun.js
@@ -146,13 +146,6 @@ function renderToReadableStream(
   });
 }
 
-function renderToNodeStream() {
-  throw new Error(
-    'ReactDOMServer.renderToNodeStream(): The Node Stream API is not available ' +
-      'in Bun. Use ReactDOMServer.renderToReadableStream() instead.',
-  );
-}
-
 function renderToStaticNodeStream() {
   throw new Error(
     'ReactDOMServer.renderToStaticNodeStream(): The Node Stream API is not available ' +
@@ -162,7 +155,6 @@ function renderToStaticNodeStream() {
 
 export {
   renderToReadableStream,
-  renderToNodeStream,
   renderToStaticNodeStream,
   ReactVersion as version,
 };
diff --git a/packages/react-dom/src/server/ReactDOMLegacyServerBrowser.js b/packages/react-dom/src/server/ReactDOMLegacyServerBrowser.js
@@ -39,13 +39,6 @@ function renderToStaticMarkup(
   );
 }
 
-function renderToNodeStream() {
-  throw new Error(
-    'ReactDOMServer.renderToNodeStream(): The streaming API is not available ' +
-      'in the browser. Use ReactDOMServer.renderToString() instead.',
-  );
-}
-
 function renderToStaticNodeStream() {
   throw new Error(
     'ReactDOMServer.renderToStaticNodeStream(): The streaming API is not available ' +
@@ -56,7 +49,6 @@ function renderToStaticNodeStream() {
 export {
   renderToString,
   renderToStaticMarkup,
-  renderToNodeStream,
   renderToStaticNodeStream,
   version,
 };
diff --git a/packages/react-dom/src/server/ReactDOMLegacyServerNode.js b/packages/react-dom/src/server/ReactDOMLegacyServerNode.js
@@ -10,10 +10,7 @@
 import type {ReactNodeList} from 'shared/ReactTypes';
 
 import {version, renderToStringImpl} from './ReactDOMLegacyServerImpl';
-import {
-  renderToNodeStream,
-  renderToStaticNodeStream,
-} from './ReactDOMLegacyServerNodeStream';
+import {renderToStaticNodeStream} from './ReactDOMLegacyServerNodeStream';
 
 type ServerOptions = {
   identifierPrefix?: string,
@@ -46,7 +43,6 @@ function renderToStaticMarkup(
 export {
   renderToString,
   renderToStaticMarkup,
-  renderToNodeStream,
   renderToStaticNodeStream,
   version,
 };
diff --git a/packages/react-dom/src/server/ReactDOMLegacyServerNodeStream.js b/packages/react-dom/src/server/ReactDOMLegacyServerNodeStream.js
@@ -59,10 +59,9 @@ function onError() {
   // Non-fatal errors are ignored.
 }
 
-function renderToNodeStreamImpl(
+function renderToStaticNodeStream(
   children: ReactNodeList,
-  options: void | ServerOptions,
-  generateStaticMarkup: boolean,
+  options?: ServerOptions,
 ): Readable {
   function onAllReady() {
     // We wait until everything has loaded before starting to write.
@@ -78,7 +77,7 @@ function renderToNodeStreamImpl(
   const request = createRequest(
     children,
     resumableState,
-    createRenderState(resumableState, generateStaticMarkup),
+    createRenderState(resumableState, true),
     createRootFormatContext(),
     Infinity,
     onError,
@@ -92,23 +91,4 @@ function renderToNodeStreamImpl(
   return destination;
 }
 
-function renderToNodeStream(
-  children: ReactNodeList,
-  options?: ServerOptions,
-): Readable {
-  if (__DEV__) {
-    console.error(
-      'renderToNodeStream is deprecated. Use renderToPipeableStream instead.',
-    );
-  }
-  return renderToNodeStreamImpl(children, options, false);
-}
-
-function renderToStaticNodeStream(
-  children: ReactNodeList,
-  options?: ServerOptions,
-): Readable {
-  return renderToNodeStreamImpl(children, options, true);
-}
-
-export {renderToNodeStream, renderToStaticNodeStream};
+export {renderToStaticNodeStream};
diff --git a/packages/react-dom/src/server/react-dom-server.bun.stable.js b/packages/react-dom/src/server/react-dom-server.bun.stable.js
@@ -9,7 +9,6 @@
 
 export {
   renderToReadableStream,
-  renderToNodeStream,
   renderToStaticNodeStream,
   version,
 } from './ReactDOMFizzServerBun.js';