GraphQLDocument Builder

Amplify/Categories/API/ClientBehavior/APICategoryGraphQLBehavior.swift

@@ -90,31 +90,4 @@ public protocol APICategoryGraphQLBehavior: class {
     func subscribe<R: Decodable>(request: GraphQLRequest<R>,
                                  listener: GraphQLSubscriptionOperation<R>.EventListener?)
         -> GraphQLSubscriptionOperation<R>
-
-    // MARK: - GraphQL operations without a specified type
-
-    /// Performs a GraphQL mutate for the `AnyModel` item. This operation will be asynchronous, with the callback
-    /// accessible both locally and via the Hub.
-    ///
-    /// - Parameters:
-    ///   - model: The instance of the `AnyModel`.
-    ///   - type: The type of mutation to apply on the instance of `AnyModel`.
-    ///   - listener: The event listener for the operation
-    /// - Returns: The AmplifyOperation being enqueued.
-    func mutate(ofAnyModel anyModel: AnyModel,
-                type: GraphQLMutationType,
-                listener: GraphQLOperation<AnyModel>.EventListener?) -> GraphQLOperation<AnyModel>
-
-    /// An internal method used by Plugins to perform initial subscriptions on registered model types to keep them in
-    /// sync with DataStore.
-    ///
-    /// - Parameters:
-    ///   - modelType: The type of the model to subscribe to, as the `Model` protocol rather than the concrete type
-    ///   - subscriptionType: The type of subscription (onCreate, onUpdate, onDelete) to subscribe to
-    /// - Returns: The AmplifyOperation being enqueued
-    func subscribe(toAnyModelType modelType: Model.Type,
-                   subscriptionType: GraphQLSubscriptionType,
-                   listener: GraphQLSubscriptionOperation<AnyModel>.EventListener?)
-    -> GraphQLSubscriptionOperation<AnyModel>
-
 }

Amplify/Categories/API/ClientBehavior/AmplifyAPICategory+GraphQLBehavior.swift

@@ -51,20 +51,4 @@ extension AmplifyAPICategory: APICategoryGraphQLBehavior {
         -> GraphQLSubscriptionOperation<R> {
             plugin.subscribe(request: request, listener: listener)
     }
-
-    // MARK: - GraphQL operations without a specified type
-
-    public func mutate(ofAnyModel anyModel: AnyModel,
-                       type: GraphQLMutationType,
-                       listener: GraphQLOperation<AnyModel>.EventListener?) -> GraphQLOperation<AnyModel> {
-        plugin.mutate(ofAnyModel: anyModel, type: type, listener: listener)
-    }
-
-    public func subscribe(toAnyModelType modelType: Model.Type,
-                          subscriptionType: GraphQLSubscriptionType,
-                          listener: GraphQLSubscriptionOperation<AnyModel>.EventListener?)
-        -> GraphQLSubscriptionOperation<AnyModel> {
-            plugin.subscribe(toAnyModelType: modelType, subscriptionType: subscriptionType, listener: listener)
-    }
-
 }

Amplify/Categories/DataStore/GraphQL/GraphQLQueryType.swift

@@ -5,10 +5,12 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
-/// Defines the type of query, either a `list` which returns multiple results
-/// and can optionally use filters or a `get`, which aims to fetch one result
-/// identified by its `id`.
+/// Defines the type of query,
+/// `list` which returns multiple results and can optionally use filters
+/// `get`, which aims to fetch one result identified by its `id`.
+/// `sync`, similar to `list` and returns results with optionally specifically a point in time
 public enum GraphQLQueryType: String {
     case get
     case list
+    case sync
 }

Amplify/Core/Support/String+Casing.swift → Amplify/Core/Support/String+Extensions.swift

@@ -30,4 +30,9 @@ extension String {
     public func camelCased() -> String {
         return prefix(1).lowercased() + dropFirst()
     }
+
+    /// Appends "s" to the end of the string to represent the pluralized form.
+    public func pluralize() -> String {
+        return self + "s"
+    }
 }

Amplify/Core/Support/Tree.swift

