Remove renderToStaticNodeStream (#28873)

gnoff · web-flow · commit 33a32441e991 · 2024-04-18T21:06:04.000-07:00
Stacked on #28872 renderToStaticNodeStream was not originally deprecated when renderToNodeStream was deprecated because it did not yet have a clear analog in the modern streaming implementation for SSR. In React 19 we have already removed renderToNodeStream. This change removes renderToStaticNodeStream as well because you can replicate it's semantics using renderToPipeableStream with onAllReady or renderToReadableStream with await stream.allready.
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.renderToStaticNodeStream = l.renderToStaticNodeStream;
 exports.renderToReadableStream = s.renderToReadableStream;
 if (s.resume) {
   exports.resume = s.resume;
diff --git a/packages/react-dom/npm/server.bun.js b/packages/react-dom/npm/server.bun.js
@@ -15,6 +15,5 @@ exports.renderToReadableStream = b.renderToReadableStream;
 if (b.resume) {
   exports.resume = b.resume;
 }
-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.renderToStaticNodeStream = b.renderToStaticNodeStream;
 exports.renderToString = l.renderToString;
 exports.renderToStaticMarkup = l.renderToStaticMarkup;
 if (b.resume) {
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.renderToStaticNodeStream = l.renderToStaticNodeStream;
 exports.renderToPipeableStream = s.renderToPipeableStream;
 if (s.resumeToPipeableStream) {
   exports.resumeToPipeableStream = 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 renderToStaticNodeStream() {
-  return require('./src/server/ReactDOMLegacyServerBrowser').renderToStaticNodeStream.apply(
-    this,
-    arguments,
-  );
-}
 
 export function renderToReadableStream() {
   return require('./src/server/react-dom-server.browser').renderToReadableStream.apply(
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 renderToStaticNodeStream() {
-  return require('./src/server/react-dom-server.bun').renderToStaticNodeStream.apply(
-    this,
-    arguments,
-  );
-}
-
 export function renderToString() {
   return require('./src/server/ReactDOMLegacyServerBrowser').renderToString.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 renderToStaticNodeStream() {
-  return require('./src/server/react-dom-server.edge').renderToStaticNodeStream.apply(
-    this,
-    arguments,
-  );
-}
-
 export function renderToString() {
   return require('./src/server/ReactDOMLegacyServerBrowser').renderToString.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 renderToStaticNodeStream() {
-  return require('./src/server/ReactDOMLegacyServerNode').renderToStaticNodeStream.apply(
-    this,
-    arguments,
-  );
-}
 
 export function renderToPipeableStream() {
   return require('./src/server/react-dom-server.node').renderToPipeableStream.apply(
diff --git a/packages/react-dom/src/__tests__/ReactDOMServerIntegrationNewContext-test.js b/packages/react-dom/src/__tests__/ReactDOMServerIntegrationNewContext-test.js
@@ -324,97 +324,6 @@ describe('ReactDOMServerIntegration', () => {
       expect(e.textContent).toBe('dark');
     });
 
-    it('does not pollute parallel node streams', () => {
-      const LoggedInUser = React.createContext();
-
-      const AppWithUser = user => (
-        <LoggedInUser.Provider value={user}>
-          <header>
-            <LoggedInUser.Consumer>{whoAmI => whoAmI}</LoggedInUser.Consumer>
-          </header>
-          <footer>
-            <LoggedInUser.Consumer>{whoAmI => whoAmI}</LoggedInUser.Consumer>
-          </footer>
-        </LoggedInUser.Provider>
-      );
-
-      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
-      // highWaterMark boundary of 2^14 chars.
-      streamAmy._read(20);
-      streamBob._read(20);
-      streamAmy._read(20);
-      streamBob._read(20);
-
-      expect(streamAmy.read()).toBe('<header>Amy</header><footer>Amy</footer>');
-      expect(streamBob.read()).toBe('<header>Bob</header><footer>Bob</footer>');
-    });
-
-    it('does not pollute parallel node streams when many are used', () => {
-      const CurrentIndex = React.createContext();
-
-      const NthRender = index => (
-        <CurrentIndex.Provider value={index}>
-          <header>
-            <CurrentIndex.Consumer>{idx => idx}</CurrentIndex.Consumer>
-          </header>
-          <footer>
-            <CurrentIndex.Consumer>{idx => idx}</CurrentIndex.Consumer>
-          </footer>
-        </CurrentIndex.Provider>
-      );
-
-      const streams = [];
-
-      // Test with more than 32 streams to test that growing the thread count
-      // works properly.
-      const streamCount = 34;
-
-      for (let i = 0; i < streamCount; i++) {
-        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
-      // number of bytes to avoid a test case which needs to align to a
-      // highWaterMark boundary of 2^14 chars.
-      for (let i = 0; i < streamCount; i++) {
-        streams[i]._read(20);
-      }
-
-      // Early destroy every other stream
-      for (let i = 0; i < streamCount; i += 2) {
-        streams[i].destroy();
-      }
-
-      // Recreate those same streams.
-      for (let i = 0; i < streamCount; i += 2) {
-        streams[i] = ReactDOMServer.renderToStaticNodeStream(
-          NthRender(i),
-        ).setEncoding('utf8');
-      }
-
-      // Read a bit from all streams again.
-      for (let i = 0; i < streamCount; i++) {
-        streams[i]._read(20);
-      }
-
-      // Assert that all stream rendered the expected output.
-      for (let i = 0; i < streamCount; i++) {
-        expect(streams[i].read()).toBe(
-          '<header>' + i + '</header><footer>' + i + '</footer>',
-        );
-      }
-    });
-
     it('does not pollute sync renders after an error', () => {
       const LoggedInUser = React.createContext('default');
       const Crash = () => {
diff --git a/packages/react-dom/src/__tests__/ReactServerRendering-test.js b/packages/react-dom/src/__tests__/ReactServerRendering-test.js
@@ -577,73 +577,6 @@ describe('ReactDOMServer', () => {
     });
   });
 
-  describe('renderToStaticNodeStream', () => {
-    it('should generate simple markup', () => {
-      const SuccessfulElement = React.createElement(() => <img />);
-      expect(() => {
-        const response =
-          ReactDOMServer.renderToStaticNodeStream(SuccessfulElement);
-        expect(response.read().toString()).toMatch(new RegExp('<img' + '/>'));
-      }).toErrorDev(
-        'ReactDOMServer.renderToStaticNodeStream() is deprecated and will be removed in an upcomingrelease of React',
-        {withoutStack: true},
-      );
-    });
-
-    it('should handle errors correctly', () => {
-      const FailingElement = React.createElement(() => {
-        throw new Error('An Error');
-      });
-
-      let response;
-      expect(() => {
-        response = ReactDOMServer.renderToStaticNodeStream(FailingElement);
-      }).toErrorDev(
-        'ReactDOMServer.renderToStaticNodeStream() is deprecated and will be removed in an upcomingrelease of React',
-        {withoutStack: true},
-      );
-      return new Promise(resolve => {
-        response.once('error', () => {
-          resolve();
-        });
-        expect(response.read()).toBeNull();
-      });
-    });
-
-    it('should omit text and suspense placeholders', 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.renderToStaticNodeStream(
-          <div>
-            <React.Suspense fallback={'fallback'}>
-              <Suspender />
-            </React.Suspense>
-          </div>,
-        );
-      }).toErrorDev(
-        'ReactDOMServer.renderToStaticNodeStream() is deprecated and will be removed in an upcomingrelease of React',
-        {withoutStack: true},
-      );
-      await resolve();
-      expect(response.read().toString()).toEqual('<div>resolved</div>');
-    });
-  });
-
   it('warns with a no-op when an async setState is triggered', () => {
     class Foo extends React.Component {
       UNSAFE_componentWillMount() {
diff --git a/packages/react-dom/src/server/ReactDOMFizzServerBun.js b/packages/react-dom/src/server/ReactDOMFizzServerBun.js
@@ -146,15 +146,4 @@ function renderToReadableStream(
   });
 }
 
-function renderToStaticNodeStream() {
-  throw new Error(
-    'ReactDOMServer.renderToStaticNodeStream(): The Node Stream API is not available ' +
-      'in Bun. Use ReactDOMServer.renderToReadableStream() instead.',
-  );
-}
-
-export {
-  renderToReadableStream,
-  renderToStaticNodeStream,
-  ReactVersion as version,
-};
+export {renderToReadableStream, ReactVersion as version};
diff --git a/packages/react-dom/src/server/ReactDOMLegacyServerBrowser.js b/packages/react-dom/src/server/ReactDOMLegacyServerBrowser.js
@@ -39,16 +39,4 @@ function renderToStaticMarkup(
   );
 }
 
-function renderToStaticNodeStream() {
-  throw new Error(
-    'ReactDOMServer.renderToStaticNodeStream(): The streaming API is not available ' +
-      'in the browser. Use ReactDOMServer.renderToStaticMarkup() instead.',
-  );
-}
-
-export {
-  renderToString,
-  renderToStaticMarkup,
-  renderToStaticNodeStream,
-  version,
-};
+export {renderToString, renderToStaticMarkup, version};
diff --git a/packages/react-dom/src/server/ReactDOMLegacyServerNode.js b/packages/react-dom/src/server/ReactDOMLegacyServerNode.js
@@ -10,7 +10,6 @@
 import type {ReactNodeList} from 'shared/ReactTypes';
 
 import {version, renderToStringImpl} from './ReactDOMLegacyServerImpl';
-import {renderToStaticNodeStream} from './ReactDOMLegacyServerNodeStream';
 
 type ServerOptions = {
   identifierPrefix?: string,
@@ -40,9 +39,4 @@ function renderToStaticMarkup(
   );
 }
 
-export {
-  renderToString,
-  renderToStaticMarkup,
-  renderToStaticNodeStream,
-  version,
-};
+export {renderToString, renderToStaticMarkup, version};
diff --git a/packages/react-dom/src/server/ReactDOMLegacyServerNodeStream.js b/packages/react-dom/src/server/ReactDOMLegacyServerNodeStream.js
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

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,5 @@ exports.renderToReadableStream = b.renderToReadableStream;`
`15`	`15`	`if (b.resume) {`
`16`	`16`	`exports.resume = b.resume;`
`17`	`17`	`}`
`18`		`-exports.renderToStaticNodeStream = b.renderToStaticNodeStream;`
`19`	`18`	`exports.renderToString = l.renderToString;`
`20`	`19`	`exports.renderToStaticMarkup = l.renderToStaticMarkup;`