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

Fixes issue #2627 #2682

Merged

Conversation

raggettii
Copy link
Contributor

@raggettii raggettii commented Dec 18, 2024

What kind of change does this PR introduce?
It ensures that the text does not retains the previously searched value

Issue Number:

Fixes #2627

Did you add tests for your changes?
No

Snapshots/Videos:

If relevant, did you update the documentation?

Summary

Does this PR introduce a breaking change?

Other information

Have you read the contributing guide?
Yes

Summary by CodeRabbit

  • New Features

    • Improved user experience with modal handling for adding members.
    • Enhanced error logging during member creation.
  • Bug Fixes

    • Corrected modal toggle functionality for creating new users.
    • Fixed search input reset behavior when opening the add user modal.
  • Improvements

    • Updated search functionality to prevent default form submission behavior.

Copy link
Contributor

coderabbitai bot commented Dec 18, 2024

Walkthrough

The pull request focuses on improving the AddMember component in the src/screens/OrganizationPeople/AddMember.tsx file. The changes address a specific issue where search inputs and results persist after closing and reopening the modal. Key modifications include adding a useEffect hook to reset the userName state, correcting the toggleCreateNewUserModal function, updating error handling in the createMember function, and modifying the handleUserModalSearchChange function to prevent default form submission.

Changes

File Change Summary
src/screens/OrganizationPeople/AddMember.tsx - Added useEffect to reset userName state when modal opens/closes
- Corrected toggleCreateNewUserModal function to toggle correct state
- Updated createMember with improved error handling
- Modified handleUserModalSearchChange to prevent default form submission

Assessment against linked issues

Objective Addressed Explanation
Reset search input when modal closes [#2627]
Prevent persisting search results after modal reopens [#2627]

Possibly related PRs

Suggested labels

ignore-sensitive-files-pr

Suggested reviewers

  • palisadoes
  • AVtheking
  • pranshugupta54

Poem

🐰 A modal's dance, a search reset's grace,
Clearing inputs with a rabbit's embrace,
No more lingering queries to trace,
Clean and fresh, a user's delight,
In code's realm, everything's just right! 🔍✨


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.

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

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

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 (3)
src/screens/OrganizationPeople/AddMember.tsx (3)

Line range hint 92-93: Fix incorrect state variable in toggleCreateNewUserModal

The function is using the wrong state variable (addUserModalisOpen) instead of createNewUserModalisOpen in the toggle logic, which will cause incorrect modal behavior.

Apply this fix:

  const toggleCreateNewUserModal = (): void =>
-   setCreateNewUserModalIsOpen(!addUserModalisOpen);
+   setCreateNewUserModalIsOpen(!createNewUserModalisOpen);

Line range hint 95-108: Enhance error handling in createMember function

While the error handling has been improved, it could be more robust to handle all error types consistently.

Consider this enhancement:

  const createMember = async (userId: string): Promise<void> => {
    try {
      await addMember({
        variables: {
          userid: userId,
          orgid: currentUrl,
        },
      });
      toast.success(tCommon('addedSuccessfully', { item: 'Member' }) as string);
      memberRefetch({
        orgId: currentUrl,
      });
    } catch (error: unknown) {
-     if (error instanceof Error) {
-       toast.error(error.message);
-       console.log(error.message);
-     }
+     const errorMessage = error instanceof Error ? error.message : 'An unknown error occurred';
+     console.error('Failed to create member:', errorMessage);
+     toast.error(errorMessage);
    }
  };

Modal state management needs correction in toggleCreateNewUserModal

Found an issue where toggleCreateNewUserModal incorrectly uses addUserModalisOpen instead of createNewUserModalisOpen:

const toggleCreateNewUserModal = (): void =>
  setCreateNewUserModalIsOpen(!addUserModalisOpen); // Wrong state variable

This should be:

const toggleCreateNewUserModal = (): void =>
  setCreateNewUserModalIsOpen(!createNewUserModalisOpen);
🔗 Analysis chain

Line range hint 79-93: Verify modal state management

Let's ensure all modal state changes are working correctly across the component.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for potential modal state management issues
# Look for other modal state manipulations that might need similar fixes

# Search for modal state changes
echo "Checking modal state manipulations:"
rg -n "setAddUserModalIsOpen|setCreateNewUserModalIsOpen" --type tsx

# Search for potential conflicting modal states
echo "Checking for potential modal state conflicts:"
ast-grep --pattern 'useState<boolean>($$$)' --type tsx

Length of output: 517


Script:

#!/bin/bash
# Let's try a different approach to check modal state management

# Search for modal state changes without file type restriction
echo "Checking modal state manipulations:"
rg -n "setAddUserModalIsOpen|setCreateNewUserModalIsOpen"

# Search for useState declarations in the component
echo "Checking useState declarations in AddMember.tsx:"
rg -A 2 "useState" "src/screens/OrganizationPeople/AddMember.tsx"

# Look for other modal-related state management in the component
echo "Checking other modal-related code:"
rg -A 2 "Modal|modal" "src/screens/OrganizationPeople/AddMember.tsx"

Length of output: 4524

🧹 Nitpick comments (1)
src/screens/OrganizationPeople/AddMember.tsx (1)

Line range hint 279-291: Enhance search input handling

While the function works correctly, the name splitting logic could be more robust.

Consider this enhancement:

  const handleUserModalSearchChange = (e: React.FormEvent): void => {
    e.preventDefault();
-   const [firstName, lastName] = userName.split(' ');
+   const trimmedName = userName.trim();
+   const [firstName, ...lastNameParts] = trimmedName.split(' ');
+   const lastName = lastNameParts.join(' ');

    const newFilterData = {
-     firstName_contains: firstName || '',
-     lastName_contains: lastName || '',
+     firstName_contains: trimmedName ? firstName : '',
+     lastName_contains: lastNameParts.length > 0 ? lastName : '',
    };

    allUsersRefetch({
      ...newFilterData,
    });
  };

This change:

  • Trims whitespace from the input
  • Handles multi-word last names correctly
  • More explicitly handles empty input cases
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9723078 and fa1834e.

📒 Files selected for processing (1)
  • src/screens/OrganizationPeople/AddMember.tsx (1 hunks)
🔇 Additional comments (1)
src/screens/OrganizationPeople/AddMember.tsx (1)

79-81: LGTM! This fixes the search value retention issue.

The useEffect hook correctly resets the search input when the modal is toggled, addressing issue #2627.

@dhanagopu
Copy link

@raggettii Please fix the failing tests

@raggettii
Copy link
Contributor Author

@dhanagopu I only made 1 line change, and the tests are failing that not even from the files that i made changes to

@shivasankaran18
Copy link
Contributor

@dhanagopu fixed these failing tests in my PRs #2663 #2662 ..Merging them should fix these ..could you please look into it?

Copy link

codecov bot commented Dec 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.13%. Comparing base (8169150) to head (7da5aa8).
Report is 1 commits behind head on develop-postgres.

Additional details and impacted files
@@                 Coverage Diff                  @@
##           develop-postgres    #2682      +/-   ##
====================================================
- Coverage             88.37%   84.13%   -4.25%     
====================================================
  Files                   295      312      +17     
  Lines                  7046     8130    +1084     
  Branches               1521     1835     +314     
====================================================
+ Hits                   6227     6840     +613     
- Misses                  615     1135     +520     
+ Partials                204      155      -49     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@varshith257 varshith257 merged commit 4b45d85 into PalisadoesFoundation:develop-postgres Dec 19, 2024
9 of 10 checks passed
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.

Search retains previous input after closing the modal instead of resetting to default data
4 participants