Merge pull request #642 from algolia/feat/ensure-bool-string-deserialization

Ensure bool-representable enums deserialization from string

Author: VladislavFitz

Sources/AlgoliaSearchClient/Helpers/Coding/Wrappers/BoolContainer.swift

@@ -0,0 +1,35 @@
+//
+//  BoolContainer.swift
+//  
+//
+//  Created by Vladislav Fitc on 17/07/2020.
+//
+
+import Foundation
+
+/**
+ Helper structure ensuring the decoding of a bool value from a "volatile" JSON
+ occasionally providing bool values in the form of String   
+ */
+struct BoolContainer: RawRepresentable, Codable {
+  
+  let rawValue: Bool
+  
+  init(rawValue: Bool) {
+    self.rawValue = rawValue
+  }
+  
+  init(from decoder: Decoder) throws {
+    let container = try decoder.singleValueContainer()
+    if let boolValue = try? container.decode(Bool.self) {
+      self.rawValue = boolValue
+      return
+    }
+    if let boolFromString = Bool(try container.decode(String.self)) {
+      self.rawValue = boolFromString
+      return
+    }
+    throw DecodingError.dataCorruptedError(in: container, debugDescription: "Value cannot be decoded neither to Bool nor to String representing Bool value")
+  }
+  
+}

Sources/AlgoliaSearchClient/Helpers/Coding/Wrappers/StringNumberContainer.swift

@@ -7,6 +7,10 @@
 
 import Foundation
 
