[Sdk 518] Print warning on random UUID and deprecate additional device id methods (#25)

* - Login and logout deprecated
- utils 'isEmpty' method rename to 'isEmptyorNull'

* - changelog updated
- added warning when sdk generate a random uuid

* Update ModuleDeviceIdCore.java

* Update CHANGELOG.md

Co-authored-by: Zahid Zafar <>
Co-authored-by: ArtursKadikis <[email protected]>

Author: ZahidZafar

CHANGELOG.md

@@ -1,4 +1,5 @@
 22.06.0
+* The "resetDeviceId", "login", and "logout" have been deprecated.
 * ! Minor breaking change ! The following methods and their functionality is removed from the "Config" class: "enableTestMode", "disableTestMode" and "isTestModeEnabled". The "TestMode" functionality is being removed from the SDK.
 
 20.11.5

sdk-java/src/main/java/ly/count/sdk/java/Config.java

@@ -647,7 +647,7 @@ public Config setDeviceIdStrategy(DeviceIdStrategy strategy) {
      * @return {@code this} instance for method chaining
      */
     public Config setCustomDeviceId(String customDeviceId) {
-        if (Utils.isEmpty(customDeviceId)) {
+        if (Utils.isEmptyOrNull(customDeviceId)) {
             System.out.print("[ConfigCore] DeviceIdStrategy.CUSTOM_ID strategy cannot be used without device id specified");
         } else {
             this.customDeviceId = customDeviceId;
@@ -716,7 +716,7 @@ public Config setRequestQueueMaxSize(int requestQueueMaxSize) {
      * @return {@code this} instance for method chaining
      */
     public Config enableParameterTamperingProtection(String salt) {
-        if (Utils.isEmpty(salt)) {
+        if (Utils.isEmptyOrNull(salt)) {
             System.out.print("[ConfigCore] Salt cannot be empty in enableParameterTamperingProtection");
         } else {
             this.salt = salt;
@@ -854,7 +854,7 @@ public Config setSessionCooldownPeriod(int sessionCooldownPeriod) {
      * @return {@code this} instance for method chaining
      */
     public Config setSdkName(String sdkName) {
-        if (Utils.isEmpty(sdkName)) {
+        if (Utils.isEmptyOrNull(sdkName)) {
             System.out.print("[ConfigCore] sdkName cannot be empty");
         } else {
             this.sdkName = sdkName;
@@ -869,7 +869,7 @@ public Config setSdkName(String sdkName) {
      * @return {@code this} instance for method chaining
      */
     public Config setSdkVersion(String sdkVersion) {
-        if (Utils.isEmpty(sdkVersion)) {
+        if (Utils.isEmptyOrNull(sdkVersion)) {
             System.out.print("[ConfigCore] sdkVersion cannot be empty");
         } else {
             this.sdkVersion = sdkVersion;
@@ -884,7 +884,7 @@ public Config setSdkVersion(String sdkVersion) {
      * @return {@code this} instance for method chaining
      */
     public Config setApplicationName(String name) {
-        if (Utils.isEmpty(name)) {
+        if (Utils.isEmptyOrNull(name)) {
             System.out.print("[ConfigCore] name cannot be empty");
         } else {
             this.applicationName = name;
@@ -899,7 +899,7 @@ public Config setApplicationName(String name) {
      * @return {@code this} instance for method chaining
      */
     public Config setApplicationVersion(String version) {
-        if (Utils.isEmpty(version)) {
+        if (Utils.isEmptyOrNull(version)) {
             System.out.print("[ConfigCore] version cannot be empty");
         } else {
             this.applicationVersion = version;
@@ -989,7 +989,7 @@ public Config setNetworkImportantRequestCooldown(int milliseconds) {
      * @return {@code this} instance for method chaining
      */
     public Config addPublicKeyPin(String pemEncodedPublicKey) {
-        if (Utils.isEmpty(pemEncodedPublicKey)) {
+        if (Utils.isEmptyOrNull(pemEncodedPublicKey)) {
             System.out.print("[ConfigCore] pemEncodedPublicKey cannot be empty");
         } else {
             if (publicKeyPins == null) {
@@ -1021,7 +1021,7 @@ public Config addPublicKeyPin(String pemEncodedPublicKey) {
      * @return {@code this} instance for method chaining
      */
     public Config addCertificatePin(String pemEncodedCertificate) {
-        if (Utils.isEmpty(pemEncodedCertificate)) {
+        if (Utils.isEmptyOrNull(pemEncodedCertificate)) {
             System.out.print("[ConfigCore] pemEncodedCertificate cannot be empty");
         } else {
             if (certificatePins == null) {

sdk-java/src/main/java/ly/count/sdk/java/Usage.java

@@ -111,6 +111,7 @@ public interface Usage {
     View view(String name);
 
     /**
+     * @deprecated
      * Login function to set device (user) id on Countly server to the string specified here.
      * Closes current session, then starts new one automatically if {@link Config#autoSessionsTracking} is on, acquires device id.
      *
@@ -119,6 +120,7 @@ public interface Usage {
     Usage login(String id);
 
     /**
+     * @deprecated
      * Logout function to make current user anonymous (that is with random id according to
      * {@link Config#deviceIdStrategy} and such). Obviously makes sense only after a call to {@link #login(String)},
      * so it throws error or does nothing (depending on {@link Config#testMode}) if current id wasn't set using {@link #login(String)}.

sdk-java/src/main/java/ly/count/sdk/java/internal/CrashImplCore.java

@@ -165,7 +165,7 @@ public Map<String, String> getSegments() {
     public List<String> getLogs() {
         try {
             String logs = this.data.getString("_logs");
-            return Utils.isEmpty(logs) ? null : Arrays.asList(logs.split("\n"));
+            return Utils.isEmptyOrNull(logs) ? null : Arrays.asList(logs.split("\n"));
         } catch (JSONException e) {
             return null;
         }
@@ -230,7 +230,7 @@ public static String getStoragePrefix() {
     public CrashImplCore putMetricsCore(CtxCore ctx, Long runningTime) {
         String version = ctx.getConfig().getApplicationVersion();
         return add("_os", DeviceCore.dev.getOS())
-                .add("_app_version", Utils.isEmpty(version) ? "0.0" : version)
+                .add("_app_version", Utils.isEmptyOrNull(version) ? "0.0" : version)
                 .add("_os_version", DeviceCore.dev.getOSVersion())
                 .add("_ram_current", DeviceCore.dev.getRAMAvailable())
                 .add("_ram_total", DeviceCore.dev.getRAMTotal())

sdk-java/src/main/java/ly/count/sdk/java/internal/ModuleDeviceIdCore.java

@@ -120,6 +120,9 @@ public void onContextAcquired(final CtxCore ctx) {
                     @Override
                     public void call(Config.DID id) throws Exception {
                         if (id != null) {
+                            if(id.strategy == Config.DID.STRATEGY_UUID) {
+                                L.i("During init, custom device id was not provided. SDK has generated a random device id.");
+                            }
                             L.d("[ModuleDeviceIdCore] Got device id: " + id);
                             SDKCore.instance.onDeviceId(ctx, id, null);
                         } else {
@@ -254,7 +257,7 @@ private void sendDIDSignal(CtxCore ctx, Config.DID id, Config.DID old) {
      * @param id device id to change to
      */
     public void login(CtxCore ctx, String id) {
-        if (Utils.isEmpty(id)) {
+        if (Utils.isEmptyOrNull(id)) {
             L.e("[ModuleDeviceIdCore] Empty id passed to login method");
         } else {
             final Config.DID old = ctx.getConfig().getDeviceId();
@@ -303,7 +306,7 @@ public void call(Config.DID id) throws Exception {
      * @param id new user id
      */
     public void changeDeviceId(CtxCore ctx, String id, boolean withMerge) {
-        if (Utils.isEmpty(id)) {
+        if (Utils.isEmptyOrNull(id)) {
             L.e("[ModuleDeviceIdCore] Empty id passed to resetId method");
         } else {
             final Config.DID old = ctx.getConfig().getDeviceId();

sdk-java/src/main/java/ly/count/sdk/java/internal/SDKStorage.java

@@ -13,11 +13,6 @@
 import java.util.List;
 import java.util.Map;
 
-import ly.count.sdk.java.internal.Log;
-import ly.count.sdk.java.internal.Storable;
-import ly.count.sdk.java.internal.Storage;
-import ly.count.sdk.java.internal.Utils;
-
 abstract class SDKStorage extends SDKLifecycle {
     private static final String FILE_NAME_PREFIX = "[CLY]";
     private static final String FILE_NAME_SEPARATOR = "_";
@@ -41,7 +36,7 @@ private static String getName(Storable storable) {
     }
 
     private static String getName(String ...names) {
-        if (names == null || names.length == 0 || Utils.isEmpty(names[0])) {
+        if (names == null || names.length == 0 || Utils.isEmptyOrNull(names[0])) {
             return FILE_NAME_PREFIX;
         } else {
             StringBuilder prefix = new StringBuilder(FILE_NAME_PREFIX);
@@ -246,7 +241,7 @@ private String[] getFileList(ly.count.sdk.java.internal.CtxCore context){
 
     @Override
     public List<Long> storableList(ly.count.sdk.java.internal.CtxCore context, String prefix, int slice) {
-        if (Utils.isEmpty(prefix)) {
+        if (Utils.isEmptyOrNull(prefix)) {
             L.e("[SDKStorage] Cannot get list of ids without prefix");
         }
         prefix = prefix + FILE_NAME_SEPARATOR;

sdk-java/src/main/java/ly/count/sdk/java/internal/Transport.java

@@ -141,7 +141,7 @@ HttpURLConnection connection(final Request request, final User user) throws IOEx
 
         String path = config.getServerURL().toString() + endpoint;
         String picture = request.params.remove(UserEditorImpl.PICTURE_PATH);
-        boolean usingGET = !config.isUsePOST() && request.isGettable(config.getServerURL()) && Utils.isEmpty(picture);
+        boolean usingGET = !config.isUsePOST() && request.isGettable(config.getServerURL()) && Utils.isEmptyOrNull(picture);
 
         if (usingGET && config.getParameterTamperingProtectionSalt() != null) {
             request.params.add(CHECKSUM, Utils.digestHex(PARAMETER_TAMPERING_DIGEST, request.params.toString() + config.getParameterTamperingProtectionSalt()));

sdk-java/src/main/java/ly/count/sdk/java/internal/Utils.java

@@ -105,7 +105,7 @@ public static Field findField(Class cls, String name) throws NoSuchFieldExceptio
      * @param str string to check
      * @return true if null or empty string, false otherwise
      */
-    public static boolean isEmpty(String str) {
+    public static boolean isEmptyOrNull(String str) {
         return str == null || "".equals(str);
     }
 
@@ -116,7 +116,7 @@ public static boolean isEmpty(String str) {
      * @return false if null or empty string, true otherwise
      */
     public static boolean isNotEmpty(String str) {
-        return !isEmpty(str);
+        return !isEmptyOrNull(str);
     }
 
     public static boolean isNotEqual(Object a, Object b) {

sdk-java/src/test/java/ly/count/sdk/java/internal/UtilsTests.java

@@ -10,8 +10,6 @@
 import java.util.ArrayList;
 import java.util.Collection;
 
-import ly.count.sdk.java.internal.Utils;
-
 @RunWith(JUnit4.class)
 public class UtilsTests {
     @Before
@@ -192,9 +190,9 @@ public boolean equals(Object obj) {
 
     @Test
     public void isEmpty() {
-        junit.framework.Assert.assertFalse(Utils.isEmpty("notthatempty"));
-        junit.framework.Assert.assertTrue(Utils.isEmpty(""));
-        junit.framework.Assert.assertTrue(Utils.isEmpty(null));
+        junit.framework.Assert.assertFalse(Utils.isEmptyOrNull("notthatempty"));
+        junit.framework.Assert.assertTrue(Utils.isEmptyOrNull(""));
+        junit.framework.Assert.assertTrue(Utils.isEmptyOrNull(null));
     }
 
     @Test