fix: ParseFile id creation should be consistent to ensure proper hash…

…ing (#83) * fix: ParseFile id creation should be consistent to ensure proper hashing * nit * uniqueness with data * don't throw circular dependency error on duplicate file * removed unused uniqueFiles property
netreconlab · Mar 17, 2023 · c371d5d · c371d5d
1 parent d1feb04
commit c371d5d
Show file tree

Hide file tree

Showing 13 changed files with 113 additions and 60 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,9 +2,15 @@
 # Parse-Swift Changelog
 
 ### main
-[Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/5.3.1...main), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/main/documentation/parseswift)
+[Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/5.3.2...main), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/main/documentation/parseswift)
 * _Contributing to this repo? Add info about your change here to be included in the next release_
 
+### 5.3.2
+[Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/5.3.1...5.3.2), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/5.3.2/documentation/parseswift)
+
+__Fixes__
+* ParseFile id creation should be consistent to ensure proper hashing ([#83](https://github.com/netreconlab/Parse-Swift/pull/83)), thanks to [Corey Baker](https://github.com/cbaker6).
+
 ### 5.3.1
 [Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/5.3.0...5.3.1), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/5.3.1/documentation/parseswift)
 

diff --git a/Sources/ParseSwift/API/API+Command+async.swift b/Sources/ParseSwift/API/API+Command+async.swift
@@ -17,7 +17,7 @@ internal extension API.Command {
     func prepareURLRequest(options: API.Options,
                            batching: Bool = false,
                            childObjects: [String: PointerType]? = nil,
-                           childFiles: [UUID: ParseFile]? = nil) async -> Result<URLRequest, ParseError> {
+                           childFiles: [String: ParseFile]? = nil) async -> Result<URLRequest, ParseError> {
         await withCheckedContinuation { continuation in
             self.prepareURLRequest(options: options,
                                          batching: batching,
@@ -33,7 +33,7 @@ internal extension API.Command {
                  callbackQueue: DispatchQueue,
                  notificationQueue: DispatchQueue? = nil,
                  childObjects: [String: PointerType]? = nil,
-                 childFiles: [UUID: ParseFile]? = nil,
+                 childFiles: [String: ParseFile]? = nil,
                  allowIntermediateResponses: Bool = false,
                  uploadProgress: ((URLSessionTask, Int64, Int64, Int64) -> Void)? = nil,
                  downloadProgress: ((URLSessionDownloadTask, Int64, Int64, Int64) -> Void)? = nil) async throws -> U {

diff --git a/Sources/ParseSwift/API/API+Command.swift b/Sources/ParseSwift/API/API+Command.swift
@@ -53,7 +53,7 @@ internal extension API {
         func executeStream(options: API.Options,
                            callbackQueue: DispatchQueue,
                            childObjects: [String: PointerType]? = nil,
-                           childFiles: [UUID: ParseFile]? = nil,
+                           childFiles: [String: ParseFile]? = nil,
                            uploadProgress: ((URLSessionTask, Int64, Int64, Int64) -> Void)? = nil,
                            stream: InputStream,
                            completion: @escaping (ParseError?) -> Void) {
@@ -94,7 +94,7 @@ internal extension API {
                      callbackQueue: DispatchQueue,
                      notificationQueue: DispatchQueue? = nil,
                      childObjects: [String: PointerType]? = nil,
-                     childFiles: [UUID: ParseFile]? = nil,
+                     childFiles: [String: ParseFile]? = nil,
                      allowIntermediateResponses: Bool = false,
                      uploadProgress: ((URLSessionTask, Int64, Int64, Int64) -> Void)? = nil,
                      downloadProgress: ((URLSessionDownloadTask, Int64, Int64, Int64) -> Void)? = nil,
@@ -252,7 +252,7 @@ internal extension API {
         func prepareURLRequest(options: API.Options,
                                batching: Bool = false,
                                childObjects: [String: PointerType]? = nil,
-                               childFiles: [UUID: ParseFile]? = nil,
+                               childFiles: [String: ParseFile]? = nil,
                                completion: @escaping(Result<URLRequest, ParseError>) -> Void) {
             let params = self.params?.getURLQueryItems()
             Task {

diff --git a/Sources/ParseSwift/API/API+NonParseBodyCommand.swift b/Sources/ParseSwift/API/API+NonParseBodyCommand.swift
@@ -168,7 +168,7 @@ internal extension API.NonParseBodyCommand {
                       transaction: Bool,
                       objectsSavedBeforeThisOne: [String: PointerType]?,
                       // swiftlint:disable:next line_length
-                      filesSavedBeforeThisOne: [UUID: ParseFile]?) async throws -> RESTBatchCommandTypeEncodablePointer<AnyCodable> {
+                      filesSavedBeforeThisOne: [String: ParseFile]?) async throws -> RESTBatchCommandTypeEncodablePointer<AnyCodable> {
         let defaultACL = try? await ParseACL.defaultACL()
         let batchCommands = try objects.compactMap { (object) -> API.BatchCommand<AnyCodable, PointerType>? in
             guard var objectable = object as? Objectable else {

diff --git a/Sources/ParseSwift/Coding/ParseEncoder.swift b/Sources/ParseSwift/Coding/ParseEncoder.swift
@@ -110,7 +110,7 @@ public struct ParseEncoder {
                 acl: ParseACL? = nil,
                 batching: Bool = false,
                 objectsSavedBeforeThisOne: [String: PointerType]? = nil,
-                filesSavedBeforeThisOne: [UUID: ParseFile]? = nil) throws -> Data {
+                filesSavedBeforeThisOne: [String: ParseFile]? = nil) throws -> Data {
         var keysToSkip = SkipKeys.none.keys()
         if batching {
             keysToSkip = SkipKeys.object.keys()
@@ -159,9 +159,9 @@ public struct ParseEncoder {
                                          acl: ParseACL? = nil,
                                          collectChildren: Bool,
                                          objectsSavedBeforeThisOne: [String: PointerType]?,
-                                         filesSavedBeforeThisOne: [UUID: ParseFile]?) throws -> (encoded: Data,
-                                                                                                 unique: PointerType?,
-                                                                                                 unsavedChildren: [Encodable]) {
+                                         filesSavedBeforeThisOne: [String: ParseFile]?) throws -> (encoded: Data,
+                                                                                                   unique: PointerType?,
+                                                                                                   unsavedChildren: [Encodable]) {
         let keysToSkip: Set<String>!
         if !Parse.configuration.isRequiringCustomObjectIds {
             keysToSkip = SkipKeys.object.keys()
@@ -188,7 +188,7 @@ public struct ParseEncoder {
                          batching: Bool,
                          collectChildren: Bool,
                          objectsSavedBeforeThisOne: [String: PointerType]?,
-                         filesSavedBeforeThisOne: [UUID: ParseFile]?) throws -> (encoded: Data, unique: PointerType?, unsavedChildren: [Encodable]) {
+                         filesSavedBeforeThisOne: [String: ParseFile]?) throws -> (encoded: Data, unique: PointerType?, unsavedChildren: [Encodable]) {
         let keysToSkip: Set<String>!
         if !Parse.configuration.isRequiringCustomObjectIds {
             keysToSkip = SkipKeys.object.keys()
@@ -218,12 +218,11 @@ internal class _ParseEncoder: JSONEncoder, Encoder {
     let dictionary: NSMutableDictionary
     let skippedKeys: Set<String>
     var uniquePointer: PointerType?
-    var uniqueFiles = Set<ParseFile>()
     var newObjects = [Encodable]()
     var collectChildren = false
     var batching = false
     var objectsSavedBeforeThisOne: [String: PointerType]?
-    var filesSavedBeforeThisOne: [UUID: ParseFile]?
+    var filesSavedBeforeThisOne: [String: ParseFile]?
     /// The encoder's storage.
     var storage: _ParseEncodingStorage
     var ignoreSkipKeys = false
@@ -280,7 +279,7 @@ internal class _ParseEncoder: JSONEncoder, Encoder {
                       collectChildren: Bool,
                       uniquePointer: PointerType?,
                       objectsSavedBeforeThisOne: [String: PointerType]?,
-                      filesSavedBeforeThisOne: [UUID: ParseFile]?) throws -> (encoded: Data, unique: PointerType?, unsavedChildren: [Encodable]) {
+                      filesSavedBeforeThisOne: [String: ParseFile]?) throws -> (encoded: Data, unique: PointerType?, unsavedChildren: [Encodable]) {
         self.acl = acl
         let encoder = _ParseEncoder(codingPath: codingPath, dictionary: dictionary, skippingKeys: skippedKeys)
         encoder.outputFormatting = outputFormatting
@@ -364,7 +363,7 @@ internal class _ParseEncoder: JSONEncoder, Encoder {
             if let uniquePointer = self.uniquePointer,
                uniquePointer.hasSameObjectId(as: pointer) {
                 throw ParseError(code: .otherCause,
-                                 message: "Found a circular dependency when encoding.")
+                                 message: "Found a circular dependency when encoding objects. The object: \(pointer) cannot have the same objectId as: \(uniquePointer)")
             }
             valueToEncode = pointer
         } else if let object = value as? Objectable {
@@ -373,7 +372,7 @@ internal class _ParseEncoder: JSONEncoder, Encoder {
                 if let uniquePointer = self.uniquePointer,
                    uniquePointer.hasSameObjectId(as: pointer) {
                     throw ParseError(code: .otherCause,
-                                     message: "Found a circular dependency when encoding.")
+                                     message: "Found a circular dependency when encoding objects. The object: \(pointer) cannot have the same objectId as: \(uniquePointer)")
                 }
                 valueToEncode = pointer
             } else {
@@ -401,10 +400,6 @@ internal class _ParseEncoder: JSONEncoder, Encoder {
     func deepFindAndReplaceParseFiles(_ value: ParseFile) throws -> Encodable? {
         var valueToEncode: Encodable?
         if value.isSaved {
-            if self.uniqueFiles.contains(value) {
-                throw ParseError(code: .otherCause, message: "Found a circular dependency when encoding.")
-            }
-            self.uniqueFiles.insert(value)
             if !self.collectChildren {
                 valueToEncode = value
             }
@@ -413,13 +408,12 @@ internal class _ParseEncoder: JSONEncoder, Encoder {
                 if let updatedFile = self.filesSavedBeforeThisOne?[value.id] {
                     valueToEncode = updatedFile
                 } else {
-                    // New object needs to be saved before it can be stored
+                    // New file needs to be saved before it can be stored
                     self.newObjects.append(value)
                 }
             } else if let currentFile = self.filesSavedBeforeThisOne?[value.id] {
                 valueToEncode = currentFile
             } else if dictionary.count > 0 {
-                // Only top level objects can be saved without a pointer
                 throw ParseError(code: .otherCause, message: "Error. Could not resolve unsaved file while encoding.")
             }
         }
@@ -1035,7 +1029,7 @@ private class _ParseReferencingEncoder: _ParseEncoder {
     // MARK: - Initialization
 
     /// Initializes `self` by referencing the given array container in the given encoder.
-    init(referencing encoder: _ParseEncoder, at index: Int, wrapping array: NSMutableArray, skippingKeys: Set<String>, collectChildren: Bool, objectsSavedBeforeThisOne: [String: PointerType]?, filesSavedBeforeThisOne: [UUID: ParseFile]?) {
+    init(referencing encoder: _ParseEncoder, at index: Int, wrapping array: NSMutableArray, skippingKeys: Set<String>, collectChildren: Bool, objectsSavedBeforeThisOne: [String: PointerType]?, filesSavedBeforeThisOne: [String: ParseFile]?) {
         self.encoder = encoder
         self.reference = .array(array, index)
         super.init(codingPath: encoder.codingPath, dictionary: NSMutableDictionary(), skippingKeys: skippingKeys)
@@ -1046,7 +1040,7 @@ private class _ParseReferencingEncoder: _ParseEncoder {
     }
 
     /// Initializes `self` by referencing the given dictionary container in the given encoder.
-    init(referencing encoder: _ParseEncoder, key: CodingKey, wrapping dictionary: NSMutableDictionary, skippingKeys: Set<String>, collectChildren: Bool, objectsSavedBeforeThisOne: [String: PointerType]?, filesSavedBeforeThisOne: [UUID: ParseFile]?) {
+    init(referencing encoder: _ParseEncoder, key: CodingKey, wrapping dictionary: NSMutableDictionary, skippingKeys: Set<String>, collectChildren: Bool, objectsSavedBeforeThisOne: [String: PointerType]?, filesSavedBeforeThisOne: [String: ParseFile]?) {
         self.encoder = encoder
         self.reference = .dictionary(dictionary, key.stringValue)
         super.init(codingPath: encoder.codingPath, dictionary: dictionary, skippingKeys: skippingKeys)

diff --git a/Sources/ParseSwift/Objects/ParseInstallation+async.swift b/Sources/ParseSwift/Objects/ParseInstallation+async.swift
@@ -372,7 +372,7 @@ internal extension Sequence where Element: ParseInstallation {
         var options = options
         options.insert(.cachePolicy(.reloadIgnoringLocalCacheData))
         var childObjects = [String: PointerType]()
-        var childFiles = [UUID: ParseFile]()
+        var childFiles = [String: ParseFile]()
         var commands = [API.Command<Self.Element, Self.Element>]()
         let objects = map { $0 }
         for object in objects {
@@ -381,13 +381,15 @@ internal extension Sequence where Element: ParseInstallation {
                                 isShouldReturnIfChildObjectsFound: transaction)
             try savedChildObjects.forEach {(key, value) in
                 guard childObjects[key] == nil else {
-                    throw ParseError(code: .otherCause, message: "circular dependency")
+                    throw ParseError(code: .otherCause,
+                                     message: "Found a circular dependency in ParseInstallation.")
                 }
                 childObjects[key] = value
             }
             try savedChildFiles.forEach {(key, value) in
                 guard childFiles[key] == nil else {
-                    throw ParseError(code: .otherCause, message: "circular dependency")
+                    throw ParseError(code: .otherCause,
+                                     message: "Found a circular dependency in ParseInstallation.")
                 }
                 childFiles[key] = value
             }

diff --git a/Sources/ParseSwift/Objects/ParseObject+async.swift b/Sources/ParseSwift/Objects/ParseObject+async.swift
@@ -294,15 +294,15 @@ internal extension ParseObject {
     // swiftlint:disable:next function_body_length
     func ensureDeepSave(options: API.Options = [],
                         isShouldReturnIfChildObjectsFound: Bool = false) async throws -> ([String: PointerType],
-                                                                                          [UUID: ParseFile]) {
+                                                                                          [String: ParseFile]) {
 
         var options = options
         // Remove any caching policy added by the developer as fresh data
         // from the server is needed.
         options.remove(.cachePolicy(.reloadIgnoringLocalCacheData))
         options.insert(.cachePolicy(.reloadIgnoringLocalCacheData))
         var objectsFinishedSaving = [String: PointerType]()
-        var filesFinishedSaving = [UUID: ParseFile]()
+        var filesFinishedSaving = [String: ParseFile]()
         let defaultACL = try? await ParseACL.defaultACL()
         do {
             let object = try ParseCoding.parseEncoder()
@@ -414,7 +414,7 @@ internal extension Sequence where Element: ParseObject {
         var options = options
         options.insert(.cachePolicy(.reloadIgnoringLocalCacheData))
         var childObjects = [String: PointerType]()
-        var childFiles = [UUID: ParseFile]()
+        var childFiles = [String: ParseFile]()
         var commands = [API.Command<Self.Element, Self.Element>]()
         let objects = map { $0 }
         for object in objects {
@@ -423,13 +423,15 @@ internal extension Sequence where Element: ParseObject {
                                 isShouldReturnIfChildObjectsFound: transaction)
             try savedChildObjects.forEach {(key, value) in
                 guard childObjects[key] == nil else {
-                    throw ParseError(code: .otherCause, message: "circular dependency")
+                    throw ParseError(code: .otherCause,
+                                     message: "Found a circular dependency in ParseObject.")
                 }
                 childObjects[key] = value
             }
             try savedChildFiles.forEach {(key, value) in
                 guard childFiles[key] == nil else {
-                    throw ParseError(code: .otherCause, message: "circular dependency")
+                    throw ParseError(code: .otherCause,
+                                     message: "Found a circular dependency in ParseObject.")
                 }
                 childFiles[key] = value
             }
@@ -478,7 +480,7 @@ internal extension ParseEncodable {
     func saveAll(objects: [ParseEncodable],
                  transaction: Bool = configuration.isUsingTransactions,
                  objectsSavedBeforeThisOne: [String: PointerType]?,
-                 filesSavedBeforeThisOne: [UUID: ParseFile]?,
+                 filesSavedBeforeThisOne: [String: ParseFile]?,
                  options: API.Options = [],
                  callbackQueue: DispatchQueue = .main) async throws -> [(Result<PointerType, ParseError>)] {
         try await API.NonParseBodyCommand<AnyCodable, PointerType>

diff --git a/Sources/ParseSwift/Objects/ParseObject.swift b/Sources/ParseSwift/Objects/ParseObject.swift
@@ -167,9 +167,10 @@ public extension ParseObject {
     }
 
     /**
-     A computed property that is the same value as `objectId` and makes it easy to use `ParseObject`'s
+     A computed property that is a unique identifier and makes it easy to use `ParseObject`'s
      as models in MVVM and SwiftUI.
-     - note: `id` allows `ParseObjects`'s to be used even when they are unsaved and do not have an `objectId`.
+     - note: `id` allows `ParseObject`'s to be used even when they are not saved and do not have an `objectId`.
+     - important: `id` will have the same value as `objectId` when a `ParseObject` is saved.
     */
     var id: String {
         objectId ?? UUID().uuidString

diff --git a/Sources/ParseSwift/Objects/ParseUser+async.swift b/Sources/ParseSwift/Objects/ParseUser+async.swift
@@ -603,7 +603,7 @@ internal extension Sequence where Element: ParseUser {
         var options = options
         options.insert(.cachePolicy(.reloadIgnoringLocalCacheData))
         var childObjects = [String: PointerType]()
-        var childFiles = [UUID: ParseFile]()
+        var childFiles = [String: ParseFile]()
         var commands = [API.Command<Self.Element, Self.Element>]()
         let objects = map { $0 }
         for object in objects {
@@ -612,13 +612,15 @@ internal extension Sequence where Element: ParseUser {
                                 isShouldReturnIfChildObjectsFound: transaction)
             try savedChildObjects.forEach {(key, value) in
                 guard childObjects[key] == nil else {
-                    throw ParseError(code: .otherCause, message: "circular dependency")
+                    throw ParseError(code: .otherCause,
+                                     message: "Found a circular dependency in ParseUser.")
                 }
                 childObjects[key] = value
             }
             try savedChildFiles.forEach {(key, value) in
                 guard childFiles[key] == nil else {
-                    throw ParseError(code: .otherCause, message: "circular dependency")
+                    throw ParseError(code: .otherCause,
+                                     message: "Found a circular dependency in ParseUser.")
                 }
                 childFiles[key] = value
             }

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 = "5.3.1"
+    static let version = "5.3.2"
     static let fileManagementDirectory = "parse/"
     static let fileManagementPrivateDocumentsDirectory = "Private Documents/"
     static let fileManagementLibraryDirectory = "Library/"