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

Username filter in facility organization #2784

Conversation

Rishith25
Copy link

@Rishith25 Rishith25 commented Jan 27, 2025

Proposed Changes

Associated Issue

  • Link to issue here, explain how the proposed solution will solve the reported issue/ feature request.

Architecture changes

  • Remove this section if not used

Merge Checklist

  • Tests added/fixed
  • Update docs in /docs
  • Linting Complete
  • Any other necessary step

Only PR's with test cases included and passing lint and test pipelines will be reviewed

@ohcnetwork/care-backend-maintainers @ohcnetwork/care-backend-admins

Summary by CodeRabbit

  • New Features
    • Added username filtering for facility organization users
  • Improvements
    • Enhanced querying capabilities for facility organization user data

@Rishith25 Rishith25 requested a review from a team as a code owner January 27, 2025 16:35
Copy link
Contributor

coderabbitai bot commented Jan 27, 2025

📝 Walkthrough

Walkthrough

The pull request introduces a new filter class FacilityOrganizationUserFilter in the facility organization API viewset, enabling filtering of FacilityOrganizationUser instances by username. The FacilityOrganizationUsersViewSet is updated to incorporate this filter, adding filterset_class and filter_backends to support more granular querying of facility organization users.

Changes

File Change Summary
care/emr/api/viewsets/facility_organization.py - Added FacilityOrganizationUserFilter class with username filtering
- Updated FacilityOrganizationUsersViewSet with filter configuration

Possibly related PRs

Suggested reviewers

  • vigneshhari
  • rithviknishad

Poem

🔍 Filtering users with finesse,
A username quest, nothing less!
Django's magic, filters so bright,
Querying data with pure delight 🕵️‍♀️
Code evolves, one filter at a time

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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
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)
care/emr/api/viewsets/facility_organization.py (1)

152-153: I see we're keeping things... minimal.

While the username filter implementation works, it might be nice if we could add some basic input validation and perhaps consider adding filters for other relevant user fields. You know, just to make it a bit more... complete.

Consider enhancing the filter class with additional fields and validation:

 class FacilityOrganizationUserFilter(filters.FilterSet):
     username = filters.CharFilter(field_name="user__username", lookup_expr="icontains")
+    email = filters.CharFilter(field_name="user__email", lookup_expr="icontains")
+    is_active = filters.BooleanFilter(field_name="user__is_active")
+
+    class Meta:
+        model = FacilityOrganizationUser
+        fields = ["username", "email", "is_active"]
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0b64be7 and ff07218.

📒 Files selected for processing (1)
  • care/emr/api/viewsets/facility_organization.py (1 hunks)
🔇 Additional comments (2)
care/emr/api/viewsets/facility_organization.py (2)

158-159: Oh, I noticed we forgot something... tests perhaps?

The filter configuration looks good, but it would be absolutely wonderful if we could add some test cases to verify the username filtering functionality. You know, just to make sure everything works as intended... now and in the future.

Would you like me to help generate some test cases? Here's what we should cover:

  1. Filtering with exact username match
  2. Filtering with partial username match
  3. Case-insensitive matching
  4. Empty result handling
  5. Special character handling

152-159: Just a tiny performance consideration we might want to think about...

The icontains lookup on username could potentially be resource-intensive on large datasets. It might be worth ensuring we have appropriate indexing and rate limiting in place.

Let's check the database indexing and existing rate limiting configuration:

@rithviknishad
Copy link
Member

PRs not following the merge checklist would be closed

@Rishith25
Copy link
Author

Rishith25 commented Jan 29, 2025

@rithviknishad @Jacobjeevan username filtering test cases for other entities are not present in entire codebase.
Should i need to write test cases for username filtering for facility organization users?? because we dont have test cases for username filtering anywhere

Correct me if i am wrong and also can you please guide me on how to write test cases in backend if i need to write test cases.

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.

Add fallback url for goback() | OTP field auto focus | Add Search Feature for users
2 participants