Flutter replay for Android [waiting for upstream SDK release]

flutter/android/build.gradle

@@ -1,12 +1,12 @@
 buildscript {
-    ext.kotlin_version = '1.6.21'
+    ext.kotlin_version = '1.8.0'
     repositories {
         google()
         mavenCentral()
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:7.2.2'
+        classpath 'com.android.tools.build:gradle:7.4.2'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }
 }
@@ -60,7 +60,7 @@ android {
 }
 
 dependencies {
-    api 'io.sentry:sentry-android:7.8.0'
+    api 'io.sentry:sentry-android:7.9.0-alpha.1'
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
 
     // Required -- JUnit 4 framework

flutter/android/gradle.properties

@@ -1 +1,2 @@
 org.gradle.jvmargs=-Xmx1536M
+android.useAndroidX=true

flutter/android/gradlew

@@ -0,0 +1 @@
+../example/android/gradlew

flutter/android/gradlew.bat

@@ -0,0 +1 @@
+../example/android/gradlew.bat

flutter/android/src/main/kotlin/io/sentry/flutter/SentryFlutter.kt

@@ -1,6 +1,7 @@
 package io.sentry.flutter
 
 import io.sentry.SentryLevel
+import io.sentry.SentryReplayOptions
 import io.sentry.android.core.BuildConfig
 import io.sentry.android.core.SentryAndroidOptions
 import io.sentry.protocol.SdkVersion
@@ -119,6 +120,18 @@ class SentryFlutter(
     data.getIfNotNull<Int>("readTimeoutMillis") {
       options.readTimeoutMillis = it
     }
+
+    data.getIfNotNull<Map<String, Any>>("replay") {
+      updateReplayOptions(options.experimental.sessionReplay, it)
+    }
+  }
+
+  fun updateReplayOptions(
+    options: SentryReplayOptions,
+    data: Map<String, Any>,
+  ) {
+    options.sessionSampleRate = data["sessionSampleRate"] as? Double
+    options.errorSampleRate = data["errorSampleRate"] as? Double
   }
 }
 

flutter/android/src/main/kotlin/io/sentry/flutter/SentryFlutterPlugin.kt

@@ -24,16 +24,20 @@ import io.sentry.android.core.SentryAndroid
 import io.sentry.android.core.SentryAndroidOptions
 import io.sentry.android.core.performance.AppStartMetrics
 import io.sentry.android.core.performance.TimeSpan
+import io.sentry.android.replay.ReplayIntegration
 import io.sentry.protocol.DebugImage
 import io.sentry.protocol.SdkVersion
 import io.sentry.protocol.SentryId
 import io.sentry.protocol.User
+import io.sentry.transport.CurrentDateProvider
+import java.io.File
 import java.lang.ref.WeakReference
 
 class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
   private lateinit var channel: MethodChannel
   private lateinit var context: Context
   private lateinit var sentryFlutter: SentryFlutter
+  private lateinit var replay: ReplayIntegration
 
   private var activity: WeakReference<Activity>? = null
   private var framesTracker: ActivityFramesTracker? = null
@@ -53,7 +57,11 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
       )
   }
 
-  override fun onMethodCall(call: MethodCall, result: Result) {
+  @Suppress("CyclomaticComplexMethod")
+  override fun onMethodCall(
+    call: MethodCall,
+    result: Result,
+  ) {
     when (call.method) {
       "initNativeSdk" -> initNativeSdk(call, result)
       "captureEnvelope" -> captureEnvelope(call, result)
@@ -72,6 +80,7 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
       "setTag" -> setTag(call.argument("key"), call.argument("value"), result)
       "removeTag" -> removeTag(call.argument("key"), result)
       "loadContexts" -> loadContexts(result)
+      "addReplayScreenshot" -> addReplayScreenshot(call.argument("path"), call.argument("timestamp"), result)
       else -> result.notImplemented()
     }
   }
@@ -101,7 +110,10 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     // Stub
   }
 
-  private fun initNativeSdk(call: MethodCall, result: Result) {
+  private fun initNativeSdk(
+    call: MethodCall,
+    result: Result,
+  ) {
     if (!this::context.isInitialized) {
       result.error("1", "Context is null", null)
       return
@@ -121,6 +133,27 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
       }
 
       options.beforeSend = BeforeSendCallbackImpl(options.sdkVersion)
+
+      // Replace the default ReplayIntegration with a Flutter-specific recorder.
+      options.integrations.removeAll { it is ReplayIntegration }
+      val cacheDirPath = options.cacheDirPath
+      val replayOptions = options.experimental.sessionReplay
+      val isReplayEnabled = replayOptions.isSessionReplayEnabled || replayOptions.isSessionReplayForErrorsEnabled
+      if (cacheDirPath != null && isReplayEnabled) {
+        replay =
+          ReplayIntegration(
+            context,
+            dateProvider = CurrentDateProvider.getInstance(),
+            recorderProvider = { SentryFlutterReplayRecorder(channel, replay) },
+            recorderConfigProvider = null,
+            replayCacheProvider = null,
+          )
+
+        options.addIntegration(replay)
+        options.setReplayController(replay)
+      } else {
+        options.setReplayController(null)
+      }
     }
     result.success("")
   }
@@ -143,11 +176,12 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     } else {
       val appStartTimeMillis = DateUtils.nanosToMillis(appStartTime.nanoTimestamp().toDouble())
       val item =
+
         mutableMapOf<String, Any?>(
-          "pluginRegistrationTime" to pluginRegistrationTime,
-          "appStartTime" to appStartTimeMillis,
-          "isColdStart" to isColdStart,
-        )
+            "pluginRegistrationTime" to pluginRegistrationTime,
+            "appStartTime" to appStartTimeMillis,
+            "isColdStart" to isColdStart,
+          )
 
       val androidNativeSpans = mutableMapOf<String, Any?>()
 
