-
Notifications
You must be signed in to change notification settings - Fork 8
/
ModuleInitBootstrapper.kt
535 lines (469 loc) · 25.4 KB
/
ModuleInitBootstrapper.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
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
package io.embrace.android.embracesdk.injection
import android.content.Context
import io.embrace.android.embracesdk.Embrace.AppFramework
import io.embrace.android.embracesdk.anr.ndk.isUnityMainThread
import io.embrace.android.embracesdk.config.ConfigService
import io.embrace.android.embracesdk.internal.Systrace
import io.embrace.android.embracesdk.internal.network.http.HttpUrlConnectionTracker.registerFactory
import io.embrace.android.embracesdk.internal.utils.AndroidServicesModuleSupplier
import io.embrace.android.embracesdk.internal.utils.AnrModuleSupplier
import io.embrace.android.embracesdk.internal.utils.BuildVersionChecker
import io.embrace.android.embracesdk.internal.utils.CoreModuleSupplier
import io.embrace.android.embracesdk.internal.utils.CrashModuleSupplier
import io.embrace.android.embracesdk.internal.utils.CustomerLogModuleSupplier
import io.embrace.android.embracesdk.internal.utils.DataCaptureServiceModuleSupplier
import io.embrace.android.embracesdk.internal.utils.DataContainerModuleSupplier
import io.embrace.android.embracesdk.internal.utils.DataSourceModuleSupplier
import io.embrace.android.embracesdk.internal.utils.DeliveryModuleSupplier
import io.embrace.android.embracesdk.internal.utils.EssentialServiceModuleSupplier
import io.embrace.android.embracesdk.internal.utils.NativeModuleSupplier
import io.embrace.android.embracesdk.internal.utils.PayloadModuleSupplier
import io.embrace.android.embracesdk.internal.utils.Provider
import io.embrace.android.embracesdk.internal.utils.SdkObservabilityModuleSupplier
import io.embrace.android.embracesdk.internal.utils.SessionModuleSupplier
import io.embrace.android.embracesdk.internal.utils.StorageModuleSupplier
import io.embrace.android.embracesdk.internal.utils.SystemServiceModuleSupplier
import io.embrace.android.embracesdk.internal.utils.VersionChecker
import io.embrace.android.embracesdk.internal.utils.WorkerThreadModuleSupplier
import io.embrace.android.embracesdk.logging.InternalStaticEmbraceLogger
import io.embrace.android.embracesdk.ndk.NativeModule
import io.embrace.android.embracesdk.ndk.NativeModuleImpl
import io.embrace.android.embracesdk.session.properties.EmbraceSessionProperties
import io.embrace.android.embracesdk.worker.TaskPriority
import io.embrace.android.embracesdk.worker.WorkerName
import io.embrace.android.embracesdk.worker.WorkerThreadModule
import io.embrace.android.embracesdk.worker.WorkerThreadModuleImpl
import java.util.Locale
import java.util.concurrent.Future
import java.util.concurrent.TimeUnit
import java.util.concurrent.atomic.AtomicReference
import kotlin.math.max
import kotlin.reflect.KClass
/**
* A class that wires together and initializes modules in a manner that makes them work as a cohesive whole.
*/
internal class ModuleInitBootstrapper(
val initModule: InitModule = InitModuleImpl(),
val openTelemetryModule: OpenTelemetryModule = OpenTelemetryModuleImpl(initModule),
private val coreModuleSupplier: CoreModuleSupplier = ::CoreModuleImpl,
private val systemServiceModuleSupplier: SystemServiceModuleSupplier = ::SystemServiceModuleImpl,
private val androidServicesModuleSupplier: AndroidServicesModuleSupplier = ::AndroidServicesModuleImpl,
private val workerThreadModuleSupplier: WorkerThreadModuleSupplier = ::WorkerThreadModuleImpl,
private val storageModuleSupplier: StorageModuleSupplier = ::StorageModuleImpl,
private val essentialServiceModuleSupplier: EssentialServiceModuleSupplier = ::EssentialServiceModuleImpl,
private val dataCaptureServiceModuleSupplier: DataCaptureServiceModuleSupplier = ::DataCaptureServiceModuleImpl,
private val deliveryModuleSupplier: DeliveryModuleSupplier = ::DeliveryModuleImpl,
private val anrModuleSupplier: AnrModuleSupplier = ::AnrModuleImpl,
private val sdkObservabilityModuleSupplier: SdkObservabilityModuleSupplier = ::SdkObservabilityModuleImpl,
private val customerLogModuleSupplier: CustomerLogModuleSupplier = ::CustomerLogModuleImpl,
private val nativeModuleSupplier: NativeModuleSupplier = ::NativeModuleImpl,
private val dataContainerModuleSupplier: DataContainerModuleSupplier = ::DataContainerModuleImpl,
private val dataSourceModuleSupplier: DataSourceModuleSupplier = ::DataSourceModuleImpl,
private val sessionModuleSupplier: SessionModuleSupplier = ::SessionModuleImpl,
private val crashModuleSupplier: CrashModuleSupplier = ::CrashModuleImpl,
private val payloadModuleSupplier: PayloadModuleSupplier = ::PayloadModuleImpl,
) {
lateinit var coreModule: CoreModule
private set
lateinit var workerThreadModule: WorkerThreadModule
private set
lateinit var systemServiceModule: SystemServiceModule
private set
lateinit var androidServicesModule: AndroidServicesModule
private set
lateinit var storageModule: StorageModule
private set
lateinit var essentialServiceModule: EssentialServiceModule
private set
lateinit var dataCaptureServiceModule: DataCaptureServiceModule
private set
lateinit var deliveryModule: DeliveryModule
private set
lateinit var anrModule: AnrModule
private set
lateinit var sdkObservabilityModule: SdkObservabilityModule
private set
lateinit var customerLogModule: CustomerLogModule
private set
lateinit var nativeModule: NativeModule
private set
lateinit var dataContainerModule: DataContainerModule
private set
lateinit var dataSourceModule: DataSourceModule
private set
lateinit var sessionModule: SessionModule
private set
lateinit var crashModule: CrashModule
private set
lateinit var payloadModule: PayloadModule
private set
private val asyncInitTask = AtomicReference<Future<*>?>(null)
@Volatile
private var synchronousInitCompletionMs: Long = -1L
@Volatile
private var asyncInitCompletionMs: Long = -1L
/**
* Returns true when the call has triggered an initialization, false if initialization is already in progress or is complete.
*/
@JvmOverloads
fun init(
context: Context,
enableIntegrationTesting: Boolean,
appFramework: AppFramework,
sdkStartTimeMs: Long,
customAppId: String? = null,
configServiceProvider: Provider<ConfigService?> = { null },
versionChecker: VersionChecker = BuildVersionChecker,
): Boolean {
try {
Systrace.startSynchronous("modules-init")
if (isInitialized()) {
return false
}
synchronized(asyncInitTask) {
return if (!isInitialized()) {
coreModule = init(CoreModule::class) { coreModuleSupplier(context, appFramework) }
workerThreadModule = init(WorkerThreadModule::class) { workerThreadModuleSupplier(initModule) }
val initTask = postInit(OpenTelemetryModule::class) {
workerThreadModule.backgroundWorker(WorkerName.BACKGROUND_REGISTRATION).submit(TaskPriority.CRITICAL) {
Systrace.traceSynchronous("span-service-init") {
openTelemetryModule.spanService.initializeService(sdkStartTimeMs)
}
asyncInitCompletionMs = initModule.clock.now()
}
}
val serviceRegistry = coreModule.serviceRegistry
postInit(OpenTelemetryModule::class) {
serviceRegistry.registerService(initModule.telemetryService)
serviceRegistry.registerService(openTelemetryModule.spanService)
}
systemServiceModule = init(SystemServiceModule::class) {
systemServiceModuleSupplier(coreModule, versionChecker)
}
androidServicesModule = init(AndroidServicesModule::class) {
androidServicesModuleSupplier(initModule, coreModule, workerThreadModule)
}
postInit(AndroidServicesModule::class) {
serviceRegistry.registerService(androidServicesModule.preferencesService)
}
storageModule = init(StorageModule::class) {
storageModuleSupplier(initModule, coreModule, workerThreadModule)
}
essentialServiceModule = init(EssentialServiceModule::class) {
essentialServiceModuleSupplier(
initModule,
coreModule,
workerThreadModule,
systemServiceModule,
androidServicesModule,
storageModule,
customAppId,
enableIntegrationTesting,
configServiceProvider
)
}
postInit(EssentialServiceModule::class) {
serviceRegistry.registerServices(
essentialServiceModule.processStateService,
essentialServiceModule.metadataService,
essentialServiceModule.configService,
essentialServiceModule.activityLifecycleTracker,
essentialServiceModule.networkConnectivityService,
essentialServiceModule.userService
)
val networkBehavior = essentialServiceModule.configService.networkBehavior
if (networkBehavior.isNativeNetworkingMonitoringEnabled()) {
registerFactory(networkBehavior.isRequestContentLengthCaptureEnabled())
}
// only call after ConfigService has initialized.
essentialServiceModule.metadataService.precomputeValues()
}
dataCaptureServiceModule = init(DataCaptureServiceModule::class) {
dataCaptureServiceModuleSupplier(
initModule,
openTelemetryModule,
coreModule,
systemServiceModule,
essentialServiceModule,
workerThreadModule,
versionChecker
)
}
Systrace.traceSynchronous("startup-tracker") {
coreModule.application.registerActivityLifecycleCallbacks(
dataCaptureServiceModule.startupTracker
)
}
postInit(DataCaptureServiceModule::class) {
serviceRegistry.registerServices(
dataCaptureServiceModule.webviewService,
dataCaptureServiceModule.memoryService,
dataCaptureServiceModule.componentCallbackService,
dataCaptureServiceModule.powerSaveModeService,
dataCaptureServiceModule.breadcrumbService,
dataCaptureServiceModule.pushNotificationService,
dataCaptureServiceModule.thermalStatusService
)
}
deliveryModule = init(DeliveryModule::class) {
deliveryModuleSupplier(coreModule, workerThreadModule, storageModule, essentialServiceModule)
}
postInit(DeliveryModule::class) {
serviceRegistry.registerService(deliveryModule.deliveryService)
}
/** Since onForeground() is called sequential in the order that services registered for it,
* it is important to initialize the `EmbraceAnrService`, and thus register the `onForeground()
* listener for it, before the `EmbraceSessionService`.
* The onForeground() call inside the EmbraceAnrService should be called before the
* EmbraceSessionService call. This is necessary since the EmbraceAnrService should be able to
* force a Main thread health check and close the pending ANR intervals that happened on the
* background before the next session is created.
* */
anrModule = init(AnrModule::class) {
anrModuleSupplier(initModule, coreModule, essentialServiceModule, workerThreadModule)
}
postInit(AnrModule::class) {
serviceRegistry.registerServices(
anrModule.anrService,
anrModule.responsivenessMonitorService
)
// set callbacks and pass in non-placeholder config.
anrModule.anrService.finishInitialization(
essentialServiceModule.configService
)
}
// initialize the logger early so that logged exceptions have a good chance of
// being appended to the exceptions service rather than logcat
sdkObservabilityModule = init(SdkObservabilityModule::class) {
sdkObservabilityModuleSupplier(initModule, essentialServiceModule)
}
postInit(SdkObservabilityModule::class) {
serviceRegistry.registerService(sdkObservabilityModule.internalErrorService)
InternalStaticEmbraceLogger.logger.addLoggerAction(sdkObservabilityModule.internalErrorLogger)
}
val sessionProperties = Systrace.traceSynchronous("session-properties-init") {
EmbraceSessionProperties(
androidServicesModule.preferencesService,
essentialServiceModule.configService,
coreModule.logger
)
}
customerLogModule = init(CustomerLogModule::class) {
customerLogModuleSupplier(
initModule,
coreModule,
openTelemetryModule,
androidServicesModule,
essentialServiceModule,
deliveryModule,
sessionProperties,
workerThreadModule
)
}
postInit(CustomerLogModule::class) {
serviceRegistry.registerServices(
customerLogModule.logMessageService,
customerLogModule.logService,
customerLogModule.networkCaptureService,
customerLogModule.networkLoggingService
)
// Start the log orchestrator
customerLogModule.logOrchestrator
}
nativeModule = init(NativeModule::class) {
nativeModuleSupplier(
coreModule,
storageModule,
essentialServiceModule,
deliveryModule,
androidServicesModule,
sessionProperties,
workerThreadModule
)
}
postInit(NativeModule::class) {
val ndkService = nativeModule.ndkService
val initWorkerTaskQueueTime = initModule.clock.now()
workerThreadModule.backgroundWorker(WorkerName.SERVICE_INIT).submit {
val taskRuntimeMs = initModule.clock.now()
dataCaptureServiceModule.appStartupTraceEmitter.addTrackedInterval(
name = "init-worker-schedule-delay",
startTimeMs = initWorkerTaskQueueTime,
endTimeMs = taskRuntimeMs
)
}
serviceRegistry.registerServices(
ndkService,
nativeModule.nativeThreadSamplerService
)
if (essentialServiceModule.configService.autoDataCaptureBehavior.isNdkEnabled()) {
essentialServiceModule.sessionIdTracker.ndkService = nativeModule.ndkService
}
if (nativeModule.nativeThreadSamplerInstaller != null) {
// install the native thread sampler
nativeModule.nativeThreadSamplerService?.let { nativeThreadSamplerService ->
nativeThreadSamplerService.setupNativeSampler()
// In Unity this should always run on the Unity thread.
if (coreModule.appFramework == AppFramework.UNITY && isUnityMainThread()) {
try {
if (nativeModule.nativeThreadSamplerInstaller != null) {
nativeModule.nativeThreadSamplerInstaller?.monitorCurrentThread(
nativeThreadSamplerService,
essentialServiceModule.configService,
anrModule.anrService
)
} else {
InternalStaticEmbraceLogger.logger.logWarning(
"nativeThreadSamplerInstaller not started, cannot sample current thread"
)
}
} catch (t: Throwable) {
InternalStaticEmbraceLogger.logger.logError("Failed to sample current thread during ANRs", t)
}
}
}
}
}
dataContainerModule = init(DataContainerModule::class) {
dataContainerModuleSupplier(
initModule,
openTelemetryModule,
coreModule,
workerThreadModule,
systemServiceModule,
androidServicesModule,
essentialServiceModule,
dataCaptureServiceModule,
anrModule,
customerLogModule,
deliveryModule,
nativeModule,
sessionProperties,
sdkStartTimeMs
)
}
postInit(NativeModule::class) {
serviceRegistry.registerServices(
dataContainerModule.performanceInfoService,
dataContainerModule.eventService,
dataContainerModule.applicationExitInfoService
)
}
dataSourceModule = init(DataSourceModule::class) {
dataSourceModuleSupplier(
essentialServiceModule,
initModule,
openTelemetryModule,
systemServiceModule,
androidServicesModule,
workerThreadModule
)
}
sessionModule = init(SessionModule::class) {
sessionModuleSupplier(
initModule,
openTelemetryModule,
androidServicesModule,
essentialServiceModule,
nativeModule,
dataContainerModule,
deliveryModule,
sessionProperties,
dataCaptureServiceModule,
customerLogModule,
sdkObservabilityModule,
workerThreadModule,
dataSourceModule
)
}
crashModule = init(CrashModule::class) {
crashModuleSupplier(
initModule,
storageModule,
essentialServiceModule,
deliveryModule,
nativeModule,
sessionModule,
anrModule,
dataContainerModule,
androidServicesModule
)
}
payloadModule = init(PayloadModule::class) {
payloadModuleSupplier(
essentialServiceModule,
nativeModule,
openTelemetryModule,
sdkObservabilityModule
)
}
postInit(CrashModule::class) {
Thread.setDefaultUncaughtExceptionHandler(crashModule.automaticVerificationExceptionHandler)
serviceRegistry.registerService(crashModule.crashService)
}
// Sets up the registered services. This method is called after the SDK has been started and no more services can
// be added to the registry. It sets listeners for any services that were registered.
serviceRegistry.closeRegistration()
serviceRegistry.registerActivityListeners(essentialServiceModule.processStateService)
serviceRegistry.registerConfigListeners(essentialServiceModule.configService)
serviceRegistry.registerMemoryCleanerListeners(essentialServiceModule.memoryCleanerService)
serviceRegistry.registerActivityLifecycleListeners(essentialServiceModule.activityLifecycleTracker)
asyncInitTask.set(initTask)
synchronousInitCompletionMs = initModule.clock.now()
true
} else {
false
}
}
} finally {
Systrace.endSynchronous()
}
}
/**
* A blocking get that returns when the async portion of initialization is complete. An exception will be thrown by the underlying
* [Future] if there is a timeout or if this failed for other reasons.
*/
@JvmOverloads
fun waitForAsyncInit(timeout: Long = 5L, unit: TimeUnit = TimeUnit.SECONDS) {
Systrace.traceSynchronous("async-init-wait") {
asyncInitTask.get()?.get(timeout, unit)
}
Systrace.traceSynchronous("record-delay") {
// If async init finished after synchronous init, there's a delay so record that delay
// Otherwise, record a 0-duration span to signify there was no significant wait
val delayStartMs = synchronousInitCompletionMs
val delayEndMs = max(synchronousInitCompletionMs, asyncInitCompletionMs)
if (delayStartMs > 0) {
dataCaptureServiceModule.appStartupTraceEmitter.addTrackedInterval(
name = "async-init-delay",
startTimeMs = delayStartMs,
endTimeMs = delayEndMs
)
}
}
}
fun stopServices() {
if (isInitialized()) {
return
}
synchronized(asyncInitTask) {
if (isInitialized()) {
InternalStaticEmbraceLogger.logger.logDeveloper("Embrace", "Attempting to close services...")
coreModule.serviceRegistry.close()
InternalStaticEmbraceLogger.logger.logDeveloper("Embrace", "Services closed")
workerThreadModule.close()
essentialServiceModule.processStateService.close()
} else {
asyncInitTask.set(null)
}
}
}
private fun isInitialized(): Boolean = asyncInitTask.get() != null
private fun <T> init(module: KClass<*>, provider: Provider<T>): T =
Systrace.traceSynchronous("${toSectionName(module)}-init") { provider() }
private fun <T> postInit(module: KClass<*>, code: () -> T): T =
Systrace.traceSynchronous("${toSectionName(module)}-post-init") { code() }
// This is called twice for each input - memoizing/caching is not worth the hassle
private fun toSectionName(klass: KClass<*>): String =
klass.simpleName?.removeSuffix("Module")?.toLowerCase(Locale.ENGLISH) ?: "module"
}