chore(new-webui): Add compatibility patch for Ant Design with React 19. by junhaoliao · Pull Request #933 · y-scope/clp

junhaoliao · 2025-05-28T18:47:21Z

Description

As instructed by https://ant.design/docs/react/v5-for-19 , add compatibility patch for Ant Design with React 19.

Checklist

The PR satisfies the contribution guidelines.
This is a breaking change and that has been indicated in the PR title, OR this isn't a
breaking change.
Necessary docs have been updated, OR no docs need to be updated.

Validation performed

Modified AntApp in components/log-viewer-webui/client/src/AntdApp.tsx as
```
import {message} from "antd";
...
const AntApp = () => {
    useEffect(() => {
        message.error("hi");
    }, []);

    return <RouterProvider router={router}/>;
};
```
and observed two error pop-ups showed up as shown in below screenshot. (two messages were rendered because of React StrictMode)

Summary by CodeRabbit

Chores
- Updated dependencies to improve compatibility with newer versions of React and Ant Design.

coderabbitai · 2025-05-28T18:47:28Z

Walkthrough

A new dependency, @ant-design/v5-patch-for-react-19, was added to the package.json for the log viewer web UI client. An import statement for this patch was introduced at the top of AntdApp.tsx to ensure compatibility between Ant Design v5 and React 19. No other changes were made.

Changes

File(s)	Change Summary
.../log-viewer-webui/client/package.json	Added `@ant-design/v5-patch-for-react-19` dependency; reordered `react-chartjs-2` in the list.
.../log-viewer-webui/client/src/AntdApp.tsx	Added import of `@ant-design/v5-patch-for-react-19` at the top of the file.

Possibly related PRs

fix(log-viewer-webui): Remove unnecessary React import (fixes #803). #804: Both PRs modify import statements in AntdApp.tsx, but for different modules and purposes.
feat(webui): Adds a switch to enable new Ant Design webui and a basic menu. #791: Both PRs change AntdApp.tsx in relation to Ant Design integration, with this PR adding a compatibility patch and the related PR introducing new Ant Design-based UI components.

Suggested reviewers

davemarco

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cd48f8b and 6901c28.

⛔ Files ignored due to path filters (1)

components/log-viewer-webui/client/package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (2)

components/log-viewer-webui/client/package.json (1 hunks)
components/log-viewer-webui/client/src/AntdApp.tsx (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}`: - Prefer `false == ` rather than `!`.

**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}: - Prefer false == <expression> rather than !<expression>.

components/log-viewer-webui/client/src/AntdApp.tsx

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: lint-check (macos-latest)
GitHub Check: lint-check (ubuntu-latest)

🔇 Additional comments (1)

components/log-viewer-webui/client/package.json (1)

17-17: Approve addition of React-19 compatibility patch
The dependency @ant-design/v5-patch-for-react-19@^1.0.3 is required to ensure Ant Design v5 works correctly with React 19 and matches the tested version.

coderabbitai · 2025-05-28T18:50:01Z

    "dayjs": "^1.11.13",
    "highlight.js": "^11.11.1",
    "react": "^19.0.0",
+    "react-chartjs-2": "^5.3.0",


🧹 Nitpick (assertive)

Optional: Standardise dependency ordering
The moved react-chartjs-2 entry is valid, but consider organising dependencies alphabetically or grouping them by ecosystem for improved maintainability.

🤖 Prompt for AI Agents

In components/log-viewer-webui/client/package.json at line 30, the dependency "react-chartjs-2" is correctly added but the dependencies list is not ordered consistently. To improve maintainability, reorder all dependencies alphabetically or group them logically by ecosystem. Adjust the entire dependencies section to follow the chosen ordering scheme.

coderabbitai · 2025-05-28T18:50:01Z


 import router from "./router";

+import "@ant-design/v5-patch-for-react-19";


⚠️ Potential issue

Load the compatibility patch before all other imports
The side-effect import must execute prior to any React or component imports to properly patch Ant Design. Please relocate this line to the very top of the file.

- import {RouterProvider} from "react-router"; - import router from "./router"; - import "@ant-design/v5-patch-for-react-19"; + import "@ant-design/v5-patch-for-react-19"; + import {RouterProvider} from "react-router"; + import router from "./router";

📝 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.

Suggested change

import "@ant-design/v5-patch-for-react-19";

import "@ant-design/v5-patch-for-react-19";

import {RouterProvider} from "react-router";

import router from "./router";

🤖 Prompt for AI Agents

In components/log-viewer-webui/client/src/AntdApp.tsx at line 5, the import of the Ant Design compatibility patch must be moved to the very top of the file before any other imports. This ensures the patch runs first and properly modifies Ant Design behavior. Relocate the import statement so it is the first line in the file.

davemarco

lgtm. title looks good.

…9. (y-scope#933)

Add compatibility patch for Ant Design with React 19.

6901c28

junhaoliao requested a review from a team as a code owner May 28, 2025 18:47

junhaoliao requested a review from davemarco May 28, 2025 18:47

coderabbitai Bot reviewed May 28, 2025

View reviewed changes

junhaoliao changed the title ~~chore: Add compatibility patch for Ant Design with React 19.~~ chore(new-webui): Add compatibility patch for Ant Design with React 19. May 28, 2025

davemarco approved these changes May 28, 2025

View reviewed changes

junhaoliao merged commit e864329 into main May 28, 2025
14 checks passed

junhaoliao deleted the antd-compat branch May 28, 2025 20:49

junhaoliao restored the antd-compat branch May 28, 2025 20:49

junhaoliao deleted the antd-compat branch May 28, 2025 20:49

junhaoliao added a commit to junhaoliao/clp that referenced this pull request May 17, 2026

chore(new-webui): Add compatibility patch for Ant Design with React 1…

23a4cf8

…9. (y-scope#933)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(new-webui): Add compatibility patch for Ant Design with React 19.#933

chore(new-webui): Add compatibility patch for Ant Design with React 19.#933
junhaoliao merged 1 commit into
mainfrom
antd-compat

junhaoliao commented May 28, 2025 •

edited

Loading

Uh oh!

coderabbitai Bot commented May 28, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot May 28, 2025

Uh oh!

coderabbitai Bot May 28, 2025

Uh oh!

davemarco left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		import router from "./router";

		import "@ant-design/v5-patch-for-react-19";

Conversation

junhaoliao commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Validation performed

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot May 28, 2025

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot May 28, 2025

Choose a reason for hiding this comment

Uh oh!

davemarco left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

junhaoliao commented May 28, 2025 •

edited

Loading

coderabbitai Bot commented May 28, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)