Bugfix: add-sample-rate-native

[JulianBissekkou]

📜 Description

During development I discovered that the sample rate is not correctly forwarded to the native sdks.

💡 Motivation and Context

This PR makes sure that initialization of the native sdks also uses the configured sampleRate and traceSampleRate from the FlutterSentryOptions.

💚 How did you test it?

I tested this by setting a breakpoint and ensuring that my configuration was applied to the native options. If there is a better way, let me know :)

📝 Checklist

• I reviewed submitted code
• I added tests to verify changes
• No new PII added or SDK only sends newly added PII if sendDefaultPii is enabled
• I updated the docs if needed
• All tests passing
• No breaking changes

🔮 Next steps

[JulianBissekkou]

I checked "No breaking changes" since I think this is not breaking. However, the sdk might behave differently but I would say its no the correct expected behavior.

[buenaflor]

hey, do you use the native sdk alongside the flutter sdk?

[buenaflor]

I'm trying to find the context as to why this was not added before. It's hard to imagine that this was just an oversight but it could be.

[buenaflor]

Example: our react native SDK also doesn't set the sample rates during init: https://github.com/getsentry/sentry-react-native/blob/979a258538e6b140d912f7d74b89f684c504b67f/android/src/main/java/io/sentry/react/RNSentryModuleImpl.java#L182

[JulianBissekkou]

@buenaflor
I am only using the flutter sdk and my application is running on android and iOS and I was curious how the implementation of the initialization is done and then I also found that some of the properties where not parsed.

I was also suprised, but my assumption was that nobody found this since most react native and flutter developers are interested in the errors that are thrown in the TS or Dart code and the native exceptions are very rare.
The missing change in the sampleRate is therefore nothing that most people would directly notice since it doesn't affect many events.

I wasn't sure if there is some kind of magic initialization that I was missing so take your time with reviewing this.
Looking forward hearing from you :)

[buenaflor]

After some discussion I don't think this should be added since there's the possibility of double instrumentation since the native sdks themselves have instrumentation for certain integrations. For example the cocoa sdk has all these automatic instrumentation which might result in duplicate data being sent.

In terms of feature set and design we also want to keep our hybrid sdks as consistent as possible to one another.

So adding this change brings a lot of implications and is actually a rather big decision.

[JulianBissekkou]

@buenaflor
Can you explain why we get duplicate instrumentation? We are only updating configuration parameters of the iOS sdks. This can also be done by developers that are using the native iOS integration. The flutter/dart sdk will only provide data to sentry for the dart specific part.

[buenaflor]

@JulianBissekkou if we pass tracesSampleRate as well then we would get duplicate appstart performance transactions, one implemented in native ios/android and one implemented in flutter. Just one of many examples.

here is what we should do: I agree that sampleRate should be passed, this controls errors and crashes so it makes sense to pass it. but tracesSampleRate should stay as it is because of the mentioned reason.

[JulianBissekkou]

@buenaflor Thanks for explaining.
I applied your suggestions 👍🏽

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.72%. Comparing base (90a08ea) to head (7ea555d).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2200      +/-   ##
==========================================
+ Coverage   88.03%   90.72%   +2.68%     
==========================================
  Files         247       73     -174     
  Lines        8585     2371    -6214     
==========================================
- Hits         7558     2151    -5407     
+ Misses       1027      220     -807     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[buenaflor]

@JulianBissekkou some tests are failing but it should be a very simple fix (you can ignore the danger ci)

also could you add this changelog entry under # Fixes in the unreleased section

- Pass `sampleRate` to native SDKs ([#2200](https://github.com/getsentry/sentry-dart/pull/2200))

[denrase]

Thank you for contributing!

• Please also add tests for the new values our native tests SentryFlutterTests.swift and SentryFlutterTest.kt.
• Update the test expectations in init_native_sdk_test.dart to include the new value

[JulianBissekkou]

I will make this PR ready later this week :) Thanks for your feedback