Merge pull request #649 from algolia/develop

VladislavFitz · web-flow · commit 40f3aec54c13 · 2020-07-28T11:57:10.000+01:00
Release 8.0.1
diff --git a/Sources/AlgoliaSearchClient/Client/Search/SearchClient.swift b/Sources/AlgoliaSearchClient/Client/Search/SearchClient.swift
@@ -7,6 +7,8 @@
 
 import Foundation
 
+typealias Client = SearchClient
+
 /// Client to perform operations on indices.
 public struct SearchClient: Credentials {
 
diff --git a/Sources/AlgoliaSearchClient/Models/Common/UserToken.swift b/Sources/AlgoliaSearchClient/Models/Common/UserToken.swift
@@ -11,13 +11,13 @@ public struct UserToken: StringWrapper, URLEncodable {
 
   public let rawValue: String
 
-  private let allowedCharacters: CharacterSet = CharacterSet.alphanumerics.union(.init(charactersIn: "_-"))
+  private let allowedCharacters: CharacterSet = CharacterSet.alphanumerics.union(.init(charactersIn: "._-"))
 
   public init(rawValue: String) {
     assert(!rawValue.isEmpty, "UserToken can't be empty")
-    assert(rawValue.count <= 64, "UserToken length can't be superior to 64 characters.")
+    assert(rawValue.count <= 64, "UserToken length can't be superior to 64 characters. Input: \(rawValue)")
     let containsOnlyAllowedCharacters = rawValue.trimmingCharacters(in: allowedCharacters).isEmpty
-    assert(containsOnlyAllowedCharacters, "UserToken allows only characters of type [a-zA-Z0-9_-]")
+    assert(containsOnlyAllowedCharacters, "UserToken allows only characters of type [a-zA-Z0-9_-.]. Input: \(rawValue)")
     self.rawValue = rawValue
   }
 
diff --git a/Sources/AlgoliaSearchClient/Models/Search/Indexing/Scope.swift b/Sources/AlgoliaSearchClient/Models/Search/Indexing/Scope.swift
@@ -55,7 +55,7 @@ public struct ScopeComponent: StringOption & ProvidingCustomOption {
 
   public let rawValue: String
 
-  public init(rawValue: RawValue) {
+  public init(rawValue: String) {
     self.rawValue = rawValue
   }
 
diff --git a/Sources/AlgoliaSearchClient/Models/Search/Response/SearchResponse/Auxiliary/Alternative/AlternativeType.swift b/Sources/AlgoliaSearchClient/Models/Search/Response/SearchResponse/Auxiliary/Alternative/AlternativeType.swift
@@ -11,7 +11,7 @@ public struct AlternativeType: StringOption & ProvidingCustomOption {
 
   public let rawValue: String
 
-  public init(rawValue: RawValue) {
+  public init(rawValue: String) {
     self.rawValue = rawValue
   }
 
diff --git a/Sources/AlgoliaSearchClient/Models/Task/Common/TaskStatus.swift b/Sources/AlgoliaSearchClient/Models/Task/Common/TaskStatus.swift
@@ -11,7 +11,7 @@ public struct TaskStatus: StringOption & ProvidingCustomOption {
 
   public let rawValue: String
 
-  public init(rawValue: RawValue) {
+  public init(rawValue: String) {
     self.rawValue = rawValue
   }
 
diff --git a/Tests/AlgoliaSearchClientTests/Helper/XCTest+Codable.swift b/Tests/AlgoliaSearchClientTests/Helper/XCTest+Codable.swift
@@ -24,7 +24,7 @@ func AssertDecode<T: Codable & Equatable>(_ input: JSON, expected: T, file: Stat
   jsonDecoder.dateDecodingStrategy = .swiftAPIClient
   let decoded = try jsonDecoder.decode(T.self, from: data)
 
-  XCTAssertEqual(expected, decoded, file: file, line: line)
+  XCTAssertEqual(expected, decoded, file: (file), line: line)
 }
 
 func AssertDecode<T: Codable>(_ input: JSON, expected: T, file: StaticString = #file, line: UInt = #line) throws {
@@ -40,7 +40,7 @@ func AssertDecode<T: Codable>(_ input: JSON, expected: T, file: StaticString = #
   let decodedJSON = try JSON(decoded)
   let expectedJSON = try JSON(expected)
 
-  XCTAssertEqual(expectedJSON, decodedJSON, 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 {
@@ -58,14 +58,14 @@ func AssertEncode<T: Encodable>(_ value: T, expected: JSON, file: StaticString =
   jsonDecoder.dateDecodingStrategy = .swiftAPIClient
   let jsonFromValue = try jsonDecoder.decode(JSON.self, from: valueData)
 
-  XCTAssertEqual(jsonFromValue, expected, file: file, line: line)
+  XCTAssertEqual(jsonFromValue, expected, file: (file), line: line)
 }
 
 func AssertEquallyEncoded<A: Encodable, B: Encodable>(_ l: A, _ r: B, file: StaticString = #file, line: UInt = #line) throws {
   let encoder = JSONEncoder()
   encoder.dateEncodingStrategy = .swiftAPIClient
   let lData = try encoder.encode(l)
   let rData = try encoder.encode(r)
-  XCTAssertEqual(lData, rData, file: file, line: line)
+  XCTAssertEqual(lData, rData, file: (file), line: line)
 }
 
diff --git a/Tests/AlgoliaSearchClientTests/Helper/XCTest+HTTPError.swift b/Tests/AlgoliaSearchClientTests/Helper/XCTest+HTTPError.swift
@@ -12,7 +12,7 @@ import XCTest
 func AssertThrowsHTTPError<T>(_ body: @autoclosure () throws -> T, statusCode: Int, file: StaticString = #file, line: UInt = #line) throws {
   do {
     let _ = try body()
-    XCTFail("Expected HTTP error", file: file, line: line)
+    XCTFail("Expected HTTP error", file: (file), line: line)
   } catch let error {
     guard let httpError = error as? HTTPError, httpError.statusCode == statusCode else {
       throw error
diff --git a/Tests/AlgoliaSearchClientTests/Helper/XCTest+Wait.swift b/Tests/AlgoliaSearchClientTests/Helper/XCTest+Wait.swift
@@ -16,7 +16,7 @@ func AssertWait<W: AnyWaitable>(_ waitable: W, timeout: TimeInterval = defaultWa
     try waitable.wait(timeout: 20, requestOptions: nil)
   } catch let error {
     let isTimeoutError = error as? WaitTask.Error == WaitTask.Error.timeout
-    try XCTSkipIf(isTimeoutError, file: file, line: line)
+    try XCTSkipIf(isTimeoutError, file: (file), line: line)
     throw error
   }
 }
diff --git a/Tests/AlgoliaSearchClientTests/Integration/APIKeysIntegrationTests.swift b/Tests/AlgoliaSearchClientTests/Integration/APIKeysIntegrationTests.swift
@@ -17,7 +17,12 @@ class APIKeysIntegrationTests: OnlineTestCase {
   
   var keyToDelete: APIKey?
   
-  func testAPIKeys() throws {
+  override var retryableTests: [() throws -> Void] {
+    [apiKeys]
+  }
+
+  
+  func apiKeys() throws {
     
     let parameters = APIKeyParameters(ACLs: [.search])
       .set(\.description, to: "A description")
diff --git a/Tests/AlgoliaSearchClientTests/Integration/AnalyticsIntegrationsTests.swift b/Tests/AlgoliaSearchClientTests/Integration/AnalyticsIntegrationsTests.swift
@@ -11,12 +11,20 @@ import XCTest
 
 class AnalyticsIntegrationTests: OnlineTestCase {
   
-  func testBrowsing() throws {
+  override var retryableTests: [() throws -> Void] {
+    [
+      browsing,
+      abTesting,
+      aaTesting
+    ]
+  }
+  
+  func browsing() throws {
     let analyticsClient = AnalyticsClient(appID: client.applicationID, apiKey: client.apiKey)
     let _ = try analyticsClient.browseAllABTests(hitsPerPage: 3)
   }
 
-  func testABTesting() throws {
+  func abTesting() throws {
     
     let analyticsClient = AnalyticsClient(appID: client.applicationID, apiKey: client.apiKey)
 
@@ -60,7 +68,7 @@ class AnalyticsIntegrationTests: OnlineTestCase {
     try AssertThrowsHTTPError(try analyticsClient.getABTest(withID: creation.wrapped.abTestID), statusCode: 404)
   }
     
-  func testAATesting() throws {
+  func aaTesting() throws {
     
     let analyticsClient = AnalyticsClient(appID: client.applicationID, apiKey: client.apiKey)
     let index = client.index(withName: "aa_testing")
diff --git a/Tests/AlgoliaSearchClientTests/Integration/BatchingIntegrationsTests.swift b/Tests/AlgoliaSearchClientTests/Integration/BatchingIntegrationsTests.swift
@@ -15,7 +15,11 @@ class BatchingIntegrationTests: OnlineTestCase {
     return "index_batching"
   }
   
-  func testBatching() throws {
+  override var retryableTests: [() throws -> Void] {
+    [batching]
+  }
+
+  func batching() throws {
     
     let records: [JSON] = [
       ["objectID":"one", "key": "value"],
diff --git a/Tests/AlgoliaSearchClientTests/Integration/BrowseIntegrationTests.swift b/Tests/AlgoliaSearchClientTests/Integration/BrowseIntegrationTests.swift
@@ -21,7 +21,15 @@ class BrowseIntegrationTests: OnlineTestCase {
     return "index_browse"
   }
   
-  func testBrowseObjects() throws {
+  override var retryableTests: [() throws -> Void] {
+    [
+      browseObjects,
+      browseRules,
+      browseSynonyms
+    ]
+  }
+  
+  func browseObjects() throws {
     
     struct Record: Codable {
       let objectID: String
@@ -46,7 +54,7 @@ class BrowseIntegrationTests: OnlineTestCase {
     
   }
   
-  func testBrowseRules() throws {
+  func browseRules() throws {
     
     let rules: [Rule] = (0...50).map { _ in
       return Rule(objectID: .random)
@@ -64,7 +72,7 @@ class BrowseIntegrationTests: OnlineTestCase {
     
   }
   
-  func testBrowseSynonyms() throws {
+  func browseSynonyms() throws {
     
     let synonyms: [Synonym] = (0...50).map { _ in
       switch Int.random(in: 0...3) {
diff --git a/Tests/AlgoliaSearchClientTests/Integration/CopyIndexIntegrationTests.swift b/Tests/AlgoliaSearchClientTests/Integration/CopyIndexIntegrationTests.swift
@@ -15,6 +15,15 @@ class CopyIndexIntergrationTests: OnlineTestCase {
     return index!
   }
   
+  override var retryableTests: [() throws -> Void] {
+    [
+      copySettings,
+      copyRules,
+      copySynonyms,
+      fullCopy
+    ]
+  }
+  
   let records: [JSON] = [
     ["objectID": "one", "company": "apple"],
     ["objectID": "two", "company": "algolia"]
@@ -26,7 +35,7 @@ class CopyIndexIntergrationTests: OnlineTestCase {
     .set(\.consequence, to: Rule.Consequence().set(\.automaticFacetFilters, to: [Rule.AutomaticFacetFilters(attribute: "company")]))
   let synonym = Synonym.placeholder(objectID: "google_placeholder", placeholder: "<GOOG>", replacements: ["Google", "GOOG"])
       
-  func testCopySettings() throws {
+  func copySettings() throws {
     
     let targetIndex = client.index(withName: "copy_index_settings")
     
@@ -43,7 +52,7 @@ class CopyIndexIntergrationTests: OnlineTestCase {
     
   }
   
-  func testCopyRules() throws {
+  func copyRules() throws {
     
     let targetIndex = client.index(withName: "copy_index_rules")
     
@@ -61,7 +70,7 @@ class CopyIndexIntergrationTests: OnlineTestCase {
 
   }
   
-  func testCopySynonyms() throws {
+  func copySynonyms() throws {
     
     let targetIndex = client.index(withName: "copy_index_synonyms")
     
@@ -78,7 +87,7 @@ class CopyIndexIntergrationTests: OnlineTestCase {
     
   }
   
-  func testFullCopy() throws {
+  func fullCopy() throws {
     
     let targetIndex = client.index(withName: "copy_index_full_copy")
     
diff --git a/Tests/AlgoliaSearchClientTests/Integration/ExistsIntegrationTests.swift b/Tests/AlgoliaSearchClientTests/Integration/ExistsIntegrationTests.swift
@@ -15,7 +15,11 @@ class ExistsIntegrationTests: OnlineTestCase {
     return "exists"
   }
   
-  func testExists() throws {
+  override var retryableTests: [() throws -> Void] {
+    [exists]
+  }
+  
+  func exists() throws {
     XCTAssertFalse(try index.exists())
     try index.saveObject(TestRecord(), autoGeneratingObjectID: true).wait()
     XCTAssertTrue(try index.exists())
diff --git a/Tests/AlgoliaSearchClientTests/Integration/IndexingIntegrationTests.swift b/Tests/AlgoliaSearchClientTests/Integration/IndexingIntegrationTests.swift
@@ -15,7 +15,15 @@ class IndexingIntegrationTests: OnlineTestCase {
     return "indexing"
   }
   
-  func testIndexing() throws {
+  override var retryableTests: [() throws -> Void] {
+    [
+      indexing,
+      saveGetObject,
+      saveGetObjectCallback
+    ]
+  }
+  
+  func indexing() throws {
     
     let objectID = ObjectID(rawValue: .init(randomWithLength: 10))
     let object = TestRecord(objectID: objectID)
@@ -107,7 +115,7 @@ class IndexingIntegrationTests: OnlineTestCase {
     
   }
 
-  func testSaveGetObject() throws {
+  func saveGetObject() throws {
 
     let object: JSON = [
       "testField1": "testValue1",
@@ -122,7 +130,7 @@ class IndexingIntegrationTests: OnlineTestCase {
     XCTAssertEqual(fetchedObject["testField3"], true)
   }
 
-  func testSaveGetObjectCallback() throws {
+  func saveGetObjectCallback() throws {
 
     let object: JSON = [
       "testField1": "testValue1",
diff --git a/Tests/AlgoliaSearchClientTests/Integration/InsightsIntegrationTests.swift b/Tests/AlgoliaSearchClientTests/Integration/InsightsIntegrationTests.swift
@@ -15,7 +15,11 @@ class InsightsIntegrationTests: OnlineTestCase {
     return "sending_events"
   }
   
-  func testInsights() throws {
+  override var retryableTests: [() throws -> Void] {
+    [insights]
+  }
+
+  func insights() throws {
     
     let insightsClient = InsightsClient(appID: client.applicationID, apiKey: client.apiKey)
     
diff --git a/Tests/AlgoliaSearchClientTests/Integration/LogsIntergrationTests.swift b/Tests/AlgoliaSearchClientTests/Integration/LogsIntergrationTests.swift
@@ -14,8 +14,12 @@ class LogsIntergrationTests: OnlineTestCase {
   override var indexNameSuffix: String? {
     "logs"
   }
+  
+  override var retryableTests: [() throws -> Void] {
+    [getLogs]
+  }
 
-  func testGetLogs() throws {
+  func getLogs() throws {
     try client.listIndices()
     try client.listIndices()
     let logs = try client.getLogs(offset: 0, length: 2, type: .all).logs
diff --git a/Tests/AlgoliaSearchClientTests/Integration/MultiClusterIntegrationTests.swift b/Tests/AlgoliaSearchClientTests/Integration/MultiClusterIntegrationTests.swift
@@ -56,11 +56,15 @@ class MultipleClusterIntegrationTests: OnlineTestCase {
   
   let date: Date = .init()
   
+  override var retryableTests: [() throws -> Void] {
+    [multiCluster]
+  }
+  
   func userID(_ id: String) -> UserID {
     return UserID(rawValue: TestIdentifier(date: date, suffix: id).rawValue)
   }
     
-  func testMultiCluster() throws {
+  func multiCluster() throws {
   
     let userID0 = userID("0")
     let userID1 = userID("1")
diff --git a/Tests/AlgoliaSearchClientTests/Integration/MultipleOperationsIntegrationTests.swift b/Tests/AlgoliaSearchClientTests/Integration/MultipleOperationsIntegrationTests.swift
@@ -23,6 +23,10 @@ class MultipleOperationsIntegrationTests: OnlineTestCase {
     return client.index(withName: "multiple_operations_dev")
   }()
   
+  override var retryableTests: [() throws -> Void] {
+    [multipleOperations]
+  }
+  
   override func setUpWithError() throws {
     try super.setUpWithError()
     try firstIndex.delete()
@@ -35,7 +39,7 @@ class MultipleOperationsIntegrationTests: OnlineTestCase {
     try secondIndex.delete()
   }
   
-  func testMultipleOperationsTests() throws {
+  func multipleOperations() throws {
     
     let object: JSON = ["firstName": "Jimmie"]
     
diff --git a/Tests/AlgoliaSearchClientTests/Integration/OnlineTestCase.swift b/Tests/AlgoliaSearchClientTests/Integration/OnlineTestCase.swift
diff --git a/Tests/AlgoliaSearchClientTests/Integration/PersonalizationIntegrationTests.swift b/Tests/AlgoliaSearchClientTests/Integration/PersonalizationIntegrationTests.swift
diff --git a/Tests/AlgoliaSearchClientTests/Integration/QueryRulesIntegrationTests.swift b/Tests/AlgoliaSearchClientTests/Integration/QueryRulesIntegrationTests.swift
diff --git a/Tests/AlgoliaSearchClientTests/Integration/SearchIntegrationTests.swift b/Tests/AlgoliaSearchClientTests/Integration/SearchIntegrationTests.swift
diff --git a/Tests/AlgoliaSearchClientTests/Integration/SecuredAPIKeysIntegrationTests.swift b/Tests/AlgoliaSearchClientTests/Integration/SecuredAPIKeysIntegrationTests.swift
diff --git a/Tests/AlgoliaSearchClientTests/Integration/SettingsIntegrationTests.swift b/Tests/AlgoliaSearchClientTests/Integration/SettingsIntegrationTests.swift
diff --git a/Tests/AlgoliaSearchClientTests/Integration/SynonymsIntegrationTests.swift b/Tests/AlgoliaSearchClientTests/Integration/SynonymsIntegrationTests.swift
diff --git a/Tests/AlgoliaSearchClientTests/Unit/Command/AlgoliaCommandTest.swift b/Tests/AlgoliaSearchClientTests/Unit/Command/AlgoliaCommandTest.swift

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public struct ScopeComponent: StringOption & ProvidingCustomOption {`
`55`	`55`
`56`	`56`	`public let rawValue: String`
`57`	`57`
`58`		`- public init(rawValue: RawValue) {`
	`58`	`+ public init(rawValue: String) {`
`59`	`59`	`self.rawValue = rawValue`
`60`	`60`	`}`
`61`	`61`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ public struct AlternativeType: StringOption & ProvidingCustomOption {`
`11`	`11`
`12`	`12`	`public let rawValue: String`
`13`	`13`
`14`		`- public init(rawValue: RawValue) {`
	`14`	`+ public init(rawValue: String) {`
`15`	`15`	`self.rawValue = rawValue`
`16`	`16`	`}`
`17`	`17`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ public struct TaskStatus: StringOption & ProvidingCustomOption {`
`11`	`11`
`12`	`12`	`public let rawValue: String`
`13`	`13`
`14`		`- public init(rawValue: RawValue) {`
	`14`	`+ public init(rawValue: String) {`
`15`	`15`	`self.rawValue = rawValue`
`16`	`16`	`}`
`17`	`17`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ func AssertWait<W: AnyWaitable>(_ waitable: W, timeout: TimeInterval = defaultWa`
`16`	`16`	`try waitable.wait(timeout: 20, requestOptions: nil)`
`17`	`17`	`} catch let error {`
`18`	`18`	`let isTimeoutError = error as? WaitTask.Error == WaitTask.Error.timeout`
`19`		`- try XCTSkipIf(isTimeoutError, file: file, line: line)`
	`19`	`+ try XCTSkipIf(isTimeoutError, file: (file), line: line)`
`20`	`20`	`throw error`
`21`	`21`	`}`
`22`	`22`	`}`