Fs3 370 slug (#4)

### [3.0.3 (Latest version)](doc:android-v3)
* Added campaign slug information in FlagMetadata

Author: raf-abtasty

build.gradle

@@ -14,7 +14,7 @@ buildscript {
     if (flagship_version_name != null)
         rootProject.ext.flagship_version_name = flagship_version_name
     else
-        rootProject.ext.flagship_version_name = "3.0.2"
+        rootProject.ext.flagship_version_name = "3.0.3"
 
     if (flagship_version_code != null)
         rootProject.ext.flagship_version_code = flagship_version_code

flagship/src/main/java/com/abtasty/flagship/cache/VisitorCacheHelper.java

@@ -44,14 +44,15 @@ public void applyFromJSON(VisitorDelegateDTO visitorDelegateDTO, JSONObject data
                             String campaignId = campaignObject.getString("campaignId");
                             String variationGroupId = campaignObject.getString("variationGroupId");
                             String variationId = campaignObject.getString("variationId");
+                            String slug = campaignObject.optString("slug", "");
                             boolean isReference = campaignObject.getBoolean("isReference");
                             String type = campaignObject.getString("type");
                             if (campaignObject.optBoolean("activated", false) && !visitorDelegate.getActivatedVariations().contains(variationId))
                                 visitorDelegate.getActivatedVariations().add(variationId);
                             JSONObject flagsJson = campaignObject.optJSONObject("flags");
                             if (flagsJson != null) {
                                 flagsJson.keySet().forEach(key -> {
-                                    Modification modification = new Modification(key, campaignId, variationGroupId, variationId, isReference, flagsJson.get(key), type);
+                                    Modification modification = new Modification(key, campaignId, variationGroupId, variationId, isReference, flagsJson.get(key), type, slug);
                                     visitorDelegate.getModifications().put(key, modification);
                                 });
                             }
@@ -103,6 +104,7 @@ private static JSONArray modificationsToCacheJSON(VisitorDelegateDTO visitorDele
                         .put("variationId", m.getValue().getVariationId())
                         .put("isReference", m.getValue().isReference())
                         .put("type", m.getValue().getType())
+                        .put("slug", m.getValue().getSlug())
                         .put("activated", visitorDelegateDTO.getActivatedVariations().contains(m.getValue().getVariationId()))
                         .put("flags", new JSONObject().put(m.getValue().getKey(),
                                 (m.getValue().getValue() != null) ? m.getValue().getValue() : JSONObject.NULL)));

flagship/src/main/java/com/abtasty/flagship/model/Campaign.java

@@ -46,18 +46,19 @@ public static Campaign parse(JSONObject campaignObject) {
         try {
             String id = campaignObject.getString("id");
             String campaignType = campaignObject.optString("type", "");
+            String slug = campaignObject.isNull("slug") ? "" : campaignObject.optString("slug", "");
             LinkedList<VariationGroup> variationGroups = new LinkedList<>();
             JSONArray variationGroupArray = campaignObject.optJSONArray("variationGroups");
             if (variationGroupArray != null) {
                 //bucketing
                 variationGroupArray.forEach(variationGroupsObj -> {
-                    VariationGroup variationGroup = VariationGroup.parse(id, campaignType, (JSONObject) variationGroupsObj, true);
+                    VariationGroup variationGroup = VariationGroup.parse(id, campaignType, slug, (JSONObject) variationGroupsObj, true);
                     if (variationGroup != null)
                         variationGroups.add(variationGroup);
                 });
             } else {
                 //api
-                VariationGroup variationGroup = VariationGroup.parse(id, campaignType, campaignObject, false);
+                VariationGroup variationGroup = VariationGroup.parse(id, campaignType, slug, campaignObject, false);
                 if (variationGroup != null)
                     variationGroups.add(variationGroup);
             }

flagship/src/main/java/com/abtasty/flagship/model/FlagMetadata.java

@@ -10,28 +10,32 @@ public class FlagMetadata {
     public final boolean   isReference;
     public final String    campaignType;
 
+    public final String     slug;
+
     public FlagMetadata() {
         this.campaignId = "";
         this.variationGroupId = "";
         this.variationId = "";
         this.isReference = false;
         this.campaignType = "";
+        this.slug = "";
     }
 
-    public FlagMetadata(String campaignId, String variationGroupId, String variationId, Boolean isReference, String campaignType) {
+    public FlagMetadata(String campaignId, String variationGroupId, String variationId, Boolean isReference, String campaignType, String slug) {
         this.campaignId = campaignId;
         this.variationGroupId = variationGroupId;
         this.variationId = variationId;
         this.isReference = isReference;
         this.campaignType = campaignType;
+        this.slug = slug;
     }
 
     public static FlagMetadata fromModification(Modification modification) {
         if (modification == null)
             return new FlagMetadata();
         else {
             return new FlagMetadata(modification.getCampaignId(), modification.getVariationGroupId(),
-                    modification.getVariationId(), modification.isReference(), modification.getType());
+                    modification.getVariationId(), modification.isReference(), modification.getType(), modification.getSlug());
         }
     }
 
@@ -48,7 +52,8 @@ public JSONObject toJSON() {
                     .put("variationGroupId", variationGroupId)
                     .put("variationId", variationId)
                     .put("isReference", isReference)
-                    .put("campaignType", campaignType);
+                    .put("campaignType", campaignType)
+                    .put("slug", slug);
         }
     }
 }

flagship/src/main/java/com/abtasty/flagship/model/Modification.java

@@ -12,15 +12,18 @@ public class Modification implements Serializable {
     private final Object      value;
     private final String      type;
 
+    private final String      slug;
+
     public Modification(String key, String campaignId, String variationGroupId, String variationId, boolean isReference,
-                        Object value, String type) {
+                        Object value, String type, String slug) {
         this.key = key;
         this.campaignId = campaignId;
         this.variationGroupId = variationGroupId;
         this.variationId = variationId;
         this.isReference = isReference;
         this.value = value;
         this.type = type;
+        this.slug = slug;
     }
 
     public String getKey() {
@@ -50,4 +53,8 @@ public Object getValue() {
     public String getType() {
         return type;
     }
+
+    public String getSlug() {
+        return slug;
+    }
 }

flagship/src/main/java/com/abtasty/flagship/model/Modifications.java

@@ -50,15 +50,15 @@ public HashMap<String, Modification> getValues() {
         return values;
     }
 
-    public static Modifications parse(String campaignId, String campaignType, String variationGroupId, String variationId, boolean isReference, JSONObject modificationsObj) {
+    public static Modifications parse(String campaignId, String campaignType, String slug, String variationGroupId, String variationId, boolean isReference, JSONObject modificationsObj) {
         try {
 //            String type = modificationsObj.getString("type");
             HashMap<String, Modification> values = new HashMap<>();
             JSONObject valueObj = modificationsObj.getJSONObject("value");
             valueObj.keySet().forEach(key -> {
                 Object value = valueObj.isNull(key) ? null : valueObj.get(key);
                 if (value instanceof Boolean || value instanceof Number || value instanceof String || value instanceof JSONObject || value instanceof JSONArray || value == null)
-                    values.put(key, new Modification(key, campaignId, variationGroupId, variationId, isReference, value, campaignType));
+                    values.put(key, new Modification(key, campaignId, variationGroupId, variationId, isReference, value, campaignType, slug));
                 else
                     FlagshipLogManager.log(FlagshipLogManager.Tag.PARSING, LogManager.Level.ERROR, FlagshipConstants.Errors.PARSING_MODIFICATION_ERROR);
             });

flagship/src/main/java/com/abtasty/flagship/model/Variation.java

@@ -53,11 +53,11 @@ public int getAllocation() {
         return allocation;
     }
 
-    public static Variation parse(Boolean bucketingMode, String campaignId, String campaignType, String variationGroupId, JSONObject variationObj) {
+    public static Variation parse(Boolean bucketingMode, String campaignId, String campaignType, String slug, String variationGroupId, JSONObject variationObj) {
         try {
             String variationId = variationObj.getString("id");
             boolean isReference = variationObj.optBoolean("reference", false);
-            Modifications modifications = Modifications.parse(campaignId, campaignType, variationGroupId, variationId, isReference, variationObj.getJSONObject("modifications"));
+            Modifications modifications = Modifications.parse(campaignId, campaignType, slug, variationGroupId, variationId, isReference, variationObj.getJSONObject("modifications"));
             int allocation = variationObj.optInt("allocation", bucketingMode ? 0 : 100);
             //In Api mode always 100%, in bucketing mode the variations at 0% are loaded just to check if it matches one in cache at selection time.
             return new Variation(campaignId, variationGroupId, variationId, isReference, modifications, allocation);

flagship/src/main/java/com/abtasty/flagship/model/VariationGroup.java

@@ -81,15 +81,15 @@ public boolean isTargetingValid(HashMap<String, Object> context) {
         return true;
     }
 
-    public static VariationGroup parse(String campaignId, String campaignType, JSONObject variationGroupsObj, boolean bucketing) {
+    public static VariationGroup parse(String campaignId, String campaignType, String slug, JSONObject variationGroupsObj, boolean bucketing) {
         try {
             String variationGroupId = variationGroupsObj.getString(bucketing ? "id" : "variationGroupId");
             TargetingGroups targetingGroups = null;
             LinkedHashMap<String, Variation> variations = new LinkedHashMap<>();
             if (!bucketing) {
                 // api
                 JSONObject variationObj = variationGroupsObj.getJSONObject("variation");
-                Variation variation = Variation.parse(bucketing, campaignId, campaignType, variationGroupId, variationObj);
+                Variation variation = Variation.parse(bucketing, campaignId, campaignType, slug, variationGroupId, variationObj);
                 if (variation != null)
                     variations.put(variation.getVariationId(), variation);
             } else {
@@ -98,7 +98,7 @@ public static VariationGroup parse(String campaignId, String campaignType, JSONO
                 if (variationArr != null) {
                     for (int i = 0; i < variationArr.length(); i++) {
                         JSONObject variationObj = variationArr.getJSONObject(i);
-                            Variation variation = Variation.parse(bucketing, campaignId, campaignType, variationGroupId, variationObj);
+                            Variation variation = Variation.parse(bucketing, campaignId, campaignType, slug, variationGroupId, variationObj);
                             if (variation != null)
                                 variations.put(variation.getVariationId(), variation);
                     }

flagship/src/test/java/FlagshipIntegrationTests.java

@@ -1464,7 +1464,8 @@ public void cacheHit(String visitorId, JSONObject data) {
                                             cacheHitLatch.countDown();
                                             break;
                                         }
-                                        default: {
+                                        case "ACTIVATION": {
+                                            cacheHitLatch.countDown();
                                             break;
                                         }
                                     }
@@ -1477,7 +1478,7 @@ public void cacheHit(String visitorId, JSONObject data) {
 
                             @Override
                             public JSONArray lookupHits(String visitorId) {
-                                JSONArray array;
+                                JSONArray array = new JSONArray();
                                 if (visitorId.equals("visitor_id_2"))
                                     array = new JSONArray("{]"); //shouldn't crash
                                 else {
@@ -1541,7 +1542,7 @@ public void flushHits(String visitorId) {
         assertEquals(8, cacheVisitorLatch.getCount());
         assertEquals(8, lookUpVisitorLatch.getCount());
         assertEquals(9, flushVisitorLatch.getCount());
-        assertEquals(2, cacheHitLatch.getCount());
+        assertEquals(1, cacheHitLatch.getCount());
         assertEquals(8, lookupHitsLatch.getCount());
         assertEquals(9, flushHitsLatch.getCount());
         assertTrue(cacheVisitorOk.get());
@@ -1600,7 +1601,7 @@ public void onLog(Level level, String tag, String message) {
         assertFalse(rank_plus.metadata().isReference);
         assertEquals("ab", rank_plus.metadata().campaignType);
         assertTrue(rank_plus.metadata().exists());
-        assertEquals(5, rank_plus.metadata().toJSON().length());
+        assertEquals(6, rank_plus.metadata().toJSON().length());
 
         Flag<String> do_not_exists = visitor.getFlag("do_not_exists", "a");
 
@@ -1627,6 +1628,12 @@ public void onLog(Level level, String tag, String message) {
         Thread.sleep(1500);
         assertEquals(6, activateLatch.getCount());
 
+        //testing slug
+
+        assertEquals("", visitor.getFlag("visitorIdColor", "#00000000").metadata().slug);
+        assertEquals("campaignSlug", visitor.getFlag("rank_plus", "#00000000").metadata().slug);
+        assertEquals("", visitor.getFlag("eflzjefl", "#00000000").metadata().slug);
+
     }
 
     @Test
@@ -1699,5 +1706,4 @@ public void cache_bucketing() throws InterruptedException, ExecutionException, I
         assertEquals(2, json.getJSONObject("decision_file").getJSONArray("campaigns").length());
 
     }
-
 }

flagship/src/test/resources/bucketing_response_1.json

@@ -234,6 +234,7 @@
     {
       "id": "brjjpk7734cg0sl5llll",
       "type": "ab",
+      "slug": "campaignSlug",
       "variationGroups": [
         {
           "id": "brjjpk7734cg0sl5mmmm",