Fix location filter to filter root locations

[sainak]

Proposed Changes

• Brief of changes made.

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
  • Enhanced location filtering in the API to support retrieving root locations when the "parent" query parameter is empty.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a subtle enhancement to the FacilityLocationViewSet in the location API, specifically modifying the get_queryset method. The change adds a new conditional filtering mechanism that allows retrieving root locations when the "parent" query parameter is empty. This modification provides a more flexible approach to querying location hierarchies without disrupting existing functionality.

Changes

File	Change Summary
care/emr/api/viewsets/location.py	Added conditional filtering in get_queryset to support root location retrieval when parent query parameter is empty

Poem

🌳 Roots emerge from query's embrace,
A whisper of code, a subtle trace
Empty parent, secrets unfurled
Location's hierarchy now twirled
API's magic, soft and light 🌿

---

📜 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 9be535f and b411f45.

📒 Files selected for processing (1)

• care/emr/api/viewsets/location.py (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Test / Test
• GitHub Check: Analyze (python)

🔇 Additional comments (1)

care/emr/api/viewsets/location.py (1)

111-114: Perhaps we could be more specific about the Django Filters issue?

The comment "For some reason its not working as intended in Django Filters" is a bit vague. It would be really helpful if we could document the specific issue you encountered with Django Filters, you know, for future reference.

Also, consider these alternative approaches that might be more... elegant:

1. Handle this in FacilityLocationFilter:

class FacilityLocationFilter(filters.FilterSet):
    parent = filters.UUIDFilter(field_name="parent__external_id")
    is_root = filters.BooleanFilter(method='filter_root_locations')
    name = filters.CharFilter(field_name="name", lookup_expr="icontains")

    def filter_root_locations(self, queryset, name, value):
        if value:
            return queryset.filter(parent__isnull=True)
        return queryset

2. Or make the current implementation more explicit:

-if "parent" in self.request.GET and not self.request.GET.get("parent"):
+if "parent" in self.request.GET and self.request.GET.get("parent") == "":

Let's verify if there are any existing usages of empty parent parameter:

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 56.16%. Comparing base (9be535f) to head (b411f45).
Report is 2 commits behind head on develop.

Files with missing lines	Patch %	Lines
care/emr/api/viewsets/location.py	0.00%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2804      +/-   ##
===========================================
- Coverage    56.17%   56.16%   -0.02%     
===========================================
  Files          215      215              
  Lines        10217    10219       +2     
  Branches      1030     1031       +1     
===========================================
  Hits          5739     5739              
- Misses        4462     4464       +2     
  Partials        16       16              

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