Fixes a NPE with Connect ID Flow

[shubham1g5]

Product Description

Earlier we were cleaning the listener in onDestroy by which time there is no guarantee that the fragment will be alive or not. It's anyway better for UI listeners to be tied to onResume and onPause instead which is what this PR does to correct this behavior.

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 refactor how the NavController.OnDestinationChangedListener is managed within the NavigationHostCommCareActivity class. Instead of adding the listener in onCreate and removing it in onDestroy, the listener is now added in onResume and removed in onPause. The reference to the listener is still set to null in onDestroy. This adjustment ensures that the listener is active only when the activity is in the foreground, aligning with the activity's visible lifecycle.

Suggested labels

skip-integration-tests

Suggested reviewers

• OrangeAndGreen

Tip

⚡️ Faster reviews with caching

• CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

---

📜 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 16ba8f8 and f259740.

📒 Files selected for processing (1)

• app/src/org/commcare/activities/NavigationHostCommCareActivity.java (1 hunks)

🔇 Additional comments (4)

app/src/org/commcare/activities/NavigationHostCommCareActivity.java (4)

25-26: Improved lifecycle management with onResume.

Moving the addOnDestinationChangedListener call from onCreate to onResume is a good practice. This ensures the listener is only active when the activity is visible to the user, providing better alignment with the Android activity lifecycle.

Also applies to: 27-31

---

33-37: Well-paired lifecycle cleanup in onPause.

Adding the onPause method to remove the destination changed listener is the correct companion to the onResume addition. This follows Android's recommended lifecycle management pattern and helps prevent potential memory leaks or zombie listeners.

---

39-43: Good practice keeping resource cleanup in onDestroy.

Setting the listener to null in onDestroy is still appropriate even though the listener is now removed in onPause. This ensures proper cleanup when the activity is completely destroyed, preventing any potential memory leaks.

---

25-43: NPE fix correctly implemented.

This refactoring appropriately addresses the NullPointerException issue by ensuring that the listener is always managed within the activity's foreground lifecycle (onResume/onPause) rather than dealing with it during destruction. This makes the code more robust as the fragment state is more predictable during these earlier lifecycle events.

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