Start adopting Dart 3 for new WASM VFS features

Author: simolus3

sqlite3/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.0.0-dev
+
+- __Breaking__: The WASM implementation no longer registers a default virtual
+  file system. Instead, `registerVirtualFileSystem` needs to be used to add
+  desired file system implementations.
+
+
 ## 1.11.1
 
 - Fix user-defined functions returning text not supporting multi-byte utf8

sqlite3/analysis_options.yaml

@@ -4,8 +4,3 @@ analyzer:
   language:
     strict-casts: true
     strict-raw-types: true
-
-linter:
-  rules:
-    # We already enable `parameter_assignments`, so this doesn't provide much value.
-    prefer_final_parameters: false

sqlite3/assets/wasm/sqlite_cfg.h

@@ -3,8 +3,10 @@
 // Don't include the default VFS implementations, we write our own
 #define SQLITE_OS_OTHER 1
 
-// Don't include locking code
+// Don't include locking code and WAL which require multiple threads to access
+// the same WASM module, something we can't do
 #define SQLITE_THREADSAFE 0
+#define SQLITE_OMIT_WAL 1
 
 // Our implementation of temporary files is also entirely in-memory,
 // so there really is no point in using temp files.
@@ -20,6 +22,10 @@
 #define SQLITE_USE_ALLOCA 1
 #define SQLITE_BYTEORDER 1234
 
+// This apparently improves performance: https://github.com/sqlite/sqlite/blob/b8d689b6668437e220fa329300e0541ff64e4ef6/ext/wasm/api/sqlite3-wasm.c#L57-L77
+#define SQLITE_DEFAULT_CACHE_SIZE -16384
+#define SQLITE_DEFAULT_PAGE_SIZE 8192
+
 // We have them, so we may as well let sqlite3 use them?
 #define HAVE_ISNAN 1
 #define HAVE_LOCALTIME_R 1

sqlite3/lib/src/ffi/sqlite3.g.dart

@@ -1183,16 +1183,16 @@ class Bindings {
       .asFunction<int Function(ffi.Pointer<ffi.Void>)>();
 }
 
-class sqlite3_char extends ffi.Opaque {}
+final class sqlite3_char extends ffi.Opaque {}
 
-class sqlite3 extends ffi.Opaque {}
+final class sqlite3 extends ffi.Opaque {}
 
-class sqlite3_stmt extends ffi.Opaque {}
+final class sqlite3_stmt extends ffi.Opaque {}
 
-class sqlite3_backup extends ffi.Opaque {}
+final class sqlite3_backup extends ffi.Opaque {}
 
-class sqlite3_api_routines extends ffi.Opaque {}
+final class sqlite3_api_routines extends ffi.Opaque {}
 
-class sqlite3_value extends ffi.Opaque {}
+final class sqlite3_value extends ffi.Opaque {}
 
-class sqlite3_context extends ffi.Opaque {}
+final class sqlite3_context extends ffi.Opaque {}

sqlite3/lib/src/vfs.dart

