Merge #71

71: Change the update status as enum and rename Type into UpdateType in Update model r=curquiza a=ppamorim This PR transforms the status result from the `Update` struct into an enum. This change is needed since the server has a stable API and the user doesn't want to keep comparing strings in the SDK. Co-authored-by: Pedro Paulo de Amorim <[email protected]>
meilisearch · Oct 15, 2020 · e21f2aa · e21f2aa
2 parents 1f138d1 + 3715a7d
commit e21f2aa
Show file tree

Hide file tree

Showing 5 changed files with 86 additions and 15 deletions.
diff --git a/Sources/MeiliSearch/Model/Update.swift b/Sources/MeiliSearch/Model/Update.swift
@@ -17,13 +17,13 @@ public struct Update: Codable, Equatable {
         // MARK: Properties
 
         ///Returns if the update has been sucessful or not.
-        public let status: String
+        public let status: Status
 
         ///Unique ID for the current `Update`.
         public let updateId: Int
 
         ///Type of update.
-        public let type: Type
+        public let type: UpdateType
 
         ///Duration of the update process.
         public let duration: TimeInterval?
@@ -34,8 +34,8 @@ public struct Update: Codable, Equatable {
         ///Date when the update has been processed.
         public let processedAt: Date?
 
-        ///Typr of `Update`.
-        public struct `Type`: Codable, Equatable {
+        ///Type of `Update`
+        public struct UpdateType: Codable, Equatable {
 
             // MARK: Properties
 
@@ -49,4 +49,33 @@ public struct Update: Codable, Equatable {
 
     }
 
+    public enum Status: Codable, Equatable {
+
+        case enqueued
+        case processed
+        case failed
+
+        public enum StatusError: Error {
+            case unknown
+        }
+
+        public init(from decoder: Decoder) throws {
+            let container = try decoder.singleValueContainer()
+            let rawStatus = try container.decode(String.self)
+            switch rawStatus {
+            case "enqueued":
+                self = .enqueued
+            case "processed":
+                self = .processed
+            case "failed":
+                self = .failed
+            default:
+                throw StatusError.unknown
+            }
+        }
+
+        public func encode(to encoder: Encoder) throws { }
+
+    }
+
 }
diff --git a/Tests/MeiliSearchIntegrationTests/DocumentsTests.swift b/Tests/MeiliSearchIntegrationTests/DocumentsTests.swift
@@ -174,7 +174,7 @@ class DocumentsTests: XCTestCase {
         }
         self.wait(for: [getExpectation], timeout: 3.0)
     }
-    
+
     func testAddAndGetOneDocumentWithIntIdentifierAndSucceed() {
 
         let movie: Movie = Movie(id: 10, title: "test", comment: "test movie")
@@ -240,7 +240,6 @@ class DocumentsTests: XCTestCase {
 
             case .success(let update):
 
-
                 XCTAssertEqual(Update(updateId: 0), update)
 
                 Thread.sleep(forTimeInterval: 1.0)

diff --git a/Tests/MeiliSearchIntegrationTests/SettingsTests.swift b/Tests/MeiliSearchIntegrationTests/SettingsTests.swift
@@ -20,7 +20,7 @@ class SettingsTests: XCTestCase {
     private let defaultAttributesForFaceting: [String] = []
     private let defaultStopWords: [String] = []
     private let defaultSynonyms: [String: [String]] = [:]
-    private var defaultGlobalSettings: Setting? = nil
+    private var defaultGlobalSettings: Setting?
 
     // MARK: Setup
 

diff --git a/Tests/MeiliSearchIntegrationTests/UpdatesTests.swift b/Tests/MeiliSearchIntegrationTests/UpdatesTests.swift
@@ -68,11 +68,12 @@ class UpdatesTests: XCTestCase {
             switch result {
             case .success(let update):
 
-                self.client.getUpdate(UID: self.uid, update) { result in
+                self.client.getUpdate(UID: self.uid, update) { (result: Result<Update.Result, Swift.Error>)  in
 
                     switch result {
                     case .success(let update):
-                        XCTAssertTrue(["enqueued", "processed", "fail"].contains(update.status))
+                        XCTAssertEqual("DocumentsAddition", update.type.name)
+                        XCTAssertTrue(update.type.number >= 0)
                     case .failure(let error):
                         print(error)
                         XCTFail()
@@ -102,13 +103,13 @@ class UpdatesTests: XCTestCase {
             self.client.addDocuments(UID: self.uid, documents: documents, primaryKey: nil) { _ in }
         }
 
-        self.client.getAllUpdates(UID: self.uid) { result in
+        self.client.getAllUpdates(UID: self.uid) { (result: Result<[Update.Result], Swift.Error>)  in
 
             switch result {
             case .success(let updates):
-                let statuses: [String] = ["enqueued", "processed", "fail"]
                 updates.forEach { (update: Update.Result) in
-                    XCTAssertTrue(statuses.contains(update.status))
+                  XCTAssertEqual("DocumentsAddition", update.type.name)
+                  XCTAssertTrue(update.type.number >= 0)
                 }
 
             case .failure(let error):

diff --git a/Tests/MeiliSearchUnitTests/UpdatesTests.swift b/Tests/MeiliSearchUnitTests/UpdatesTests.swift
@@ -31,7 +31,8 @@ class UpdatesTests: XCTestCase {
 
         let data = json.data(using: .utf8)!
 
-        let stubResult: Update.Result = try! Constants.customJSONDecoder.decode(Update.Result.self, from: data)
+        let stubResult: Update.Result = try! Constants.customJSONDecoder.decode(
+          Update.Result.self, from: data)
 
         session.pushData(json)
 
@@ -46,10 +47,51 @@ class UpdatesTests: XCTestCase {
             switch result {
             case .success(let result):
                 XCTAssertEqual(stubResult, result)
-                expectation.fulfill()
             case .failure:
                 XCTFail("Failed to get settings")
             }
+            expectation.fulfill()
+        }
+
+        self.wait(for: [expectation], timeout: 1.0)
+
+    }
+
+    func testGetUpdateInvalidStatus() {
+
+        //Prepare the mock server
+
+        let badStatusUpdateJson = """
+        {
+            "status": "something",
+            "updateId": 1,
+            "type": {
+                "name": "DocumentsAddition",
+                "number": 4
+            },
+            "duration": 0.076980613,
+            "enqueuedAt": "2019-12-07T21:16:09.623944Z",
+            "processedAt": "2019-12-07T21:16:09.703509Z"
+        }
+        """
+
+        session.pushData(badStatusUpdateJson)
+
+        // Start the test with the mocked server
+
+        let UID: String = "movies"
+        let update = Update(updateId: 1)
+
+        let expectation = XCTestExpectation(description: "Get settings")
+
+        self.client.getUpdate(UID: UID, update) { result in
+            switch result {
+            case .success:
+                XCTFail("The server send a invalid status and it should not succeed")
+            case .failure(let error):
+                XCTAssertTrue(error is Update.Status.StatusError)
+                expectation.fulfill()
+            }
         }
 
         self.wait(for: [expectation], timeout: 1.0)
@@ -92,10 +134,10 @@ class UpdatesTests: XCTestCase {
             switch result {
             case .success(let results):
                 XCTAssertEqual(stubResults, results)
-                expectation.fulfill()
             case .failure:
                 XCTFail("Failed to get settings")
             }
+            expectation.fulfill()
         }
 
         self.wait(for: [expectation], timeout: 1.0)