Timer stopping after activity is paused issue solved

[Jignesh-dimagi]

Technical Summary

https://dimagi.atlassian.net/browse/QA-7823

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 adjust the lifecycle management of the resend timer and SMS broadcast receiver within the PersonalIdPhoneVerificationFragment. The resend timer is now started in onResume() and stopped in onPause(), instead of the previous onCreateView() and onStop() methods, respectively. Similarly, the SMS broadcast receiver registration is moved from onStart() to onResume(), with unregistration still in onPause(). Additionally, the assignment of otpRequestTime in the requestOtp() method is now conditional on the presence of a valid phone number.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Fragment
    participant SMSReceiver

    User->>Fragment: Fragment resumes (onResume)
    Fragment->>Fragment: startResendTimer()
    Fragment->>Fragment: register SMSReceiver

    User->>Fragment: Fragment pauses (onPause)
    Fragment->>Fragment: stopResendTimer()
    Fragment->>Fragment: unregister SMSReceiver

    User->>Fragment: requestOtp()
    Fragment->>Fragment: Check if primaryPhone is valid
    alt primaryPhone is valid
        Fragment->>Fragment: Set otpRequestTime
    else primaryPhone is null/empty
        Fragment->>Fragment: Do not set otpRequestTime
    end

Loading

---

📜 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 11a0b7c and 64944e4.

📒 Files selected for processing (1)

• app/src/org/commcare/fragments/personalId/PersonalIdPhoneVerificationFragment.java (2 hunks)

🔇 Additional comments (4)

app/src/org/commcare/fragments/personalId/PersonalIdPhoneVerificationFragment.java (4)

183-183: LGTM! Proper timer lifecycle management.

Moving startResendTimer() to onResume() correctly addresses the issue where the timer would continue running when the activity is paused. This ensures the timer only runs when the fragment is actively visible to the user.

---

184-184: LGTM! Consistent receiver lifecycle management.

Moving SMS receiver registration to onResume() maintains consistency with the timer lifecycle changes and ensures the receiver is only active when the fragment is focused.

---

191-191: LGTM! Completes the timer lifecycle fix.

Moving stopResendTimer() to onPause() ensures the timer stops immediately when the fragment loses focus, completing the fix for the timer lifecycle issue described in the PR title.

---

254-254: LGTM! Good defensive programming.

Moving the otpRequestTime assignment inside the phone number validation prevents unnecessary timestamp updates when no OTP request is actually made, improving the accuracy of the resend timer logic.

✨ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.