+/**
+  Helper structure ensuring the decoding of a number value from a "volatile" JSON
+  occasionally providing number values in the form of String
+*/
 struct StringNumberContainer: RawRepresentable, Codable {
 
   let rawValue: Double

Sources/AlgoliaSearchClient/Models/Rule/Rule+Alternatives.swift

@@ -9,7 +9,7 @@ import Foundation
 
 extension Rule {
 
-  public enum Alternatives: RawRepresentable, Codable {
+  public enum Alternatives: RawRepresentable, Encodable {
 
     case `true`
     case `false`
@@ -30,3 +30,20 @@ extension Rule {
   }
 
 }
+
+extension Rule.Alternatives: ExpressibleByBooleanLiteral {
+
+  public init(booleanLiteral value: Bool) {
+    self = value ? .true : .false
+  }
+
+}
+
+extension Rule.Alternatives: Decodable {
+  
+  public init(from decoder: Decoder) throws {
+    let boolContainer = try BoolContainer(from: decoder)
+    self = boolContainer.rawValue ? .true : .false
+  }
+  
+}

Sources/AlgoliaSearchClient/Models/Search/Indexing/PartialUpdate.swift

@@ -148,15 +148,13 @@ extension PartialUpdate.Content: Codable {
   }
 
   public init(from decoder: Decoder) throws {
-    let container = try decoder.container(keyedBy: CodingKeys.self)
-    let operation: PartialUpdate.Operation? = try container.decodeIfPresent(forKey: .operation)
-    if let operation = operation {
-      self.operation = operation
-      self.value = try container.decode(forKey: .value)
-    } else {
+    guard let container = try? decoder.container(keyedBy: CodingKeys.self), container.contains(.operation) else {
       self.operation = nil
       self.value = try JSON(from: decoder)
+      return
     }
+    self.operation = try container.decode(forKey: .operation)
+    self.value = try container.decode(forKey: .value)
   }
 
   public func encode(to encoder: Encoder) throws {

Sources/AlgoliaSearchClient/Models/Settings/Auxiliary/LanguageFeature.swift

@@ -39,17 +39,7 @@ extension LanguageFeature: ExpressibleByArrayLiteral {
 
 }
 
-extension LanguageFeature: Codable {
-
-  public init(from decoder: Decoder) throws {
-    let container = try decoder.singleValueContainer()
-    if let isTrue = try? container.decode(Bool.self) {
-      self = isTrue ? .true : .false
-    } else {
-      let languages = try container.decode([Language].self)
-      self = .queryLanguages(languages)
-    }
-  }
+extension LanguageFeature: Encodable {
 
   public func encode(to encoder: Encoder) throws {
     var singleValueContainer = encoder.singleValueContainer()
@@ -65,6 +55,20 @@ extension LanguageFeature: Codable {
 
 }
 
+extension LanguageFeature: Decodable {
+  
+  public init(from decoder: Decoder) throws {
+    let container = try decoder.singleValueContainer()
+    if let boolContainer = try? container.decode(BoolContainer.self) {
+      self = boolContainer.rawValue ? .true : .false
+    } else {
+      let languages = try container.decode([Language].self)
+      self = .queryLanguages(languages)
+    }
+  }
+  
+}
+
 extension LanguageFeature: Equatable {}
 
 extension LanguageFeature: URLEncodable {

Tests/AlgoliaSearchClientTests/Doc/APIParameters/APIParameters+Typos.swift

@@ -76,7 +76,7 @@ extension APIParameters {
       func set_default_typo_tolerance_mode() {
         let settings = Settings()
           .set(\.typoTolerance, to: true)
-        //.set(\.typoTolerance, to: .false)
+        //.set(\.typoTolerance, to: false)
         //.set(\.typoTolerance, to: .min)
         //.set(\.typoTolerance, to: .strict)
 
@@ -89,8 +89,8 @@ extension APIParameters {
 
       func override_default_typo_tolerance_mode() {
         let query = Query("query")
-          .set(\.typoTolerance, to: .false)
-        //.set(\.typoTolerance, to: .true)
+          .set(\.typoTolerance, to: false)
+        //.set(\.typoTolerance, to: true)
         //.set(\.typoTolerance, to: .min)
         //.set(\.typoTolerance, to: .strict)
 

Tests/AlgoliaSearchClientTests/Doc/Methods/ABTestSnippets.swift

@@ -79,7 +79,7 @@ extension ABTestSnippets {
                         variantB: .init(indexName: "indexName2",
                                         trafficPercentage: 10,
                                         customSearchParameters: Query()
-                                          .set(\.ignorePlurals, to: .true),
+                                          .set(\.ignorePlurals, to: true),
                                         description: "a description"))
 
     analyticsClient.addABTest(abTest) { result in

Tests/AlgoliaSearchClientTests/Doc/Methods/RulesSnippets.swift

@@ -52,7 +52,7 @@ extension RulesSnippets {
       .set(\.condition, to: Rule.Condition()
         .set(\.anchoring, to: .contains)
         .set(\.pattern, to: .literal("smartphone"))
-        .set(\.alternatives, to: .true)
+        .set(\.alternatives, to: true)
       )
       .set(\.consequence, to: Rule.Consequence()
         .set(\.query, to: Query()

Tests/AlgoliaSearchClientTests/Helper/XCTest+Codable.swift

@@ -14,17 +14,33 @@ func AssertEncodeDecode<T: Codable>(_ value: T, _ rawValue: JSON, file: StaticSt
   try AssertDecode(rawValue, expected: value, file: file, line: line)
 }
 
+func AssertDecode<T: Codable & Equatable>(_ input: JSON, expected: T, file: StaticString = #file, line: UInt = #line) throws {
+
+  let encoder = JSONEncoder()
+  encoder.dateEncodingStrategy = .swiftAPIClient
+  let data = try encoder.encode(input)
+
+  let jsonDecoder = JSONDecoder()
+  jsonDecoder.dateDecodingStrategy = .swiftAPIClient
+  let decoded = try jsonDecoder.decode(T.self, from: data)
+
+  XCTAssertEqual(expected, decoded, file: file, line: line)
+}
+
 func AssertDecode<T: Codable>(_ input: JSON, expected: T, file: StaticString = #file, line: UInt = #line) throws {
 
   let encoder = JSONEncoder()
   encoder.dateEncodingStrategy = .swiftAPIClient
-  let data = try encoder.encode(expected)
+  let data = try encoder.encode(input)
 
   let jsonDecoder = JSONDecoder()
   jsonDecoder.dateDecodingStrategy = .swiftAPIClient
-  let expectedJSON = try jsonDecoder.decode(JSON.self, from: data)
+  let decoded = try jsonDecoder.decode(T.self, from: data)
+  
+  let decodedJSON = try JSON(decoded)
+  let expectedJSON = try JSON(expected)
 
-  XCTAssertEqual(input, expectedJSON, file: file, line: line)
+  XCTAssertEqual(expectedJSON, decodedJSON, file: file, line: line)
 }
 
 @discardableResult func AssertDecode<T: Decodable>(jsonFilename filename: String, expected: T.Type, file: StaticString = #file, line: UInt = #line) throws -> T {

Tests/AlgoliaSearchClientTests/Integration/QueryRulesIntegrationTests.swift

@@ -48,7 +48,7 @@ class QueryRulesIntegrationTests: OnlineTestCase {
     try index.saveRule(brandAutomaticFacetingRule).wait()
 
     let queryEditsRule = Rule(objectID: "query_edits")
-      .set(\.condition, to: .init(anchoring: .is, pattern: .literal("mobile phone"), alternatives: .true))
+      .set(\.condition, to: .init(anchoring: .is, pattern: .literal("mobile phone"), alternatives: true))
       .set(\.consequence, to: Rule.Consequence()
         .set(\.filterPromotes, to: false)
         .set(\.queryTextAlteration, to: .edits([