Fix sync buttons in learn and delivery progress pages

[OrangeAndGreen]

https://dimagi.atlassian.net/browse/CCCT-839

cross-request: dimagi/commcare-core#1455

Product Description

Sync button in top-right corner now functional in Learn Progress and Delivery Progress pages.

Technical Summary

The two fragments needed to override the onMenuItemSelected function and, when the sync action was selected by the user, initiate a data refresh.

Feature Flag

Connect

Safety Assurance

Safety story

The added code is similar to what's already in the opportunity list page to do a refresh there.

Automated test coverage

No automated tests for Connect yet.

QA Plan

To add to the test plan if not already there:

• Learning progress: Click the sync button in the top-right corner and verify that the page performs a sync with the server
• Delivery progress: Repeat the above test

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 pull request modifies three fragments to update the way menu item selection events are handled. In both the ConnectDeliveryProgressFragment and ConnectLearningProgressFragment classes, a new implementation of the onOptionsItemSelected(MenuItem item) method is added. This method checks whether the selected menu item’s ID matches R.id.action_sync and, if so, calls the refreshData() method, returning true to indicate the event has been handled. If the item’s ID is different, the method delegates the event to its superclass by calling the superclass’s implementation of onOptionsItemSelected(item). In the ConnectJobsListsFragment class, an @Override annotation is added to the pre-existing method to explicitly indicate that the method is overriding a method from its superclass.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Fragment
    participant Superclass

    User->>Fragment: Select MenuItem
    Fragment->>Fragment: onOptionsItemSelected(MenuItem)
    alt MenuItem is 'action_sync'
      Fragment->>Fragment: refreshData()
      Fragment-->>User: return true
    else Other MenuItem
      Fragment->>Superclass: onOptionsItemSelected(MenuItem)
      Superclass-->>Fragment: handle selection
      Fragment-->>User: return result
    end

Loading

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 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 12a6338 and 12faaa8.

📒 Files selected for processing (3)

• app/src/org/commcare/fragments/connect/ConnectDeliveryProgressFragment.java (2 hunks)
• app/src/org/commcare/fragments/connect/ConnectJobsListsFragment.java (1 hunks)
• app/src/org/commcare/fragments/connect/ConnectLearningProgressFragment.java (2 hunks)

🔇 Additional comments (3)

app/src/org/commcare/fragments/connect/ConnectDeliveryProgressFragment.java (1)

268-276: Implementation correctly adds sync functionality to the menu.

The implementation properly overrides onOptionsItemSelected to handle the sync action and call the existing refreshData() method. This follows standard Android pattern for menu item handling. The code is clean and consistent with the PR objectives.

app/src/org/commcare/fragments/connect/ConnectLearningProgressFragment.java (1)

91-99: Implementation correctly adds sync functionality to the menu.

The implementation properly overrides onOptionsItemSelected to handle the sync action and call the existing refreshData() method. This follows standard Android pattern for menu item handling. The code is clean and consistent with the PR objectives.

app/src/org/commcare/fragments/connect/ConnectJobsListsFragment.java (1)

110-110: Good addition of @OverRide annotation.

Adding the @Override annotation improves code clarity and provides compile-time safety by ensuring the method correctly overrides the parent class method. This aligns with the other implementations in this PR.

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

[OrangeAndGreen]

Per Jignesh's suggestion: Fragment.onOptionsItemSelected is deprecated, and the modern approach is for fragments to add a MenuProvider to handle custom actions. Change made in 7624441, including updating the Connect home page to use the modern approach.