Dart sdk missing full (absolute) file path to define ownership rules

[lukesterlee]

Platform:

• Dart
• Flutter Android or iOS
• Flutter Web

IDE:

• VSCode
• IntelliJ/AS
• XCode
• Other, which one?

split-debug-info and obfuscate (Flutter Android or iOS) or CanvasKit (Flutter Web):

• Enabled
• Disabled

Platform installed with:

• pub.dev
• GitHub

Output of the command flutter doctor -v below:

[✓] Flutter (Channel unknown, 1.22.5, on Mac OS X 10.15.7 19H524 darwin-x64, locale en)
• Flutter version 1.22.5 at /Users/lukelee/fvm/versions/1.22.5
• Framework revision 7891006299 (3 months ago), 2020-12-10 11:54:40 -0800
• Engine revision ae90085a84
• Dart version 2.10.4

[✓] Android toolchain - develop for Android devices (Android SDK version 30.0.0-rc1)
• Android SDK at /Users/lukelee/Library/Android/sdk
• Platform android-30, build-tools 30.0.0-rc1
• Java binary at: /Applications/Android Studio.app/Contents/jre/jdk/Contents/Home/bin/java
• Java version OpenJDK Runtime Environment (build 1.8.0_212-release-1586-b4-5784211)
• All Android licenses accepted.

[✓] Xcode - develop for iOS and macOS (Xcode 12.4)
• Xcode at /Applications/Xcode.app/Contents/Developer
• Xcode 12.4, Build version 12D4e
• CocoaPods version 1.10.0

[✓] Android Studio (version 3.6)
• Android Studio at /Applications/Android Studio.app/Contents
• Flutter plugin version 45.1.1
• Dart plugin version 192.8052
• Java version OpenJDK Runtime Environment (build 1.8.0_212-release-1586-b4-5784211)

[✓] Connected device (2 available)
• Android SDK built for x86 64 (mobile) • emulator-5554 • android-x64 • Android 10 (API 29)
(emulator)
• macOS (desktop) • macos • darwin-x64 • Mac OS X 10.15.7 19H524
darwin-x64

• No issues found!
The version of the SDK (See pubspec.lock):
4.0.4

---

I have the following issue:

Dart sdk is missing a full (absolute) file path to define ownership rules.
The data is included in JSON files as abs_filepath but the path is not popping up in the ownership rules section.

Steps to reproduce:

• Step 1: trigger an exception in a flutter app.
• Step 2: go to sentry and find the exception you triggered.
• Step 3: click Create Ownership Rule on the right panel.
• Step 4: the full absolute file path is not popping up so you can't utilize the ownership rule feature to define the paths to assign to a specific team.

Actual result:
When we use flutter sdk, we don't get the full path.

• Actual

Expected result:
When we log to Android SDK via method channel, we get this full path.

• Result

[marandaneto]

@lukesterlee thanks for reporting this, the reason is:

https://github.com/getsentry/sentry-dart/blob/main/dart/lib/src/sentry_stack_trace_factory.dart#L127-L143

does it mean that using the Flutter SDK works but the pure Dart SDK does not?

eg:
file:///Users/myuser/Github/sentry-dart/dart/example/main.dart so we have PII here but there's also no easy way to know when the project actually starts which would be sentry-dart.
Ideas on how to do it?

I was not aware this would affect ownership rules, good catch

[marandaneto]

I can confirm that, Flutter SDK would return package:sentry_flutter_example/main.dart instead of the file absolute path.

