fix(datastore): decode optimistically with paginated list response type (#3474)

* fix(datastore): decode optimistically with paginated list response type

* add unit test cases

* resolve comments

* Update PaginatedListTests.swift

Author: 5d

Amplify/Categories/API/Response/GraphQLError.swift

@@ -44,3 +44,5 @@ extension GraphQLError {
         public let column: Int
     }
 }
+
+extension GraphQLError: Error { }

AmplifyPlugins/Core/AWSPluginsCore/Sync/PaginatedList.swift

@@ -12,4 +12,35 @@ public struct PaginatedList<ModelType: Model>: Decodable {
     public let items: [MutationSync<ModelType>]
     public let nextToken: String?
     public let startedAt: Int64?
+
+    enum CodingKeys: CodingKey {
+        case items
+        case nextToken
+        case startedAt
+    }
+
+    public init(items: [MutationSync<ModelType>], nextToken: String?, startedAt: Int64?) {
+        self.items = items
+        self.nextToken = nextToken
+        self.startedAt = startedAt
+    }
+
+    public init(from decoder: Decoder) throws {
+        let values = try decoder.container(keyedBy: CodingKeys.self)
+        let optimisticDecodedResults = try values.decode([OptimisticDecoded<MutationSync<ModelType>>].self, forKey: .items)
+        items = optimisticDecodedResults.compactMap { try? $0.result.get() }
+        nextToken = try values.decode(String?.self, forKey: .nextToken)
+        startedAt = try values.decode(Int64?.self, forKey: .startedAt)
+    }
+}
+
+
+fileprivate struct OptimisticDecoded<T: Decodable>: Decodable {
+    let result: Result<T, Error>
+
+    init(from decoder: Decoder) throws {
+        result = Result(catching: {
+            try T(from: decoder)
+        })
+    }
 }

AmplifyPlugins/Core/AWSPluginsCoreTests/Sync/PaginatedListTests.swift

@@ -69,6 +69,7 @@ class PaginatedListTests: XCTestCase {
             XCTAssertNotNil(paginatedList.startedAt)
             XCTAssertNotNil(paginatedList.nextToken)
             XCTAssertNotNil(paginatedList.items)
+            XCTAssertEqual(paginatedList.items.count, 2)
             XCTAssert(!paginatedList.items.isEmpty)
             XCTAssert(paginatedList.items[0].model.title == "title")
             XCTAssert(paginatedList.items[0].syncMetadata.version == 10)
@@ -94,4 +95,53 @@ class PaginatedListTests: XCTestCase {
         }
     }
 
+    /// - Given: a `Post` Sync query with items, nextToken, and with sync data (startedAt, _version, etc)
+    /// - When:
+    ///   - some of the JSON items are not able to be decoded to Post
+    ///   - the JSON is decoded into `PaginatedList<Post>`
+    /// - Then:
+    ///   - the result should contain only valid items of type MutationSync<Post>, startedAt, nextToken.
+    func testDecodePaginatedListOptimistically() {
+        let syncQueryJSON = """
+        {
+          "items": [
+            null,
+            {
+              "id": "post-id",
+              "createdAt": "2019-11-27T23:35:39Z",
+              "_version": 10,
+              "_lastChangedAt": 1574897753341,
+              "_deleted": null
+            },
+            {
+              "id": "post-id",
+              "title": "title",
+              "content": "post content",
+              "createdAt": "2019-11-27T23:35:39Z",
+              "_version": 11,
+              "_lastChangedAt": 1574897753341,
+              "_deleted": null
+            }
+          ],
+          "startedAt": 1575322600038,
+          "nextToken": "token"
+        }
+        """
+        do {
+            let decoder = JSONDecoder(dateDecodingStrategy: ModelDateFormatting.decodingStrategy)
+            let data = Data(syncQueryJSON.utf8)
+            let paginatedList = try decoder.decode(PaginatedList<Post>.self, from: data)
+            XCTAssertNotNil(paginatedList)
+            XCTAssertNotNil(paginatedList.startedAt)
+            XCTAssertNotNil(paginatedList.nextToken)
+            XCTAssertNotNil(paginatedList.items)
+            XCTAssertEqual(paginatedList.items.count, 1)
+            XCTAssert(paginatedList.items[0].model.title == "title")
+            XCTAssert(paginatedList.items[0].syncMetadata.version == 11)
+            XCTAssert(paginatedList.items[0].syncMetadata.lastChangedAt == 1_574_897_753_341)
+        } catch {
+            XCTFail(error.localizedDescription)
+        }
+    }
+
 }

AmplifyPlugins/DataStore/Sources/AWSDataStorePlugin/Sync/InitialSync/InitialSyncOperation.swift

@@ -216,11 +216,17 @@ final class InitialSyncOperation: AsynchronousOperation {
 
         let syncQueryResult: SyncQueryResult
         switch graphQLResult {
+        case .success(let queryResult):
+            syncQueryResult = queryResult
+
+        case .failure(.partial(let queryResult, let errors)):
+            syncQueryResult = queryResult
+            errors.map { DataStoreError.api(APIError(errorDescription: $0.message, error: $0)) }
+                .forEach { dataStoreConfiguration.errorHandler($0) }
+
         case .failure(let graphQLResponseError):
             finish(result: .failure(DataStoreError.api(graphQLResponseError)))
             return
-        case .success(let queryResult):
-            syncQueryResult = queryResult
         }
 
         let items = syncQueryResult.items