[CI-3692] Update labels type (#140)

esezen · web-flow · commit b5c554c5cbee · 2024-09-24T13:43:25.000-07:00
* Update labels type

* Lint

* Add more tests

* Lint
diff --git a/constructorio-client/src/main/java/io/constructor/client/models/Result.java b/constructorio-client/src/main/java/io/constructor/client/models/Result.java
@@ -23,7 +23,7 @@ public class Result {
     private Object variationsMap;
 
     @SerializedName("labels")
-    private Map<String, Boolean> labels;
+    private Map<String, Object> labels;
 
     @SerializedName("strategy")
     private Map<String, String> strategy;
@@ -66,7 +66,7 @@ public Object getVariationsMap() {
     /**
      * @return the labels
      */
-    public Map<String, Boolean> getLabels() {
+    public Map<String, Object> getLabels() {
         return labels;
     }
 
@@ -97,7 +97,7 @@ public void setVariationsMap(Object variationsMap) {
         this.variationsMap = variationsMap;
     }
 
-    public void setLabels(Map<String, Boolean> labels) {
+    public void setLabels(Map<String, Object> labels) {
         this.labels = labels;
     }
 
diff --git a/constructorio-client/src/test/java/io/constructor/client/AutocompleteResponseTest.java b/constructorio-client/src/test/java/io/constructor/client/AutocompleteResponseTest.java
@@ -25,7 +25,12 @@ public void createAutocompleteResponseShouldReturnAResult() throws Exception {
         assertTrue("request exists", response.getRequest() != null);
         assertTrue(
                 "labels exists",
-                response.getSections().get("Products").get(0).getLabels().get("is_sponsored"));
+                (Boolean)
+                        response.getSections()
+                                .get("Products")
+                                .get(0)
+                                .getLabels()
+                                .get("is_sponsored"));
         assertEquals("request query exists", response.getRequest().get("query"), "peanut");
     }
 
diff --git a/constructorio-client/src/test/java/io/constructor/client/BrowseResponseTest.java b/constructorio-client/src/test/java/io/constructor/client/BrowseResponseTest.java
@@ -4,6 +4,7 @@
 import static org.junit.Assert.assertTrue;
 
 import io.constructor.client.models.BrowseResponse;
+import java.util.Map;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
@@ -49,7 +50,16 @@ public void createBrowseResponseShouldReturnAResult() throws Exception {
                 562);
         assertTrue(
                 "browse result labels exists",
-                response.getResponse().getResults().get(0).getLabels().get("is_sponsored"));
+                (Boolean)
+                        response.getResponse().getResults().get(0).getLabels().get("is_sponsored"));
+        assertEquals(
+                "browse result labels exists",
+                (String) response.getResponse().getResults().get(0).getLabels().get("foo"),
+                "bar");
+        assertEquals(
+                "browse result labels exists",
+                (Double) response.getResponse().getResults().get(0).getLabels().get("baz"),
+                (Double) 1.0);
         assertTrue("browse result id exists", response.getResultId() != null);
         assertTrue("request exists", response.getRequest() != null);
         assertEquals(
@@ -252,4 +262,28 @@ public void createBrowseResponseShouldReturnAResultWithRefinedContent() throws E
         assertTrue("browse result id exists", response.getResultId() != null);
         assertTrue("request exists", response.getRequest() != null);
     }
+
+    @Test
+    public void createBrowseResponseShouldReturnAResultWithLabels() throws Exception {
+        String string = Utils.getTestResource("response.browse.color.blue.json");
+        BrowseResponse response = ConstructorIO.createBrowseResponse(string);
+        assertEquals(
+                "search result [labels] exists",
+                response.getResponse().getResults().get(0).getLabels().size(),
+                6);
+        assertEquals(
+                "is_sponsored label exists",
+                response.getResponse().getResults().get(0).getLabels().get("is_sponsored"),
+                true);
+        assertEquals(
+                "__cnstrc_new_arrivals label exists and it's a nested object",
+                ((Map<String, Object>)
+                                response.getResponse()
+                                        .getResults()
+                                        .get(0)
+                                        .getLabels()
+                                        .get("__cnstrc_new_arrivals"))
+                        .get("display_name"),
+                "New Arrival");
+    }
 }
diff --git a/constructorio-client/src/test/java/io/constructor/client/ConstructorIOAutocompleteTest.java b/constructorio-client/src/test/java/io/constructor/client/ConstructorIOAutocompleteTest.java
@@ -1,7 +1,6 @@
 package io.constructor.client;
 
 import static org.junit.Assert.*;
-import static org.junit.Assert.assertNotNull;
 
 import com.google.gson.Gson;
 import com.google.gson.internal.LinkedTreeMap;
@@ -138,7 +137,12 @@ public void autocompleteShouldReturnAResultWithLabels() throws Exception {
                 5);
         assertTrue(
                 "autocomplete result labels exists",
-                response.getSections().get("Products").get(0).getLabels().get("is_sponsored"));
+                (Boolean)
+                        response.getSections()
+                                .get("Products")
+                                .get(0)
+                                .getLabels()
+                                .get("is_sponsored"));
     }
 
     @Test
