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

added filter for is_archieved on file viewset #2704

Conversation

DraKen0009
Copy link
Contributor

@DraKen0009 DraKen0009 commented Jan 4, 2025

Proposed Changes

  • added a filefilter class for fileupload viewset

Associated Issue

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 filtering capabilities for file uploads based on archived status
    • Enabled more granular querying of file uploads through Django's filtering framework

@DraKen0009 DraKen0009 requested a review from a team as a code owner January 4, 2025 11:43
Copy link

coderabbitai bot commented Jan 4, 2025

📝 Walkthrough

Walkthrough

The pull request introduces filtering capabilities for file uploads in the FileUploadViewSet. A new FileUploadFilter class is implemented to enable boolean filtering on the is_archived field. The view set's configuration is updated to incorporate Django's filtering backend, allowing more precise querying of file uploads based on their archived status. The core authorization and file upload logic remains intact, with the changes focusing solely on expanding filtering functionality.

Changes

File Change Summary
care/emr/api/viewsets/file_upload.py - Added FileUploadFilter class with is_archived boolean filter
- Added filterset_class = FileUploadFilter to FileUploadViewSet
- Added filter_backends = [filters.DjangoFilterBackend] to FileUploadViewSet

Assessment against linked issues

Objective Addressed Explanation
Implement filters for file uploads [#2699]

Poem

🗂️ Filters dance, archives take flight
Bits and bytes now shine so bright
Django's magic, softly spun
File uploads, filtering done!
Code whispers its subtle might 🔍


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

54-56: Consider adding usage documentation or docstring for the filter class.

It might be slightly unexpected for new contributors or maintainers if there's no brief explanation of how FileUploadFilter should be used with is_archived. You might want to provide a small docstring indicating its filtering mechanism. This helps ensure clarity, especially when adding more filters later.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 08da469 and 622f890.

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

66-67: Verify test coverage for newly introduced filtering.

Even though it looks straightforward, it’s worth confirming that test cases exist for the FileUploadFilter usage. This will verify that the is_archived field filtering works as intended and integrates seamlessly with the viewset.

@vigneshhari vigneshhari merged commit d1468c6 into ohcnetwork:develop Jan 4, 2025
1 check 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.

Filters for file not present
2 participants