fix: Prevent crash when the SDK has not been initialized (#95)

cbaker6 · web-flow · commit a746db0bf4e9 · 2023-05-01T12:13:41.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,10 +2,14 @@
 # Parse-Swift Changelog
 
 ### main
-[Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/5.4.1...main), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/main/documentation/parseswift)
+[Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/5.4.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.4.2
+[Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/5.4.1...5.4.2), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/5.4.2/documentation/parseswift)
+
 __Fixes__
+* Prevent crash when the developer makes query, fetch, etc. calls before the SDK is properly initialized ([#95](https://github.com/netreconlab/Parse-Swift/pull/95)), thanks to [Corey Baker](https://github.com/cbaker6).
 * Add backwards compatability to Xcode 13.2. Building on Xcode <13.3 only works for SPM ([#92](https://github.com/netreconlab/Parse-Swift/pull/92)), thanks to [Corey Baker](https://github.com/cbaker6).
 
 ### 5.4.1
diff --git a/Sources/ParseSwift/API/API+Command.swift b/Sources/ParseSwift/API/API+Command.swift
@@ -409,15 +409,15 @@ internal extension API.Command {
             && object.objectId == nil && !ignoringCustomObjectIdConfig {
             throw ParseError(code: .missingObjectId, message: "objectId must not be nil")
         }
-        if object.isSaved {
+        if try await object.isSaved() {
             // MARK: Should be switched to "update" when server supports PATCH.
             return try replace(object,
                                original: data)
         }
-        return await create(object)
+        return try await create(object)
     }
 
-    static func create<T>(_ object: T) async -> API.Command<T, T> where T: ParseObject {
+    static func create<T>(_ object: T) async throws -> API.Command<T, T> where T: ParseObject {
         var object = object
         if object.ACL == nil,
             let acl = try? await ParseACL.defaultACL() {
@@ -427,7 +427,7 @@ internal extension API.Command {
             try ParseCoding.jsonDecoder().decode(CreateResponse.self, from: data).apply(to: object)
         }
         return API.Command<T, T>(method: .POST,
-                                 path: object.endpoint(.POST),
+                                 path: try await object.endpoint(.POST),
                                  body: object,
                                  mapper: mapper)
     }
diff --git a/Sources/ParseSwift/API/API+NonParseBodyCommand.swift b/Sources/ParseSwift/API/API+NonParseBodyCommand.swift
@@ -169,6 +169,7 @@ internal extension API.NonParseBodyCommand {
                       objectsSavedBeforeThisOne: [String: PointerType]?,
                       // swiftlint:disable:next line_length
                       filesSavedBeforeThisOne: [String: ParseFile]?) async throws -> RESTBatchCommandTypeEncodablePointer<AnyCodable> {
+        try await yieldIfNotInitialized()
         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/Objects/ParseInstallation+async.swift b/Sources/ParseSwift/Objects/ParseInstallation+async.swift
@@ -341,7 +341,7 @@ internal extension ParseInstallation {
             case .save:
                 command = try await self.saveCommand(ignoringCustomObjectIdConfig: ignoringCustomObjectIdConfig)
             case .create:
-                command = await self.createCommand()
+                command = try await self.createCommand()
             case .replace:
                 command = try self.replaceCommand()
             case .update:
@@ -400,7 +400,7 @@ internal extension Sequence where Element: ParseInstallation {
                         try await object.saveCommand(ignoringCustomObjectIdConfig: ignoringCustomObjectIdConfig)
                     )
                 case .create:
-                    commands.append(await object.createCommand())
+                    commands.append(try await object.createCommand())
                 case .replace:
                     commands.append(try object.replaceCommand())
                 case .update:
diff --git a/Sources/ParseSwift/Objects/ParseInstallation.swift b/Sources/ParseSwift/Objects/ParseInstallation.swift
@@ -172,7 +172,8 @@ public extension ParseInstallation {
 // MARK: Convenience
 extension ParseInstallation {
 
-    func endpoint(_ method: API.Method) -> API.Endpoint {
+    func endpoint(_ method: API.Method) async throws -> API.Endpoint {
+        try await yieldIfNotInitialized()
         if !Parse.configuration.isRequiringCustomObjectIds || method != .POST {
             return endpoint
         } else {
@@ -727,17 +728,19 @@ extension ParseInstallation {
     }
 
     func saveCommand(ignoringCustomObjectIdConfig: Bool = false) async throws -> API.Command<Self, Self> {
+        try await yieldIfNotInitialized()
         if Parse.configuration.isRequiringCustomObjectIds && objectId == nil && !ignoringCustomObjectIdConfig {
             throw ParseError(code: .missingObjectId, message: "objectId must not be nil")
         }
-        if isSaved {
+        if try await isSaved() {
             return try replaceCommand() // MARK: Should be switched to "updateCommand" when server supports PATCH.
         }
-        return await createCommand()
+        return try await createCommand()
     }
 
     // MARK: Saving ParseObjects - private
-    func createCommand() async -> API.Command<Self, Self> {
+    func createCommand() async throws -> API.Command<Self, Self> {
+        try await yieldIfNotInitialized()
         var object = self
         if object.ACL == nil,
             let acl = try? await ParseACL.defaultACL() {
@@ -747,7 +750,7 @@ extension ParseInstallation {
             try ParseCoding.jsonDecoder().decode(CreateResponse.self, from: data).apply(to: object)
         }
         return API.Command<Self, Self>(method: .POST,
-                                       path: endpoint(.POST),
+                                       path: try await endpoint(.POST),
                                        body: object,
                                        mapper: mapper)
     }
@@ -854,8 +857,8 @@ extension ParseInstallation {
         }
     }
 
-    func deleteCommand() throws -> API.NonParseBodyCommand<NoBody, NoBody> {
-        guard isSaved else {
+    func deleteCommand() async throws -> API.NonParseBodyCommand<NoBody, NoBody> {
+        guard try await isSaved() else {
             throw ParseError(code: .otherCause, message: "Cannot Delete an object without id")
         }
 
diff --git a/Sources/ParseSwift/Objects/ParseObject+async.swift b/Sources/ParseSwift/Objects/ParseObject+async.swift
@@ -385,7 +385,7 @@ or disable transactions for this call.
             case .save:
                 command = try await self.saveCommand(ignoringCustomObjectIdConfig: ignoringCustomObjectIdConfig)
             case .create:
-                command = await self.createCommand()
+                command = try await self.createCommand()
             case .replace:
                 command = try self.replaceCommand()
             case .update:
@@ -442,7 +442,7 @@ internal extension Sequence where Element: ParseObject {
                         try await object.saveCommand(ignoringCustomObjectIdConfig: ignoringCustomObjectIdConfig)
                     )
                 case .create:
-                    commands.append(await object.createCommand())
+                    commands.append(try await object.createCommand())
                 case .replace:
                     commands.append(try object.replaceCommand())
                 case .update:
diff --git a/Sources/ParseSwift/Objects/ParseObject.swift b/Sources/ParseSwift/Objects/ParseObject.swift
@@ -909,8 +909,8 @@ extension ParseObject {
                                                ignoringCustomObjectIdConfig: ignoringCustomObjectIdConfig)
     }
 
-    internal func createCommand() async -> API.Command<Self, Self> {
-        await API.Command<Self, Self>.create(self)
+    internal func createCommand() async throws -> API.Command<Self, Self> {
+        try await API.Command<Self, Self>.create(self)
     }
 
     internal func replaceCommand() throws -> API.Command<Self, Self> {
diff --git a/Sources/ParseSwift/Objects/ParseUser+async.swift b/Sources/ParseSwift/Objects/ParseUser+async.swift
@@ -572,7 +572,7 @@ internal extension ParseUser {
             case .save:
                 command = try await self.saveCommand(ignoringCustomObjectIdConfig: ignoringCustomObjectIdConfig)
             case .create:
-                command = await self.createCommand()
+                command = try await self.createCommand()
             case .replace:
                 command = try await self.replaceCommand()
             case .update:
@@ -631,7 +631,7 @@ internal extension Sequence where Element: ParseUser {
                         try await object.saveCommand(ignoringCustomObjectIdConfig: ignoringCustomObjectIdConfig)
                     )
                 case .create:
-                    commands.append(await object.createCommand())
+                    commands.append(try await object.createCommand())
                 case .replace:
                     commands.append(try await object.replaceCommand())
                 case .update:
diff --git a/Sources/ParseSwift/Objects/ParseUser.swift b/Sources/ParseSwift/Objects/ParseUser.swift
@@ -102,7 +102,8 @@ public extension ParseUser {
 // MARK: Convenience
 extension ParseUser {
 
-    func endpoint(_ method: API.Method) -> API.Endpoint {
+    func endpoint(_ method: API.Method) async throws -> API.Endpoint {
+        try await yieldIfNotInitialized()
         if !Parse.configuration.isRequiringCustomObjectIds || method != .POST {
             return endpoint
         } else {
@@ -1079,17 +1080,18 @@ extension ParseUser {
     }
 
     func saveCommand(ignoringCustomObjectIdConfig: Bool = false) async throws -> API.Command<Self, Self> {
+        try await yieldIfNotInitialized()
         if Parse.configuration.isRequiringCustomObjectIds && objectId == nil && !ignoringCustomObjectIdConfig {
             throw ParseError(code: .missingObjectId, message: "objectId must not be nil")
         }
         if isSaved {
             return try await replaceCommand() // MARK: Should be switched to "updateCommand" when server supports PATCH.
         }
-        return await createCommand()
+        return try await createCommand()
     }
 
     // MARK: Saving ParseObjects - private
-    func createCommand() async -> API.Command<Self, Self> {
+    func createCommand() async throws -> API.Command<Self, Self> {
         var object = self
         if object.ACL == nil,
             let acl = try? await ParseACL.defaultACL() {
@@ -1099,7 +1101,7 @@ extension ParseUser {
             try ParseCoding.jsonDecoder().decode(CreateResponse.self, from: data).apply(to: object)
         }
         return API.Command<Self, Self>(method: .POST,
-                                       path: endpoint(.POST),
+                                       path: try await endpoint(.POST),
                                        body: object,
                                        mapper: mapper)
     }
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.4.1"
+    static let version = "5.4.2"
     static let fileManagementDirectory = "parse/"
     static let fileManagementPrivateDocumentsDirectory = "Private Documents/"
     static let fileManagementLibraryDirectory = "Library/"
diff --git a/Sources/ParseSwift/Protocols/Objectable.swift b/Sources/ParseSwift/Protocols/Objectable.swift
@@ -80,6 +80,8 @@ extension Objectable {
     }
 
     /// Specifies if a `ParseObject` has been saved.
+    /// - warning: This will not be available in ParseSwift 6.0.0. Use `isSaved()` instead.
+    /// BAKER mark this internal.
     public var isSaved: Bool {
         if !Parse.configuration.isRequiringCustomObjectIds {
             return objectId != nil
@@ -88,11 +90,22 @@ extension Objectable {
         }
     }
 
+    /// Specifies if a `ParseObject` has been saved.
+    public func isSaved() async throws -> Bool {
+        try await yieldIfNotInitialized()
+        if !Parse.configuration.isRequiringCustomObjectIds {
+            return objectId != nil
+        } else {
+            return objectId != nil && createdAt != nil
+        }
+    }
+
     func toPointer() throws -> PointerType {
         return try PointerType(self)
     }
 
-    func endpoint(_ method: API.Method) -> API.Endpoint {
+    func endpoint(_ method: API.Method) async throws -> API.Endpoint {
+        try await yieldIfNotInitialized()
         if !Parse.configuration.isRequiringCustomObjectIds || method != .POST {
             return endpoint
         } else {
diff --git a/Sources/ParseSwift/Types/ParseFile.swift b/Sources/ParseSwift/Types/ParseFile.swift
@@ -193,7 +193,8 @@ extension ParseFile {
         return options
     }
 
-    func checkDownloadsForFile(options: API.Options) throws -> ParseFile? {
+    func checkDownloadsForFile(options: API.Options) async throws -> ParseFile? {
+        try await yieldIfNotInitialized()
         var cachePolicy: URLRequest.CachePolicy = Parse.configuration.requestCachePolicy
         var shouldBreak = false
         for option in options {
@@ -481,23 +482,23 @@ extension ParseFile {
                       progress: ((URLSessionDownloadTask, Int64, Int64, Int64) -> Void)? = nil,
                       completion: @escaping (Result<Self, ParseError>) -> Void) {
         let options = setDefaultOptions(options)
-        do {
-            guard let file = try checkDownloadsForFile(options: options) else {
-                throw ParseError(code: .unsavedFileFailure,
-                                 message: "File not downloaded")
-            }
-            callbackQueue.async {
-                completion(.success(file))
-            }
-        } catch {
-            let parseError = error as? ParseError ?? ParseError(swift: error)
-            guard parseError.code != .unsavedFileFailure else {
+        Task {
+            do {
+                guard let file = try await checkDownloadsForFile(options: options) else {
+                    throw ParseError(code: .unsavedFileFailure,
+                                     message: "File not downloaded")
+                }
                 callbackQueue.async {
-                    completion(.failure(parseError))
+                    completion(.success(file))
+                }
+            } catch {
+                let parseError = error as? ParseError ?? ParseError(swift: error)
+                guard parseError.code != .unsavedFileFailure else {
+                    callbackQueue.async {
+                        completion(.failure(parseError))
+                    }
+                    return
                 }
-                return
-            }
-            Task {
                 await downloadFileCommand()
                     .execute(options: options,
                              callbackQueue: callbackQueue,
diff --git a/Sources/ParseSwift/Types/Query.swift b/Sources/ParseSwift/Types/Query.swift
diff --git a/Tests/ParseSwiftTests/ParseInstallationTests.swift b/Tests/ParseSwiftTests/ParseInstallationTests.swift
diff --git a/Tests/ParseSwiftTests/ParseObjectTests.swift b/Tests/ParseSwiftTests/ParseObjectTests.swift
diff --git a/Tests/ParseSwiftTests/ParseQueryTests.swift b/Tests/ParseSwiftTests/ParseQueryTests.swift
diff --git a/Tests/ParseSwiftTests/ParseSessionTests.swift b/Tests/ParseSwiftTests/ParseSessionTests.swift
diff --git a/Tests/ParseSwiftTests/ParseUserTests.swift b/Tests/ParseSwiftTests/ParseUserTests.swift

Original file line number	Diff line number	Diff line change
`@@ -409,15 +409,15 @@ internal extension API.Command {`
`409`	`409`	`&& object.objectId == nil && !ignoringCustomObjectIdConfig {`
`410`	`410`	`throw ParseError(code: .missingObjectId, message: "objectId must not be nil")`
`411`	`411`	`}`
`412`		`- if object.isSaved {`
	`412`	`+ if try await object.isSaved() {`
`413`	`413`	`// MARK: Should be switched to "update" when server supports PATCH.`
`414`	`414`	`return try replace(object,`
`415`	`415`	`original: data)`
`416`	`416`	`}`
`417`		`- return await create(object)`
	`417`	`+ return try await create(object)`
`418`	`418`	`}`
`419`	`419`
`420`		`- static func create<T>(_ object: T) async -> API.Command<T, T> where T: ParseObject {`
	`420`	`+ static func create<T>(_ object: T) async throws -> API.Command<T, T> where T: ParseObject {`
`421`	`421`	`var object = object`
`422`	`422`	`if object.ACL == nil,`
`423`	`423`	`let acl = try? await ParseACL.defaultACL() {`
`@@ -427,7 +427,7 @@ internal extension API.Command {`
`427`	`427`	`try ParseCoding.jsonDecoder().decode(CreateResponse.self, from: data).apply(to: object)`
`428`	`428`	`}`
`429`	`429`	`return API.Command<T, T>(method: .POST,`
`430`		`- path: object.endpoint(.POST),`
	`430`	`+ path: try await object.endpoint(.POST),`
`431`	`431`	`body: object,`
`432`	`432`	`mapper: mapper)`
`433`	`433`	`}`
Original file line number	Diff line number	Diff line change
`@@ -172,7 +172,8 @@ public extension ParseInstallation {`
`172`	`172`	`// MARK: Convenience`
`173`	`173`	`extension ParseInstallation {`
`174`	`174`
`175`		`- func endpoint(_ method: API.Method) -> API.Endpoint {`
	`175`	`+ func endpoint(_ method: API.Method) async throws -> API.Endpoint {`
	`176`	`+ try await yieldIfNotInitialized()`
`176`	`177`	`if !Parse.configuration.isRequiringCustomObjectIds \|\| method != .POST {`
`177`	`178`	`return endpoint`
`178`	`179`	`} else {`
`@@ -727,17 +728,19 @@ extension ParseInstallation {`
`727`	`728`	`}`
`728`	`729`
`729`	`730`	`func saveCommand(ignoringCustomObjectIdConfig: Bool = false) async throws -> API.Command<Self, Self> {`
	`731`	`+ try await yieldIfNotInitialized()`
`730`	`732`	`if Parse.configuration.isRequiringCustomObjectIds && objectId == nil && !ignoringCustomObjectIdConfig {`
`731`	`733`	`throw ParseError(code: .missingObjectId, message: "objectId must not be nil")`
`732`	`734`	`}`
`733`		`- if isSaved {`
	`735`	`+ if try await isSaved() {`
`734`	`736`	`return try replaceCommand() // MARK: Should be switched to "updateCommand" when server supports PATCH.`
`735`	`737`	`}`
`736`		`- return await createCommand()`
	`738`	`+ return try await createCommand()`
`737`	`739`	`}`
`738`	`740`
`739`	`741`	`// MARK: Saving ParseObjects - private`
`740`		`- func createCommand() async -> API.Command<Self, Self> {`
	`742`	`+ func createCommand() async throws -> API.Command<Self, Self> {`
	`743`	`+ try await yieldIfNotInitialized()`
`741`	`744`	`var object = self`
`742`	`745`	`if object.ACL == nil,`
`743`	`746`	`let acl = try? await ParseACL.defaultACL() {`
`@@ -747,7 +750,7 @@ extension ParseInstallation {`
`747`	`750`	`try ParseCoding.jsonDecoder().decode(CreateResponse.self, from: data).apply(to: object)`
`748`	`751`	`}`
`749`	`752`	`return API.Command<Self, Self>(method: .POST,`
`750`		`- path: endpoint(.POST),`
	`753`	`+ path: try await endpoint(.POST),`
`751`	`754`	`body: object,`
`752`	`755`	`mapper: mapper)`
`753`	`756`	`}`
`@@ -854,8 +857,8 @@ extension ParseInstallation {`
`854`	`857`	`}`
`855`	`858`	`}`
`856`	`859`
`857`		`- func deleteCommand() throws -> API.NonParseBodyCommand<NoBody, NoBody> {`
`858`		`- guard isSaved else {`
	`860`	`+ func deleteCommand() async throws -> API.NonParseBodyCommand<NoBody, NoBody> {`
	`861`	`+ guard try await isSaved() else {`
`859`	`862`	`throw ParseError(code: .otherCause, message: "Cannot Delete an object without id")`
`860`	`863`	`}`
`861`	`864`
Original file line number	Diff line number	Diff line change
`@@ -909,8 +909,8 @@ extension ParseObject {`
`909`	`909`	`ignoringCustomObjectIdConfig: ignoringCustomObjectIdConfig)`
`910`	`910`	`}`
`911`	`911`
`912`		`- internal func createCommand() async -> API.Command<Self, Self> {`
`913`		`- await API.Command<Self, Self>.create(self)`
	`912`	`+ internal func createCommand() async throws -> API.Command<Self, Self> {`
	`913`	`+ try await API.Command<Self, Self>.create(self)`
`914`	`914`	`}`
`915`	`915`
`916`	`916`	`internal func replaceCommand() throws -> API.Command<Self, Self> {`