feat: enable query caching by using GET instead of POST (#386)

* feat: add the ability to cache queries

* feat: use GET instead of POST for query by default

* add the rest of GET queries

* fix test build errors

* first test

* sort url query items for cache

* add tests

* add changelog

Author: cbaker6

.codecov.yml

@@ -6,10 +6,10 @@ coverage:
   status:
     patch:
       default:
-        target: auto
+        target: 79
     changes: false
     project:
       default:
-        target: 87
+        target: 89
 comment:
   require_changes: true

.github/workflows/ci.yml

@@ -6,7 +6,7 @@ on:
     branches: '*'
 env:
   CI_XCODE_VER: '/Applications/Xcode_12.5.1.app/Contents/Developer'
-  CI_XCODE_13: '/Applications/Xcode_13.4.app/Contents/Developer'
+  CI_XCODE_13: '/Applications/Xcode_13.4.1.app/Contents/Developer'
 
 jobs:
   xcode-test-ios:

.github/workflows/release.yml

@@ -3,7 +3,7 @@ on:
   release:
     types: [published]
 env:
-  CI_XCODE_13: '/Applications/Xcode_13.4.app/Contents/Developer'
+  CI_XCODE_13: '/Applications/Xcode_13.4.1.app/Contents/Developer'
 
 jobs:
   cocoapods:

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ### main
 
+__New features__
+- Enable query caching by using GET instead of POST. GET is now used by default. To switch back to POST, set usingPostForQuery = true when initializing the SDK which will automatically disable all query caching ([#386](https://github.com/parse-community/Parse-Swift/pull/386)), thanks to [Corey Baker](https://github.com/cbaker6).
+
 __Improvements__
 - Added discardableResult to allow developers to choose whether or not certain functions should return a result ([#385](https://github.com/parse-community/Parse-Swift/pull/385)), thanks to [Damian Van de Kauter](https://github.com/vdkdamian).
 

ParseSwift.xcodeproj/project.pbxproj

@@ -260,7 +260,7 @@ internal extension API {
         func prepareURLRequest(options: API.Options,
                                childObjects: [String: PointerType]? = nil,
                                childFiles: [UUID: ParseFile]? = nil) -> Result<URLRequest, ParseError> {
-            let params = self.params?.getQueryItems()
+            let params = self.params?.getURLQueryItems()
             var headers = API.getHeaders(options: options)
             if method == .GET || method == .DELETE {
                 headers.removeValue(forKey: "X-Parse-Request-Id")

Sources/ParseSwift/API/API+Command.swift

@@ -19,6 +19,7 @@ internal extension API {
         let path: API.Endpoint
         let body: T?
         let mapper: ((Data) throws -> U)
+        let params: [String: String?]?
 
         init(method: API.Method,
              path: API.Endpoint,
@@ -27,6 +28,7 @@ internal extension API {
              mapper: @escaping ((Data) throws -> U)) {
             self.method = method
             self.path = path
+            self.params = params
             self.body = body
             self.mapper = mapper
         }
@@ -83,17 +85,23 @@ internal extension API {
 
         // MARK: URL Preperation
         func prepareURLRequest(options: API.Options) -> Result<URLRequest, ParseError> {
+            let params = self.params?.getURLQueryItems()
             var headers = API.getHeaders(options: options)
             if method == .GET || method == .DELETE {
                 headers.removeValue(forKey: "X-Parse-Request-Id")
             }
             let url = ParseSwift.configuration.serverURL.appendingPathComponent(path.urlComponent)
 
-            guard let components = URLComponents(url: url, resolvingAgainstBaseURL: false),
-                  let urlComponents = components.url else {
+            guard var components = URLComponents(url: url, resolvingAgainstBaseURL: false) else {
                 return .failure(ParseError(code: .unknownError,
                                            message: "couldn't unrwrap url components for \(url)"))
             }
+            components.queryItems = params
+
+            guard let urlComponents = components.url else {
+                return .failure(ParseError(code: .unknownError,
+                                           message: "couldn't create url from components for \(components)"))
+            }
 
             var urlRequest = URLRequest(url: urlComponents)
             urlRequest.allHTTPHeaderFields = headers

Sources/ParseSwift/API/API+NonParseBodyCommand.swift

@@ -254,11 +254,3 @@ public struct API {
         ParseConstants.sdk+ParseConstants.version
     }
 }
-
-internal extension Dictionary where Key == String, Value == String? {
-    func getQueryItems() -> [URLQueryItem] {
-        return map { (key, value) -> URLQueryItem in
-            return URLQueryItem(name: key, value: value)
-        }
-    }
-}

Sources/ParseSwift/API/API.swift

@@ -0,0 +1,17 @@
+//
+//  Dictionary.swift
+//  ParseSwift
+//
+//  Created by Corey Baker on 7/14/22.
+//  Copyright © 2022 Parse Community. All rights reserved.
+//
+
+import Foundation
+
+internal extension Dictionary where Key == String, Value == String? {
+    func getURLQueryItems() -> [URLQueryItem] {
+        sorted { $0.key < $1.key }.map { (key, value) -> URLQueryItem in
+            URLQueryItem(name: key, value: value)
+        }
+    }
+}

Sources/ParseSwift/Extensions/Dictionary.swift

@@ -37,6 +37,12 @@ public struct ParseConfiguration {
     /// - warning: This is known not to work for LiveQuery on Parse Servers <= 5.0.0.
     public internal(set) var isUsingEqualQueryConstraint = false
 
+    /// Use **POST** instead of **GET** when making query calls.
+    /// Defaults to **false**.
+    /// - warning: **POST** calls are not cached and will require all queries to access the
+    /// server instead of following the `requestCachePolicy`.
+    public internal(set) var isUsingPostForQuery = false
+
     /// The default caching policy for all http requests that determines when to
     /// return a response from the cache. Defaults to `useProtocolCachePolicy`.
     /// See Apple's [documentation](https://developer.apple.com/documentation/foundation/url_loading_system/accessing_cached_data)
@@ -85,6 +91,8 @@ public struct ParseConfiguration {
      side for each object. Must be enabled on the server to work.
      - parameter usingTransactions: Use transactions when saving/updating multiple objects.
      - parameter usingEqualQueryConstraint: Use the **$eq** query constraint when querying.
+     - parameter usingPostForQuery: Use **POST** instead of **GET** when making query calls.
+     Defaults to **false**.
      - parameter keyValueStore: A key/value store that conforms to the `ParseKeyValueStore`
      protocol. Defaults to `nil` in which one will be created an memory, but never persisted. For Linux, this
      this is the only store available since there is no Keychain. Linux users should replace this store with an
@@ -110,6 +118,7 @@ public struct ParseConfiguration {
      See Apple's [documentation](https://developer.apple.com/documentation/foundation/urlsessiontaskdelegate/1411595-urlsession) for more for details.
      - warning: `usingTransactions` is experimental.
      - warning: It is recomended to only specify `masterKey` when using the SDK on a server. Do not use this key on the client.
+     - warning: Setting `usingPostForQuery` to **true**  will require all queries to access the server instead of following the `requestCachePolicy`.
      */
     public init(applicationId: String,
                 clientKey: String? = nil,
@@ -121,6 +130,7 @@ public struct ParseConfiguration {
                 allowingCustomObjectIds: Bool = false,
                 usingTransactions: Bool = false,
                 usingEqualQueryConstraint: Bool = false,
+                usingPostForQuery: Bool = false,
                 keyValueStore: ParseKeyValueStore? = nil,
                 requestCachePolicy: URLRequest.CachePolicy = .useProtocolCachePolicy,
                 cacheMemoryCapacity: Int = 512_000,
@@ -140,6 +150,7 @@ public struct ParseConfiguration {
         self.isAllowingCustomObjectIds = allowingCustomObjectIds
         self.isUsingTransactions = usingTransactions
         self.isUsingEqualQueryConstraint = usingEqualQueryConstraint
+        self.isUsingPostForQuery = usingPostForQuery
         self.mountPath = "/" + serverURL.pathComponents
             .filter { $0 != "/" }
             .joined(separator: "/")
@@ -253,6 +264,8 @@ public struct ParseSwift {
      side for each object. Must be enabled on the server to work.
      - parameter usingTransactions: Use transactions when saving/updating multiple objects.
      - parameter usingEqualQueryConstraint: Use the **$eq** query constraint when querying.
+     - parameter usingPostForQuery: Use **POST** instead of **GET** when making query calls.
+     Defaults to **false**.
      - parameter keyValueStore: A key/value store that conforms to the `ParseKeyValueStore`
      protocol. Defaults to `nil` in which one will be created an memory, but never persisted. For Linux, this
      this is the only store available since there is no Keychain. Linux users should replace this store with an
@@ -276,6 +289,7 @@ public struct ParseSwift {
      See Apple's [documentation](https://developer.apple.com/documentation/foundation/urlsessiontaskdelegate/1411595-urlsession) for more for details.
      - warning: `usingTransactions` is experimental.
      - warning: It is recomended to only specify `masterKey` when using the SDK on a server. Do not use this key on the client.
+     - warning: Setting `usingPostForQuery` to **true**  will require all queries to access the server instead of following the `requestCachePolicy`.
      */
     static public func initialize(
         applicationId: String,
@@ -286,6 +300,7 @@ public struct ParseSwift {
         allowingCustomObjectIds: Bool = false,
         usingTransactions: Bool = false,
         usingEqualQueryConstraint: Bool = false,
+        usingPostForQuery: Bool = false,
         keyValueStore: ParseKeyValueStore? = nil,
         requestCachePolicy: URLRequest.CachePolicy = .useProtocolCachePolicy,
         cacheMemoryCapacity: Int = 512_000,
@@ -306,6 +321,7 @@ public struct ParseSwift {
                                         allowingCustomObjectIds: allowingCustomObjectIds,
                                         usingTransactions: usingTransactions,
                                         usingEqualQueryConstraint: usingEqualQueryConstraint,
+                                        usingPostForQuery: usingPostForQuery,
                                         keyValueStore: keyValueStore,
                                         requestCachePolicy: requestCachePolicy,
                                         cacheMemoryCapacity: cacheMemoryCapacity,
@@ -325,6 +341,7 @@ public struct ParseSwift {
                                     allowingCustomObjectIds: Bool = false,
                                     usingTransactions: Bool = false,
                                     usingEqualQueryConstraint: Bool = false,
+                                    usingPostForQuery: Bool = false,
                                     keyValueStore: ParseKeyValueStore? = nil,
                                     requestCachePolicy: URLRequest.CachePolicy = .useProtocolCachePolicy,
                                     cacheMemoryCapacity: Int = 512_000,
@@ -345,6 +362,7 @@ public struct ParseSwift {
                                                allowingCustomObjectIds: allowingCustomObjectIds,
                                                usingTransactions: usingTransactions,
                                                usingEqualQueryConstraint: usingEqualQueryConstraint,
+                                               usingPostForQuery: usingPostForQuery,
                                                keyValueStore: keyValueStore,
                                                requestCachePolicy: requestCachePolicy,
                                                cacheMemoryCapacity: cacheMemoryCapacity,