Merge branch 'perf/sdk-overhead-reduction' into perf/sdk-overhead-reduction-contexts-key-array

Author: adinauer

CHANGELOG.md

@@ -5,6 +5,10 @@
 ### Internal
 
 - Reduce context serialization overhead by sorting key snapshots with arrays instead of temporary lists. ([#5599](https://github.com/getsentry/sentry-java/pull/5599))
+- Reduce breadcrumb allocation overhead by creating the `Breadcrumb` data map only when data is added. ([#5598](https://github.com/getsentry/sentry-java/pull/5598))
+- Reduce JSON serialization overhead by lowering the initial `JsonWriter` nesting stack size while preserving on-demand growth. ([#5591](https://github.com/getsentry/sentry-java/pull/5591))
+- Reduce timestamp helper overhead by replacing unnecessary `Calendar` usage in `DateUtils` with direct `Date` creation. ([#5589](https://github.com/getsentry/sentry-java/pull/5589))
+- Reduce Android startup overhead by using the default timezone directly on older devices or when no timezone info is available in the locale. ([#5587](https://github.com/getsentry/sentry-java/pull/5587))
 
 ## 8.45.0
 

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

@@ -257,14 +257,19 @@ private void setDeviceIO(
   @SuppressWarnings("NewApi")
   @NotNull
   private TimeZone getTimeZone() {
-    if (buildInfoProvider.getSdkInfoVersion() >= Build.VERSION_CODES.N) {
+    // Only use the costly Calendar API on Android 13+ (API Level 33+) when the locale contains a
+    // Unicode timezone extension (for example "en-US-u-tz-usnyc"), because Calendar honors that
+    // extension. For all other cases, use the process default timezone directly for performance.
+    if (buildInfoProvider.getSdkInfoVersion() >= Build.VERSION_CODES.TIRAMISU) {
       LocaleList locales = context.getResources().getConfiguration().getLocales();
       if (!locales.isEmpty()) {
         Locale locale = locales.get(0);
-        return Calendar.getInstance(locale).getTimeZone();
+        if (locale.getUnicodeLocaleType("tz") != null) {
+          return Calendar.getInstance(locale).getTimeZone();
+        }
       }
     }
-    return Calendar.getInstance().getTimeZone();
+    return TimeZone.getDefault();
   }
 
   @SuppressWarnings("JdkObsolete")

sentry-android-core/src/test/java/io/sentry/android/core/DeviceInfoUtilTest.kt

@@ -2,16 +2,22 @@ package io.sentry.android.core
 
 import android.content.Context
 import android.content.Intent
+import android.content.res.Configuration
 import android.os.BatteryManager
+import android.os.Build
+import android.os.LocaleList
 import androidx.test.core.app.ApplicationProvider
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import io.sentry.android.core.internal.util.CpuInfoUtils
+import java.util.Locale
+import java.util.TimeZone
 import kotlin.test.BeforeTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertNotNull
 import kotlin.test.assertNull
 import org.junit.runner.RunWith
+import org.robolectric.annotation.Config
 
 @RunWith(AndroidJUnit4::class)
 class DeviceInfoUtilTest {
@@ -47,6 +53,32 @@ class DeviceInfoUtilTest {
     assertNotNull(deviceInfo.memorySize)
   }
 
+  @Test
+  fun `sets default timezone`() {
+    val deviceInfoUtil = DeviceInfoUtil.getInstance(context, SentryAndroidOptions())
+    val deviceInfo = deviceInfoUtil.collectDeviceInformation(false, false)
+
+    assertEquals(TimeZone.getDefault(), deviceInfo.timezone)
+  }
+
+  @Test
+  @Config(sdk = [Build.VERSION_CODES.TIRAMISU])
+  fun `preserves timezone from locale unicode extension`() {
+    val defaultTimeZone = TimeZone.getDefault()
+    try {
+      TimeZone.setDefault(TimeZone.getTimeZone("UTC"))
+      val configuration = Configuration(context.resources.configuration)
+      configuration.setLocales(LocaleList(Locale.forLanguageTag("en-US-u-tz-usnyc")))
+      val localizedContext = context.createConfigurationContext(configuration)
+      val deviceInfoUtil = DeviceInfoUtil(localizedContext, SentryAndroidOptions())
+      val deviceInfo = deviceInfoUtil.collectDeviceInformation(false, false)
+
+      assertEquals("America/New_York", deviceInfo.timezone?.id)
+    } finally {
+      TimeZone.setDefault(defaultTimeZone)
+    }
+  }
+
   @Test
   fun `does include cpu data`() {
     CpuInfoUtils.getInstance().setCpuMaxFrequencies(listOf(1024))

sentry/src/main/java/io/sentry/Breadcrumb.java

@@ -34,8 +34,10 @@ public final class Breadcrumb implements JsonUnknown, JsonSerializable, Comparab
   /** The type of breadcrumb. */
   private @Nullable String type;
 
+  private static final @NotNull Map<String, @NotNull Object> EMPTY_DATA = Collections.emptyMap();
+
   /** Data associated with this breadcrumb. */
-  private @NotNull Map<String, @NotNull Object> data = new ConcurrentHashMap<>();
+  private volatile @NotNull Map<String, @NotNull Object> data = EMPTY_DATA;
 
   /** Dotted strings that indicate what the crumb is or where it comes from. */
   private @Nullable String category;
@@ -78,9 +80,11 @@ public Breadcrumb(final long timestamp) {
     this.type = breadcrumb.type;
     this.category = breadcrumb.category;
     this.origin = breadcrumb.origin;
-    final Map<String, Object> dataClone = CollectionUtils.newConcurrentHashMap(breadcrumb.data);
-    if (dataClone != null) {
-      this.data = dataClone;
+    if (!breadcrumb.data.isEmpty()) {
+      final Map<String, Object> dataClone = CollectionUtils.newConcurrentHashMap(breadcrumb.data);
+      if (dataClone != null) {
+        this.data = dataClone;
+      }
     }
     this.unknown = CollectionUtils.newConcurrentHashMap(breadcrumb.unknown);
     this.level = breadcrumb.level;
@@ -100,7 +104,7 @@ public static Breadcrumb fromMap(
     @NotNull Date timestamp = DateUtils.getCurrentDateTime();
     String message = null;
     String type = null;
-    @NotNull Map<String, Object> data = new ConcurrentHashMap<>();
+    Map<String, Object> data = null;
     String category = null;
     String origin = null;
     SentryLevel level = null;
@@ -129,6 +133,9 @@ public static Breadcrumb fromMap(
           if (untypedData != null) {
             for (Map.Entry<Object, Object> dataEntry : untypedData.entrySet()) {
               if (dataEntry.getKey() instanceof String && dataEntry.getValue() != null) {
+                if (data == null) {
+                  data = new ConcurrentHashMap<>();
+                }
                 data.put((String) dataEntry.getKey(), dataEntry.getValue());
               } else {
                 options
@@ -166,7 +173,9 @@ public static Breadcrumb fromMap(
     final Breadcrumb breadcrumb = new Breadcrumb(timestamp);
     breadcrumb.message = message;
     breadcrumb.type = type;
-    breadcrumb.data = data;
+    if (data != null) {
+      breadcrumb.data = data;
+    }
     breadcrumb.category = category;
     breadcrumb.origin = origin;
     breadcrumb.level = level;
@@ -494,7 +503,7 @@ public static Breadcrumb fromMap(
       breadcrumb.setData("view.tag", viewTag);
     }
     for (final Map.Entry<String, Object> entry : additionalData.entrySet()) {
-      breadcrumb.getData().put(entry.getKey(), entry.getValue());
+      breadcrumb.setData(entry.getKey(), entry.getValue());
     }
     breadcrumb.setLevel(SentryLevel.INFO);
     return breadcrumb;
@@ -555,7 +564,7 @@ public Breadcrumb(@Nullable String message) {
     if (timestamp != null) {
       return (Date) timestamp.clone();
     } else if (timestampMs != null) {
-      // we memoize it here into timestamp to avoid instantiating Calendar again and again
+      // we memoize it here into timestamp to avoid creating a Date again and again
       timestamp = DateUtils.getDateTime(timestampMs);
       return timestamp;
     }
@@ -598,6 +607,20 @@ public void setType(@Nullable String type) {
     this.type = type;
   }
 
+  private @NotNull Map<String, @NotNull Object> getOrCreateData() {
+    Map<String, @NotNull Object> currentData = data;
+    if (currentData == EMPTY_DATA) {
+      synchronized (this) {
+        currentData = data;
+        if (currentData == EMPTY_DATA) {
+          currentData = new ConcurrentHashMap<>();
+          data = currentData;
+        }
+      }
+    }
+    return currentData;
+  }
+
   /**
    * Returns the data map
    *
@@ -606,7 +629,7 @@ public void setType(@Nullable String type) {
   @ApiStatus.Internal
   @NotNull
   public Map<String, Object> getData() {
-    return data;
+    return getOrCreateData();
   }
 
   /**
@@ -636,7 +659,7 @@ public void setData(@Nullable String key, @Nullable Object value) {
     if (value == null) {
       removeData(key);
     } else {
-      data.put(key, value);
+      getOrCreateData().put(key, value);
     }
   }
 
@@ -649,7 +672,10 @@ public void removeData(@Nullable String key) {
     if (key == null) {
       return;
     }
-    data.remove(key);
+    final Map<String, @NotNull Object> currentData = data;
+    if (currentData != EMPTY_DATA) {
+      currentData.remove(key);
+    }
   }
 
   /**
@@ -859,7 +885,7 @@ public static final class Deserializer implements JsonDeserializer<Breadcrumb> {
       @NotNull Date timestamp = DateUtils.getCurrentDateTime();
       String message = null;
       String type = null;
-      @NotNull Map<String, Object> data = new ConcurrentHashMap<>();
+      Map<String, Object> data = null;
       String category = null;
       String origin = null;
       SentryLevel level = null;
@@ -884,7 +910,7 @@ public static final class Deserializer implements JsonDeserializer<Breadcrumb> {
             Map<String, Object> deserializedData =
                 CollectionUtils.newConcurrentHashMap(
                     (Map<String, Object>) reader.nextObjectOrNull());
-            if (deserializedData != null) {
+            if (deserializedData != null && !deserializedData.isEmpty()) {
               data = deserializedData;
             }
             break;
@@ -913,7 +939,9 @@ public static final class Deserializer implements JsonDeserializer<Breadcrumb> {
       Breadcrumb breadcrumb = new Breadcrumb(timestamp);
       breadcrumb.message = message;
       breadcrumb.type = type;
-      breadcrumb.data = data;
+      if (data != null) {
+        breadcrumb.data = data;
+      }
       breadcrumb.category = category;
       breadcrumb.origin = origin;
       breadcrumb.level = level;

sentry/src/main/java/io/sentry/DateUtils.java

@@ -1,13 +1,10 @@
 package io.sentry;
 
-import static io.sentry.vendor.gson.internal.bind.util.ISO8601Utils.TIMEZONE_UTC;
-
 import io.sentry.vendor.gson.internal.bind.util.ISO8601Utils;
 import java.math.BigDecimal;
 import java.math.RoundingMode;
 import java.text.ParseException;
 import java.text.ParsePosition;
-import java.util.Calendar;
 import java.util.Date;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
@@ -24,10 +21,9 @@ private DateUtils() {}
    *
    * @return the UTC Date
    */
-  @SuppressWarnings("JdkObsolete")
+  @SuppressWarnings("JavaUtilDate")
   public static @NotNull Date getCurrentDateTime() {
-    final Calendar calendar = Calendar.getInstance(TIMEZONE_UTC);
-    return calendar.getTime();
+    return new Date();
   }
 
   /**
@@ -78,10 +74,9 @@ private DateUtils() {}
    * @param millis the UTC millis from the epoch
    * @return the UTC Date
    */
+  @SuppressWarnings("JavaUtilDate")
   public static @NotNull Date getDateTime(final long millis) {
-    final Calendar calendar = Calendar.getInstance(TIMEZONE_UTC);
-    calendar.setTimeInMillis(millis);
-    return calendar.getTime();
+    return new Date(millis);
   }
 
   /**

sentry/src/main/java/io/sentry/vendor/gson/stream/JsonWriter.java

@@ -17,7 +17,7 @@
 // Source: https://github.com/google/gson
 // Tag: gson-parent-2.8.7
 // Commit Hash: 4520489c29e770c64b11ca35e0a0fdf17a1874ab
-// Changes: @ApiStatus.Internal, SuppressWarnings
+// Changes: @ApiStatus.Internal, SuppressWarnings, reduced stack size
 
 package io.sentry.vendor.gson.stream;
 
@@ -175,7 +175,7 @@ public class JsonWriter implements Closeable, Flushable {
   /** The output data, containing at most one top-level array or object. */
   private final Writer out;
 
-  private int[] stack = new int[32];
+  private int[] stack = new int[8];
   private int stackSize = 0;
   {
     push(EMPTY_DOCUMENT);

sentry/src/test/java/io/sentry/BreadcrumbTest.kt

@@ -1,6 +1,9 @@
 package io.sentry
 
 import java.util.Date
+import java.util.concurrent.CountDownLatch
+import java.util.concurrent.Executors
+import java.util.concurrent.TimeUnit
 import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFalse
@@ -329,6 +332,39 @@ class BreadcrumbTest {
     breadcrumb.removeData(null)
   }
 
+  @Test
+  fun `getData returns mutable map for new breadcrumb`() {
+    val breadcrumb = Breadcrumb()
+
+    breadcrumb.data["k"] = "v"
+
+    assertEquals("v", breadcrumb.getData("k"))
+  }
+
+  @Test
+  fun `concurrent first writes keep all data entries`() {
+    val breadcrumb = Breadcrumb()
+    val count = 32
+    val executor = Executors.newFixedThreadPool(count)
+    val start = CountDownLatch(1)
+    val futures =
+      (0 until count).map { index ->
+        executor.submit {
+          start.await()
+          breadcrumb.setData("key-$index", index)
+        }
+      }
+
+    start.countDown()
+    futures.forEach { it.get(5, TimeUnit.SECONDS) }
+    executor.shutdown()
+
+    assertEquals(count, breadcrumb.data.size)
+    for (index in 0 until count) {
+      assertEquals(index, breadcrumb.data["key-$index"])
+    }
+  }
+
   class TestKey(val id: Long) {
     override fun toString(): String = id.toString()
   }

sentry/src/test/java/io/sentry/DateUtilsTest.kt

@@ -86,6 +86,7 @@ class DateUtilsTest {
     val utcActual = convertDate(actual)
     val timestamp = utcActual.format(isoFormat)
 
+    assertEquals(millis, actual.time)
     assertEquals("2020-06-07T12:38:12.631Z", timestamp)
   }