feat: support facet ordering (#780)

Co-authored-by: Antoine Hémery <[email protected]>
Co-authored-by: Sylvain Bellone <[email protected]>

Author: 3 people

src/Algolia.Search.Test/Serializer/SerializerTest.cs

@@ -907,6 +907,71 @@ public void TestRecommendResponse()
             Assert.That(recommendedProducts.ElementAt(0).Url, Is.EqualTo("men/t-shirts/d05927-8161-111"));
             Assert.That(recommendedProducts.ElementAt(0).ImageLink, Is.EqualTo("https://example.org/image/D05927-8161-111-F01.jpg"));
         }
+
+        [Test]
+        [Parallelizable]
+        public void TestFacetOrdering()
+        {
+            // Test serialization
+            var settings = new IndexSettings
+            {
+                RenderingContent = new RenderingContent
+                {
+                    FacetOrdering = new FacetOrdering
+                    {
+                        Facets = new FacetsOrder
+                        {
+                            Order = new List<string> { "size", "brand" }
+                        },
+                        Values = new Dictionary<string, FacetValuesOrder>
+                        {
+                            { "brand", new FacetValuesOrder { Order = new List<string> { "uniqlo" } } },
+                            { "size", new FacetValuesOrder
+                                {
+                                    Order = new List<string> { "S", "M", "L" },
+                                    SortRemainingBy = "hidden"
+                                }
+                            }
+                        }
+                    }
+                }
+            };
+
+            string json = JsonConvert.SerializeObject(settings, JsonConfig.AlgoliaJsonSerializerSettings);
+            Assert.AreEqual("{\"renderingContent\":{\"facetOrdering\":{\"facets\":{\"order\":[\"size\",\"brand\"]},\"values\":{\"brand\":{\"order\":[\"uniqlo\"]},\"size\":{\"order\":[\"S\",\"M\",\"L\"],\"sortRemainingBy\":\"hidden\"}}}}}", json);
+
+            // Test deserialization
+            var payload = @"{
+  ""renderingContent"": {
+    ""facetOrdering"": {
+      ""facets"": {
+        ""order"": [""brand"", ""color""]
+      },
+      ""values"": {
+        ""brand"": {
+          ""order"": [""uniqlo"", ""sony""],
+          ""sortRemainingBy"": ""alpha""
+        }
+      }
+    }
+  }
+}";
+            var response = JsonConvert.DeserializeObject<SearchResponse<object>>(payload, JsonConfig.AlgoliaJsonSerializerSettings);
+
+            Assert.IsNotNull(response.RenderingContent);
+            Assert.IsNotNull(response.RenderingContent.FacetOrdering);
+            Assert.IsNotNull(response.RenderingContent.FacetOrdering.Facets);
+            Assert.IsNotNull(response.RenderingContent.FacetOrdering.Facets.Order);
+            Assert.True(response.RenderingContent.FacetOrdering.Facets.Order.Contains("brand"));
+            Assert.True(response.RenderingContent.FacetOrdering.Facets.Order.Contains("color"));
+
+            Assert.IsNotNull(response.RenderingContent.FacetOrdering.Values);
+            Assert.True(response.RenderingContent.FacetOrdering.Values.ContainsKey("brand"));
+            FacetValuesOrder brandValues = response.RenderingContent.FacetOrdering.Values["brand"];
+            Assert.True(brandValues.Order.Contains("uniqlo"));
+            Assert.True(brandValues.Order.Contains("sony"));
+            Assert.AreEqual("alpha", brandValues.SortRemainingBy);
+        }
     }
 
     public class Product

src/Algolia.Search/Models/Rules/ConsequenceParams.cs

@@ -22,6 +22,7 @@
 */
 
 using System.Collections.Generic;
+using Algolia.Search.Models.Rules;
 using Algolia.Search.Models.Search;
 using Algolia.Search.Serializer;
 using Newtonsoft.Json;
@@ -68,5 +69,11 @@ public class ConsequenceParams : Query
         /// Behaves like optionalFilters.
         /// </summary>
         public List<AutomaticFacetFilter> AutomaticOptionalFacetFilters { get; set; }
+
+        /// <summary>
+        /// Content defining how the search interface should be rendered.
+        /// This is set via the settings for a default value and can be overridden via rules.
+        /// </summary>
+        public RenderingContent RenderingContent { get; set; }
     }
 }

src/Algolia.Search/Models/Rules/FacetOrdering.cs

@@ -0,0 +1,43 @@
+/*
+* Copyright (c) 2021 Algolia
+* http://www.algolia.com/
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+* copies of the Software, and to permit persons to whom the Software is
+* furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included in
+* all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+* THE SOFTWARE.
+*/
+
+using System.Collections.Generic;
+
+namespace Algolia.Search.Models.Rules
+{
+    /// <summary>
+    /// Facets and facets values ordering rules container.
+    /// </summary>
+    public class FacetOrdering
+    {
+        /// <summary>
+        /// Define or override the way facet attributes are displayed.
+        /// </summary>
+        public FacetsOrder Facets { get; set; }
+
+        /// <summary>
+        /// Facet values ordering rule container.
+        /// </summary>
+        public Dictionary<string, FacetValuesOrder> Values { get; set; }
+    }
+}

