Add an overload to FirebaseCrashlytics.recordException to attach additional custom key value pairs #6528

tejasd · 2024-11-20T22:21:30Z

This PR adds a method public void recordException(@NonNull Throwable throwable, Map<String, String> userInfo) as an overload to the existing recordException method in Crashlytics to allow attaching additional custom keys to the specific event. This restores parity w/ the behaviour on iOS.

Details:

The key value pairs passed through this method override the global custom keys (if there are any duplicates)

Additionally:

Creates a new EventMetadata class to represent sessionId and timestamp attached to non fatal events.

…Exception

github-actions · 2024-11-20T22:21:45Z

Javadoc Changes:

--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html	2024-11-21 17:15:37.090331321 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html	2024-11-21 17:13:08.626606418 +0000
@@ -79,6 +79,13 @@
           <tr>
             <td><code>void</code></td>
             <td>
+              <div><code><a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#recordException(java.lang.Throwable,java.util.Map&lt;java.lang.String,java.lang.String&gt;)">recordException</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Throwable.html">Throwable</a>&nbsp;throwable,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/Map.html">Map</a>&lt;<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>,&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&gt;&nbsp;userInfo<br>)</code></div>
+              <p>Records a non-fatal report to send to Crashlytics.</p>
+            </td>
+          </tr>
+          <tr>
+            <td><code>void</code></td>
+            <td>
               <div><code><a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#sendUnsentReports()">sendUnsentReports</a>()</code></div>
               <p>If automatic data collection is disabled, this method queues up all the reports on a device to send to Crashlytics.</p>
             </td>
@@ -333,6 +340,38 @@
                 </td>
               </tr>
             </tbody>
+          </table>
+        </div>
+      </div>
+      <div class="api-item"><a name="recordException(java.lang.Throwable, java.util.Map&lt;java.lang.String,java.lang.String&gt;)"></a><a name="recordException-java.lang.Throwable-java.util.Map&lt;java.lang.String,java.lang.String&gt;-"></a><a name="recordexception"></a>
+        <h3 class="api-name" id="recordException(java.lang.Throwable,java.util.Map&lt;java.lang.String,java.lang.String&gt;)">recordException</h3>
+        <pre class="api-signature no-pretty-print">public&nbsp;void&nbsp;<a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#recordException(java.lang.Throwable,java.util.Map&lt;java.lang.String,java.lang.String&gt;)">recordException</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Throwable.html">Throwable</a>&nbsp;throwable,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/Map.html">Map</a>&lt;<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>,&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&gt;&nbsp;userInfo<br>)</pre>
+        <p>Records a non-fatal report to send to Crashlytics.</p>
+        <div class="devsite-table-wrapper">
+          <table class="responsive">
+            <colgroup>
+              <col width="40%">
+              <col>
+            </colgroup>
+            <thead>
+              <tr>
+                <th colspan="100%">Parameters</th>
+              </tr>
+            </thead>
+            <tbody class="list">
+              <tr>
+                <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Throwable.html">Throwable</a>&nbsp;throwable</code></td>
+                <td>
+                  <p>a <code><a href="https://developer.android.com/reference/kotlin/java/lang/Throwable.html">Throwable</a></code> to be recorded as a non-fatal event.</p>
+                </td>
+              </tr>
+              <tr>
+                <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/Map.html">Map</a>&lt;<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>,&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&gt;&nbsp;userInfo</code></td>
+                <td>
+                  <p>a <code><a href="https://developer.android.com/reference/kotlin/java/util/Map.html">Map</a></code> to add key value pairs to be recorded with the non fatal exception.</p>
+                </td>
+              </tr>
+            </tbody>
           </table>
         </div>
       </div>

--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html	2024-11-21 17:15:37.090331321 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html	2024-11-21 17:13:08.610606448 +0000
@@ -79,6 +79,13 @@
           <tr>
             <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></code></td>
             <td>
+              <div><code><a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#recordException(java.lang.Throwable,java.util.Map&lt;java.lang.String,java.lang.String&gt;)">recordException</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;throwable:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;userInfo:&nbsp;(<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html">Mutable</a>)<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>!,&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>!&gt;<br>)</code></div>
+              <p>Records a non-fatal report to send to Crashlytics.</p>
+            </td>
+          </tr>
+          <tr>
+            <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></code></td>
+            <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#sendUnsentReports()">sendUnsentReports</a>()</code></div>
               <p>If automatic data collection is disabled, this method queues up all the reports on a device to send to Crashlytics.</p>
             </td>
@@ -333,6 +340,38 @@
                 </td>
               </tr>
             </tbody>
