feat(crashlytics): support custom properties in `recordException(...)` method #825

adrenaline15 · 2025-02-18T16:04:40Z

fixes feat: Extend recordException to provide a possibility to add custom properties per exception and not only globally #824
adds the possibility to add custom properties when recording a non-fatal exception as outlined here:

https://firebase.google.com/docs/crashlytics/customize-crash-reports?platform=android#log-excepts

Pull request checklist

Please check if your PR fulfills the following requirements:

The changes have been tested successfully.
A changeset has been created (npm run changeset).
I have read and followed the pull request guidelines.

* adds the possibility to add custom properties when recording a non-fatal exception as outlined here: > https://firebase.google.com/docs/crashlytics/customize-crash-reports?platform=android#log-excepts

* correct usage of `JSONObject` instead of `JSObject` * testing done

adrenaline15 · 2025-02-18T16:52:12Z

    const stacktrace = await StackTrace.fromError(err);
    await FirebaseCrashlytics.recordException({
      message: '[NOT AN EXCEPTION]',
      stacktrace,
      customProperties: [
        {
          type: 'string',
          key: 'error_name',
          value: err?.name,
        },
        {
          type: 'string',
          key: 'error_message',
          value: err?.message,
        },
        {
          type: 'string',
          key: 'error_type',
          value: err?.type,
        },
        !!err.code && {
          type: 'string',
          key: 'error_code',
          value: err.code,
        },
      ],
    });

robingenz

Please also add iOS support if it's supported by the Firebase iOS SDK since this plugin supports both platforms.

packages/crashlytics/src/definitions.ts

adrenaline15 · 2025-02-18T17:12:10Z

Please also add iOS support if it's supported by the Firebase iOS SDK since this plugin supports both platforms.

