Support source code context

[marandaneto]

Description

iOS:
By default, source code context isn't uploaded if using sentry-cli upload-dsym.
Docs: https://docs.sentry.io/platforms/apple/guides/ios/dsym/

If this works on iOS, we need to patch the docs to use upload-dif with --include-sources
We likely need to patch https://github.com/getsentry/sentry-fastlane-plugin/ to support this flag too.

include-sources should be opt-in similar on Android.
https://docs.sentry.io/platforms/android/gradle/
See uploadNativeSymbols

Java/Android

Beta Give feedback

1. Java Source Context sentry-java#633
   Effort: Large Impact: Large Platform: Java enhancement +4
   
2. Source Context for Java sentry-android-gradle-plugin#495
   +0

iOS

Beta Give feedback

1. ci: Enable source context for TestFlight sentry-cocoa#2570
   +0

React Native

Beta Give feedback

1. Replace deprecated upload-dsym for RN-iOS and add support for the new one sentry-wizard#181
   Platform: React-Native Status: Backlog +2
2. Support source code context for iOS, requires include-sources option sentry-react-native#2748
   Effort: Small Impact: Small Platform: React-Native Status: Backlog iOS +5

Dart/Flutter

Beta Give feedback

1. https://github.com/getsentry/sentry-dart-plugin
2. Support Source Context sentry-dart#132
   Effort: Large Impact: Medium Platform: Dart enhancement product +5
   

.NET

Beta Give feedback

1. Support for Source Context sentry-dotnet#646
   Effort: Large Feature Impact: Large Platform: .NET +4
2. Missing source context with MAUI apps sentry-dotnet#2177
   Android Bug MAUI Platform: .NET +4
   

---

Other relevant items

Related Project: Source Context Adoption

Not part of the initial roadmap, tbd if/when these are tackled:

• Creating bundle sources with difutil not working for xcarchive sentry-cli#1425
• Source Context support if not using split-debug-info sentry-dart#1314

[marandaneto]

@brustolin is going to check if Sentry-CLI is able to upload source code context for iOS, if it works, we'd add to the other plugins as well.

[marandaneto]

@brustolin is going to check if Sentry-CLI is able to upload source code context for iOS, if it works, we'd add to the other plugins as well.

@philipphofmann or @brustolin any updates on this?

[brustolin]

According to Kamil Sentry-CLI is able to upload source code context.
https://docs.sentry.io/platforms/apple/guides/ios/data-management/debug-files/source-context/

[marandaneto]

Source code context does not work for iOS when using upload-dif and --include-sources, its either a limitation of Sentry itself, or there's a bug if it should have worked OOTB.
@kamilogorek do you know which team is responsible for that? Apparently, the CLI did its job, I saw plenty of uploaded symbols with the feature sources.

[kamilogorek]

Do we have an example where it doesn't work? Can we get debug logs for it?
Asking, as if we do upload sources, then we should see that explicitly mentioned in the logs.

[marandaneto]

Do we have an example where it doesn't work? Can we get debug logs for it? Asking, as if we do upload sources, then we should see that explicitly mentioned in the logs.

I'll let @philipphofmann or @brustolin handle this since this is iOS.

[philipphofmann]

@kamilogorek, I have information from a customer that I can't share here, but you can have a look on Notion.

[eric]

It was working when I was releasing to Apple with bitcode, downloading the symbols and re-uploading those to Sentry. Now that we are no longer compiling with bitcode and uploading symbols directly, it no longer displays the source context.

[philipphofmann]

@kamilogorek, see the reply from @eric. I think it could be related.

[eric]

Has there been any progress on uploading source for iOS/tvOS?

[philipphofmann]

@eric, sorry for the late reply. I tried source context with our sample iOS app by adding the include_sources to sentry_upload_dif in Fastlane and also with sentry-cli by using --include-sources, and both worked. I think the docs are a bit misleading, and I will fix them. Creating a source bundle doesn't work for iOS, you have to use --include-sources when uploading the dSYMs.

[eric]

@philipphofmann I'm confused why the documentation on the website still says to use sentry_upload_dsym under the Without Bitcode section.

When we moved away from uploading Bitcode to Apple (because it is deprecated) it appears we moved from using sentry_upload_dif to using sentry_upload_dsym because that's what the documentation said to do.

Can we still use sentry_upload_dif without Bitcode? Can we use it without downloading the dSYMs from Apple?

I guess that's the reason why Sentry stopped giving us source context in September. We followed the instructions and haven't had them ever since.

[philipphofmann]

Creating source bundles for xcarchives is not working; see getsentry/sentry-cli#1425

[philipphofmann]

@eric, please use sentry_upload_dif and add include_sources: true. Then it should work. I'm going to update the docs.

[philipphofmann]

Docs PR getsentry/sentry-docs#6015

[marandaneto]

Relates to getsentry/sentry-docs#6553 as well