Fix memory leak issue in SentryFlutterPlugin (#1588)

Co-authored-by: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com>
getsentry · Aug 9, 2023 · adf71f4 · adf71f4
1 parent 07d9b4d
commit adf71f4
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 36 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Fixes
+
+- Fixing memory leak issue in SentryFlutterPlugin (Android Plugin) ([#1588](https://github.com/getsentry/sentry-dart/pull/1588))
+
 ### Dependencies
 
 - Bump Android SDK from v6.25.2 to v6.28.0 ([#1586](https://github.com/getsentry/sentry-dart/pull/1586))

diff --git a/flutter/android/src/main/kotlin/io/sentry/flutter/SentryFlutterPlugin.kt b/flutter/android/src/main/kotlin/io/sentry/flutter/SentryFlutterPlugin.kt
@@ -11,11 +11,13 @@ import io.flutter.plugin.common.MethodChannel
 import io.flutter.plugin.common.MethodChannel.MethodCallHandler
 import io.flutter.plugin.common.MethodChannel.Result
 import io.sentry.Breadcrumb
+import io.sentry.DateUtils
+import io.sentry.Hint
 import io.sentry.HubAdapter
+import io.sentry.Sentry
 import io.sentry.SentryEvent
 import io.sentry.SentryLevel
-import io.sentry.Sentry
-import io.sentry.DateUtils
+import io.sentry.SentryOptions
 import io.sentry.android.core.ActivityFramesTracker
 import io.sentry.android.core.AppStartState
 import io.sentry.android.core.BuildConfig.VERSION_NAME
@@ -26,7 +28,6 @@ import io.sentry.protocol.DebugImage
 import io.sentry.protocol.SdkVersion
 import io.sentry.protocol.SentryId
 import io.sentry.protocol.User
-import io.sentry.protocol.Geo
 import java.io.File
 import java.lang.ref.WeakReference
 import java.util.Locale
@@ -40,10 +41,6 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
   private var framesTracker: ActivityFramesTracker? = null
   private var autoPerformanceTracingEnabled = false
 
-  private val flutterSdk = "sentry.dart.flutter"
-  private val androidSdk = "sentry.java.android.flutter"
-  private val nativeSdk = "sentry.native.android.flutter"
-
   override fun onAttachedToEngine(flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) {
     context = flutterPluginBinding.applicationContext
     channel = MethodChannel(flutterPluginBinding.binaryMessenger, "sentry_flutter")
@@ -127,9 +124,15 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
       args.getIfNotNull<String>("environment") { options.environment = it }
       args.getIfNotNull<String>("release") { options.release = it }
       args.getIfNotNull<String>("dist") { options.dist = it }
-      args.getIfNotNull<Boolean>("enableAutoSessionTracking") { options.isEnableAutoSessionTracking = it }
-      args.getIfNotNull<Long>("autoSessionTrackingIntervalMillis") { options.sessionTrackingIntervalMillis = it }
-      args.getIfNotNull<Long>("anrTimeoutIntervalMillis") { options.anrTimeoutIntervalMillis = it }
+      args.getIfNotNull<Boolean>("enableAutoSessionTracking") {
+        options.isEnableAutoSessionTracking = it
+      }
+      args.getIfNotNull<Long>("autoSessionTrackingIntervalMillis") {
+        options.sessionTrackingIntervalMillis = it
+      }
+      args.getIfNotNull<Long>("anrTimeoutIntervalMillis") {
+        options.anrTimeoutIntervalMillis = it
+      }
       args.getIfNotNull<Boolean>("attachThreads") { options.isAttachThreads = it }
       args.getIfNotNull<Boolean>("attachStacktrace") { options.isAttachStacktrace = it }
       args.getIfNotNull<Boolean>("enableAutoNativeBreadcrumbs") {
@@ -183,12 +186,7 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
       options.sdkVersion = sdkVersion
       options.sentryClientName = "$androidSdk/$VERSION_NAME"
       options.nativeSdkName = nativeSdk
-
-      options.setBeforeSend { event, _ ->
-        setEventOriginTag(event)
-        addPackages(event, options.sdkVersion)
-        event
-      }
+      options.beforeSend = BeforeSendCallbackImpl(options.sdkVersion)
 
       args.getIfNotNull<Int>("connectionTimeoutMillis") { options.connectionTimeoutMillis = it }
       args.getIfNotNull<Int>("readTimeoutMillis") { options.readTimeoutMillis = it }
@@ -408,30 +406,50 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     result.success("")
   }
 
-  private fun setEventOriginTag(event: SentryEvent) {
-    event.sdk?.let {
-      when (it.name) {
-        flutterSdk -> setEventEnvironmentTag(event, "flutter", "dart")
-        androidSdk -> setEventEnvironmentTag(event, environment = "java")
-        nativeSdk -> setEventEnvironmentTag(event, environment = "native")
-        else -> return
-      }
+  private class BeforeSendCallbackImpl(
+    private val sdkVersion: SdkVersion?
+  ) : SentryOptions.BeforeSendCallback {
+    override fun execute(event: SentryEvent, hint: Hint): SentryEvent {
+      setEventOriginTag(event)
+      addPackages(event, sdkVersion)
+      return event
     }
   }
 
-  private fun setEventEnvironmentTag(event: SentryEvent, origin: String = "android", environment: String) {
-    event.setTag("event.origin", origin)
-    event.setTag("event.environment", environment)
-  }
-
-  private fun addPackages(event: SentryEvent, sdk: SdkVersion?) {
-    event.sdk?.let {
-      if (it.name == flutterSdk) {
-        sdk?.packageSet?.forEach { sentryPackage ->
-          it.addPackage(sentryPackage.name, sentryPackage.version)
+  companion object {
+
+    private const val flutterSdk = "sentry.dart.flutter"
+    private const val androidSdk = "sentry.java.android.flutter"
+    private const val nativeSdk = "sentry.native.android.flutter"
+    private fun setEventOriginTag(event: SentryEvent) {
+      event.sdk?.let {
+        when (it.name) {
+          flutterSdk -> setEventEnvironmentTag(event, "flutter", "dart")
+          androidSdk -> setEventEnvironmentTag(event, environment = "java")
+          nativeSdk -> setEventEnvironmentTag(event, environment = "native")
+          else -> return
         }
-        sdk?.integrationSet?.forEach { integration ->
-          it.addIntegration(integration)
+      }
+    }
+
+    private fun setEventEnvironmentTag(
+      event: SentryEvent,
+      origin: String = "android",
+      environment: String
+    ) {
+      event.setTag("event.origin", origin)
+      event.setTag("event.environment", environment)
+    }
+
+    private fun addPackages(event: SentryEvent, sdk: SdkVersion?) {
+      event.sdk?.let {
+        if (it.name == flutterSdk) {
+          sdk?.packageSet?.forEach { sentryPackage ->
+            it.addPackage(sentryPackage.name, sentryPackage.version)
+          }
+          sdk?.integrationSet?.forEach { integration ->
+            it.addIntegration(integration)
+          }
         }
       }
     }