Changes to delivery progress text for each payment unit

[OrangeAndGreen]

https://dimagi.atlassian.net/browse/CCCT-897
cross-request: dimagi/commcare-core#1455

Product Description

Small improvements to the text displayed for each payment unit in the delivery progress page, to only count progress based on approved visits (not including pending visits).

Technical Summary

Simple change to the values that go into the text field and progress bar

Feature Flag

Connect

Safety Assurance

Safety story

Simple change to UI inputs. Tested manually.

Automated test coverage

No automated tests for Connect yet.

QA Plan

Verify the delivery progress bar and text for each payment unit are displayed as specified in Sankalp's comment in the Jira ticket.

Labels and Review

• Do we need to enhance the manual QA test coverage ? If yes, the "QA Note" label is set correctly
• Does the PR introduce any major changes worth communicating ? If yes, the "Release Note" label is set and a "Release Note" is specified in PR description.
• Risk label is set correctly
• The set of people pinged as reviewers is appropriate for the level of risk of the change

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in this pull request modify the setDeliveriesData method in the ConnectDeliveryProgressDeliveryFragment class. The modifications involve a restructuring of variable declarations and calculations within a loop that processes delivery records. Previously declared local variables such as totalApproved, totalPending, totalAmount, and daysRemaining are now re-declared within the loop, and the pending total calculation has been replaced by a new remaining variable. Additionally, the calculation for approvedPercentage is updated to use unit.getMaxTotal() instead of summing totalPending and totalApproved. The method previously used an auxiliary method, calculateDaysPending, which has now been removed in favor of invoking job.getDaysRemaining(). Overall, these changes streamline the method, reducing variable scope and simplifying the calculations.

Sequence Diagram(s)

sequenceDiagram
    participant F as ConnectDeliveryProgressDeliveryFragment
    participant D as Delivery Record
    participant J as Job
    participant U as Unit

    loop For each delivery
        F->>D: Retrieve delivery details
        Note over F: Declare local variables (totalApproved, totalAmount, daysRemaining) per iteration
        F->>F: Compute totalApproved directly within loop
        F->>F: Calculate remaining (new variable replaces totalPending)
        F->>J: Call job.getDaysRemaining()
        J-->>F: Return days remaining
        F->>U: Access unit.getMaxTotal() for approvedPercentage calculation
        F->>F: Compute approvedPercentage using new value
    end

Loading

Suggested Reviewers

• shubham1g5

---

📜 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 b5da6ff and 55547c8.

📒 Files selected for processing (1)

• app/src/org/commcare/fragments/connect/ConnectDeliveryProgressDeliveryFragment.java (2 hunks)

🔇 Additional comments (4)

app/src/org/commcare/fragments/connect/ConnectDeliveryProgressDeliveryFragment.java (4)

148-150: Improved progress calculation by excluding pending visits

The calculation has been updated to focus on approved visits only, with remaining now derived as the difference between maximum possible visits and approved visits. This aligns with the PR objective of ensuring progress is calculated based solely on approved visits.

Consider renaming remaining to something more descriptive like remainingVisits or visitsNotYetApproved for better code readability.

---

155-155: Code simplification by leveraging existing method

Good simplification by directly using job.getDaysRemaining() instead of a separate calculation method. This promotes code reuse and ensures consistent calculation of remaining days across the application.

---

157-157: Improved percentage calculation logic

The percentage calculation now correctly uses the maximum total as the denominator instead of the sum of approved and pending visits. This ensures the progress accurately reflects the ratio of completed work relative to the total expected work.

---

162-162: Updated to use new remaining calculation

This change consistently applies the new calculation approach by setting the pending count to the newly calculated remaining value.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[pm-dimagi]

I think taking key "approved" as constant value