Source context not applied to .dart stack traces

[rodolfoBee]

Environment

SaaS (https://sentry.io/)

Steps to Reproduce

1. Install the Flutter SDK in a Flutter app
2. Upload the .dart source code to Sentry
3. Send a test event to Sentry

Expected Result

The stack trace has source code context added based on the upload files.

Actual Result

Source context is not applied to the event.

The code is not minified and build using ShoreBird.
The stack trace abs_paths is: app:///http/skydart_roster_update.dart:109:7

The uploaded file to the event's release is: ~/http/skydart_roster_update.dart

Files are uploaded using sentry dart plugin:

sentry_dart_plugin: ^2.4.0
sentry:
  project: [redacted]
  org: [redacted]
  auth_token: [redacted]
  upload_source_maps: true
  upload_sources: true

This issue seems to be limited to .dart stack traces. The same process was done with a .js stack trace as test and the uploaded source context was applied to the event.

The issue was originally reported on this internal ticket.

Product Area

Issues - Source Maps

Link

No response

DSN

No response

Version

No response

[getsantry]

Auto-routing to @getsentry/product-owners-issues for triage ⏲️

[buenaflor]

thanks, will have a look 👍

[buenaflor]

@denrase we should check if source context works in Flutter web on non-minified builds

[talas9]

Hi,

I tried changing the event absPath and package:

absPath was changed to all possible values (Flutter package name, iOS package name, Android package name, app://, app:/, ~, "")

nothing worked, then I tried changing package to match the uploaded artifacts, still nothing works!

is there a way I can view the uploaded sources so I can modify the event sent to match the ones in Sentry so the system can match them properly until you fix the issue in the SDK?

Here is my final code:

// Add a prefix to the stack trace
      options.beforeSend = (event, hint) async {
        final exceptions = event.exceptions?.map((exception) {
          final stackTrace = exception.stackTrace;
          if (stackTrace != null) {
            final frames = stackTrace.frames.map((frame) {
              final modifiedAbsPath = frame.absPath?.replaceFirst(
                "package:sky_crews",
                Platform.isIOS
                    ? "[redacted]"
                    : "[redacted]",
              );
              final modifiedPackage = frame.package?.replaceFirst(
                "sky_crew",
                Platform.isIOS
                    ? "[redacted]"
                    : "[redacted]",
              );

              return frame.copyWith(
                absPath: modifiedAbsPath,
                package: modifiedPackage,
              );
            }).toList();
            // Remove frames that has function as "exceptionLog" && fileName as "logger.dart"
            // as this is the logger function and we don't need it in the stack trace
            frames.removeWhere((frame) =>
                frame.function == "exceptionLog" &&
                frame.fileName == "logger.dart");
            return exception.copyWith(
              stackTrace: SentryStackTrace(frames: frames),
            );
          }
          return exception;
        }).toList();
        return event.copyWith(exceptions: exceptions ?? []);
      };

Thanks.

[rodolfoBee]

@buenaflor
I created a simple flutter web project and trigger some errors to my project.

I got a stack trace similar to the one from the affected user:

"abs_path": "http://localhost:49275/main.dart",

After that, I uploaded the file to my project/release: https://dev-curumas.sentry.io/settings/projects/flutter/source-maps/sentrytest%401.0.0%2B1/

New test events do not contain the source context: https://dev-curumas.sentry.io/issues/6285810522/events/95e91fafb6ec46b18da4ec3b1a23d86a/

I did not minify my code. From the quick internal chat it might be a result of the app not using split-debug-info, were you able to confirm this is the root cause?
Reference: getsentry/sentry-dart#1314

[talas9]

@rodolfoBee just to be clear, I tried building with split-debug-info as well.. It didn't help!

[buenaflor]

Would you mind trying out the sentry-dart-plugin 2.1.0? We've done some changes to uploading dart file, not sure if that's related

[talas9]

@buenaflor, Just to confirm.. you want me to downgrade to 2.1.0? currently I'm using sentry_dart_plugin: ^2.4.0

[buenaflor]

yes, just wanna validate that this issue existed before some of our changes

[talas9]

Hi @buenaflor ,

Bellow is my test result with both versions..\

TypeError: type 'Null' is not a subtype of type 'String' in type cast
  #0      _$FCMDataFromJson (package:sky_crew/models/fcm_data.g.dart:19)
  #1      new FCMData.fromJson (package:sky_crew/models/fcm_data.dart:44)
  #2      MyFirebaseMessaging.handleMessage (package:sky_crew/firebase_messaging.dart:61)
  #3      _RootZone.runUnaryGuarded (dart:async/zone.dart:1609)
  #4      _BufferingStreamSubscription._sendData (dart:async/stream_impl.dart:366)
  #5      _DelayedData.perform (dart:async/stream_impl.dart:542)
  #6      _PendingEvents.handleNext (dart:async/stream_impl.dart:647)
  #7      _PendingEvents.schedule.<fn> (dart:async/stream_impl.dart:618)
  #8      _microtaskLoop (dart:async/schedule_microtask.dart:40)
  #9      _startMicrotaskLoop (dart:async/schedule_microtask.dart:49)

for this stack I'm using the command:
flutter packages pub run sentry_dart_plugin [email protected]+9274 --upload-sources

and the output for 2.4.0 is:

PS E:\skyflutter> flutter packages pub run sentry_dart_plugin [email protected]+9274 --upload-sources
Deprecated. Use `dart run` instead.
[❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚] 0% reading config values..        
Searching for pubspec.yaml or sentry.properties config...

Found config from sentry.properties

Sentry CLI binary checksum verification passed successfully (hash: 34878a7f30c3da8861455a2e8a8cfbd5a861649e11fe88432e9b610c83650896).
☑ reading config values
☑ validating config values
[❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚] 18% uploading debug symbols..
> Found 0 debug information files
> No debug information files found

> Found 65 debug information files

> Resolved source code for 0 debug information files

> Prepared debug information files for upload

> Nothing to upload, all files are on the server
☑ uploading debug symbols

Created release [email protected]+9274

uploadSourceMaps is disabled.

+-----------------------+--------------+

| Repository            | Revision     |
+-----------------------+--------------+
| skycrewapp/skyflutter | 8d8fbac9483d |
+-----------------------+--------------+

Finalized release [email protected]+9274

Output for 2.1.0 is:

PS E:\skyflutter> flutter packages pub run sentry_dart_plugin [email protected]+9274 --upload-sources
Deprecated. Use `dart run` instead.
[❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚] 0% reading config values..        
Searching for pubspec.yaml or sentry.properties config...

Found config from sentry.properties

Sentry CLI binary checksum verification passed successfully (hash: 34878a7f30c3da8861455a2e8a8cfbd5a861649e11fe88432e9b610c83650896).
☑ reading config values
☑ validating config values
[❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚❚] 18% uploading debug symbols..
> Found 0 debug information files
> No debug information files found

> Found 65 debug information files

> Resolved source code for 0 debug information files

> Prepared debug information files for upload

> Nothing to upload, all files are on the server
☑ uploading debug symbols

Created release [email protected]+9274

uploadSourceMaps is disabled.

+-----------------------+--------------+

| Repository            | Revision     |
+-----------------------+--------------+
| skycrewapp/skyflutter | 8d8fbac9483d |
+-----------------------+--------------+

Finalized release [email protected]+9274

I don't see any change in output, and context is still not showing in Sentry.

Could you please confirm I'm providing correct release name based on raw stack details provided above?
I tried every combination, but I can't get my hands on how this stack <-> source (context) matching works.

As you can see in the ticket @rodolfoBee was trying to help me and suggested altering the event before sending it to sentry, that didn't work so now I'm trying to change the release name when uploading source to try and match it with the previous stacks.

[rodolfoBee]

Today I realised I made a mistake in my tests: I forgot the "dist" value is automatically added by the SDK. After adding it to my uploaded file, the source code is shown. Here are screenshots (stack trace is the same as before):

You can notice one thing in the uploaded file: it is not marked as "minified". I am using the CLI v2.39.1 to upload a specific file instead of the plugin:

 sentry-cli files upload -p flutter --release "[email protected]+1" --dist 1 lib/main.dart "~/main.dart"   

I remember seeing in one of @talas9 events the same frame format (using http://...). Maybe this helps @buenaflor understand the root cause?

[talas9]

Hi @rodolfoBee,

I tried your solution, it didn't work for me, do I still need to do the beforeSend alteration?

sentry-cli files upload --release "[email protected]+9274" --dist 9274 lib/main.dart "~/main.dart"

I'm checking an existing issue after uploading the sources using previous command on the following stack:

_Exception: Exception: Image upload failed due to loss of GPU access.
  File "<asynchronous suspension>"
  File "<asynchronous suspension>"
  #2      main.<fn>.<fn> (package:sky_crew/main.dart:159)

[buenaflor]

which platforms does this affect? ios, android and web?

[rodolfoBee]

My test is only on web. Talas' event is from iOS from what it seems.

You can try the formats app:///main.dart replacing package:sky_crew with app://

[talas9]

@buenaflor I'm only using iOS and Android for my project.

With the new commands I added seems like it works when I build on CodeMagic, but not for local dev reported events!

I've added a lot of commands so I'm not even sure which one is the one that did the trick, but I will list them:

1- Added --split-debug-info=build/app/outputs/debug-info to Shorebird/Flutter build command
2- I'm uploading sources in CodeMagic under 4 release names (sky_crew, package:sky_crew, co.ucentric.Sky-Crew, co.ucentric.Sky_Crew)
3- I have implement beforeSend option which originally was provided by @rodolfoBee , with some modifications I did on it:

So this is one of the stacktraces that are showing with context now:

Notice how in the previous stack it is showing the path of the file on CodeMagic MacOS, while in my dev env which is windows, this is not working, not sure if this has anything to do with OS but wanted to bring that to your attention as well

I'll be happy to share log files from CodeMagic and commands output with you if you require that.

Thanks.