Throw error when sharing while sync engine is stopped. (#234)

* Throw error when sharing while sync engine is stopped.

* snapshot

Author: mbrandonw

Sources/SQLiteData/CloudKit/CloudKitSharing.swift

@@ -35,10 +35,11 @@
         case recordNotRoot([ForeignKey])
         case recordTableNotSynchronized
         case recordTablePrivate
+        case syncEngineNotRunning
       }
 
-      let recordTableName: String
-      let recordPrimaryKey: String
+      var recordTableName: String?
+      var recordPrimaryKey: String?
       let reason: Reason
       let debugDescription: String
 
@@ -71,6 +72,16 @@
       configure: @Sendable (CKShare) -> Void
     ) async throws -> SharedRecord
     where T.TableColumns.PrimaryKey.QueryOutput: IdentifierStringConvertible {
+      guard isRunning
+      else {
+        throw SharingError(
+          reason: .syncEngineNotRunning,
+          debugDescription: """
+            Sync engine is not running. Make sure engine is running by invoking the 'start()' \
+            method, or using the 'startImmediately' argument when initializing the engine.
+            """
+        )
+      }
       guard tablesByName[T.tableName] != nil
       else {
         throw SharingError(

Tests/SQLiteDataTests/CloudKitTests/SharingTests.swift

@@ -55,6 +55,35 @@
         }
       }
 
+      @available(iOS 17, macOS 14, tvOS 17, watchOS 10, *)
+      @Test func syncEngineStopped() async throws {
+        let remindersList = RemindersList(id: 1, title: "Personal")
+        try await userDatabase.userWrite { db in
+          try db.seed { remindersList }
+        }
+        try await syncEngine.processPendingRecordZoneChanges(scope: .private)
+        syncEngine.stop()
+
+        let error = await #expect(throws: (any Error).self) {
+          _ = try await self.syncEngine.share(record: remindersList, configure: { _ in })
+        }
+        assertInlineSnapshot(of: error?.localizedDescription, as: .customDump) {
+          """
+          "The record could not be shared."
+          """
+        }
+        assertInlineSnapshot(of: error, as: .customDump) {
+          #"""
+          SyncEngine.SharingError(
+            recordTableName: nil,
+            recordPrimaryKey: nil,
+            reason: .syncEngineNotRunning,
+            debugDescription: "Sync engine is not running. Make sure engine is running by invoking the \'start()\' method, or using the \'startImmediately\' argument when initializing the engine."
+          )
+          """#
+        }
+      }
+
       @available(iOS 17, macOS 14, tvOS 17, watchOS 10, *)
       @Test func shareUnrecognizedTable() async throws {
         let error = await #expect(throws: (any Error).self) {

Tests/SQLiteDataTests/Internal/BaseCloudKitTests.swift

@@ -124,6 +124,9 @@ class BaseCloudKitTests: @unchecked Sendable {
 
   deinit {
     if #available(iOS 17, macOS 14, tvOS 17, watchOS 10, *) {
+      guard syncEngine.isRunning
+      else { return }
+
       syncEngine.shared.assertFetchChangesScopes([])
       syncEngine.shared.state.assertPendingDatabaseChanges([])
       syncEngine.shared.state.assertPendingRecordZoneChanges([])
@@ -132,6 +135,7 @@ class BaseCloudKitTests: @unchecked Sendable {
       syncEngine.private.state.assertPendingDatabaseChanges([])
       syncEngine.private.state.assertPendingRecordZoneChanges([])
       syncEngine.private.assertAcceptedShareMetadata([])
+
       try! syncEngine.metadatabase.read { db in
         try #expect(UnsyncedRecordID.count().fetchOne(db) == 0)
       }