@@ -0,0 +1,25 @@
+//
+// Copyright 2018-2020 Amazon.com,
+// Inc. or its affiliates. All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import Foundation
+
+/// A Tree data type with a `value` of some type `E` and `children` subtrees.
+public class Tree<E> {
+    public var value: E
+    public var children: [Tree<E>] = []
+    public weak var parent: Tree<E>?
+
+    public init(value: E) {
+        self.value = value
+    }
+
+    /// Add a child to the tree's children and set a weak reference from the child to the parent (`self`)
+    public func addChild(settingParentOf child: Tree) {
+        children.append(child)
+        child.parent = self
+    }
+}

AmplifyPlugins/API/AWSAPICategoryPlugin/AWSAPIPlugin+GraphQLBehavior.swift

@@ -54,27 +54,6 @@ public extension AWSAPIPlugin {
             return operation
     }
 
-    func subscribe(toAnyModelType modelType: Model.Type,
-                   subscriptionType: GraphQLSubscriptionType,
-                   listener: GraphQLSubscriptionOperation<AnyModel>.EventListener?) ->
-        GraphQLSubscriptionOperation<AnyModel> {
-            let request = GraphQLRequest<AnyModel>.subscription(toAnyModelType: modelType,
-                                                                subscriptionType: subscriptionType)
-
-            let operationRequest = getOperationRequest(request: request,
-                                                       operationType: .subscription)
-
-            let operation = AWSGraphQLSubscriptionOperation(
-                request: operationRequest,
-                pluginConfig: pluginConfig,
-                subscriptionConnectionFactory: subscriptionConnectionFactory,
-                authService: authService,
-                listener: listener)
-
-            queue.addOperation(operation)
-            return operation
-    }
-
     private func getOperationRequest<R: Decodable>(request: GraphQLRequest<R>,
                                                    operationType: GraphQLOperationType) -> GraphQLOperationRequest<R> {
 

AmplifyPlugins/API/AWSAPICategoryPlugin/AWSAPIPlugin+Reachability.swift

@@ -36,7 +36,7 @@ extension AWSAPIPlugin {
 
     private func determineHostName(apiName: String?) throws -> String {
         if let apiName = apiName {
-            guard let baseUrl = self.pluginConfig.endpoints[apiName]?.baseURL,
+            guard let baseUrl = pluginConfig.endpoints[apiName]?.baseURL,
                 let host = baseUrl.host else {
                     let error = APIError.invalidConfiguration("Invalid endpoint configuration for \(apiName)",
                                                               """
@@ -59,7 +59,7 @@ extension AWSAPIPlugin {
             throw error
         }
 
-        guard let configEntry = self.pluginConfig.endpoints.first else {
+        guard let configEntry = pluginConfig.endpoints.first else {
             let error = APIError.invalidConfiguration("No API configurations found",
                                                       """
                                                       Review how the API category is being instantiated and

AmplifyPlugins/API/AWSAPICategoryPluginFunctionalTests/AnyModelIntegrationTests.swift

@@ -50,7 +50,7 @@ class AnyModelIntegrationTests: XCTestCase {
 
         let callbackInvoked = expectation(description: "Callback invoked")
         var responseFromOperation: GraphQLResponse<AnyModel>?
-        _ = Amplify.API.mutate(ofAnyModel: anyPost, type: .create) { response in
+        _ = Amplify.API.mutate(of: anyPost, type: .create) { response in
             defer {
                 callbackInvoked.fulfill()
             }
@@ -101,7 +101,7 @@ class AnyModelIntegrationTests: XCTestCase {
         let originalAnyPost = try originalPost.eraseToAnyModel()
 
         let createCallbackInvoked = expectation(description: "Create callback invoked")
-        _ = Amplify.API.mutate(ofAnyModel: originalAnyPost, type: .create) { _ in
+        _ = Amplify.API.mutate(of: originalAnyPost, type: .create) { _ in
             createCallbackInvoked.fulfill()
         }
 
@@ -115,7 +115,7 @@ class AnyModelIntegrationTests: XCTestCase {
 
         let updateCallbackInvoked = expectation(description: "Update callback invoked")
         var responseFromOperation: GraphQLResponse<AnyModel>?
-        _ = Amplify.API.mutate(ofAnyModel: updatedAnyPost, type: .update) { response in
+        _ = Amplify.API.mutate(of: updatedAnyPost, type: .update) { response in
             defer {
                 updateCallbackInvoked.fulfill()
             }
@@ -164,7 +164,7 @@ class AnyModelIntegrationTests: XCTestCase {
         let originalAnyPost = try originalPost.eraseToAnyModel()
 
         let createCallbackInvoked = expectation(description: "Create callback invoked")
-        _ = Amplify.API.mutate(ofAnyModel: originalAnyPost, type: .create) { _ in
+        _ = Amplify.API.mutate(of: originalAnyPost, type: .create) { _ in
             createCallbackInvoked.fulfill()
         }
 
@@ -174,7 +174,7 @@ class AnyModelIntegrationTests: XCTestCase {
 
         let deleteCallbackInvoked = expectation(description: "Delete callback invoked")
         var responseFromOperation: GraphQLResponse<AnyModel>?
-        _ = Amplify.API.mutate(ofAnyModel: originalAnyPost, type: .delete) { response in
+        _ = Amplify.API.mutate(of: originalAnyPost, type: .delete) { response in
             defer {
                 deleteCallbackInvoked.fulfill()
             }

AmplifyPlugins/API/AWSAPICategoryPluginFunctionalTests/GraphQLSyncBased/GraphQLSyncBasedTests.swift

@@ -55,18 +55,15 @@ class GraphQLSyncBasedTests: XCTestCase {
 
         let updatedTitle = title + "Updated"
 
-        let modifiedPost = Post(id: createdPost.model.id,
+        let modifiedPost = Post(id: createdPost.model["id"] as? String ?? "",
                                 title: updatedTitle,
-                                content: createdPost.model.content,
+                                content: createdPost.model["content"] as? String ?? "",
                                 createdAt: Date())
 
         let completeInvoked = expectation(description: "request completed")
         var responseFromOperation: GraphQLResponse<MutationSync<AnyModel>>?
-        let document = GraphQLSyncMutation(of: modifiedPost, type: .update, version: 1)
-        let request = GraphQLRequest(document: document.stringValue,
-                                     variables: document.variables,
-                                     responseType: MutationSync<AnyModel>.self,
-                                     decodePath: document.decodePath)
+
+        let request = GraphQLRequest<MutationSyncResult>.updateMutation(of: modifiedPost, version: 1)
 
         _ = Amplify.API.mutate(request: request) { event in
             defer {
@@ -107,7 +104,7 @@ class GraphQLSyncBasedTests: XCTestCase {
         }
 
         XCTAssertEqual(mutationSync.model["title"] as? String, updatedTitle)
-        XCTAssertEqual(mutationSync.model["content"] as? String, createdPost.model.content)
+        XCTAssertEqual(mutationSync.model["content"] as? String, createdPost.model["content"] as? String)
         XCTAssertEqual(mutationSync.syncMetadata.version, 2)
     }
 
@@ -132,11 +129,10 @@ class GraphQLSyncBasedTests: XCTestCase {
         var responseFromOperation: GraphQLResponse<PaginatedList<AnyModel>>?
         let post = Post.keys
         let predicate = post.title == title
-        let document = GraphQLSyncQuery(from: Post.self, predicate: predicate, limit: 1, lastSync: 123)
-        let request = GraphQLRequest(document: document.stringValue,
-                                     variables: document.variables,
-                                     responseType: PaginatedList<AnyModel>.self,
-                                     decodePath: document.decodePath)
+        let request = GraphQLRequest<SyncQueryResult>.syncQuery(modelType: Post.self,
+                                                                where: predicate,
+                                                                limit: 1,
+                                                                lastSync: 123)
 
         _ = Amplify.API.query(request: request) { event in
             defer {
@@ -198,12 +194,8 @@ class GraphQLSyncBasedTests: XCTestCase {
         let disconnectedInvoked = expectation(description: "Connection disconnected")
         let completedInvoked = expectation(description: "Completed invoked")
         let progressInvoked = expectation(description: "Progress invoked")
+        let request = GraphQLRequest<MutationSyncResult>.subscription(to: Post.self, subscriptionType: .onCreate)
 
-        let document = GraphQLSubscription(of: Post.self, type: .onCreate, syncEnabled: true)
-        let request = GraphQLRequest(document: document.stringValue,
-                                     variables: document.variables,
-                                     responseType: MutationSync<AnyModel>.self,
-                                     decodePath: document.decodePath)
         let operation = Amplify.API.subscribe(request: request) { event in
             switch event {
             case .inProcess(let graphQLResponse):
@@ -252,20 +244,16 @@ class GraphQLSyncBasedTests: XCTestCase {
 
     // MARK: Helpers
 
-    func createPost(id: String, title: String) -> MutationSync<AmplifyTestCommon.Post>? {
+    func createPost(id: String, title: String) -> MutationSyncResult? {
         let post = Post(id: id, title: title, content: "content", createdAt: Date())
         return createPost(post: post)
     }
 
-    func createPost(post: AmplifyTestCommon.Post) -> MutationSync<AmplifyTestCommon.Post>? {
-        var result: MutationSync<AmplifyTestCommon.Post>?
+    func createPost(post: AmplifyTestCommon.Post) -> MutationSyncResult? {
+        var result: MutationSyncResult?
         let completeInvoked = expectation(description: "request completed")
 
-        let document = GraphQLSyncMutation(of: post, type: .create)
-        let request = GraphQLRequest(document: document.stringValue,
-                                     variables: document.variables,
-                                     responseType: MutationSync<AmplifyTestCommon.Post>.self,
-                                     decodePath: document.decodePath)
+        let request = GraphQLRequest<MutationSyncResult>.createMutation(of: post)
         _ = Amplify.API.mutate(request: request, listener: { event in
             switch event {
             case .completed(let data):
@@ -285,5 +273,4 @@ class GraphQLSyncBasedTests: XCTestCase {
         wait(for: [completeInvoked], timeout: TestCommonConstants.networkTimeout)
         return result
     }
-
 }

AmplifyPlugins/Core/AWSPluginsCore/Model/Decorator/ConflictResolutionDecorator.swift

@@ -0,0 +1,68 @@
+//
+// Copyright 2018-2020 Amazon.com,
+// Inc. or its affiliates. All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import Amplify
+import Foundation
+
+/// Adds conflict resolution information onto the document based on the operation type (query or mutation)
+/// All selection sets are decorated with conflict resolution fields and inputs are added based on the values that it
+/// was instantiated with. If `version` is passed, the input with key "input" will contain "_version" with the `version`
+/// value. If `lastSync` is passed, the input will contain new key "lastSync" with the `lastSync` value.
+public struct ConflictResolutionDecorator: ModelBasedGraphQLDocumentDecorator {
+
+    private let version: Int?
+    private let lastSync: Int?
+
+    public init(version: Int? = nil, lastSync: Int? = nil) {
+        self.version = version
+        self.lastSync = lastSync
+    }
+
+    public func decorate(_ document: SingleDirectiveGraphQLDocument,
+                         modelType: Model.Type) -> SingleDirectiveGraphQLDocument {
+        var inputs = document.inputs
+
+        if let version = version,
+            case .mutation = document.operationType,
+            var input = inputs["input"],
+            case var .object(value) = input.value {
+
+            value["_version"] = version
+            input.value = .object(value)
+            inputs["input"] = input
+        }
+
+        if let lastSync = lastSync, case .query = document.operationType {
+            inputs["lastSync"] = GraphQLDocumentInput(type: "AWSTimestamp", value: .scalar(lastSync))
+        }
+
+        if let selectionSet = document.selectionSet {
+            addConflictResolution(selectionSet: selectionSet)
+            return document.copy(inputs: inputs, selectionSet: selectionSet)
+        }
+
+        return document.copy(inputs: inputs)
+    }
+
+    /// Append the correct conflict resolution fields for `model` and `pagination` selection sets.
+    private func addConflictResolution(selectionSet: SelectionSet) {
+        switch selectionSet.value.fieldType {
+        case .value:
+            break
+        case .model:
+            selectionSet.addChild(settingParentOf: .init(value: .init(name: "_version", fieldType: .value)))
+            selectionSet.addChild(settingParentOf: .init(value: .init(name: "_deleted", fieldType: .value)))
+            selectionSet.addChild(settingParentOf: .init(value: .init(name: "_lastChangedAt", fieldType: .value)))
+        case .pagination:
+            selectionSet.addChild(settingParentOf: .init(value: .init(name: "startedAt", fieldType: .value)))
+        }
+
+        selectionSet.children.forEach { child in
+            addConflictResolution(selectionSet: child)
+        }
+    }
+}