@@ -39,7 +39,7 @@ class Sqlite3Filename {
 /// consider extending [BaseVirtualFileSystem].
 ///
 /// [vfs]: https://www.sqlite.org/c3ref/vfs.html
-abstract class VirtualFileSystem {
+abstract base class VirtualFileSystem {
   /// The name of this virtual file system.
   ///
   /// This can be passed as an URI parameter when opening databases to select
@@ -78,18 +78,12 @@ abstract class VirtualFileSystem {
 }
 
 /// The result of [VirtualFileSystem.xOpen].
-class XOpenResult {
-  final int outFlags;
-  final VirtualFileSystemFile file;
-
-  XOpenResult({required this.outFlags, required this.file});
-  // todo: Turn into record
-}
+typedef XOpenResult = ({int outFlags, VirtualFileSystemFile file});
 
 /// A file implemented by a VFS author and returned by [VirtualFileSystem.xOpen].
 ///
 /// To avoid common pitfalls, consider extending [BaseVfsFile] instead.
-abstract class VirtualFileSystemFile {
+abstract interface class VirtualFileSystemFile {
   /// Close this file.
   void xClose();
 
@@ -137,7 +131,7 @@ abstract class VirtualFileSystemFile {
 
 /// A [VirtualFileSystem] implementation that uses a [Random] instance for
 /// [xRandomness] and [DateTime.now] for [xCurrentTime].
-abstract class BaseVirtualFileSystem extends VirtualFileSystem {
+abstract base class BaseVirtualFileSystem extends VirtualFileSystem {
   final Random random;
 
   BaseVirtualFileSystem({Random? random, required String name})

sqlite3/lib/src/wasm/vfs/async_opfs/client.dart

@@ -12,7 +12,7 @@ import '../utils.dart';
 import 'sync_channel.dart';
 import 'worker.dart';
 
-class WasmVfs extends BaseVirtualFileSystem {
+final class WasmVfs extends BaseVirtualFileSystem {
   final RequestResponseSynchronizer synchronizer;
   final MessageSerializer serializer;
 
@@ -72,7 +72,7 @@ class WasmVfs extends BaseVirtualFileSystem {
 
     final outFlags = result.flag0;
     final fd = result.flag1;
-    return XOpenResult(outFlags: outFlags, file: WasmFile(this, fd));
+    return (outFlags: outFlags, file: WasmFile(this, fd));
   }
 
   @override

sqlite3/lib/src/wasm/vfs/async_opfs/worker.dart

@@ -89,8 +89,7 @@ class VfsWorker {
   Future<_ResolvedPath> _resolvePath(String absolutePath,
       {bool createDirectories = false}) async {
     final fullPath = p.url.relative(absolutePath, from: '/');
-    final directories = p.url.split(fullPath);
-    final file = directories.removeLast();
+    final [...directories, file] = p.url.split(fullPath);
 
     var dirHandle = root;
     for (final entry in directories) {

sqlite3/lib/src/wasm/vfs/indexed_db.dart

@@ -401,7 +401,7 @@ class _OffsetAndBuffer {
 ///
 /// In the future, we may want to store individual blocks instead.
 
-class IndexedDbFileSystem extends BaseVirtualFileSystem {
+final class IndexedDbFileSystem extends BaseVirtualFileSystem {
   final AsynchronousIndexedDbFileSystem _asynchronous;
 
   var _isClosing = false;
@@ -567,8 +567,10 @@ class IndexedDbFileSystem extends BaseVirtualFileSystem {
       }
     }
 
-    return XOpenResult(
-        outFlags: 0, file: _IndexedDbFile(this, inMemoryFile.file, pathStr));
+    return (
+      outFlags: 0,
+      file: _IndexedDbFile(this, inMemoryFile.file, pathStr),
+    );
   }
 
   @override
@@ -577,7 +579,7 @@ class IndexedDbFileSystem extends BaseVirtualFileSystem {
   }
 }
 
-class _IndexedDbFile extends VirtualFileSystemFile {
+class _IndexedDbFile implements VirtualFileSystemFile {
   final IndexedDbFileSystem vfs;
   final VirtualFileSystemFile memoryFile;
   final String path;
@@ -643,7 +645,7 @@ class _IndexedDbFile extends VirtualFileSystemFile {
   }
 }
 
-abstract class _IndexedDbWorkItem with LinkedListEntry<_IndexedDbWorkItem> {
+sealed class _IndexedDbWorkItem extends LinkedListEntry<_IndexedDbWorkItem> {
   final Completer<void> completer = Completer.sync();
 
   /// Insert this item into the [pending] list, returning whether the item was
@@ -664,7 +666,7 @@ abstract class _IndexedDbWorkItem with LinkedListEntry<_IndexedDbWorkItem> {
   FutureOr<void> run();
 }
 
-class _FunctionWorkItem extends _IndexedDbWorkItem {
+final class _FunctionWorkItem extends _IndexedDbWorkItem {
   final FutureOr<void> Function() work;
   final String description;
 
@@ -674,7 +676,7 @@ class _FunctionWorkItem extends _IndexedDbWorkItem {
   FutureOr<void> run() => work();
 }
 
-class _DeleteFileWorkItem extends _IndexedDbWorkItem {
+final class _DeleteFileWorkItem extends _IndexedDbWorkItem {
   final IndexedDbFileSystem fileSystem;
   final String path;
 
@@ -737,7 +739,7 @@ class _DeleteFileWorkItem extends _IndexedDbWorkItem {
   }
 }
 
-class _CreateFileWorkItem extends _IndexedDbWorkItem {
+final class _CreateFileWorkItem extends _IndexedDbWorkItem {
   final IndexedDbFileSystem fileSystem;
   final String path;
 
@@ -750,7 +752,7 @@ class _CreateFileWorkItem extends _IndexedDbWorkItem {
   }
 }
 
-class _WriteFileWorkItem extends _IndexedDbWorkItem {
+final class _WriteFileWorkItem extends _IndexedDbWorkItem {
   final IndexedDbFileSystem fileSystem;
   final String path;
 

sqlite3/lib/src/wasm/vfs/memory.dart

@@ -7,7 +7,7 @@ import '../../constants.dart';
 import '../../vfs.dart';
 import 'utils.dart';
 
-class InMemoryFileSystem extends BaseVirtualFileSystem {
+final class InMemoryFileSystem extends BaseVirtualFileSystem {
   final Map<String, Uint8List?> fileData = {};
 
   InMemoryFileSystem({super.name = 'dart-memory', super.random});
@@ -40,7 +40,7 @@ class InMemoryFileSystem extends BaseVirtualFileSystem {
       }
     }
 
-    return XOpenResult(
+    return (
       outFlags: 0,
       file: _InMemoryFile(
         this,

sqlite3/lib/src/wasm/vfs/simple_opfs.dart

@@ -40,7 +40,7 @@ enum FileType {
 /// not in the JavaScript context for a tab or a shared web worker.
 ///
 /// [file system access API]: https://developer.mozilla.org/en-US/docs/Web/API/File_System_Access_API
-class SimpleOpfsFileSystem extends BaseVirtualFileSystem {
+final class SimpleOpfsFileSystem extends BaseVirtualFileSystem {
   // The storage idea here is to open sync file handles at the beginning, so
   // that no new async open needs to happen when these callbacks are invoked by
   // sqlite3.
@@ -162,7 +162,7 @@ class SimpleOpfsFileSystem extends BaseVirtualFileSystem {
       }
     }
 
-    return XOpenResult(
+    return (
       outFlags: 0,
       file: _SimpleOpfsFile(this, recognized, syncHandle, deleteOnClose),
     );

sqlite3/pubspec.yaml

@@ -32,7 +32,7 @@ dev_dependencies:
   build_daemon: ^4.0.0
   build_runner: ^2.1.7
   build_web_compilers: ^4.0.3
-  ffigen: ^7.0.0
+  ffigen: ^8.0.1
   http: ^0.13.4
   lints: ^2.0.1
   shelf: ^1.4.0