[Dev] - AuthenticationState Renaming and Remove ECID variable

code/identityedge/src/main/java/com/adobe/marketing/mobile/identityedge/AuthenticationState.java → code/identityedge/src/main/java/com/adobe/marketing/mobile/identityedge/AuthenticatedState.java

@@ -14,25 +14,25 @@
 /**
  * Represents the authentication state for an {@link IdentityItem}
  */
-public enum AuthenticationState {
+public enum AuthenticatedState {
     AMBIGUOUS("ambiguous"),
     AUTHENTICATED("authenticated"),
     LOGGED_OUT("loggedOut");
 
     private String name;
 
-    private AuthenticationState(final String name) {
+    private AuthenticatedState(final String name) {
         this.name = name;
     }
 
     public String getName() {
         return name;
     }
 
-    public static AuthenticationState fromString(final String state) {
-        if ("authenticated".equalsIgnoreCase(state)) {
+    public static AuthenticatedState fromString(final String state) {
+        if (AUTHENTICATED.getName().equalsIgnoreCase(state)) {
             return AUTHENTICATED;
-        } else if ("loggedOut".equalsIgnoreCase(state)) {
+        } else if (LOGGED_OUT.getName().equalsIgnoreCase(state)) {
             return LOGGED_OUT;
         } else {
             return AMBIGUOUS;

code/identityedge/src/main/java/com/adobe/marketing/mobile/identityedge/IdentityEdgeProperties.java

@@ -31,38 +31,20 @@ class IdentityEdgeProperties {
         add(IdentityEdgeConstants.Namespaces.IDFA);
     }};
 
-    // The current Experience Cloud ID
-    private ECID ecid;
+    private final IdentityMap identityMap;
 
-    // A secondary (non-primary) Experience Cloud ID
-    private ECID ecidSecondary;
-
-    private IdentityMap identityMap = new IdentityMap();
-
-    IdentityEdgeProperties() { }
+    IdentityEdgeProperties() {
+        this.identityMap = new IdentityMap();
+    }
 
     /**
      * Creates a identity edge properties instance based on the map
      *
      * @param xdmData a map representing an identity edge properties instance
      */
     IdentityEdgeProperties(final Map<String, Object> xdmData) {
-        if (Utils.isNullOrEmpty(xdmData)) {
-            return;
-        }
-
-        identityMap = IdentityMap.fromData(xdmData);
-        if (identityMap != null) {
-            final List<IdentityItem> ecidItems = identityMap.getIdentityItemsForNamespace(IdentityEdgeConstants.Namespaces.ECID);
-            if (ecidItems != null) {
-                if (ecidItems.size() > 0 && ecidItems.get(0) != null && ecidItems.get(0).getId() != null) {
-                    ecid = new ECID(ecidItems.get(0).getId());
-                }
-                if (ecidItems.size() > 1 && ecidItems.get(1) != null && ecidItems.get(1).getId() != null) {
-                    ecidSecondary = new ECID(ecidItems.get(1).getId());
-                }
-            }
-        }
+        IdentityMap map = IdentityMap.fromData(xdmData);
+        this.identityMap = map == null ? new IdentityMap() : map; // always keep an empty identity map so there is no need for null check
     }
 
     /**
@@ -72,8 +54,9 @@ class IdentityEdgeProperties {
      */
     void setECID(final ECID newEcid) {
         // delete the previous ECID from the identity map if exist
-        if (ecid != null) {
-            final IdentityItem previousECIDItem = new IdentityItem(ecid.toString());
+        final ECID currentECID = getECID();
+        if (currentECID != null) {
+            final IdentityItem previousECIDItem = new IdentityItem(currentECID.toString());
             identityMap.removeItem(previousECIDItem, IdentityEdgeConstants.Namespaces.ECID);
         }
 
@@ -83,11 +66,9 @@ void setECID(final ECID newEcid) {
             identityMap.clearItemsForNamespace(IdentityEdgeConstants.Namespaces.ECID);
         } else {
             // And add the new primary Ecid as a first element of Identity map
-            final IdentityItem newECIDItem = new IdentityItem(newEcid.toString(), AuthenticationState.AMBIGUOUS, false);
+            final IdentityItem newECIDItem = new IdentityItem(newEcid.toString(), AuthenticatedState.AMBIGUOUS, false);
             identityMap.addItem(newECIDItem, IdentityEdgeConstants.Namespaces.ECID, true);
         }
-
-        this.ecid = newEcid; // keep the local variable up to date
     }
 
     /**
@@ -96,7 +77,11 @@ void setECID(final ECID newEcid) {
      * @return current {@code ECID}
      */
     ECID getECID() {
-        return ecid;
+        final List<IdentityItem> ecidItems = identityMap.getIdentityItemsForNamespace(IdentityEdgeConstants.Namespaces.ECID);
+        if (ecidItems != null && !ecidItems.isEmpty() && ecidItems.get(0) != null && !Utils.isNullOrEmpty(ecidItems.get(0).getId())) {
+            return new ECID(ecidItems.get(0).getId());
+        }
+        return null;
     }
 
     /**
@@ -106,25 +91,23 @@ ECID getECID() {
      */
     void setECIDSecondary(final ECID newSecondaryEcid) {
         // delete the previous secondary ECID from the identity map if exist
+        final ECID ecidSecondary = getECIDSecondary();
         if (ecidSecondary != null) {
             final IdentityItem previousECIDItem = new IdentityItem(ecidSecondary.toString());
             identityMap.removeItem(previousECIDItem, IdentityEdgeConstants.Namespaces.ECID);
         }
 
         // do not set secondary ECID if primary ECID is not set
-        if (ecid == null) {
+        if (getECID() == null) {
             MobileCore.log(LoggingMode.DEBUG, LOG_TAG, "Cannot set secondary ECID value as no primary ECID exists.");
-            this.ecidSecondary = null;
             return;
         }
 
         // add the new secondary ECID to Identity map
         if (newSecondaryEcid != null) {
-            final IdentityItem newSecondaryECIDItem = new IdentityItem(newSecondaryEcid.toString(), AuthenticationState.AMBIGUOUS, false);
+            final IdentityItem newSecondaryECIDItem = new IdentityItem(newSecondaryEcid.toString(), AuthenticatedState.AMBIGUOUS, false);
             identityMap.addItem(newSecondaryECIDItem, IdentityEdgeConstants.Namespaces.ECID);
         }
-
-        this.ecidSecondary = newSecondaryEcid; // keep the local variable up to date
     }
 
     /**
@@ -133,7 +116,11 @@ void setECIDSecondary(final ECID newSecondaryEcid) {
      * @return secondary {@code ECID}
      */
     ECID getECIDSecondary() {
-        return ecidSecondary;
+        final List<IdentityItem> ecidItems = identityMap.getIdentityItemsForNamespace(IdentityEdgeConstants.Namespaces.ECID);
+        if (ecidItems != null && ecidItems.size() > 1 && ecidItems.get(1) != null && !Utils.isNullOrEmpty(ecidItems.get(1).getId())) {
+            return new ECID(ecidItems.get(1).getId());
+        }
+        return null;
     }
 
     /**

code/identityedge/src/main/java/com/adobe/marketing/mobile/identityedge/IdentityEdgeState.java

@@ -24,7 +24,8 @@ class IdentityEdgeState {
     private IdentityEdgeProperties identityProperties;
 
     /**
-     *  Creates a new {@link IdentityEdgeState} with the given {@link IdentityEdgeProperties}
+     * Creates a new {@link IdentityEdgeState} with the given {@link IdentityEdgeProperties}
+     *
      * @param identityProperties identity edge properties
      */
     IdentityEdgeState(final IdentityEdgeProperties identityProperties) {
@@ -47,10 +48,13 @@ boolean hasBooted() {
 
     /**
      * Completes init for the Identity Edge extension.
+     *
      * @return True if we should share state after bootup, false otherwise
      */
     boolean bootupIfReady() {
-        if (hasBooted) { return true; }
+        if (hasBooted) {
+            return true;
+        }
         // Load properties from local storage
         identityProperties = IdentityEdgeStorageService.loadPropertiesFromPersistence();
 
@@ -114,17 +118,26 @@ void removeCustomerIdentifiers(final IdentityMap map) {
     /**
      * Update the legacy ECID property with {@code legacyEcid} provided it does not equal the primary or secondary ECIDs
      * currently in {@code IdentityEdgePoperties}.
+     *
      * @param legacyEcid the current ECID from the direct Identity extension
      * @return true if the legacy ECID was updated in {@code IdentityEdgeProperties}
      */
     boolean updateLegacyExperienceCloudId(final ECID legacyEcid) {
-        if (legacyEcid == identityProperties.getECID() || legacyEcid == identityProperties.getECIDSecondary()) {
+        final ECID ecid = identityProperties.getECID();
+        final ECID ecidSecondary = identityProperties.getECIDSecondary();
+
+        if ((legacyEcid != null) && (legacyEcid.equals(ecid) || legacyEcid.equals(ecidSecondary))) {
+            return false;
+        }
+
+        // no need to clear secondaryECID if its already null
+         if (legacyEcid == null && ecidSecondary == null){
             return false;
         }
 
         identityProperties.setECIDSecondary(legacyEcid);
         IdentityEdgeStorageService.savePropertiesToPersistence(identityProperties);
-        MobileCore.log(LoggingMode.DEBUG, LOG_TAG,"Identity direct ECID updated to '" + legacyEcid + "', updating the IdentityMap");
+        MobileCore.log(LoggingMode.DEBUG, LOG_TAG, "Identity direct ECID updated to '" + legacyEcid + "', updating the IdentityMap");
         return true;
     }
 

code/identityedge/src/main/java/com/adobe/marketing/mobile/identityedge/IdentityItem.java

@@ -23,43 +23,43 @@
  */
 public final class IdentityItem {
     private final String id;
-    private final AuthenticationState authenticationState;
+    private final AuthenticatedState authenticatedState;
     private final boolean primary;
 
     private static final String LOG_TAG = "IdentityItem";
 
     /**
      * Creates a new {@link IdentityItem}
      * @param id id for the item
-     * @param authenticationState {@link AuthenticationState} for the item
+     * @param authenticatedState {@link AuthenticatedState} for the item
      * @param primary primary flag for the item
      * @throws IllegalArgumentException if id is null
      */
-    public IdentityItem(final String id, final AuthenticationState authenticationState, final boolean primary) {
+    public IdentityItem(final String id, final AuthenticatedState authenticatedState, final boolean primary) {
         if (id == null) {
             throw new IllegalArgumentException("id must be non-null");
         }
         this.id = id;
-        this.authenticationState = authenticationState != null ? authenticationState : AuthenticationState.AMBIGUOUS;
+        this.authenticatedState = authenticatedState != null ? authenticatedState : AuthenticatedState.AMBIGUOUS;
         this.primary = primary;
     }
 
     /**
      * Creates a new {@link IdentityItem} with default values
-     * authenticationState is set to AMBIGUOUS
+     * authenticatedState is set to AMBIGUOUS
      * primary is set to false
      * @param id the id for this {@link IdentityItem}
      */
     public IdentityItem(final String id) {
-        this(id, AuthenticationState.AMBIGUOUS, false);
+        this(id, AuthenticatedState.AMBIGUOUS, false);
     }
 
     /**
      * Creates a copy of item
      * @param item A {@link IdentityItem} to be copied
      */
     public IdentityItem(final IdentityItem item) {
-        this(item.id, item.authenticationState, item.primary);
+        this(item.id, item.authenticatedState, item.primary);
     }
 
     /**
@@ -72,10 +72,10 @@ Map<String, Object> toObjectMap() {
             map.put(IdentityEdgeConstants.XDMKeys.ID, id);
         }
 
-        if (authenticationState != null) {
-            map.put(IdentityEdgeConstants.XDMKeys.AUTHENTICATED_STATE, authenticationState.toString());
+        if (authenticatedState != null) {
+            map.put(IdentityEdgeConstants.XDMKeys.AUTHENTICATED_STATE, authenticatedState.getName());
         } else {
-            map.put(IdentityEdgeConstants.XDMKeys.AUTHENTICATED_STATE, AuthenticationState.AMBIGUOUS.toString());
+            map.put(IdentityEdgeConstants.XDMKeys.AUTHENTICATED_STATE, AuthenticatedState.AMBIGUOUS.getName());
         }
 
         map.put(IdentityEdgeConstants.XDMKeys.PRIMARY, primary);
@@ -90,10 +90,10 @@ public String getId() {
     }
 
     /**
-     * @return Current {@link AuthenticationState} for this item
+     * @return Current {@link AuthenticatedState} for this item
      */
-    public AuthenticationState getAuthenticationState() {
-        return authenticationState;
+    public AuthenticatedState getAuthenticatedState() {
+        return authenticatedState;
     }
 
     /**
@@ -113,17 +113,17 @@ static IdentityItem fromData(final Map<String, Object> data) {
 
         try {
             final String id = (String) data.get(IdentityEdgeConstants.XDMKeys.ID);
-            AuthenticationState authenticationState = AuthenticationState.fromString((String) data.get(IdentityEdgeConstants.XDMKeys.AUTHENTICATED_STATE));
-            if (authenticationState == null) {
-                authenticationState = AuthenticationState.AMBIGUOUS;
+            AuthenticatedState authenticatedState = AuthenticatedState.fromString((String) data.get(IdentityEdgeConstants.XDMKeys.AUTHENTICATED_STATE));
+            if (authenticatedState == null) {
+                authenticatedState = AuthenticatedState.AMBIGUOUS;
             }
 
             boolean primary = false;
             if (data.get(IdentityEdgeConstants.XDMKeys.PRIMARY) != null) {
                 primary = (boolean) data.get(IdentityEdgeConstants.XDMKeys.PRIMARY);
             }
 
-            return new IdentityItem(id, authenticationState, primary);
+            return new IdentityItem(id, authenticatedState, primary);
         } catch (ClassCastException e) {
             MobileCore.log(LoggingMode.DEBUG, LOG_TAG, "Failed to create IdentityItem from data.");
             return null;

code/identityedge/src/test/java/com/adobe/marketing/mobile/identityedge/IdentityEdgeExtensionTests.java

@@ -384,14 +384,14 @@ public void test_handleUpdateIdentities() throws Exception {
         verify(mockExtensionApi, times(1)).setXDMSharedEventState(sharedStateCaptor.capture(), eq(updateIdentityEvent), any(ExtensionErrorCallback.class));
         Map<String, String> sharedState = flattenMap(sharedStateCaptor.getValue());
         assertEquals("secretID", sharedState.get("identityMap.UserId[0].id"));
-        assertEquals("AMBIGUOUS", sharedState.get("identityMap.UserId[0].authenticatedState"));
+        assertEquals("ambiguous", sharedState.get("identityMap.UserId[0].authenticatedState"));
         assertEquals("false", sharedState.get("identityMap.UserId[0].primary"));
 
         // verify persistence
         verify(mockSharedPreferenceEditor, times(2)).putString(eq(IdentityEdgeConstants.DataStoreKey.IDENTITY_PROPERTIES), persistenceValueCaptor.capture());
         Map<String, String> persistedData = flattenJSONString(persistenceValueCaptor.getAllValues().get(1));
         assertEquals("secretID", persistedData.get("identityMap.UserId[0].id"));
-        assertEquals("AMBIGUOUS", persistedData.get("identityMap.UserId[0].authenticatedState"));
+        assertEquals("ambiguous", persistedData.get("identityMap.UserId[0].authenticatedState"));
         assertEquals("false", persistedData.get("identityMap.UserId[0].primary"));
     }
 

code/identityedge/src/test/java/com/adobe/marketing/mobile/identityedge/IdentityEdgePropertiesTests.java

@@ -51,12 +51,12 @@ public void test_toXDMData_Full() {
 
         // verify primary ECID
         assertEquals(props.getECID().toString(), flatMap.get("identityMap.ECID[0].id"));
-        assertEquals("AMBIGUOUS", flatMap.get("identityMap.ECID[0].authenticatedState"));
+        assertEquals("ambiguous", flatMap.get("identityMap.ECID[0].authenticatedState"));
         assertEquals("false", flatMap.get("identityMap.ECID[0].primary"));
 
         // verify secondary ECID
         assertEquals(props.getECIDSecondary().toString(), flatMap.get("identityMap.ECID[1].id"));
-        assertEquals("AMBIGUOUS", flatMap.get("identityMap.ECID[1].authenticatedState"));
+        assertEquals("ambiguous", flatMap.get("identityMap.ECID[1].authenticatedState"));
         assertEquals("false", flatMap.get("identityMap.ECID[1].primary"));
     }
 

code/identityedge/src/test/java/com/adobe/marketing/mobile/identityedge/IdentityEdgeTests.java

@@ -11,8 +11,6 @@
 
 package com.adobe.marketing.mobile.identityedge;
 
-import android.provider.ContactsContract;
-
 import com.adobe.marketing.mobile.AdobeCallback;
 import com.adobe.marketing.mobile.AdobeCallbackWithError;
 import com.adobe.marketing.mobile.AdobeError;
@@ -260,8 +258,8 @@ public void testUpdateIdentities() {
 
         // test
         IdentityMap map = new IdentityMap();
-        map.addItem(new IdentityItem("id", AuthenticationState.AUTHENTICATED, true),"mainspace");
-        map.addItem(new IdentityItem("idtwo", AuthenticationState.LOGGED_OUT, false),"secondspace");
+        map.addItem(new IdentityItem("id", AuthenticatedState.AUTHENTICATED, true),"mainspace");
+        map.addItem(new IdentityItem("idtwo", AuthenticatedState.LOGGED_OUT, false),"secondspace");
         IdentityEdge.updateIdentities(map);
 
         // verify
@@ -298,7 +296,7 @@ public void testRemoveIdentity() {
         // setup
         final ArgumentCaptor<Event> eventCaptor = ArgumentCaptor.forClass(Event.class);
         final ArgumentCaptor<ExtensionErrorCallback> extensionErrorCallbackCaptor = ArgumentCaptor.forClass(ExtensionErrorCallback.class);
-        IdentityItem sampleItem = new IdentityItem("sample", AuthenticationState.AMBIGUOUS, false);
+        IdentityItem sampleItem = new IdentityItem("sample", AuthenticatedState.AMBIGUOUS, false);
 
         // test
         IdentityEdge.removeIdentity(sampleItem, "namespace");
@@ -323,7 +321,7 @@ public void testRemoveIdentity() {
     @Test
     public void testRemoveIdentity_WithInvalidInputs() {
         // setup
-        IdentityItem sampleItem = new IdentityItem("sample", AuthenticationState.AMBIGUOUS, false);
+        IdentityItem sampleItem = new IdentityItem("sample", AuthenticatedState.AMBIGUOUS, false);
 
         // test
         IdentityEdge.removeIdentity(null, "namespace");
@@ -396,11 +394,11 @@ public void call(IdentityMap map) {
         IdentityItem coreItem = callbackReturnValues.get(0).getIdentityItemsForNamespace("CORE").get(0);
 
         assertEquals(ecid.toString(), ecidItem.getId());
-        assertEquals(AuthenticationState.AMBIGUOUS, ecidItem.getAuthenticationState());
+        assertEquals(AuthenticatedState.AMBIGUOUS, ecidItem.getAuthenticatedState());
         assertEquals(true, ecidItem.isPrimary());
 
         assertEquals(coreId, coreItem.getId());
-        assertEquals(AuthenticationState.AUTHENTICATED, coreItem.getAuthenticationState());
+        assertEquals(AuthenticatedState.AUTHENTICATED, coreItem.getAuthenticatedState());
         assertEquals(false, coreItem.isPrimary());
 
         // TODO - enable when ExtensionError creation is available