diff --git a/constructorio-client/src/test/java/io/constructor/client/ConstructorIOBrowseTest.java b/constructorio-client/src/test/java/io/constructor/client/ConstructorIOBrowseTest.java
@@ -315,7 +315,8 @@ public void BrowseShouldReturnAResultWithLabels() throws Exception {
         assertEquals("browse results exist", response.getResponse().getResults().size(), 4);
         assertTrue(
                 "browse result labels exist",
-                response.getResponse().getResults().get(0).getLabels().get("is_sponsored"));
+                (Boolean)
+                        response.getResponse().getResults().get(0).getLabels().get("is_sponsored"));
     }
 
     @Test
diff --git a/constructorio-client/src/test/java/io/constructor/client/ConstructorIOSearchTest.java b/constructorio-client/src/test/java/io/constructor/client/ConstructorIOSearchTest.java
@@ -120,7 +120,8 @@ public void SearchShouldReturnAResultWithLabels() throws Exception {
         assertTrue("search results exist", response.getResponse().getResults().size() > 0);
         assertTrue(
                 "labels exist",
-                response.getResponse().getResults().get(0).getLabels().get("is_sponsored"));
+                (Boolean)
+                        response.getResponse().getResults().get(0).getLabels().get("is_sponsored"));
     }
 
     @Test
diff --git a/constructorio-client/src/test/java/io/constructor/client/RecommendationsResponseTest.java b/constructorio-client/src/test/java/io/constructor/client/RecommendationsResponseTest.java
@@ -33,7 +33,8 @@ public void createRecommendationsResponseShouldReturnAResult() throws Exception
         assertTrue("request exists", response.getRequest() != null);
         assertTrue(
                 "recommendation result labels exist",
-                response.getResponse().getResults().get(0).getLabels().get("is_sponsored"));
+                (Boolean)
+                        response.getResponse().getResults().get(0).getLabels().get("is_sponsored"));
         assertEquals(
                 "request filter value exists", response.getRequest().get("item_id"), "109350015");
         assertEquals(
diff --git a/constructorio-client/src/test/java/io/constructor/client/SearchResponseTest.java b/constructorio-client/src/test/java/io/constructor/client/SearchResponseTest.java
@@ -4,6 +4,7 @@
 import static org.junit.Assert.assertTrue;
 
 import io.constructor.client.models.SearchResponse;
+import java.util.Map;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
@@ -146,7 +147,8 @@ public void createSearchResponseShouldReturnAResultWithVariations() throws Excep
                 261);
         assertTrue(
                 "search result labels exist",
-                response.getResponse().getResults().get(0).getLabels().get("is_sponsored"));
+                (Boolean)
+                        response.getResponse().getResults().get(0).getLabels().get("is_sponsored"));
         assertTrue("search result id exists", response.getResultId() != null);
         assertTrue("request exists", response.getRequest() != null);
         assertEquals("request query exists", response.getRequest().get("term"), "jacket");
@@ -236,4 +238,28 @@ public void createSearchResponseShouldReturnAResultWithRefinedContent() throws E
         assertTrue("request exists", response.getRequest() != null);
         assertEquals("request query exists", response.getRequest().get("term"), "item");
     }
