Firebase AppCheck - Add more logging #123
Conversation
Add additional logs for AppCheck
There was a problem hiding this comment.
Summary of Changes
Hello @riggaroo, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request refactors the application's logging infrastructure to leverage the Timber library, enabling more controlled and environment-specific logging behavior. It specifically integrates Crashlytics for comprehensive non-fatal error reporting in production, while maintaining standard debug logging during development. This change streamlines how logs are handled throughout the codebase, improving maintainability and diagnostic capabilities.
Highlights
- Logging Mechanism Migration: The application's logging mechanism has been switched from direct
android.util.Logcalls to the Timber logging library, providing a more robust and flexible logging solution. - Crashlytics Integration for Non-Fatals: Non-fatal exceptions and informational logs are now routed to Firebase Crashlytics through a custom Timber
CrashlyticsTree, enhancing error reporting and monitoring in release builds. - Dependency Updates: Key dependencies including Firebase BOM and Play Services Base have been updated to their latest versions, and the Timber library has been added across relevant modules.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request successfully migrates the application's logging to Timber, which is a commendable improvement for structured logging and integrating non-fatal error reporting with Crashlytics. The implementation of the CrashlyticsTree and its conditional planting in the Application class is well-executed. My review includes a few suggestions to enhance security, readability, and user experience by addressing a potential information leak in the logs and a silent error condition.
| } catch (exception : Exception) { | ||
| Log.d("CustomizeExportViewModel", "Original image save failed: ", exception) | ||
| } catch (exception: Exception) { | ||
| Timber.d(exception, "Original image save failed: ") |
There was a problem hiding this comment.
When saving the original image fails, the exception is caught and logged only at the DEBUG level. This failure is silent to the user, who might later see a "Download complete" message and incorrectly assume the original image was also saved. This could lead to unexpected data loss for the user. It's better to log this as a warning and notify the user with a snackbar message.
Timber.w(exception, "Original image save failed: ")
snackbarHostState.value.showSnackbar("Failed to save original image")
...twork/src/main/java/com/android/developers/androidify/startup/FirebaseAppCheckInitializer.kt
Show resolved
Hide resolved
...twork/src/main/java/com/android/developers/androidify/startup/FirebaseAppCheckInitializer.kt
Outdated
Show resolved
Hide resolved
| /** | ||
| * A Timber tree that logs to Crashlytics. | ||
| * | ||
| * In debug builds, this tree does nothing. In release builds, it logs non-fatal exceptions |
There was a problem hiding this comment.
Just curious as I don't know this - do fatal exceptions automatically end up in Play Console anyway?
There was a problem hiding this comment.
Yes, those are already logged :)
Switched logging mechanism to use Timber instead, to log non-fatals to Crashlytics too.
#122