Refactor retrieving advertisement id to Coroutines

parsely/src/main/java/com/parsely/parselyandroid/AdvertisementIdProvider.kt

@@ -0,0 +1,50 @@
+package com.parsely.parselyandroid
+
+import android.content.Context
+import android.provider.Settings
+import com.google.android.gms.ads.identifier.AdvertisingIdClient
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.launch
+
+internal class AdvertisementIdProvider(
+    private val context: Context,
+    coroutineScope: CoroutineScope
+) : IdProvider {
+
+    private var adKey: String? = null
+
+    init {
+        coroutineScope.launch {
+            try {
+                adKey = AdvertisingIdClient.getAdvertisingIdInfo(context).id
+            } catch (e: Exception) {
+                ParselyTracker.PLog("No Google play services or error!")
+            }
+        }
+    }
+
+    /**
+     * @return advertisement id if the coroutine in the constructor finished executing AdvertisingIdClient#getAdvertisingIdInfo
+     * null otherwise
+     */
+    override fun provide(): String? = adKey
+}
+
+internal class AndroidIdProvider(private val context: Context) : IdProvider {
+    override fun provide(): String? {
+        val uuid = try {
+            Settings.Secure.getString(
+                context.applicationContext.contentResolver,
+                Settings.Secure.ANDROID_ID
+            )
+        } catch (ex: Exception) {
+            null
+        }
+        ParselyTracker.PLog(String.format("Android ID: %s", uuid))
+        return uuid
+    }
+}
+
+internal fun interface IdProvider {
+    fun provide(): String?
+}

parsely/src/main/java/com/parsely/parselyandroid/DeviceInfoRepository.kt

@@ -0,0 +1,46 @@
+package com.parsely.parselyandroid
+
+import android.os.Build
+
+internal interface DeviceInfoRepository{
+    fun collectDeviceInfo(): Map<String, String>
+}
+
+internal open class AndroidDeviceInfoRepository(
+    private val advertisementIdProvider: IdProvider,
+    private val androidIdProvider: IdProvider,
+): DeviceInfoRepository {
+
+    /**
+     * Collect device-specific info.
+     *
+     *
+     * Collects info about the device and user to use in Parsely events.
+     */
+    override fun collectDeviceInfo(): Map<String, String> {
+        val dInfo: MutableMap<String, String> = HashMap()
+
+        // TODO: screen dimensions (maybe?)
+        dInfo["parsely_site_uuid"] = parselySiteUuid
+        dInfo["manufacturer"] = Build.MANUFACTURER
+        dInfo["os"] = "android"
+        dInfo["os_version"] = String.format("%d", Build.VERSION.SDK_INT)
+
+        return dInfo
+    }
+
+    private val parselySiteUuid: String
+        get() {
+            val adKey = advertisementIdProvider.provide()
+            val androidId = androidIdProvider.provide()
+
+            ParselyTracker.PLog("adkey is: %s, uuid is %s", adKey, androidId)
+
+            return if (adKey != null) {
+                adKey
+            } else {
+                ParselyTracker.PLog("falling back to device uuid")
+                androidId .orEmpty()
+            }
+        }
+}

parsely/src/main/java/com/parsely/parselyandroid/EventsBuilder.java

@@ -3,41 +3,27 @@
 import static com.parsely.parselyandroid.ParselyTracker.PLog;
 
 import android.content.Context;
