Enable SQLITE_ENABLE_SNAPSHOT by default and introduce SQLITE_DISABLE_SNAPSHOT

groue · groue · commit 361a482b1e8e · 2025-10-12T14:03:09.000+02:00
diff --git a/GRDB/Core/DatabasePool.swift b/GRDB/Core/DatabasePool.swift
@@ -684,7 +684,7 @@ extension DatabasePool: DatabaseReader {
     
     // MARK: - WAL Snapshot Transactions
     
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
     /// Returns a long-lived WAL snapshot transaction on a reader connection.
     func walSnapshotTransaction() throws -> WALSnapshotTransaction {
         guard let readerPool else {
@@ -950,7 +950,7 @@ extension DatabasePool {
             purpose: "snapshot.\(databaseSnapshotCountMutex.increment())")
     }
     
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
     /// Creates a database snapshot that allows concurrent accesses to an
     /// unchanging database content, as it exists at the moment the snapshot
     /// is created.
diff --git a/GRDB/Core/DatabaseSnapshotPool.swift b/GRDB/Core/DatabaseSnapshotPool.swift
@@ -1,4 +1,4 @@
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
 // Import C SQLite functions
 #if GRDBCIPHER // CocoaPods (SQLCipher subspec)
 import SQLCipher
diff --git a/GRDB/Core/WALSnapshot.swift b/GRDB/Core/WALSnapshot.swift
@@ -1,4 +1,4 @@
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
 // Import C SQLite functions
 #if GRDBCIPHER // CocoaPods (SQLCipher subspec)
 import SQLCipher
diff --git a/GRDB/Core/WALSnapshotTransaction.swift b/GRDB/Core/WALSnapshotTransaction.swift
@@ -1,4 +1,4 @@
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
 /// A long-live read-only WAL transaction.
 ///
 /// `WALSnapshotTransaction` **takes ownership** of its reader
diff --git a/GRDB/ValueObservation/Observers/ValueConcurrentObserver.swift b/GRDB/ValueObservation/Observers/ValueConcurrentObserver.swift
@@ -276,7 +276,7 @@ extension ValueConcurrentObserver {
     }
 }
 
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
 extension ValueConcurrentObserver {
     /// Synchronously starts the observation, and returns the initial value.
     ///
diff --git a/Package.swift b/Package.swift
@@ -14,8 +14,13 @@ let darwinPlatforms: [Platform] = [
 ]
 var swiftSettings: [SwiftSetting] = [
     .define("SQLITE_ENABLE_FTS5"),
-    // SQLite snapshots are available on the system SQLite on Darwin platforms.
-    .define("SQLITE_ENABLE_SNAPSHOT", .when(platforms: darwinPlatforms, traits: ["GRDBSQLite"])),
+    // Until Xcode has proper support for package traits, we must enable
+    // SQLITE_ENABLE_SNAPSHOT by default so that Xcode projects that build
+    // a Darwin app can depend on GRDB and profit from WAL snapshots.
+    // Package traits who want to disable snapshots must set SQLITE_DISABLE_SNAPSHOT.
+    // TODO: when Xcode support traits, remove all mentions of SQLITE_DISABLE_SNAPSHOT and update as below:
+    // .define("SQLITE_ENABLE_SNAPSHOT", .when(platforms: darwinPlatforms, traits: ["GRDBSQLite"])),
+    .define("SQLITE_ENABLE_SNAPSHOT"),
 ]
 var cSettings: [CSetting] = []
 var dependencies: [PackageDescription.Package.Dependency] = []
diff --git a/Tests/GRDBCombineTests/DatabaseReaderReadPublisherTests.swift b/Tests/GRDBCombineTests/DatabaseReaderReadPublisherTests.swift
@@ -40,7 +40,7 @@ class DatabaseReaderReadPublisherTests : XCTestCase {
         try Test(test).runAtTemporaryDatabasePath { try setUp(DatabaseQueue(path: $0)) }
         try Test(test).runAtTemporaryDatabasePath { try setUp(DatabasePool(path: $0)) }
         try Test(test).runAtTemporaryDatabasePath { try setUp(DatabasePool(path: $0)).makeSnapshot() }
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
         try Test(test).runAtTemporaryDatabasePath { try setUp(DatabasePool(path: $0)).makeSnapshotPool() }
 #endif
     }
@@ -141,7 +141,7 @@ class DatabaseReaderReadPublisherTests : XCTestCase {
         try Test(test).runAtTemporaryDatabasePath { try DatabaseQueue(path: $0) }
         try Test(test).runAtTemporaryDatabasePath { try DatabasePool(path: $0) }
         try Test(test).runAtTemporaryDatabasePath { try DatabasePool(path: $0).makeSnapshot() }
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
         try Test(test).runAtTemporaryDatabasePath { try DatabasePool(path: $0).makeSnapshotPool() }
 #endif
     }
@@ -177,7 +177,7 @@ class DatabaseReaderReadPublisherTests : XCTestCase {
         try Test(test).runAtTemporaryDatabasePath { try setUp(DatabaseQueue(path: $0)) }
         try Test(test).runAtTemporaryDatabasePath { try setUp(DatabasePool(path: $0)) }
         try Test(test).runAtTemporaryDatabasePath { try setUp(DatabasePool(path: $0)).makeSnapshot() }
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
         try Test(test).runAtTemporaryDatabasePath { try setUp(DatabasePool(path: $0)).makeSnapshotPool() }
 #endif
     }
@@ -213,7 +213,7 @@ class DatabaseReaderReadPublisherTests : XCTestCase {
         try Test(test).runAtTemporaryDatabasePath { try setUp(DatabaseQueue(path: $0)) }
         try Test(test).runAtTemporaryDatabasePath { try setUp(DatabasePool(path: $0)) }
         try Test(test).runAtTemporaryDatabasePath { try setUp(DatabasePool(path: $0)).makeSnapshot() }
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
         try Test(test).runAtTemporaryDatabasePath { try setUp(DatabasePool(path: $0)).makeSnapshotPool() }
 #endif
     }
@@ -250,7 +250,7 @@ class DatabaseReaderReadPublisherTests : XCTestCase {
         try Test(test).runAtTemporaryDatabasePath { try setUp(DatabaseQueue(path: $0)) }
         try Test(test).runAtTemporaryDatabasePath { try setUp(DatabasePool(path: $0)) }
         try Test(test).runAtTemporaryDatabasePath { try setUp(DatabasePool(path: $0)).makeSnapshot() }
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
         try Test(test).runAtTemporaryDatabasePath { try setUp(DatabasePool(path: $0)).makeSnapshotPool() }
 #endif
     }
@@ -274,7 +274,7 @@ class DatabaseReaderReadPublisherTests : XCTestCase {
         try Test(test).runAtTemporaryDatabasePath { try DatabaseQueue(path: $0) }
         try Test(test).runAtTemporaryDatabasePath { try DatabasePool(path: $0) }
         try Test(test).runAtTemporaryDatabasePath { try DatabasePool(path: $0).makeSnapshot() }
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
         try Test(test).runAtTemporaryDatabasePath { try DatabasePool(path: $0).makeSnapshotPool() }
 #endif
     }
diff --git a/Tests/GRDBTests/DatabaseAbortedTransactionTests.swift b/Tests/GRDBTests/DatabaseAbortedTransactionTests.swift
@@ -40,7 +40,7 @@ class DatabaseAbortedTransactionTests : GRDBTestCase {
         try test(makeDatabaseQueue())
         try test(makeDatabasePool())
         try test(makeDatabasePool().makeSnapshot())
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
         try test(makeDatabasePool().makeSnapshotPool())
 #endif
     }
@@ -85,7 +85,7 @@ class DatabaseAbortedTransactionTests : GRDBTestCase {
         try test(makeDatabaseQueue())
         try test(makeDatabasePool())
         try test(makeDatabasePool().makeSnapshot())
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
         try test(makeDatabasePool().makeSnapshotPool())
 #endif
     }
diff --git a/Tests/GRDBTests/DatabaseConfigurationTests.swift b/Tests/GRDBTests/DatabaseConfigurationTests.swift
@@ -27,7 +27,7 @@ class DatabaseConfigurationTests: GRDBTestCase {
         try pool.makeSnapshot().read { _ in }
         XCTAssertEqual(connectionCountMutex.load(), 5)
         
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
         try pool.makeSnapshotPool().read { _ in }
         XCTAssertEqual(connectionCountMutex.load(), 6)
 #endif
@@ -74,7 +74,7 @@ class DatabaseConfigurationTests: GRDBTestCase {
                 XCTFail("Expected TestError")
             } catch is TestError { }
             
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
             do {
                 errorMutex.store(TestError())
                 _ = try pool.makeSnapshotPool()
diff --git a/Tests/GRDBTests/DatabasePoolTests.swift b/Tests/GRDBTests/DatabasePoolTests.swift
@@ -53,7 +53,7 @@ class DatabasePoolTests: GRDBTestCase {
             XCTAssertTrue(fm.fileExists(atPath: dbPool.path + "-wal"))
             XCTAssertTrue(fm.fileExists(atPath: dbPool.path + "-shm"))
 
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
             // A non-empty wal file makes sure ValueObservation can use wal snapshots.
             // See <https://github.com/groue/GRDB.swift/issues/1383>
             let walURL = URL(fileURLWithPath: dbPool.path + "-wal")
@@ -77,7 +77,7 @@ class DatabasePoolTests: GRDBTestCase {
                 XCTAssertTrue(fm.fileExists(atPath: dbPool.path + "-wal"))
                 XCTAssertTrue(fm.fileExists(atPath: dbPool.path + "-shm"))
                 
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
                 // A non-empty wal file makes sure ValueObservation can use wal snapshots.
                 // See <https://github.com/groue/GRDB.swift/issues/1383>
                 let walURL = URL(fileURLWithPath: dbPool.path + "-wal")
@@ -103,7 +103,7 @@ class DatabasePoolTests: GRDBTestCase {
                 XCTAssertTrue(fm.fileExists(atPath: dbPool.path + "-wal"))
                 XCTAssertTrue(fm.fileExists(atPath: dbPool.path + "-shm"))
                 
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
                 // A non-empty wal file makes sure ValueObservation can use wal snapshots.
                 // See <https://github.com/groue/GRDB.swift/issues/1383>
                 let walURL = URL(fileURLWithPath: dbPool.path + "-wal")
@@ -126,7 +126,7 @@ class DatabasePoolTests: GRDBTestCase {
             XCTAssertTrue(fm.fileExists(atPath: dbPool.path + "-wal"))
             XCTAssertTrue(fm.fileExists(atPath: dbPool.path + "-shm"))
             
-#if SQLITE_ENABLE_SNAPSHOT
+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
             // A non-empty wal file makes sure ValueObservation can use wal snapshots.
             // See <https://github.com/groue/GRDB.swift/issues/1383>
             let walURL = URL(fileURLWithPath: dbPool.path + "-wal")
diff --git a/Tests/GRDBTests/DatabaseReaderTests.swift b/Tests/GRDBTests/DatabaseReaderTests.swift
diff --git a/Tests/GRDBTests/DatabaseSnapshotPoolTests.swift b/Tests/GRDBTests/DatabaseSnapshotPoolTests.swift
diff --git a/Tests/GRDBTests/ValueObservationPrintTests.swift b/Tests/GRDBTests/ValueObservationPrintTests.swift
diff --git a/Tests/GRDBTests/ValueObservationTests.swift b/Tests/GRDBTests/ValueObservationTests.swift

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#if SQLITE_ENABLE_SNAPSHOT`
	`1`	`+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT`
`2`	`2`	`// Import C SQLite functions`
`3`	`3`	`#if GRDBCIPHER // CocoaPods (SQLCipher subspec)`
`4`	`4`	`import SQLCipher`
Original file line number	Diff line number	Diff line change
`@@ -276,7 +276,7 @@ extension ValueConcurrentObserver {`
`276`	`276`	`}`
`277`	`277`	`}`
`278`	`278`
`279`		`-#if SQLITE_ENABLE_SNAPSHOT`
	`279`	`+#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT`
`280`	`280`	`extension ValueConcurrentObserver {`
`281`	`281`	`/// Synchronously starts the observation, and returns the initial value.`
`282`	`282`	`///`