fix(DeviceID): DeviceIdStore.load should be thread safe to avoid double device ID generation

Author: lemnik

bugsnag-android-core/detekt-baseline.xml

@@ -15,7 +15,7 @@
     <ID>LongParameterList:AppWithState.kt$AppWithState$( binaryArch: String?, id: String?, releaseStage: String?, version: String?, codeBundleId: String?, buildUuid: Provider&lt;String?>?, type: String?, versionCode: Number?, /** * The number of milliseconds the application was running before the event occurred */ var duration: Number?, /** * The number of milliseconds the application was running in the foreground before the * event occurred */ var durationInForeground: Number?, /** * Whether the application was in the foreground when the event occurred */ var inForeground: Boolean?, /** * Whether the application was launching when the event occurred */ var isLaunching: Boolean? )</ID>
     <ID>LongParameterList:AppWithState.kt$AppWithState$( binaryArch: String?, id: String?, releaseStage: String?, version: String?, codeBundleId: String?, buildUuid: String?, type: String?, versionCode: Number?, /** * The number of milliseconds the application was running before the event occurred */ duration: Number?, /** * The number of milliseconds the application was running in the foreground before the * event occurred */ durationInForeground: Number?, /** * Whether the application was in the foreground when the event occurred */ inForeground: Boolean?, /** * Whether the application was launching when the event occurred */ isLaunching: Boolean? )</ID>
     <ID>LongParameterList:AppWithState.kt$AppWithState$( config: ImmutableConfig, binaryArch: String?, id: String?, releaseStage: String?, version: String?, codeBundleId: String?, duration: Number?, durationInForeground: Number?, inForeground: Boolean?, isLaunching: Boolean? )</ID>
-    <ID>LongParameterList:DataCollectionModule.kt$DataCollectionModule$( contextModule: ContextModule, configModule: ConfigModule, systemServiceModule: SystemServiceModule, trackerModule: TrackerModule, bgTaskService: BackgroundTaskService, connectivity: Connectivity, deviceIdStore: Provider&lt;DeviceIdStore>, memoryTrimState: MemoryTrimState, clientObservable: ClientObservable )</ID>
+    <ID>LongParameterList:DataCollectionModule.kt$DataCollectionModule$( contextModule: ContextModule, configModule: ConfigModule, systemServiceModule: SystemServiceModule, trackerModule: TrackerModule, bgTaskService: BackgroundTaskService, connectivity: Connectivity, deviceId: Provider&lt;DeviceIdStore.DeviceIds?>, memoryTrimState: MemoryTrimState, clientObservable: ClientObservable )</ID>
     <ID>LongParameterList:Device.kt$Device$( buildInfo: DeviceBuildInfo, /** * The Application Binary Interface used */ var cpuAbi: Array&lt;String>?, /** * Whether the device has been jailbroken */ var jailbroken: Boolean?, /** * A UUID generated by Bugsnag and used for the individual application on a device */ var id: String?, /** * The IETF language tag of the locale used */ var locale: String?, /** * The total number of bytes of memory on the device */ var totalMemory: Long?, /** * A collection of names and their versions of the primary languages, frameworks or * runtimes that the application is running on */ runtimeVersions: MutableMap&lt;String, Any>? )</ID>
     <ID>LongParameterList:DeviceBuildInfo.kt$DeviceBuildInfo$( val manufacturer: String?, val model: String?, val osVersion: String?, val apiLevel: Int?, val osBuild: String?, val fingerprint: String?, val tags: String?, val brand: String?, val cpuAbis: Array&lt;String>? )</ID>
     <ID>LongParameterList:DeviceDataCollector.kt$DeviceDataCollector$( private val connectivity: Connectivity, private val appContext: Context, resources: Resources, private val deviceIdStore: Provider&lt;DeviceIdStore.DeviceIds?>, private val buildInfo: DeviceBuildInfo, private val dataDirectory: File, private val rootedFuture: Provider&lt;Boolean>?, private val bgTaskService: BackgroundTaskService, private val logger: Logger )</ID>

bugsnag-android-core/src/main/java/com/bugsnag/android/Client.java

@@ -194,7 +194,7 @@ public Unit invoke(Boolean hasConnection, String networkState) {
 
         DataCollectionModule dataCollectionModule = new DataCollectionModule(contextModule,
                 configModule, systemServiceModule, trackerModule,
-                bgTaskService, connectivity, storageModule.getDeviceIdStore(),
+                bgTaskService, connectivity, storageModule.getDeviceId(),
                 memoryTrimState, clientObservable);
 
         // load the device + user information

bugsnag-android-core/src/main/java/com/bugsnag/android/DataCollectionModule.kt

@@ -20,7 +20,7 @@ internal class DataCollectionModule(
     trackerModule: TrackerModule,
     bgTaskService: BackgroundTaskService,
     connectivity: Connectivity,
-    deviceIdStore: Provider<DeviceIdStore>,
+    deviceId: Provider<DeviceIdStore.DeviceIds?>,
     memoryTrimState: MemoryTrimState,
     clientObservable: ClientObservable
 ) : BackgroundDependencyModule(bgTaskService) {
@@ -51,7 +51,7 @@ internal class DataCollectionModule(
             connectivity,
             ctx,
             ctx.resources,
-            deviceIdStore.map { it.load() },
+            deviceId,
             deviceBuildInfo,
             dataDir,
             rootDetection,

bugsnag-android-core/src/main/java/com/bugsnag/android/DeviceIdStore.kt

@@ -62,6 +62,7 @@ internal class DeviceIdStore @JvmOverloads @Suppress("LongParameterList") constr
         return internalPersistence.loadDeviceId(true)
     }
 
+    @Synchronized
     fun load(): DeviceIds? {
         if (deviceIds != null) {
             return deviceIds

bugsnag-android-core/src/main/java/com/bugsnag/android/StorageModule.kt

@@ -34,11 +34,15 @@ internal class StorageModule(
         )
     }
 
+    val deviceId = deviceIdStore.map {
+        it.load()
+    }
+
     val userStore = provider {
         UserStore(
             immutableConfig.persistUser,
             bugsnagDir,
-            deviceIdStore.map { it.load() },
+            deviceId,
             sharedPrefMigrator = sharedPrefMigrator,
             logger = immutableConfig.logger
         )