the problem is, for a Dart App, the frame.uri.scheme is actually a file scheme and we need to filter that :( not sure how we can go around this.

@bruno-garcia ideas?

[marandaneto]

I only see a way if filtering frame.uri.pathSegments but we'd need to know where to start discarding PII info

[ueman]

I would guess splitting at the lib folder would be a good starting point as practically every Dart programm uses it.
There would be of course some problems if there are more than one lib folder.

[marandaneto]

yep @ueman that's one of my thoughts, for scripting it'd not work though, but I guess heuristics would be the way to go, or, Dart offering a proper relative path property.
The other way would be getting the user's folder from the OS and substring from there, it'd not avoid PII entirely though.

[ueman]

There is also https://api.dart.dev/stable/2.12.1/dart-io/Platform-class.html which should help in some cases. I'm pretty sure it doesn't work with Flutter, I would have to double check that however.

[marandaneto]

There is also https://api.dart.dev/stable/2.12.1/dart-io/Platform-class.html which should help in some cases. I'm pretty sure it doesn't work with Flutter, I would have to double check that however.

still returns /Users/myuser/Github/sentry-dart/dart/example/main.dart but yeah I've not googled it yet, might have a reliable workaround somewhere hidden in the Webs :D

[lukesterlee]

@marandaneto I'm sorry for the confusion, I meant we do get the right data in both android sdk and flutter sdk but flutter sdk does not know how to parse the data in the ownership rules section since they are parsing filename instead of abs_path.

This is from our JSON raw payload:

{
"function":"CheckingCardService.lock",
"package":"betterment_flutter",
"filename":"checking_card_service.dart",
"abs_path":"package:betterment_flutter/features/checking/manage_account/services/checking_card_service.dart",
"lineno":39,
"colno":7,
"in_app":true
}

As you can see in the previous screenshots, it seems like android sdk's ownership rules parse abs_path while flutter sdk's ownership rules parse filename. I think there is no problem with sdk, we just have a problem with pulling the right attribute in ownership rules section on the web?

by the way, thanks for the quick response! I really appreciate it. 🙌

[marandaneto]

@lukesterlee thanks for your reply.

I am a bit lost here.

The data is included in JSON files as abs_filepath but the path is not popping up in the ownership rules section.

this is indeed an issue (Sentry Dart SDK), but unless we use some heuristics, there's no native way to get proper absolute paths without risking PII.

the Sentry Flutter SDK though gets proper absolute file paths, as the tooling doesn't include PII so we send it as it is, so it's all good afaik.

When we log to Android SDK via method channel, we get this full path.

what do you mean by Android SDK? are you talking about the Sentry Flutter SDK or Native SDKs (Java/Kotlin and Swift/ObjC events)? Please review your description so we can get a better understanding :)

[samandmoore]

(i work with @lukesterlee)

this is indeed an issue (Sentry Dart SDK), but unless we use some heuristics, there's no native way to get proper absolute paths without risking PII.

@marandaneto would it be possible to introduce something like inAppIncludes to identify the root of the app within the file system?

sentry-dart/dart/lib/src/sentry_options.dart

Line 123 in ae21d7e

List<String> get inAppIncludes => List.unmodifiable(_inAppIncludes);

with something like that, it would be possible to trim all path segments before that one and call that the absolute path, right?

edit: and i think that logic would only want to be applied to files whose scheme is file: right?

[samandmoore]

@lukesterlee thanks for reporting this, the reason is:

https://github.com/getsentry/sentry-dart/blob/main/dart/lib/src/sentry_stack_trace_factory.dart#L127-L143

does it mean that using the Flutter SDK works but the pure Dart SDK does not?

@marandaneto another question, just for clarification, i'm not quite understanding how this code is converting package:betterment_flutter/something.dart into something.dart. i'd expect that since the scheme is package it would not be stripping the path down to just the filename. can you explain why that's happening?

[marandaneto]

(i work with @lukesterlee)

this is indeed an issue (Sentry Dart SDK), but unless we use some heuristics, there's no native way to get proper absolute paths without risking PII.

@marandaneto would it be possible to introduce something like inAppIncludes to identify the root of the app within the file system?

sentry-dart/dart/lib/src/sentry_options.dart

Line 123 in ae21d7e

List<String> get inAppIncludes => List.unmodifiable(_inAppIncludes);

with something like that, it would be possible to trim all path segments before that one and call that the absolute path, right?

not sure how that would work as the dir. path would be dynamic depending on the user's folder etc.

edit: and i think that logic would only want to be applied to files whose scheme is file: right?

yes, only to file, when its package or something else, the absolute path is already fine