for #10069 added AppLaunchTimeMeasurement.kt to handle logic of startup time for cold, warm, and hot startup types.
sraturi
4 years ago
committed by
Michael Comella
parent
6516eff5c8
commit
8f16f9cb37
@ -0,0 +1,80 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
package org.mozilla.fenix.components.metrics
|
||||
|
||||
import android.os.Process
|
||||
import android.os.SystemClock
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import kotlinx.coroutines.withContext
|
||||
import org.mozilla.fenix.components.metrics.Event.AppAllStartup.Type
|
||||
import org.mozilla.fenix.components.metrics.Event.AppAllStartup.Type.ERROR
|
||||
import org.mozilla.fenix.components.metrics.Event.AppAllStartup.Type.WARM
|
||||
import org.mozilla.fenix.components.metrics.Event.AppAllStartup.Type.HOT
|
||||
import org.mozilla.fenix.components.metrics.Event.AppAllStartup.Type.COLD
|
||||
import org.mozilla.fenix.perf.Stat
|
||||
|
||||
/**
|
||||
* Handles the logic of figuring out launch time for cold, warm and hot startup.
|
||||
*/
|
||||
class AppLaunchTimeMeasurement(private val stats: Stat = Stat()) {
|
||||
|
||||
private var isOnPreDrawCalled = false
|
||||
|
||||
private var applicationOnCreateTimeStampNanoSeconds: Long? = null
|
||||
private var homeActivityInitTimeStampNanoSeconds: Long? = null
|
||||
private var homeActivityOnRestartTimeStampNanoSeconds: Long? = null
|
||||
// we are considering screen to be visible after the first pre draw call.
|
||||
private var homeActivityOnPreDrawTimeStampNanoSeconds: Long? = null
|
||||
|
||||
fun onHomeActivityOnCreate(activityInitNanos: Long) {
|
||||
this.homeActivityInitTimeStampNanoSeconds = activityInitNanos
|
||||
}
|
||||
|
||||
fun onHomeActivityOnRestart(activityOnRestartNanos: Long = SystemClock.elapsedRealtimeNanos()) {
|
||||
homeActivityOnRestartTimeStampNanoSeconds = activityOnRestartNanos
|
||||
}
|
||||
|
||||
fun onFirstFramePreDraw(activityOnPreDrawNanos: Long = SystemClock.elapsedRealtimeNanos()) {
|
||||
isOnPreDrawCalled = true
|
||||
homeActivityOnPreDrawTimeStampNanoSeconds = activityOnPreDrawNanos
|
||||
}
|
||||
|
||||
/**
|
||||
* if we have both start and finish time for launch, return the difference otherwise return null.
|
||||
*/
|
||||
suspend fun getApplicationLaunchTime(startupType: Type): Long? = withContext(Dispatchers.IO) {
|
||||
when {
|
||||
// one use case is user launching the app and quicky pressing back button. in that case
|
||||
// there will be no onPredraw call but activity will call onStop().
|
||||
!isOnPreDrawCalled -> {
|
||||
null
|
||||
}
|
||||
else -> {
|
||||
when (startupType) {
|
||||
COLD -> {
|
||||
applicationOnCreateTimeStampNanoSeconds =
|
||||
stats.getProcessStartTimeStampNano(Process.myPid())
|
||||
homeActivityOnPreDrawTimeStampNanoSeconds!!.minus(
|
||||
applicationOnCreateTimeStampNanoSeconds!!
|
||||
)
|
||||
}
|
||||
WARM -> {
|
||||
homeActivityOnPreDrawTimeStampNanoSeconds!!.minus(
|
||||
homeActivityInitTimeStampNanoSeconds!!
|
||||
)
|
||||
}
|
||||
HOT -> {
|
||||
homeActivityOnPreDrawTimeStampNanoSeconds!!.minus(
|
||||
homeActivityOnRestartTimeStampNanoSeconds!!
|
||||
)
|
||||
}
|
||||
ERROR -> {
|
||||
null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,79 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
package org.mozilla.fenix.components.metrics
|
||||
|
||||
import android.os.SystemClock
|
||||
import io.mockk.MockKAnnotations
|
||||
import io.mockk.every
|
||||
import io.mockk.impl.annotations.MockK
|
||||
import kotlinx.coroutines.runBlocking
|
||||
import org.junit.Assert.assertTrue
|
||||
import org.junit.Before
|
||||
import org.junit.Test
|
||||
import org.mozilla.fenix.components.metrics.Event.AppAllStartup.Type.HOT
|
||||
import org.mozilla.fenix.components.metrics.Event.AppAllStartup.Type.COLD
|
||||
import org.mozilla.fenix.components.metrics.Event.AppAllStartup.Type.ERROR
|
||||
import org.mozilla.fenix.components.metrics.Event.AppAllStartup.Type.WARM
|
||||
import org.mozilla.fenix.perf.Stat
|
||||
|
||||
class AppLaunchTimeMeasurementTest {
|
||||
|
||||
@MockK
|
||||
private lateinit var statMock: Stat
|
||||
|
||||
private lateinit var appLaunchTimeMeasurement: AppLaunchTimeMeasurement
|
||||
private val startTime = SystemClock.elapsedRealtimeNanos()
|
||||
private val endTime = SystemClock.elapsedRealtimeNanos() + 1
|
||||
|
||||
@Before
|
||||
fun setUp() {
|
||||
MockKAnnotations.init(this)
|
||||
appLaunchTimeMeasurement = AppLaunchTimeMeasurement(statMock)
|
||||
|
||||
every { statMock.getProcessStartTimeStampNano(any()) } returns startTime
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `WHEN application is launched with cold startup THEN report the correct value`() {
|
||||
runBlocking {
|
||||
appLaunchTimeMeasurement.onFirstFramePreDraw(endTime)
|
||||
|
||||
val actualResult = endTime.minus(startTime)
|
||||
assertTrue(appLaunchTimeMeasurement.getApplicationLaunchTime(COLD) == actualResult)
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `WHEN application is launch with warm startup THEN report the correct value`() {
|
||||
appLaunchTimeMeasurement.onHomeActivityOnCreate(startTime)
|
||||
appLaunchTimeMeasurement.onFirstFramePreDraw(endTime)
|
||||
|
||||
val actualResult = endTime.minus(startTime)
|
||||
runBlocking {
|
||||
assertTrue(appLaunchTimeMeasurement.getApplicationLaunchTime(WARM) == actualResult)
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `WHEN application is launch with hot startup THEN report the correct value`() {
|
||||
appLaunchTimeMeasurement.onHomeActivityOnRestart(startTime)
|
||||
appLaunchTimeMeasurement.onFirstFramePreDraw(endTime)
|
||||
|
||||
val actualResult = endTime.minus(startTime)
|
||||
runBlocking {
|
||||
assertTrue(appLaunchTimeMeasurement.getApplicationLaunchTime(HOT) == actualResult)
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `WHEN getting launch time before onDraw() is called THEN report the correct value`() {
|
||||
appLaunchTimeMeasurement.onHomeActivityOnCreate(startTime)
|
||||
|
||||
val actualResult = null
|
||||
runBlocking {
|
||||
assertTrue(appLaunchTimeMeasurement.getApplicationLaunchTime(ERROR) == actualResult)
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue