fix: filters dsl defaults (#342)

aallam · web-flow · commit 7ebdee38c568 · 2022-06-15T17:10:28.000+02:00
diff --git a/client/src/commonMain/kotlin/com/algolia/search/dsl/DSLQuery.kt b/client/src/commonMain/kotlin/com/algolia/search/dsl/DSLQuery.kt
@@ -49,7 +49,7 @@ public fun Query.filters(block: DSLFilters.() -> Unit) {
 /**
  * Use [FilterGroupsConverter.Legacy] on the [block] output and assign it to [Query.optionalFilters].
  */
-public fun Query.optionalFilters(escape: Boolean = true, block: DSLFacetFilters.() -> Unit) {
+public fun Query.optionalFilters(escape: Boolean = false, block: DSLFacetFilters.() -> Unit) {
     optionalFilters = when (escape) {
         true -> FilterGroupsConverter.Legacy.Facet(DSLFacetFilters(block))
         false -> FilterGroupsConverter.Legacy.Facet.Unquoted(DSLFacetFilters(block))
@@ -59,7 +59,7 @@ public fun Query.optionalFilters(escape: Boolean = true, block: DSLFacetFilters.
 /**
  * Use [FilterGroupsConverter.Legacy] on the [block] output and assign it to [Query.facetFilters].
  */
-public fun Query.facetFilters(escape: Boolean = true, block: DSLFacetFilters.() -> Unit) {
+public fun Query.facetFilters(escape: Boolean = false, block: DSLFacetFilters.() -> Unit) {
     facetFilters = when (escape) {
         true -> FilterGroupsConverter.Legacy.Facet(DSLFacetFilters(block))
         false -> FilterGroupsConverter.Legacy.Facet.Unquoted(DSLFacetFilters(block))
@@ -69,7 +69,7 @@ public fun Query.facetFilters(escape: Boolean = true, block: DSLFacetFilters.()
 /**
  * Use [FilterGroupsConverter.Legacy] on the [block] output and assign it to [Query.numericFilters].
  */
-public fun Query.numericFilters(escape: Boolean = true, block: DSLNumericFilters.() -> Unit) {
+public fun Query.numericFilters(escape: Boolean = false, block: DSLNumericFilters.() -> Unit) {
     numericFilters = when (escape) {
         true -> FilterGroupsConverter.Legacy.Numeric(DSLNumericFilters(block))
         false -> FilterGroupsConverter.Legacy.Numeric.Unquoted(DSLNumericFilters(block))
@@ -79,7 +79,7 @@ public fun Query.numericFilters(escape: Boolean = true, block: DSLNumericFilters
 /**
  * Use [FilterGroupsConverter.Legacy] on the [block] output and assign it to [Query.tagFilters].
  */
-public fun Query.tagFilters(escape: Boolean = true, block: DSLTagFilters.() -> Unit) {
+public fun Query.tagFilters(escape: Boolean = false, block: DSLTagFilters.() -> Unit) {
     tagFilters = when (escape) {
         true -> FilterGroupsConverter.Legacy.Tag(DSLTagFilters(block))
         false -> FilterGroupsConverter.Legacy.Tag.Unquoted(DSLTagFilters(block))
diff --git a/client/src/commonMain/kotlin/com/algolia/search/model/filter/internal/Filter.kt b/client/src/commonMain/kotlin/com/algolia/search/model/filter/internal/Filter.kt
@@ -112,5 +112,5 @@ internal fun Filter.Tag.toLegacy(escape: Boolean): List<String> {
     val raw = if (escape) value.escape() else value
     val value = if (isNegated) "-$raw" else raw
 
-    return listOf("$attribute:$value")
+    return listOf(value)
 }
diff --git a/client/src/commonTest/kotlin/dsl/TestDSLQuery.kt b/client/src/commonTest/kotlin/dsl/TestDSLQuery.kt
@@ -72,25 +72,25 @@ internal class TestDSLQuery {
         }
 
         query.facetFilters!!.isNotEmpty()
-        assertEquals(listOf(listOf("\"attributeA\":0")), query.facetFilters)
+        assertEquals(listOf(listOf("attributeA:0")), query.facetFilters)
     }
 
     @Test
     fun facetFiltersUnquoted() {
         val query = query {
-            facetFilters(escape = false) {
+            facetFilters(escape = true) {
                 and { facet(attributeA, 0) }
             }
         }
 
         query.facetFilters!!.isNotEmpty()
-        assertEquals(listOf(listOf("attributeA:0")), query.facetFilters)
+        assertEquals(listOf(listOf("\"attributeA\":0")), query.facetFilters)
     }
 
     @Test
     fun numericFilters() {
         val query = query {
-            numericFilters {
+            numericFilters(escape = true) {
                 and { range(attributeA, 0..1) }
             }
         }
@@ -102,7 +102,7 @@ internal class TestDSLQuery {
     @Test
     fun numericFiltersUnquoted() {
         val query = query {
-            numericFilters(escape = false) {
+            numericFilters {
                 and { range(attributeA, 0..1) }
             }
         }
@@ -120,19 +120,19 @@ internal class TestDSLQuery {
         }
 
         query.tagFilters!!.isNotEmpty()
-        assertEquals(listOf(listOf("_tags:\"unknown\"")), query.tagFilters)
+        assertEquals(listOf(listOf("unknown")), query.tagFilters)
     }
 
     @Test
     fun tagFiltersUnquoted() {
         val query = query {
-            tagFilters(escape = false) {
+            tagFilters(escape = true) {
                 and { tag(unknown) }
             }
         }
 
         query.tagFilters!!.isNotEmpty()
-        assertEquals(listOf(listOf("_tags:unknown")), query.tagFilters)
+        assertEquals(listOf(listOf("\"unknown\"")), query.tagFilters)
     }
 
     @Test
@@ -144,19 +144,19 @@ internal class TestDSLQuery {
         }
 
         query.optionalFilters!!.isNotEmpty()
-        assertEquals(listOf(listOf("\"attributeA\":0")), query.optionalFilters)
+        assertEquals(listOf(listOf("attributeA:0")), query.optionalFilters)
     }
 
     @Test
     fun optionalFiltersUnquoted() {
         val query = query {
-            optionalFilters(escape = false) {
+            optionalFilters(escape = true) {
                 and { facet(attributeA, 0) }
             }
         }
 
         query.optionalFilters!!.isNotEmpty()
-        assertEquals(listOf(listOf("attributeA:0")), query.optionalFilters)
+        assertEquals(listOf(listOf("\"attributeA\":0")), query.optionalFilters)
     }
 
     @Test
diff --git a/client/src/commonTest/kotlin/model/filter/TestFilterGroupsConverter.kt b/client/src/commonTest/kotlin/model/filter/TestFilterGroupsConverter.kt
@@ -29,7 +29,7 @@ internal class TestFilterGroupsConverter {
                 and { range(attributeA, 0..10, isNegated = true) }
             }
         }
-        query.numericFilters shouldEqual listOf(listOf("\"attributeA\" < 0"), listOf("\"attributeA\" > 10"))
+        query.numericFilters shouldEqual listOf(listOf("attributeA < 0"), listOf("attributeA > 10"))
     }
 
     @Test
@@ -48,9 +48,9 @@ internal class TestFilterGroupsConverter {
         }
 
         query.facetFilters shouldEqual listOf(
-            listOf("\"attributeA\":\"unknown\""),
-            listOf("\"attributeB\":\"unknown\""),
-            listOf("\"attributeA\":\"unknown\"", "\"attributeB\":\"unknown\"")
+            listOf("attributeA:unknown"),
+            listOf("attributeB:unknown"),
+            listOf("attributeA:unknown", "attributeB:unknown")
         )
     }
 }
diff --git a/client/src/commonTest/kotlin/model/filter/TestFilterTag.kt b/client/src/commonTest/kotlin/model/filter/TestFilterTag.kt
@@ -17,13 +17,13 @@ internal class TestFilterTag {
 
     @Test
     fun legacy() {
-        FilterConverter.Legacy(filter) shouldEqual listOf("_tags:\"valueA\"")
-        FilterConverter.Legacy(!filter) shouldEqual listOf("_tags:-\"valueA\"")
+        FilterConverter.Legacy(filter) shouldEqual listOf("\"valueA\"")
+        FilterConverter.Legacy(!filter) shouldEqual listOf("-\"valueA\"")
     }
 
     @Test
     fun legacyUnquoted() {
-        FilterConverter.Legacy.Unquoted(filter) shouldEqual listOf("_tags:valueA")
-        FilterConverter.Legacy.Unquoted(!filter) shouldEqual listOf("_tags:-valueA")
+        FilterConverter.Legacy.Unquoted(filter) shouldEqual listOf("valueA")
+        FilterConverter.Legacy.Unquoted(!filter) shouldEqual listOf("-valueA")
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -112,5 +112,5 @@ internal fun Filter.Tag.toLegacy(escape: Boolean): List<String> {`
`112`	`112`	`val raw = if (escape) value.escape() else value`
`113`	`113`	`val value = if (isNegated) "-$raw" else raw`
`114`	`114`
`115`		`- return listOf("$attribute:$value")`
	`115`	`+ return listOf(value)`
`116`	`116`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,25 +72,25 @@ internal class TestDSLQuery {`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`query.facetFilters!!.isNotEmpty()`
`75`		`- assertEquals(listOf(listOf("\"attributeA\":0")), query.facetFilters)`
	`75`	`+ assertEquals(listOf(listOf("attributeA:0")), query.facetFilters)`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`@Test`
`79`	`79`	`fun facetFiltersUnquoted() {`
`80`	`80`	`val query = query {`
`81`		`- facetFilters(escape = false) {`
	`81`	`+ facetFilters(escape = true) {`
`82`	`82`	`and { facet(attributeA, 0) }`
`83`	`83`	`}`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`query.facetFilters!!.isNotEmpty()`
`87`		`- assertEquals(listOf(listOf("attributeA:0")), query.facetFilters)`
	`87`	`+ assertEquals(listOf(listOf("\"attributeA\":0")), query.facetFilters)`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`@Test`
`91`	`91`	`fun numericFilters() {`
`92`	`92`	`val query = query {`
`93`		`- numericFilters {`
	`93`	`+ numericFilters(escape = true) {`
`94`	`94`	`and { range(attributeA, 0..1) }`
`95`	`95`	`}`
`96`	`96`	`}`
`@@ -102,7 +102,7 @@ internal class TestDSLQuery {`
`102`	`102`	`@Test`
`103`	`103`	`fun numericFiltersUnquoted() {`
`104`	`104`	`val query = query {`
`105`		`- numericFilters(escape = false) {`
	`105`	`+ numericFilters {`
`106`	`106`	`and { range(attributeA, 0..1) }`
`107`	`107`	`}`
`108`	`108`	`}`
`@@ -120,19 +120,19 @@ internal class TestDSLQuery {`
`120`	`120`	`}`
`121`	`121`
`122`	`122`	`query.tagFilters!!.isNotEmpty()`
`123`		`- assertEquals(listOf(listOf("_tags:\"unknown\"")), query.tagFilters)`
	`123`	`+ assertEquals(listOf(listOf("unknown")), query.tagFilters)`
`124`	`124`	`}`
`125`	`125`
`126`	`126`	`@Test`
`127`	`127`	`fun tagFiltersUnquoted() {`
`128`	`128`	`val query = query {`
`129`		`- tagFilters(escape = false) {`
	`129`	`+ tagFilters(escape = true) {`
`130`	`130`	`and { tag(unknown) }`
`131`	`131`	`}`
`132`	`132`	`}`
`133`	`133`
`134`	`134`	`query.tagFilters!!.isNotEmpty()`
`135`		`- assertEquals(listOf(listOf("_tags:unknown")), query.tagFilters)`
	`135`	`+ assertEquals(listOf(listOf("\"unknown\"")), query.tagFilters)`
`136`	`136`	`}`
`137`	`137`
`138`	`138`	`@Test`
`@@ -144,19 +144,19 @@ internal class TestDSLQuery {`
`144`	`144`	`}`
`145`	`145`
`146`	`146`	`query.optionalFilters!!.isNotEmpty()`
`147`		`- assertEquals(listOf(listOf("\"attributeA\":0")), query.optionalFilters)`
	`147`	`+ assertEquals(listOf(listOf("attributeA:0")), query.optionalFilters)`
`148`	`148`	`}`
`149`	`149`
`150`	`150`	`@Test`
`151`	`151`	`fun optionalFiltersUnquoted() {`
`152`	`152`	`val query = query {`
`153`		`- optionalFilters(escape = false) {`
	`153`	`+ optionalFilters(escape = true) {`
`154`	`154`	`and { facet(attributeA, 0) }`
`155`	`155`	`}`
`156`	`156`	`}`
`157`	`157`
`158`	`158`	`query.optionalFilters!!.isNotEmpty()`
`159`		`- assertEquals(listOf(listOf("attributeA:0")), query.optionalFilters)`
	`159`	`+ assertEquals(listOf(listOf("\"attributeA\":0")), query.optionalFilters)`
`160`	`160`	`}`
`161`	`161`
`162`	`162`	`@Test`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ internal class TestFilterGroupsConverter {`
`29`	`29`	`and { range(attributeA, 0..10, isNegated = true) }`
`30`	`30`	`}`
`31`	`31`	`}`
`32`		`- query.numericFilters shouldEqual listOf(listOf("\"attributeA\" < 0"), listOf("\"attributeA\" > 10"))`
	`32`	`+ query.numericFilters shouldEqual listOf(listOf("attributeA < 0"), listOf("attributeA > 10"))`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`@Test`
`@@ -48,9 +48,9 @@ internal class TestFilterGroupsConverter {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`query.facetFilters shouldEqual listOf(`
`51`		`- listOf("\"attributeA\":\"unknown\""),`
`52`		`- listOf("\"attributeB\":\"unknown\""),`
`53`		`- listOf("\"attributeA\":\"unknown\"", "\"attributeB\":\"unknown\"")`
	`51`	`+ listOf("attributeA:unknown"),`
	`52`	`+ listOf("attributeB:unknown"),`
	`53`	`+ listOf("attributeA:unknown", "attributeB:unknown")`
`54`	`54`	`)`
`55`	`55`	`}`
`56`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,13 +17,13 @@ internal class TestFilterTag {`
`17`	`17`
`18`	`18`	`@Test`
`19`	`19`	`fun legacy() {`
`20`		`- FilterConverter.Legacy(filter) shouldEqual listOf("_tags:\"valueA\"")`
`21`		`- FilterConverter.Legacy(!filter) shouldEqual listOf("_tags:-\"valueA\"")`
	`20`	`+ FilterConverter.Legacy(filter) shouldEqual listOf("\"valueA\"")`
	`21`	`+ FilterConverter.Legacy(!filter) shouldEqual listOf("-\"valueA\"")`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`@Test`
`25`	`25`	`fun legacyUnquoted() {`
`26`		`- FilterConverter.Legacy.Unquoted(filter) shouldEqual listOf("_tags:valueA")`
`27`		`- FilterConverter.Legacy.Unquoted(!filter) shouldEqual listOf("_tags:-valueA")`
	`26`	`+ FilterConverter.Legacy.Unquoted(filter) shouldEqual listOf("valueA")`
	`27`	`+ FilterConverter.Legacy.Unquoted(!filter) shouldEqual listOf("-valueA")`
`28`	`28`	`}`
`29`	`29`	`}`