Merge #571

571: Add federated multisearch to MeilisearchClient r=curquiza a=apt-TebbeM

# Pull Request

## Related issue
Fixes #560 

## What does this PR do?
- increases meilisearch version to 1.10.0 in docker-compose.yaml
- adds new method on MeilisearchClient for federated search
- extracts shared properties of "FederatedSearchQuery" and "SearchQuery" into a SearchQueryBase
- add custom JsonConverter to handle federated search in request (empty object needs to be included, cause that causes federated search to work)
- added tests

## PR checklist
Please check if your PR fulfills the following requirements:
- [ x ] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [ x ] Have you read the contributing guidelines?
- [ x  ] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: TebbeM <[email protected]>
Co-authored-by: apt-TebbeM <[email protected]>

Author: meili-bors[bot]

.env

@@ -1,3 +1,3 @@
-MEILISEARCH_VERSION=v1.9.0
+MEILISEARCH_VERSION=v1.10.0
 PROXIED_MEILISEARCH=http://nginx/api/
 MEILISEARCH_URL=http://meilisearch:7700

src/Meilisearch/Constants.cs

@@ -1,6 +1,8 @@
 using System.Text.Json;
 using System.Text.Json.Serialization;
 
+using Meilisearch.Converters;
+
 namespace Meilisearch
 {
     /// <summary>

src/Meilisearch/Converters/AlwaysIncludeEmptyObjectConverter.cs

@@ -0,0 +1,72 @@
+using System;
+using System.Linq;
+using System.Reflection;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace Meilisearch.Converters
+{
+    /// <summary>
+    /// Always include property in json. MultiSearchFederationOptions will be serialized as "{}"
+    /// </summary>
+    public class MultiSearchFederationOptionsConverter : JsonConverter<MultiSearchFederationOptions>
+    {
+        /// <summary>
+        /// Would override the default read logic, but here we use the default
+        /// </summary>
+        /// <param name="reader"></param>
+        /// <param name="typeToConvert"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
+        public override MultiSearchFederationOptions Read(ref Utf8JsonReader reader, Type typeToConvert,
+            JsonSerializerOptions options)
+        {
+            return JsonSerializer.Deserialize<MultiSearchFederationOptions>(ref reader, options);
+        }
+
+        /// <summary>
+        /// Write json for MultiSearchFederationOptions and include it always as empty object
+        /// </summary>
+        /// <param name="writer"></param>
+        /// <param name="value"></param>
+        /// <param name="options"></param>
+        public override void Write(Utf8JsonWriter writer, MultiSearchFederationOptions value,
+            JsonSerializerOptions options)
+        {
+            if (value == null || !HasAnyValueSet(value))
+            {
+                WriteEmptyObject(writer);
+            }
+            else
+            {
+                JsonSerializer.Serialize(writer, value);
+            }
+        }
+        private static void WriteEmptyObject(Utf8JsonWriter writer)
+        {
+            writer.WriteStartObject();
+            writer.WriteEndObject();
+        }
+
+        private bool HasAnyValueSet(MultiSearchFederationOptions value)
+        {
+            foreach (var property in
+                     value.GetType().GetProperties(BindingFlags.Public | BindingFlags.Instance))
+            {
+                var propertyValue = property.GetValue(value);
+                var defaultValue = GetDefaultValue(property.PropertyType);
+
+                if (!Equals(propertyValue, defaultValue))
+                {
+                    return true;
+                }
+            }
+            return false;
+        }
+
+        private object GetDefaultValue(Type type)
+        {
+            return type.IsValueType ? Activator.CreateInstance(type) : null;
+        }
+    }
+}

src/Meilisearch/FederatedMultiSearchQuery.cs

@@ -0,0 +1,35 @@
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+
+using Meilisearch.Converters;
+
+namespace Meilisearch
+{
+    /// <summary>
+    ///  Search query used in federated multi-index search
+    /// </summary>
+    public class FederatedMultiSearchQuery
+    {
+        /// <summary>
+        /// Default constructor that ensures FederationOptions are always set
+        /// </summary>
+        public FederatedMultiSearchQuery()
+        {
+            FederationOptions = new MultiSearchFederationOptions();
+        }
+
+        /// <summary>
+        /// The queries
+        /// </summary>
+        [JsonPropertyName("queries")]
+        public List<FederatedSearchQuery> Queries { get; set; }
+
+        /// <summary>
+        /// The federated search query options
+        /// </summary>
+        [JsonInclude]
+        [JsonPropertyName("federation")]
+        [JsonConverter(typeof(MultiSearchFederationOptionsConverter))]
+        public MultiSearchFederationOptions FederationOptions { get; set; }
+    }
+}

src/Meilisearch/FederatedSearchQuery.cs

@@ -0,0 +1,16 @@
+using System.Text.Json.Serialization;
+
+namespace Meilisearch
+{
+    /// <summary>
+    /// Search query for federated multi-index search
+    /// </summary>
+    public class FederatedSearchQuery : SearchQueryBase
+    {
+        /// <summary>
+        /// Federated search options
+        /// </summary>
+        [JsonPropertyName("federationOptions")]
+        public MultiSearchFederationOptions FederationOptions { get; set; }
+    }
+}

src/Meilisearch/Meilisearch.csproj

@@ -13,7 +13,6 @@
         <PackageIcon>logo.png</PackageIcon>
         <PackageReadmeFile>README.md</PackageReadmeFile>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
-
         <GenerateDocumentationFile>True</GenerateDocumentationFile>
         <!-- Warnings for missing XML documentation are only visible during dev time -->
         <!-- You may want to remove the NoWarn node in case documentation will be mandatory in the future -->