@@ -203,7 +237,10 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     result.success(null)
   }
 
-  private fun endNativeFrames(id: String?, result: Result) {
+  private fun endNativeFrames(
+    id: String?,
+    result: Result,
+  ) {
     val activity = activity?.get()
     if (!sentryFlutter.autoPerformanceTracingEnabled || activity == null || id == null) {
       if (id == null) {
@@ -223,16 +260,21 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     if (total == 0 && slow == 0 && frozen == 0) {
       result.success(null)
     } else {
-      val frames = mapOf<String, Any?>(
-        "totalFrames" to total,
-        "slowFrames" to slow,
-        "frozenFrames" to frozen,
-      )
+      val frames =
+        mapOf<String, Any?>(
+          "totalFrames" to total,
+          "slowFrames" to slow,
+          "frozenFrames" to frozen,
+        )
       result.success(frames)
     }
   }
 
-  private fun setContexts(key: String?, value: Any?, result: Result) {
+  private fun setContexts(
+    key: String?,
+    value: Any?,
+    result: Result,
+  ) {
     if (key == null || value == null) {
       result.success("")
       return
@@ -244,7 +286,10 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     }
   }
 
-  private fun removeContexts(key: String?, result: Result) {
+  private fun removeContexts(
+    key: String?,
+    result: Result,
+  ) {
     if (key == null) {
       result.success("")
       return
@@ -256,7 +301,10 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     }
   }
 
-  private fun setUser(user: Map<String, Any?>?, result: Result) {
+  private fun setUser(
+    user: Map<String, Any?>?,
+    result: Result,
+  ) {
     if (user != null) {
       val options = HubAdapter.getInstance().options
       val userInstance = User.fromMap(user, options)
@@ -267,7 +315,10 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     result.success("")
   }
 
-  private fun addBreadcrumb(breadcrumb: Map<String, Any?>?, result: Result) {
+  private fun addBreadcrumb(
+    breadcrumb: Map<String, Any?>?,
+    result: Result,
+  ) {
     if (breadcrumb != null) {
       val options = HubAdapter.getInstance().options
       val breadcrumbInstance = Breadcrumb.fromMap(breadcrumb, options)
@@ -282,7 +333,11 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     result.success("")
   }
 
-  private fun setExtra(key: String?, value: String?, result: Result) {
+  private fun setExtra(
+    key: String?,
+    value: String?,
+    result: Result,
+  ) {
     if (key == null || value == null) {
       result.success("")
       return
@@ -292,7 +347,10 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     result.success("")
   }
 
-  private fun removeExtra(key: String?, result: Result) {
+  private fun removeExtra(
+    key: String?,
+    result: Result,
+  ) {
     if (key == null) {
       result.success("")
       return
@@ -302,7 +360,11 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     result.success("")
   }
 
-  private fun setTag(key: String?, value: String?, result: Result) {
+  private fun setTag(
+    key: String?,
+    value: String?,
+    result: Result,
+  ) {
     if (key == null || value == null) {
       result.success("")
       return
@@ -312,7 +374,10 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     result.success("")
   }
 
-  private fun removeTag(key: String?, result: Result) {
+  private fun removeTag(
+    key: String?,
+    result: Result,
+  ) {
     if (key == null) {
       result.success("")
       return
@@ -322,16 +387,19 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     result.success("")
   }
 
-  private fun captureEnvelope(call: MethodCall, result: Result) {
+  private fun captureEnvelope(
+    call: MethodCall,
+    result: Result,
+  ) {
     if (!Sentry.isEnabled()) {
       result.error("1", "The Sentry Android SDK is disabled", null)
       return
     }
     val args = call.arguments() as List<Any>? ?: listOf()
     if (args.isNotEmpty()) {
-      val event = args.first() as ByteArray?
-      if (event != null && event.isNotEmpty()) {
-        val id = InternalSentrySdk.captureEnvelope(event)
+      val envelopeData = args.first() as ByteArray?
+      if (envelopeData != null && envelopeData.isNotEmpty()) {
+        val id = InternalSentrySdk.captureEnvelope(envelopeData)
         if (id != null) {
           result.success("")
         } else {
@@ -379,18 +447,21 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
   private class BeforeSendCallbackImpl(
     private val sdkVersion: SdkVersion?,
   ) : SentryOptions.BeforeSendCallback {
-    override fun execute(event: SentryEvent, hint: Hint): SentryEvent {
+    override fun execute(
+      event: SentryEvent,
+      hint: Hint,
+    ): SentryEvent {
       setEventOriginTag(event)
       addPackages(event, sdkVersion)
       return event
     }
   }
 
   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) {
@@ -411,7 +482,10 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
       event.setTag("event.environment", environment)
     }
 
-    private fun addPackages(event: SentryEvent, sdk: SdkVersion?) {
+    private fun addPackages(
+      event: SentryEvent,
+      sdk: SdkVersion?,
+    ) {
       event.sdk?.let {
         if (it.name == flutterSdk) {
           sdk?.packageSet?.forEach { sentryPackage ->
@@ -440,4 +514,17 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
       )
     result.success(serializedScope)
   }
+
+  private fun addReplayScreenshot(
+    path: String?,
+    timestamp: Long?,
+    result: Result,
+  ) {
+    if (path == null || timestamp == null) {
+      result.error("5", "Arguments are null", null)
+      return
+    }
+    replay.onScreenshotRecorded(File(path), timestamp)
+    result.success("")
+  }
 }