[SR] Session Replay (#3339)

* Add new sentry-android-replay module

* Add screenshot recorder

* Add sentry replay envelope and event

* Add TODOs and license headers

* Api dump

* Formatting

* Lint

* Format code

* More comments

* Disable detekt plugin for now

* WIP

* Add replay envelopes

* Remove jsonValue

* Remove

* Fix json

* Finalize replay envelopes

* Introduce MapObjectReader

* Add missing test

* Add test  for MapObjectReader

* Add MapObjectWriter change

* Add finals

* Fix test

* Fix test

* Address review

* Add finals and annotations

* Specify SHA for license headers

* Address review from Dhiogo

* Address review from Markus

* Remove public captureReplay method

* Fix test

* api dump

* api dump

* Address review from Markus

* Api dump

* Add replay integration

* Uncomment redacting

* Update proguard rules

* Add missing rule for AndroidTest

* Add ReplayCache tests

* Add tests

* Add SessionReplayOptions

* Call listeners when installing RootViewsSpy

* Call listeners when installing RootViewsSpy

* SessionReplayOptions -> SentryReplayOptions

* Fix test

* Add AndroidManifest options for replays

* Add buffer mode and link replays with events/transactions

* Pass hint to captureReplay

* Better error handling

* recycler lastScreenshot before re-assigning

* Expose ReplayCache as public api

* Fix redacting out of sync

* _experimental -> experimental

* Merge conflicts

* Fix tests

* Add more tests

* Improve ReplayCache logic

* frameUsec -> frameDurationUsec

* bottom/right -> height/width

* add todos

* duration -> durationMs

* replaId non-nullable

* More conflicts

* More conflicts

* Fix tests

* Address PR review

* Add kdoc

* Add kdoc

* Fix tests

* Add comment for experimental options

* Do not run recorder if full session was not sampled

* Add more tests

* Add session deadline of 1h

* Clean up older replays when starting a new one

* Remove unnecessary extension fun

* Safe executors

* Fix crashing MediaCodec and use density to determine recording resolution

* Add redact options and align naming

* Fix tests

* Fix tests

* WIP

* Try-catch release of encoder

* Support orientation change for session mode

* WIP

* Spotless

* TODO

* Update sentry/src/main/java/io/sentry/SentryReplayOptions.java

Co-authored-by: Markus Hintersteiner <[email protected]>

* More gates

* Revert addAll

* Fix conflicts

* fix test

* release: 7.8.0-alpha.0

* Introduce CaptureStrategy for buffer and session modes

* Formatting

* WIP

* Expose public API for flutter

* Spotless

* Spotless

* Remove breadcrumb import

* Send temporary breadcrumbs and add test

* Formatting

* Sort rrweb events

* Formatting

* Expose replayCacheDir

* Capture network requests

* Change op name to resource.http

* feat(replay): Add `sendReplay` method for Hybrid SDKs

* fix apiDump

* Address PR review

* Capture motion events as incremental rrweb events

* Spotless

* Revert

* Changelog

* release: 7.9.0-alpha.1

* Fix test

* WIP

* Adhere to rrweb move event expectations

* formatting

* Align breadcrumbs with frontend and iOS

* Add tests and fix deserialization

* Rotate buffered motion events in buffer mode

* Add Nullables

* Address PR feedback

* Formatting

* Rotate current events until segment end exclusively

* Allow rrweb breadcrumb customization from hybrid SDKs

* Fix proguard rules

* WIP

* Add tests

* Detect obscured views

* revert some thigns

* Remove commented code

* Suppress lint

* Support multi-touch gestures

* Address PR feedback

* Changelog

* release: 7.11.0-alpha.2

* Make multi-touch work

* Fix tests

* WIP

* Capture screen names as urls for replay

* Fix

* Ignore warning

* Address PR feedback

* Tests

* Add quality settings

* Fix redacting out of sync

* Remove time measuring

* Mark isEnableScreenTracking as experimental

* Format code

* Address PR feedback

* Clean up

* Spotless

* Format code

* Changelog

* release: 7.12.0-alpha.3

* [SR] Add `redactClasses` option (#3546)

Co-authored-by: Roman Zavarnitsyn <[email protected]>

* misc(changelog): Prepare for next alpha

* fix(changelog): Bump alpha version number

* release: 7.12.0-alpha.4

* Redaction fixes for RN

* Add stopgap for offline session recording

* Recycle unused bitmap

* Add tests for sentry

* Add ReplayIntegrationTest

* Replay SmokeTest

* Fix test

* Fix test

* Fix events linking with buffered replays

* Changelog

---------

Co-authored-by: Sentry Github Bot <[email protected]>
Co-authored-by: Markus Hintersteiner <[email protected]>
Co-authored-by: getsentry-bot <[email protected]>
Co-authored-by: getsentry-bot <[email protected]>
Co-authored-by: Krystof Woldrich <[email protected]>
Co-authored-by: Krystof Woldrich <[email protected]>

Author: 5 people

CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Session Replay Public Beta ([#3339](https://github.com/getsentry/sentry-java/pull/3339))
+
+  To enable Replay use the `sessionReplay.sessionSampleRate` or `sessionReplay.errorSampleRate` experimental options.
+
+  ```kotlin
+  import io.sentry.SentryReplayOptions
+  import io.sentry.android.core.SentryAndroid
+
+  SentryAndroid.init(context) { options ->
+   
+    // Currently under experimental options:
+    options.experimental.sessionReplay.sessionSampleRate = 1.0
+    options.experimental.sessionReplay.errorSampleRate = 1.0
+  
+    // To change default redaction behavior (defaults to true)
+    options.experimental.sessionReplay.redactAllImages = true
+    options.experimental.sessionReplay.redactAllText = true
+  
+    // To change quality of the recording (defaults to MEDIUM)
+    options.experimental.sessionReplay.quality = SentryReplayOptions.SentryReplayQuality.MEDIUM // (LOW|MEDIUM|HIGH)
+  }
+  ```
+
+  To learn more visit [Sentry's Mobile Session Replay](https://docs.sentry.io/product/explore/session-replay/mobile/) documentation page.
+
 ## 7.11.0
 
 ### Features

build.gradle.kts

@@ -112,6 +112,7 @@ subprojects {
         "sentry-android-ndk",
         "sentry-android-okhttp",
         "sentry-android-sqlite",
+        "sentry-android-replay",
         "sentry-android-timber"
     )
     if (jacocoAndroidModules.contains(name)) {
@@ -296,7 +297,9 @@ private val androidLibs = setOf(
     "sentry-android-navigation",
     "sentry-android-okhttp",
     "sentry-android-timber",
-    "sentry-compose-android"
+    "sentry-compose-android",
+    "sentry-android-sqlite",
+    "sentry-android-replay"
 )
 
 private val androidXLibs = listOf(

buildSrc/src/main/java/Config.kt

@@ -34,6 +34,7 @@ object Config {
 
         val minSdkVersion = 19
         val minSdkVersionOkHttp = 21
+        val minSdkVersionReplay = 19
         val minSdkVersionNdk = 19
         val minSdkVersionCompose = 21
         val targetSdkVersion = sdkVersion
@@ -194,6 +195,7 @@ object Config {
         val jsonUnit = "net.javacrumbs.json-unit:json-unit:2.32.0"
         val hsqldb = "org.hsqldb:hsqldb:2.6.1"
         val javaFaker = "com.github.javafaker:javafaker:1.0.2"
+        val msgpack = "org.msgpack:msgpack-core:0.9.8"
     }
 
     object QualityPlugins {

gradle.properties

@@ -10,7 +10,7 @@ android.useAndroidX=true
 android.defaults.buildfeatures.buildconfig=true
 
 # Release information
-versionName=7.11.0
+versionName=7.12.0-alpha.4
 
 # Override the SDK name on native crashes on Android
 sentryAndroidSdkName=sentry.native.android

sentry-android-core/api/sentry-android-core.api

@@ -184,9 +184,11 @@ public final class io/sentry/android/core/CurrentActivityIntegration : android/a
 public final class io/sentry/android/core/DeviceInfoUtil {
 	public fun <init> (Landroid/content/Context;Lio/sentry/android/core/SentryAndroidOptions;)V
 	public fun collectDeviceInformation (ZZ)Lio/sentry/protocol/Device;
+	public static fun getBatteryLevel (Landroid/content/Intent;Lio/sentry/SentryOptions;)Ljava/lang/Float;
 	public static fun getInstance (Landroid/content/Context;Lio/sentry/android/core/SentryAndroidOptions;)Lio/sentry/android/core/DeviceInfoUtil;
 	public fun getOperatingSystem ()Lio/sentry/protocol/OperatingSystem;
 	public fun getSideLoadedInfo ()Lio/sentry/android/core/ContextUtils$SideLoadedInfo;
+	public static fun isCharging (Landroid/content/Intent;Lio/sentry/SentryOptions;)Ljava/lang/Boolean;
 	public static fun resetInstance ()V
 }
 

sentry-android-core/build.gradle.kts

@@ -76,6 +76,7 @@ dependencies {
     api(projects.sentry)
     compileOnly(projects.sentryAndroidFragment)
     compileOnly(projects.sentryAndroidTimber)
+    compileOnly(projects.sentryAndroidReplay)
     compileOnly(projects.sentryCompose)
     compileOnly(projects.sentryComposeHelper)
 
@@ -104,6 +105,7 @@ dependencies {
     testImplementation(projects.sentryTestSupport)
     testImplementation(projects.sentryAndroidFragment)
     testImplementation(projects.sentryAndroidTimber)
+    testImplementation(projects.sentryAndroidReplay)
     testImplementation(projects.sentryComposeHelper)
     testImplementation(projects.sentryAndroidNdk)
     testRuntimeOnly(Config.Libs.composeUi)

sentry-android-core/proguard-rules.pro

@@ -72,3 +72,9 @@
 -keepnames class io.sentry.exception.SentryHttpClientException
 
 ##---------------End: proguard configuration for sentry-okhttp  ----------
+
+##---------------Begin: proguard configuration for sentry-android-replay  ----------
+-dontwarn io.sentry.android.replay.ReplayIntegration
+-dontwarn io.sentry.android.replay.DefaultReplayBreadcrumbConverter
+-keepnames class io.sentry.android.replay.ReplayIntegration
+##---------------End: proguard configuration for sentry-android-replay  ----------

sentry-android-core/src/main/java/io/sentry/android/core/ActivityLifecycleIntegration.java

@@ -371,7 +371,7 @@ private void finishTransaction(
   public synchronized void onActivityCreated(
       final @NotNull Activity activity, final @Nullable Bundle savedInstanceState) {
     setColdStart(savedInstanceState);
-    if (hub != null) {
+    if (hub != null && options != null && options.isEnableScreenTracking()) {
       final @Nullable String activityClassName = ClassUtil.getClassName(activity);
       hub.configureScope(scope -> scope.setScreen(activityClassName));
     }

sentry-android-core/src/main/java/io/sentry/android/core/AndroidOptionsInitializer.java

@@ -22,13 +22,16 @@
 import io.sentry.android.core.internal.util.SentryFrameMetricsCollector;
 import io.sentry.android.core.performance.AppStartMetrics;
 import io.sentry.android.fragment.FragmentLifecycleIntegration;
+import io.sentry.android.replay.DefaultReplayBreadcrumbConverter;
+import io.sentry.android.replay.ReplayIntegration;
 import io.sentry.android.timber.SentryTimberIntegration;
 import io.sentry.cache.PersistingOptionsObserver;
 import io.sentry.cache.PersistingScopeObserver;
 import io.sentry.compose.gestures.ComposeGestureTargetLocator;
 import io.sentry.compose.viewhierarchy.ComposeViewHierarchyExporter;
 import io.sentry.internal.gestures.GestureTargetLocator;
 import io.sentry.internal.viewhierarchy.ViewHierarchyExporter;
+import io.sentry.transport.CurrentDateProvider;
 import io.sentry.transport.NoOpEnvelopeCache;
 import io.sentry.util.LazyEvaluator;
 import io.sentry.util.Objects;
@@ -237,7 +240,8 @@ static void installDefaultIntegrations(
       final @NotNull LoadClass loadClass,
       final @NotNull ActivityFramesTracker activityFramesTracker,
       final boolean isFragmentAvailable,
-      final boolean isTimberAvailable) {
+      final boolean isTimberAvailable,
+      final boolean isReplayAvailable) {
 
     // Integration MUST NOT cache option values in ctor, as they will be configured later by the
     // user
@@ -302,6 +306,13 @@ static void installDefaultIntegrations(
         new NetworkBreadcrumbsIntegration(context, buildInfoProvider, options.getLogger()));
     options.addIntegration(new TempSensorBreadcrumbsIntegration(context));
     options.addIntegration(new PhoneStateBreadcrumbsIntegration(context));
+    if (isReplayAvailable) {
+      final ReplayIntegration replay =
+          new ReplayIntegration(context, CurrentDateProvider.getInstance());
+      replay.setBreadcrumbConverter(new DefaultReplayBreadcrumbConverter());
+      options.addIntegration(replay);
+      options.setReplayController(replay);
+    }
   }
 
   /**

sentry-android-core/src/main/java/io/sentry/android/core/DefaultAndroidEventProcessor.java

@@ -10,6 +10,7 @@
 import io.sentry.SentryBaseEvent;
 import io.sentry.SentryEvent;
 import io.sentry.SentryLevel;
+import io.sentry.SentryReplayEvent;
 import io.sentry.android.core.internal.util.AndroidMainThreadChecker;
 import io.sentry.android.core.performance.AppStartMetrics;
 import io.sentry.android.core.performance.TimeSpan;
@@ -303,4 +304,17 @@ private void setSideLoadedInfo(final @NotNull SentryBaseEvent event) {
 
     return transaction;
   }
+
+  @Override
+  public @NotNull SentryReplayEvent process(
+      final @NotNull SentryReplayEvent event, final @NotNull Hint hint) {
+    final boolean applyScopeData = shouldApplyScopeData(event, hint);
+    if (applyScopeData) {
+      processNonCachedEvent(event, hint);
+    }
+
+    setCommons(event, false, applyScopeData);
+
+    return event;
+  }
 }