Support latest version of package:web in drift adapter (#65)

* Support latest version of package:web in drift adapter

* Avoid using internal drift APIs

* complement test

* changelog

---------

Co-authored-by: Simon Binder <[email protected]>

Author: davidmartos96

packages/drift_sqlite_async/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.2.0-alpha.1
+
+ - Support `drift` version >=2.19 and `web` 1.0.0
+ - BREAKING CHANGE: Nested transactions through drift no longer create SAVEPOINTs. When nesting a drift `transaction`, the transaction is reused. See https://github.com/powersync-ja/sqlite_async.dart/pull/65
+
 ## 0.1.0-alpha.7
 
  - Update a dependency to the latest release.

packages/drift_sqlite_async/lib/src/executor.dart

@@ -1,15 +1,24 @@
 import 'dart:async';
 
 import 'package:drift/backends.dart';
-import 'package:drift_sqlite_async/src/transaction_executor.dart';
+import 'package:drift/src/runtime/query_builder/query_builder.dart';
 import 'package:sqlite_async/sqlite3_common.dart';
 import 'package:sqlite_async/sqlite_async.dart';
 
-class _SqliteAsyncDelegate extends DatabaseDelegate {
+// Ends with " RETURNING *", or starts with insert/update/delete.
+// Drift-generated queries will always have the RETURNING *.
+// The INSERT/UPDATE/DELETE check is for custom queries, and is not exhaustive.
+final _returningCheck = RegExp(r'( RETURNING \*;?$)|(^(INSERT|UPDATE|DELETE))',
+    caseSensitive: false);
+
+class _SqliteAsyncDelegate extends _SqliteAsyncQueryDelegate
+    implements DatabaseDelegate {
   final SqliteConnection db;
   bool _closed = false;
 
-  _SqliteAsyncDelegate(this.db);
+  _SqliteAsyncDelegate(this.db) : super(db, db.writeLock);
+
+  bool isInTransaction = false; // unused
 
   @override
   late final DbVersionDelegate versionDelegate =
@@ -18,18 +27,11 @@ class _SqliteAsyncDelegate extends DatabaseDelegate {
   // Not used - we override beginTransaction() with SqliteAsyncTransactionExecutor for more control.
   @override
   late final TransactionDelegate transactionDelegate =
-      const NoTransactionDelegate();
+      _SqliteAsyncTransactionDelegate(db);
 
   @override
   bool get isOpen => !db.closed && !_closed;
 
-  // Ends with " RETURNING *", or starts with insert/update/delete.
-  // Drift-generated queries will always have the RETURNING *.
-  // The INSERT/UPDATE/DELETE check is for custom queries, and is not exhaustive.
-  final _returningCheck = RegExp(
-      r'( RETURNING \*;?$)|(^(INSERT|UPDATE|DELETE))',
-      caseSensitive: false);
-
   @override
   Future<void> open(QueryExecutorUser user) async {
     // Workaround - this ensures the db is open
@@ -42,9 +44,30 @@ class _SqliteAsyncDelegate extends DatabaseDelegate {
     _closed = true;
   }
 
+  @override
+  void notifyDatabaseOpened(OpeningDetails details) {
+    // Unused
+  }
+}
+
+class _SqliteAsyncQueryDelegate extends QueryDelegate {
+  final SqliteWriteContext _context;
+  final Future<T> Function<T>(
+      Future<T> Function(SqliteWriteContext tx) callback)? _writeLock;
+
+  _SqliteAsyncQueryDelegate(this._context, this._writeLock);
+
+  Future<T> writeLock<T>(Future<T> Function(SqliteWriteContext tx) callback) {
+    if (_writeLock case var writeLock?) {
+      return writeLock.call(callback);
+    } else {
+      return callback(_context);
+    }
+  }
+
   @override
   Future<void> runBatched(BatchedStatements statements) async {
-    return db.writeLock((tx) async {
+    return writeLock((tx) async {
       // sqlite_async's batch functionality doesn't have enough flexibility to support
       // this with prepared statements yet.
       for (final arg in statements.arguments) {
@@ -56,12 +79,12 @@ class _SqliteAsyncDelegate extends DatabaseDelegate {
 
   @override
   Future<void> runCustom(String statement, List<Object?> args) {
-    return db.execute(statement, args);
+    return _context.execute(statement, args);
   }
 
   @override
   Future<int> runInsert(String statement, List<Object?> args) async {
-    return db.writeLock((tx) async {
+    return writeLock((tx) async {
       await tx.execute(statement, args);
       final row = await tx.get('SELECT last_insert_rowid() as row_id');
       return row['row_id'];
@@ -77,24 +100,38 @@ class _SqliteAsyncDelegate extends DatabaseDelegate {
       // This takes write lock, so we want to avoid it for plain select statements.
       // This is not an exhaustive check, but should cover all Drift-generated queries using
       // `runSelect()`.
-      result = await db.execute(statement, args);
+      result = await _context.execute(statement, args);
     } else {
       // Plain SELECT statement - use getAll() to avoid using a write lock.
-      result = await db.getAll(statement, args);
+      result = await _context.getAll(statement, args);
     }
     return QueryResult(result.columnNames, result.rows);
   }
 
   @override
   Future<int> runUpdate(String statement, List<Object?> args) {
-    return db.writeLock((tx) async {
+    return writeLock((tx) async {
       await tx.execute(statement, args);
       final row = await tx.get('SELECT changes() as changes');
       return row['changes'];
     });
   }
 }
 
+class _SqliteAsyncTransactionDelegate extends SupportedTransactionDelegate {
+  final SqliteConnection _db;
+
+  _SqliteAsyncTransactionDelegate(this._db);
+
+  @override
+  Future<void> startTransaction(Future Function(QueryDelegate p1) run) async {
+    await _db.writeTransaction((context) async {
+      final delegate = _SqliteAsyncQueryDelegate(context, null);
+      return run(delegate);
+    });
+  }
+}
+
 class _SqliteAsyncVersionDelegate extends DynamicVersionDelegate {
   final SqliteConnection _db;
 
@@ -137,9 +174,4 @@ class SqliteAsyncQueryExecutor extends DelegatedDatabase {
 
   @override
   bool get isSequential => false;
-
-  @override
-  TransactionExecutor beginTransaction() {
-    return SqliteAsyncTransactionExecutor(db);
-  }
 }

packages/drift_sqlite_async/lib/src/transaction_executor.dart

@@ -1,5 +1,5 @@
 name: drift_sqlite_async
-version: 0.1.0-alpha.7
+version: 0.2.0-alpha.1
 homepage: https://github.com/powersync-ja/sqlite_async.dart
 repository: https://github.com/powersync-ja/sqlite_async.dart
 description: Use Drift with a sqlite_async database, allowing both to be used in the same application.
@@ -14,11 +14,11 @@ topics:
 environment:
   sdk: ">=3.0.0 <4.0.0"
 dependencies:
-  drift: ">=2.15.0 <2.19.0"
+  drift: ">=2.19.0 <3.0.0"
   sqlite_async: ^0.9.0
 dev_dependencies:
   build_runner: ^2.4.8
-  drift_dev: ">=2.15.0 <2.19.0"
+  drift_dev: ">=2.19.0 <3.0.0"
   glob: ^2.1.2
   sqlite3: ^2.4.0
   test: ^1.25.2

packages/drift_sqlite_async/pubspec.yaml

@@ -129,6 +129,13 @@ void main() {
         // This runs outside the transaction
         expect(await db.get('select count(*) as count from test_data'),
             equals({'count': 0}));
+
+        // This runs in the transaction
+        final countInTransaction = (await dbu
+                .customSelect('select count(*) as count from test_data')
+                .getSingle())
+            .data;
+        expect(countInTransaction, equals({'count': 2}));
       });
 
       expect(await db.get('select count(*) as count from test_data'),
@@ -172,7 +179,7 @@ void main() {
             {'description': 'Test 1'},
             {'description': 'Test 3'}
           ]));
-    });
+    }, skip: 'sqlite_async does not support nested transactions');
 
     test('Concurrent select', () async {
       var completer1 = Completer<void>();