Cancelling config workflow when device isn't compatible

[OrangeAndGreen]

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

Product Description

After showing the user an error message indicating that their device doesn't meet the security requirements for biometric, the configuration workflow will close.

Technical Summary

Finishing the activity instead of navigating to phone fragment.
Note: Popping back to phone would have also fixed the error, instead of navigating forward to phone fragment.
But once we know they can't enroll, might as well drop them back at home

Feature Flag

PersonalID

Safety Assurance

Safety story

Tested by forcing the error in code.
I was able to reproduce the bad behavior before the fix.

Automated test coverage

None

QA Plan

Reported by QA already.

[coderabbitai]

📝 Walkthrough

Walkthrough

The change updates the finish() method in the PersonalIdMessageFragment class. Specifically, for the case when the device configuration fails (PERSONALID_DEVICE_CONFIGURATION_FAILED), the method now directly finishes the current activity using requireActivity().finish(). Previously, this case would trigger navigation to the phone fragment. No other logic or cases in the finish() method are modified.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PersonalIdMessageFragment
    participant Activity

    User->>PersonalIdMessageFragment: Triggers finish() with PERSONALID_DEVICE_CONFIGURATION_FAILED
    PersonalIdMessageFragment->>Activity: finish()
    Activity-->>User: Activity closes

Loading

Possibly related PRs

• Pm Device configuration api #3117: Previously introduced navigation to the phone fragment for the PERSONALID_DEVICE_CONFIGURATION_FAILED case, which is now replaced by directly finishing the activity.

Suggested reviewers

• pm-dimagi
• 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 d820ee1 and 45b65aa.

📒 Files selected for processing (1)

• app/src/org/commcare/fragments/personalId/PersonalIdMessageFragment.java (1 hunks)

🔇 Additional comments (1)

app/src/org/commcare/fragments/personalId/PersonalIdMessageFragment.java (1)

140-142: Consider returning a clear RESULT_CANCELED before finishing the activity

Every other exit path that finishes PersonalIdActivity sets an explicit result (RESULT_OK) so the caller can distinguish success from failure.
For the configuration-failed branch we silently call finish(), which implicitly sends RESULT_CANCELED, but being explicit keeps the contract obvious and protects against regressions if the default ever changes.

case ConnectConstants.PERSONALID_DEVICE_CONFIGURATION_FAILED:
-    requireActivity().finish();
+    // Surface the failure to the caller explicitly
+    activity.setResult(Activity.RESULT_CANCELED);
+    activity.finish();
     break;

[ suggest_optional_refactor ]

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Commit Unit Tests in branch dv/biometric_fail_nav_fix
• Post Copyable Unit Tests in Comment

---

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 auto-generate unit tests to generate unit tests 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.