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

Add phone number search for organization users #10598

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from

Conversation

Mahendar0701
Copy link
Contributor

@Mahendar0701 Mahendar0701 commented Feb 13, 2025

Proposed Changes

@ohcnetwork/care-fe-code-reviewers

Merge Checklist

  • Add specs that demonstrate bug / test a new feature.
  • Update product documentation.
  • Ensure that UI text is kept in I18n files.
  • Prep screenshot or demo video for changelog entry, and attach it to issue.
  • Request for Peer Reviews
  • Completion of QA

Summary by CodeRabbit

  • New Features
    • Introduced a multi-field search capability on the organization users page, allowing users to filter results using criteria such as username and phone number.
    • Streamlined the search experience with refined input handling and dynamic search parameter updates.

@Mahendar0701 Mahendar0701 requested a review from a team as a code owner February 13, 2025 15:39
Copy link
Contributor

coderabbitai bot commented Feb 13, 2025

Walkthrough

The changes update the search functionality within the OrganizationUsers component. A new multi-field search mechanism is introduced by adding a searchOptions array and corresponding handler functions (handleSearch and handleFieldChange). The existing search input is replaced by the SearchByMultipleFields component, and query parameters in the useQuery hook are adjusted to reflect the new search criteria based on selected fields.

Changes

File Change Summary
src/pages/Organization/OrganizationUsers.tsx - Introduced searchOptions array to define searchable fields (username and phone_number)
- Added handleSearch (via useCallback) to update search parameters
- Added handleFieldChange to reset search fields
- Replaced Input with SearchByMultipleFields component
- Updated useQuery queryKey and query function to use new search parameters

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant S as SearchByMultipleFields
    participant OU as OrganizationUsers
    participant API as Server/API

    U->>S: Enter search value & select field
    S->>OU: Trigger handleSearch with input details
    OU->>API: Make API call with updated query parameters
    API-->>OU: Return search results
    OU-->>S: Update displayed results

    U->>S: Change selected field
    S->>OU: Trigger handleFieldChange to reset search
    OU-->>S: Reset and update fields
Loading

Possibly related PRs

Suggested labels

needs testing, needs review

Suggested reviewers

  • Jacobjeevan
  • rithviknishad

Poem

I’m a happy rabbit, coding with glee,
Hopping through search fields so merrily.
New functions and options, a garden so wide,
In OrganizationUsers, I take pride.
With each refreshed query, my spirits abide!


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 209632c and c87fc40.

📒 Files selected for processing (1)
  • src/pages/Organization/OrganizationUsers.tsx (3 hunks)
🧰 Additional context used
🧠 Learnings (1)
src/pages/Organization/OrganizationUsers.tsx (1)
Learnt from: Jacobjeevan
PR: ohcnetwork/care_fe#10568
File: src/pages/Facility/settings/organizations/FacilityOrganizationUsers.tsx:69-78
Timestamp: 2025-02-13T19:11:07.106Z
Learning: Avoid implementing redundant client-side filtering when the API already supports search functionality, especially with paginated data, as it can lead to incorrect results and unnecessary performance overhead.
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Test
  • GitHub Check: OSSAR-Scan
  • GitHub Check: cypress-run (1)
🔇 Additional comments (4)
src/pages/Organization/OrganizationUsers.tsx (4)

2-2: LGTM! Good choice of dependencies.

The added imports, particularly isValidPhoneNumber from react-phone-number-input, are appropriate for implementing robust phone number validation.

Also applies to: 4-4, 12-12


35-35: LGTM! Well-structured search configuration.

The search options are well-defined with appropriate types and placeholders. The cacheBlacklist correctly prevents caching of search parameters.

Also applies to: 39-52


77-96: LGTM! Proper implementation of server-side filtering.

The query integration correctly implements server-side filtering, avoiding the pitfalls of client-side filtering with paginated data. The queryKey properly includes all search parameters for accurate cache invalidation.


136-147: LGTM! Well-implemented search field component.

The SearchByMultipleFields component is properly configured with appropriate options, handlers, and accessibility attributes (data-cy).


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

netlify bot commented Feb 13, 2025

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit c87fc40
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/67af372a7cebd900083c76cb
😎 Deploy Preview https://deploy-preview-10598.preview.ohc.network
📱 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.

@Mahendar0701
Copy link
Contributor Author

Mahendar0701 commented Feb 13, 2025

@rithviknishad @Jacobjeevan Need backend support for phonenumber filtering. Should i raise PR for phone_number filter in backend??

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: 1

🧹 Nitpick comments (2)
src/pages/Organization/OrganizationUsers.tsx (2)

38-51: Consider enhancing type safety and internationalization.

While the search options configuration is well-structured, consider these improvements:

  1. Add type definitions for the search options
  2. Use translation keys for placeholders
+interface SearchOption {
+  key: "username" | "phone_number";
+  type: "text" | "phone";
+  placeholder: string;
+  value: string;
+}

-const searchOptions = [
+const searchOptions: SearchOption[] = [
   {
     key: "username",
     type: "text" as const,
-    placeholder: "Search by username",
+    placeholder: t("search_by_username"),
     value: qParams.name || "",
   },
   {
     key: "phone_number",
     type: "phone" as const,
-    placeholder: "Search by phone number",
+    placeholder: t("search_by_phone_number"),
     value: qParams.phone_number || "",
   },
 ];

77-89: Consider adding error handling and loading states.

The query integration and UI implementation are well-structured, but consider these enhancements:

  1. Add error handling for API failures
  2. Show loading states during search operations
 const { data: users, isFetching: isFetchingUsers } = useQuery({
   queryKey: [
     "organizationUsers",
     id,
     qParams.name,
     qParams.phone_number,
     qParams.page,
   ],
   queryFn: query.debounced(organizationApi.listUsers, {
     pathParams: { id },
     queryParams: {
       username: qParams.name,
       phone_number: qParams.phone_number,
       page: qParams.page,
       limit: resultsPerPage,
       offset: ((qParams.page ?? 1) - 1) * resultsPerPage,
     },
   }),
   enabled: !!id,
+  retry: 3,
+  onError: (error) => {
+    // Handle API errors
+    console.error("Failed to fetch users:", error);
+  },
 });

 <SearchByMultipleFields
   id="user-search"
   options={searchOptions}
   initialOptionIndex={Math.max(
     searchOptions.findIndex((option) => option.value !== ""),
     0,
   )}
   onSearch={handleSearch}
   onFieldChange={handleFieldChange}
   className="w-full"
   data-cy="search-user"
+  isLoading={isFetchingUsers}
 />

Also applies to: 135-146

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 52efe89 and 209632c.

📒 Files selected for processing (1)
  • src/pages/Organization/OrganizationUsers.tsx (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: OSSAR-Scan
  • GitHub Check: cypress-run (1)
🔇 Additional comments (1)
src/pages/Organization/OrganizationUsers.tsx (1)

2-2: LGTM! Well-structured setup for the search functionality.

The imports and cache configuration are properly set up for the new search functionality.

Also applies to: 11-11, 34-34

src/pages/Organization/OrganizationUsers.tsx Outdated Show resolved Hide resolved
@Jacobjeevan
Copy link
Contributor

@rithviknishad @Jacobjeevan Need backend support for phonenumber filtering. Should i raise PR for phone_number filter in backend??

Create a backend issue and get it assigned 👍

@Mahendar0701
Copy link
Contributor Author

@rithviknishad @Jacobjeevan Backend PR ohcnetwork/care#2833 got merged . This PR is ready for review now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add more parameters for searching organization users
3 participants