actually it looks like its not supported the same way on iOS.. (i also added it to the issue #824)

firebase/firebase-ios-sdk#13153

maybe it could be achieved tho..

https://firebase.google.com/docs/crashlytics/customize-crash-reports?platform=ios#log-excepts

i just feel like it would be all reported as string then? so theoretically not the same.. but i could be wrong here.

adrenaline15 · 2025-02-19T11:47:27Z

to quickly follow-up on this topic for iOS:

looks like the userinfo-way will not work when using a custom error-model = when a stacktrace is provided:

firebase/firebase-ios-sdk#11452 (comment)

that means the only possibility to somehow achieve this would be to set them as global values before and resetting them right after the report.

Crashlytics.crashlytics().setCustomValue("value", forKey: key)
Crashlytics.crashlytics().record(exceptionModel: error)
Crashlytics.crashlytics().setCustomValue(nil, forKey: key)

robingenz · 2025-02-19T12:03:20Z

In this case just ignore the customProperties property if a stacktrace is provided. Make sure to document this in the property description.

adrenaline15 · 2025-02-19T12:21:33Z

sadly that means there is no way to have both then right?

so a stacktrace + custom properties per non-fatal crash

which honestly was my initial motivation, since i wanted to debug keychain-errors for ios^^

robingenz · 2025-02-19T12:38:14Z

sadly that means there is no way to have both then right?

Right. But you could implement the workaround you mentioned here yourself using the plugin API. This does not need to be implemented in the plugin itself.

adrenaline15 · 2025-02-19T12:42:37Z

valid point... seems to be suboptimal either way 🫤

i will try my luck with implementing this then.

robingenz · 2025-02-19T12:58:15Z

Yes, i know. Unfortunately, there is nothing we can do about it. It's a limitation of the iOS SDK. Do you still want to finish the PR?

adrenaline15 · 2025-02-19T13:54:56Z

yes, i think i'm pretty close :)

…ations as outlined in the changeset/readme * updates the definitions, readme and changeset

adrenaline15 · 2025-02-20T13:35:19Z

sorry, needed to finish some work.

i did now implement the iOS-part too, so feel free to have a look and change it accordingly 🙏

actually i forgot that this would not work in the current implementation:

Crashlytics.crashlytics().setCustomValue("value", forKey: key)
Crashlytics.crashlytics().record(exceptionModel: error)
Crashlytics.crashlytics().setCustomValue(nil, forKey: key)

for this there would need to be another method to clear/reset a global value by its key (or provide a dedicated type for it in the setCustomValue-fn)

robingenz · 2025-02-26T10:35:59Z

.changeset/giant-kids-tell.md

+- adds the possibility to add dedicated custom properties when recording a non-fatal exception as outlined here:
+  - https://firebase.google.com/docs/crashlytics/customize-crash-reports?platform=android#log-excepts
+  - https://firebase.google.com/docs/crashlytics/customize-crash-reports?platform=ios#log-excepts
+> Note: on iOS this cannot be combined with `stacktrace` due to [limitations in the ios-sdk](https://github.com/firebase/firebase-ios-sdk/discussions/11452#discussioncomment-6277129).


Suggested change

- adds the possibility to add dedicated custom properties when recording a non-fatal exception as outlined here:

- https://firebase.google.com/docs/crashlytics/customize-crash-reports?platform=android#log-excepts

- https://firebase.google.com/docs/crashlytics/customize-crash-reports?platform=ios#log-excepts

> Note: on iOS this cannot be combined with `stacktrace` due to [limitations in the ios-sdk](https://github.com/firebase/firebase-ios-sdk/discussions/11452#discussioncomment-6277129).

feat: support custom properties in `recordException(...)` method

Please just use a one-liner here.

robingenz · 2025-02-26T10:37:09Z

...rc/main/java/io/capawesome/capacitorjs/plugins/firebase/crashlytics/FirebaseCrashlytics.java

@@ -56,9 +59,67 @@ public void deleteUnsentReports() {
        getFirebaseCrashlyticsInstance().deleteUnsentReports();
    }

-    public void recordException(String message, JSArray stacktrace) {
+    public void recordException(String message, JSArray stacktrace, JSArray customProperties) {


Suggested change

public void recordException(String message, JSArray stacktrace, JSArray customProperties) {

public void recordException(String message, JSArray stacktrace, @Nullable JSArray customProperties) {

Let's add the @Nullable annotation to make it easier to maintain.

...rc/main/java/io/capawesome/capacitorjs/plugins/firebase/crashlytics/FirebaseCrashlytics.java

packages/crashlytics/ios/Plugin/FirebaseCrashlyticsPlugin.swift

robingenz · 2025-02-27T14:00:26Z

@adrenaline15 FYI: I'm releasing a new version of Capacitor Firebase tomorrow. It would be cool if we could include your feature there.

adrenaline15 · 2025-02-27T14:35:38Z

i did now update the MR with the desired changes 🤞

robingenz

Please run npm run fmt to format your code.

> `npm run fmt`

pkg-pr-new · 2025-02-27T14:53:57Z

Open in Stackblitz

@capacitor-firebase/analytics

npm i https://pkg.pr.new/capawesome-team/capacitor-firebase/@capacitor-firebase/analytics@825

@capacitor-firebase/app

npm i https://pkg.pr.new/capawesome-team/capacitor-firebase/@capacitor-firebase/app@825

@capacitor-firebase/app-check

npm i https://pkg.pr.new/capawesome-team/capacitor-firebase/@capacitor-firebase/app-check@825

@capacitor-firebase/authentication

npm i https://pkg.pr.new/capawesome-team/capacitor-firebase/@capacitor-firebase/authentication@825

@capacitor-firebase/crashlytics

npm i https://pkg.pr.new/capawesome-team/capacitor-firebase/@capacitor-firebase/crashlytics@825

@capacitor-firebase/firestore

npm i https://pkg.pr.new/capawesome-team/capacitor-firebase/@capacitor-firebase/firestore@825

@capacitor-firebase/functions

npm i https://pkg.pr.new/capawesome-team/capacitor-firebase/@capacitor-firebase/functions@825

@capacitor-firebase/messaging

npm i https://pkg.pr.new/capawesome-team/capacitor-firebase/@capacitor-firebase/messaging@825

@capacitor-firebase/performance

npm i https://pkg.pr.new/capawesome-team/capacitor-firebase/@capacitor-firebase/performance@825

@capacitor-firebase/remote-config

npm i https://pkg.pr.new/capawesome-team/capacitor-firebase/@capacitor-firebase/remote-config@825

@capacitor-firebase/storage

npm i https://pkg.pr.new/capawesome-team/capacitor-firebase/@capacitor-firebase/storage@825

commit: 41f9ff8

robingenz

Thank you!

robingenz · 2025-02-27T19:48:51Z

@adrenaline15 I just noticed that these custom properties are called keys and values in Crashlytics. I have therefore renamed the option, see #835. Please don't be surprised and thank you for your contribution!

adrenaline15 · 2025-02-27T20:48:24Z

no worries :) thanks for your great contributions to the capacitor-ecosystem <3

gcarpi · 2025-04-04T16:56:21Z

Hi guys, I updated my project to v7.1.0, and it seems there's an error when calling the recordException method without passing the keysAndValues. In v7.0.0, this error didn't occur. I tested it on both Android and iOS, and it seems the error only occurs on Android.

To fix the issue, I had to pass keysAndValues as an empty array, like this:

FirebaseCrashlytics.recordException({ ...options, keysAndValues: []})

robingenz · 2025-04-04T17:10:23Z

This is already fixed and will be published soon: #842

gcarpi · 2025-04-04T17:37:06Z

Thank you @robingenz

adrenaline15 added 2 commits February 18, 2025 16:59

* fixes capawesome-team#824

f5361c6

* adds the possibility to add custom properties when recording a non-fatal exception as outlined here: > https://firebase.google.com/docs/crashlytics/customize-crash-reports?platform=android#log-excepts

* adds the requested changeset

86f9827

adrenaline15 changed the title * fixes #824 feat(crashlytics): Extend recordException to provide a possibility to add custom properties per exception and not only globally Feb 18, 2025

* missing imports

af213da

* correct usage of `JSONObject` instead of `JSObject` * testing done

robingenz requested changes Feb 18, 2025

View reviewed changes

packages/crashlytics/src/definitions.ts Show resolved Hide resolved

* adds the corresponding implementation for iOS too - with some limit…

4350e87

…ations as outlined in the changeset/readme * updates the definitions, readme and changeset

adrenaline15 requested a review from robingenz February 20, 2025 13:35

robingenz requested changes Feb 26, 2025

View reviewed changes

* changes according to the review

393c306

robingenz requested changes Feb 27, 2025

View reviewed changes

* formatting

41f9ff8

> `npm run fmt`

robingenz approved these changes Feb 27, 2025

View reviewed changes

robingenz changed the title ~~feat(crashlytics): Extend recordException to provide a possibility to add custom properties per exception and not only globally~~ feat(crashlytics): support custom properties in recordException(...) method Feb 27, 2025

robingenz merged commit 9d67b1c into capawesome-team:main Feb 27, 2025
4 checks passed

github-actions bot mentioned this pull request Feb 26, 2025

chore(release): publish #816

Merged

robingenz mentioned this pull request Feb 27, 2025

refactor(crashlytics): rename customProperties to keysAndValues #835

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(crashlytics): support custom properties in `recordException(...)` method #825

feat(crashlytics): support custom properties in `recordException(...)` method #825

adrenaline15 commented Feb 18, 2025 •

edited

Loading

adrenaline15 commented Feb 18, 2025

robingenz left a comment

adrenaline15 commented Feb 18, 2025 •

edited

Loading

adrenaline15 commented Feb 19, 2025

robingenz commented Feb 19, 2025

adrenaline15 commented Feb 19, 2025

robingenz commented Feb 19, 2025

adrenaline15 commented Feb 19, 2025

robingenz commented Feb 19, 2025

adrenaline15 commented Feb 19, 2025

adrenaline15 commented Feb 20, 2025

robingenz Feb 26, 2025

robingenz Feb 26, 2025

robingenz commented Feb 27, 2025

adrenaline15 commented Feb 27, 2025

robingenz left a comment

pkg-pr-new bot commented Feb 27, 2025

robingenz left a comment

robingenz commented Feb 27, 2025

adrenaline15 commented Feb 27, 2025 •

edited

Loading

gcarpi commented Apr 4, 2025 •

edited

Loading

robingenz commented Apr 4, 2025

gcarpi commented Apr 4, 2025

	public void recordException(String message, JSArray stacktrace, JSArray customProperties) {
	public void recordException(String message, JSArray stacktrace, @Nullable JSArray customProperties) {

feat(crashlytics): support custom properties in recordException(...) method #825

feat(crashlytics): support custom properties in recordException(...) method #825

Conversation

adrenaline15 commented Feb 18, 2025 • edited Loading

Pull request checklist

adrenaline15 commented Feb 18, 2025

robingenz left a comment

Choose a reason for hiding this comment

adrenaline15 commented Feb 18, 2025 • edited Loading

adrenaline15 commented Feb 19, 2025

robingenz commented Feb 19, 2025

adrenaline15 commented Feb 19, 2025

robingenz commented Feb 19, 2025

adrenaline15 commented Feb 19, 2025

robingenz commented Feb 19, 2025

adrenaline15 commented Feb 19, 2025

adrenaline15 commented Feb 20, 2025

robingenz Feb 26, 2025

Choose a reason for hiding this comment

robingenz Feb 26, 2025

Choose a reason for hiding this comment

robingenz commented Feb 27, 2025

adrenaline15 commented Feb 27, 2025

robingenz left a comment

Choose a reason for hiding this comment

pkg-pr-new bot commented Feb 27, 2025

robingenz left a comment

Choose a reason for hiding this comment

robingenz commented Feb 27, 2025

adrenaline15 commented Feb 27, 2025 • edited Loading

gcarpi commented Apr 4, 2025 • edited Loading

robingenz commented Apr 4, 2025

gcarpi commented Apr 4, 2025

feat(crashlytics): support custom properties in `recordException(...)` method #825

feat(crashlytics): support custom properties in `recordException(...)` method #825

adrenaline15 commented Feb 18, 2025 •

edited

Loading

adrenaline15 commented Feb 18, 2025 •

edited

Loading

adrenaline15 commented Feb 27, 2025 •

edited

Loading

gcarpi commented Apr 4, 2025 •

edited

Loading