src/Algolia.Search/Models/Rules/FacetValuesOrder.cs

@@ -0,0 +1,47 @@
+/*
+* Copyright (c) 2021 Algolia
+* http://www.algolia.com/
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+* copies of the Software, and to permit persons to whom the Software is
+* furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included in
+* all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+* THE SOFTWARE.
+*/
+
+using System.Collections.Generic;
+using Algolia.Search.Models.Enums;
+
+namespace Algolia.Search.Models.Rules
+{
+    /// <summary>
+    /// Facet values ordering rule container.
+    /// </summary>
+    public class FacetValuesOrder
+    {
+        /// <summary>
+        /// An ordered list of facet values to present.
+        /// </summary>
+        public List<string> Order { get; set; }
+
+        /// <summary>
+        /// A constant defining what to do with remaining facet values not included in Order:
+        ///   - "alpha": sort the remaining values in alphanumeric order
+        ///   - "count": sort the remaining values by count in descending order
+        ///   - "hidden": hide the remaining values
+        /// </summary>
+        public string SortRemainingBy { get; set; }
+    }
+}

src/Algolia.Search/Models/Rules/FacetsOrder.cs

@@ -0,0 +1,38 @@
+/*
+* Copyright (c) 2021 Algolia
+* http://www.algolia.com/
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+* copies of the Software, and to permit persons to whom the Software is
+* furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included in
+* all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+* THE SOFTWARE.
+*/
+
+using System.Collections.Generic;
+
+namespace Algolia.Search.Models.Rules
+{
+    /// <summary>
+    /// Define or override the way facet attributes are displayed.
+    /// </summary>
+    public class FacetsOrder
+    {
+        /// <summary>
+        /// An ordered list of attributes of facets to present.
+        /// </summary>
+        public List<string> Order { get; set; }
+    }
+}

src/Algolia.Search/Models/Rules/RenderingContent.cs

@@ -0,0 +1,37 @@
+/*
+* Copyright (c) 2021 Algolia
+* http://www.algolia.com/
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+* copies of the Software, and to permit persons to whom the Software is
+* furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included in
+* all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+* THE SOFTWARE.
+*/
+
+namespace Algolia.Search.Models.Rules
+{
+    /// <summary>
+    /// Content defining how the search interface should be rendered.
+    /// This is set via the settings for a default value and can be overridden via rules.
+    /// </summary>
+    public class RenderingContent
+    {
+        /// <summary>
+        /// Facets and facets values ordering rules container.
+        /// </summary>
+        public FacetOrdering FacetOrdering { get; set; }
+    }
+}

src/Algolia.Search/Models/Search/SearchResponse.cs

@@ -22,6 +22,7 @@
 */
 
 using System.Collections.Generic;
+using Algolia.Search.Models.Rules;
 using Newtonsoft.Json;
 
 namespace Algolia.Search.Models.Search
@@ -183,5 +184,11 @@ public class SearchResponse<T> where T : class
         /// Number of relevant hits to display in case of non-zero relevancyStrictness applied
         /// </summary>
         public int? NbSortedHits { get; set; }
+
+        /// <summary>
+        /// Content defining how the search interface should be rendered.
+        /// This is set via the settings for a default value and can be overridden via rules.
+        /// </summary>
+        public RenderingContent RenderingContent { get; set; }
     }
 }

src/Algolia.Search/Models/Settings/IndexSettings.cs

@@ -22,6 +22,7 @@
  */
 
 using System.Collections.Generic;
+using Algolia.Search.Models.Rules;
 using Algolia.Search.Serializer;
 using Newtonsoft.Json;
 
@@ -85,12 +86,18 @@ private List<string> AttributesToIndex
         public List<string> Replicas { get; set; }
 
         /// <summary>
-        /// Relevancy score to apply to search in virtual index. 
-        /// Bigger value means less, but more relevant results, 
+        /// Relevancy score to apply to search in virtual index.
+        /// Bigger value means less, but more relevant results,
         /// lesser value - more less relevant results
         /// </summary>
         public int? RelevancyStrictness { get; set; }
 
+        /// <summary>
+        /// Content defining how the search interface should be rendered.
+        /// This is set via the settings for a default value and can be overridden via rules.
+        /// </summary>
+        public RenderingContent RenderingContent { get; set; }
+
         /// <summary>
         /// The primary parameter is automatically added to a replica's settings when the replica is created and cannot be modified.
         /// </summary>

src/Algolia.Search/Serializer/QueryConverter.cs

@@ -29,7 +29,7 @@
 namespace Algolia.Search.Serializer
 {
     /// <summary>
-    /// Custom serializer for the query object because it must math specific syntax
+    /// Custom serializer for the query object because it must match specific syntax
     /// For more informations regarding the syntax
     /// https://www.algolia.com/doc/rest-api/search/#search-endpoints
     /// https://www.newtonsoft.com/json/help/html/JsonConverterAttributeClass.htm