CloudKit Sync - Knowing Sync is in Progress or When Finished?

[rwgrier]

I've recently started using SQLiteData. I am enjoying it. Thanks for making it.

For CloudKit sync, I have two questions.

1. Is there a way to know if SyncEngine is currently syncing with CloudKit?
2. Is there a way to know once SyncEngine has finished syncing?

There may be cases where I would like to hold off on syncing and wait until it's finished.

[mbrandonw]

Hi @rwgrier,

• Is there a way to know if SyncEngine is currently syncing with CloudKit?

That's exactly what PR #249 accomplishes, which we plan on merging and releasing soon. You can check out the example app to see how it is used to show a progress indicator in a SwiftUI view when the sync engine is sending/fetching changes.

• Is there a way to know once SyncEngine has finished syncing?

The same property above can be used, and it's an observable property so you can use it just as you would use any property in an @Observable model. For example, you can use the new Observations { … } to track its changes, or you can use the observe tool that ships in our SwiftNavigation library. And any access to that property in a SwiftUI view will cause the view to automatically re-render when the value changes.

There may be cases where I would like to hold off on syncing and wait until it's finished.

Not exactly sure what your use case is, but do be aware that there isn't necessarily any rhyme or reason to when the sync engine may start communicating with CloudKit. It can flutter with activity even when nothing has changed. I personally wouldn't do anything too user facing with that information because it may flip true/false pretty frequently.

[rwgrier]

This is excellent info. Looks like a great addition to SQLiteData.

Not exactly sure what your use case is, but do be aware that there isn't necessarily any rhyme or reason to when the sync engine may start communicating with CloudKit. It can flutter with activity even when nothing has changed. I personally wouldn't do anything too user facing with that information because it may flip true/false pretty frequently.

Right now, more of a curiosity. The PR will handle any actual use cases I currently have.

Thank you!