wip

Author: stephencelis

Sources/SharingGRDBCore/CloudKit/DefaultSyncEngine.swift

@@ -1,20 +1,20 @@
 #if canImport(CloudKit)
-import CloudKit
-import Dependencies
-import GRDB
+  import CloudKit
+  import Dependencies
+  import GRDB
 
-@available(iOS 17, macOS 14, tvOS 17, watchOS 10, *)
-extension DependencyValues {
-  public var defaultSyncEngine: SyncEngine {
-    get { self[SyncEngine.self] }
-    set { self[SyncEngine.self] = newValue }
+  @available(iOS 17, macOS 14, tvOS 17, watchOS 10, *)
+  extension DependencyValues {
+    public var defaultSyncEngine: SyncEngine {
+      get { self[SyncEngine.self] }
+      set { self[SyncEngine.self] = newValue }
+    }
   }
-}
 
-@available(iOS 17, macOS 14, tvOS 17, watchOS 10, *)
-extension SyncEngine: TestDependencyKey {
-  public static var testValue: SyncEngine {
-    try! SyncEngine(container: .default(), database: DatabaseQueue(), tables: [])
+  @available(iOS 17, macOS 14, tvOS 17, watchOS 10, *)
+  extension SyncEngine: TestDependencyKey {
+    public static var testValue: SyncEngine {
+      try! SyncEngine(for: DatabaseQueue())
+    }
   }
-}
 #endif

Sources/SharingGRDBCore/CloudKit/SyncEngine.swift

@@ -4,6 +4,8 @@
   import CustomDump
   import OrderedCollections
   import OSLog
+  import StructuredQueriesCore
+  import SwiftData
 
   @available(iOS 17, macOS 14, tvOS 17, watchOS 10, *)
   public final class SyncEngine: Sendable {
@@ -24,14 +26,41 @@
 
     let dataManager = Dependency(\.dataManager)
 
-    public convenience init(
-      container: CKContainer,
+    public convenience init<each T1: PrimaryKeyedTable, each T2: PrimaryKeyedTable>(
+      for database: any DatabaseWriter,
+      tables: repeat (each T1).Type,
+      privateTables: repeat (each T2).Type,
+      containerIdentifier: String? = nil,
       defaultZone: CKRecordZone = CKRecordZone(zoneName: "co.pointfree.SQLiteData.defaultZone"),
-      database: any DatabaseWriter,
-      logger: Logger = Logger(subsystem: "SQLiteData", category: "CloudKit"),
-      tables: [any PrimaryKeyedTable.Type],
-      privateTables: [any PrimaryKeyedTable.Type] = []
-    ) throws {
+      logger: Logger = Logger(subsystem: "SQLiteData", category: "CloudKit")
+    ) throws
+    where
+      repeat (each T1).PrimaryKey.QueryOutput: IdentifierStringConvertible,
+      repeat (each T2).PrimaryKey.QueryOutput: IdentifierStringConvertible
+    {
+      let containerIdentifier = containerIdentifier
+        ?? ModelConfiguration(groupContainer: .automatic).cloudKitContainerIdentifier
+
+      guard let containerIdentifier else {
+        throw SchemaError(
+          reason: .noCloudKitContainer,
+          debugDescription: """
+            No default CloudKit container found. Please add a container identifier to your app's \
+            entitlements.
+            """
+        )
+      }
+
+      let container = CKContainer(identifier: containerIdentifier)
+      var allTables: [any PrimaryKeyedTable.Type] = []
+      var allPrivateTables: [any PrimaryKeyedTable.Type] = []
+      for table in repeat each tables {
+        allTables.append(table)
+      }
+      for privateTable in repeat each privateTables {
+        allPrivateTables.append(privateTable)
+      }
+
       let userDatabase = UserDatabase(database: database)
       try self.init(
         container: container,
@@ -66,8 +95,8 @@
         },
         userDatabase: userDatabase,
         logger: logger,
-        tables: tables,
-        privateTables: privateTables
+        tables: allTables,
+        privateTables: allPrivateTables
       )
       _ = try setUpSyncEngine(
         userDatabase: userDatabase,
@@ -1493,7 +1522,8 @@
     ///
     /// - Parameter containerIdentifier: The identifier of the CloudKit container used to synchronize
     ///                                  data.
-    public func attachMetadatabase(containerIdentifier: String) throws {
+    public func attachMetadatabase(containerIdentifier: String? = nil) throws {
+      // TODO
       let databasePath = try SQLQueryExpression(
         """
         SELECT "file" FROM pragma_database_list()
@@ -1539,6 +1569,7 @@
         case invalidForeignKeyAction(ForeignKey)
         case invalidTableName(String)
         case metadatabaseMismatch(attachedPath: String, syncEngineConfiguredPath: String)
+        case noCloudKitContainer
         case nonNullColumnsWithoutDefault(tableName: String, columnNames: [String])
         case triggersWithoutSynchronizationCheck([String])
         case unknown

Sources/SharingGRDBCore/Documentation.docc/Articles/CloudKit.md

@@ -89,15 +89,11 @@ struct MyApp: App {
 ```
 
 The `SyncEngine` 
- [initializer](<doc:SyncEngine/init(container:defaultZone:database:logger:tables:privateTables:)>)
+[initializer](<doc:SyncEngine/init(for:tables:privateTables:containerIdentifier:defaultZone:logger:)>)
 has more options you may be interested in configuring.
 
-> Important: A few important things to note about this:
-> 
->   * The CloudKit container identifier must be explicitly provided and unfortunately cannot be 
->     extracted from Entitlements.plist automatically. That privilege is only afforded to SwiftData.
->   * You must explicitly provide all tables that you want to synchronize. We do this so that you
->     can have the option of having some local tables that are not synchronized to CloudKit.
+> Important: You must explicitly provide all tables that you want to synchronize. We do this so that
+> you can have the option of having some local tables that are not synchronized to CloudKit.
 
 Once this work is done the app should work exactly as it did before, but now any changes made
 to the database will be synchronized to CloudKit. You will still interact with your local SQLite

Sources/SharingGRDBCore/Documentation.docc/Articles/CloudKitSharing.md

@@ -391,7 +391,7 @@ struct MyApp: App {
     try! prepareDependencies {
       $0.defaultDatabase = try appDatabase()
       $0.defaultSyncEngine = try SyncEngine(
-        database: $0.defaultDatabase,
+        for: $0.defaultDatabase,
         tables: RemindersList.self, Reminder.self,
         privateTables: RemindersListPrivate.self
       )