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 Search Functionality for Full Name and Partial Matches in People Section (#3388) #3520

Open
wants to merge 3 commits into
base: develop-postgres
Choose a base branch
from

Conversation

Nivedita-Chhokar
Copy link

@Nivedita-Chhokar Nivedita-Chhokar commented Feb 1, 2025

What kind of change does this PR introduce?

Bugfix

Issue Number:

Fixes #3388

Snapshots/Videos:

20250202034155.mp4

If relevant, did you update the documentation?

No

Summary

This PR addresses the issue where the search functionality in the "People" section fails to return results when searching with a full name, partial matches beyond the first name, or queries with extra spaces. The current behavior shows "people.nothingToShow," which is not helpful or accurate. This fix improves the search functionality to support full names, partial matches, and handles spaces correctly, ensuring that users can find a person even with incomplete or extended queries.

Does this PR introduce a breaking change?

No

Checklist

CodeRabbit AI Review

  • I have reviewed and addressed all critical issues flagged by CodeRabbit AI
  • I have implemented or provided justification for each non-critical suggestion
  • I have documented my reasoning in the PR comments where CodeRabbit AI suggestions were not implemented

Test Coverage

  • I have written tests for all new changes/features
  • I have verified that test coverage meets or exceeds 95%
  • I have run the test suite locally and all tests pass

Other information

Have you read the contributing guide?

Yes

Summary by CodeRabbit

  • New Features
    • Added informative empty state messages across the People and Organizations views, so users now see a clear message when no entries are available.
    • Enhanced People search functionality to support combined first and last name queries, offering more precise filtering in user searches.

Copy link
Contributor

coderabbitai bot commented Feb 1, 2025

Walkthrough

This pull request enhances localization and search functionalities. Several translation files have been updated with a new key, "nothingToShow", to provide clearer empty state messages in the "people" and "userOrganizations" sections. In addition, the People component and its tests have been modified to support full name searches by splitting input into first and last name, and by including a new GraphQL query parameter (lastName_contains) for more precise filtering.

Changes

File(s) Change Summary
public/locales/en/translation.json Added "nothingToShow": "Nothing to show here." in the "people" section and "nothingToShow": "Nothing to show here." in the "userOrganizations" section.
public/locales/fr/translation.json, public/locales/hi/translation.json, public/locales/sp/translation.json, public/locales/zh/translation.json Added new "nothingToShow" key in the "people" section with language-specific messages.
src/screens/UserPortal/People/People.tsx, src/screens/UserPortal/People/People.spec.tsx Enhanced search functionality: renamed parameter to userName, split input into first and last names, and updated GraphQL queries and tests with lastName_contains for proper full name search handling.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant P as People Component
    participant S as GraphQL Server

    U->>P: Enters search input (full name)
    P->>P: Splits input into firstName & lastName
    P->>S: Sends query with { firstName_contains, lastName_contains }
    S-->>P: Returns matching members
    P->>U: Displays results or shows "nothingToShow" if no match found
Loading

Assessment against linked issues

Objective (from linked issues) Addressed Explanation
Support full name and partial match searches in the People section [#3388]

Suggested reviewers

  • palisadoes
  • disha1202

Poem

In a field of code I hop with glee,
Little changes bloom like spring's decree.
Translations speak in many tongues so true,
And search now finds both first and last names too.
From heart to code, I cheer aloud—
A bunny’s joy, both soft and proud!
🐇🌼


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

github-actions bot commented Feb 1, 2025

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

🧹 Nitpick comments (1)
src/screens/UserPortal/People/People.tsx (1)

Line range hint 1-24: Consider enhancing error handling for network failures.

While the component handles loading and empty states well, consider adding explicit error handling for network failures to improve user experience.

 const { data, loading, refetch } = useQuery(
   ORGANIZATIONS_MEMBER_CONNECTION_LIST,
   {
     variables: {
       orgId: organizationId,
       firstName_contains: '',
       lastName_contains: '',
     },
+    onError: (error) => {
+      // Handle network/query errors
+      console.error('Search failed:', error);
+      // Show error message to user
+    }
   },
 );
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 735869e and 1c708a5.

📒 Files selected for processing (7)
  • public/locales/en/translation.json (1 hunks)
  • public/locales/fr/translation.json (1 hunks)
  • public/locales/hi/translation.json (1 hunks)
  • public/locales/sp/translation.json (1 hunks)
  • public/locales/zh/translation.json (1 hunks)
  • src/screens/UserPortal/People/People.spec.tsx (11 hunks)
  • src/screens/UserPortal/People/People.tsx (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test Application
🔇 Additional comments (8)
src/screens/UserPortal/People/People.tsx (2)

91-91: LGTM! Added lastName parameter for full name search support.

The addition of lastName_contains parameter enables filtering by last name in the GraphQL query.


116-121: Well-implemented full name search logic!

The search implementation:

  • Properly handles whitespace trimming
  • Correctly splits full name into first and last components
  • Gracefully handles partial inputs using default empty strings
src/screens/UserPortal/People/People.spec.tsx (1)

724-762: Excellent test coverage for the new search functionality!

The test suite thoroughly covers:

  • Full name search scenarios
  • Edge cases with empty inputs
  • Mock data setup with lastName parameter
public/locales/zh/translation.json (1)

983-984: LGTM! Clear and natural Chinese translation added.

The translation for "nothingToShow" is grammatically correct and maintains consistency with other language versions.

public/locales/en/translation.json (1)

1009-1010: LGTM! Clear and concise English message added.

The "Nothing to show here" message is user-friendly and serves as a good base for translations.

public/locales/hi/translation.json (1)

969-970: New "nothingToShow" Key Addition

The new key "nothingToShow": "यहां दिखाने के लिए कुछ नहीं है।" has been added to the "people" section to provide a clear empty state message. The text is concise and appears consistent with similar updates in the other localization files.

public/locales/fr/translation.json (1)

969-970: New "nothingToShow" Key Addition

The added key "nothingToShow": "Rien à afficher ici." in the "people" section correctly reflects the intended message for an empty state in French. It aligns well with similar messages in other locales.

public/locales/sp/translation.json (1)

984-985: Localized Message Added Correctly.
The new key "nothingToShow" with the value "Nada que mostrar aquí." is correctly inserted in the "people" section. It is consistent with similar localization changes in other languages and meets the objective of providing a clearer empty state message for the People section.

Copy link

codecov bot commented Feb 1, 2025

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 88.64%. Comparing base (73cf8cd) to head (1c708a5).
Report is 22 commits behind head on develop-postgres.

Files with missing lines Patch % Lines
src/screens/UserPortal/People/People.tsx 50.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #3520       +/-   ##
=====================================================
+ Coverage              1.90%   88.64%   +86.73%     
=====================================================
  Files                   316      341       +25     
  Lines                  8249     8627      +378     
  Branches               1880     1926       +46     
=====================================================
+ Hits                    157     7647     +7490     
+ Misses                 8083      635     -7448     
- Partials                  9      345      +336     

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

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