add escaping to the DSL

Author: aallam

src/commonMain/kotlin/com/algolia/search/dsl/DSLQuery.kt

@@ -49,29 +49,41 @@ public fun Query.filters(block: DSLFilters.() -> Unit) {
 /**
  * Use [FilterGroupsConverter.Legacy] on the [block] output and assign it to [Query.optionalFilters].
  */
-public fun Query.optionalFilters(block: DSLFacetFilters.() -> Unit) {
-    optionalFilters = FilterGroupsConverter.Legacy.Facet(DSLFacetFilters(block))
+public fun Query.optionalFilters(escape: Boolean = true, block: DSLFacetFilters.() -> Unit) {
+    optionalFilters = when(escape) {
+        true -> FilterGroupsConverter.Legacy.Facet(DSLFacetFilters(block))
+        false -> FilterGroupsConverter.Legacy.Facet.Unquoted(DSLFacetFilters(block))
+    }
 }
 
 /**
  * Use [FilterGroupsConverter.Legacy] on the [block] output and assign it to [Query.facetFilters].
  */
-public fun Query.facetFilters(block: DSLFacetFilters.() -> Unit) {
-    facetFilters = FilterGroupsConverter.Legacy.Facet(DSLFacetFilters(block))
+public fun Query.facetFilters(escape: Boolean = true, block: DSLFacetFilters.() -> Unit) {
+    facetFilters = when(escape) {
+        true -> FilterGroupsConverter.Legacy.Facet(DSLFacetFilters(block))
+        false -> FilterGroupsConverter.Legacy.Facet.Unquoted(DSLFacetFilters(block))
+    }
 }
 
 /**
  * Use [FilterGroupsConverter.Legacy] on the [block] output and assign it to [Query.numericFilters].
  */
-public fun Query.numericFilters(block: DSLNumericFilters.() -> Unit) {
-    numericFilters = FilterGroupsConverter.Legacy.Numeric(DSLNumericFilters(block))
+public fun Query.numericFilters(escape: Boolean = true, block: DSLNumericFilters.() -> Unit) {
+    numericFilters = when(escape) {
+        true -> FilterGroupsConverter.Legacy.Numeric(DSLNumericFilters(block))
+        false -> FilterGroupsConverter.Legacy.Numeric.Unquoted(DSLNumericFilters(block))
+    }
 }
 
 /**
  * Use [FilterGroupsConverter.Legacy] on the [block] output and assign it to [Query.tagFilters].
  */
-public fun Query.tagFilters(block: DSLTagFilters.() -> Unit) {
-    tagFilters = FilterGroupsConverter.Legacy.Tag(DSLTagFilters(block))
+public fun Query.tagFilters(escape: Boolean = true, block: DSLTagFilters.() -> Unit) {
+    tagFilters = when (escape) {
+        true -> FilterGroupsConverter.Legacy.Tag(DSLTagFilters(block))
+        false -> FilterGroupsConverter.Legacy.Tag.Unquoted(DSLTagFilters(block))
+    }
 }
 
 /**

src/commonTest/kotlin/dsl/TestDSLQuery.kt

@@ -30,6 +30,7 @@ import com.algolia.search.model.search.Polygon
 import shouldNotBeNull
 import unknown
 import kotlin.test.Test
+import kotlin.test.assertEquals
 
 internal class TestDSLQuery {
 
@@ -71,6 +72,19 @@ internal class TestDSLQuery {
         }
 
         query.facetFilters!!.isNotEmpty()
+        assertEquals(listOf(listOf("\"attributeA\":0")), query.facetFilters)
+    }
+
+    @Test
+    fun facetFiltersUnquoted() {
+        val query = query {
+            facetFilters(escape = false) {
+                and { facet(attributeA, 0) }
+            }
+        }
+
+        query.facetFilters!!.isNotEmpty()
+        assertEquals(listOf(listOf("attributeA:0")), query.facetFilters)
     }
 
     @Test
@@ -82,6 +96,19 @@ internal class TestDSLQuery {
         }
 
         query.numericFilters!!.isNotEmpty()
+        assertEquals(listOf(listOf("\"attributeA\" >= 0"), listOf("\"attributeA\" <= 1")), query.numericFilters)
+    }
+
+    @Test
+    fun numericFiltersUnquoted() {
+        val query = query {
+            numericFilters(escape = false) {
+                and { range(attributeA, 0..1) }
+            }
+        }
+
+        query.numericFilters!!.isNotEmpty()
+        assertEquals(listOf(listOf("attributeA >= 0"), listOf("attributeA <= 1")), query.numericFilters)
     }
 
     @Test
@@ -93,6 +120,19 @@ internal class TestDSLQuery {
         }
 
         query.tagFilters!!.isNotEmpty()
+        assertEquals(listOf(listOf("_tags:\"unknown\"")), query.tagFilters)
+    }
+
+    @Test
+    fun tagFiltersUnquoted() {
+        val query = query {
+            tagFilters(escape = false) {
+                and { tag(unknown) }
+            }
+        }
+
+        query.tagFilters!!.isNotEmpty()
+        assertEquals(listOf(listOf("_tags:unknown")), query.tagFilters)
     }
 
     @Test
@@ -104,6 +144,19 @@ internal class TestDSLQuery {
         }
 
         query.optionalFilters!!.isNotEmpty()
+        assertEquals(listOf(listOf("\"attributeA\":0")), query.optionalFilters)
+    }
+
+    @Test
+    fun optionalFiltersUnquoted() {
+        val query = query {
+            optionalFilters(escape = false) {
+                and { facet(attributeA, 0) }
+            }
+        }
+
+        query.optionalFilters!!.isNotEmpty()
+        assertEquals(listOf(listOf("attributeA:0")), query.optionalFilters)
     }
 
     @Test