+          </table>
+        </div>
+      </div>
+      <div class="api-item"><a name="recordException(java.lang.Throwable, java.util.Map&lt;java.lang.String,java.lang.String&gt;)"></a><a name="recordException-java.lang.Throwable-java.util.Map&lt;java.lang.String,java.lang.String&gt;-"></a><a name="recordexception"></a>
+        <h3 class="api-name" id="recordException(java.lang.Throwable,java.util.Map&lt;java.lang.String,java.lang.String&gt;)">recordException</h3>
+        <pre class="api-signature no-pretty-print">fun&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#recordException(java.lang.Throwable,java.util.Map&lt;java.lang.String,java.lang.String&gt;)">recordException</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;throwable:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;userInfo:&nbsp;(<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html">Mutable</a>)<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>!,&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>!&gt;<br>):&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></pre>
+        <p>Records a non-fatal report to send to Crashlytics.</p>
+        <div class="devsite-table-wrapper">
+          <table class="responsive">
+            <colgroup>
+              <col width="40%">
+              <col>
+            </colgroup>
+            <thead>
+              <tr>
+                <th colspan="100%">Parameters</th>
+              </tr>
+            </thead>
+            <tbody class="list">
+              <tr>
+                <td><code>throwable:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a></code></td>
+                <td>
+                  <p>a <code><a href="https://developer.android.com/reference/kotlin/java/lang/Throwable.html">Throwable</a></code> to be recorded as a non-fatal event.</p>
+                </td>
+              </tr>
+              <tr>
+                <td><code>userInfo:&nbsp;(<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html">Mutable</a>)<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>!,&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>!&gt;</code></td>
+                <td>
+                  <p>a <code><a href="https://developer.android.com/reference/kotlin/java/util/Map.html">Map</a></code> to add key value pairs to be recorded with the non fatal exception.</p>
+                </td>
+              </tr>
+            </tbody>
           </table>
         </div>
       </div>

github-actions · 2024-11-20T22:21:47Z

Vertex AI Mock Responses Check ⚠️

A newer major version of the mock responses for Vertex AI unit tests is available. update_responses.sh should be updated to clone the latest version of the responses: v5.2

google-oss-bot · 2024-11-20T22:25:23Z

Coverage Report ¹

Affected Products

firebase-crashlytics
Overall coverage changed from 11.59% (6a03d4c) to 11.63% (b66b8ff) by +0.04%.
Filename Base (6a03d4c) Merge (b66b8ff) Diff
CrashlyticsController.java 18.57% 18.52% -0.05%
EventMetadata.kt ? 0.00% ?
SessionReportingCoordinator.java 42.20% 43.09% +0.90%

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/EZASBzRHTG.html

google-oss-bot · 2024-11-20T22:28:11Z

The public api surface has changed for the subproject firebase-crashlytics:
error: Added method com.google.firebase.crashlytics.FirebaseCrashlytics.recordException(Throwable,java.util.Map<java.lang.String,java.lang.String>) [AddedMethod]

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

github-actions · 2024-11-20T22:30:23Z

Test Results

8 files - 1 028 8 suites - 1 028 25s ⏱️ - 36m 12s
22 tests - 5 851 22 ✅ - 5 829 0 💤 - 22 0 ❌ ±0
44 runs - 11 787 44 ✅ - 11 743 0 💤 - 44 0 ❌ ±0

Results for commit 1b5f09e. ± Comparison against base commit 6a03d4c.

This pull request removes 5851 tests.

com.google.android.datatransport.cct.CctBackendFactoryTest ‑ create_returnCCTBackend_WhenBackendNameIsCCT
com.google.android.datatransport.cct.CctDestinationTest ‑ cctDestination_shouldOnlySupportProtoAndJson
com.google.android.datatransport.cct.CctDestinationTest ‑ cctDestination_shouldSupportProtoAndJson
com.google.android.datatransport.cct.CctTransportBackendTest ‑ decorate_whenOffline_shouldProperlyPopulateNetworkInfo
com.google.android.datatransport.cct.CctTransportBackendTest ‑ decorate_whenOnline_shouldProperlyPopulateNetworkInfo
com.google.android.datatransport.cct.CctTransportBackendTest ‑ schedule_shouldAddCookieOnPseudonymousIds
com.google.android.datatransport.cct.CctTransportBackendTest ‑ schedule_shouldDropCookieOnMixedPseudonymousIds
com.google.android.datatransport.cct.CctTransportBackendTest ‑ send_CompressedResponseIsUncompressed
com.google.android.datatransport.cct.CctTransportBackendTest ‑ send_whenBackendRedirectsMoreThan5Times_shouldOnlyRedirect4Times
com.google.android.datatransport.cct.CctTransportBackendTest ‑ send_whenBackendRedirects_shouldCorrectlyFollowTheRedirectViaPost
…

♻️ This comment has been updated with latest results.

google-oss-bot · 2024-11-20T22:30:57Z

Size Report ¹

Affected Products

firebase-crashlytics
Type Base (6a03d4c) Merge (b66b8ff) Diff
aar 411 kB 413 kB +2.40 kB (+0.6%)
apk (aggressive) 698 kB 698 kB +52 B (+0.0%)
apk (release) 5.85 MB 5.85 MB +2.38 kB (+0.0%)

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/YMD3VxSdQR.html

google-oss-bot · 2024-11-21T14:43:40Z

The public api surface has changed for the subproject firebase-crashlytics:
error: Added method com.google.firebase.crashlytics.FirebaseCrashlytics.recordException(Throwable,java.util.Map<java.lang.String,java.lang.String>) [AddedMethod]

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

google-oss-bot · 2024-11-21T14:47:37Z

The public api surface has changed for the subproject firebase-crashlytics:
error: Added method com.google.firebase.crashlytics.FirebaseCrashlytics.recordException(Throwable,java.util.Map<java.lang.String,java.lang.String>) [AddedMethod]

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

Initial implementation of recording a custom key value pair in record…

71fff26

…Exception

google-oss-bot added the size/M label Nov 20, 2024

Fix unit tests affected by EventMetadata

981a51e

google-oss-bot added size/L and removed size/M labels Nov 21, 2024

Add copyright header to EventMetadata

81fd3fa

tejasd added 5 commits November 21, 2024 10:01

Update api.txt file

2e39254

Add a JvmOverload in EventMetadata to use the default value for userInfo

f6196e2

Add a unit test to verify the behavior of userInfo keys

38a4a26

Update documentation of EventMetadata

7c422bb

Remove TODO

9f99b44

tejasd changed the title ~~Initial implementation of recording a custom key value pair in recordExcpetion.~~ Add an overload to FirebaseCrashlytics.recordException to attach additional custom key value pairs Nov 21, 2024

tejasd added 3 commits November 21, 2024 11:39

Additional documentation for EventMetadata

bb3aae2

Add details to CHANGELOG

c02234e

Merge branch 'main' into td/record-exception

1b5f09e

tejasd mentioned this pull request Nov 21, 2024

Add examples to use the new recordException overload. firebase/snippets-android#596

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add an overload to FirebaseCrashlytics.recordException to attach additional custom key value pairs #6528

Add an overload to FirebaseCrashlytics.recordException to attach additional custom key value pairs #6528

tejasd commented Nov 20, 2024 •

edited

Loading

github-actions bot commented Nov 20, 2024 •

edited

Loading

github-actions bot commented Nov 20, 2024

google-oss-bot commented Nov 20, 2024 •

edited

Loading

`firebase-crashlytics`

google-oss-bot commented Nov 20, 2024

github-actions bot commented Nov 20, 2024 •

edited

Loading

google-oss-bot commented Nov 20, 2024 •

edited

Loading

`firebase-crashlytics`

google-oss-bot commented Nov 21, 2024

google-oss-bot commented Nov 21, 2024

Add an overload to FirebaseCrashlytics.recordException to attach additional custom key value pairs #6528

Are you sure you want to change the base?

Add an overload to FirebaseCrashlytics.recordException to attach additional custom key value pairs #6528

Conversation

tejasd commented Nov 20, 2024 • edited Loading

github-actions bot commented Nov 20, 2024 • edited Loading

github-actions bot commented Nov 20, 2024

Vertex AI Mock Responses Check ⚠️

google-oss-bot commented Nov 20, 2024 • edited Loading

Coverage Report 1

Affected Products

firebase-crashlytics

Test Logs

google-oss-bot commented Nov 20, 2024

github-actions bot commented Nov 20, 2024 • edited Loading

Test Results

google-oss-bot commented Nov 20, 2024 • edited Loading

Size Report 1

Affected Products

firebase-crashlytics

Test Logs

google-oss-bot commented Nov 21, 2024

google-oss-bot commented Nov 21, 2024

tejasd commented Nov 20, 2024 •

edited

Loading

github-actions bot commented Nov 20, 2024 •

edited

Loading

google-oss-bot commented Nov 20, 2024 •

edited

Loading

Coverage Report ¹

`firebase-crashlytics`

github-actions bot commented Nov 20, 2024 •

edited

Loading

google-oss-bot commented Nov 20, 2024 •

edited

Loading

Size Report ¹

`firebase-crashlytics`