Prepare SDK for upcoming Session Replay API changes on Android (#2977)

* Prepare SDK for upcoming Android changes

* Fix code formatting

* chore: update flutter/scripts/update-android.sh to 8.14.0

* chore: update flutter/scripts/update-android.sh to 8.16.0

* Update CHANGELOG.md

* Update CHANGELOG.md

* Update build.gradle

* Update test

* Update CHANGELOG

* Fix detekt

* Update CHANGELOG

* Update

* Ensure async consistency

* Update

* Fix analyze

---------

Co-authored-by: GitHub <[email protected]>
Co-authored-by: Giancarlo Buenaflor <[email protected]>
Co-authored-by: Giancarlo Buenaflor <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## Unreleased
+
+### Dependencies
+
+- Bump Android SDK from v8.13.2 to v8.17.0 ([#2977](https://github.com/getsentry/sentry-dart/pull/2977))
+  - [changelog](https://github.com/getsentry/sentry-java/blob/main/CHANGELOG.md#8170)
+  - [diff](https://github.com/getsentry/sentry-java/compare/8.13.2...8.17.0)
+
 ## 9.5.0
 
 ### Features

flutter/android/build.gradle

@@ -60,7 +60,7 @@ android {
 }
 
 dependencies {
-    api 'io.sentry:sentry-android:8.13.2'
+    api 'io.sentry:sentry-android:8.17.0'
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
 
     // Required -- JUnit 4 framework

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

@@ -201,10 +201,10 @@ class SentryFlutter {
     replayOptions.sessionSampleRate = (data["sessionSampleRate"] as? Number)?.toDouble()
     replayOptions.onErrorSampleRate = (data["onErrorSampleRate"] as? Number)?.toDouble()
 
-    // Disable native tracking of orientation change (causes replay restart)
+    // Disable native tracking of window sizes
     // because we don't have the new size from Flutter yet. Instead, we'll
     // trigger onConfigurationChanged() manually in setReplayConfig().
-    replayOptions.setTrackOrientationChange(false)
+    replayOptions.isTrackConfiguration = false
 
     @Suppress("UNCHECKED_CAST")
     val tags = (data["tags"] as? Map<String, Any>) ?: mapOf()

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

@@ -3,15 +3,9 @@ package io.sentry.flutter
 import android.annotation.SuppressLint
 import android.app.Activity
 import android.content.Context
-import android.content.res.Configuration
-import android.graphics.Point
-import android.graphics.Rect
 import android.os.Build
-import android.os.Build.VERSION
-import android.os.Build.VERSION_CODES
 import android.os.Looper
 import android.util.Log
-import android.view.WindowManager
 import io.flutter.embedding.engine.plugins.FlutterPlugin
 import io.flutter.embedding.engine.plugins.activity.ActivityAware
 import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding
@@ -49,18 +43,6 @@ class SentryFlutterPlugin :
   private lateinit var context: Context
   private lateinit var sentryFlutter: SentryFlutter
 
-  // Note: initial config because we don't yet have the numbers of the actual Flutter widget.
-  // See how SentryFlutterReplayRecorder.start() handles it. New settings will be set by setReplayConfig() method below.
-  private var replayConfig =
-    ScreenshotRecorderConfig(
-      recordingWidth = VIDEO_BLOCK_SIZE,
-      recordingHeight = VIDEO_BLOCK_SIZE,
-      scaleFactorX = 1.0f,
-      scaleFactorY = 1.0f,
-      frameRate = 1,
-      bitRate = 75000,
-    )
-
   private var activity: WeakReference<Activity>? = null
   private var pluginRegistrationTime: Long? = null
 
@@ -160,18 +142,6 @@ class SentryFlutterPlugin :
           context.applicationContext,
           dateProvider = CurrentDateProvider.getInstance(),
           recorderProvider = { SentryFlutterReplayRecorder(channel, replay!!) },
-          recorderConfigProvider = {
-            Log.i(
-              "Sentry",
-              "Replay configuration requested. Returning: %dx%d at %d FPS, %d BPS".format(
-                replayConfig.recordingWidth,
-                replayConfig.recordingHeight,
-                replayConfig.frameRate,
-                replayConfig.bitRate,
-              ),
-            )
-            replayConfig
-          },
           replayCacheProvider = null,
         )
       replay!!.breadcrumbConverter = SentryFlutterReplayBreadcrumbConverter()
@@ -473,7 +443,8 @@ class SentryFlutterPlugin :
 
     private const val NATIVE_CRASH_WAIT_TIME = 500L
 
-    @JvmStatic fun privateSentryGetReplayIntegration(): ReplayIntegration? = replay
+    @JvmStatic
+    fun privateSentryGetReplayIntegration(): ReplayIntegration? = replay
 
     private fun crash() {
       val exception = RuntimeException("FlutterSentry Native Integration: Sample RuntimeException")
@@ -515,8 +486,28 @@ class SentryFlutterPlugin :
     // Since codec block size is 16, so we have to adjust the width and height to it,
     // otherwise the codec might fail to configure on some devices, see
     // https://cs.android.com/android/platform/superproject/+/master:frameworks/base/media/java/android/media/MediaCodecInfo.java;l=1999-2001
+    val windowWidth = call.argument("windowWidth") as? Double ?: 0.0
+    val windowHeight = call.argument("windowHeight") as? Double ?: 0.0
+
     var width = call.argument("width") as? Double ?: 0.0
     var height = call.argument("height") as? Double ?: 0.0
+
+    val invalidConfig =
+      width == 0.0 ||
+        height == 0.0 ||
+        windowWidth == 0.0 ||
+        windowHeight == 0.0
+
+    if (invalidConfig) {
+      result.error(
+        "5",
+        "Replay config is not valid: width: $width, height: $height, " +
+          "windowWidth: $windowWidth, windowHeight: $windowHeight",
+        null,
+      )
+      return
+    }
+
     // First update the smaller dimension, as changing that will affect the screen ratio more.
     if (width < height) {
       val newWidth = width.adjustReplaySizeToBlockSize()
@@ -528,23 +519,12 @@ class SentryFlutterPlugin :
       height = newHeight
     }
 
-    val wm = context.getSystemService(Context.WINDOW_SERVICE) as WindowManager
-    val screenBounds =
-      if (VERSION.SDK_INT >= VERSION_CODES.R) {
-        wm.currentWindowMetrics.bounds
-      } else {
-        val screenBounds = Point()
-        @Suppress("DEPRECATION")
-        wm.defaultDisplay.getRealSize(screenBounds)
-        Rect(0, 0, screenBounds.x, screenBounds.y)
-      }
-
-    replayConfig =
+    val replayConfig =
       ScreenshotRecorderConfig(
         recordingWidth = width.roundToInt(),
         recordingHeight = height.roundToInt(),
-        scaleFactorX = width.toFloat() / screenBounds.width().toFloat(),
-        scaleFactorY = height.toFloat() / screenBounds.height().toFloat(),
+        scaleFactorX = width.toFloat() / windowWidth.toFloat(),
+        scaleFactorY = height.toFloat() / windowHeight.toFloat(),
         frameRate = call.argument("frameRate") as? Int ?: 0,
         bitRate = call.argument("bitRate") as? Int ?: 0,
       )
@@ -557,7 +537,7 @@ class SentryFlutterPlugin :
         replayConfig.bitRate,
       ),
     )
-    replay!!.onConfigurationChanged(Configuration())
+    replay?.onConfigurationChanged(replayConfig)
     result.success("")
   }
 

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

@@ -12,21 +12,12 @@ internal class SentryFlutterReplayRecorder(
   private val channel: MethodChannel,
   private val integration: ReplayIntegration,
 ) : Recorder {
-  override fun start(recorderConfig: ScreenshotRecorderConfig) {
-    // Ignore if this is the initial call before we actually got the configuration from Flutter.
-    // We'll get another call here when the configuration is changed according to the widget size.
-    if (recorderConfig.recordingHeight <= VIDEO_BLOCK_SIZE && recorderConfig.recordingWidth <= VIDEO_BLOCK_SIZE) {
-      return
-    }
-
+  override fun start() {
     Handler(Looper.getMainLooper()).post {
       try {
         channel.invokeMethod(
           "ReplayRecorder.start",
           mapOf(
-            "width" to recorderConfig.recordingWidth,
-            "height" to recorderConfig.recordingHeight,
-            "frameRate" to recorderConfig.frameRate,
             "replayId" to integration.getReplayId().toString(),
           ),
         )
@@ -46,6 +37,33 @@ internal class SentryFlutterReplayRecorder(
     }
   }
 
+  override fun onConfigurationChanged(config: ScreenshotRecorderConfig) {
+    Handler(Looper.getMainLooper()).post {
+      try {
+        channel.invokeMethod(
+          "ReplayRecorder.onConfigurationChanged",
+          mapOf(
+            "width" to config.recordingWidth,
+            "height" to config.recordingHeight,
+            "frameRate" to config.frameRate,
+          ),
+        )
+      } catch (ignored: Exception) {
+        Log.w("Sentry", "Failed to propagate configuration change to Flutter", ignored)
+      }
+    }
+  }
+
+  override fun reset() {
+    Handler(Looper.getMainLooper()).post {
+      try {
+        channel.invokeMethod("ReplayRecorder.reset", null)
+      } catch (ignored: Exception) {
+        Log.w("Sentry", "Failed to reset replay recorder", ignored)
+      }
+    }
+  }
+
   override fun pause() {
     Handler(Looper.getMainLooper()).post {
       try {

flutter/lib/src/event_processor/screenshot_event_processor.dart

@@ -17,13 +17,11 @@ class ScreenshotEventProcessor implements EventProcessor {
 
   ScreenshotEventProcessor(this._options) {
     final targetResolution = _options.screenshotQuality.targetResolution();
-    _recorder = ScreenshotRecorder(
-      ScreenshotRecorderConfig(
-        width: targetResolution,
-        height: targetResolution,
-      ),
-      _options,
-    );
+    _recorder = ScreenshotRecorder(_options,
+        config: ScreenshotRecorderConfig(
+          width: targetResolution,
+          height: targetResolution,
+        ));
     _debouncer = Debouncer(
       // ignore: invalid_use_of_internal_member
       _options.clock,

flutter/lib/src/native/cocoa/cocoa_replay_recorder.dart

@@ -15,11 +15,12 @@ class CocoaReplayRecorder {
 
   CocoaReplayRecorder(this._options)
       : _recorder = ReplayScreenshotRecorder(
-          ScreenshotRecorderConfig(
-            pixelRatio: _options.replay.quality.resolutionScalingFactor,
-          ),
           _options,
-        );
+        ) {
+    _recorder.config = ScreenshotRecorderConfig(
+      pixelRatio: _options.replay.quality.resolutionScalingFactor,
+    );
+  }
 
   Future<Map<String, int>?> captureScreenshot() async {
     return _recorder.capture((screenshot) async {

flutter/lib/src/native/java/android_replay_recorder.dart

@@ -7,7 +7,6 @@ import 'package:meta/meta.dart';
 
 import '../../../sentry_flutter.dart';
 import '../../replay/scheduled_recorder.dart';
-import '../../replay/scheduled_recorder_config.dart';
 import '../../screenshot/screenshot.dart';
 import 'binding.dart' as native;
 
@@ -18,18 +17,17 @@ class AndroidReplayRecorder extends ScheduledScreenshotRecorder {
   _AndroidNativeReplayWorker? _worker;
 
   @internal // visible for testing, used by SentryNativeJava
-  static AndroidReplayRecorder Function(
-          ScheduledScreenshotRecorderConfig, SentryFlutterOptions) factory =
+  static AndroidReplayRecorder Function(SentryFlutterOptions) factory =
       AndroidReplayRecorder.new;
 
-  AndroidReplayRecorder(super.config, super.options) {
+  AndroidReplayRecorder(super.options) {
     super.callback = _addReplayScreenshot;
   }
 
   @override
   Future<void> start() async {
     final spawningWorker = _AndroidNativeReplayWorker.spawn();
-    super.start();
+    await super.start();
     _worker = await spawningWorker;
   }
 

flutter/lib/src/native/java/sentry_native_java.dart

@@ -24,19 +24,20 @@ class SentryNativeJava extends SentryNativeChannel {
             final replayId =
                 SentryId.fromId(call.arguments['replayId'] as String);
 
-            final config = ScheduledScreenshotRecorderConfig(
-                width: (call.arguments['width'] as num).toDouble(),
-                height: (call.arguments['height'] as num).toDouble(),
-                frameRate: call.arguments['frameRate'] as int);
-
-            _replayRecorder = AndroidReplayRecorder.factory(config, options);
+            _replayRecorder = AndroidReplayRecorder.factory(options);
             await _replayRecorder!.start();
-
             hub.configureScope((s) {
               // ignore: invalid_use_of_internal_member
               s.replayId = replayId;
             });
+            break;
+          case 'ReplayRecorder.onConfigurationChanged':
+            final config = ScheduledScreenshotRecorderConfig(
+                width: (call.arguments['width'] as num).toDouble(),
+                height: (call.arguments['height'] as num).toDouble(),
+                frameRate: call.arguments['frameRate'] as int);
 
+            await _replayRecorder?.onConfigurationChanged(config);
             break;
           case 'ReplayRecorder.stop':
             hub.configureScope((s) {
@@ -55,6 +56,9 @@ class SentryNativeJava extends SentryNativeChannel {
           case 'ReplayRecorder.resume':
             await _replayRecorder?.resume();
             break;
+          case 'ReplayRecorder.reset':
+            // ignored
+            break;
           default:
             throw UnimplementedError('Method ${call.method} not implemented');
         }

flutter/lib/src/native/sentry_native_channel.dart

@@ -252,6 +252,8 @@ class SentryNativeChannel
   @override
   FutureOr<void> setReplayConfig(ReplayConfig config) =>
       channel.invokeMethod('setReplayConfig', {
+        'windowWidth': config.windowWidth,
+        'windowHeight': config.windowHeight,
         'width': config.width,
         'height': config.height,
         'frameRate': config.frameRate,