Migrating to 6.0.0+ With Complete Concurrency

[cbaker6]

Version 6.0.4 of Parse-Swift^OG has been released and has a plethora of new features and updates (see API and tutorial documentation). In addition, the latest version can take advantage of all of the new features in Parse Server 9.1.1+ and still works with Parse Server 4.0.0+ (see a list of features in #72). Version 6.0.0+ has been modernized and optimized to better leverage the latest features in Swift and provide a more intuitive experience for developers than previous versions. Under the hood, 6.0.0+ uses strict concurrency, which allows the compiler to conclusively prove different parts of the SDK can run concurrently.

Test Drive 6.0.0+ with Parse Server 9.1.1+

Deploying a local Parse Server is quick and easy via Docker. All of the Swift Playgrounds can be run locally in Xcode

1. Fork parse-hipaa (make sure it's the parse-swift branch), change directories into the parse-hipaa folder in your terminal, type docker-compose up. The latest parse-hipaa serve which is built with the latest Parse Server should be up and running. You can find more information here
2. Follow the directions to view your Parse Dashboard to see all data changes made by Swift Playgrounds
3. Fork Parse-Swift and open Parse.xcworkspace
4. Be sure to change the Parse-Swift workspace in Xcode to build for ParseSwift (macOS) framework when using Swift Playgrounds
5. Go to the last file in the Project Navigator pane and select ParseSwift-> 1 - Your first Object. All Playground files are located here
6. Begin running the Playgrounds files and edit the code to experiment

Upgrading

To upgrade (If you are attempting to migrate from the parse-community/Parse-Swift, please read #70 first). Otherwise, you can follow the steps below:

1. Open your project, click on your project in the Project Navigator panel
2. Select the name of your project under Project in the right panel
3. Click the Package Dependencies tab
4. Edit the Dependency Rule, select Up to Next Major Version and input 6.0.0 for the specific version and < 7.0.0

To adapt to 6.0.0+, you will need to make some required changes to your apps. Note that your whole app DOES NOT need to be in Swift 6 Language mode to use ParseSwift 6.0.0+ (more information on incremental migrations). Some notable changes are below:

Breaking Changes

• Update SDK to be Swift 6.0+ compliant. This includes making all objects Sendable and reducing the possibility of data races. Added WASM support. Multiple batches now perform asynchronously (#208).
• Remove all deprecated code and warnings (#211). Please make updates to suggested code changes in the comments in the marked deprecated code.

Almost every object in the SDK is either Sendable or nonisolated(unsafe) with mutating properties protected with NSLock's. Only View Models in the SDK use @MainActor with all other calls running on the queue they were called on (this is the same as ParseSwift 5.x). All completion handlers default to returning to the main queue unless specified as an argument when calling the respective method (this is the same as ParseSwift 5.x). To migrate, you can remove any @preconcurrency imports related to ParseSwift, since the SDK is now under strict concurrency. Most of the changes you will need to make will be related to ensuring you have Sendable closures. Example below:

// ParseSwift 5.x 
func exampleFunction(completion: @escaping ([ExampleParseObject]?, Error?) -> Void)

// ParseSwift 6.0.0+ 
func exampleFunction(completion: @escaping @Sendable ([ExampleParseObject]?, Error?) -> Void)

In addition, any class that subclasses ParseLiveQueryDelegate needs to also subclass NSObject and should be a final class. LiveQuery subscription classes such as Subscription and SubscriptionCallback are @unchecked Sendable and use NSLock under the hood to manage state internally in the SDK. If you subclass Subscription and SubscriptionCallback, you are responsible for maintaining the state of all added mutable properties using NSLock, Mutex, etc. Please see Hacking With Swift and Avander Lee's posts to learn more about Swift 6 complete concurrency.

[softcleandev]

Thanks for keeping this project alive.
I can’t wait to try out the new version.