CloudKit on Andrew Bancroft

NSPersistentCloudKitContainer Buggy Behavior List

Thu, 11 Jul 2019 04:40:54 +0000

NSPersistentCloudKitContainer is brand new with Xcode 11 and iOS 13.

It works… kind of… sometimes…

I’m keeping this list of buggy behavior to help keep my head straight. I’ve also filed bug reports on each.

Hopefully others in the iOS community who are experimenting with NSPersistentCloudKitContainer can confirm or deny these same oddities. If they’re fixed in a subsequent beta, I’ll come back here and note it!

Which Beta Version Does This Affect?

I’ve tested out each of these on iOS 13 Beta 5 and Xcode 11 Beta 5.

Enabling CloudKit doesn’t create a default container

In Xcode 11, adding the iCloud capability and clicking the CloudKit checkbox is not automatically creating a default container for new apps that I’m testing…

Xcode 10

Xcode 11

Existing data doesn’t sync

Suppose that…

You have an existing Core Data app
The app is installed on two devices with the same user signed in to iCloud
Data has been saved independently on both devices

Now suppose that you want to take advantage of the automagic syncing offered with NSPersistendCloudKitContainer.

If you…

Set up your app to work with NSPersistentCloudKitContainer
Rebuild your app and install it on both devices
Launch the app on both devices…

You might expect the existing data to show up on both devices. It doesn’t.

If you add new data on one device, only the new data that gets saved after the NSPersistentCloudKitContainer conversion gets synced. Existing data never does.

🤷🏼‍♂️

Data only syncs after you close and re-launch your app

I really thought I had this figured out. Beta 5 has proved me wrong.

In Beta 2, simply setting automaticallyMergesChangesFromParent on the container’s viewContext to true seemed to work.

Not with Beta 5.

You can save new data and wait (and wait… and wait…). It doesn’t show up in the UI until after you re-launch the app.

Here’s what I’m experiencing:

Record accessor methods missing in Xcode

“On my machine”, attempting to use the record(for:) methods on NSPersistentCloudKitContainer produce the following error message:

Value of type ‘NSPersistentCloudKitContainer’ has no member ‘record’

I can “Jump to definition” and the methods appear to be there…

Attempting to use the function in code doesn’t work…

Getting Started With NSPersistentCloudKitContainer

Tue, 11 Jun 2019 04:40:54 +0000

First Things First

In order to use NSPersistentCloudKitContainer in your app, you need to be targeting iOS 13+.
The CloudKit syncing portion only works on physical devices (not in the simulator). That being the case, you’ll need two or more devices running the app and using the same iCloud account to fully test things out and make sure syncing and data merging behavior works as you’d expect it to.

The goal of this walkthrough is to provide you with a fully-working example of performing and synchronizing create, read, update, and delete operations using NSPersistentCloudKitContainer.

It’s the project I wish I had for referencing the basics…something beyond the out-of-the-box, saving a list of timestamps that comes pre-implemented with a Master-Detail app, but something less complicated than Apple’s example project which ends up having several relationships involved in the data model, extra features configured on the persistent container, etc.

I offer it to you as reference as well – I hope it helps!

Resources

Setup

The easiest way to get stareted with NSPersistentCloudKitContainer is to enable Core Data and CloudKit when you start your new project.

The Core Data + CloudKit Stack

Xcode provides the Core Data Stack code you need in the usual location: in the AppDelegate.swift file.

There’s one notable difference though. Instead of initializing a normal NSPersistentContainer, Xcode uses the new NSPersistentCloudKitContainer (this is why it’s important to check the CloudKit box when you create your app).

What About Existing Apps?

If you’ve got an existing app that’s using a “regular” NSPersistentContainer, you can change it to NSPersistentCloudKitContainer and continue on from there!

If you’re not using NSPersistentContainer with your app yet, my guide on how to migrate may be of help!

Adding Capabilities

While Xcode auto-generates the Core Data + CloudKit stack for you, it does not enable iCloud for you.

To enable full functionality, you need to go to your Xcode project settings.

Then click on the Signing & Capabilities section and add the iCloud and Background Modes capabilities.

Check the CloudKit checkbox, and the Remote Notifications checkbox.

Add iCloud + CloudKit

Add Background Modes + Remote Notifications

What About Registering for Remote Notifications?

The beauty of NSPersistentCloudKitContainer is that it handles all the work required to listen for and respond to remote notifications.

This means that data saved locally on one device gets pushed up to iCloud synced back down to another device automatically.

What About My Data Model in iCloud?

When you enable the iCloud capability for your app, Xcode automatically creates a container for your app in the CloudKit Dashboard.

It does not, however, create a schema that matches your Core Data model…yet. This is a setting you can toggle, but the default behavior is to “lazily” create the schema as people create objects and save them to your persistent store.

Walking Through the Example Project

WWDC always gets the blog ideas flowing through my brain, so this little app’s theme is “saving a list of blog ideas”, both locally, and across my devices using NSPersistentCloudKitContainer.

User Interface

The user interfacde allows you to perform the essential operations of a data-driven app: create, read, update, and delete objects.

Data Model

The data model for this is basic: a single BlogIdea Entity with two String properties: ideaTitle and ideaDescription.

No relationships or extra configuration options… just one Entity to keep it a basic reference-able project.

The BlogIdea NSManagedObject subclass is implemented like this:

public class BlogIdea: NSManagedObject {

    @NSManaged public var ideaTitle: String?
    @NSManaged public var ideaDescription: String?

    static var entityName: String { return "BlogIdea" }
}

View Controllers

There are two view controllers that come with this example:

MainViewController

class MainViewController:   UIViewController, 
                            NSFetchedResultsControllerDelegate, 
                            UITableViewDataSource, 
                            UITableViewDelegate {
    // Responsible for listing out BlogIdeas in a table view

    // Holds a reference to an NSManagedObjectContext instance
    // which gets initialized in the SceneDelegate.swift file
    // and passed to this view controller when the scene gets "connected"

    // Uses NSFetchedResultsController to keep the table view in sync
    // with the Core Data managed object context

    // Implements swipe-to-delete with delete confirmation

    // Navigates to editor when someone taps on a table view row
    // and passes its NSManagedObjectContext instance along
}

BlogIdeaEditorViewController

class BlogIdeaEditorViewController: UIViewController {
    // Responsible for creating new BlogIdeas

    // Holds a reference to an NSManagedObjectContext instance
    // which gets passed along in MainViewController's prepare for segue method

    // Able to edit existing BlogIdeas
}

Understanding the Default Sync Behavior

At this point no additional configuration has happened. The Core Data stack is the unmodified Xcode generated code, and the fetched results controller is hooked up to the managed object context for your app, ready to fetch Blog Ideas and help get them into the table view.

If you open the project, build and run on two devices, and begin adding Blog Ideas, updating them, deleting them, etc. what happens?

The first observation is that…things…don’t…seem to be working…

…At least not how I thought they would.

I expected my Blog List view to automatically update in response to changes made on my other device, buuut… nope. Thankfully it’s an “easy” fix.

Reflecting Changes in the UI

Wherever you access your app’s persistent CloudKit container to grab the viewContext, you need to set the automaticallyMergesChangesFromParent property to true.

I initialize the container in the SceneDelegate, so check out the code exerpt below to see where that gets set.

SceneDelegate.swift

func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
    // Use this method to optionally configure and attach the UIWindow `window` to the provided UIWindowScene `scene`.
    // If using a storyboard, the `window` property will automatically be initialized and attached to the scene.
    // This delegate does not imply the connecting scene or session are new (see `application:configurationForConnectingSceneSession` instead).
    guard let _ = (scene as? UIWindowScene) else { return }
    
    let navigationController = self.window?.rootViewController as! UINavigationController
    let mainVC = navigationController.viewControllers[0] as! MainViewController
    
    let viewContext = (UIApplication.shared.delegate as! AppDelegate).persistentContainer.viewContext
    viewContext.automaticallyMergesChangesFromParent = true

    mainVC.managedObjectContext = viewContext
}

