Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade to react 19 #610

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

ihab4real
Copy link

@ihab4real ihab4real commented Dec 22, 2024

Upgrade to and remove new breaking/deprecated changes in react 19.0


This change is Reviewable

Summary by CodeRabbit

  • New Features

    • Updated the CommentForm component to utilize modern reference handling with createRef, improving input management.
  • Bug Fixes

    • Enhanced consistency in input field attributes by aligning id attributes with new ref names.
  • Chores

    • Upgraded core dependencies: React and React DOM from version 18.2.0 to 19.0.0, and Rescript from version 10.1.4 to 11.1.4.

this avoids this warning in console:
[SERVER] Your app (or one of its dependencies) is using an outdated JSX transform. Update to the modern JSX transform for faster performance: https://react.dev/link/new-jsx-transform
Updates component to use React.createRef() to handle React 19 breaking changes:
- Replaces string refs with createRef
- Removes ReactDOM.findDOMNode usage
Copy link

coderabbitai bot commented Dec 22, 2024

Walkthrough

The pull request introduces configuration and component updates focusing on React and Babel settings. The babel.config.js file is modified to enable automatic JSX runtime and optimize production builds. The CommentForm component in React is refactored to use modern ref management with createRef(). Additionally, package.json is updated with version bumps for React, React DOM, and ReScript dependencies, reflecting a move towards newer library versions.

Changes

File Change Summary
babel.config.js - Updated @babel/preset-react with runtime: 'automatic'
- Conditionally added react-refresh/babel plugin
- Added babel-plugin-transform-react-remove-prop-types for production
client/app/bundles/comments/components/CommentBox/CommentForm/CommentForm.jsx - Replaced string refs with createRef()
- Added six new ref variables
- Updated input value retrieval logic
package.json - Upgraded React and React DOM to ^19.0.0
- Updated ReScript to ^11.1.4

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Babel as Babel Config
    participant React as React Component
    
    Dev->>Babel: Configure automatic JSX runtime
    Babel-->>React: Apply new transformation rules
    Dev->>React: Refactor refs using createRef()
    React-->>Dev: Modernized component references
Loading

Poem

🐰 Babel's magic, refs so bright,
React components taking flight!
From strings to refs, a cleaner way,
Upgrading libraries day by day.
Code hops forward with glee and grace! 🚀

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🔭 Outside diff range comments (1)
package.json (1)

Potential compatibility issue with react-router and react-router-dom

While most dependencies support React 19, react-router and react-router-dom specify >=18 as their peer dependency requirement. This could potentially lead to compatibility issues since their latest versions haven't been explicitly tested with React 19. Here's what needs attention:

  • react-router and react-router-dom should be pinned to versions that explicitly support React 19, or consider waiting for official React 19 support
  • Other dependencies (react-redux, react-intl, react-transition-group) are compatible with React 19
🔗 Analysis chain

Line range hint 78-89: Verify peer dependency compatibility

Let's verify if all React-related dependencies are compatible with React 19.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check peer dependencies of react-related packages
for pkg in react-redux react-router react-router-dom react-transition-group react-intl; do
  echo "Checking $pkg..."
  curl -s "https://registry.npmjs.org/$pkg/latest" | jq -r '.peerDependencies.react'
done

Length of output: 1275

🧹 Nitpick comments (3)
client/app/bundles/comments/components/CommentBox/CommentForm/CommentForm.jsx (3)

49-62: Consider reducing form handling duplication

The switch statement pattern is repeated across methods. Consider extracting the form mode logic into a helper method or using a mapping object.

+ const FORM_REFS = {
+   0: { author: 'horizontalAuthorRef', text: 'horizontalTextRef' },
+   1: { author: 'stackedAuthorRef', text: 'stackedTextRef' },
+   2: { author: 'inlineAuthorRef', text: 'inlineTextRef' }
+ };
+
  handleChange() {
-   let comment;
-   switch (this.state.formMode) {
-     case 0:
-       comment = {
-         author: this.horizontalAuthorRef.current.value,
-         text: this.horizontalTextRef.current.value,
-       };
-       break;
-     // ... other cases
-   }
+   const refs = FORM_REFS[this.state.formMode];
+   if (!refs) throw new Error(`Unexpected state.formMode ${this.state.formMode}`);
+   
+   const comment = {
+     author: this[refs.author].current.value,
+     text: this[refs.text].current.value
+   };
    this.setState({ comment });
  }

Line range hint 1-1: Remove eslint-disable comment

Now that string refs have been replaced, the react/no-string-refs disable comment can be removed.

- /* eslint-disable react/no-find-dom-node, react/no-string-refs */
+ /* eslint-disable react/no-find-dom-node */

Line range hint 1-300: Consider converting to functional component

With the modernization efforts, consider converting this class component to a functional component using hooks:

  • Replace class fields with useState
  • Replace createRef with useRef
  • Replace lifecycle methods with useEffect
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3e1f722 and 0fea611.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (3)
  • babel.config.js (1 hunks)
  • client/app/bundles/comments/components/CommentBox/CommentForm/CommentForm.jsx (6 hunks)
  • package.json (2 hunks)
🔇 Additional comments (2)
babel.config.js (1)

11-11: LGTM! Good adoption of automatic JSX runtime

The addition of runtime: 'automatic' is a recommended optimization that removes the need for React imports in JSX files and enables future React features.

client/app/bundles/comments/components/CommentBox/CommentForm/CommentForm.jsx (1)

29-34: LGTM! Good modernization of refs

Excellent transition from legacy string refs to modern createRef(). This aligns well with React best practices.

package.json Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant