Skip to content

Conversation

@avazirna
Copy link
Contributor

Summary

This PR enables Firebase Performance Monitoring for CommCare. This service automatically captures metrics related to the performance of Android apps, such as screen rendering times, network latency, component lifecycle events, and offers the possibility to include custom traces targeting specific app behaviours.

Safety Assurance

  • If 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

Safety story

Considering that this adds a new SDK to the app and runs on its own service, it's important to ensure that it doesn't impact App size and there are no major performance implications.

shubham1g5
shubham1g5 previously approved these changes Sep 13, 2024
@avazirna
Copy link
Contributor Author

@damagatchi retest this please

@avazirna avazirna added this to the 2.55 milestone Sep 17, 2024
@avazirna
Copy link
Contributor Author

@damagatchi retest this please

1 similar comment
@avazirna
Copy link
Contributor Author

@damagatchi retest this please

@coderabbitai
Copy link

coderabbitai bot commented Dec 9, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request involve the integration of Firebase Performance Monitoring into the application by modifying the build.gradle files. In the app/build.gradle, the com.google.firebase.firebase-perf plugin is applied, and the dependency com.google.firebase:firebase-perf:21.0.1 is added to the dependencies block. This integration allows the application to collect performance metrics, enabling real-time monitoring of its performance.

Additionally, in the main build.gradle file, a new classpath dependency for the Firebase Performance Monitoring plugin is introduced with the line classpath 'com.google.firebase:perf-plugin:1.4.2'. This addition enhances the build configuration to support the functionalities provided by the Firebase Performance Monitoring tools. Overall, these changes focus on enhancing the application's performance monitoring capabilities without altering existing logic or control flows.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant BuildSystem
    participant Firebase

    Developer->>BuildSystem: Add Firebase Performance plugin
    Developer->>BuildSystem: Add Firebase Performance dependency
    BuildSystem->>Firebase: Integrate Performance Monitoring
    Firebase-->>BuildSystem: Performance Monitoring Enabled
Loading

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
build.gradle (1)

15-15: Consider upgrading to the latest version of the Firebase Performance plugin.

The current version '1.4.2' is outdated. Consider upgrading to the latest version to get important bug fixes and performance improvements.

-        classpath 'com.google.firebase:perf-plugin:1.4.2'
+        classpath 'com.google.firebase:perf-plugin:1.4.2+'
app/build.gradle (1)

103-103: Consider upgrading to the latest version of Firebase Performance.

The current version '21.0.1' is outdated. Consider upgrading to the latest version for better performance and bug fixes.

-    implementation 'com.google.firebase:firebase-perf:21.0.1'
+    implementation 'com.google.firebase:firebase-perf:21.5.0'
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a1947c9 and 0e9f554.

📒 Files selected for processing (2)
  • app/build.gradle (2 hunks)
  • build.gradle (1 hunks)
🔇 Additional comments (2)
app/build.gradle (2)

18-18: LGTM!

The Firebase Performance plugin is correctly applied after other Firebase plugins.


18-18: Monitor the impact on app size.

Firebase Performance Monitoring can increase your app size. Consider:

  1. Monitoring the APK size impact after integration
  2. Using Android Studio's APK Analyzer to compare before/after sizes
  3. Setting up size monitoring in your CI pipeline
  4. Using R8/ProGuard optimization rules specific to Firebase Performance

Also applies to: 103-103

@avazirna avazirna modified the milestones: 2.55, 2.56 Dec 11, 2024
@avazirna
Copy link
Contributor Author

avazirna commented Apr 7, 2025

@damagatchi retest this please

@avazirna avazirna modified the milestones: 2.56, 2.57 Apr 7, 2025
@avazirna
Copy link
Contributor Author

avazirna commented Apr 8, 2025

@damagatchi retest this please

@avazirna
Copy link
Contributor Author

@damagatchi retest this please

@avazirna avazirna changed the title Enable Firebase Performance Monitoring perf monitoring Enable Firebase Performance Monitoring May 22, 2025
@avazirna
Copy link
Contributor Author

@shubham1g5 this is ready for review

Copy link
Contributor

@shubham1g5 shubham1g5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@avazirna What are the next steps on the safety story here ? Has this been verified by you or needs to be done ?


# Set this flag to 'false' to disable @AddTrace annotation processing and automatic monitoring of HTTP/S network
# requests for all build variants at compile time.
firebasePerformanceInstrumentationEnabled=false
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should not this be true ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bit confusing, I had to run tests to understand its impact. This property prevents the instrumentation of the app code (basically, to add code to automatically measure the traces) but doesn't disable the SDK, so some traces are still collected and the manual traces work fine. However, the current issue is with the JaCoCo plugin so I will spend some time tweaking its configuration to see if we can use the SDK in full.

@avazirna avazirna added the skip-integration-tests Skip android tests. label May 29, 2025
@avazirna
Copy link
Contributor Author

@damagatchi retest this please

1 similar comment
@avazirna
Copy link
Contributor Author

@damagatchi retest this please

@avazirna
Copy link
Contributor Author

avazirna commented Jun 1, 2025

@damagatchi retest this please

1 similar comment
@avazirna
Copy link
Contributor Author

avazirna commented Jun 1, 2025

@damagatchi retest this please

@avazirna avazirna removed the skip-integration-tests Skip android tests. label Jun 2, 2025
@avazirna
Copy link
Contributor Author

avazirna commented Jun 2, 2025

@damagatchi retest this please

@avazirna avazirna merged commit adde781 into master Jun 2, 2025
4 of 6 checks passed
@avazirna avazirna deleted the enable-firebase-perf-monitoring branch June 2, 2025 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants