-
Notifications
You must be signed in to change notification settings - Fork 8
/
AppStartupTraceEmitterTest.kt
508 lines (456 loc) · 21.8 KB
/
AppStartupTraceEmitterTest.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
package io.embrace.android.embracesdk.capture.startup
import android.os.Build
import androidx.test.ext.junit.runners.AndroidJUnit4
import io.embrace.android.embracesdk.arch.assertDoesNotHaveEmbraceAttribute
import io.embrace.android.embracesdk.arch.assertIsKeySpan
import io.embrace.android.embracesdk.arch.schema.KeySpan
import io.embrace.android.embracesdk.arch.schema.PrivateSpan
import io.embrace.android.embracesdk.concurrency.BlockableExecutorService
import io.embrace.android.embracesdk.fakes.FakeClock
import io.embrace.android.embracesdk.fakes.FakeClock.Companion.DEFAULT_FAKE_CURRENT_TIME
import io.embrace.android.embracesdk.fakes.FakeInternalErrorService
import io.embrace.android.embracesdk.fakes.injection.FakeInitModule
import io.embrace.android.embracesdk.findSpanAttribute
import io.embrace.android.embracesdk.internal.clock.nanosToMillis
import io.embrace.android.embracesdk.internal.spans.EmbraceSpanData
import io.embrace.android.embracesdk.internal.spans.SpanService
import io.embrace.android.embracesdk.internal.spans.SpanSink
import io.embrace.android.embracesdk.internal.utils.BuildVersionChecker
import io.embrace.android.embracesdk.logging.EmbLoggerImpl
import io.embrace.android.embracesdk.worker.BackgroundWorker
import org.junit.Assert.assertEquals
import org.junit.Before
import org.junit.Test
import org.junit.runner.RunWith
import org.robolectric.annotation.Config
/**
* The various combinations of OS capabilities mean we have to test the following Android versions:
*
* - 14+: cold start trace from process create to render, process requested time available, activity pre/post create available
* - 10 to 13: cold start trace from process create to render, process requested time NOT available, activity pre/post create available
* - 7 to 9: cold start trace from process create to activity resume, process requested + activity pre/post create times NOT available
* - 5 to 6.0.1: cold start trace application init if available (sdk init if not) to activity resume
*/
@RunWith(AndroidJUnit4::class)
internal class AppStartupTraceEmitterTest {
private var startupService: StartupService? = null
private lateinit var clock: FakeClock
private lateinit var spanSink: SpanSink
private lateinit var spanService: SpanService
private lateinit var fakeInternalErrorService: FakeInternalErrorService
private lateinit var logger: EmbLoggerImpl
private lateinit var backgroundWorker: BackgroundWorker
private lateinit var appStartupTraceEmitter: AppStartupTraceEmitter
@Before
fun setUp() {
clock = FakeClock()
val initModule = FakeInitModule(clock = clock)
backgroundWorker = BackgroundWorker(BlockableExecutorService())
spanSink = initModule.openTelemetryModule.spanSink
spanService = initModule.openTelemetryModule.spanService
spanService.initializeService(clock.now())
startupService = StartupServiceImpl(
spanService,
backgroundWorker
)
clock.tick(100L)
fakeInternalErrorService = FakeInternalErrorService()
logger = EmbLoggerImpl().apply { internalErrorService = fakeInternalErrorService }
appStartupTraceEmitter = AppStartupTraceEmitter(
clock = initModule.openTelemetryClock,
startupServiceProvider = { startupService },
spanService = spanService,
backgroundWorker = backgroundWorker,
versionChecker = BuildVersionChecker,
logger = logger
)
fakeInternalErrorService.throwables.clear()
}
@Config(sdk = [Build.VERSION_CODES.TIRAMISU])
@Test
fun `no crashes if startup service not available in T`() {
startupService = null
appStartupTraceEmitter.firstFrameRendered(STARTUP_ACTIVITY_NAME)
}
@Config(sdk = [Build.VERSION_CODES.TIRAMISU])
@Test
fun `verify cold start trace with every event triggered in T`() {
verifyColdStartWithRender(processCreateDelayMs = 0L)
}
@Config(sdk = [Build.VERSION_CODES.TIRAMISU])
@Test
fun `verify cold start trace without application init start and end triggered in T`() {
verifyColdStartWithRenderWithoutAppInitEvents(processCreateDelayMs = 0L)
}
@Config(sdk = [Build.VERSION_CODES.TIRAMISU])
@Test
fun `verify warm start trace without application init start and end triggered in T`() {
verifyWarmStartWithRenderWithoutAppInitEvents(processCreateDelayMs = 0L)
}
@Config(sdk = [Build.VERSION_CODES.S])
@Test
fun `no crashes if startup service not available in S`() {
startupService = null
appStartupTraceEmitter.firstFrameRendered(STARTUP_ACTIVITY_NAME)
}
@Config(sdk = [Build.VERSION_CODES.S])
@Test
fun `verify cold start trace with every event triggered in S`() {
verifyColdStartWithRender()
}
@Config(sdk = [Build.VERSION_CODES.S])
@Test
fun `verify cold start trace without application init start and end triggered in S`() {
verifyColdStartWithRenderWithoutAppInitEvents()
}
@Config(sdk = [Build.VERSION_CODES.S])
@Test
fun `verify warm start trace without application init start and end triggered in S`() {
verifyWarmStartWithRenderWithoutAppInitEvents()
}
@Config(sdk = [Build.VERSION_CODES.P])
@Test
fun `no crashes if startup service not available in P`() {
startupService = null
appStartupTraceEmitter.startupActivityResumed(STARTUP_ACTIVITY_NAME)
}
@Config(sdk = [Build.VERSION_CODES.P])
@Test
fun `verify cold start trace with every event triggered in P`() {
verifyColdStartWithResume()
}
@Config(sdk = [Build.VERSION_CODES.P])
@Test
fun `verify cold start trace without application init start and end triggered in P`() {
verifyColdStartWithResumeWithoutAppInitEvents()
}
@Config(sdk = [Build.VERSION_CODES.P])
@Test
fun `verify warm start trace without application init start and end triggered in O`() {
verifyWarmStartWithResumeWithoutAppInitEvents()
}
@Config(sdk = [Build.VERSION_CODES.M])
@Test
fun `no crashes if startup service not available in M`() {
startupService = null
appStartupTraceEmitter.startupActivityResumed(STARTUP_ACTIVITY_NAME)
}
@Config(sdk = [Build.VERSION_CODES.M])
@Test
fun `verify cold start trace with every event triggered in M`() {
verifyColdStartWithResume(trackProcessStart = false)
}
@Config(sdk = [Build.VERSION_CODES.M])
@Test
fun `verify cold start trace without application init start and end triggered in M`() {
verifyColdStartWithResumeWithoutAppInitEvents(trackProcessStart = false)
}
@Config(sdk = [Build.VERSION_CODES.M])
@Test
fun `verify warm start trace without application init start and end triggered in M`() {
verifyWarmStartWithResumeWithoutAppInitEvents()
}
@Config(sdk = [Build.VERSION_CODES.LOLLIPOP])
@Test
fun `no crashes if startup service not available in L`() {
startupService = null
appStartupTraceEmitter.startupActivityResumed(STARTUP_ACTIVITY_NAME)
}
@Config(sdk = [Build.VERSION_CODES.LOLLIPOP])
@Test
fun `verify cold start trace with every event triggered in L`() {
verifyColdStartWithResume(trackProcessStart = false)
}
@Config(sdk = [Build.VERSION_CODES.LOLLIPOP])
@Test
fun `verify cold start trace without application init start and end triggered in L`() {
verifyColdStartWithResumeWithoutAppInitEvents(trackProcessStart = false)
}
@Config(sdk = [Build.VERSION_CODES.LOLLIPOP])
@Test
fun `verify warm start trace without application init start and end triggered in L`() {
verifyWarmStartWithResumeWithoutAppInitEvents()
}
private fun verifyColdStartWithRender(processCreateDelayMs: Long? = null) {
clock.tick(100L)
appStartupTraceEmitter.applicationInitStart()
clock.tick(15L)
val sdkInitStart = clock.now()
clock.tick(30L)
val sdkInitEnd = clock.now()
clock.tick(400L)
appStartupTraceEmitter.applicationInitEnd()
val applicationInitEnd = clock.now()
clock.tick(50L)
checkNotNull(startupService).setSdkStartupInfo(sdkInitStart, sdkInitEnd, false, "main")
appStartupTraceEmitter.startupActivityPreCreated()
val startupActivityPreCreated = clock.now()
clock.tick()
appStartupTraceEmitter.startupActivityInitStart()
val startupActivityStart = clock.now()
clock.tick(180)
appStartupTraceEmitter.startupActivityPostCreated()
val startupActivityPostCreated = clock.now()
clock.tick()
appStartupTraceEmitter.startupActivityInitEnd()
val startupActivityEnd = clock.now()
clock.tick(15L)
appStartupTraceEmitter.startupActivityResumed(STARTUP_ACTIVITY_NAME)
clock.tick(199L)
appStartupTraceEmitter.firstFrameRendered(STARTUP_ACTIVITY_NAME)
val traceEnd = clock.now()
assertEquals(7, spanSink.completedSpans().size)
val spanMap = spanSink.completedSpans().associateBy { it.name }
val trace = checkNotNull(spanMap["emb-cold-time-to-initial-display"])
val processInit = checkNotNull(spanMap["emb-process-init"])
val embraceInit = checkNotNull(spanMap["emb-embrace-init"])
val activityInitDelay = checkNotNull(spanMap["emb-activity-init-gap"])
val activityCreate = checkNotNull(spanMap["emb-activity-create"])
val firstRender = checkNotNull(spanMap["emb-first-frame-render"])
assertTraceRoot(
trace = trace,
expectedStartTimeMs = DEFAULT_FAKE_CURRENT_TIME,
expectedEndTimeMs = traceEnd,
expectedProcessCreateDelayMs = processCreateDelayMs,
expectedActivityPreCreatedMs = startupActivityPreCreated,
expectedActivityPostCreatedMs = startupActivityPostCreated,
)
assertChildSpan(processInit, DEFAULT_FAKE_CURRENT_TIME, applicationInitEnd)
assertChildSpan(embraceInit, sdkInitStart, sdkInitEnd)
assertChildSpan(activityInitDelay, applicationInitEnd, startupActivityStart)
assertChildSpan(activityCreate, startupActivityStart, startupActivityEnd)
assertChildSpan(firstRender, startupActivityEnd, traceEnd)
assertEquals(0, fakeInternalErrorService.throwables.size)
}
private fun verifyColdStartWithRenderWithoutAppInitEvents(processCreateDelayMs: Long? = null) {
clock.tick(100L)
val sdkInitStart = clock.now()
clock.tick(30L)
val sdkInitEnd = clock.now()
clock.tick(400L)
checkNotNull(startupService).setSdkStartupInfo(sdkInitStart, sdkInitEnd, false, "main")
appStartupTraceEmitter.startupActivityPreCreated()
val startupActivityPreCreated = clock.now()
clock.tick()
appStartupTraceEmitter.startupActivityInitStart()
val startupActivityStart = clock.now()
clock.tick(180)
appStartupTraceEmitter.startupActivityPostCreated()
val startupActivityPostCreated = clock.now()
clock.tick()
appStartupTraceEmitter.startupActivityInitEnd()
val startupActivityEnd = clock.now()
clock.tick(15L)
appStartupTraceEmitter.startupActivityResumed(STARTUP_ACTIVITY_NAME)
clock.tick(199L)
appStartupTraceEmitter.firstFrameRendered(STARTUP_ACTIVITY_NAME)
val traceEnd = clock.now()
assertEquals(6, spanSink.completedSpans().size)
val spanMap = spanSink.completedSpans().associateBy { it.name }
val trace = checkNotNull(spanMap["emb-cold-time-to-initial-display"])
val embraceInit = checkNotNull(spanMap["emb-embrace-init"])
val activityInitDelay = checkNotNull(spanMap["emb-activity-init-gap"])
val activityCreate = checkNotNull(spanMap["emb-activity-create"])
val firstRender = checkNotNull(spanMap["emb-first-frame-render"])
assertTraceRoot(
trace = trace,
expectedStartTimeMs = DEFAULT_FAKE_CURRENT_TIME,
expectedEndTimeMs = traceEnd,
expectedProcessCreateDelayMs = processCreateDelayMs,
expectedActivityPreCreatedMs = startupActivityPreCreated,
expectedActivityPostCreatedMs = startupActivityPostCreated,
)
assertChildSpan(embraceInit, sdkInitStart, sdkInitEnd)
assertChildSpan(activityInitDelay, sdkInitEnd, startupActivityStart)
assertChildSpan(activityCreate, startupActivityStart, startupActivityEnd)
assertChildSpan(firstRender, startupActivityEnd, traceEnd)
assertEquals(0, fakeInternalErrorService.throwables.size)
}
private fun verifyColdStartWithResume(trackProcessStart: Boolean = true) {
clock.tick(100L)
appStartupTraceEmitter.applicationInitStart()
val applicationInitStart = clock.now()
clock.tick(10L)
val sdkInitStart = clock.now()
clock.tick(30L)
val sdkInitEnd = clock.now()
clock.tick(400L)
appStartupTraceEmitter.applicationInitEnd()
val applicationInitEnd = clock.now()
clock.tick(50L)
checkNotNull(startupService).setSdkStartupInfo(sdkInitStart, sdkInitEnd, false, "main")
appStartupTraceEmitter.startupActivityInitStart()
val startupActivityStart = clock.now()
clock.tick(180L)
appStartupTraceEmitter.startupActivityInitEnd()
val startupActivityEnd = clock.now()
clock.tick(15L)
appStartupTraceEmitter.startupActivityResumed(STARTUP_ACTIVITY_NAME)
val traceEnd = clock.now()
assertEquals(7, spanSink.completedSpans().size)
val spanMap = spanSink.completedSpans().associateBy { it.name }
val trace = checkNotNull(spanMap["emb-cold-time-to-initial-display"])
val processInit = checkNotNull(spanMap["emb-process-init"])
val embraceInit = checkNotNull(spanMap["emb-embrace-init"])
val activityInitDelay = checkNotNull(spanMap["emb-activity-init-gap"])
val activityCreate = checkNotNull(spanMap["emb-activity-create"])
val activityResume = checkNotNull(spanMap["emb-activity-resume"])
val traceStartMs = if (trackProcessStart) {
DEFAULT_FAKE_CURRENT_TIME
} else {
applicationInitStart
}
assertTraceRoot(
trace = trace,
expectedStartTimeMs = traceStartMs,
expectedEndTimeMs = traceEnd,
)
assertChildSpan(processInit, traceStartMs, applicationInitEnd)
assertChildSpan(embraceInit, sdkInitStart, sdkInitEnd)
assertChildSpan(activityInitDelay, applicationInitEnd, startupActivityStart)
assertChildSpan(activityCreate, startupActivityStart, startupActivityEnd)
assertChildSpan(activityResume, startupActivityEnd, traceEnd)
assertEquals(0, fakeInternalErrorService.throwables.size)
}
private fun verifyColdStartWithResumeWithoutAppInitEvents(trackProcessStart: Boolean = true) {
clock.tick(100L)
val sdkInitStart = clock.now()
clock.tick(30L)
val sdkInitEnd = clock.now()
clock.tick(400L)
checkNotNull(startupService).setSdkStartupInfo(sdkInitStart, sdkInitEnd, false, "main")
appStartupTraceEmitter.startupActivityInitStart()
val startupActivityStart = clock.now()
clock.tick(180L)
appStartupTraceEmitter.startupActivityInitEnd()
val startupActivityEnd = clock.now()
clock.tick(15L)
appStartupTraceEmitter.startupActivityResumed(STARTUP_ACTIVITY_NAME)
val traceEnd = clock.now()
assertEquals(6, spanSink.completedSpans().size)
val spanMap = spanSink.completedSpans().associateBy { it.name }
val trace = checkNotNull(spanMap["emb-cold-time-to-initial-display"])
val embraceInit = checkNotNull(spanMap["emb-embrace-init"])
val activityInitDelay = checkNotNull(spanMap["emb-activity-init-gap"])
val activityCreate = checkNotNull(spanMap["emb-activity-create"])
val activityResume = checkNotNull(spanMap["emb-activity-resume"])
val traceStartMs = if (trackProcessStart) {
DEFAULT_FAKE_CURRENT_TIME
} else {
sdkInitStart
}
assertTraceRoot(
trace = trace,
expectedStartTimeMs = traceStartMs,
expectedEndTimeMs = traceEnd,
)
assertChildSpan(embraceInit, sdkInitStart, sdkInitEnd)
assertChildSpan(activityInitDelay, sdkInitEnd, startupActivityStart)
assertChildSpan(activityCreate, startupActivityStart, startupActivityEnd)
assertChildSpan(activityResume, startupActivityEnd, traceEnd)
assertEquals(0, fakeInternalErrorService.throwables.size)
}
private fun verifyWarmStartWithRenderWithoutAppInitEvents(processCreateDelayMs: Long? = null) {
clock.tick(100L)
val sdkInitStart = clock.now()
clock.tick(30L)
val sdkInitEnd = clock.now()
checkNotNull(startupService).setSdkStartupInfo(sdkInitStart, sdkInitEnd, false, "main")
clock.tick(60001L)
appStartupTraceEmitter.startupActivityPreCreated()
val startupActivityPreCreated = clock.now()
clock.tick()
appStartupTraceEmitter.startupActivityInitStart()
val startupActivityStart = clock.now()
clock.tick(180)
appStartupTraceEmitter.startupActivityPostCreated()
val startupActivityPostCreated = clock.now()
clock.tick()
appStartupTraceEmitter.startupActivityInitEnd()
val startupActivityEnd = clock.now()
clock.tick(15L)
appStartupTraceEmitter.startupActivityResumed(STARTUP_ACTIVITY_NAME)
clock.tick(199L)
appStartupTraceEmitter.firstFrameRendered(STARTUP_ACTIVITY_NAME)
val traceEnd = clock.now()
assertEquals(4, spanSink.completedSpans().size)
val spanMap = spanSink.completedSpans().associateBy { it.name }
val trace = checkNotNull(spanMap["emb-warm-time-to-initial-display"])
val activityCreate = checkNotNull(spanMap["emb-activity-create"])
val firstRender = checkNotNull(spanMap["emb-first-frame-render"])
with(trace) {
assertTraceRoot(
trace = this,
expectedStartTimeMs = startupActivityStart,
expectedEndTimeMs = traceEnd,
expectedProcessCreateDelayMs = processCreateDelayMs,
expectedActivityPreCreatedMs = startupActivityPreCreated,
expectedActivityPostCreatedMs = startupActivityPostCreated,
)
assertEquals((startupActivityStart - sdkInitEnd).toString(), attributes["activity-init-gap-ms"])
assertEquals("30", attributes["embrace-init-duration-ms"])
}
assertChildSpan(activityCreate, startupActivityStart, startupActivityEnd)
assertChildSpan(firstRender, startupActivityEnd, traceEnd)
assertEquals(0, fakeInternalErrorService.throwables.size)
}
private fun verifyWarmStartWithResumeWithoutAppInitEvents() {
clock.tick(100L)
val sdkInitStart = clock.now()
clock.tick(30L)
val sdkInitEnd = clock.now()
checkNotNull(startupService).setSdkStartupInfo(sdkInitStart, sdkInitEnd, false, "main")
clock.tick(60001L)
appStartupTraceEmitter.startupActivityInitStart()
val startupActivityStart = clock.now()
clock.tick(180L)
appStartupTraceEmitter.startupActivityInitEnd()
val startupActivityEnd = clock.now()
clock.tick(15L)
appStartupTraceEmitter.startupActivityResumed(STARTUP_ACTIVITY_NAME)
val traceEnd = clock.now()
assertEquals(4, spanSink.completedSpans().size)
val spanMap = spanSink.completedSpans().associateBy { it.name }
val trace = checkNotNull(spanMap["emb-warm-time-to-initial-display"])
val activityCreate = checkNotNull(spanMap["emb-activity-create"])
val activityResume = checkNotNull(spanMap["emb-activity-resume"])
with(trace) {
assertTraceRoot(
trace = this,
expectedStartTimeMs = startupActivityStart,
expectedEndTimeMs = traceEnd,
)
assertEquals("60001", attributes["activity-init-gap-ms"])
assertEquals("30", attributes["embrace-init-duration-ms"])
}
assertChildSpan(activityCreate, startupActivityStart, startupActivityEnd)
assertChildSpan(activityResume, startupActivityEnd, traceEnd)
assertEquals(0, fakeInternalErrorService.throwables.size)
}
private fun assertTraceRoot(
trace: EmbraceSpanData,
expectedStartTimeMs: Long,
expectedEndTimeMs: Long,
expectedProcessCreateDelayMs: Long? = null,
expectedActivityPreCreatedMs: Long? = null,
expectedActivityPostCreatedMs: Long? = null,
) {
assertEquals(expectedStartTimeMs, trace.startTimeNanos.nanosToMillis())
assertEquals(expectedEndTimeMs, trace.endTimeNanos.nanosToMillis())
trace.assertDoesNotHaveEmbraceAttribute(PrivateSpan)
trace.assertIsKeySpan()
assertEquals(STARTUP_ACTIVITY_NAME, trace.findSpanAttribute("startup-activity-name"))
assertEquals(expectedProcessCreateDelayMs?.toString(), trace.attributes["process-create-delay-ms"])
assertEquals(expectedActivityPreCreatedMs?.toString(), trace.attributes["startup-activity-pre-created-ms"])
assertEquals(expectedActivityPostCreatedMs?.toString(), trace.attributes["startup-activity-post-created-ms"])
}
private fun assertChildSpan(span: EmbraceSpanData, expectedStartTimeNanos: Long, expectedEndTimeNanos: Long) {
assertEquals(expectedStartTimeNanos, span.startTimeNanos.nanosToMillis())
assertEquals(expectedEndTimeNanos, span.endTimeNanos.nanosToMillis())
span.assertDoesNotHaveEmbraceAttribute(PrivateSpan)
span.assertDoesNotHaveEmbraceAttribute(KeySpan)
}
companion object {
private const val STARTUP_ACTIVITY_NAME = "StartupActivity"
}
}