Prepare for removing react server dom from the RSC bundle #1889
Conversation
WalkthroughThe PR refactors React streaming infrastructure by introducing a new Changes
Sequence DiagramsequenceDiagram
participant Client
participant StreamServerRenderedReactComponent
participant StreamingUtils
participant RenderEngine as React Render Engine
participant BufferStream
Client->>StreamServerRenderedReactComponent: render(options)
StreamServerRenderedReactComponent->>StreamingUtils: streamServerRenderedComponent(options, renderStrategy)
StreamingUtils->>StreamingUtils: Create PostSSRHookTracker & RSCRequestTracker
StreamingUtils->>StreamingUtils: Augment Rails context with streaming capabilities
StreamingUtils->>RenderEngine: renderToPipeableStream(component)
RenderEngine->>RenderEngine: Render component
alt Streaming Success
RenderEngine->>StreamingUtils: emit chunks (shell ready, content)
StreamingUtils->>StreamingUtils: transformRenderStreamChunksToResultObject(chunks)
StreamingUtils->>StreamingUtils: injectRSCPayload(payload)
StreamingUtils->>BufferStream: Buffer transformed chunks
BufferStream->>Client: Stream results
else Error Occurred
RenderEngine->>StreamingUtils: emit error
StreamingUtils->>StreamingUtils: handleError(construct error HTML)
StreamingUtils->>BufferStream: emitError(errorHTML)
BufferStream->>Client: Stream error response
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
Code Review for PR #1889: Prepare for removing react server dom from the RSC bundleSummaryThis PR is a preparatory refactoring that extracts streaming-related utilities from ✅ Strengths
❌ Critical Issues1. Import path inconsistency (Breaking Change)The package.json export mapping was updated: "./handleError": "./lib/generateRenderingErrorMessage.js"However, 3 files in react-on-rails-pro still import from the old path:
Impact: This will cause runtime import errors when the code is built and used. Fix: These files should either:
My recommendation: Keep the export name as 2. Formatting issue in import statement
import {
StreamingTrackers,
transformRenderStreamChunksToResultObject,
streamServerRenderedComponent,
} from './streamingUtils.ts';The closing brace has inconsistent spacing (note the leading space before Fix: Run
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
packages/react-on-rails-pro/src/ReactOnRailsRSC.ts(1 hunks)packages/react-on-rails-pro/src/streamServerRenderedReactComponent.ts(1 hunks)packages/react-on-rails-pro/src/streamingUtils.ts(1 hunks)packages/react-on-rails/package.json(1 hunks)packages/react-on-rails/src/base/full.ts(1 hunks)packages/react-on-rails/src/serverRenderReactComponent.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{js,jsx,ts,tsx,css,scss,json,yml,yaml,md}
📄 CodeRabbit inference engine (CLAUDE.md)
Prettier is the sole authority for formatting all non-Ruby files; never manually format them
Files:
packages/react-on-rails/src/serverRenderReactComponent.tspackages/react-on-rails/src/base/full.tspackages/react-on-rails/package.jsonpackages/react-on-rails-pro/src/streamingUtils.tspackages/react-on-rails-pro/src/streamServerRenderedReactComponent.tspackages/react-on-rails-pro/src/ReactOnRailsRSC.ts
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (CLAUDE.md)
Use ESLint for JS/TS code (lint via rake lint or yarn lint)
Files:
packages/react-on-rails/src/serverRenderReactComponent.tspackages/react-on-rails/src/base/full.tspackages/react-on-rails-pro/src/streamingUtils.tspackages/react-on-rails-pro/src/streamServerRenderedReactComponent.tspackages/react-on-rails-pro/src/ReactOnRailsRSC.ts
🧠 Learnings (11)
📓 Common learnings
Learnt from: AbanoubGhadban
PR: shakacode/react_on_rails#1696
File: node_package/src/RSCPayloadGenerator.ts:124-168
Timestamp: 2025-06-09T07:58:02.646Z
Learning: In React Server Components (RSC) implementations, explicit error handling in RSC payload generation streams (like in RSCPayloadGenerator.ts) is not needed because errors will propagate to client components that fetch the RSC payloads (such as RSCRoute components). React's built-in error handling mechanisms and ErrorBoundary components are sufficient for handling these errors at the component level, which allows for better user experience with appropriate error UI fallbacks.
Learnt from: alexeyr-ci
PR: shakacode/react_on_rails#1644
File: node_package/src/ReactOnRailsRSC.ts:87-87
Timestamp: 2024-12-12T13:07:09.929Z
Learning: When handling errors in 'node_package/src/ReactOnRailsRSC.ts', include the error stack in error messages in development and test environments to aid debugging.
Learnt from: justin808
PR: shakacode/react_on_rails#1770
File: lib/generators/react_on_rails/templates/base/base/app/javascript/src/HelloWorld/ror_components/HelloWorld.client.jsx:2-2
Timestamp: 2025-09-16T08:01:11.146Z
Learning: React on Rails uses webpack CSS Modules configuration with namedExports: true, which requires the import syntax `import * as style from './file.module.css'` rather than the default export pattern. This configuration enables better tree shaking and bundle size optimization for CSS modules.
Learnt from: AbanoubGhadban
PR: shakacode/react_on_rails#1696
File: node_package/src/transformRSCNodeStream.ts:3-31
Timestamp: 2025-04-09T13:02:16.009Z
Learning: In the React Server Components (RSC) stream processing implementation, all chunks end with a newline character (`\n`), so the `lastIncompleteChunk` variable is expected to be empty by the time the stream ends, making a flush handler unnecessary in the Transform stream.
📚 Learning: 2025-06-09T07:58:02.646Z
Learnt from: AbanoubGhadban
PR: shakacode/react_on_rails#1696
File: node_package/src/RSCPayloadGenerator.ts:124-168
Timestamp: 2025-06-09T07:58:02.646Z
Learning: In React Server Components (RSC) implementations, explicit error handling in RSC payload generation streams (like in RSCPayloadGenerator.ts) is not needed because errors will propagate to client components that fetch the RSC payloads (such as RSCRoute components). React's built-in error handling mechanisms and ErrorBoundary components are sufficient for handling these errors at the component level, which allows for better user experience with appropriate error UI fallbacks.
Applied to files:
packages/react-on-rails/src/serverRenderReactComponent.tspackages/react-on-rails/src/base/full.tspackages/react-on-rails/package.jsonpackages/react-on-rails-pro/src/streamingUtils.tspackages/react-on-rails-pro/src/streamServerRenderedReactComponent.tspackages/react-on-rails-pro/src/ReactOnRailsRSC.ts
📚 Learning: 2024-12-12T13:07:09.929Z
Learnt from: alexeyr-ci
PR: shakacode/react_on_rails#1644
File: node_package/src/ReactOnRailsRSC.ts:87-87
Timestamp: 2024-12-12T13:07:09.929Z
Learning: When handling errors in 'node_package/src/ReactOnRailsRSC.ts', include the error stack in error messages in development and test environments to aid debugging.
Applied to files:
packages/react-on-rails/src/serverRenderReactComponent.tspackages/react-on-rails/src/base/full.tspackages/react-on-rails/package.jsonpackages/react-on-rails-pro/src/streamingUtils.tspackages/react-on-rails-pro/src/ReactOnRailsRSC.ts
📚 Learning: 2025-04-26T21:55:55.874Z
Learnt from: alexeyr-ci2
PR: shakacode/react_on_rails#1732
File: spec/dummy/client/app-react16/startup/ReduxSharedStoreApp.client.jsx:40-44
Timestamp: 2025-04-26T21:55:55.874Z
Learning: In the react_on_rails project, files under `app-react16` directories are copied/moved to corresponding `/app` directories during the conversion process (removing the `-react16` suffix), which affects their relative import paths at runtime.
Applied to files:
packages/react-on-rails/src/serverRenderReactComponent.tspackages/react-on-rails/src/base/full.tspackages/react-on-rails/package.jsonpackages/react-on-rails-pro/src/ReactOnRailsRSC.ts
📚 Learning: 2025-02-13T19:09:15.991Z
Learnt from: AbanoubGhadban
PR: shakacode/react_on_rails#1644
File: node_package/src/RSCWebpackLoader.ts:0-0
Timestamp: 2025-02-13T19:09:15.991Z
Learning: In React Server Components webpack loader, using `new Function('return import("react-server-dom-webpack/node-loader")')()` is necessary as a workaround to bypass TypeScript compilation issues with direct dynamic imports.
Applied to files:
packages/react-on-rails/src/serverRenderReactComponent.tspackages/react-on-rails/src/base/full.tspackages/react-on-rails/package.jsonpackages/react-on-rails-pro/src/streamingUtils.tspackages/react-on-rails-pro/src/streamServerRenderedReactComponent.tspackages/react-on-rails-pro/src/ReactOnRailsRSC.ts
📚 Learning: 2025-09-16T08:01:11.146Z
Learnt from: justin808
PR: shakacode/react_on_rails#1770
File: lib/generators/react_on_rails/templates/base/base/app/javascript/src/HelloWorld/ror_components/HelloWorld.client.jsx:2-2
Timestamp: 2025-09-16T08:01:11.146Z
Learning: React on Rails uses webpack CSS Modules configuration with namedExports: true, which requires the import syntax `import * as style from './file.module.css'` rather than the default export pattern. This configuration enables better tree shaking and bundle size optimization for CSS modules.
Applied to files:
packages/react-on-rails/src/serverRenderReactComponent.tspackages/react-on-rails/package.jsonpackages/react-on-rails-pro/src/streamingUtils.tspackages/react-on-rails-pro/src/streamServerRenderedReactComponent.tspackages/react-on-rails-pro/src/ReactOnRailsRSC.ts
📚 Learning: 2025-02-12T16:38:06.537Z
Learnt from: Romex91
PR: shakacode/react_on_rails#1697
File: package-scripts.yml:28-28
Timestamp: 2025-02-12T16:38:06.537Z
Learning: The file `node_package/lib/ReactOnRails.full.js` is autogenerated during the build process and should not be present in the repository.
Applied to files:
packages/react-on-rails/src/serverRenderReactComponent.tspackages/react-on-rails/src/base/full.tspackages/react-on-rails/package.jsonpackages/react-on-rails-pro/src/ReactOnRailsRSC.ts
📚 Learning: 2025-02-13T16:50:47.848Z
Learnt from: AbanoubGhadban
PR: shakacode/react_on_rails#1644
File: node_package/src/clientStartup.ts:18-21
Timestamp: 2025-02-13T16:50:47.848Z
Learning: In the react_on_rails module, the `reactOnRailsPageUnloaded` function in clientStartup.ts is intentionally kept private as it's only used internally as a callback for `onPageUnloaded`.
Applied to files:
packages/react-on-rails/src/serverRenderReactComponent.tspackages/react-on-rails/src/base/full.tspackages/react-on-rails/package.jsonpackages/react-on-rails-pro/src/streamServerRenderedReactComponent.tspackages/react-on-rails-pro/src/ReactOnRailsRSC.ts
📚 Learning: 2025-07-08T05:57:29.630Z
Learnt from: AbanoubGhadban
PR: shakacode/react_on_rails#1745
File: node_package/src/RSCRequestTracker.ts:8-14
Timestamp: 2025-07-08T05:57:29.630Z
Learning: The global `generateRSCPayload` function in React on Rails Pro (RORP) is provided by the framework during rendering requests, not implemented in application code. The `declare global` statements are used to document the expected interface that RORP will inject at runtime.
Applied to files:
packages/react-on-rails/src/serverRenderReactComponent.tspackages/react-on-rails/src/base/full.tspackages/react-on-rails/package.jsonpackages/react-on-rails-pro/src/streamingUtils.tspackages/react-on-rails-pro/src/streamServerRenderedReactComponent.tspackages/react-on-rails-pro/src/ReactOnRailsRSC.ts
📚 Learning: 2024-07-27T10:08:35.868Z
Learnt from: theforestvn88
PR: shakacode/react_on_rails#1620
File: spec/dummy/client/app/startup/HelloTurboStream.jsx:3-3
Timestamp: 2024-07-27T10:08:35.868Z
Learning: The `RailsContext` import in `spec/dummy/client/app/startup/HelloTurboStream.jsx` is used later in the project, as clarified by the user theforestvn88.
Applied to files:
packages/react-on-rails-pro/src/streamingUtils.tspackages/react-on-rails-pro/src/ReactOnRailsRSC.ts
📚 Learning: 2025-04-09T13:02:16.009Z
Learnt from: AbanoubGhadban
PR: shakacode/react_on_rails#1696
File: node_package/src/transformRSCNodeStream.ts:3-31
Timestamp: 2025-04-09T13:02:16.009Z
Learning: In the React Server Components (RSC) stream processing implementation, all chunks end with a newline character (`\n`), so the `lastIncompleteChunk` variable is expected to be empty by the time the stream ends, making a flush handler unnecessary in the Transform stream.
Applied to files:
packages/react-on-rails-pro/src/streamingUtils.tspackages/react-on-rails-pro/src/streamServerRenderedReactComponent.ts
🧬 Code graph analysis (1)
packages/react-on-rails-pro/src/streamingUtils.ts (4)
packages/react-on-rails/src/types/index.ts (3)
StreamRenderState(473-476)assertRailsContextWithServerComponentMetadata(80-94)RailsContextWithServerStreamingCapabilities(65-68)packages/react-on-rails/src/serverRenderUtils.ts (3)
createResultObject(9-24)validateComponent(30-36)convertToError(26-28)packages/react-on-rails/src/createReactOutput.ts (1)
createReactOutput(36-92)packages/react-on-rails/src/isServerRenderResult.ts (1)
isServerRenderHash(8-17)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)
- GitHub Check: dummy-app-integration-tests (3.4, 22)
- GitHub Check: dummy-app-integration-tests (3.2, 20)
- GitHub Check: rspec-package-tests (3.4, latest)
- GitHub Check: rspec-package-tests (3.4, minimum)
- GitHub Check: rspec-package-tests (3.2, minimum)
- GitHub Check: rspec-package-tests (3.2, latest)
- GitHub Check: lint-js-and-ruby
- GitHub Check: build-dummy-app-webpack-test-bundles
- GitHub Check: build-dummy-app-webpack-test-bundles
- GitHub Check: claude-review
- GitHub Check: build
| const transformStream = new PassThrough({ | ||
| transform(chunk: Buffer, _, callback) { | ||
| const htmlChunk = chunk.toString(); | ||
| const consoleReplayScript = buildConsoleReplay(consoleHistory, previouslyReplayedConsoleMessages); | ||
| previouslyReplayedConsoleMessages = consoleHistory?.length || 0; | ||
| const jsonChunk = JSON.stringify(createResultObject(htmlChunk, consoleReplayScript, renderState)); | ||
| this.push(`${jsonChunk}\n`); | ||
|
|
||
| // Reset the render state to ensure that the error is not carried over to the next chunk | ||
| // eslint-disable-next-line no-param-reassign | ||
| renderState.error = undefined; | ||
| // eslint-disable-next-line no-param-reassign | ||
| renderState.hasErrors = false; | ||
|
|
||
| callback(); | ||
| }, | ||
| }); | ||
|
|
||
| let pipedStream: PipeableOrReadableStream | null = null; | ||
| const pipeToTransform = (pipeableStream: PipeableOrReadableStream) => { | ||
| pipeableStream.pipe(transformStream); | ||
| pipedStream = pipeableStream; | ||
| }; | ||
| // We need to wrap the transformStream in a Readable stream to properly handle errors: | ||
| // 1. If we returned transformStream directly, we couldn't emit errors into it externally | ||
| // 2. If an error is emitted into the transformStream, it would cause the render to fail | ||
| // 3. By wrapping in Readable.from(), we can explicitly emit errors into the readableStream without affecting the transformStream | ||
| // Note: Readable.from can merge multiple chunks into a single chunk, so we need to ensure that we can separate them later | ||
| const { stream: readableStream, emitError } = bufferStream(transformStream); | ||
|
|
||
| const writeChunk = (chunk: string) => transformStream.write(chunk); | ||
| const endStream = () => { | ||
| transformStream.end(); | ||
| if (pipedStream && 'abort' in pipedStream) { | ||
| pipedStream.abort(); | ||
| } | ||
| }; | ||
| return { readableStream, pipeToTransform, writeChunk, emitError, endStream }; | ||
| }; | ||
|
|
There was a problem hiding this comment.
Fix the transform pipeline: PassThrough ignores the custom transform.
transformRenderStreamChunksToResultObject instantiates a PassThrough with a transform callback. In Node.js, PassThrough always forwards chunks unchanged and ignores any custom _transform implementation, so the JSON serialization never runs—downstream readers see raw HTML instead of the expected JSON result envelopes, breaking the streaming contract. Use Transform (or explicitly override _transform) instead so the chunks are rewritten before they hit the buffered readable.(nodejs.org)
-import { PassThrough, Readable } from 'stream';
+import { Transform, Readable } from 'stream';
…
- const transformStream = new PassThrough({
- transform(chunk: Buffer, _, callback) {
+ const transformStream = new Transform({
+ transform(chunk: Buffer, _, callback) {
const htmlChunk = chunk.toString();
const consoleReplayScript = buildConsoleReplay(consoleHistory, previouslyReplayedConsoleMessages);
previouslyReplayedConsoleMessages = consoleHistory?.length || 0;
const jsonChunk = JSON.stringify(createResultObject(htmlChunk, consoleReplayScript, renderState));
this.push(`${jsonChunk}\n`);
…📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const transformStream = new PassThrough({ | |
| transform(chunk: Buffer, _, callback) { | |
| const htmlChunk = chunk.toString(); | |
| const consoleReplayScript = buildConsoleReplay(consoleHistory, previouslyReplayedConsoleMessages); | |
| previouslyReplayedConsoleMessages = consoleHistory?.length || 0; | |
| const jsonChunk = JSON.stringify(createResultObject(htmlChunk, consoleReplayScript, renderState)); | |
| this.push(`${jsonChunk}\n`); | |
| // Reset the render state to ensure that the error is not carried over to the next chunk | |
| // eslint-disable-next-line no-param-reassign | |
| renderState.error = undefined; | |
| // eslint-disable-next-line no-param-reassign | |
| renderState.hasErrors = false; | |
| callback(); | |
| }, | |
| }); | |
| let pipedStream: PipeableOrReadableStream | null = null; | |
| const pipeToTransform = (pipeableStream: PipeableOrReadableStream) => { | |
| pipeableStream.pipe(transformStream); | |
| pipedStream = pipeableStream; | |
| }; | |
| // We need to wrap the transformStream in a Readable stream to properly handle errors: | |
| // 1. If we returned transformStream directly, we couldn't emit errors into it externally | |
| // 2. If an error is emitted into the transformStream, it would cause the render to fail | |
| // 3. By wrapping in Readable.from(), we can explicitly emit errors into the readableStream without affecting the transformStream | |
| // Note: Readable.from can merge multiple chunks into a single chunk, so we need to ensure that we can separate them later | |
| const { stream: readableStream, emitError } = bufferStream(transformStream); | |
| const writeChunk = (chunk: string) => transformStream.write(chunk); | |
| const endStream = () => { | |
| transformStream.end(); | |
| if (pipedStream && 'abort' in pipedStream) { | |
| pipedStream.abort(); | |
| } | |
| }; | |
| return { readableStream, pipeToTransform, writeChunk, emitError, endStream }; | |
| }; | |
| import { Transform, Readable } from 'stream'; | |
| // ... earlier code ... | |
| const transformStream = new Transform({ | |
| transform(chunk: Buffer, _, callback) { | |
| const htmlChunk = chunk.toString(); | |
| const consoleReplayScript = buildConsoleReplay(consoleHistory, previouslyReplayedConsoleMessages); | |
| previouslyReplayedConsoleMessages = consoleHistory?.length || 0; | |
| const jsonChunk = JSON.stringify(createResultObject(htmlChunk, consoleReplayScript, renderState)); | |
| this.push(`${jsonChunk}\n`); | |
| // Reset the render state to ensure that the error is not carried over to the next chunk | |
| // eslint-disable-next-line no-param-reassign | |
| renderState.error = undefined; | |
| // eslint-disable-next-line no-param-reassign | |
| renderState.hasErrors = false; | |
| callback(); | |
| }, | |
| }); | |
| let pipedStream: PipeableOrReadableStream | null = null; | |
| const pipeToTransform = (pipeableStream: PipeableOrReadableStream) => { | |
| pipeableStream.pipe(transformStream); | |
| pipedStream = pipeableStream; | |
| }; | |
| // We need to wrap the transformStream in a Readable stream to properly handle errors: | |
| // 1. If we returned transformStream directly, we couldn't emit errors into it externally | |
| // 2. If an error is emitted into the transformStream, it would cause the render to fail | |
| // 3. By wrapping in Readable.from(), we can explicitly emit errors into the readableStream without affecting the transformStream | |
| // Note: Readable.from can merge multiple chunks into a single chunk, so we need to ensure that we can separate them later | |
| const { stream: readableStream, emitError } = bufferStream(transformStream); | |
| const writeChunk = (chunk: string) => transformStream.write(chunk); | |
| const endStream = () => { | |
| transformStream.end(); | |
| if (pipedStream && 'abort' in pipedStream) { | |
| pipedStream.abort(); | |
| } | |
| }; | |
| return { readableStream, pipeToTransform, writeChunk, emitError, endStream }; | |
| }; |
Pull Request Review - PR #1889This PR refactors streaming server-rendering infrastructure by extracting utilities into streamingUtils.ts. Overall good modularization, but has critical issues that must be fixed before merge. Positive Aspects
Critical Issues1. BROKEN package.json Export (packages/react-on-rails/package.json:49)The file was renamed handleError.ts to generateRenderingErrorMessage.ts, but package.json line 49 still exports './handleError' pointing to non-existent './lib/handleError.js'. This will cause runtime errors. MUST remove this line. 2. Missing TestsNo tests added for this non-trivial refactoring. The bufferStream function is complex (handles race conditions), and error handling flows have changed. Tests needed for:
3. Undocumented Signature ChangestreamServerRenderedComponent now requires handleError as 3rd parameter (dependency injection). Good for testing but not documented. 4. Error Handling DifferenceOld: writeChunk(htmlString) then endStream() 5. Missing CHANGELOG EntryPer CLAUDE.md guidelines, this should be documented. Action Items (Must Fix)
SummaryGood refactoring improving modularity, but needs the package.json fix and tests before merge. Risk level: Medium (untested with signature changes). |
Pull Request Review - PR #1889SummaryThis PR refactors streaming infrastructure by extracting utilities from Code Quality & Best PracticesStrengths:
Issues Identified:
Code Structure AnalysisCurrent State (after this PR): This is a cleaner architecture, but the signature change needs documentation. Performance Considerations
Security Concerns
Test CoverageMajor Concern:
Missing PR Checklist ItemsAccording to the PR description, these items are unchecked:
Recommendations
ConclusionThis is a well-structured refactoring that improves code organization. However, there are critical issues that need addressing:
The code itself is high quality, but the PR needs completion of checklist items and resolution of the issues above before merging. Recommendation: Request changes to fix the package.json issue and add test coverage. |
Pull Request Review - PR #1889SummaryThis PR refactors the streaming infrastructure by extracting shared utilities from ✅ Code Quality and Best PracticesExcellent Refactoring Structure
Architecture DesignThe new architecture is sound:
This separation enables future removal of 🐛 Potential Issues1. CRITICAL: Signature Change in
|
AbanoubGhadban
deleted the
prepare-for-removing-react-server-dom-from-rsc-bundle
branch
Summary
Solves #1886
Remove this paragraph and provide a general description of the code changes in your pull
request... were there any bugs you had fixed? If so, mention them. If
these bugs have open GitHub issues, be sure to tag them here as well,
to keep the conversation linked together.
Pull Request checklist
Remove this line after checking all the items here. If the item is not applicable to the PR, both check it out and wrap it by
~.Add the CHANGELOG entry at the top of the file.
Other Information
Remove this paragraph and mention any other important and relevant information such as benchmarks.
This change is
Summary by CodeRabbit