cleanup

Author: stevensJourney

.github/workflows/test.yaml

@@ -23,7 +23,7 @@ jobs:
       - name: Check publish score
         run: |
           dart pub global activate pana
-          dart pub global run pana --no-warning --exit-code-threshold 10
+          dart pub global run pana --no-warning --exit-code-threshold 0
 
   test:
     runs-on: ubuntu-latest

README.md

@@ -1,4 +1,4 @@
-# sqlite_async 
+# sqlite_async
 
 High-performance asynchronous interface for SQLite on Dart & Flutter.
 
@@ -15,13 +15,13 @@ query access.
 
 ## Features
 
- * All operations are asynchronous by default - does not block the main isolate.
- * Watch a query to automatically re-run on changes to the underlying data.
- * Concurrent transactions supported by default - one write transaction and many multiple read transactions.
- * Uses WAL mode for fast writes and running read transactions concurrently with a write transaction.
- * Direct synchronous access in an isolate is supported for performance-sensitive use cases. 
- * Automatically convert query args to JSON where applicable, making JSON1 operations simple.
- * Direct SQL queries - no wrapper classes or code generation required.
+- All operations are asynchronous by default - does not block the main isolate.
+- Watch a query to automatically re-run on changes to the underlying data.
+- Concurrent transactions supported by default - one write transaction and many multiple read transactions.
+- Uses WAL mode for fast writes and running read transactions concurrently with a write transaction.
+- Direct synchronous access in an isolate is supported for performance-sensitive use cases.
+- Automatically convert query args to JSON where applicable, making JSON1 operations simple.
+- Direct SQL queries - no wrapper classes or code generation required.
 
 See this [blog post](https://www.powersync.co/blog/sqlite-optimizations-for-ultra-high-performance),
 explaining why these features are important for using SQLite.
@@ -78,18 +78,16 @@ void main() async {
 
 # Web
 
-Web support is provided by the [Drift](https://github.com/powersync-ja/drift/pull/1) library. Detailed instructions for compatibility and setup are listed in the link.
-
-Web support requires Sqlite3 WASM and Drift worker Javascript files to be accessible via configurable URIs.
+Web support requires Sqlite3 WASM and web worker Javascript files to be accessible via configurable URIs.
 
 Default URIs are shown in the example below. URIs only need to be specified if they differ from default values.
 
-Watched queries and table change notifications are only supported when using a custom Drift worker which is compiled by linking
-https://github.com/powersync-ja/drift/pull/1. 
+The compiled web worker files can be found in our Github [releases](https://github.com/powersync-ja/sqlite_async.dart/releases)
+The `sqlite3.wasm` asset can be found [here](https://github.com/simolus3/sqlite3.dart/releases)
 
 Setup
 
-``` Dart 
+```Dart
 import 'package:sqlite_async/sqlite_async.dart';
 
 final db = SqliteDatabase(
@@ -99,4 +97,3 @@ final db = SqliteDatabase(
             wasmUri: 'sqlite3.wasm', workerUri: 'db_worker.js')));
 
 ```
-

lib/src/web/web_mutex.dart

@@ -2,7 +2,7 @@ import 'package:mutex/mutex.dart' as mutex;
 import 'package:sqlite_async/src/common/mutex.dart';
 
 /// Web implementation of [Mutex]
-/// This will use `navigator.locks` in future
+/// This should use `navigator.locks` in future
 class MutexImpl implements Mutex {
   late final mutex.Mutex m;
 
@@ -12,12 +12,12 @@ class MutexImpl implements Mutex {
 
   @override
   Future<void> close() async {
-    // TODO
+    // This isn't relevant for web at the moment.
   }
 
   @override
   Future<T> lock<T>(Future<T> Function() callback, {Duration? timeout}) {
-    // TODO: use web navigator locks here
+    // Note this lock is only valid in a single web tab
     return m.protect(callback);
   }