[firebase_crashlytics]: Android reports the APK's libapp.so build ID for Dart code-push (Shorebird) patches, so their crashes use the wrong symbols

Open
#18,951 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
android, dart, firebase

Research direction

Start by reading FlutterFirebaseCrashlyticsPlugin.recordError and ElfBuildIdReader in the Android Crashlytics plugin, then trace how the Dart VM snapshot build ID is obtained from the stack trace. Check the existing Android Crashlytics tests for build ID selection. Done when an opt-in lets Dart errors report the running Dart code's build ID and tests cover both the default ELF ID and the opt-in behavior.

Written by the indexing model from the issue text.

Description

Needs Attention platform: android plugin: crashlytics type: enhancement
Is there an existing issue for this?
  • I have searched the existing issues.
Which plugins are affected?

Crashlytics

Which platforms are affected?

Android

Description

When an app uses a Dart code-push tool such as Shorebird, Crashlytics symbolicates Dart crashes from a patch with the original release's symbols, so the stack trace shows unrelated functions with no warning.

A Shorebird patch is a full recompile of the app's Dart. It is downloaded at runtime and loaded instead of the libapp.so in the installed APK, which stays the release's. On Android, FlutterFirebaseCrashlyticsPlugin.recordError picks the build ID like this:

// Prefer the ELF build ID from libapp.so over the Dart VM's snapshot build ID.
// The firebase-crashlytics-buildtools JAR uses the ELF build ID when uploading symbols,
// so we must report the same ID for Crashlytics to match them.
val effectiveBuildId = elfBuildId ?: dartBuildId

elfBuildId is read by ElfBuildIdReader from the APK's libapp.so, so for a patched app it is always the release's build ID, even though the code that crashed came from the patch. Uploading the patch's symbols with firebase crashlytics:symbols:upload doesn't help, because the event never carries the patch's build ID. Every frame from a patch is decoded against the wrong symbol file, including frames from code the patch didn't change, since a recompile moves it.

Expected: a way to have the event carry the build ID of the Dart code that is actually running, so the patch's uploaded symbols are used.

Actual: the event always carries the APK's libapp.so build ID.

I understand why the ELF ID is preferred by default, so I'm not asking to change the default. An opt-in would be enough, for example:

  • an option to prefer the Dart VM's snapshot build ID (dartBuildId, from the stack trace's build_id: line) over the ELF one, or
  • an API to set the build ID reported with Dart errors, which an app could set from its code-push SDK when a patch is running.
Reproducing the issue
  1. Create a Shorebird release of an Android app with firebase_crashlytics, built with --obfuscate --split-debug-info, and upload its symbols to Crashlytics.
  2. Publish a Shorebird patch whose new code throws, e.g. throw StateError('patch crash test') from a new function called on a button tap.
  3. Install the release, restart it twice so the patch is running, and trigger the error.
  4. In Crashlytics, the event's plain-text stack trace shows the release's BuildId (it matches libapp.so pulled from the device, not the patch's symbol file), and the function names come from the release, e.g. the new throwing function appears as an unrelated existing method.
  5. Passing the same pc offsets to llvm-symbolizer with the patch's symbol file gives the correct trace, with the throwing function on top.
Firebase Core version

4.15.0 (firebase_crashlytics 5.4.0)

Flutter Version

3.47.7 (Shorebird's Flutter fork, Shorebird CLI 1.6.134)

Relevant Log Output

No response

Flutter dependencies

No response

Additional context and comments

iOS has a related gap, but that one isn't in the plugin: Crashlytics only symbolicates iOS Dart frames through dSYMs, and a Shorebird patch has no dSYM, so patched iOS frames stay as raw abs … virt … lines. I'll raise that through Firebase Support.

Dominant language
Dart
Stars
9.3k
Forks
4.1k
Avg merge
2d 10h
Merged PRs (30d)
78

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from firebase/flutterfire

All issues in firebase/flutterfire

Similar issues

More Dart issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.