Merge pull request #46 from pointfreeco/in-memory-metadatabase

Allow in-memory databases in tests/previews

Author: mbrandonw

Sources/SharingGRDBCore/CloudKit/Metadatabase.swift

@@ -23,10 +23,25 @@ func defaultMetadatabase(
     at: .applicationSupportDirectory,
     withIntermediateDirectories: true
   )
-  let metadatabase = try DatabasePool(
-    path: url.path(percentEncoded: false),
-    configuration: configuration
-  )
+
+  @Dependency(\.context) var context
+  guard !url.isInMemory || context != .live
+  else {
+    struct InMemoryDatabase: Error {}
+    throw InMemoryDatabase()
+  }
+
+  let metadatabase: any DatabaseWriter = if url.isInMemory {
+    try DatabaseQueue(
+      path: url.absoluteString,
+      configuration: configuration
+    )
+  } else {
+    try DatabasePool(
+      path: url.path(percentEncoded: false),
+      configuration: configuration
+    )
+  }
   // TODO: go towards idempotent migrations instead of GRDB migrator by the end of all of this
   var migrator = DatabaseMigrator()
   // TODO: do we want this?

Sources/SharingGRDBCore/CloudKit/SyncEngine.swift

@@ -1417,19 +1417,16 @@
       databasePath: String,
       containerIdentifier: String?
     ) throws -> URL {
-      guard
-        let databaseURL = URL(string: databasePath),
-        !databaseURL.isInMemory
+      guard let databaseURL = URL(string: databasePath)
       else {
-        throw SyncEngine.SchemaError(
-          reason: .inMemoryDatabase,
-          debugDescription: """
-            Can't synchronize temporary/in-memory database: it must be written to the file system.
-            """
-        )
+        struct InvalidDatabsePath: Error {}
+        throw InvalidDatabsePath()
+      }
+      guard !databaseURL.isInMemory
+      else {
+        return URL(string: "file:\(String.sqliteDataCloudKitSchemaName)?mode=memory&cache=shared")!
       }
-      return
-        databaseURL
+      return databaseURL
         .deletingLastPathComponent()
         .appending(component: ".\(databaseURL.deletingPathExtension().lastPathComponent)")
         .appendingPathExtension("metadata\(containerIdentifier.map { "-\($0)" } ?? "").sqlite")

Tests/SharingGRDBTests/CloudKitTests/SyncEngineTests.swift

@@ -1,5 +1,6 @@
 import CloudKit
 import CustomDump
+import DependenciesTestSupport
 import Foundation
 import InlineSnapshotTesting
 import SharingGRDB
@@ -8,29 +9,7 @@ import Testing
 
 extension BaseCloudKitTests {
   @MainActor
-  final class SyncEngineTests: BaseCloudKitTests, @unchecked Sendable {
-    #if os(macOS) && compiler(>=6.2)
-      @available(iOS 17, macOS 14, tvOS 17, watchOS 10, *)
-      @Test func foreignKeysDisabled() throws {
-        let result = #expect(
-          processExitsWith: .failure,
-          observing: [\.standardErrorContent]
-        ) {
-          // TODO: finish in Xcode 26
-          //  _ = try SyncEngine(
-          //    syncEngine.private: MockSyncEngine(scope: .private, state: MockSyncEngineState()),
-          //    syncEngine.shared: MockSyncEngine(scope: .shared, state: MockSyncEngineState()),
-          //    database: databaseWithForeignKeys(),
-          //    tables: []
-          //  )
-        }
-        #expect(
-          String(decoding: try #require(result).standardOutputContent, as: UTF8.self)
-            == "Foreign key support must be disabled to synchronize with CloudKit."
-        )
-      }
-    #endif
-
+  final class SyncEngineTests {
     @Test func inMemory() throws {
       #expect(URL(string: "")?.isInMemory == nil)
       #expect(URL(string: ":memory:")?.isInMemory == true)
@@ -39,14 +18,55 @@ extension BaseCloudKitTests {
       #expect(URL(string: "file:memdb1?mode=memory&cache=shared")?.isInMemory == true)
     }
 
+    @Test func inMemoryUserDatabase() async throws {
+      let syncEngine = try await SyncEngine(
+        container: MockCloudContainer(
+          containerIdentifier: "test",
+          privateCloudDatabase: MockCloudDatabase(databaseScope: .private),
+          sharedCloudDatabase: MockCloudDatabase(databaseScope: .shared)
+        ),
+        userDatabase: UserDatabase(database: DatabaseQueue()),
+        tables: []
+      )
+
+      try await syncEngine.userDatabase.read { db in
+        try SQLQueryExpression(
+          """
+          SELECT 1 FROM "sqlitedata_icloud_metadata"
+          """
+        )
+        .execute(db)
+      }
+    }
+
+    @Test(.dependency(\.context, .live))
+    func inMemoryUserDatabase_LiveContext() async throws {
+      let error = await #expect(throws: (any Error).self) {
+        try await SyncEngine(
+          container: MockCloudContainer(
+            containerIdentifier: "test",
+            privateCloudDatabase: MockCloudDatabase(databaseScope: .private),
+            sharedCloudDatabase: MockCloudDatabase(databaseScope: .shared)
+          ),
+          userDatabase: UserDatabase(database: DatabaseQueue()),
+          tables: []
+        )
+      }
+      assertInlineSnapshot(of: error, as: .customDump) {
+        """
+        InMemoryDatabase()
+        """
+      }
+    }
+
     @Test func metadatabaseMismatch() async throws {
       let error = await #expect(throws: (any Error).self) {
         var configuration = Configuration()
         configuration.prepareDatabase { db in
           try db.attachMetadatabase(containerIdentifier: "iCloud.co.pointfree")
         }
         let database = try DatabasePool(
-          path: NSTemporaryDirectory() + UUID().uuidString,
+          path: "/tmp/db.sqlite",
           configuration: configuration
         )
         _ = try await SyncEngine(
@@ -63,8 +83,8 @@ extension BaseCloudKitTests {
         #"""
         SyncEngine.SchemaError(
           reason: .metadatabaseMismatch(
-            attachedPath: "/private/var/folders/vj/bzr5j4ld7cz6jgpphc5kbs8m0000gn/T/.C1938F73-8A6E-40BA-BCF5-A10C07CA1EB6.metadata-iCloud.co.pointfree.sqlite",
-            syncEngineConfiguredPath: "/var/folders/vj/bzr5j4ld7cz6jgpphc5kbs8m0000gn/T/.C1938F73-8A6E-40BA-BCF5-A10C07CA1EB6.metadata-iCloud.co.point-free.sqlite"
+            attachedPath: "/private/tmp/.db.metadata-iCloud.co.pointfree.sqlite",
+            syncEngineConfiguredPath: "/tmp/.db.metadata-iCloud.co.point-free.sqlite"
           ),
           debugDescription: "Metadatabase attached in \'prepareDatabase\' does not match metadatabase prepared in \'SyncEngine.init\'. Are the CloudKit container identifiers different?"
         )