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

Resource requests: added status, cat and title filters #2799

Merged
merged 1 commit into from
Jan 31, 2025

Conversation

Jacobjeevan
Copy link
Contributor

@Jacobjeevan Jacobjeevan commented Jan 30, 2025

Proposed Changes

  • Added filters for title, status and category for resource requests

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
    • Enhanced resource request filtering capabilities
    • Added filters for:
      • Resource request title
      • Resource request status
      • Resource request category

@Jacobjeevan Jacobjeevan requested a review from a team as a code owner January 30, 2025 21:10
Copy link
Contributor

coderabbitai bot commented Jan 30, 2025

📝 Walkthrough

Walkthrough

The changes introduce three new filters to the ResourceRequestFilters class in the resource request viewset. These filters expand the existing filtering capabilities by allowing users to filter resource requests based on title (case-insensitive), status (exact match), and category (exact match). The enhancement provides more granular querying options for resource request data, complementing the previously existing facility and patient-related filters.

Changes

File Change Summary
care/emr/api/viewsets/resource_request.py Added three new filters to ResourceRequestFilters:
- title: Case-insensitive containment filter
- status: Exact match status filter
- category: Exact match category filter

Poem

🔍 Filters, oh filters, so precise and neat
Searching through requests with a filtering beat
Title, status, category in line
Making queries simply divine
Whispers Was this not what you wanted? How quaint. 🕵️‍♀️

✨ 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.

@Jacobjeevan Jacobjeevan linked an issue Jan 30, 2025 that may be closed by this pull request
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/resource_request.py (1)

33-34: Consider adding validation for status and category filters.

While the implementation is functional, it might be slightly more robust to validate these values against predefined choices. You know, just to prevent those pesky invalid status and category queries that might slip through. 😊

Consider updating the filters like this:

-    status = filters.CharFilter(field_name="status", lookup_expr="iexact")
-    category = filters.CharFilter(field_name="category", lookup_expr="iexact")
+    status = filters.ChoiceFilter(
+        field_name="status",
+        choices=ResourceRequest.STATUS_CHOICES,
+    )
+    category = filters.ChoiceFilter(
+        field_name="category",
+        choices=ResourceRequest.CATEGORY_CHOICES,
+    )

Also, it would be absolutely wonderful if you could add some documentation about the valid status and category values. You know, for those of us who might need it someday. 📝

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c6e3020 and 9304750.

📒 Files selected for processing (1)
  • care/emr/api/viewsets/resource_request.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test / Test
🔇 Additional comments (2)
care/emr/api/viewsets/resource_request.py (2)

32-32: LGTM! The title filter implementation looks reasonable.

Using case-insensitive containment match for the title filter will provide a good user experience for partial text searches.


32-34: Verify the existence of these fields in the model.

Let's make sure these fields actually exist in the ResourceRequest model and check for any existing queries that might be affected.

✅ Verification successful

All fields exist and are properly configured in the model.

The fields title, status, and category are correctly defined in the ResourceRequest model with appropriate field types and constraints. The filters are using standard Django lookups that match the field types.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence of title, status, and category fields and their usage

# Check model definition
echo "Checking ResourceRequest model definition..."
rg -A 5 "class ResourceRequest" care/emr/models/

# Check existing queries
echo "Checking existing queries..."
rg -g '!*/migrations/*' "title|status|category" care/emr/

Length of output: 65326

Copy link

codecov bot commented Jan 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.16%. Comparing base (c6e3020) to head (9304750).
Report is 4 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2799      +/-   ##
===========================================
+ Coverage    56.14%   56.16%   +0.01%     
===========================================
  Files          215      215              
  Lines        10212    10215       +3     
  Branches      1030     1030              
===========================================
+ Hits          5734     5737       +3     
  Misses        4462     4462              
  Partials        16       16              

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

@vigneshhari vigneshhari merged commit 283cd5e into ohcnetwork:develop Jan 31, 2025
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.

Resources API is not filtering by Patient in Patient Details Page and Status in Resource Board
2 participants