Datastore/sort by (#580)

* initial orderBy

* rename order

* in case of sudden shut down, urgent push

* update codes according to updated proposal

* refactor sort code

* finished up integration tests

* renamed some stuff

* 1st: fixed PR comments

* remove a Todo comment, update AssertTrue to AssertEqual, remove AWSMobileClient

* removing Pods folder

* fixed namespace issue

* remove additionalStatements

* removing additional statements in mock*

Co-authored-by: Guo <[email protected]>

Author: ruiguoamz

Amplify.xcodeproj/project.pbxproj

@@ -353,6 +353,7 @@
 		B9FAA180238FBB5D009414B4 /* Model+Array.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9FAA17F238FBB5D009414B4 /* Model+Array.swift */; };
 		B9FB05F82383740D00DE1FD4 /* DataStoreStatement.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9FB05F72383740D00DE1FD4 /* DataStoreStatement.swift */; };
 		D83C5160248964780091548E /* ModelGraphQLTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D83C515F248964780091548E /* ModelGraphQLTests.swift */; };
+		D8DD7A1D24A1CCCD001C49FD /* QuerySortInput.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8DD7A1C24A1CCCD001C49FD /* QuerySortInput.swift */; };
 		FA0173352375F8A5005DDDFC /* LoggingError.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA0173342375F8A5005DDDFC /* LoggingError.swift */; };
 		FA0173372375FAA5005DDDFC /* HubError.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA0173362375FAA5005DDDFC /* HubError.swift */; };
 		FA09337C23844E9F00C2FD5F /* GraphQLOperationRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA09337B23844E9F00C2FD5F /* GraphQLOperationRequest.swift */; };
@@ -1120,6 +1121,7 @@
 		D5363CAF9EFAA822FED56808 /* Pods_Amplify_AWSPluginsCore_AWSPluginsTestConfigs_AWSPluginsTestCommon.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Amplify_AWSPluginsCore_AWSPluginsTestConfigs_AWSPluginsTestCommon.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		D5521D5FA66340943C39C451 /* Pods-Amplify-AmplifyAWSPlugins-AWSPluginsCore-AWSAPICategoryPlugin.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Amplify-AmplifyAWSPlugins-AWSPluginsCore-AWSAPICategoryPlugin.debug.xcconfig"; path = "Target Support Files/Pods-Amplify-AmplifyAWSPlugins-AWSPluginsCore-AWSAPICategoryPlugin/Pods-Amplify-AmplifyAWSPlugins-AWSPluginsCore-AWSAPICategoryPlugin.debug.xcconfig"; sourceTree = "<group>"; };
 		D83C515F248964780091548E /* ModelGraphQLTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ModelGraphQLTests.swift; sourceTree = "<group>"; };
+		D8DD7A1C24A1CCCD001C49FD /* QuerySortInput.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = QuerySortInput.swift; sourceTree = "<group>"; };
 		DD2486414D63230FF39130C7 /* Pods-Amplify-AWSPluginsCore.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Amplify-AWSPluginsCore.debug.xcconfig"; path = "Target Support Files/Pods-Amplify-AWSPluginsCore/Pods-Amplify-AWSPluginsCore.debug.xcconfig"; sourceTree = "<group>"; };
 		DEEB82A328223C60557B75C1 /* Pods-Amplify-AmplifyAWSPlugins-AWSPluginsCore-AWSPinpointAnalyticsPlugin.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Amplify-AmplifyAWSPlugins-AWSPluginsCore-AWSPinpointAnalyticsPlugin.release.xcconfig"; path = "Target Support Files/Pods-Amplify-AmplifyAWSPlugins-AWSPluginsCore-AWSPinpointAnalyticsPlugin/Pods-Amplify-AmplifyAWSPlugins-AWSPluginsCore-AWSPinpointAnalyticsPlugin.release.xcconfig"; sourceTree = "<group>"; };
 		E1306F31E45EE7C6B6048F89 /* Pods-AmplifyAWSPlugins-AWSPluginsCore-AWSS3StoragePlugin-AWSS3StoragePluginTests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-AmplifyAWSPlugins-AWSPluginsCore-AWSS3StoragePlugin-AWSS3StoragePluginTests.release.xcconfig"; path = "Target Support Files/Pods-AmplifyAWSPlugins-AWSPluginsCore-AWSS3StoragePlugin-AWSS3StoragePluginTests/Pods-AmplifyAWSPlugins-AWSPluginsCore-AWSS3StoragePlugin-AWSS3StoragePluginTests.release.xcconfig"; sourceTree = "<group>"; };
@@ -2295,6 +2297,7 @@
 				B98E9D072372236200934B51 /* QueryOperator.swift */,
 				B98E9D0B2372236200934B51 /* QueryOperator+Equatable.swift */,
 				B912D1B5242960D40028F05C /* QueryPaginationInput.swift */,
