feat: Attempt to retreive full objects on server during POST

Author: cbaker6

CHANGELOG.md

@@ -2,9 +2,16 @@
 # Parse-Swift Changelog
 
 ### main
-[Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/5.12.1...main), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/main/documentation/parseswift)
+[Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/5.12.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.12.2
+[Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/5.12.1...5.12.2), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/5.12.2/documentation/parseswift)
+
+__Fixes__
+* When creating objects, if the server does not return the correct full object, attempt to retrieve it before returning to call-site. ([#197](https://github.com/netreconlab/Parse-Swift/pull/197)), thanks to [Corey Baker](https://github.com/cbaker6).
+* Fixes an issue when using `mergeable` on `ParseInstallation`'s' and properties that are automatically computed such as `appVersion` are not sent to the server. ([#197](https://github.com/netreconlab/Parse-Swift/pull/197)), thanks to [Corey Baker](https://github.com/cbaker6).
+
 ### 5.12.1
 [Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/5.12.0...5.12.1), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/5.12.1/documentation/parseswift)
 

Sources/ParseSwift/API/API+Command.swift

@@ -436,7 +436,27 @@ internal extension API.Command {
         }
         let updatedObject = object
         let mapper = { @Sendable (data) -> V in
-            try ParseCoding.jsonDecoder().decode(CreateResponse.self, from: data).apply(to: updatedObject)
+			do {
+				// Try to decode CreateResponse, if that doesn't work try Pointer
+				let savedObject = try ParseCoding.jsonDecoder().decode(
+					CreateResponse.self,
+					from: data
+				).apply(
+					to: updatedObject
+				)
+				return savedObject
+			} catch let originalError {
+				do {
+					let pointer = try ParseCoding.jsonDecoder().decode(
+						Pointer<V>.self,
+						from: data
+					)
+					let fetchedObject = try await pointer.fetch()
+					return fetchedObject
+				} catch {
+					throw originalError
+				}
+			}
         }
         return API.Command<V, V>(method: .POST,
                                  path: try await object.endpoint(.POST),

Sources/ParseSwift/Objects/ParseInstallation.swift

@@ -95,6 +95,25 @@ public extension ParseInstallation {
         "_Installation"
     }
 
+	var mergeable: Self {
+		guard isSaved,
+			originalData == nil else {
+			return self
+		}
+		var object = Self()
+		object.objectId = objectId
+		object.createdAt = createdAt
+		object.badge = badge
+		object.timeZone = timeZone
+		object.appName = appName
+		object.appIdentifier = appIdentifier
+		object.appVersion = appVersion
+		object.parseVersion = parseVersion
+		object.localeIdentifier = localeIdentifier
+		object.originalData = try? ParseCoding.jsonEncoder().encode(self)
+		return object
+	}
+
     var endpoint: API.Endpoint {
         if let objectId = objectId {
             return .installation(objectId: objectId)
@@ -418,7 +437,7 @@ extension ParseInstallation {
             return
         }
         #if !os(Linux) && !os(Android) && !os(Windows)
-        #if TARGET_OS_MACCATALYST
+		#if targetEnvironment(macCatalyst)
         // If using an Xcode new enough to know about Mac Catalyst:
         // Mac Catalyst Apps use a prefix to the bundle ID. This should not be transmitted
         // to Parse Server. Catalyst apps should look like iOS apps otherwise
@@ -754,18 +773,18 @@ extension ParseInstallation {
 				let savedObject = try ParseCoding.jsonDecoder().decode(
 					CreateResponse.self,
 					from: data
-				).apply(to: updatedObject)
-
+				).apply(
+					to: updatedObject
+				)
 				return savedObject
 			} catch let originalError {
 				do {
 					let pointer = try ParseCoding.jsonDecoder().decode(
 						Pointer<Self>.self,
 						from: data
 					)
-					var objectToUpdate = updatedObject
-					objectToUpdate.objectId = pointer.objectId
-					return objectToUpdate
+					let fetchedObject = try await pointer.fetch()
+					return fetchedObject
 				} catch {
 					throw originalError
 				}

Sources/ParseSwift/Objects/ParseUser.swift

@@ -1223,18 +1223,18 @@ extension ParseUser {
 				let savedObject = try ParseCoding.jsonDecoder().decode(
 					CreateResponse.self,
 					from: data
-				).apply(to: updatedUser)
-
+				).apply(
+					to: updatedUser
+				)
 				return savedObject
 			} catch let originalError {
 				do {
 					let pointer = try ParseCoding.jsonDecoder().decode(
 						Pointer<Self>.self,
 						from: data
 					)
-					var objectToUpdate = updatedUser
-					objectToUpdate.objectId = pointer.objectId
-					return objectToUpdate
+					let fetchedObject = try await pointer.fetch()
+					return fetchedObject
 				} catch {
 					throw originalError
 				}

Sources/ParseSwift/ParseConstants.swift

@@ -10,7 +10,7 @@ import Foundation
 
 enum ParseConstants {
     static let sdk = "swift"
-    static let version = "5.12.1"
+    static let version = "5.12.2"
     static let fileManagementDirectory = "parse/"
     static let fileManagementPrivateDocumentsDirectory = "Private Documents/"
     static let fileManagementLibraryDirectory = "Library/"

Tests/ParseSwiftTests/ParseInstallationTests.swift

@@ -483,6 +483,51 @@ class ParseInstallationTests: XCTestCase { // swiftlint:disable:this type_body_l
         XCTAssertEqual(merged, original)
     }
 
+	@MainActor
+	func testMergeableRetainsAutomaticallyComputedProperties() async throws {
+		var original = try await Installation.current()
+		original.objectId = "yolo"
+		original.createdAt = Date()
+		original.updatedAt = Date()
+		original.badge = 10
+		original.deviceToken = "12345"
+		original.channels = ["halo"]
+		original.customKey = "newKey"
+		var acl = ParseACL()
+		acl.publicRead = true
+		original.ACL = acl
+
+		// These properties should not be nil before merge
+		XCTAssertNotNil(original.customKey)
+		XCTAssertNotNil(original.deviceType)
+		XCTAssertNotNil(original.deviceToken)
+		XCTAssertNotNil(original.channels)
+		XCTAssertNotNil(original.installationId)
+		XCTAssertNotNil(original.ACL)
+		XCTAssertNotNil(original.updatedAt)
+
+		let mergeable = original.mergeable
+
+		// These should always remain in the merge
+		XCTAssertEqual(original.badge, mergeable.badge)
+		XCTAssertEqual(original.timeZone, mergeable.timeZone)
+		XCTAssertEqual(original.appName, mergeable.appName)
+		XCTAssertEqual(original.appVersion, mergeable.appVersion)
+		XCTAssertEqual(original.appIdentifier, mergeable.appIdentifier)
+		XCTAssertEqual(original.parseVersion, mergeable.parseVersion)
+		XCTAssertEqual(original.localeIdentifier, mergeable.localeIdentifier)
+		XCTAssertEqual(original.createdAt, mergeable.createdAt)
+
+		// All other properties should be nil
+		XCTAssertNil(mergeable.customKey)
+		XCTAssertNil(mergeable.deviceType)
+		XCTAssertNil(mergeable.deviceToken)
+		XCTAssertNil(mergeable.channels)
+		XCTAssertNil(mergeable.installationId)
+		XCTAssertNil(mergeable.ACL)
+		XCTAssertNil(mergeable.updatedAt)
+	}
+
     @MainActor
     func testMergeDifferentObjectId() async throws {
         var installation = Installation()

Tests/ParseSwiftTests/ParseObjectCustomObjectIdTests.swift

@@ -661,6 +661,36 @@ class ParseObjectCustomObjectIdTests: XCTestCase { // swiftlint:disable:this typ
         }
     }
 
+	func testCreateServerReturnsPointer() async throws {
+		var score = GameScore(points: 10)
+		score.objectId = "yarr"
+
+		var scoreOnServer = try score.toPointer()
+
+		let encoded: Data!
+		do {
+			encoded = try ParseCoding.jsonEncoder().encode(scoreOnServer)
+			// Get dates in correct format from ParseDecoding strategy
+			scoreOnServer = try score.getDecoder().decode(
+				Pointer<GameScore>.self,
+				from: encoded
+			)
+		} catch {
+			XCTFail("Should encode/decode. Error \(error)")
+			return
+		}
+
+		MockURLProtocol.mockRequests { _ in
+			return MockURLResponse(data: encoded, statusCode: 200)
+		}
+		do {
+			let saved = try await score.create()
+			XCTAssertTrue(saved.objectId == scoreOnServer.objectId)
+		} catch {
+			XCTFail(error.localizedDescription)
+		}
+	}
+
     func testSaveNoObjectId() async throws {
         let score = GameScore(points: 10)
         do {
@@ -1276,6 +1306,37 @@ class ParseObjectCustomObjectIdTests: XCTestCase { // swiftlint:disable:this typ
         }
     }
 
+	func testUserCreateServerReturnsPointer() async throws {
+		var user = User()
+		user.objectId = "yarr"
+		user.ACL = nil
+
+		var userOnServer = try user.toPointer()
+
+		let encoded: Data!
+		do {
+			encoded = try ParseCoding.jsonEncoder().encode(userOnServer)
+			// Get dates in correct format from ParseDecoding strategy
+			userOnServer = try user.getDecoder().decode(
+				Pointer<User>.self,
+				from: encoded
+			)
+		} catch {
+			XCTFail("Should encode/decode. Error \(error)")
+			return
+		}
+
+		MockURLProtocol.mockRequests { _ in
+			return MockURLResponse(data: encoded, statusCode: 200)
+		}
+		do {
+			let saved = try await user.create()
+			XCTAssertTrue(saved.objectId == userOnServer.objectId)
+		} catch {
+			XCTFail(error.localizedDescription)
+		}
+	}
+
     func testUserSaveNoObjectId() async throws {
         let score = GameScore(points: 10)
         do {
@@ -1829,6 +1890,37 @@ class ParseObjectCustomObjectIdTests: XCTestCase { // swiftlint:disable:this typ
         }
     }
 
+	func testInstallationCreateServerReturnsPointer() async throws {
+		var installation = Installation()
+		installation.objectId = "yarr"
+		installation.ACL = nil
+
+		var installationOnServer = try installation.toPointer()
+
+		let encoded: Data!
+		do {
+			encoded = try ParseCoding.jsonEncoder().encode(installationOnServer)
+			// Get dates in correct format from ParseDecoding strategy
+			installationOnServer = try installation.getDecoder().decode(
+				Pointer<Installation>.self,
+				from: encoded
+			)
+		} catch {
+			XCTFail("Should encode/decode. Error \(error)")
+			return
+		}
+
+		MockURLProtocol.mockRequests { _ in
+			return MockURLResponse(data: encoded, statusCode: 200)
+		}
+		do {
+			let saved = try await installation.create()
+			XCTAssertTrue(saved.objectId == installationOnServer.objectId)
+		} catch {
+			XCTFail(error.localizedDescription)
+		}
+	}
+
     func testInstallationSaveNoObjectId() async throws {
         let score = GameScore(points: 10)
         do {