Merge branch 'rz/feat/session-replay-breadcrumbs-customizer' into rz/fix/session-replay-redaction

Author: romtsn

CHANGELOG.md

@@ -1,8 +1,19 @@
 # Changelog
 
-## 7.8.0-alpha.0
+## 7.9.0-alpha.1
 
-- No documented changes.
+- Session Replay for Android ([#3339](https://github.com/getsentry/sentry-java/pull/3339))
+
+We released our second Alpha version of the SDK with support. To get access, it requires adding your Sentry org to our feature flag. Please let us know on the [waitlist](https://sentry.io/lp/mobile-replay-beta/) if you're interested
+
+### Features
+
+- Add start_type to app context ([#3379](https://github.com/getsentry/sentry-java/pull/3379))
+
+### Fixes
+
+- Fix Frame measurements in app start transactions ([#3382](https://github.com/getsentry/sentry-java/pull/3382))
+- Fix timing metric value different from span duration ([#3368](https://github.com/getsentry/sentry-java/pull/3368))
 
 ## 7.8.0
 

gradle.properties

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

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

@@ -183,9 +183,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/proguard-rules.pro

@@ -75,6 +75,6 @@
 
 ##---------------Begin: proguard configuration for sentry-android-replay  ----------
 -dontwarn io.sentry.android.replay.ReplayIntegration
--dontwarn io.sentry.android.replay.ReplayIntegrationKt
+-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/AndroidOptionsInitializer.java

@@ -22,6 +22,7 @@
 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;
@@ -308,6 +309,7 @@ static void installDefaultIntegrations(
     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/DeviceInfoUtil.java

@@ -16,6 +16,7 @@
 import android.util.DisplayMetrics;
 import io.sentry.DateUtils;
 import io.sentry.SentryLevel;
+import io.sentry.SentryOptions;
 import io.sentry.android.core.internal.util.CpuInfoUtils;
 import io.sentry.android.core.internal.util.DeviceOrientations;
 import io.sentry.android.core.internal.util.RootChecker;
@@ -184,8 +185,8 @@ public ContextUtils.SideLoadedInfo getSideLoadedInfo() {
   private void setDeviceIO(final @NotNull Device device, final boolean includeDynamicData) {
     final Intent batteryIntent = getBatteryIntent();
     if (batteryIntent != null) {
-      device.setBatteryLevel(getBatteryLevel(batteryIntent));
-      device.setCharging(isCharging(batteryIntent));
+      device.setBatteryLevel(getBatteryLevel(batteryIntent, options));
+      device.setCharging(isCharging(batteryIntent, options));
       device.setBatteryTemperature(getBatteryTemperature(batteryIntent));
     }
 
@@ -270,7 +271,8 @@ private Intent getBatteryIntent() {
    * @return the device's current battery level (as a percentage of total), or null if unknown
    */
   @Nullable
-  private Float getBatteryLevel(final @NotNull Intent batteryIntent) {
+  public static Float getBatteryLevel(
+      final @NotNull Intent batteryIntent, final @NotNull SentryOptions options) {
     try {
       int level = batteryIntent.getIntExtra(BatteryManager.EXTRA_LEVEL, -1);
       int scale = batteryIntent.getIntExtra(BatteryManager.EXTRA_SCALE, -1);
@@ -294,7 +296,8 @@ private Float getBatteryLevel(final @NotNull Intent batteryIntent) {
    * @return whether or not the device is currently plugged in and charging, or null if unknown
    */
   @Nullable
-  private Boolean isCharging(final @NotNull Intent batteryIntent) {
+  public static Boolean isCharging(
+      final @NotNull Intent batteryIntent, final @NotNull SentryOptions options) {
     try {
       int plugged = batteryIntent.getIntExtra(BatteryManager.EXTRA_PLUGGED, -1);
       return plugged == BatteryManager.BATTERY_PLUGGED_AC

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

@@ -16,6 +16,7 @@
 import io.sentry.android.core.performance.ActivityLifecycleTimeSpan;
 import io.sentry.android.core.performance.AppStartMetrics;
 import io.sentry.android.core.performance.TimeSpan;
+import io.sentry.protocol.App;
 import io.sentry.protocol.MeasurementValue;
 import io.sentry.protocol.SentryId;
 import io.sentry.protocol.SentrySpan;
@@ -79,27 +80,40 @@ public SentryEvent process(@NotNull SentryEvent event, @NotNull Hint hint) {
 
     // the app start measurement is only sent once and only if the transaction has
     // the app.start span, which is automatically created by the SDK.
-    if (!sentStartMeasurement && hasAppStartSpan(transaction)) {
-      final @NotNull TimeSpan appStartTimeSpan =
-          AppStartMetrics.getInstance().getAppStartTimeSpanWithFallback(options);
-      final long appStartUpDurationMs = appStartTimeSpan.getDurationMs();
-
-      // if appStartUpDurationMs is 0, metrics are not ready to be sent
-      if (appStartUpDurationMs != 0) {
-        final MeasurementValue value =
-            new MeasurementValue(
-                (float) appStartUpDurationMs, MeasurementUnit.Duration.MILLISECOND.apiName());
-
-        final String appStartKey =
-            AppStartMetrics.getInstance().getAppStartType() == AppStartMetrics.AppStartType.COLD
-                ? MeasurementValue.KEY_APP_START_COLD
-                : MeasurementValue.KEY_APP_START_WARM;
-
-        transaction.getMeasurements().put(appStartKey, value);
-
-        attachColdAppStartSpans(AppStartMetrics.getInstance(), transaction);
-        sentStartMeasurement = true;
+    if (hasAppStartSpan(transaction)) {
+      if (!sentStartMeasurement) {
+        final @NotNull TimeSpan appStartTimeSpan =
+            AppStartMetrics.getInstance().getAppStartTimeSpanWithFallback(options);
+        final long appStartUpDurationMs = appStartTimeSpan.getDurationMs();
+
+        // if appStartUpDurationMs is 0, metrics are not ready to be sent
+        if (appStartUpDurationMs != 0) {
+          final MeasurementValue value =
+              new MeasurementValue(
+                  (float) appStartUpDurationMs, MeasurementUnit.Duration.MILLISECOND.apiName());
+
+          final String appStartKey =
+              AppStartMetrics.getInstance().getAppStartType() == AppStartMetrics.AppStartType.COLD
+                  ? MeasurementValue.KEY_APP_START_COLD
+                  : MeasurementValue.KEY_APP_START_WARM;
+
+          transaction.getMeasurements().put(appStartKey, value);
+
+          attachColdAppStartSpans(AppStartMetrics.getInstance(), transaction);
+          sentStartMeasurement = true;
+        }
+      }
+
+      @Nullable App appContext = transaction.getContexts().getApp();
+      if (appContext == null) {
+        appContext = new App();
+        transaction.getContexts().setApp(appContext);
       }
+      final String appStartType =
+          AppStartMetrics.getInstance().getAppStartType() == AppStartMetrics.AppStartType.COLD
+              ? "cold"
+              : "warm";
+      appContext.setStartType(appStartType);
     }
 
     final SentryId eventId = transaction.getEventId();

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

@@ -36,8 +36,6 @@ public final class SentryAndroid {
   static final String SENTRY_REPLAY_INTEGRATION_CLASS_NAME =
       "io.sentry.android.replay.ReplayIntegration";
 
-  private static boolean isReplayAvailable = false;
-
   private static final String TIMBER_CLASS_NAME = "timber.log.Timber";
   private static final String FRAGMENT_CLASS_NAME =
       "androidx.fragment.app.FragmentManager$FragmentLifecycleCallbacks";
@@ -104,7 +102,7 @@ public static synchronized void init(
             final boolean isTimberAvailable =
                 (isTimberUpstreamAvailable
                     && classLoader.isClassAvailable(SENTRY_TIMBER_INTEGRATION_CLASS_NAME, options));
-            isReplayAvailable =
+            final boolean isReplayAvailable =
                 classLoader.isClassAvailable(SENTRY_REPLAY_INTEGRATION_CLASS_NAME, options);
 
             final BuildInfoProvider buildInfoProvider = new BuildInfoProvider(logger);

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

@@ -7,6 +7,7 @@
 import io.sentry.NoOpTransaction;
 import io.sentry.SentryDate;
 import io.sentry.SentryNanotimeDate;
+import io.sentry.SentryTracer;
 import io.sentry.SpanDataConvention;
 import io.sentry.android.core.internal.util.SentryFrameMetricsCollector;
 import io.sentry.protocol.MeasurementValue;
@@ -135,11 +136,15 @@ private void captureFrameMetrics(@NotNull final ISpan span) {
         return;
       }
 
-      // ignore spans with no finish date
-      final @Nullable SentryDate spanFinishDate = span.getFinishDate();
+      // Ignore spans with no finish date, but SentryTracer is not finished when executing this
+      // callback, yet, so in that case we use the current timestamp.
+      final @Nullable SentryDate spanFinishDate =
+          span instanceof SentryTracer ? new SentryNanotimeDate() : span.getFinishDate();
       if (spanFinishDate == null) {
         return;
       }
+      // Note: The comparison between two values obtained by realNanos() works only if both are the
+      // same kind of dates (both are SentryNanotimeDate or both SentryLongDate)
       final long spanEndNanos = realNanos(spanFinishDate);
 
       final @NotNull SentryFrameMetrics frameMetrics = new SentryFrameMetrics();

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

@@ -6,6 +6,7 @@
 import static android.appwidget.AppWidgetManager.ACTION_APPWIDGET_UPDATE;
 import static android.content.Intent.ACTION_AIRPLANE_MODE_CHANGED;
 import static android.content.Intent.ACTION_APP_ERROR;
+import static android.content.Intent.ACTION_BATTERY_CHANGED;
 import static android.content.Intent.ACTION_BATTERY_LOW;
 import static android.content.Intent.ACTION_BATTERY_OKAY;
 import static android.content.Intent.ACTION_BOOT_COMPLETED;
@@ -41,10 +42,11 @@
 import io.sentry.Breadcrumb;
 import io.sentry.Hint;
 import io.sentry.IHub;
-import io.sentry.ILogger;
 import io.sentry.Integration;
 import io.sentry.SentryLevel;
 import io.sentry.SentryOptions;
+import io.sentry.android.core.internal.util.AndroidCurrentDateProvider;
+import io.sentry.android.core.internal.util.Debouncer;
 import io.sentry.util.Objects;
 import io.sentry.util.StringUtils;
 import java.io.Closeable;
@@ -120,7 +122,7 @@ public void register(final @NotNull IHub hub, final @NotNull SentryOptions optio
 
   private void startSystemEventsReceiver(
       final @NotNull IHub hub, final @NotNull SentryAndroidOptions options) {
-    receiver = new SystemEventsBroadcastReceiver(hub, options.getLogger());
+    receiver = new SystemEventsBroadcastReceiver(hub, options);
     final IntentFilter filter = new IntentFilter();
     for (String item : actions) {
       filter.addAction(item);
@@ -154,6 +156,7 @@ private void startSystemEventsReceiver(
     actions.add(ACTION_AIRPLANE_MODE_CHANGED);
     actions.add(ACTION_BATTERY_LOW);
     actions.add(ACTION_BATTERY_OKAY);
+    actions.add(ACTION_BATTERY_CHANGED);
     actions.add(ACTION_BOOT_COMPLETED);
     actions.add(ACTION_CAMERA_BUTTON);
     actions.add(ACTION_CONFIGURATION_CHANGED);
@@ -204,45 +207,69 @@ public void close() throws IOException {
 
   static final class SystemEventsBroadcastReceiver extends BroadcastReceiver {
 
+    private static final long DEBOUNCE_WAIT_TIME_MS = 60 * 1000;
     private final @NotNull IHub hub;
-    private final @NotNull ILogger logger;
+    private final @NotNull SentryAndroidOptions options;
+    private final @NotNull Debouncer debouncer =
+        new Debouncer(AndroidCurrentDateProvider.getInstance(), DEBOUNCE_WAIT_TIME_MS, 0);
 
-    SystemEventsBroadcastReceiver(final @NotNull IHub hub, final @NotNull ILogger logger) {
+    SystemEventsBroadcastReceiver(
+        final @NotNull IHub hub, final @NotNull SentryAndroidOptions options) {
       this.hub = hub;
-      this.logger = logger;
+      this.options = options;
     }
 
     @Override
     public void onReceive(Context context, Intent intent) {
+      final boolean shouldDebounce = debouncer.checkForDebounce();
+      final String action = intent.getAction();
+      final boolean isBatteryChanged = ACTION_BATTERY_CHANGED.equals(action);
+      if (isBatteryChanged && shouldDebounce) {
+        // aligning with iOS which only captures battery status changes every minute at maximum
+        return;
+      }
+
       final Breadcrumb breadcrumb = new Breadcrumb();
       breadcrumb.setType("system");
       breadcrumb.setCategory("device.event");
-      final String action = intent.getAction();
       String shortAction = StringUtils.getStringAfterDot(action);
       if (shortAction != null) {
         breadcrumb.setData("action", shortAction);
       }
 
-      final Bundle extras = intent.getExtras();
-      final Map<String, String> newExtras = new HashMap<>();
-      if (extras != null && !extras.isEmpty()) {
-        for (String item : extras.keySet()) {
-          try {
-            @SuppressWarnings("deprecation")
-            Object value = extras.get(item);
-            if (value != null) {
-              newExtras.put(item, value.toString());
+      if (isBatteryChanged) {
+        final Float batteryLevel = DeviceInfoUtil.getBatteryLevel(intent, options);
+        if (batteryLevel != null) {
+          breadcrumb.setData("level", batteryLevel);
+        }
+        final Boolean isCharging = DeviceInfoUtil.isCharging(intent, options);
+        if (isCharging != null) {
+          breadcrumb.setData("charging", isCharging);
+        }
+      } else {
+        final Bundle extras = intent.getExtras();
+        final Map<String, String> newExtras = new HashMap<>();
+        if (extras != null && !extras.isEmpty()) {
+          for (String item : extras.keySet()) {
+            try {
+              @SuppressWarnings("deprecation")
+              Object value = extras.get(item);
+              if (value != null) {
+                newExtras.put(item, value.toString());
+              }
+            } catch (Throwable exception) {
+              options
+                  .getLogger()
+                  .log(
+                      SentryLevel.ERROR,
+                      exception,
+                      "%s key of the %s action threw an error.",
+                      item,
+                      action);
             }
-          } catch (Throwable exception) {
-            logger.log(
-                SentryLevel.ERROR,
-                exception,
-                "%s key of the %s action threw an error.",
-                item,
-                action);
           }
+          breadcrumb.setData("extras", newExtras);
         }
-        breadcrumb.setData("extras", newExtras);
       }
       breadcrumb.setLevel(SentryLevel.INFO);