More API error messages

[OrangeAndGreen]

Product Description

Improved user messaging for several HTTP error codes.

Technical Summary

Added messages for unauthorized, server error, cooldown, and unknown.
Parsing errors (JSONException, IOException) during failure scenario handling now treated as unknown errors

Feature Flag

PersonalID

Safety Assurance

Safety story

No special testing, these are just different strings to show

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes introduce enhanced error handling for recovery network operations. Four new string resources were added to provide specific user-facing messages for unauthorized requests, server errors, request cooldowns, and unknown errors. The PersonalIdApiErrorHandler class was updated to map additional error codes to these new string resources, including a new case for unknown errors. The PersonalIdApiHandler class added an UNKNOWN_ERROR code to its error code enumeration and now uses this code for previously unhandled or ambiguous error situations, consolidating certain exception handling logic.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Activity
    participant PersonalIdApiHandler
    participant PersonalIdApiErrorHandler

    User->>Activity: Initiates recovery network request
    Activity->>PersonalIdApiHandler: Sends request
    PersonalIdApiHandler-->>Activity: Handles response
    alt Error occurs
        PersonalIdApiHandler->>PersonalIdApiErrorHandler: Pass error code (e.g., UNAUTHORIZED, SERVER_ERROR, COOLDOWN, UNKNOWN_ERROR)
        PersonalIdApiErrorHandler-->>Activity: Returns specific error string resource
        Activity-->>User: Displays error message
    else Success
        Activity-->>User: Displays success
    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 4a9a7cb and af06687.

📒 Files selected for processing (3)

• app/res/values/strings.xml (1 hunks)
• app/src/org/commcare/connect/network/PersonalIdApiErrorHandler.java (1 hunks)
• app/src/org/commcare/connect/network/PersonalIdApiHandler.java (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

app/src/org/commcare/connect/network/PersonalIdApiErrorHandler.java (1)

app/src/org/commcare/connect/network/ConnectNetworkHelper.java (1)

• ConnectNetworkHelper (46-464)

🔇 Additional comments (6)

app/src/org/commcare/connect/network/PersonalIdApiHandler.java (2)

28-28: Good addition of semantic error code.

The new UNKNOWN_ERROR enum constant provides better categorization for ambiguous error scenarios and improves error handling granularity.

---

97-99: Excellent improvement to exception handling.

The consolidation into a multi-catch block is more concise and the change from NETWORK_ERROR to UNKNOWN_ERROR is semantically correct - parsing errors during error response handling are indeed different from network connectivity issues.

app/res/values/strings.xml (1)

334-337: Well-designed error messages for improved user experience.

The new string resources provide clear, specific feedback for different API error scenarios. The messages are user-friendly and appropriately informative without being technical.

app/src/org/commcare/connect/network/PersonalIdApiErrorHandler.java (3)

37-37: Improved error specificity.

The mapping now uses the dedicated token unavailable string resource, providing more accurate user feedback for this specific error scenario.

---

39-43: Excellent mapping of error codes to specific messages.

Each error code now returns an appropriate, specific string resource that accurately reflects the underlying issue:

• Rate limiting maps to cooldown message with timeframe
• Authentication failures map to unauthorized message
• Server errors map to server error message

This provides much better user experience with clear, actionable feedback.

---

49-50: Good addition of unknown error handling.

The new UNKNOWN_ERROR case properly handles ambiguous error scenarios with an appropriate fallback message, completing the error handling coverage.

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