-import android.content.SharedPreferences;
-import android.os.AsyncTask;
-import android.provider.Settings;
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 
-import com.google.android.gms.ads.identifier.AdvertisingIdClient;
-import com.google.android.gms.common.GooglePlayServicesNotAvailableException;
-import com.google.android.gms.common.GooglePlayServicesRepairableException;
-
-import java.io.IOException;
 import java.util.Calendar;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.TimeZone;
 
 class EventsBuilder {
-    private static final String UUID_KEY = "parsely-uuid";
     private static final String VIDEO_START_ID_KEY = "vsid";
     private static final String PAGE_VIEW_ID_KEY = "pvid";
 
-    @NonNull
-    private final Context context;
-    private final SharedPreferences settings;
     private final String siteId;
 
-    private Map<String, String> deviceInfo;
+    @NonNull
+    private final DeviceInfoRepository deviceInfoRepository;
 
-    public EventsBuilder(@NonNull final Context context, @NonNull final String siteId) {
-        this.context = context;
+    public EventsBuilder(@NonNull final DeviceInfoRepository deviceInfoRepository, @NonNull final String siteId) {
         this.siteId = siteId;
-        settings = context.getSharedPreferences("parsely-prefs", 0);
-        deviceInfo = collectDeviceInfo(null);
-        new GetAdKey(context).execute();
+        this.deviceInfoRepository = deviceInfoRepository;
     }
 
     /**
@@ -74,11 +60,11 @@ Map<String, Object> buildEvent(
         if (extraData != null) {
             data.putAll(extraData);
         }
-        data.put("manufacturer", deviceInfo.get("manufacturer"));
-        data.put("os", deviceInfo.get("os"));
-        data.put("os_version", deviceInfo.get("os_version"));
+
+        final Map<String, String> deviceInfo = deviceInfoRepository.collectDeviceInfo();
         data.put("ts", now.getTimeInMillis());
-        data.put("parsely_site_uuid", deviceInfo.get("parsely_site_uuid"));
+        data.putAll(deviceInfo);
+
         event.put("data", data);
 
         if (metadata != null) {
@@ -96,90 +82,4 @@ Map<String, Object> buildEvent(
         return event;
     }
 
-    /**
-     * Collect device-specific info.
-     * <p>
-     * Collects info about the device and user to use in Parsely events.
-     */
-    private Map<String, String> collectDeviceInfo(@Nullable final String adKey) {
-        Map<String, String> dInfo = new HashMap<>();
-
-        // TODO: screen dimensions (maybe?)
-        PLog("adkey is: %s, uuid is %s", adKey, getSiteUuid());
-        final String uuid = (adKey != null) ? adKey : getSiteUuid();
-        dInfo.put("parsely_site_uuid", uuid);
-        dInfo.put("manufacturer", android.os.Build.MANUFACTURER);
-        dInfo.put("os", "android");
-        dInfo.put("os_version", String.format("%d", android.os.Build.VERSION.SDK_INT));
-
-        // FIXME: Not passed in event or used anywhere else.
-        CharSequence txt = context.getPackageManager().getApplicationLabel(context.getApplicationInfo());
-        dInfo.put("appname", txt.toString());
-
-        return dInfo;
-    }
-
-    /**
-     * Get the UUID for this user.
-     */
-    //TODO: docs about where we get this UUID from and how.
-    private String getSiteUuid() {
-        String uuid = "";
-        try {
-            uuid = settings.getString(UUID_KEY, "");
-            if (uuid.equals("")) {
-                uuid = generateSiteUuid();
-            }
-        } catch (Exception ex) {
-            PLog("Exception caught during site uuid generation: %s", ex.toString());
-        }
-        return uuid;
-    }
-
-    /**
-     * Read the Parsely UUID from application context or make a new one.
-     *
-     * @return The UUID to use for this user.
-     */
-    private String generateSiteUuid() {
-        String uuid = Settings.Secure.getString(context.getApplicationContext().getContentResolver(),
-                Settings.Secure.ANDROID_ID);
-        PLog(String.format("Generated UUID: %s", uuid));
-        return uuid;
-    }
-    /**
-     * Async task to get adKey for this device.
-     */
-    private class GetAdKey extends AsyncTask<Void, Void, String> {
-        private final Context mContext;
-
-        public GetAdKey(Context context) {
-            mContext = context;
-        }
-
-        @Override
-        protected String doInBackground(Void... params) {
-            AdvertisingIdClient.Info idInfo = null;
-            String advertId = null;
-            try {
-                idInfo = AdvertisingIdClient.getAdvertisingIdInfo(mContext);
-            } catch (GooglePlayServicesRepairableException | IOException |
-                     GooglePlayServicesNotAvailableException | IllegalArgumentException e) {
-                PLog("No Google play services or error! falling back to device uuid");
-                // fall back to device uuid on google play errors
-                advertId = getSiteUuid();
-            }
-            try {
-                advertId = idInfo.getId();
-            } catch (NullPointerException e) {
-                advertId = getSiteUuid();
-            }
-            return advertId;
-        }
-
-        @Override
-        protected void onPostExecute(String advertId) {
-            deviceInfo = collectDeviceInfo(advertId);
-        }
-    }
 }

parsely/src/main/java/com/parsely/parselyandroid/ParselyTracker.java

@@ -70,7 +70,11 @@ public class ParselyTracker {
      */
     protected ParselyTracker(String siteId, int flushInterval, Context c) {
         context = c.getApplicationContext();
-        eventsBuilder = new EventsBuilder(context, siteId);
+        eventsBuilder = new EventsBuilder(
+                new AndroidDeviceInfoRepository(
+                        new AdvertisementIdProvider(context, ParselyCoroutineScopeKt.getSdkScope()),
+                        new AndroidIdProvider(context)
+                ), siteId);
         localStorageRepository = new LocalStorageRepository(context);
         flushManager = new ParselyFlushManager(new Function0<Unit>() {
             @Override

parsely/src/test/java/com/parsely/parselyandroid/AndroidDeviceInfoRepositoryTest.kt

@@ -0,0 +1,76 @@
+package com.parsely.parselyandroid
+
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.Before
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.robolectric.RobolectricTestRunner
+import org.robolectric.annotation.Config
+import org.robolectric.shadows.ShadowBuild
+
+private const val SDK_VERSION = 33
+private const val MANUFACTURER = "test manufacturer"
+
+@RunWith(RobolectricTestRunner::class)
+@Config(sdk = [SDK_VERSION])
+internal class AndroidDeviceInfoRepositoryTest {
+
+    @Before
+    fun setUp() {
+        ShadowBuild.setManufacturer(MANUFACTURER)
+    }
+
+    @Test
+    fun `given the advertisement id exists, when collecting device info, then parsely site uuid is advertisement id`() {
+        // given
+        val advertisementId = "ad id"
+        val sut = AndroidDeviceInfoRepository(
+            advertisementIdProvider = { advertisementId },
+            androidIdProvider = { "android id" })
+
+        // when
+        val result = sut.collectDeviceInfo()
+
+        // then
+        assertThat(result).isEqualTo(expectedConstantDeviceInfo + ("parsely_site_uuid" to advertisementId))
+    }
+
+    @Test
+    fun `given the advertisement is null and android id is not, when collecting device info, then parsely id is android id`() {
+        // given
+        val androidId = "android id"
+        val sut = AndroidDeviceInfoRepository(
+            advertisementIdProvider = { null },
+            androidIdProvider = { androidId }
+        )
+
+        // when
+        val result = sut.collectDeviceInfo()
+
+        // then
+        assertThat(result).isEqualTo(expectedConstantDeviceInfo + ("parsely_site_uuid" to androidId))
+    }
+
+    @Test
+    fun `given both advertisement id and android id are null, when collecting device info, then parsely id is empty`() {
+        // given
+        val sut = AndroidDeviceInfoRepository(
+            advertisementIdProvider = { null },
+            androidIdProvider = { null }
+        )
+
+        // when
+        val result = sut.collectDeviceInfo()
+
+        // then
+        assertThat(result).isEqualTo(expectedConstantDeviceInfo + ("parsely_site_uuid" to ""))
+    }
+
+    private companion object {
+        val expectedConstantDeviceInfo = mapOf(
+            "manufacturer" to MANUFACTURER,
+            "os" to "android",
+            "os_version" to "$SDK_VERSION"
+        )
+    }
+}

parsely/src/test/java/com/parsely/parselyandroid/AndroidIdProviderTest.kt

@@ -0,0 +1,56 @@
+package com.parsely.parselyandroid
+
+import android.app.Application
+import android.provider.Settings
+import androidx.test.core.app.ApplicationProvider
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.Before
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.robolectric.RobolectricTestRunner
+
+@RunWith(RobolectricTestRunner::class)
+internal class AndroidIdProviderTest {
+
+    lateinit var sut: AndroidIdProvider
+
+    @Before
+    fun setUp() {
+        sut = AndroidIdProvider(ApplicationProvider.getApplicationContext())
+    }
+
+    @Test
+    fun `given no site uuid is stored, when requesting uuid, then return ANDROID_ID value`() {
+        // given
+        val fakeAndroidId = "test id"
+        Settings.Secure.putString(
+            ApplicationProvider.getApplicationContext<Application>().contentResolver,
+            Settings.Secure.ANDROID_ID,
+            fakeAndroidId
+        )
+
+        // when
+        val result=  sut.provide()
+
+        // then
+        assertThat(result).isEqualTo(fakeAndroidId)
+    }
+
+    @Test
+    fun `given site uuid already requested, when requesting uuid, then return same uuid`() {
+        // given
+        val fakeAndroidId = "test id"
+        Settings.Secure.putString(
+            ApplicationProvider.getApplicationContext<Application>().contentResolver,
+            Settings.Secure.ANDROID_ID,
+            fakeAndroidId
+        )
+        val storedValue = sut.provide()
+
+        // when
+        val result = sut.provide()
+
+        // then
+        assertThat(result).isEqualTo(storedValue)
+    }
+}