Support attachMetadatabase in previews (#267)

* Support `attachMetadatabase` in previews

Previews can currently crash if an app database is provisioned that
attaches a metadatabase. Despite trying to ensure all databases are
in-memory to work around an Xcode previews quirk, SQLite still throws a
file system error when connecting to an in-memory database with a file
URL.

This PR attempts to work around the issue by sharing the same database
connection in previews.

This does require losing the internal `DatabaseMigrator` we currently
use for the metadatabase and instead depend on `IF NOT EXISTS` because
GRDB only supports a single set of migrations per database (we could
maybe scope this change just to previews), but this is probably OK. It
also means that the migrator will always detect schema changes for
previews since the metadatabase tables will conflict, but this is also
probably OK since previews are not long-living.

* Revert "Support `attachMetadatabase` in previews"

This reverts commit 1734711.

* wip

* wip

* wip

* wip

---------

Co-authored-by: Brandon Williams <[email protected]>

Author: stephencelis

Examples/Examples.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -311,9 +311,23 @@
         .select(\.file)
         .fetchOne(db)
       if let attachedMetadatabasePath {
-        let attachedMetadatabaseName = URL(filePath: metadatabase.path).lastPathComponent
-        let metadatabaseName = URL(filePath: attachedMetadatabasePath).lastPathComponent
-        if attachedMetadatabaseName != metadatabaseName {
+        let metadatabaseName =
+          metadatabase.path.isEmpty
+          ? try URL.metadatabase(
+            databasePath: "",
+            containerIdentifier: self.container.containerIdentifier
+          )
+          .lastPathComponent
+          : URL(filePath: metadatabase.path).lastPathComponent
+        let attachedMetadatabaseName =
+          URL(string: attachedMetadatabasePath)?.lastPathComponent ?? ""
+
+        try URL.metadatabase(
+          databasePath: attachedMetadatabasePath,
+          containerIdentifier: self.container.containerIdentifier
+        )
+        .lastPathComponent
+        if metadatabaseName != attachedMetadatabaseName {
           throw SchemaError(
             reason: .metadatabaseMismatch(
               attachedPath: attachedMetadatabasePath,
@@ -1917,6 +1931,7 @@
       databasePath: String,
       containerIdentifier: String?
     ) throws -> URL {
+      let databasePath = databasePath.isEmpty ? ":memory:" : databasePath
       guard let databaseURL = URL(string: databasePath)
       else {
         struct InvalidDatabasePath: Error {}
@@ -1927,9 +1942,9 @@
         return URL(string: "file:\(String.sqliteDataCloudKitSchemaName)?mode=memory&cache=shared")!
       }
       return
-        databaseURL
-        .deletingLastPathComponent()
-        .appending(component: ".\(databaseURL.deletingPathExtension().lastPathComponent)")
+        databaseURL.deletingLastPathComponent().appending(
+          component: ".\(databaseURL.deletingPathExtension().lastPathComponent)"
+        )
         .appendingPathExtension("metadata\(containerIdentifier.map { "-\($0)" } ?? "").sqlite")
     }
 
@@ -2022,12 +2037,16 @@
         databasePath: databasePath,
         containerIdentifier: containerIdentifier
       )
-      let path = url.path(percentEncoded: false)
+      let path = url.isInMemory ? url.absoluteString : url.path(percentEncoded: false)
       try FileManager.default.createDirectory(
         at: .applicationSupportDirectory,
         withIntermediateDirectories: true
       )
-      _ = try DatabasePool(path: path).write { db in
+      let database: any DatabaseWriter =
+        url.isInMemory
+        ? try DatabaseQueue(path: path)
+        : try DatabasePool(path: path)
+      _ = try database.write { db in
         try #sql("SELECT 1").execute(db)
       }
       try #sql(
@@ -2044,7 +2063,6 @@
     package struct SchemaError: LocalizedError {
       package enum Reason {
         case cycleDetected
-        case inMemoryDatabase
         case invalidForeignKey(ForeignKey)
         case invalidForeignKeyAction(ForeignKey)
         case invalidTableName(String)