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

fix(web): resolve selecting new member issue #1358

Merged
merged 1 commit into from
Jan 17, 2025
Merged

Conversation

caichi-t
Copy link
Contributor

@caichi-t caichi-t commented Jan 17, 2025

Overview

This PR fixes the bug you can't select suggested member.

Summary by CodeRabbit

  • New Features

    • Enhanced member addition modal with improved search functionality
    • Added dedicated search input field for better user experience
  • Bug Fixes

    • Improved form state management for search input
    • Implemented automatic search field reset after user selection

@caichi-t caichi-t requested a review from nourbalaha as a code owner January 17, 2025 05:53
Copy link
Contributor

coderabbitai bot commented Jan 17, 2025

Walkthrough

The pull request introduces modifications to the MemberAddModal component in the web application. The changes focus on enhancing form state management, specifically updating the FormValues type to include a search property. The modifications improve how search inputs are handled, ensuring better integration with form state and user interaction. The changes involve updating type definitions, modifying form field management, and refining the user selection process.

Changes

File Change Summary
web/src/components/molecules/Member/MemberAddModal/index.tsx - Updated FormValues type to include search property
- Modified Form.Item to link search input to form state
- Added form.resetFields(["search"]) in handleSelect
- Updated useEffect to set option value to user.id

Suggested labels

web

Suggested reviewers

  • nourbalaha

Poem

🐰 A modal's dance of types and state,
Where search and roles now collaborate!
With form fields linked and values clear,
The rabbit hops with coding cheer! 🎉
Refactoring magic, smooth and bright!


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.

@github-actions github-actions bot added the web label Jan 17, 2025
Copy link

netlify bot commented Jan 17, 2025

Deploy Preview for reearth-cms ready!

Name Link
🔨 Latest commit deca9e1
🔍 Latest deploy log https://app.netlify.com/sites/reearth-cms/deploys/6789f053b023d0000882b9f9
😎 Deploy Preview https://deploy-preview-1358--reearth-cms.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@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: 0

🔭 Outside diff range comments (1)
web/src/components/molecules/Member/MemberAddModal/index.tsx (1)

Line range hint 164-182: Add error handling for search operations.

The search functionality should handle and display errors that might occur during the search operation. Consider adding error handling and user feedback.

 <AutoComplete
   open={isResultOpen}
   options={options}
   popupMatchSelectWidth={433}
   notFoundContent={t("No result")}
   onSearch={handleMemberNameChange}
+  status={searchError ? "error" : undefined}
   onFocus={() => {
     if (options?.length) {
       setIsResultOpen(true);
     }
   }}
   // ... rest of the props
 >
   <Search
     size="large"
     allowClear
     loading={searchLoading}
+    placeholder={searchError ? t("Error occurred during search") : t("Email address or user name")}
     placeholder={t("Email address or user name")}
   />
 </AutoComplete>
🧹 Nitpick comments (2)
web/src/components/molecules/Member/MemberAddModal/index.tsx (2)

109-111: Consider resetting AutoComplete's internal state.

While resetting the form field is good, the AutoComplete component might maintain its own internal state. Consider also clearing the AutoComplete's value directly to ensure consistent behavior across all browsers.

 const handleSelect = useCallback(
   (user: User) => {
     onUserAdd(user);
     resultClear();
     form.resetFields(["search"]);
+    // Consider adding:
+    // if (autoCompleteRef.current) {
+    //   autoCompleteRef.current.setValue("");
+    // }
   },
   [onUserAdd, resultClear, form],
 );

164-164: Consider adding search field validation.

Now that the search field is properly connected to form state, consider adding validation rules to prevent empty searches or enforce minimum length requirements.

-<Form.Item label={t("Search user")} name="search">
+<Form.Item 
+  label={t("Search user")} 
+  name="search"
+  rules={[
+    { min: 2, message: t("Please enter at least 2 characters") },
+  ]}>
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 61175e6 and deca9e1.

📒 Files selected for processing (1)
  • web/src/components/molecules/Member/MemberAddModal/index.tsx (5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Redirect rules - reearth-cms
  • GitHub Check: Header rules - reearth-cms
  • GitHub Check: Pages changed - reearth-cms
  • GitHub Check: ci-web / ci
🔇 Additional comments (2)
web/src/components/molecules/Member/MemberAddModal/index.tsx (2)

87-87: LGTM! Using user.id as option value improves reliability.

Using the user's ID as the option value ensures proper identification and selection of users.


30-30: Verify the impact of FormValues type change.

The type change from Record<string, Role> to { search: string } & Record<string, Role> is more specific and provides better type safety. However, this is a breaking change.

Let's verify other usages of this type:

@caichi-t caichi-t merged commit a581933 into main Jan 17, 2025
22 checks passed
@caichi-t caichi-t deleted the fix-web/select-member branch January 17, 2025 09:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants