feat: View models now update on the MainActor (#76)

cbaker6 · web-flow · commit 8140c4d107e5 · 2023-03-13T12:20:22.000-04:00
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.1.1...main), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/main/documentation/parseswift)
+[Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/5.2.0...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.2.0
+[Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/5.1.1...5.2.0), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/5.2.0/documentation/parseswift)
+
+__New features__
+* All Parse-Swift view models now update on the MainActor to make view changes more predictable ([#75](https://github.com/netreconlab/Parse-Swift/pull/75)), thanks to [Corey Baker](https://github.com/cbaker6).
+
 ### 5.1.1
 [Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/5.1.0...5.1.1), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/5.1.1/documentation/parseswift)
 
diff --git a/ParseSwift.playground/Pages/17 - SwiftUI - Finding Objects.xcplaygroundpage/Contents.swift b/ParseSwift.playground/Pages/17 - SwiftUI - Finding Objects.xcplaygroundpage/Contents.swift
@@ -95,6 +95,8 @@ struct ContentView: View {
                 TextField("Name", text: $name)
                 TextField("Points", text: $points)
                 Button(action: {
+                    //: Code below should normally be in a ViewModel
+                    //: This is just a simple example...
                     guard let pointsValue = Int(points),
                           let linkToFile = URL(string: "https://parseplatform.org/img/logo.svg") else {
                         return
@@ -111,7 +113,9 @@ struct ContentView: View {
                         switch result {
                         case .success:
                             savedLabel = "Saved score"
-                            self.viewModel.find()
+                            Task {
+                                await self.viewModel.find()
+                            }
                         case .failure(let error):
                             savedLabel = "Error: \(error.message)"
                         }
@@ -136,14 +140,14 @@ struct ContentView: View {
                 }
             }
             Spacer()
-        }.onAppear(perform: {
-            viewModel.find()
-        }).alert(isPresented: $isShowingAction, content: {
+        }.task {
+            await viewModel.find()
+        }.alert(isPresented: $isShowingAction) {
             Alert(title: Text("GameScore"),
                   message: Text(savedLabel),
                   dismissButton: .default(Text("Ok"), action: {
             }))
-        })
+        }
     }
 }
 
diff --git a/ParseSwift.playground/Pages/19 - SwiftUI - LiveQuery.xcplaygroundpage/Contents.swift b/ParseSwift.playground/Pages/19 - SwiftUI - LiveQuery.xcplaygroundpage/Contents.swift
@@ -75,9 +75,9 @@ struct ContentView: View {
     var body: some View {
         VStack {
 
-            if subscription.subscribed != nil {
+            if subscription.isSubscribed {
                 Text("Subscribed to query!")
-            } else if subscription.unsubscribed != nil {
+            } else if subscription.isUnsubscribed {
                 Text("Unsubscribed from query!")
             } else if let event = subscription.event {
 
diff --git a/README.md b/README.md
@@ -259,6 +259,6 @@ You are not limited to a single Live Query Client - you can create multiple inst
 ## Migrating from Older Versions and SDKs
 
 1. See the [discussion](https://github.com/netreconlab/Parse-Swift/discussions/74) to learn how to migrate from Parse-Swift<sup>OG</sup> 4.15.0+ to 5.1.1+
-1. See the [discussion](https://github.com/netreconlab/Parse-Swift/discussions/70) to learn how to migrate from the [Parse-Swift](https://github.com/parse-community/Parse-Swift)
-1. See the [discussion](https://github.com/netreconlab/Parse-Swift/discussions/71) to learn how to migrate from the [Parse-SDK-iOS-OSX](https://github.com/parse-community/Parse-SDK-iOS-OSX)
+1. See the [discussion](https://github.com/netreconlab/Parse-Swift/discussions/70) to learn how to migrate from [parse-community/Parse-Swift](https://github.com/parse-community/Parse-Swift)
+1. See the [discussion](https://github.com/netreconlab/Parse-Swift/discussions/71) to learn how to migrate from [Parse-SDK-iOS-OSX](https://github.com/parse-community/Parse-SDK-iOS-OSX)
 
diff --git a/Sources/ParseSwift/LiveQuery/Subscription.swift b/Sources/ParseSwift/LiveQuery/Subscription.swift
@@ -25,35 +25,41 @@ open class Subscription<T: ParseObject>: QueryViewModel<T>, QuerySubscribable {
             if newValue != nil {
                 subscribed = nil
                 unsubscribed = nil
-                DispatchQueue.main.async {
-                    self.objectWillChange.send()
-                }
+                self.objectWillChange.send()
             }
         }
     }
 
+    /// If **true** the LiveQuery subscription is currently active,
+    /// **false** otherwise.
+    open var isSubscribed: Bool {
+        subscribed != nil
+    }
+
     /// Updates and notifies when a subscription request has been fulfilled and if it is new.
     open var subscribed: (query: Query<T>, isNew: Bool)? {
         willSet {
             if newValue != nil {
                 unsubscribed = nil
                 event = nil
-                DispatchQueue.main.async {
-                    self.objectWillChange.send()
-                }
+                self.objectWillChange.send()
             }
         }
     }
 
+    /// If **true** the LiveQuery subscription is currently inactive,
+    /// **false** otherwise.
+    open var isUnsubscribed: Bool {
+        unsubscribed != nil
+    }
+
     /// Updates and notifies when an unsubscribe request has been fulfilled.
     open var unsubscribed: Query<T>? {
         willSet {
             if newValue != nil {
                 subscribed = nil
                 event = nil
-                DispatchQueue.main.async {
-                    self.objectWillChange.send()
-                }
+                self.objectWillChange.send()
             }
         }
     }
@@ -69,7 +75,7 @@ open class Subscription<T: ParseObject>: QueryViewModel<T>, QuerySubscribable {
     }
 
     // MARK: QuerySubscribable
-
+    @MainActor
     open func didReceive(_ eventData: Data) throws {
         // Need to decode the event with respect to the `ParseObject`.
         let eventMessage = try ParseCoding.jsonDecoder().decode(EventResponse<T>.self, from: eventData)
@@ -79,10 +85,12 @@ open class Subscription<T: ParseObject>: QueryViewModel<T>, QuerySubscribable {
         self.event = (query, event)
     }
 
+    @MainActor
     open func didSubscribe(_ new: Bool) {
         self.subscribed = (query, new)
     }
 
+    @MainActor
     open func didUnsubscribe() {
         self.unsubscribed = query
     }
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.1.1"
+    static let version = "5.2.1"
     static let fileManagementDirectory = "parse/"
     static let fileManagementPrivateDocumentsDirectory = "Private Documents/"
     static let fileManagementLibraryDirectory = "Library/"
diff --git a/Sources/ParseSwift/Protocols/CloudObservable.swift b/Sources/ParseSwift/Protocols/CloudObservable.swift
@@ -5,7 +5,7 @@
 //  Created by Corey Baker on 7/11/21.
 //  Copyright © 2021 Network Reconnaissance Lab. All rights reserved.
 //
-#if canImport(SwiftUI)
+#if canImport(Combine)
 import Foundation
 
 /**
@@ -27,12 +27,14 @@ public protocol CloudObservable: ObservableObject {
      when the result of its execution.
         - parameter options: A set of header options sent to the server. Defaults to an empty set.
     */
-    func runFunction(options: API.Options)
+    @MainActor
+    func runFunction(options: API.Options) async
 
     /**
      Starts a Cloud Code Job *asynchronously* and updates the view model with the result and jobStatusId of the job.
         - parameter options: A set of header options sent to the server. Defaults to an empty set.
     */
-    func startJob(options: API.Options)
+    @MainActor
+    func startJob(options: API.Options) async
 }
 #endif
diff --git a/Sources/ParseSwift/Protocols/QueryObservable.swift b/Sources/ParseSwift/Protocols/QueryObservable.swift
@@ -6,7 +6,7 @@
 //  Copyright © 2021 Network Reconnaissance Lab. All rights reserved.
 //
 
-#if canImport(SwiftUI)
+#if canImport(Combine)
 import Foundation
 
 /**
@@ -32,7 +32,8 @@ public protocol QueryObservable: ObservableObject {
 
       - parameter options: A set of header options sent to the server. Defaults to an empty set.
     */
-    func find(options: API.Options)
+    @MainActor
+    func find(options: API.Options) async
 
     /**
      Retrieves *asynchronously* a complete list of `ParseObject`'s  that satisfy this query
@@ -42,24 +43,27 @@ public protocol QueryObservable: ObservableObject {
      - warning: The items are processed in an unspecified order. The query may not have any sort
      order, and may not use limit or skip.
     */
+    @MainActor
     func findAll(batchLimit: Int?,
-                 options: API.Options)
+                 options: API.Options) async
 
     /**
       Gets an object *asynchronously* and updates the view model when complete.
 
       - warning: This method mutates the query. It will reset the limit to `1`.
       - parameter options: A set of header options sent to the server. Defaults to an empty set.
     */
-    func first(options: API.Options)
+    @MainActor
+    func first(options: API.Options) async
 
     /**
       Counts objects *synchronously* based on the constructed query and updates the view model
      when complete.
 
       - parameter options: A set of header options sent to the server. Defaults to an empty set.
     */
-    func count(options: API.Options)
+    @MainActor
+    func count(options: API.Options) async
 
     /**
       Executes an aggregate query *asynchronously* and updates the view model when complete.
@@ -70,7 +74,8 @@ public protocol QueryObservable: ObservableObject {
         - parameter options: A set of header options sent to the server. Defaults to an empty set.
         - warning: This has not been tested thoroughly.
     */
+    @MainActor
     func aggregate(_ pipeline: [[String: Encodable]],
-                   options: API.Options)
+                   options: API.Options) async
 }
 #endif
diff --git a/Sources/ParseSwift/Types/CloudViewModel.swift b/Sources/ParseSwift/Types/CloudViewModel.swift
@@ -5,7 +5,7 @@
 //  Created by Corey Baker on 7/11/21.
 //  Copyright © 2021 Network Reconnaissance Lab. All rights reserved.
 //
-#if canImport(SwiftUI)
+#if canImport(Combine)
 import Foundation
 
 /**
@@ -24,9 +24,7 @@ open class CloudViewModel<T: ParseCloudable>: CloudObservable {
         willSet {
             if newValue != nil {
                 self.error = nil
-                DispatchQueue.main.async {
-                    self.objectWillChange.send()
-                }
+                self.objectWillChange.send()
             }
         }
     }
@@ -36,9 +34,7 @@ open class CloudViewModel<T: ParseCloudable>: CloudObservable {
         willSet {
             if newValue != nil {
                 self.results = nil
-                DispatchQueue.main.async {
-                    self.objectWillChange.send()
-                }
+                self.objectWillChange.send()
             }
         }
     }
@@ -47,27 +43,21 @@ open class CloudViewModel<T: ParseCloudable>: CloudObservable {
         self.cloudCode = cloudCode
     }
 
-    public func runFunction(options: API.Options = []) {
-        cloudCode.runFunction(options: options) { results in
-            switch results {
-
-            case .success(let results):
-                self.results = results
-            case .failure(let error):
-                self.error = error
-            }
+    @MainActor
+    public func runFunction(options: API.Options = []) async {
+        do {
+            self.results = try await cloudCode.runFunction(options: options)
+        } catch {
+            self.error = error as? ParseError ?? ParseError(swift: error)
         }
     }
 
-    public func startJob(options: API.Options = []) {
-        cloudCode.startJob(options: options) { results in
-            switch results {
-
-            case .success(let results):
-                self.results = results
-            case .failure(let error):
-                self.error = error
-            }
+    @MainActor
+    public func startJob(options: API.Options = []) async {
+        do {
+            self.results = try await cloudCode.startJob(options: options)
+        } catch {
+            self.error = error as? ParseError ?? ParseError(swift: error)
         }
     }
 }
diff --git a/Sources/ParseSwift/Types/QueryViewModel.swift b/Sources/ParseSwift/Types/QueryViewModel.swift
diff --git a/Tests/ParseSwiftTests/ParseCloudViewModelTests.swift b/Tests/ParseSwiftTests/ParseCloudViewModelTests.swift
diff --git a/Tests/ParseSwiftTests/ParseLiveQueryTests.swift b/Tests/ParseSwiftTests/ParseLiveQueryTests.swift
diff --git a/Tests/ParseSwiftTests/ParseQueryViewModelTests.swift b/Tests/ParseSwiftTests/ParseQueryViewModelTests.swift

Original file line number	Diff line number	Diff line change
`@@ -25,35 +25,41 @@ open class Subscription<T: ParseObject>: QueryViewModel<T>, QuerySubscribable {`
`25`	`25`	`if newValue != nil {`
`26`	`26`	`subscribed = nil`
`27`	`27`	`unsubscribed = nil`
`28`		`- DispatchQueue.main.async {`
`29`		`- self.objectWillChange.send()`
`30`		`- }`
	`28`	`+ self.objectWillChange.send()`
`31`	`29`	`}`
`32`	`30`	`}`
`33`	`31`	`}`
`34`	`32`
	`33`	`+ /// If true the LiveQuery subscription is currently active,`
	`34`	`+ /// false otherwise.`
	`35`	`+ open var isSubscribed: Bool {`
	`36`	`+ subscribed != nil`
	`37`	`+ }`
	`38`	`+`
`35`	`39`	`/// Updates and notifies when a subscription request has been fulfilled and if it is new.`
`36`	`40`	`open var subscribed: (query: Query<T>, isNew: Bool)? {`
`37`	`41`	`willSet {`
`38`	`42`	`if newValue != nil {`
`39`	`43`	`unsubscribed = nil`
`40`	`44`	`event = nil`
`41`		`- DispatchQueue.main.async {`
`42`		`- self.objectWillChange.send()`
`43`		`- }`
	`45`	`+ self.objectWillChange.send()`
`44`	`46`	`}`
`45`	`47`	`}`
`46`	`48`	`}`
`47`	`49`
	`50`	`+ /// If true the LiveQuery subscription is currently inactive,`
	`51`	`+ /// false otherwise.`
	`52`	`+ open var isUnsubscribed: Bool {`
	`53`	`+ unsubscribed != nil`
	`54`	`+ }`
	`55`	`+`
`48`	`56`	`/// Updates and notifies when an unsubscribe request has been fulfilled.`
`49`	`57`	`open var unsubscribed: Query<T>? {`
`50`	`58`	`willSet {`
`51`	`59`	`if newValue != nil {`
`52`	`60`	`subscribed = nil`
`53`	`61`	`event = nil`
`54`		`- DispatchQueue.main.async {`
`55`		`- self.objectWillChange.send()`
`56`		`- }`
	`62`	`+ self.objectWillChange.send()`
`57`	`63`	`}`
`58`	`64`	`}`
`59`	`65`	`}`
`@@ -69,7 +75,7 @@ open class Subscription<T: ParseObject>: QueryViewModel<T>, QuerySubscribable {`
`69`	`75`	`}`
`70`	`76`
`71`	`77`	`// MARK: QuerySubscribable`
`72`		`-`
	`78`	`+ @MainActor`
`73`	`79`	`open func didReceive(_ eventData: Data) throws {`
`74`	`80`	// Need to decode the event with respect to the `ParseObject`.
`75`	`81`	`let eventMessage = try ParseCoding.jsonDecoder().decode(EventResponse<T>.self, from: eventData)`
`@@ -79,10 +85,12 @@ open class Subscription<T: ParseObject>: QueryViewModel<T>, QuerySubscribable {`
`79`	`85`	`self.event = (query, event)`
`80`	`86`	`}`
`81`	`87`
	`88`	`+ @MainActor`
`82`	`89`	`open func didSubscribe(_ new: Bool) {`
`83`	`90`	`self.subscribed = (query, new)`
`84`	`91`	`}`
`85`	`92`
	`93`	`+ @MainActor`
`86`	`94`	`open func didUnsubscribe() {`
`87`	`95`	`self.unsubscribed = query`
`88`	`96`	`}`