+
+    @Test
+    public void createSearchResponseShouldReturnAResultWithLabels() throws Exception {
+        String string = Utils.getTestResource("response.search.item.json");
+        SearchResponse response = ConstructorIO.createSearchResponse(string);
+        assertEquals(
+                "search result [labels] exists",
+                response.getResponse().getResults().get(0).getLabels().size(),
+                4);
+        assertEquals(
+                "is_sponsored label exists",
+                response.getResponse().getResults().get(0).getLabels().get("is_sponsored"),
+                true);
+        assertEquals(
+                "__cnstrc_new_arrivals label exists and it's a nested object",
+                ((Map<String, Object>)
+                                response.getResponse()
+                                        .getResults()
+                                        .get(0)
+                                        .getLabels()
+                                        .get("__cnstrc_new_arrivals"))
+                        .get("display_name"),
+                "New Arrival");
+    }
 }
diff --git a/constructorio-client/src/test/resources/response.browse.color.blue.json b/constructorio-client/src/test/resources/response.browse.color.blue.json
@@ -1307,7 +1307,12 @@
         "value": "Coat Aspesi blue"
       }],
       "labels": {
-        "is_sponsored": true
+        "is_sponsored": true,
+        "foo": "bar",
+        "baz": 1,
+        "__cnstrc_new_arrivals": { "display_name": "New Arrival" },
+        "__cnstrc_best_sellers": { "display_name": "Bestseller" },
+        "__cnstrc_trending_now": { "display_name": "Trending Now" }
       }
     }, {
       "data": {
diff --git a/constructorio-client/src/test/resources/response.search.item.json b/constructorio-client/src/test/resources/response.search.item.json
@@ -48,7 +48,10 @@
       "value": "Item5",
       "is_slotted": true,
       "labels": {
-        "is_sponsored": true
+        "is_sponsored": true,
+        "__cnstrc_new_arrivals": { "display_name": "New Arrival" },
+        "__cnstrc_best_sellers": { "display_name": "Bestseller" },
+        "__cnstrc_trending_now": { "display_name": "Trending Now" }
       }
     }, {
       "matched_terms": ["item"],
@@ -225,4 +228,4 @@
       }]
     }
   }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -315,7 +315,8 @@ public void BrowseShouldReturnAResultWithLabels() throws Exception {`
`315`	`315`	`assertEquals("browse results exist", response.getResponse().getResults().size(), 4);`
`316`	`316`	`assertTrue(`
`317`	`317`	`"browse result labels exist",`
`318`		`- response.getResponse().getResults().get(0).getLabels().get("is_sponsored"));`
	`318`	`+ (Boolean)`
	`319`	`+ response.getResponse().getResults().get(0).getLabels().get("is_sponsored"));`
`319`	`320`	`}`
`320`	`321`
`321`	`322`	`@Test`
Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,8 @@ public void SearchShouldReturnAResultWithLabels() throws Exception {`
`120`	`120`	`assertTrue("search results exist", response.getResponse().getResults().size() > 0);`
`121`	`121`	`assertTrue(`
`122`	`122`	`"labels exist",`
`123`		`- response.getResponse().getResults().get(0).getLabels().get("is_sponsored"));`
	`123`	`+ (Boolean)`
	`124`	`+ response.getResponse().getResults().get(0).getLabels().get("is_sponsored"));`
`124`	`125`	`}`
`125`	`126`
`126`	`127`	`@Test`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,10 @@`
`48`	`48`	`"value": "Item5",`
`49`	`49`	`"is_slotted": true,`
`50`	`50`	`"labels": {`
`51`		`- "is_sponsored": true`
	`51`	`+ "is_sponsored": true,`
	`52`	`+ "__cnstrc_new_arrivals": { "display_name": "New Arrival" },`
	`53`	`+ "__cnstrc_best_sellers": { "display_name": "Bestseller" },`
	`54`	`+ "__cnstrc_trending_now": { "display_name": "Trending Now" }`
`52`	`55`	`}`
`53`	`56`	`}, {`
`54`	`57`	`"matched_terms": ["item"],`
`@@ -225,4 +228,4 @@`
`225`	`228`	`}]`
`226`	`229`	`}`
`227`	`230`	`}`
`228`		`-}`
	`231`	`+}`