Making this one-line change will enable the app (which is supported by NSFetchedResultsController) to update the UI in response to remote data changes…

eventually

It can be slow (anywhere from 5 to 15 seconds). But it will eventually update.

Revisiting the iCloud Schema

Once you save an object, the schema within the iCloud Dashboard will update to reflect the properties you designed in your Core Data Model.

Where’s My Data?

If you attempt to query for BlogIdea records in any of the iCloud databases provisioned for your app, you won’t find any.

Why?

That’s because Apple fully manages a hidden Zone for your Core Data + CloudKit data. It was veeeery briefly mentioned in the WWDC 2019 presentation (right about 10:50 if you’re watching).

Wrapping Up

My hope was to provide you with a fully-working example of performing and synchronizing create, read, update, and delete operations using NSPersistentCloudKitContainer.

Check out the GitHub repo, leave a comment, or @ me on Twitter to continue the conversation from here!

First Impressions of NSPersistentCloudKitContainer

Thu, 06 Jun 2019 04:40:54 +0000

Resources

How NSPersistentCloudKitContainer Helps

I suppose the first question everyone should ask is, “What’s the big deal? How does NSPersistentCloudKitContainer even help me?”

I noted at least three huge wins from the WWDC 2019 session. Ask yourself…

“Do I want to figure out how to retrieve data from CloudKit and merge it with my local Core Data persistent store on my own?” – No? Me either. 😃

NSPersistentCloudKitContainer handles making a local replica of your app’s CloudKit data.

“Do I want to implement synchronization schedluing and all the error handling that comes with CloudKit?” – I definitely don’t…

NSPersistentCloudKitContainer handles scheduling CloudKit operations, and takes your // handle errors placeholder code (👀) and actually implements it the right way internally. #sweet

“Do I want to map between NSManagedObjects and CKRecords by hand?” – Not if that could be automagic!

NSPersistentCloudKitContainer handles transforming your NSManagedObjects into CKRecords as well.

Exciting Times

Apple did a lot of work to encapsulate a very common set of code patterns that were necessary for implementing an app with Core Data and CloudKit.

They claim to be able to save us thousands of lines of code (and I believe it!).

I have an app that uses Core Data locally. I’ve been wanting to enable CloudKit on, so that data is synced across my users’ devices. Every time I think about what it’ll take to get the Core Data pieces talking the on the same wavelength as the CloudKit pieces, I just dread the inevitable headache that would ensue. So I run away. 😬

My hope is to see what it’s like to enable NSPersistentCloudKitContainer with that existing app. I’ll be sure to document the journey!

Dipping a Toe In

Just a couple of tidbits about the setup process for getting started with this new class…

Enabling Core Data + CloudKit

While it’s not absolutely required to check these checkboxes, Xcode will provide you with some of the boilerplate code necessary for working with Core Data and CloudKit together.

Starting Point

Xcode generates some code in your AppDelegate.swift file to initialize the Core Data Stack, only this time, instead of a standard NSPersistentContainer, it initializes the new NSPersistentCloudKitContainer:

 1lazy var persistentContainer: NSPersistentCloudKitContainer = {
 2        let container = NSPersistentCloudKitContainer(name: "NSPersistentCloudKitContainer_First_Steps")
 3        container.loadPersistentStores(completionHandler: { (storeDescription, error) in
 4            if let error = error as NSError? {
 5                // Replace this implementation with code to handle the error appropriately.
 6                fatalError("Unresolved error \(error), \(error.userInfo)")
 7            }
 8        })
 9        return container
10    }()

Not Ready Yet (more to enable)

Enable CloudKit Capability

Since you’re working with CloudKit in this scenario, you still need to enable CloudKit so that your app has the appropriate entitlements, and so that your app’s CloudKit container gets created in iCloud.

Enable Remote Notifications

CloudKit also uses Push Notifications to alert your app to data changes coming in from other devices. To get these notifications, you need to enable the Remote Notifications capability for your app as well.

Next Steps

When it comes to learning what to do next, Apple has provided a sample project that I hope to examine and take apart.

More to come!