feat(crashlytics): Extend recordException to provide a possibility to add custom properties per exception and not only globally

[adrenaline15]

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

[adrenaline15]

    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.

[adrenaline15]

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]

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]

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

[adrenaline15]

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]

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]

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

i will try my luck with implementing this then.

[robingenz]

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]

yes, i think i'm pretty close :)

[adrenaline15]

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)