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

Enable search for OrganizationUsers #2739

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

Jacobjeevan
Copy link
Contributor

@Jacobjeevan Jacobjeevan commented Jan 14, 2025

Proposed Changes

  • Enable search for organization users

Associated Issue

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 organization users
    • Enhanced search capabilities for organization user management

@Jacobjeevan Jacobjeevan requested a review from a team as a code owner January 14, 2025 15:21
Copy link

coderabbitai bot commented Jan 14, 2025

📝 Walkthrough

Walkthrough

The pull request introduces a new filter class OrganizationUserFilter to the OrganizationUsersViewSet in the organization API, enabling username-based filtering for organization users. By adding the filterset_class and configuring filter_backends, the changes enhance the API's search capabilities without modifying existing viewset logic. The implementation allows more granular querying of organization users through a username filter.

Changes

File Change Summary
care/emr/api/viewsets/organization.py - Added OrganizationUserFilter class for username filtering
- Updated OrganizationUsersViewSet with filterset_class
- Added filters.DjangoFilterBackend to filter_backends

Possibly related PRs

  • Facility Users Username Filter #2719: The Facility Users Username Filter PR introduces a similar username filtering mechanism for FacilityUsersViewSet, mirroring the approach in this PR.

Suggested reviewers

  • vigneshhari

Poem

🔍 Filters dancing, queries light
Username search, a developer's delight
Organization users now can be found
With just a few keystrokes, precision profound
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

@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 (2)
care/emr/api/viewsets/organization.py (2)

201-202: Perhaps we could add a docstring to enlighten future maintainers?

The filter implementation looks good, but a docstring explaining the purpose and usage of this filter class would be really nice to have.

 class OrganizationUserFilter(filters.FilterSet):
+    """Filter class for OrganizationUser model, enabling username-based search."""
     username = filters.CharFilter(field_name="user__username", lookup_expr="icontains")
🧰 Tools
🪛 GitHub Actions: Lint Code Base

[warning] 201-201: Code formatting issue detected and auto-fixed by ruff-format. A blank line was added after the OrganizationUserFilter class definition.


209-210: Looks good, though we could potentially do more...

The filter integration is clean and well-implemented. While we're at it, have you considered adding other useful filters like role or email? Just a thought.

 class OrganizationUserFilter(filters.FilterSet):
     username = filters.CharFilter(field_name="user__username", lookup_expr="icontains")
+    email = filters.CharFilter(field_name="user__email", lookup_expr="icontains")
+    role = filters.CharFilter(field_name="role__name", lookup_expr="icontains")
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 373e3c6 and 656b2b1.

📒 Files selected for processing (1)
  • care/emr/api/viewsets/organization.py (1 hunks)
🧰 Additional context used
🪛 GitHub Actions: Lint Code Base
care/emr/api/viewsets/organization.py

[warning] 201-201: Code formatting issue detected and auto-fixed by ruff-format. A blank line was added after the OrganizationUserFilter class definition.

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test / test
🔇 Additional comments (1)
care/emr/api/viewsets/organization.py (1)

201-203: Thanks for letting ruff-format handle the spacing.

The formatting has been automatically fixed. Moving forward, you might want to run ruff format locally before committing to avoid these tiny surprises.

🧰 Tools
🪛 GitHub Actions: Lint Code Base

[warning] 201-201: Code formatting issue detected and auto-fixed by ruff-format. A blank line was added after the OrganizationUserFilter class definition.

Copy link

codecov bot commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.45%. Comparing base (373e3c6) to head (656b2b1).
Report is 5 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2739      +/-   ##
===========================================
+ Coverage    60.43%   60.45%   +0.01%     
===========================================
  Files          252      252              
  Lines        12697    12701       +4     
  Branches      1111     1111              
===========================================
+ Hits          7674     7678       +4     
  Misses        4954     4954              
  Partials        69       69              

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

@vigneshhari vigneshhari merged commit fab832b into ohcnetwork:develop Jan 15, 2025
4 of 5 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.

3 participants