Merge pull request #474 from Countly/set_id_mode

Remove Secure.ANDROID_ID usage

Author: turtledreams

CHANGELOG.md

@@ -1,11 +1,15 @@
 ## XX.XX.XX
+* ! Minor breaking change ! Removed Secure.ANDROID_ID usage in device id generation. The SDK now exclusively uses random UUIDs for device id generation.
+
 * Added a Content feature method "refreshContentZone" that does a manual refresh.
 * Added a new interface "CountlyNotificationButtonURLHandler" to allow custom handling of URLs when notification buttons are clicked. Could be set by "CountlyConfigPush.setNotificationButtonURLHandler"
 
-* Deprecated the experimental configuration function enableServerConfiguration. It is now enabled by default and can be controlled directly from the server.
-
 * Mitigated an issue that caused PN message data collision if two message with same ID was received.
 
+* Removed the deprecated function "CountlyConfig.setIdMode(idMode)"
+
+* Deprecated the experimental configuration function enableServerConfiguration. It is now enabled by default and can be controlled directly from the server.
+
 ## 25.1.1
 * Mitigated an issue where after closing a content, they were not being fetched again.
 

sdk/src/androidTest/java/ly/count/android/sdk/CountlyConfigTests.java

@@ -110,7 +110,6 @@ public boolean filterCrash(String crash) {
         config.setCountlyStore(cs);
         config.checkForNativeCrashDumps(false);
         config.setDeviceId(s[2]);
-        config.setIdMode(DeviceIdType.DEVELOPER_SUPPLIED);
         config.setStarRatingSessionLimit(1335);
         config.setStarRatingCallback(rc);
         config.setStarRatingTextDismiss(s[3]);

sdk/src/androidTest/java/ly/count/android/sdk/DeviceIdTests.java

@@ -30,7 +30,7 @@ public void setUp() {
         Countly.sharedInstance().setLoggingEnabled(true);
 
         openUDIDProvider = new OpenUDIDProvider() {
-            @Override public String getOpenUDID() {
+            @Override public String getUUID() {
                 return currentOpenUDIDValue;
             }
         };
@@ -106,7 +106,7 @@ public void getType() {
         store.clear();
 
         assertEquals(DeviceIdType.OPEN_UDID, new DeviceId(null, store, mock(ModuleLog.class), new OpenUDIDProvider() {
-            @Override public String getOpenUDID() {
+            @Override public String getUUID() {
                 return "abc";
             }
         }).getType());

sdk/src/main/java/ly/count/android/sdk/ConnectionProcessor.java

@@ -339,8 +339,7 @@ public void run() {
             }
 
             if (deviceIdProvider_.getDeviceId() == null) {
-                // When device ID is supplied by OpenUDID or by Google Advertising ID.
-                // In some cases it might take time for them to initialize. So, just wait for it.
+                // This might not be the case anymore, check it out TODO
                 L.i("[ConnectionProcessor] No Device ID available yet, skipping request " + storedRequests[0]);
                 break;
             }

sdk/src/main/java/ly/count/android/sdk/CountlyConfig.java

@@ -79,7 +79,7 @@ public class CountlyConfig {
     protected String appKey = null;
 
     /**
-     * unique ID for the device the app is running on; note that null in deviceID means that Countly will fall back to OpenUDID, then, if it's not available, to Google Advertising ID.
+     * unique ID for the device the app is running on; note that null in deviceID means that Countly will fall back to UUID.
      */
     protected String deviceID = null;
 
@@ -289,7 +289,7 @@ public synchronized CountlyConfig setAppKey(String appKey) {
     }
 
     /**
-     * unique ID for the device the app is running on; note that null in deviceID means that Countly will fall back to OpenUDID, then, if it's not available, to Google Advertising ID.
+     * unique ID for the device the app is running on; note that null in deviceID means that Countly will fall back to UUID.
      *
      * @return Returns the same config object for convenient linking
      */
@@ -298,16 +298,6 @@ public synchronized CountlyConfig setDeviceId(String deviceID) {
         return this;
     }
 
-    /**
-     * enum value specifying which device ID generation strategy Countly should use: OpenUDID or Google Advertising ID.
-     *
-     * @return Returns the same config object for convenient linking
-     * @deprecated this call should not be used anymore as it does not have any purpose anymore
-     */
-    public synchronized CountlyConfig setIdMode(DeviceIdType idMode) {
-        return this;
-    }
-
     /**
      * sets the limit after how many sessions, for each apps version, the automatic star rating dialog is shown.
      *
@@ -992,7 +982,6 @@ public synchronized CountlyConfig enableExplicitStorageMode() {
         return this;
     }
 
-    
     /**
      * This is an experimental feature and it can have breaking changes
      *
@@ -1005,7 +994,7 @@ public synchronized CountlyConfig enableExplicitStorageMode() {
     public synchronized CountlyConfig enableServerConfiguration() {
         return this;
     }
-    
+
     protected synchronized CountlyConfig disableHealthCheck() {
         healthCheckEnabled = false;
         return this;

sdk/src/main/java/ly/count/android/sdk/DeviceId.java

@@ -62,8 +62,8 @@ protected DeviceId(@Nullable String providedId, @NonNull StorageProvider givenSt
 
                 if (providedId == null) {
                     //if the provided ID is 'null' then that means that a new ID must be generated
-                    L.i("[DeviceId-int] Using OpenUDID");
-                    setAndStoreId(DeviceIdType.OPEN_UDID, openUDIDProvider.getOpenUDID());
+                    L.i("[DeviceId-int] Using UUID");
+                    setAndStoreId(DeviceIdType.OPEN_UDID, openUDIDProvider.getUUID());
                 } else if (providedId.equals(temporaryCountlyDeviceId)) {
                     L.i("[DeviceId-int] Entering temp ID mode");
 
@@ -106,8 +106,8 @@ protected String getCurrentId() {
         assert type != null;
 
         if (id == null && type == DeviceIdType.OPEN_UDID) {
-            //using openUDID as a fallback
-            id = openUDIDProvider.getOpenUDID();
+            //using UUID as a fallback
+            id = openUDIDProvider.getUUID();
         }
         return id;
     }

sdk/src/main/java/ly/count/android/sdk/ModuleDeviceId.java

@@ -1,9 +1,7 @@
 package ly.count.android.sdk;
 
-import android.annotation.SuppressLint;
 import android.content.Context;
 import android.content.SharedPreferences;
-import android.provider.Settings;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import java.util.UUID;
@@ -252,33 +250,26 @@ void halt() {
 
     }
 
-    public final static String PREF_KEY = "openudid";
+    public final static String PREF_KEY = "openudid"; // key of old impl, keeping because needs migration
     public final static String PREFS_NAME = "openudid_prefs";
 
-    @SuppressLint("HardwareIds")
-    @Override @NonNull public String getOpenUDID() {
+    @Override @NonNull public String getUUID() {
         String retrievedID;
 
         SharedPreferences mPreferences = _cly.context_.getSharedPreferences(PREFS_NAME, Context.MODE_PRIVATE);
-        //Try to get the openudid from local preferences
+        //Try to get the stored UUID from local preferences
         retrievedID = mPreferences.getString(PREF_KEY, null);
         if (retrievedID == null) //Not found if temp storage
         {
-            Countly.sharedInstance().L.d("[OpenUDID] Generating openUDID");
-            //Try to get the ANDROID_ID
-            retrievedID = Settings.Secure.getString(_cly.context_.getContentResolver(), Settings.Secure.ANDROID_ID);
-            if (retrievedID == null || retrievedID.equals("9774d56d682e549c") || retrievedID.length() < 15) {
-                //if ANDROID_ID is null, or it's equals to the GalaxyTab generic ANDROID_ID or is too short bad, generates a new one
-                //the new one would be random
-                retrievedID = UUID.randomUUID().toString();
-            }
+            Countly.sharedInstance().L.d("[ModuleDeviceId] getUUID, Generating UUID");
+            retrievedID = UUID.randomUUID().toString();
 
             final SharedPreferences.Editor e = mPreferences.edit();
             e.putString(PREF_KEY, retrievedID);
             e.apply();
         }
 
-        Countly.sharedInstance().L.d("[OpenUDID] ID: " + retrievedID);
+        Countly.sharedInstance().L.d("[ModuleDeviceId] getUUID, retrievedID:[" + retrievedID + "]");
 
         return retrievedID;
     }

sdk/src/main/java/ly/count/android/sdk/OpenUDIDProvider.java

@@ -1,5 +1,5 @@
 package ly.count.android.sdk;
 
 interface OpenUDIDProvider {
-    String getOpenUDID();
+    String getUUID();
 }