Contextual rules

Author: q-litzler

src/commonMain/kotlin/com/algolia/search/model/rule/Condition.kt

@@ -10,8 +10,8 @@ import kotlinx.serialization.Serializable
 
 @Serializable
 public data class Condition(
-    @SerialName(KeyAnchoring) val anchoring: Anchoring,
-    @SerialName(KeyPattern) val pattern: Pattern,
+    @SerialName(KeyAnchoring) val anchoring: Anchoring? = null,
+    @SerialName(KeyPattern) val pattern: Pattern? = null,
     /**
      * Rule context (format: [A-Za-z0-9_-]+). When specified, the rule is contextual and applies only when the
      * same context is specified at query time (using the ruleContexts parameter). When absent, the rule is generic

src/commonMain/kotlin/com/algolia/search/model/rule/Rule.kt

@@ -15,7 +15,7 @@ public data class Rule(
     /**
      * Condition of the rule.
      */
-    @SerialName(KeyCondition) val condition: Condition,
+    @SerialName(KeyCondition) val condition: Condition? = null,
     /**
      * Consequence of the rule.
      */

src/commonTest/kotlin/suite/TestSuiteRules.kt

@@ -2,11 +2,17 @@ package suite
 
 import clientAdmin1
 import com.algolia.search.helper.toAttribute
+import com.algolia.search.model.ObjectID
+import com.algolia.search.model.rule.Condition
+import com.algolia.search.model.rule.Consequence
 import com.algolia.search.model.rule.Rule
+import com.algolia.search.model.search.Query
 import com.algolia.search.model.settings.AttributeForFaceting
 import com.algolia.search.model.settings.Settings
 import com.algolia.search.model.task.Task
 import com.algolia.search.model.task.TaskStatus
+import com.algolia.search.serialize.JsonDebug
+import com.algolia.search.serialize.JsonNoDefaults
 import io.ktor.client.features.ResponseException
 import io.ktor.http.HttpStatusCode
 import kotlinx.serialization.json.JsonObjectSerializer
@@ -24,6 +30,7 @@ internal class TestSuiteRules {
     private val suffix = "rules"
     private val indexName = testSuiteIndexName(suffix)
     private val brand = "brand".toAttribute()
+    private val model = "model".toAttribute()
     private val index = clientAdmin1.initIndex(indexName)
 
     @AfterTest
@@ -38,12 +45,19 @@ internal class TestSuiteRules {
         runBlocking {
             val objects = load(JsonObjectSerializer.list, "iphones.json")
             val rule = load(Rule.serializer(), "rule_brand.json")
-            val rules = load(Rule.serializer().list, "rule_edits.json")
+            val rules = load(Rule.serializer().list, "rule_batch.json")
             val tasks = mutableListOf<Task>()
 
             index.apply {
                 tasks += saveObjects(objects)
-                tasks += setSettings(Settings(attributesForFaceting = listOf(AttributeForFaceting.Default(brand))))
+                tasks += setSettings(
+                    Settings(
+                        attributesForFaceting = listOf(
+                            AttributeForFaceting.Default(brand),
+                            AttributeForFaceting.Default(model)
+                        )
+                    )
+                )
                 tasks += saveRule(rule)
                 tasks += saveRules(rules)
 
@@ -57,6 +71,7 @@ internal class TestSuiteRules {
                 searches.find { it.objectID == rules.first().objectID }.shouldNotBeNull()
                 deleteRule(rule.objectID).wait() shouldEqual TaskStatus.Published
 
+                search(Query(ruleContexts = listOf("summer"))).nbHits shouldEqual 1
                 (shouldFailWith<ResponseException> {
                     getRule(rule.objectID)
                 }).response.status.value shouldEqual HttpStatusCode.NotFound.value

src/commonTest/resources/rule_edits.json renamed to src/commonTest/resources/rule_batch.json

@@ -23,5 +23,24 @@
         }
       }
     }
+  },
+  {
+    "objectID": "query_promo",
+    "consequence": {
+      "params": {
+        "filters": "brand:OnePlus"
+      }
+    }
+  },
+  {
+    "objectID": "query_promo_summer",
+    "condition": {
+      "context": "summer"
+    },
+    "consequence": {
+      "params": {
+        "filters": "model:One"
+      }
+    }
   }
 ]