[CI-3945] Support Fmt Options (#144)

stanlp1 · web-flow · commit 373368225146 · 2024-11-05T16:24:21.000-08:00
* support fmt options

* Add boolean case
diff --git a/library/src/main/java/io/constructor/core/ConstructorIo.kt b/library/src/main/java/io/constructor/core/ConstructorIo.kt
diff --git a/library/src/main/java/io/constructor/data/builder/BrowseItemsRequest.kt b/library/src/main/java/io/constructor/data/builder/BrowseItemsRequest.kt
@@ -19,6 +19,7 @@ class BrowseItemsRequest (
     val groupsSortOrder: String? = null,
     val variationsMap: VariationsMap? = null,
     val preFilterExpression: String? = null,
+    val fmtOptions: Map<String, Any>? = null,
 ) {
     private constructor(builder: Builder) : this(
         builder.ids,
@@ -34,6 +35,7 @@ class BrowseItemsRequest (
         builder.groupsSortOrder,
         builder.variationsMap,
         builder.preFilterExpression,
+        builder.fmtOptions,
     )
 
     companion object {
@@ -55,6 +57,7 @@ class BrowseItemsRequest (
         var groupsSortOrder: String? = null
         var variationsMap: VariationsMap? = null
         var preFilterExpression: String? = null
+        var fmtOptions: Map<String, Any>? = null
 
         fun setFilters(facets: Map<String, List<String>>): Builder = apply { this.filters = facets }
         fun setPage(page: Int): Builder = apply { this.page = page }
@@ -68,6 +71,7 @@ class BrowseItemsRequest (
         fun setGroupsSortOrder(groupsSortOrder: String): Builder = apply { this.groupsSortOrder = groupsSortOrder }
         fun setVariationsMap(variationsMap: VariationsMap): Builder = apply { this.variationsMap = variationsMap }
         fun setPreFilterExpression(preFilterExpression: String): Builder = apply { this.preFilterExpression = preFilterExpression }
+        fun setFmtOptions(fmtOptions: Map<String, Any>): Builder = apply { this.fmtOptions = fmtOptions }
         fun build(): BrowseItemsRequest = BrowseItemsRequest(this)
     }
 }
diff --git a/library/src/main/java/io/constructor/data/builder/BrowseRequest.kt b/library/src/main/java/io/constructor/data/builder/BrowseRequest.kt
@@ -20,6 +20,7 @@ class BrowseRequest (
     val groupsSortOrder: String? = null,
     val variationsMap: VariationsMap? = null,
     val preFilterExpression: String? = null,
+    val fmtOptions: Map<String, Any>? = null,
 ) {
     private constructor(builder: Builder) : this(
         builder.filterName,
@@ -36,6 +37,7 @@ class BrowseRequest (
         builder.groupsSortOrder,
         builder.variationsMap,
         builder.preFilterExpression,
+        builder.fmtOptions,
     )
 
     companion object {
@@ -58,6 +60,7 @@ class BrowseRequest (
         var groupsSortOrder: String? = null
         var variationsMap: VariationsMap? = null
         var preFilterExpression: String? = null
+        var fmtOptions: Map<String, Any>? = null
 
         fun setFilters(facets: Map<String, List<String>>): Builder = apply { this.filters = facets }
         fun setPage(page: Int): Builder = apply { this.page = page }
@@ -71,6 +74,7 @@ class BrowseRequest (
         fun setGroupsSortOrder(groupsSortOrder: String): Builder = apply { this.groupsSortOrder = groupsSortOrder }
         fun setVariationsMap(variationsMap: VariationsMap): Builder = apply { this.variationsMap = variationsMap }
         fun setPreFilterExpression(preFilterExpression: String): Builder = apply { this.preFilterExpression = preFilterExpression }
+        fun setFmtOptions(fmtOptions: Map<String, Any>): Builder = apply { this.fmtOptions = fmtOptions }
         fun build(): BrowseRequest = BrowseRequest(this)
     }
 }
diff --git a/library/src/main/java/io/constructor/data/builder/SearchRequest.kt b/library/src/main/java/io/constructor/data/builder/SearchRequest.kt
@@ -19,6 +19,7 @@ class SearchRequest (
     val groupsSortOrder: String? = null,
     val variationsMap: VariationsMap? = null,
     val preFilterExpression: String? = null,
+    val fmtOptions: Map<String, Any>? = null,
 ) {
     private constructor(builder: Builder) : this(
         builder.term,
@@ -33,7 +34,8 @@ class SearchRequest (
         builder.groupsSortBy,
         builder.groupsSortOrder,
         builder.variationsMap,
-        builder.preFilterExpression
+        builder.preFilterExpression,
+        builder.fmtOptions,
     )
 
     companion object {
@@ -55,6 +57,7 @@ class SearchRequest (
         var groupsSortOrder: String? = null
         var variationsMap: VariationsMap? = null
         var preFilterExpression: String? = null
+        var fmtOptions: Map<String, Any>? = null
 
 
         fun setFilters(facets: Map<String, List<String>>): Builder = apply { this.filters = facets }
@@ -69,6 +72,7 @@ class SearchRequest (
         fun setGroupsSortOrder(groupsSortOrder: String): Builder = apply { this.groupsSortOrder = groupsSortOrder }
         fun setVariationsMap(variationsMap: VariationsMap): Builder = apply { this.variationsMap = variationsMap }
         fun setPreFilterExpression(preFilterExpression: String): Builder = apply { this.preFilterExpression = preFilterExpression }
+        fun setFmtOptions(fmtOptions: Map<String, Any>): Builder = apply { this.fmtOptions = fmtOptions }
         fun build(): SearchRequest = SearchRequest(this)
     }
 }
diff --git a/library/src/test/java/io/constructor/core/ConstructorIoIntegrationTest.kt b/library/src/test/java/io/constructor/core/ConstructorIoIntegrationTest.kt
@@ -1224,6 +1224,23 @@ class ConstructorIoIntegrationTest {
         Thread.sleep(timeBetweenTests)
     }
 
+    @Test
+    fun getSearchResultsWithFmtOptionsAgainstRealResponse() {
+        val observer = constructorIo.getSearchResults(
+                term = "item1",
+                fmtOptions = mapOf("groups_sort_order" to "ascending", "groups_sort_by" to "value", "groups_start" to "group_id:Brands", "fields" to listOf("test", "test2"))
+        ).test()
+        observer.assertComplete()
+        observer.assertNoErrors()
+
+        val searchResponse = observer.values()[0].get()
+        assertTrue(searchResponse?.resultId !== null)
+        assertTrue(searchResponse?.response?.groups!!.isNotEmpty())
+        assertEquals(searchResponse?.response?.groups?.get(0)?.displayName, "Brands")
+
+        Thread.sleep(timeBetweenTests)
+    }
+
     @Test
     fun getSearchResultsWithGroupsSortValueDescendingAgainstRealResponse() {
         val observer = constructorIo.getSearchResults(
@@ -1621,6 +1638,24 @@ class ConstructorIoIntegrationTest {
         Thread.sleep(timeBetweenTests)
     }
 
+    @Test
+    fun getBrowseResultsWithFmtOptionsAgainstRealResponse() {
+        val observer = constructorIo.getBrowseResults(
+                filterName = "Brand",
+                filterValue = "XYZ",
+                fmtOptions = mapOf("groups_sort_order" to "ascending", "groups_sort_by" to "value", "groups_start" to "group_id:Brands", "fields" to listOf("test", "test2"))
+        ).test()
+        observer.assertComplete()
+        observer.assertNoErrors()
+
+        val browseResponse = observer.values()[0].get()
+        assertTrue(browseResponse?.resultId !== null)
+        assertTrue(browseResponse?.response?.groups!!.isNotEmpty())
+        assertEquals(browseResponse?.response?.groups?.get(0)?.displayName, "Brands")
+
+        Thread.sleep(timeBetweenTests)
+    }
+
     @Test
     fun getBrowseResultsWithGroupsSortValueAscendingAgainstRealResponse() {
         val observer = constructorIo.getBrowseResults(
diff --git a/library/src/test/java/io/constructor/core/ConstructorioBrowseItemsTest.kt b/library/src/test/java/io/constructor/core/ConstructorioBrowseItemsTest.kt
@@ -226,6 +226,21 @@ class ConstructorIoBrowseItemsTest {
         assert(request.path!!.startsWith(path))
     }
 
+    @Test
+    fun getBrowseResultWithFmtOptions() {
+        val mockResponse = MockResponse().setResponseCode(200)
+                .setBody(TestDataLoader.loadAsString("browse_response.json"))
+        mockServer.enqueue(mockResponse)
+        val fmtOptions = mapOf("groups_start" to 5,"show_hidden_facets" to false, "groups_sort_order" to "ascending", "fields" to listOf(false, "test2"))
+        val browseItemsRequest = BrowseItemsRequest.Builder(ids)
+                .setFmtOptions(fmtOptions)
+                .build()
+        val observer = constructorIo.getBrowseItemsResults(browseItemsRequest).test()
+        val request = mockServer.takeRequest()
+        val path = "/browse/items?fmt_options%5Bgroups_start%5D=5&fmt_options%5Bshow_hidden_facets%5D=false&fmt_options%5Bgroups_sort_order%5D=ascending&fmt_options%5Bfields%5D=false&fmt_options%5Bfields%5D=test2&ids=10001&ids=dai_pid_2003597&key=silver-key&i=guapo-the-guid&ui=player-two&s=92&c=cioand-2.32.0&_dt="
+        assert(request.path!!.startsWith(path))
+    }
+
     @Test
     fun getBrowseItemsResultsWithVariationsMapsUsingBuilder() {
         val mockResponse = MockResponse().setResponseCode(200)
diff --git a/library/src/test/java/io/constructor/core/ConstructorioBrowseTest.kt b/library/src/test/java/io/constructor/core/ConstructorioBrowseTest.kt
@@ -261,6 +261,23 @@ class ConstructorIoBrowseTest {
         assert(request.path!!.startsWith(path))
     }
 
+    @Test
+    fun getBrowseResultWithFmtOptions() {
+        val mockResponse = MockResponse().setResponseCode(200)
+                .setBody(TestDataLoader.loadAsString("browse_response.json"))
+        mockServer.enqueue(mockResponse)
+        val fmtOptions = mapOf("groups_start" to 5,"show_hidden_facets" to false, "groups_sort_order" to "ascending", "fields" to listOf(false, "test2"))
+        val observer = constructorIo.getBrowseResults(
+                filterName = "group_id",
+                filterValue = "Beverages",
+                fmtOptions = fmtOptions
+        ).test()
+        val request = mockServer.takeRequest()
+        val path =
+                "/browse/group_id/Beverages?fmt_options%5Bgroups_start%5D=5&fmt_options%5Bshow_hidden_facets%5D=false&fmt_options%5Bgroups_sort_order%5D=ascending&fmt_options%5Bfields%5D=false&fmt_options%5Bfields%5D=test2&key=silver-key&i=guapo-the-guid&ui=player-two&s=92&c=cioand-2.32.0&_dt="
+        assert(request.path!!.startsWith(path))
+    }
+
     @Test
     fun getBrowseResultWithPreFilterExpression() {
         val mockResponse = MockResponse().setResponseCode(200)
diff --git a/library/src/test/java/io/constructor/core/ConstructorioSearchTest.kt b/library/src/test/java/io/constructor/core/ConstructorioSearchTest.kt
@@ -279,6 +279,22 @@ class ConstructorIoSearchTest {
         assert(request.path!!.startsWith(path))
     }
 
+    @Test
+    fun getSearchResultsWithFmtOptions() {
+        val mockResponse = MockResponse().setResponseCode(200)
+                .setBody(TestDataLoader.loadAsString("search_response.json"))
+        mockServer.enqueue(mockResponse)
+        val fmtOptions = mapOf("groups_start" to 5,"show_hidden_facets" to false, "groups_sort_order" to "ascending", "fields" to listOf(false, "test2"))
+        val observer = constructorIo.getSearchResults(
+                term = "bbq",
+                fmtOptions = fmtOptions,
+        ).test()
+        val request = mockServer.takeRequest()
+        val path =
+                "/search/bbq?fmt_options%5Bgroups_start%5D=5&fmt_options%5Bshow_hidden_facets%5D=false&fmt_options%5Bgroups_sort_order%5D=ascending&fmt_options%5Bfields%5D=false&fmt_options%5Bfields%5D=test2&key=silver-key&i=guapo-the-guid&ui=player-two&s=92&c=cioand-2.32.0&_dt="
+        assert(request.path!!.startsWith(path))
+    }
+
     @Test
     fun getSearchResultsWithFiltersUsingBuilder() {
         val mockResponse = MockResponse().setResponseCode(200)
