Chore: Migrate to sentry cocoa v8 (#1197)

Co-authored-by: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com> Co-authored-by: Manoel Aranda Neto <marandaneto@gmail.com> Closes #1161 Closes #1185
getsentry · Jan 16, 2023 · 8bea1f1 · 8bea1f1
1 parent fab2a9a
commit 8bea1f1
Show file tree

Hide file tree

Showing 15 changed files with 170 additions and 46 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,18 @@
 # Changelog
 
+## Unreleased
+
+### Breaking Changes
+
+- Rename APM tracking feature flags to tracing ([#1222](https://github.com/getsentry/sentry-dart/pull/1222))
+  - Rename
+    - enableAutoPerformanceTracking to enableAutoPerformanceTracing
+    - enableOutOfMemoryTracking to enableWatchdogTerminationTracking
+
+### Enhancements
+
+- Migrate to sentry cocoa v8 ([#1197](https://github.com/getsentry/sentry-dart/pull/1197))
+
 ## 7.0.0-alpha.2
 
 ### Features
@@ -9,9 +22,10 @@
 ### Breaking Changes
 
 - Enable APM features by default ([#1217](https://github.com/getsentry/sentry-dart/pull/1217))
-  - captureFailedRequests
-  - enableStructuredDataTracing
-  - enableUserInteractionTracing
+  - Enable by default
+    - captureFailedRequests
+    - enableStructuredDataTracing
+    - enableUserInteractionTracing
 - Mark transaction as internal_error in case of unhandled errors ([#1218](https://github.com/getsentry/sentry-dart/pull/1218))
 
 ## 7.0.0-alpha.1

diff --git a/flutter/android/src/main/kotlin/io/sentry/flutter/SentryFlutterPlugin.kt b/flutter/android/src/main/kotlin/io/sentry/flutter/SentryFlutterPlugin.kt
@@ -29,14 +29,13 @@ import java.lang.ref.WeakReference
 import java.util.Locale
 import java.util.UUID
 
-@Suppress("TooManyFunctions")
 class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
   private lateinit var channel: MethodChannel
   private lateinit var context: Context
 
   private var activity: WeakReference<Activity>? = null
   private var framesTracker: ActivityFramesTracker? = null
-  private var autoPerformanceTrackingEnabled = false
+  private var autoPerformanceTracingEnabled = false
 
   override fun onAttachedToEngine(flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) {
     context = flutterPluginBinding.applicationContext
@@ -155,28 +154,38 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
         // options.isEnableNdk = false
       }
 
-      args.getIfNotNull<Boolean>("enableAutoPerformanceTracking") { enableAutoPerformanceTracking ->
-        if (enableAutoPerformanceTracking) {
-          autoPerformanceTrackingEnabled = true
+      args.getIfNotNull<Boolean>("enableAutoPerformanceTracing") { enableAutoPerformanceTracing ->
+        if (enableAutoPerformanceTracing) {
+          autoPerformanceTracingEnabled = true
           framesTracker = ActivityFramesTracker(LoadClass(), options)
         }
       }
 
       args.getIfNotNull<Boolean>("sendClientReports") { options.isSendClientReports = it }
 
+      args.getIfNotNull<Map<String, Any>>("sdk") { sdk ->
+        val name = sdk["name"] as? String
+        val version = sdk["version"] as? String
+        if (name != null && version != null) {
+          val sdkVersion = SdkVersion(name, version)
+          options.setSentryClientName(name)
+          options.setSdkVersion(sdkVersion)
+        }
+      }
+
       options.setBeforeSend { event, _ ->
         setEventOriginTag(event)
         addPackages(event, options.sdkVersion)
         event
       }
 
-      // missing proxy, enableScopeSync
+      // missing proxy
     }
     result.success("")
   }
 
   private fun fetchNativeAppStart(result: Result) {
-    if (!autoPerformanceTrackingEnabled) {
+    if (!autoPerformanceTracingEnabled) {
       result.success(null)
       return
     }
@@ -199,7 +208,7 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
   }
 
   private fun beginNativeFrames(result: Result) {
-    if (!autoPerformanceTrackingEnabled) {
+    if (!autoPerformanceTracingEnabled) {
       result.success(null)
       return
     }
@@ -212,7 +221,7 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
 
   private fun endNativeFrames(id: String?, result: Result) {
     val activity = activity?.get()
-    if (!autoPerformanceTrackingEnabled || activity == null || id == null) {
+    if (!autoPerformanceTracingEnabled || activity == null || id == null) {
       if (id == null) {
         Log.w("Sentry", "Parameter id cannot be null when calling endNativeFrames.")
       }
@@ -263,7 +272,6 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     }
   }
 
-  @Suppress("ComplexMethod")
   private fun setUser(user: Map<String, Any?>?, result: Result) {
     if (user == null) {
       Sentry.setUser(null)

diff --git a/flutter/config/detekt-bl.xml b/flutter/config/detekt-bl.xml
@@ -3,10 +3,13 @@
   <ManuallySuppressedIssues></ManuallySuppressedIssues>
   <CurrentIssues>
     <ID>ComplexMethod:SentryFlutterPlugin.kt$SentryFlutterPlugin$override fun onMethodCall(call: MethodCall, result: Result)</ID>
+    <ID>ComplexMethod:SentryFlutterPlugin.kt$SentryFlutterPlugin$private fun setUser(user: Map&lt;String, Any?&gt;?, result: Result)</ID>
+    <ID>LongMethod:SentryFlutterPlugin.kt$SentryFlutterPlugin$private fun initNativeSdk(call: MethodCall, result: Result)</ID>
     <ID>MagicNumber:MainActivity.kt$MainActivity$6_000</ID>
     <ID>TooGenericExceptionCaught:MainActivity.kt$MainActivity$e: Exception</ID>
     <ID>TooGenericExceptionThrown:MainActivity.kt$MainActivity$throw Exception("Catch this java exception thrown from Kotlin thread!")</ID>
     <ID>TooGenericExceptionThrown:MainActivity.kt$MainActivity$throw RuntimeException("Catch this java exception!")</ID>
     <ID>TooGenericExceptionThrown:MainActivity.kt$MainActivity$throw RuntimeException("Catch this platform exception!")</ID>
+    <ID>TooManyFunctions:SentryFlutterPlugin.kt$SentryFlutterPlugin : FlutterPluginMethodCallHandlerActivityAware</ID>
   </CurrentIssues>
 </SmellBaseline>
diff --git a/flutter/example/ios/Flutter/AppFrameworkInfo.plist b/flutter/example/ios/Flutter/AppFrameworkInfo.plist
@@ -21,6 +21,6 @@
 	<key>CFBundleVersion</key>
 	<string>1.0</string>
 	<key>MinimumOSVersion</key>
-	<string>9.0</string>
+	<string>11.0</string>
 </dict>
 </plist>
diff --git a/flutter/example/macos/Podfile b/flutter/example/macos/Podfile
@@ -1,4 +1,4 @@
-platform :osx, '10.11'
+platform :osx, '10.13'
 
 # CocoaPods analytics sends network stats synchronously affecting flutter build latency.
 ENV['COCOAPODS_DISABLE_STATS'] = 'true'

diff --git a/flutter/example/macos/Runner.xcodeproj/project.pbxproj b/flutter/example/macos/Runner.xcodeproj/project.pbxproj
@@ -411,7 +411,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				MACOSX_DEPLOYMENT_TARGET = 10.11;
+				MACOSX_DEPLOYMENT_TARGET = 10.13;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				SDKROOT = macosx;
 				SWIFT_COMPILATION_MODE = wholemodule;
@@ -491,7 +491,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				MACOSX_DEPLOYMENT_TARGET = 10.11;
+				MACOSX_DEPLOYMENT_TARGET = 10.13;
 				MTL_ENABLE_DEBUG_INFO = YES;
 				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = macosx;
@@ -538,7 +538,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				MACOSX_DEPLOYMENT_TARGET = 10.11;
+				MACOSX_DEPLOYMENT_TARGET = 10.13;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				SDKROOT = macosx;
 				SWIFT_COMPILATION_MODE = wholemodule;

diff --git a/flutter/ios/Classes/SentryFlutterPluginApple.swift b/flutter/ios/Classes/SentryFlutterPluginApple.swift
@@ -197,13 +197,19 @@ public class SentryFlutterPluginApple: NSObject, FlutterPlugin {
         SentrySDK.start { options in
             self.updateOptions(arguments: arguments, options: options)
 
-            if arguments["enableAutoPerformanceTracking"] as? Bool ?? false {
+            if arguments["enableAutoPerformanceTracing"] as? Bool ?? false {
                 PrivateSentrySDKOnly.appStartMeasurementHybridSDKMode = true
                 #if os(iOS) || targetEnvironment(macCatalyst)
                 PrivateSentrySDKOnly.framesTrackingMeasurementHybridSDKMode = true
                 #endif
             }
 
+            if let sdk = arguments["sdk"] as? [String: Any?],
+               let name = sdk["name"] as? String,
+               let version = sdk["version"] as? String {
+               PrivateSentrySDKOnly.setSdkName(name, andVersionString: version)
+            }
+
             // note : for now, in sentry-cocoa, beforeSend is not called before captureEnvelope
             options.beforeSend = { event in
                 self.setEventOriginTag(event: event)
@@ -233,7 +239,7 @@ public class SentryFlutterPluginApple: NSObject, FlutterPlugin {
 
        if didReceiveDidBecomeActiveNotification &&
             (PrivateSentrySDKOnly.options.enableAutoSessionTracking ||
-             PrivateSentrySDKOnly.options.enableOutOfMemoryTracking) {
+             PrivateSentrySDKOnly.options.enableWatchdogTerminationTracking) {
             // We send a SentryHybridSdkDidBecomeActive to the Sentry Cocoa SDK, so the SDK will mimics
             // the didBecomeActiveNotification notification. This is needed for session and OOM tracking.
            NotificationCenter.default.post(name: Notification.Name("SentryHybridSdkDidBecomeActive"), object: nil)
@@ -313,8 +319,8 @@ public class SentryFlutterPluginApple: NSObject, FlutterPlugin {
             options.maxCacheItems = maxCacheItems
         }
 
-        if let enableOutOfMemoryTracking = arguments["enableOutOfMemoryTracking"] as? Bool {
-            options.enableOutOfMemoryTracking = enableOutOfMemoryTracking
+        if let enableWatchdogTerminationTracking = arguments["enableWatchdogTerminationTracking"] as? Bool {
+            options.enableWatchdogTerminationTracking = enableWatchdogTerminationTracking
         }
 
         if let sendClientReports = arguments["sendClientReports"] as? Bool {
@@ -581,7 +587,7 @@ public class SentryFlutterPluginApple: NSObject, FlutterPlugin {
         breadcrumbInstance.data = data
       }
 
-      SentrySDK.addBreadcrumb(crumb: breadcrumbInstance)
+      SentrySDK.addBreadcrumb(breadcrumbInstance)
 
       result("")
     }

diff --git a/flutter/ios/sentry_flutter.podspec b/flutter/ios/sentry_flutter.podspec
@@ -12,11 +12,11 @@ Sentry SDK for Flutter with support to native through sentry-cocoa.
                          :tag => s.version.to_s }
   s.source_files     = 'Classes/**/*'
   s.public_header_files = 'Classes/**/*.h'
-  s.dependency 'Sentry/HybridSDK', '7.31.5'
+  s.dependency 'Sentry/HybridSDK', '8.0.0-rc.1'
   s.ios.dependency 'Flutter'
   s.osx.dependency 'FlutterMacOS'
-  s.ios.deployment_target = '9.0'
-  s.osx.deployment_target = '10.11'
+  s.ios.deployment_target = '11.0'
+  s.osx.deployment_target = '10.13'
 
   # Flutter.framework does not contain a i386 slice. Only x86_64 simulators are supported.
   s.ios.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', 'VALID_ARCHS[sdk=iphonesimulator*]' => 'x86_64' }

diff --git a/flutter/lib/src/integrations/native_sdk_integration.dart b/flutter/lib/src/integrations/native_sdk_integration.dart
@@ -40,10 +40,15 @@ class NativeSdkIntegration extends Integration<SentryFlutterOptions> {
         'enableAutoNativeBreadcrumbs': options.enableAutoNativeBreadcrumbs,
         'maxCacheItems': options.maxCacheItems,
         'sendDefaultPii': options.sendDefaultPii,
-        'enableOutOfMemoryTracking': options.enableOutOfMemoryTracking,
+        'enableWatchdogTerminationTracking':
+            options.enableWatchdogTerminationTracking,
         'enableNdkScopeSync': options.enableNdkScopeSync,
-        'enableAutoPerformanceTracking': options.enableAutoPerformanceTracking,
+        'enableAutoPerformanceTracing': options.enableAutoPerformanceTracing,
         'sendClientReports': options.sendClientReports,
+        'sdk': {
+          'name': options.sdk.name,
+          'version': options.sdk.version,
+        },
       });
 
       options.sdk.addIntegration('nativeSdkIntegration');

diff --git a/flutter/lib/src/sentry_flutter_options.dart b/flutter/lib/src/sentry_flutter_options.dart
@@ -167,14 +167,14 @@ class SentryFlutterOptions extends SentryOptions {
   /// Enables Out of Memory Tracking for iOS and macCatalyst.
   /// See the following link for more information and possible restrictions:
   /// https://docs.sentry.io/platforms/apple/guides/ios/configuration/out-of-memory/
-  bool enableOutOfMemoryTracking = true;
+  bool enableWatchdogTerminationTracking = true;
 
   /// Enable scope sync from Java to NDK.
   /// Only available on Android.
   bool enableNdkScopeSync = false;
 
   /// Enable auto performance tracking by default.
-  bool enableAutoPerformanceTracking = true;
+  bool enableAutoPerformanceTracing = true;
 
   /// Automatically track app start measurement and send it with the
   /// first transaction. Set to false when configuring option to disable or if

diff --git a/flutter/test/integrations/init_native_sdk_integration_test.dart b/flutter/test/integrations/init_native_sdk_integration_test.dart
@@ -43,7 +43,7 @@ void main() {
         'dist': null,
         'integrations': <String>[],
         'packages': [
-          {'name': 'pub:sentry', 'version': sdkVersion}
+          {'name': 'pub:sentry_flutter', 'version': sdkVersion}
         ],
         'diagnosticLevel': 'debug',
         'maxBreadcrumbs': 100,
@@ -52,10 +52,14 @@ void main() {
         'enableAutoNativeBreadcrumbs': true,
         'maxCacheItems': 30,
         'sendDefaultPii': false,
-        'enableOutOfMemoryTracking': true,
+        'enableWatchdogTerminationTracking': true,
         'enableNdkScopeSync': false,
-        'enableAutoPerformanceTracking': true,
-        'sendClientReports': true
+        'enableAutoPerformanceTracing': true,
+        'sendClientReports': true,
+        'sdk': {
+          'name': 'sentry.dart.flutter',
+          'version': sdkVersion,
+        },
       });
     });
 
@@ -85,9 +89,9 @@ void main() {
         ..enableAutoNativeBreadcrumbs = false
         ..maxCacheItems = 0
         ..sendDefaultPii = true
-        ..enableOutOfMemoryTracking = false
+        ..enableWatchdogTerminationTracking = false
         ..enableNdkScopeSync = true
-        ..enableAutoPerformanceTracking = false
+        ..enableAutoPerformanceTracing = false
         ..sendClientReports = false;
 
       options.sdk.addIntegration('foo');
@@ -111,7 +115,7 @@ void main() {
         'dist': 'distfoo',
         'integrations': ['foo'],
         'packages': [
-          {'name': 'pub:sentry', 'version': sdkVersion},
+          {'name': 'pub:sentry_flutter', 'version': sdkVersion},
           {'name': 'bar', 'version': '1'},
         ],
         'diagnosticLevel': 'error',
@@ -121,10 +125,14 @@ void main() {
         'enableAutoNativeBreadcrumbs': false,
         'maxCacheItems': 0,
         'sendDefaultPii': true,
-        'enableOutOfMemoryTracking': false,
+        'enableWatchdogTerminationTracking': false,
         'enableNdkScopeSync': true,
-        'enableAutoPerformanceTracking': false,
-        'sendClientReports': false
+        'enableAutoPerformanceTracing': false,
+        'sendClientReports': false,
+        'sdk': {
+          'name': 'sentry.dart.flutter',
+          'version': sdkVersion,
+        },
       });
     });
 
@@ -166,7 +174,16 @@ MethodChannel createChannelWithCallback(
 
 SentryFlutterOptions createOptions() {
   final mockPlatformChecker = MockPlatformChecker(hasNativeIntegration: true);
-  return SentryFlutterOptions(dsn: fakeDsn, checker: mockPlatformChecker);
+  final options = SentryFlutterOptions(
+    dsn: fakeDsn,
+    checker: mockPlatformChecker,
+  );
+  options.sdk = SdkVersion(
+    name: sdkName,
+    version: sdkVersion,
+  );
+  options.sdk.addPackage('pub:sentry_flutter', sdkVersion);
+  return options;
 }
 
 class Fixture {

diff --git a/min_version_test/ios/Flutter/AppFrameworkInfo.plist b/min_version_test/ios/Flutter/AppFrameworkInfo.plist
@@ -21,6 +21,6 @@
   <key>CFBundleVersion</key>
   <string>1.0</string>
   <key>MinimumOSVersion</key>
-  <string>9.0</string>
+  <string>11.0</string>
 </dict>
 </plist>
diff --git a/min_version_test/ios/Podfile b/min_version_test/ios/Podfile
@@ -1,5 +1,5 @@
 # Uncomment this line to define a global platform for your project
-# platform :ios, '9.0'
+# platform :ios, '11.0'
 
 # CocoaPods analytics sends network stats synchronously affecting flutter build latency.
 ENV['COCOAPODS_DISABLE_STATS'] = 'true'