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 Latest visit date and Correct TX Curr #50

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Michaelndula
Copy link
Collaborator

@Michaelndula Michaelndula commented Jan 8, 2025

Summary by CodeRabbit

  • New Features

    • Enhanced patient enrollment data management with more precise tracking of patient statuses
    • Added latest visit date information to form retrieval process
  • Refactor

    • Updated patient treatment current (TxCurr) retrieval method
    • Modified patient visit sorting and date formatting logic

Copy link

coderabbitai bot commented Jan 8, 2025

Walkthrough

The pull request introduces modifications to two Java classes: GetTxCurr and FormsController. In GetTxCurr, the constructor and patient retrieval method have been significantly refactored, shifting from a query-based to an observation-based approach for managing patient enrollment data. The FormsController has been updated to include sorting of active visits and adding the latest visit date to the response, enhancing the information provided about patient visits.

Changes

File Change Summary
omod/src/main/java/org/openmrs/module/ssemrws/web/constants/GetTxCurr.java - Constructor updated to accept GetDatePatientBecameIIT instead of previous dependencies
- getTxCurrPatients method completely restructured to use direct observation fetching
- New logic for filtering patients based on enrollment dates and exclusion statuses
omod/src/main/java/org/openmrs/module/ssemrws/web/controller/FormsController.java - Added imports for SimpleDateFormat and Comparator
- Modified getAllAvailableFormsForVisit to sort active visits by start date
- Added latest visit date formatting to response

Sequence Diagram

sequenceDiagram
    participant GetTxCurr
    participant ContextService
    participant PatientEnrollmentData

    GetTxCurr->>ContextService: Fetch enrollment observations
    ContextService-->>GetTxCurr: Return observations
    GetTxCurr->>GetTxCurr: Filter patients by enrollment dates
    GetTxCurr->>GetTxCurr: Check patient statuses (death, transfer, RTT)
    GetTxCurr->>PatientEnrollmentData: Create enrollment data objects
    GetTxCurr-->>PatientEnrollmentData: Return filtered patient list
Loading

Possibly related PRs

Suggested reviewers

  • nelsonkimaiga

Poem

🐰 A Rabbit's Ode to Code Refactoring 🐰

In lines of Java, changes bloom bright,
Patients' journeys now clearer in sight,
Visits sorted, dates aligned just right,
With logic refined, our code takes flight,
A dance of data, pure delight!

Hop, hop, hooray! 🎉


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: 2

🧹 Nitpick comments (1)
omod/src/main/java/org/openmrs/module/ssemrws/web/controller/FormsController.java (1)

103-104: Use DateTimeFormatter instead of SimpleDateFormat for better thread safety and modern API

DateTimeFormatter from the java.time package is thread-safe and should be preferred over SimpleDateFormat.

Apply this diff to use DateTimeFormatter:

+ import java.time.ZoneId;
+ import java.time.format.DateTimeFormatter;

- SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
- String latestVisitDate = dateFormat.format(latestVisit.getStartDatetime());
+ DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
+ String latestVisitDate = latestVisit.getStartDatetime().toInstant().atZone(ZoneId.systemDefault()).format(formatter);
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 477abc5 and 87d13ee.

📒 Files selected for processing (2)
  • omod/src/main/java/org/openmrs/module/ssemrws/web/constants/GetTxCurr.java (1 hunks)
  • omod/src/main/java/org/openmrs/module/ssemrws/web/controller/FormsController.java (2 hunks)

Comment on lines +63 to +64
System.out.println("Including Patient: " + patient.getPersonName().getFullName()
+ " due to return to treatment date: " + rttDate);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Avoid logging patient names to prevent PII leakage

Logging patient names can lead to exposure of sensitive personal information and violate privacy regulations. Replace System.out.println statements with proper logging and avoid including personal identifiers.

Apply this diff to remove patient names from logs and use a logging framework:

- System.out.println("Including Patient: " + patient.getPersonName().getFullName()
-         + " due to return to treatment date: " + rttDate);
+ logger.info("Including patient due to return to treatment date: " + rttDate);

Ensure that a logging framework like SLF4J is used and properly configured:

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

private static final Logger logger = LoggerFactory.getLogger(GetTxCurr.class);

Comment on lines +67 to +68
System.out.println("Excluding Patient: " + patient.getPersonName().getFullName()
+ " due to exclusion date: " + exclusionDate);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Avoid logging patient names to prevent PII leakage

Logging patient names can lead to exposure of sensitive personal information and violate privacy regulations. Replace System.out.println statements with proper logging and avoid including personal identifiers.

Apply this diff to remove patient names from logs and use a logging framework:

- System.out.println("Excluding Patient: " + patient.getPersonName().getFullName()
-         + " due to exclusion date: " + exclusionDate);
+ logger.info("Excluding patient due to exclusion date: " + exclusionDate);

Committable suggestion skipped: line range outside the PR's diff.

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.

1 participant