fix: default cache policy for ParseFile uses SDK default (#274)

cbaker6 · web-flow · commit af447a62311f · 2021-11-03T23:24:39.000-04:00
* default cache policy for ParseFile uses SDK default

* Failing operation set test

* improve operation set comparison
diff --git a/.codecov.yml b/.codecov.yml
@@ -6,7 +6,7 @@ coverage:
   status:
     patch:
       default:
-        target: 36
+        target: auto
     changes: false
     project:
       default:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,9 +2,15 @@
 
 ### main
 
-[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/2.2.0...main)
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/2.2.1...main)
 * _Contributing to this repo? Add info about your change here to be included in the next release_
 
+### 2.2.1
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/2.2.0...2.2.1)
+
+__Fixes__
+- Set the default cache policy for `ParseFile` to the default policy set when initializing the SDK ([#274](https://github.com/parse-community/Parse-Swift/pull/274)), thanks to [Corey Baker](https://github.com/cbaker6).
+
 ### 2.2.0
 [Full Changelog](https://github.com/parse-community/Parse-Swift/compare/2.1.0...2.2.0)
 
diff --git a/Sources/ParseSwift/Objects/ParseInstallation+combine.swift b/Sources/ParseSwift/Objects/ParseInstallation+combine.swift
@@ -12,7 +12,7 @@ import Combine
 
 public extension ParseInstallation {
 
-    // MARK: Fetchable - Combine
+    // MARK: Combine
     /**
      Fetches the `ParseInstallation` *aynchronously* with the current data from the server
      and sets an error if one occurs. Publishes when complete.
@@ -34,7 +34,6 @@ public extension ParseInstallation {
         }
     }
 
-    // MARK: Savable - Combine
     /**
      Saves the `ParseInstallation` *asynchronously* and publishes when complete.
 
@@ -51,7 +50,6 @@ public extension ParseInstallation {
         }
     }
 
-    // MARK: Deletable - Combine
     /**
      Deletes the `ParseInstallation` *asynchronously* and publishes when complete.
 
diff --git a/Sources/ParseSwift/Objects/ParseObject+combine.swift b/Sources/ParseSwift/Objects/ParseObject+combine.swift
@@ -12,7 +12,7 @@ import Combine
 
 public extension ParseObject {
 
-    // MARK: Fetchable - Combine
+    // MARK: Combine
     /**
      Fetches the `ParseObject` *aynchronously* with the current data from the server and sets an error if one occurs.
      Publishes when complete.
diff --git a/Sources/ParseSwift/Objects/ParseUser+combine.swift b/Sources/ParseSwift/Objects/ParseUser+combine.swift
@@ -135,7 +135,7 @@ public extension ParseUser {
         }
     }
 
-    // MARK: Fetchable - Combine
+    // MARK: Combine
     /**
      Fetches the `ParseUser` *aynchronously* with the current data from the server and sets an error if one occurs.
      Publishes when complete.
@@ -157,7 +157,6 @@ public extension ParseUser {
         }
     }
 
-    // MARK: Savable - Combine
     /**
      Saves the `ParseUser` *asynchronously* and publishes when complete.
 
@@ -186,7 +185,6 @@ public extension ParseUser {
         }
     }
 
-    // MARK: Deletable - Combine
     /**
      Deletes the `ParseUser` *asynchronously* and publishes when complete.
 
diff --git a/Sources/ParseSwift/Operations/ParseOperation.swift b/Sources/ParseSwift/Operations/ParseOperation.swift
@@ -38,13 +38,7 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
             throw ParseError(code: .unknownError, message: "Target shouldn't be nil")
         }
         var mutableOperation = self
-        if let currentValue = target[keyPath: key.1] as? NSObject,
-           let updatedValue = value as? NSObject {
-            if currentValue != updatedValue {
-                mutableOperation.operations[key.0] = value
-                mutableOperation.target?[keyPath: key.1] = value
-            }
-        } else {
+        if !isEqual(target[keyPath: key.1], to: value) {
             mutableOperation.operations[key.0] = value
             mutableOperation.target?[keyPath: key.1] = value
         }
@@ -403,6 +397,16 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
             try value.encode(to: encoder)
         }
     }
+
+    func isEqual(_ lhs: Encodable, to rhs: Encodable) -> Bool {
+        guard let lhsData = try? ParseCoding.parseEncoder().encode(lhs),
+              let lhsString = String(data: lhsData, encoding: .utf8),
+              let rhsData = try? ParseCoding.parseEncoder().encode(rhs),
+              let rhsString = String(data: rhsData, encoding: .utf8) else {
+         return false
+        }
+        return lhsString == rhsString
+    }
 }
 
 // MARK: Savable
diff --git a/Sources/ParseSwift/ParseConstants.swift b/Sources/ParseSwift/ParseConstants.swift
@@ -10,7 +10,7 @@ import Foundation
 
 enum ParseConstants {
     static let sdk = "swift"
-    static let version = "2.2.0"
+    static let version = "2.2.1"
     static let fileManagementDirectory = "parse/"
     static let fileManagementPrivateDocumentsDirectory = "Private Documents/"
     static let fileManagementLibraryDirectory = "Library/"
diff --git a/Sources/ParseSwift/Types/ParseConfig+combine.swift b/Sources/ParseSwift/Types/ParseConfig+combine.swift
@@ -12,7 +12,7 @@ import Combine
 
 public extension ParseConfig {
 
-    // MARK: Fetchable - Combine
+    // MARK: Combine
 
     /**
      Fetch the Config *asynchronously*. Publishes when complete.
@@ -28,8 +28,6 @@ public extension ParseConfig {
         }
     }
 
-    // MARK: Savable - Combine
-
     /**
      Update the Config *asynchronously*.
      - parameter options: A set of header options sent to the server. Defaults to an empty set.
diff --git a/Sources/ParseSwift/Types/ParseFile.swift b/Sources/ParseSwift/Types/ParseFile.swift
@@ -266,15 +266,12 @@ extension ParseFile {
      - parameter callbackQueue: The queue to return to after synchronous completion.
      Default value of .main.
      - returns: A saved `ParseFile`.
-     - note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
-     desires a different policy, it should be inserted in `options`.
      */
     public func save(options: API.Options = [],
                      stream: InputStream,
                      callbackQueue: DispatchQueue = .main,
                      progress: ((URLSessionTask, Int64, Int64, Int64) -> Void)? = nil) throws {
         var options = options
-        options.insert(.cachePolicy(.reloadIgnoringLocalCacheData))
         if let mimeType = mimeType {
             options.insert(.mimeType(mimeType))
         } else {
@@ -300,13 +297,10 @@ extension ParseFile {
      - parameter options: A set of header options sent to the server. Defaults to an empty set.
      - parameter callbackQueue: The queue to return to after synchronous completion.
      - returns: A saved `ParseFile`.
-     - note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
-     desires a different policy, it should be inserted in `options`.
      */
     public func save(options: API.Options = [],
                      callbackQueue: DispatchQueue) throws -> ParseFile {
         var options = options
-        options.insert(.cachePolicy(.reloadIgnoringLocalCacheData))
         if let mimeType = mimeType {
             options.insert(.mimeType(mimeType))
         } else {
@@ -376,14 +370,11 @@ extension ParseFile {
      It should have the following argument signature: `(task: URLSessionDownloadTask,
      bytesWritten: Int64, totalBytesWritten: Int64, totalBytesExpectedToWrite: Int64)`.
      - returns: A saved `ParseFile`.
-     - note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
-     desires a different policy, it should be inserted in `options`.
      */
     public func save(options: API.Options = [],
                      callbackQueue: DispatchQueue = .main,
                      progress: ((URLSessionTask, Int64, Int64, Int64) -> Void)?) throws -> ParseFile {
         var options = options
-        options.insert(.cachePolicy(.reloadIgnoringLocalCacheData))
         if let mimeType = mimeType {
             options.insert(.mimeType(mimeType))
         } else {
@@ -538,8 +529,6 @@ extension ParseFile {
      - parameter callbackQueue: The queue to return to after synchronous completion.
      Default value of .main.
      - returns: A saved `ParseFile`.
-     - note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
-     desires a different policy, it should be inserted in `options`.
      */
     public func fetch(options: API.Options = [],
                       stream: InputStream,
@@ -556,7 +545,6 @@ extension ParseFile {
         if let tags = tags {
             options.insert(.tags(tags))
         }
-        options.insert(.cachePolicy(.reloadIgnoringLocalCacheData))
         options = options.union(self.options)
         return try downloadFileCommand()
             .executeStream(options: options,
@@ -570,8 +558,6 @@ extension ParseFile {
      - parameter options: A set of header options sent to the server. Defaults to an empty set.
      - parameter callbackQueue: The queue to return to after synchronous completion.
      - returns: A saved `ParseFile`.
-     - note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
-     desires a different policy, it should be inserted in `options`.
      */
     public func fetch(includeKeys: [String]? = nil,
                       options: API.Options = [],
@@ -588,7 +574,6 @@ extension ParseFile {
         if let tags = tags {
             options.insert(.tags(tags))
         }
-        options.insert(.cachePolicy(.reloadIgnoringLocalCacheData))
         options = options.union(self.options)
         return try downloadFileCommand()
             .execute(options: options,
@@ -600,8 +585,6 @@ extension ParseFile {
      - parameter includeKeys: Currently not used for `ParseFile`.
      - parameter options: A set of header options sent to the server. Defaults to an empty set.
      - returns: A saved `ParseFile`.
-     - note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
-     desires a different policy, it should be inserted in `options`.
      */
     public func fetch(includeKeys: [String]? = nil,
                       options: API.Options = []) throws -> ParseFile {
@@ -649,8 +632,6 @@ extension ParseFile {
      It should have the following argument signature: `(task: URLSessionDownloadTask,
      bytesWritten: Int64, totalBytesWritten: Int64, totalBytesExpectedToWrite: Int64)`.
      - returns: A saved `ParseFile`.
-     - note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
-     desires a different policy, it should be inserted in `options`.
      */
     public func fetch(options: API.Options = [],
                       callbackQueue: DispatchQueue = .main,
@@ -667,7 +648,6 @@ extension ParseFile {
         if let tags = tags {
             options.insert(.tags(tags))
         }
-        options.insert(.cachePolicy(.reloadIgnoringLocalCacheData))
         options = options.union(self.options)
         return try downloadFileCommand()
             .execute(options: options,
@@ -715,9 +695,7 @@ extension ParseFile {
      It should have the following argument signature: `(task: URLSessionDownloadTask,
      bytesWritten: Int64, totalBytesWritten: Int64, totalBytesExpectedToWrite: Int64)`.
      - parameter completion: A block that will be called when file fetches or fails.
-     It should have the following argument signature: `(Result<Self, ParseError>)`
-     - note: The default cache policy for this method is `.reloadIgnoringLocalCacheData`. If a developer
-     desires a different policy, it should be inserted in `options`.
+     It should have the following argument signature: `(Result<Self, ParseError>)`.
     */
     public func fetch(options: API.Options = [],
                       callbackQueue: DispatchQueue = .main,
@@ -735,7 +713,6 @@ extension ParseFile {
         if let tags = tags {
             options.insert(.tags(tags))
         }
-        options.insert(.cachePolicy(.reloadIgnoringLocalCacheData))
         options = options.union(self.options)
         downloadFileCommand()
             .executeAsync(options: options,
diff --git a/Sources/ParseSwift/Types/Pointer.swift b/Sources/ParseSwift/Types/Pointer.swift
@@ -12,12 +12,10 @@ protocol ParsePointer: Encodable {
 extension ParsePointer {
     /**
      Determines if two objects have the same objectId.
-
      - parameter as: Object to compare.
-
      - returns: Returns a `true` if the other object has the same `objectId` or `false` if unsuccessful.
     */
-    public func hasSameObjectId(as other: ParsePointer) -> Bool {
+    func hasSameObjectId(as other: ParsePointer) -> Bool {
         return other.className == className && other.objectId == objectId
     }
 }
@@ -82,6 +80,24 @@ public struct Pointer<T: ParseObject>: ParsePointer, Fetchable, Encodable, Hasha
 
 public extension Pointer {
 
+    /**
+     Determines if a `ParseObject` and `Pointer`have the same `objectId`.
+     - parameter as: `ParseObject` to compare.
+     - returns: Returns a `true` if the other object has the same `objectId` or `false` if unsuccessful.
+    */
+    func hasSameObjectId(as other: T) -> Bool {
+        return other.className == className && other.objectId == objectId
+    }
+
+    /**
+     Determines if two `Pointer`'s have the same `objectId`.
+     - parameter as: `Pointer` to compare.
+     - returns: Returns a `true` if the other object has the same `objectId` or `false` if unsuccessful.
+    */
+    func hasSameObjectId(as other: Self) -> Bool {
+        return other.className == className && other.objectId == objectId
+    }
+
     /**
      Fetches the `ParseObject` *synchronously* with the current data from the server and sets an error if one occurs.
      - parameter includeKeys: The name(s) of the key(s) to include that are
diff --git a/Tests/ParseSwiftTests/ParseOperationTests.swift b/Tests/ParseSwiftTests/ParseOperationTests.swift
@@ -503,6 +503,15 @@ class ParseOperationTests: XCTestCase {
         let decoded = try XCTUnwrap(String(data: encoded, encoding: .utf8))
         XCTAssertEqual(decoded, expected)
         XCTAssertEqual(operations.target?.score, 15)
+        var level = Level(level: 12)
+        level.members = ["hello", "world"]
+        let operations2 = try score.operation.set(("previous", \.previous), value: [level])
+        let expected2 = "{\"previous\":[{\"level\":12,\"members\":[\"hello\",\"world\"]}]}"
+        let encoded2 = try ParseCoding.parseEncoder()
+            .encode(operations2)
+        let decoded2 = try XCTUnwrap(String(data: encoded2, encoding: .utf8))
+        XCTAssertEqual(decoded2, expected2)
+        XCTAssertEqual(operations2.target?.previous, [level])
     }
     #endif
 
@@ -516,6 +525,17 @@ class ParseOperationTests: XCTestCase {
             .encode(operations)
         let decoded = try XCTUnwrap(String(data: encoded, encoding: .utf8))
         XCTAssertEqual(decoded, expected)
+        XCTAssertEqual(operations.target?.objectId, "test")
+        var level = Level(level: 12)
+        level.members = ["hello", "world"]
+        score.previous = [level]
+        let expected2 = "{}"
+        let operations2 = try score.operation.set(("previous", \.previous), value: [level])
+        let encoded2 = try ParseCoding.parseEncoder()
+            .encode(operations2)
+        let decoded2 = try XCTUnwrap(String(data: encoded2, encoding: .utf8))
+        XCTAssertEqual(decoded2, expected2)
+        XCTAssertEqual(operations2.target?.previous, [level])
     }
 
     func testUnchangedSet() throws {
diff --git a/Tests/ParseSwiftTests/ParsePointerTests.swift b/Tests/ParseSwiftTests/ParsePointerTests.swift
@@ -92,6 +92,33 @@ class ParsePointerTests: XCTestCase {
         XCTAssertEqual(pointer.objectId, score.objectId)
     }
 
+    func testHasSameObjectId() throws {
+        var score = GameScore(score: 10)
+        let objectId = "yarr"
+        score.objectId = objectId
+        let pointer = try score.toPointer()
+        let pointer2 = pointer
+        XCTAssertTrue(pointer.hasSameObjectId(as: pointer2))
+        XCTAssertTrue(pointer.hasSameObjectId(as: score))
+        score.objectId = "hello"
+        let pointer3 = try score.toPointer()
+        XCTAssertFalse(pointer.hasSameObjectId(as: pointer3))
+        XCTAssertFalse(pointer.hasSameObjectId(as: score))
+    }
+
+    func testPointerEquality() throws {
+        var score = GameScore(score: 10)
+        let objectId = "yarr"
+        score.objectId = objectId
+        let pointer = try score.toPointer()
+        var score2 = GameScore(score: 10)
+        score2.objectId = objectId
+        var pointer2 = try score2.toPointer()
+        XCTAssertEqual(pointer, pointer2)
+        pointer2.objectId = "hello"
+        XCTAssertNotEqual(pointer, pointer2)
+    }
+
     func testDetectCircularDependency() throws {
         var score = GameScore(score: 10)
         score.objectId = "nice"

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ import Combine`
`12`	`12`
`13`	`13`	`public extension ParseInstallation {`
`14`	`14`
`15`		`- // MARK: Fetchable - Combine`
	`15`	`+ // MARK: Combine`
`16`	`16`	`/**`
`17`	`17`	Fetches the `ParseInstallation` aynchronously with the current data from the server
`18`	`18`	`and sets an error if one occurs. Publishes when complete.`
`@@ -34,7 +34,6 @@ public extension ParseInstallation {`
`34`	`34`	`}`
`35`	`35`	`}`
`36`	`36`
`37`		`- // MARK: Savable - Combine`
`38`	`37`	`/**`
`39`	`38`	Saves the `ParseInstallation` asynchronously and publishes when complete.
`40`	`39`
`@@ -51,7 +50,6 @@ public extension ParseInstallation {`
`51`	`50`	`}`
`52`	`51`	`}`
`53`	`52`
`54`		`- // MARK: Deletable - Combine`
`55`	`53`	`/**`
`56`	`54`	Deletes the `ParseInstallation` asynchronously and publishes when complete.
`57`	`55`
Original file line number	Diff line number	Diff line change
`@@ -135,7 +135,7 @@ public extension ParseUser {`
`135`	`135`	`}`
`136`	`136`	`}`
`137`	`137`
`138`		`- // MARK: Fetchable - Combine`
	`138`	`+ // MARK: Combine`
`139`	`139`	`/**`
`140`	`140`	Fetches the `ParseUser` aynchronously with the current data from the server and sets an error if one occurs.
`141`	`141`	`Publishes when complete.`
`@@ -157,7 +157,6 @@ public extension ParseUser {`
`157`	`157`	`}`
`158`	`158`	`}`
`159`	`159`
`160`		`- // MARK: Savable - Combine`
`161`	`160`	`/**`
`162`	`161`	Saves the `ParseUser` asynchronously and publishes when complete.
`163`	`162`
`@@ -186,7 +185,6 @@ public extension ParseUser {`
`186`	`185`	`}`
`187`	`186`	`}`
`188`	`187`
`189`		`- // MARK: Deletable - Combine`
`190`	`188`	`/**`
`191`	`189`	Deletes the `ParseUser` asynchronously and publishes when complete.
`192`	`190`