Move pixel API to its own gradle lib module (#1103)

* Moved statistics package to its own module

* Added dagger as implementation to use Inject annotations

* Added common gradle module and moved WorkerInjectorPlugin to it

* Moved AppUrl to common module and fix pixel service and entity

* Moved Device.kt to common module and fix VERSION_NAME access

* Moved exception package to common module

* Removed default Build.VERSION_NAME from UncaughtExceptionEntity

* Fixed the AppInstallationReferrerStateListener<>AtbInitializer dependency

* Fixed tests

* Added test runner to common and statistics manifest

* Added dummy tests for CI

* added jUnit to refreshVersions

* Reverted change in RxPixelSenderTest as it stayed in the :app module

* Changed compileSdkVersion and targetSdkVersion to 29 in :common and :statistics and extracted common lib gradle config

Co-authored-by: David Gonzalez <[email protected]>

Author: aitorvs

app/build.gradle

@@ -11,12 +11,12 @@ ext {
 }
 
 android {
-    compileSdkVersion 29
+    compileSdkVersion compile_sdk
     ndkVersion '21.0.6113669'
     defaultConfig {
         applicationId "com.duckduckgo.mobile.android"
-        minSdkVersion 21
-        targetSdkVersion 29
+        minSdkVersion min_sdk
+        targetSdkVersion target_sdk
         versionCode buildVersionCode()
         versionName buildVersionName()
         testInstrumentationRunner "com.duckduckgo.app.TestRunner"
@@ -96,6 +96,9 @@ android {
 }
 
 dependencies {
+    implementation project(path: ':statistics')
+    implementation project(path: ':common')
+
     implementation AndroidX.legacy.supportV4
     debugImplementation Square.leakCanary.android
 
@@ -174,9 +177,6 @@ dependencies {
     // Lottie
     implementation "com.airbnb.android:lottie:_"
 
-    // Apache commons
-    implementation "org.apache.commons:commons-math3:_"
-
     // Play Store referrer library
     implementation("com.android.installreferrer:installreferrer:_")
 

app/src/androidTest/java/com/duckduckgo/app/di/StubStatisticsModule.kt

@@ -19,8 +19,8 @@ package com.duckduckgo.app.di
 import android.content.Context
 import com.duckduckgo.app.global.device.ContextDeviceInfo
 import com.duckduckgo.app.global.device.DeviceInfo
-import com.duckduckgo.app.referral.AppInstallationReferrerStateListener
 import com.duckduckgo.app.statistics.AtbInitializer
+import com.duckduckgo.app.statistics.AtbInitializerListener
 import com.duckduckgo.app.statistics.api.PixelSender
 import com.duckduckgo.app.statistics.api.StatisticsService
 import com.duckduckgo.app.statistics.api.StatisticsUpdater
@@ -84,9 +84,9 @@ class StubStatisticsModule {
     fun atbInitializer(
         statisticsDataStore: StatisticsDataStore,
         statisticsUpdater: StatisticsUpdater,
-        appReferrerStateListener: AppInstallationReferrerStateListener
+        listeners: Set<@JvmSuppressWildcards AtbInitializerListener>
     ): AtbInitializer {
-        return AtbInitializer(statisticsDataStore, statisticsUpdater, appReferrerStateListener)
+        return AtbInitializer(statisticsDataStore, statisticsUpdater, listeners)
     }
 
     @Provides

app/src/androidTest/java/com/duckduckgo/app/global/exception/UncaughtExceptionDaoTest.kt

@@ -77,9 +77,9 @@ class UncaughtExceptionDaoTest {
 
     @Test
     fun whenSeveralExceptionExistAndOneDeletedThenCorrectEntryIsRemoved() {
-        val exception1 = UncaughtExceptionEntity(id = 1, exceptionSource = GLOBAL, message = "foo1")
-        val exception2 = UncaughtExceptionEntity(id = 2, exceptionSource = ON_PROGRESS_CHANGED, message = "foo2")
-        val exception3 = UncaughtExceptionEntity(id = 3, exceptionSource = ON_PAGE_STARTED, message = "foo3")
+        val exception1 = UncaughtExceptionEntity(id = 1, exceptionSource = GLOBAL, message = "foo1", "version")
+        val exception2 = UncaughtExceptionEntity(id = 2, exceptionSource = ON_PROGRESS_CHANGED, message = "foo2", "version")
+        val exception3 = UncaughtExceptionEntity(id = 3, exceptionSource = ON_PAGE_STARTED, message = "foo3", "version")
         dao.add(exception1)
         dao.add(exception2)
         dao.add(exception3)
@@ -102,7 +102,7 @@ class UncaughtExceptionDaoTest {
 
     @Test
     fun whenExceptionRetrievedFromDatabaseThenAllDetailsRestored() {
-        val exception = UncaughtExceptionEntity(id = 1, exceptionSource = GLOBAL, message = "foo")
+        val exception = UncaughtExceptionEntity(id = 1, exceptionSource = GLOBAL, message = "foo", "version")
         dao.add(exception)
         val list = dao.all()
         assertEquals(1, list.size)
@@ -116,5 +116,5 @@ class UncaughtExceptionDaoTest {
     }
 
     private fun anUncaughtExceptionEntity(id: Long? = null) =
-        UncaughtExceptionEntity(id = id ?: 0, exceptionSource = GLOBAL, message = "foo")
+        UncaughtExceptionEntity(id = id ?: 0, exceptionSource = GLOBAL, message = "foo", "version")
 }

app/src/androidTest/java/com/duckduckgo/app/referral/StubAppReferrerFoundStateListener.kt

@@ -16,9 +16,13 @@
 
 package com.duckduckgo.app.referral
 
+import com.duckduckgo.app.statistics.AtbInitializerListener
 import kotlinx.coroutines.delay
 
-class StubAppReferrerFoundStateListener(private val referrer: String, private val mockDelayMs: Long = 0) : AppInstallationReferrerStateListener {
+class StubAppReferrerFoundStateListener(
+    private val referrer: String,
+    private val mockDelayMs: Long = 0
+) : AppInstallationReferrerStateListener, AtbInitializerListener {
     override suspend fun waitForReferrerCode(): ParsedReferrerResult {
         if (mockDelayMs > 0) delay(mockDelayMs)
 
@@ -27,4 +31,12 @@ class StubAppReferrerFoundStateListener(private val referrer: String, private va
 
     override fun initialiseReferralRetrieval() {
     }
+
+    override suspend fun beforeAtbInit() {
+        waitForReferrerCode()
+    }
+
+    override fun beforeAtbInitTimeoutMillis(): Long {
+        return mockDelayMs
+    }
 }

app/src/androidTest/java/com/duckduckgo/app/statistics/AtbInitializerTest.kt

@@ -16,7 +16,6 @@
 
 package com.duckduckgo.app.statistics
 
-import com.duckduckgo.app.referral.AppInstallationReferrerStateListener
 import com.duckduckgo.app.referral.StubAppReferrerFoundStateListener
 import com.duckduckgo.app.statistics.api.StatisticsUpdater
 import com.duckduckgo.app.statistics.store.StatisticsDataStore
@@ -34,15 +33,15 @@ class AtbInitializerTest {
 
     private val statisticsDataStore: StatisticsDataStore = mock()
     private val statisticsUpdater: StatisticsUpdater = mock()
-    private lateinit var appReferrerStateListener: AppInstallationReferrerStateListener
+    private lateinit var appReferrerStateListener: AtbInitializerListener
 
     @Test
     fun whenReferrerInformationInstantlyAvailableThenAtbInitialized() = runBlockingTest {
         whenever(statisticsDataStore.hasInstallationStatistics).thenReturn(false)
         appReferrerStateListener = StubAppReferrerFoundStateListener(referrer = "xx")
-        testee = AtbInitializer(statisticsDataStore, statisticsUpdater, appReferrerStateListener)
+        testee = AtbInitializer(statisticsDataStore, statisticsUpdater, setOf(appReferrerStateListener))
 
-        testee.initializeAfterReferrerAvailable()
+        testee.initialize()
 
         verify(statisticsUpdater).initializeAtb()
     }
@@ -51,9 +50,9 @@ class AtbInitializerTest {
     fun whenReferrerInformationQuicklyAvailableThenAtbInitialized() = runBlockingTest {
         whenever(statisticsDataStore.hasInstallationStatistics).thenReturn(false)
         appReferrerStateListener = StubAppReferrerFoundStateListener(referrer = "xx", mockDelayMs = 1000L)
-        testee = AtbInitializer(statisticsDataStore, statisticsUpdater, appReferrerStateListener)
+        testee = AtbInitializer(statisticsDataStore, statisticsUpdater, setOf(appReferrerStateListener))
 
-        testee.initializeAfterReferrerAvailable()
+        testee.initialize()
 
         verify(statisticsUpdater).initializeAtb()
     }
@@ -62,19 +61,19 @@ class AtbInitializerTest {
     fun whenReferrerInformationTimesOutThenAtbInitialized() = runBlockingTest {
         whenever(statisticsDataStore.hasInstallationStatistics).thenReturn(false)
         appReferrerStateListener = StubAppReferrerFoundStateListener(referrer = "xx", mockDelayMs = Long.MAX_VALUE)
-        testee = AtbInitializer(statisticsDataStore, statisticsUpdater, appReferrerStateListener)
+        testee = AtbInitializer(statisticsDataStore, statisticsUpdater, setOf(appReferrerStateListener))
 
-        testee.initializeAfterReferrerAvailable()
+        testee.initialize()
 
         verify(statisticsUpdater).initializeAtb()
     }
 
     @Test
     fun whenAlreadyInitializedThenRefreshCalled() = runBlockingTest {
         configureAlreadyInitialized()
-        testee = AtbInitializer(statisticsDataStore, statisticsUpdater, appReferrerStateListener)
+        testee = AtbInitializer(statisticsDataStore, statisticsUpdater, setOf(appReferrerStateListener))
 
-        testee.initializeAfterReferrerAvailable()
+        testee.initialize()
         verify(statisticsUpdater).refreshAppRetentionAtb()
     }
 

app/src/androidTest/java/com/duckduckgo/app/statistics/api/OfflinePixelSenderTest.kt

@@ -52,7 +52,7 @@ class OfflinePixelSenderTest {
 
     @Before
     fun before() {
-        val exceptionEntity = UncaughtExceptionEntity(1, UncaughtExceptionSource.GLOBAL, "test", 1588167165000, "version")
+        val exceptionEntity = UncaughtExceptionEntity(1, UncaughtExceptionSource.GLOBAL, "test", "version", 1588167165000)
 
         runBlocking<Unit> {
             whenever(mockPixel.sendPixel(any(), any(), any())).thenReturn(Completable.complete())

app/src/main/java/com/duckduckgo/app/di/PlayStoreReferralModule.kt

@@ -17,11 +17,11 @@
 package com.duckduckgo.app.di
 
 import android.content.Context
-import android.content.pm.PackageManager
 import com.duckduckgo.app.referral.*
-import com.duckduckgo.app.statistics.VariantManager
+import com.duckduckgo.app.statistics.AtbInitializerListener
 import dagger.Module
 import dagger.Provides
+import dagger.multibindings.IntoSet
 import javax.inject.Singleton
 
 @Module
@@ -35,14 +35,14 @@ class PlayStoreReferralModule {
     @Provides
     @Singleton
     fun appInstallationReferrerStateListener(
-        context: Context,
-        packageManager: PackageManager,
-        appInstallationReferrerParser: AppInstallationReferrerParser,
-        appReferrerDataStore: AppReferrerDataStore,
-        variantManager: VariantManager
-    ): AppInstallationReferrerStateListener {
-        return PlayStoreAppReferrerStateListener(context, packageManager, appInstallationReferrerParser, appReferrerDataStore, variantManager)
-    }
+        playStoreAppReferrerStateListener: PlayStoreAppReferrerStateListener
+    ): AppInstallationReferrerStateListener = playStoreAppReferrerStateListener
+
+    @Provides
+    @IntoSet
+    fun providedReferrerAtbInitializerListener(
+        playStoreAppReferrerStateListener: PlayStoreAppReferrerStateListener
+    ): AtbInitializerListener = playStoreAppReferrerStateListener
 
     @Provides
     @Singleton

app/src/main/java/com/duckduckgo/app/di/StatisticsModule.kt

@@ -21,8 +21,8 @@ import com.duckduckgo.app.global.db.AppDatabase
 import com.duckduckgo.app.global.device.ContextDeviceInfo
 import com.duckduckgo.app.global.device.DeviceInfo
 import com.duckduckgo.app.global.exception.UncaughtExceptionRepository
-import com.duckduckgo.app.referral.AppInstallationReferrerStateListener
 import com.duckduckgo.app.statistics.AtbInitializer
+import com.duckduckgo.app.statistics.AtbInitializerListener
 import com.duckduckgo.app.statistics.VariantManager
 import com.duckduckgo.app.statistics.api.*
 import com.duckduckgo.app.statistics.pixels.RxBasedPixel
@@ -86,9 +86,9 @@ class StatisticsModule {
     fun atbInitializer(
         statisticsDataStore: StatisticsDataStore,
         statisticsUpdater: StatisticsUpdater,
-        appReferrerStateListener: AppInstallationReferrerStateListener
+        listeners: Set<@JvmSuppressWildcards AtbInitializerListener>
     ): AtbInitializer {
-        return AtbInitializer(statisticsDataStore, statisticsUpdater, appReferrerStateListener)
+        return AtbInitializer(statisticsDataStore, statisticsUpdater, listeners)
     }
 
     @Singleton

app/src/main/java/com/duckduckgo/app/global/DuckDuckGoApplication.kt

@@ -329,7 +329,7 @@ open class DuckDuckGoApplication : HasAndroidInjector, Application(), LifecycleO
         notificationRegistrar.updateStatus()
         GlobalScope.launch {
             workScheduler.scheduleWork()
-            atbInitializer.initializeAfterReferrerAvailable()
+            atbInitializer.initialize()
         }
     }
 

app/src/main/java/com/duckduckgo/app/global/exception/UncaughtExceptionModule.kt

@@ -18,6 +18,7 @@ package com.duckduckgo.app.global.exception
 
 import com.duckduckgo.app.global.AlertingUncaughtExceptionHandler
 import com.duckduckgo.app.global.DispatcherProvider
+import com.duckduckgo.app.global.device.DeviceInfo
 import com.duckduckgo.app.statistics.store.OfflinePixelCountDataStore
 import dagger.Module
 import dagger.Provides
@@ -30,9 +31,10 @@ class UncaughtExceptionModule {
     @Singleton
     fun uncaughtWebViewExceptionRepository(
         uncaughtExceptionDao: UncaughtExceptionDao,
-        rootExceptionFinder: RootExceptionFinder
+        rootExceptionFinder: RootExceptionFinder,
+        deviceInfo: DeviceInfo
     ): UncaughtExceptionRepository {
-        return UncaughtExceptionRepositoryDb(uncaughtExceptionDao, rootExceptionFinder)
+        return UncaughtExceptionRepositoryDb(uncaughtExceptionDao, rootExceptionFinder, deviceInfo)
     }
 
     @Provides