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

Adding Origin and Assigned Facility Resource List #2803

Merged
merged 1 commit into from
Jan 31, 2025

Conversation

Jacobjeevan
Copy link
Contributor

@Jacobjeevan Jacobjeevan commented Jan 31, 2025

Proposed Changes

  • Added for displaying additional information on resource list page

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 specification with additional attributes for facilities, patients, and user information
    • Improved serialization capabilities for resource request data
    • Added optional fields for more flexible data representation

@Jacobjeevan Jacobjeevan requested a review from a team as a code owner January 31, 2025 10:37
Copy link

coderabbitai bot commented Jan 31, 2025

📝 Walkthrough

Walkthrough

The changes enhance the ResourceRequestListSpec and ResourceRequestRetrieveSpec classes in the resource request specification module. New attributes have been introduced to provide more comprehensive serialization capabilities, including facility-related information, patient details, and user-related fields. The modifications extend the classes' ability to represent and serialize resource request data with greater depth and flexibility.

Changes

File Changes
care/emr/resources/resource_request/spec.py - Added origin_facility attribute to ResourceRequestListSpec
- Added optional assigned_facility to ResourceRequestListSpec
- Introduced perform_extra_serialization class method for ResourceRequestListSpec
- Added multiple attributes to ResourceRequestRetrieveSpec:
- origin_facility
- Optional approving_facility
- Optional assigned_facility
- Optional related_patient
- Optional assigned_to
- Optional created_by
- Optional updated_by
- Added perform_extra_serialization class method for ResourceRequestRetrieveSpec

Suggested Reviewers

  • vigneshhari

Poem

🏥 Resource requests, now more refined
With facilities and details intertwined
Serialization's art, a coding delight
Mapping data with precision so bright
A spec that sings of details untold 🌟

✨ 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

🔭 Outside diff range comments (1)
care/emr/resources/resource_request/spec.py (1)

Line range hint 134-137: Fix the inconsistent serialization format, unless that was intentional.

I couldn't help but notice that while most of your serializations call to_json(), these two seem to have... missed the memo:

         if obj.created_by:
-            mapping["created_by"] = UserSpec.serialize(obj.created_by)
+            mapping["created_by"] = UserSpec.serialize(obj.created_by).to_json()
         if obj.updated_by:
-            mapping["updated_by"] = UserSpec.serialize(obj.updated_by)
+            mapping["updated_by"] = UserSpec.serialize(obj.updated_by).to_json()
🧹 Nitpick comments (1)
care/emr/resources/resource_request/spec.py (1)

89-98: Add type hints to the method signature, if it's not too much trouble.

The serialization logic looks fine, but it would be even better if we could add type hints to make it more maintainable for future developers who might not be as... intuitive as you.

     @classmethod
-    def perform_extra_serialization(cls, mapping, obj):
+    def perform_extra_serialization(cls, mapping: dict, obj: ResourceRequest) -> None:
📜 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 c857e96.

📒 Files selected for processing (1)
  • care/emr/resources/resource_request/spec.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test / Test

Copy link

codecov bot commented Jan 31, 2025

Codecov Report

Attention: Patch coverage is 50.00000% with 4 lines in your changes missing coverage. Please review.

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

Files with missing lines Patch % Lines
care/emr/resources/resource_request/spec.py 50.00% 4 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2803      +/-   ##
===========================================
- Coverage    56.17%   56.16%   -0.01%     
===========================================
  Files          215      215              
  Lines        10217    10224       +7     
  Branches      1030     1031       +1     
===========================================
+ Hits          5739     5742       +3     
- Misses        4462     4466       +4     
  Partials        16       16              

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

@vigneshhari vigneshhari merged commit 153a231 into ohcnetwork:develop Jan 31, 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