Fix userId cache

Author: Ivan Garza

src/androidTest/java/com/segment/analytics/android/integrations/appboy/AppboyIntegrationOptionsAndroidTest.java

@@ -29,6 +29,7 @@
 public class AppboyIntegrationOptionsAndroidTest {
 
   private static final String USER_ID = "testUser";
+  private static final String OTHER_USER_ID = "testUser2";
   private static final String TRANSFORMED_USER_ID = "transformedUser";
   private static final String TRAIT_EMAIL = "test@segment.com";
   private static final String TRAIT_EMAIL_UPDATED = "updated@segment.com";
@@ -117,6 +118,46 @@ public void testShouldTriggerUpdateIfTraitChanges() {
     inOrder.verify(appboyUser, times(1)).setEmail(TRAIT_EMAIL_UPDATED);
   }
 
+  @Test
+  public void testAvoidTriggeringRepeatedUserIdUpdates() {
+    Traits traits = createTraits(USER_ID);
+    traits.putEmail(TRAIT_EMAIL);
+
+    callIdentifyWithTraits(traits);
+    callIdentifyWithTraits(traits);
+
+    verify(appboyUser, times(1)).setEmail(TRAIT_EMAIL);
+    verify(appboy, times(1)).changeUser(TRANSFORMED_USER_ID);
+  }
+
+  @Test
+  public void clearCacheIfUserIdChanges() {
+    Traits traits = createTraits(USER_ID);
+    traits.putEmail(TRAIT_EMAIL);
+
+    Traits traitsUpdate = createTraits(OTHER_USER_ID);
+    traitsUpdate.putEmail(TRAIT_EMAIL);
+
+    callIdentifyWithTraits(traits);
+    callIdentifyWithTraits(traitsUpdate);
+
+    verify(appboyUser, times(2)).setEmail(TRAIT_EMAIL);
+  }
+
+  @Test
+  public void clearCacheOnReset() {
+    Traits traits = createTraits(USER_ID);
+    traits.putEmail(TRAIT_EMAIL);
+
+    callIdentifyWithTraits(traits);
+
+    appboyIntegration.reset();
+
+    callIdentifyWithTraits(traits);
+
+    verify(appboyUser, times(2)).setEmail(TRAIT_EMAIL);
+  }
+
   public void callIdentifyWithTraits(Traits traits) {
     IdentifyPayload identifyPayload = new IdentifyPayloadBuilder().traits(traits).build();
 

src/main/java/com/segment/analytics/android/integrations/appboy/AppboyIntegration.java

@@ -128,13 +128,17 @@ public Appboy getUnderlyingInstance() {
   public void identify(IdentifyPayload identify) {
     super.identify(identify);
 
-
     String userId = identify.userId();
     if (!StringUtils.isNullOrBlank(userId)) {
-      mAppboy.changeUser(mUserIdMapper.transformUserId(userId));
 
-      if (mTraitsCache != null) {
-        mTraitsCache.clear();
+      String cachedUserId = mTraitsCache.load().userId();
+
+      if (!userId.equals(cachedUserId)) {
+        mAppboy.changeUser(mUserIdMapper.transformUserId(userId));
+
+        if (mTraitsCache != null) {
+          mTraitsCache.clear();
+        }
       }
     }
 
@@ -307,6 +311,15 @@ public void track(TrackPayload track) {
     }
   }
 
+  @Override
+  public void reset() {
+    super.reset();
+
+    if (mTraitsCache != null) {
+      mTraitsCache.clear();
+    }
+  }
+
   @Override
   public void onActivityStarted(Activity activity) {
     super.onActivityStarted(activity);

src/main/java/com/segment/analytics/android/integrations/appboy/PreferencesTraitsCache.java

@@ -5,6 +5,7 @@
 import com.segment.analytics.Cartographer;
 import com.segment.analytics.Traits;
 import java.io.IOException;
+import java.util.Collections;
 import java.util.Map;
 
 import static android.content.Context.MODE_PRIVATE;
@@ -36,13 +37,13 @@ public void save(Traits traits) {
   public Traits load() {
     String json = preferences.getString(PREFS_KEY, null);
 
-    if (isNullOrEmpty(json)) return null;
+    if (isNullOrEmpty(json)) return new Traits();
 
     try {
       Map<String, Object> map = cartographer.fromJson(json);
       return buildTraits(map);
     } catch (IOException ignored) {
-      return null;
+      return new Traits();
     }
   }
 

src/test/java/com/segment/analytics/android/integrations/appboy/AppboyTest.java

@@ -215,7 +215,7 @@ public void testIdentifyGenderOnBadInputs() {
     traits.putGender("female_1");
     identifyPayload = new IdentifyPayloadBuilder().traits(traits).build();
     mIntegration.identify(identifyPayload);
-    verify(mAppboy, Mockito.times(2)).changeUser("userId");
+    verify(mAppboy, Mockito.times(1)).changeUser("userId");
     //verifyNoMoreAppboyUserInteractions();
     //verifyNoMoreAppboyInteractions();
   }

src/test/java/com/segment/analytics/android/integrations/appboy/InMemoryTraitsCache.java

@@ -4,7 +4,7 @@
 
 public class InMemoryTraitsCache implements TraitsCache {
 
-  private Traits traits;
+  private Traits traits = new Traits();
 
   @Override
   public void save(Traits traits) {
@@ -18,6 +18,6 @@ public Traits load() {
 
   @Override
   public void clear() {
-    traits = null;
+    traits = new Traits();
   }
 }