Report all non fatals to firebase

[shubham1g5]

Summary

Reports all non fatals to Firebase Crashlytics

PR Checklist

• If I think the PR is high risk, "High Risk" label is set
• I have confidence that this PR will not introduce a regression for the reasons below
• Do we need to enhance manual QA test coverage ? If yes, "QA Note" label is set correctly
• Does the PR introduce any major changes worth communicating ? If yes, "Release Note" label is set and a "Release Note" is specified in PR description.

Automated test coverage

NA

Safety story

Minor logs handling.

cross-request: dimagi/commcare-core#1453

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces modifications to two logging classes: AndroidLogger and PreInitLogger. Both classes have been enhanced with a new method, logException(Throwable e), which allows for the explicit logging of exceptions. This method leverages the existing CrashUtil.reportException(e) to report the provided exceptions effectively. The addition of this method improves the logging capabilities of both classes, enabling better exception handling. No other methods or functionalities within these classes have been altered, and the overall structure and logic remain unchanged.

Possibly related PRs

• Removes some logs which are killing our sumo usage #2911: The PreInitLogger class in the main PR and the PreInitLogger class in the retrieved PR both added a logException(Throwable e) method, indicating a direct connection in enhancing logging functionality for exceptions.

Suggested reviewers

• OrangeAndGreen
• pm-dimagi
• avazirna

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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. (Experiment)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

app/src/org/commcare/logging/AndroidLogger.java (1)

86-89: Consider adding documentation for exception handling strategy

While the implementation is correct, it would be helpful to document the distinction between regular logging (using CrashUtil.log) and exception reporting (using CrashUtil.reportException) in the class-level documentation.

Consider adding this documentation:

 /**
  * Logging engine for CommCare ODK Environments.
+ * 
+ * This logger provides two types of logging:
+ * 1. Regular logging via log() method which uses CrashUtil.log
+ * 2. Exception logging via logException() method which reports to Firebase Crashlytics
  *
  * @author ctsims
  */

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 61e12ff and bf98668.

📒 Files selected for processing (2)

• app/src/org/commcare/logging/AndroidLogger.java (1 hunks)
• app/src/org/commcare/logging/PreInitLogger.java (2 hunks)

🔇 Additional comments (3)

app/src/org/commcare/logging/PreInitLogger.java (2)

4-4: LGTM: Import addition is appropriate

The CrashUtil import is correctly placed and necessary for the new exception reporting functionality.

---

77-80: LGTM: Clean implementation of exception logging

The implementation is straightforward and correctly delegates to CrashUtil.reportException. This aligns with the PR's objective of reporting non-fatal errors to Firebase.

app/src/org/commcare/logging/AndroidLogger.java (1)

86-89: LGTM: Clean implementation of exception logging

The implementation correctly delegates to CrashUtil.reportException and maintains consistency with PreInitLogger's implementation.

[avazirna]

@damagatchi retest this please

[avazirna]

@shubham1g5 is there a reason for skipping the integration tests here?

[shubham1g5]

Just because it's a very minute change not affecting any functionality.