+				D8DD7A1C24A1CCCD001C49FD /* QuerySortInput.swift */,
 				B98E9D082372236200934B51 /* QueryPredicate.swift */,
 				B98E9D0C2372236200934B51 /* QueryPredicate+Equatable.swift */,
 			);
@@ -4375,6 +4378,7 @@
 				B450741324115C260098F02D /* AuthSignInRequest.swift in Sources */,
 				B4FA336A24105EB700E1C659 /* AuthCategoryConfiguration.swift in Sources */,
 				FAC23523227A053D00424678 /* LoggingCategoryPlugin.swift in Sources */,
+				D8DD7A1D24A1CCCD001C49FD /* QuerySortInput.swift in Sources */,
 				B9FB05F82383740D00DE1FD4 /* DataStoreStatement.swift in Sources */,
 				FAC23527227A053D00424678 /* LoggingCategoryClientBehavior.swift in Sources */,
 				FA09B92B2321A10E000E064D /* AnalyticsCategory+CategoryConfigurable.swift in Sources */,

Amplify/Categories/DataStore/DataStoreCategory+Behavior.swift

@@ -20,9 +20,10 @@ extension DataStoreCategory: DataStoreBaseBehavior {
 
     public func query<M: Model>(_ modelType: M.Type,
                                 where predicate: QueryPredicate? = nil,
+                                sort sortInput: QuerySortInput? = nil,
                                 paginate paginationInput: QueryPaginationInput? = nil,
                                 completion: DataStoreCallback<[M]>) {
-        plugin.query(modelType, where: predicate, paginate: paginationInput, completion: completion)
+        plugin.query(modelType, where: predicate, sort: sortInput, paginate: paginationInput, completion: completion)
     }
 
     public func delete<M: Model>(_ model: M,

Amplify/Categories/DataStore/DataStoreCategoryBehavior.swift

@@ -22,6 +22,7 @@ public protocol DataStoreBaseBehavior {
 
     func query<M: Model>(_ modelType: M.Type,
                          where predicate: QueryPredicate?,
+                         sort sortInput: QuerySortInput?,
                          paginate paginationInput: QueryPaginationInput?,
                          completion: DataStoreCallback<[M]>)
 

Amplify/Categories/DataStore/Query/QuerySortInput.swift

@@ -0,0 +1,48 @@
+//
+// Copyright 2018-2020 Amazon.com,
+// Inc. or its affiliates. All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import Foundation
+
+/// A simple enum that holding a sorting direction for a field that can be applied to queries.
+public enum QuerySortBy {
+    case ascending(CodingKey)
+    case descending(CodingKey)
+}
+
+public struct QuerySortInput {
+    public let inputs: [QuerySortBy]
+
+    public init(_ inputs: [QuerySortBy]) {
+        self.inputs = inputs
+    }
+
+    /// Creates a `QuerySortInput` in an expressive way, enabling a short
+    /// and developer friendly access to an instance of `QuerySortInput`.
+    /// Simply by calling:
+    /// - Amplify.Datastore.query(model.self, sort: .ascending(model.keys.id))
+    /// or
+    /// - Amplify.Datastore.query(model.self, sort: .descending(model.keys.id))
+    /// or
+    /// - Amplify.Datastore.query(model.self, sort: .by(.ascending(model.keys.id), .descending(model.keys.createdAt))
+    ///
+    /// - Parameters:
+    ///   - inputs: a variadic parameters that take uncertain number of `QuerySortBy`
+    /// - Returns: a new instance of `QuerySortInput`
+    public static func by(_ inputs: QuerySortBy...) -> QuerySortInput {
+        return self.init(inputs)
+    }
+
+    /// Returns an ascending sort specifier for `field`
+    public static func ascending(_ field: CodingKey) -> QuerySortInput {
+        return QuerySortInput([.ascending(field)])
+    }
+
+    /// Returns an descending sort specifier for `field`
+    public static func descending(_ field: CodingKey) -> QuerySortInput {
+        return QuerySortInput([.descending(field)])
+    }
+}

AmplifyPlugins/DataStore/AWSDataStoreCategoryPlugin/AWSDataStorePlugin+DataStoreBaseBehavior.swift

@@ -79,11 +79,13 @@ extension AWSDataStorePlugin: DataStoreBaseBehavior {
 
     public func query<M: Model>(_ modelType: M.Type,
                                 where predicate: QueryPredicate? = nil,
+                                sort sortInput: QuerySortInput? = nil,
                                 paginate paginationInput: QueryPaginationInput? = nil,
                                 completion: DataStoreCallback<[M]>) {
         reinitStorageEngineIfNeeded()
         storageEngine.query(modelType,
                             predicate: predicate,
+                            sort: sortInput,
                             paginationInput: paginationInput,
                             completion: completion)
     }
@@ -165,6 +167,7 @@ extension AWSDataStorePlugin: DataStoreBaseBehavior {
             let metadata = MutationSyncMetadata.keys
             storageEngine.query(MutationSyncMetadata.self,
                                 predicate: metadata.id == model.id,
+                                sort: nil,
                                 paginationInput: .firstResult) {
                                     switch $0 {
                                     case .success(let result):

AmplifyPlugins/DataStore/AWSDataStoreCategoryPlugin/Storage/ModelStorageBehavior.swift

@@ -24,6 +24,7 @@ protocol ModelStorageBehavior {
 
     func query<M: Model>(_ modelType: M.Type,
                          predicate: QueryPredicate?,
+                         sort: QuerySortInput?,
                          paginationInput: QueryPaginationInput?,
                          completion: DataStoreCallback<[M]>)
 

AmplifyPlugins/DataStore/AWSDataStoreCategoryPlugin/Storage/SQLite/QuerySort+SQLite.swift

@@ -0,0 +1,46 @@
+//
+// Copyright 2018-2020 Amazon.com,
+// Inc. or its affiliates. All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import Amplify
+import Foundation
+import SQLite
+
+extension QuerySortBy {
+    var fieldName: String {
+        switch self {
+        case .ascending(let key), .descending(let key):
+            return key.stringValue
+        }
+    }
+
+    var fieldOrder: String {
+        switch self {
+        case .ascending:
+            return "asc"
+        case .descending:
+            return "desc"
+        }
+    }
+}
+
+extension QuerySortInput {
+    func sortStatement(namespace: String) -> String {
+        let sqlResult = inputs
+            .map { QuerySortInput.columnFor(field: $0.fieldName,
+                                            order: $0.fieldOrder,
+                                            namespace: namespace) }
+
+        return sqlResult.joined(separator: ", ")
+    }
+
+    static func columnFor(field: String,
+                          order: String,
+                          namespace: String) -> String {
+        return namespace.quoted() + "." + field.quoted() + " " + order
+
+    }
+}

AmplifyPlugins/DataStore/AWSDataStoreCategoryPlugin/Storage/SQLite/SQLStatement+Select.swift

@@ -19,11 +19,10 @@ struct SelectStatementMetadata {
     let columnMapping: ColumnMapping
     let bindings: [Binding?]
 
-    // TODO remove additionalStatements once sorting support is added to DataStore
     static func metadata(from modelType: Model.Type,
                          predicate: QueryPredicate? = nil,
-                         paginationInput: QueryPaginationInput? = nil,
-                         additionalStatements: String? = nil) -> SelectStatementMetadata {
+                         sort: QuerySortInput? = nil,
+                         paginationInput: QueryPaginationInput? = nil) -> SelectStatementMetadata {
         let rootNamespace = "root"
         let schema = modelType.schema
         let fields = schema.columns
@@ -59,10 +58,10 @@ struct SelectStatementMetadata {
             """
         }
 
-        if let additionalStatements = additionalStatements {
+        if let sort = sort, !sort.inputs.isEmpty {
             sql = """
             \(sql)
-            \(additionalStatements)
+            order by \(sort.sortStatement(namespace: rootNamespace))
             """
         }
 
@@ -72,6 +71,7 @@ struct SelectStatementMetadata {
             \(paginationInput.sqlStatement)
             """
         }
+
         return SelectStatementMetadata(statement: sql,
                                        columnMapping: columnMapping,
                                        bindings: bindings)
@@ -137,13 +137,13 @@ struct SelectStatement: SQLStatement {
 
     init(from modelType: Model.Type,
          predicate: QueryPredicate? = nil,
-         paginationInput: QueryPaginationInput? = nil,
-         additionalStatements: String? = nil) {
+         sort: QuerySortInput? = nil,
+         paginationInput: QueryPaginationInput? = nil) {
         self.modelType = modelType
         self.metadata = .metadata(from: modelType,
                                   predicate: predicate,
-                                  paginationInput: paginationInput,
-                                  additionalStatements: additionalStatements)
+                                  sort: sort,
+                                  paginationInput: paginationInput)
     }
 
     var stringValue: String {

AmplifyPlugins/DataStore/AWSDataStoreCategoryPlugin/Storage/SQLite/StorageEngineAdapter+SQLite.swift

@@ -188,25 +188,14 @@ final class SQLiteStorageEngineAdapter: StorageEngineAdapter {
 
     func query<M: Model>(_ modelType: M.Type,
                          predicate: QueryPredicate? = nil,
+                         sort: QuerySortInput? = nil,
                          paginationInput: QueryPaginationInput? = nil,
                          completion: DataStoreCallback<[M]>) {
-        query(modelType,
-              predicate: predicate,
-              paginationInput: paginationInput,
-              additionalStatements: nil,
-              completion: completion)
-    }
-
-    func query<M: Model>(_ modelType: M.Type,
-                         predicate: QueryPredicate? = nil,
-                         paginationInput: QueryPaginationInput? = nil,
-                         additionalStatements: String? = nil,
-                         completion: DataStoreCallback<[M]>) {
         do {
             let statement = SelectStatement(from: modelType,
                                             predicate: predicate,
-                                            paginationInput: paginationInput,
-                                            additionalStatements: additionalStatements)
+                                            sort: sort,
+                                            paginationInput: paginationInput)
             let rows = try connection.prepare(statement.stringValue).run(statement.variables)
             let result: [M] = try rows.convert(to: modelType, using: statement)
             completion(.success(result))

AmplifyPlugins/DataStore/AWSDataStoreCategoryPlugin/Storage/StorageEngine.swift

@@ -293,8 +293,8 @@ final class StorageEngine: StorageEngineBehavior {
             try storageAdapter.transaction {
                 storageAdapter.query(modelType,
                                      predicate: predicate,
+                                     sort: nil,
                                      paginationInput: nil,
-                                     additionalStatements: nil,
                                      completion: queryCompletionBlock)
             }
         } catch {
@@ -329,10 +329,12 @@ final class StorageEngine: StorageEngineBehavior {
 
     func query<M: Model>(_ modelType: M.Type,
                          predicate: QueryPredicate? = nil,
+                         sort: QuerySortInput? = nil,
                          paginationInput: QueryPaginationInput? = nil,
                          completion: DataStoreCallback<[M]>) {
         return storageAdapter.query(modelType,
                                     predicate: predicate,
+                                    sort: sort,
                                     paginationInput: paginationInput,
                                     completion: completion)
     }