Fix timestamp intervals of PerformanceCollectionData in profiles (getsentry#2648)

stefanosiano · web-flow · commit 06866407be13 · 2023-04-12T15:26:52.000+02:00
* fixed timestamps of PerformanceCollectionData in profiles
* updated ui test to cover all measurements cases
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@
 
 ### Fixes
 
+- Fix timestamp intervals of PerformanceCollectionData in profiles ([#2648](https://github.com/getsentry/sentry-java/pull/2648))
 - Fix timestamps of PerformanceCollectionData in profiles ([#2632](https://github.com/getsentry/sentry-java/pull/2632))
 - Fix missing propagateMinConstraints flag for SentryTraced ([#2637](https://github.com/getsentry/sentry-java/pull/2637))
 
diff --git a/sentry-android-core/src/main/java/io/sentry/android/core/AndroidTransactionProfiler.java b/sentry-android-core/src/main/java/io/sentry/android/core/AndroidTransactionProfiler.java
@@ -433,7 +433,9 @@ private void putPerformanceCollectionDataInMeasurements(
     // terms of System.currentTimeMillis() and measurements timestamps require the nanoseconds since
     // the beginning, expressed with SystemClock.elapsedRealtimeNanos()
     long timestampDiff =
-        SystemClock.elapsedRealtimeNanos() - transactionStartNanos - System.currentTimeMillis();
+        SystemClock.elapsedRealtimeNanos()
+            - transactionStartNanos
+            - TimeUnit.MILLISECONDS.toNanos(System.currentTimeMillis());
     if (performanceCollectionData != null) {
       final @NotNull ArrayDeque<ProfileMeasurementValue> memoryUsageMeasurements =
           new ArrayDeque<>(performanceCollectionData.size());
@@ -447,17 +449,19 @@ private void putPerformanceCollectionDataInMeasurements(
         if (cpuData != null) {
           cpuUsageMeasurements.add(
               new ProfileMeasurementValue(
-                  cpuData.getTimestampMillis() + timestampDiff, cpuData.getCpuUsagePercentage()));
+                  TimeUnit.MILLISECONDS.toNanos(cpuData.getTimestampMillis()) + timestampDiff,
+                  cpuData.getCpuUsagePercentage()));
         }
         if (memoryData != null && memoryData.getUsedHeapMemory() > -1) {
           memoryUsageMeasurements.add(
               new ProfileMeasurementValue(
-                  memoryData.getTimestampMillis() + timestampDiff, memoryData.getUsedHeapMemory()));
+                  TimeUnit.MILLISECONDS.toNanos(memoryData.getTimestampMillis()) + timestampDiff,
+                  memoryData.getUsedHeapMemory()));
         }
         if (memoryData != null && memoryData.getUsedNativeMemory() > -1) {
           nativeMemoryUsageMeasurements.add(
               new ProfileMeasurementValue(
-                  memoryData.getTimestampMillis() + timestampDiff,
+                  TimeUnit.MILLISECONDS.toNanos(memoryData.getTimestampMillis()) + timestampDiff,
                   memoryData.getUsedNativeMemory()));
         }
       }
diff --git a/sentry-android-integration-tests/sentry-uitest-android/src/androidTest/java/io/sentry/uitest/android/EnvelopeTests.kt b/sentry-android-integration-tests/sentry-uitest-android/src/androidTest/java/io/sentry/uitest/android/EnvelopeTests.kt
@@ -88,9 +88,9 @@ class EnvelopeTests : BaseUiTest() {
                 val slowFrames = profilingTraceData.measurementsMap[ProfileMeasurement.ID_SLOW_FRAME_RENDERS]
                 val frozenFrames = profilingTraceData.measurementsMap[ProfileMeasurement.ID_FROZEN_FRAME_RENDERS]
                 val frameRates = profilingTraceData.measurementsMap[ProfileMeasurement.ID_SCREEN_FRAME_RATES]!!
-                val memoryStats = profilingTraceData.measurementsMap[ProfileMeasurement.ID_MEMORY_FOOTPRINT]!!
-                val memoryNativeStats = profilingTraceData.measurementsMap[ProfileMeasurement.ID_MEMORY_NATIVE_FOOTPRINT]!!
-                val cpuStats = profilingTraceData.measurementsMap[ProfileMeasurement.ID_CPU_USAGE]!!
+                val memoryStats = profilingTraceData.measurementsMap[ProfileMeasurement.ID_MEMORY_FOOTPRINT]
+                val memoryNativeStats = profilingTraceData.measurementsMap[ProfileMeasurement.ID_MEMORY_NATIVE_FOOTPRINT]
+                val cpuStats = profilingTraceData.measurementsMap[ProfileMeasurement.ID_CPU_USAGE]
                 // Slow and frozen frames can be null (in case there were none)
                 if (slowFrames != null) {
                     assertEquals(ProfileMeasurement.UNIT_NANOSECONDS, slowFrames.unit)
@@ -101,28 +101,35 @@ class EnvelopeTests : BaseUiTest() {
                 // There could be no slow/frozen frames, but we expect at least one frame rate
                 assertEquals(ProfileMeasurement.UNIT_HZ, frameRates.unit)
                 assertTrue(frameRates.values.isNotEmpty())
-                assertEquals(ProfileMeasurement.UNIT_BYTES, memoryStats.unit)
-                assertTrue(memoryStats.values.isNotEmpty())
-                assertEquals(ProfileMeasurement.UNIT_BYTES, memoryNativeStats.unit)
-                assertTrue(memoryNativeStats.values.isNotEmpty())
-                assertEquals(ProfileMeasurement.UNIT_PERCENT, cpuStats.unit)
-                assertTrue(cpuStats.values.isNotEmpty())
+                memoryStats?.let {
+                    assertEquals(ProfileMeasurement.UNIT_BYTES, it.unit)
+                    assertEquals(true, it.values.isNotEmpty())
+                }
+                memoryNativeStats?.let {
+                    assertEquals(ProfileMeasurement.UNIT_BYTES, it.unit)
+                    assertEquals(true, it.values.isNotEmpty())
+                }
+                cpuStats?.let {
+                    assertEquals(ProfileMeasurement.UNIT_PERCENT, it.unit)
+                    assertEquals(true, it.values.isNotEmpty())
+                }
 
                 // We allow measurements to be added since the start up to the end of the profile, with a small tolerance due to threading
-                val maxTimestampAllowed = profilingTraceData.durationNs.toLong() + TimeUnit.SECONDS.toNanos(1)
-
-                assertTrue((slowFrames?.values?.maxOf { it.relativeStartNs.toLong() } ?: 0) < maxTimestampAllowed)
-                assertTrue((slowFrames?.values?.minOf { it.relativeStartNs.toLong() } ?: 0) >= 0)
-                assertTrue((frozenFrames?.values?.maxOf { it.relativeStartNs.toLong() } ?: 0) < maxTimestampAllowed)
-                assertTrue((frozenFrames?.values?.minOf { it.relativeStartNs.toLong() } ?: 0) >= 0)
-                assertTrue(frameRates.values.maxOf { it.relativeStartNs.toLong() } < maxTimestampAllowed)
-                assertTrue(frameRates.values.minOf { it.relativeStartNs.toLong() } > 0)
-                assertTrue(memoryStats.values.maxOf { it.relativeStartNs.toLong() } < maxTimestampAllowed)
-                assertTrue(memoryStats.values.minOf { it.relativeStartNs.toLong() } > 0)
-                assertTrue(memoryNativeStats.values.maxOf { it.relativeStartNs.toLong() } < maxTimestampAllowed)
-                assertTrue(memoryNativeStats.values.minOf { it.relativeStartNs.toLong() } > 0)
-                assertTrue(cpuStats.values.maxOf { it.relativeStartNs.toLong() } < maxTimestampAllowed)
-                assertTrue(cpuStats.values.minOf { it.relativeStartNs.toLong() } > 0)
+                val maxTimestampAllowed = profilingTraceData.durationNs.toLong() + TimeUnit.SECONDS.toNanos(2)
+                val allMeasurements = profilingTraceData.measurementsMap.values
+
+                allMeasurements.filter { it.values.isNotEmpty() }.forEach { measurement ->
+                    val values = measurement.values.sortedBy { it.relativeStartNs.toLong() }
+                    // There should be no measurement before the profile starts
+                    assertTrue(values.first().relativeStartNs.toLong() > 0)
+                    // There should be no measurement after the profile ends
+                    assertTrue(values.last().relativeStartNs.toLong() < maxTimestampAllowed)
+
+                    // Timestamps of measurements should differ at least 10 milliseconds from each other
+                    (1 until values.size).forEach { i ->
+                        assertTrue(values[i].relativeStartNs.toLong() > values[i - 1].relativeStartNs.toLong() + TimeUnit.MILLISECONDS.toNanos(10))
+                    }
+                }
 
                 // We should find the transaction id that started the profiling in the list of transactions
                 val transactionData = profilingTraceData.transactions
diff --git a/sentry-samples/sentry-samples-android/src/main/AndroidManifest.xml b/sentry-samples/sentry-samples-android/src/main/AndroidManifest.xml
@@ -12,6 +12,8 @@
     <!-- Just some random permissions to showcase the permission context sent to Sentry -->
     <uses-permission android:name="android.permission.CAMERA"/>
     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
+    <!-- Needed by leakcanary.NotificationEventListener -->
+    <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>
 
     <!--  if your minSdkVersion < 16, this would make usable on minSdkVersion >= 14-->
     <uses-sdk
