Sync streams (#317)

Author: simolus3

demos/benchmarks/pubspec.lock

@@ -111,10 +111,10 @@ packages:
     dependency: "direct main"
     description:
       name: http
-      sha256: "2c11f3f94c687ee9bad77c171151672986360b2b001d109814ee7140b2cf261b"
+      sha256: bb2ce4590bc2667c96f318d68cac1b5a7987ec819351d32b1c987239a815e007
       url: "https://pub.dev"
     source: hosted
-    version: "1.4.0"
+    version: "1.5.0"
   http_parser:
     dependency: transitive
     description:
@@ -135,26 +135,26 @@ packages:
     dependency: transitive
     description:
       name: leak_tracker
-      sha256: "6bb818ecbdffe216e81182c2f0714a2e62b593f4a4f13098713ff1685dfb6ab0"
+      sha256: "8dcda04c3fc16c14f48a7bb586d4be1f0d1572731b6d81d51772ef47c02081e0"
       url: "https://pub.dev"
     source: hosted
-    version: "10.0.9"
+    version: "11.0.1"
   leak_tracker_flutter_testing:
     dependency: transitive
     description:
       name: leak_tracker_flutter_testing
-      sha256: f8b613e7e6a13ec79cfdc0e97638fddb3ab848452eff057653abd3edba760573
+      sha256: "1dbc140bb5a23c75ea9c4811222756104fbcd1a27173f0c34ca01e16bea473c1"
       url: "https://pub.dev"
     source: hosted
-    version: "3.0.9"
+    version: "3.0.10"
   leak_tracker_testing:
     dependency: transitive
     description:
       name: leak_tracker_testing
-      sha256: "6ba465d5d76e67ddf503e1161d1f4a6bc42306f9d66ca1e8f079a47290fb06d3"
+      sha256: "8d5a2d49f4a66b49744b23b018848400d23e54caf9463f4eb20df3eb8acb2eb1"
       url: "https://pub.dev"
     source: hosted
-    version: "3.0.1"
+    version: "3.0.2"
   lints:
     dependency: transitive
     description:
@@ -281,21 +281,21 @@ packages:
       path: "../../packages/powersync"
       relative: true
     source: path
-    version: "1.15.0"
+    version: "1.15.2"
   powersync_core:
     dependency: "direct overridden"
     description:
       path: "../../packages/powersync_core"
       relative: true
     source: path
-    version: "1.5.0"
+    version: "1.5.2"
   powersync_flutter_libs:
     dependency: "direct overridden"
     description:
       path: "../../packages/powersync_flutter_libs"
       relative: true
     source: path
-    version: "0.4.10"
+    version: "0.4.11"
   pub_semver:
     dependency: transitive
     description:
@@ -337,10 +337,10 @@ packages:
     dependency: transitive
     description:
       name: sqlite3
-      sha256: "310af39c40dd0bb2058538333c9d9840a2725ae0b9f77e4fd09ad6696aa8f66e"
+      sha256: f393d92c71bdcc118d6203d07c991b9be0f84b1a6f89dd4f7eed348131329924
       url: "https://pub.dev"
     source: hosted
-    version: "2.7.5"
+    version: "2.9.0"
   sqlite3_flutter_libs:
     dependency: transitive
     description:
@@ -353,18 +353,18 @@ packages:
     dependency: transitive
     description:
       name: sqlite3_web
-      sha256: "967e076442f7e1233bd7241ca61f3efe4c7fc168dac0f38411bdb3bdf471eb3c"
+      sha256: "0f6ebcb4992d1892ac5c8b5ecd22a458ab9c5eb6428b11ae5ecb5d63545844da"
       url: "https://pub.dev"
     source: hosted
-    version: "0.3.1"
+    version: "0.3.2"
   sqlite_async:
     dependency: "direct main"
     description:
       name: sqlite_async
-      sha256: a60e8d5c8df8e694933bd5a312c38393e79ad77d784bb91c6f38ba627bfb7aec
+      sha256: "6116bfc6aef6ce77730b478385ba4a58873df45721f6a9bc6ffabf39b6576e36"
       url: "https://pub.dev"
     source: hosted
-    version: "0.11.4"
+    version: "0.12.1"
   stack_trace:
     dependency: transitive
     description:
@@ -401,10 +401,10 @@ packages:
     dependency: transitive
     description:
       name: test_api
-      sha256: fb31f383e2ee25fbbfe06b40fe21e1e458d14080e3c67e7ba0acfde4df4e0bbd
+      sha256: "522f00f556e73044315fa4585ec3270f1808a4b186c936e612cab0b565ff1e00"
       url: "https://pub.dev"
     source: hosted
-    version: "0.7.4"
+    version: "0.7.6"
   typed_data:
     dependency: transitive
     description:
@@ -433,10 +433,10 @@ packages:
     dependency: transitive
     description:
       name: vector_math
-      sha256: "80b3257d1492ce4d091729e3a67a60407d227c27241d6927be0130c98e741803"
+      sha256: d530bd74fea330e6e364cda7a85019c434070188383e1cd8d9777ee586914c5b
       url: "https://pub.dev"
     source: hosted
-    version: "2.1.4"
+    version: "2.2.0"
   vm_service:
     dependency: transitive
     description:
@@ -470,5 +470,5 @@ packages:
     source: hosted
     version: "3.1.3"
 sdks:
-  dart: ">=3.7.0 <4.0.0"
+  dart: ">=3.8.0-0 <4.0.0"
   flutter: ">=3.27.0"

demos/django-todolist/lib/widgets/guard_by_sync.dart

@@ -7,9 +7,9 @@ import 'package:powersync_django_todolist_demo/powersync.dart';
 class GuardBySync extends StatelessWidget {
   final Widget child;
 
-  /// When set, wait only for a complete sync within the [BucketPriority]
+  /// When set, wait only for a complete sync within the [StreamPriority]
   /// instead of a full sync.
-  final BucketPriority? priority;
+  final StreamPriority? priority;
 
   const GuardBySync({
     super.key,

demos/supabase-todolist-drift/ios/Runner.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -47,18 +47,19 @@ Future<PowerSyncDatabase> powerSyncInstance(Ref ref) async {
   return db;
 }
 
-final _syncStatusInternal = StreamProvider((ref) {
+final _syncStatusInternal = StreamProvider<SyncStatus?>((ref) {
   return Stream.fromFuture(
     ref.watch(powerSyncInstanceProvider.future),
-  ).asyncExpand((db) => db.statusStream).startWith(const SyncStatus());
+  ).asyncExpand<SyncStatus?>((db) => db.statusStream).startWith(null);
 });
 
 final syncStatus = Provider((ref) {
+  // ignore: invalid_use_of_internal_member
   return ref.watch(_syncStatusInternal).value ?? const SyncStatus();
 });
 
 @riverpod
-bool didCompleteSync(Ref ref, [BucketPriority? priority]) {
+bool didCompleteSync(Ref ref, [StreamPriority? priority]) {
   final status = ref.watch(syncStatus);
   if (priority != null) {
     return status.statusForPriority(priority).hasSynced ?? false;

demos/supabase-todolist-drift/lib/powersync/powersync.dart

@@ -35,7 +35,7 @@ final class _ListsWidget extends ConsumerWidget {
   @override
   Widget build(BuildContext context, WidgetRef ref) {
     final lists = ref.watch(listsNotifierProvider);
-    final didSync = ref.watch(didCompleteSyncProvider(BucketPriority(1)));
+    final didSync = ref.watch(didCompleteSyncProvider(StreamPriority(1)));
 
     if (!didSync) {
       return const Text('Busy with sync...');

demos/supabase-todolist-drift/lib/screens/lists.dart

@@ -6,4 +6,7 @@ class AppConfig {
   static const String powersyncUrl = 'https://foo.powersync.journeyapps.com';
   static const String supabaseStorageBucket =
       ''; // Optional. Only required when syncing attachments and using Supabase Storage. See packages/powersync_attachments_helper.
+  // Whether the PowerSync instance uses sync streams to make fetching todo
+  // items optional.
+  static const bool hasSyncStreams = false;
 }

demos/supabase-todolist/lib/app_config_template.dart

@@ -7,9 +7,9 @@ import 'package:powersync_flutter_demo/powersync.dart';
 class GuardBySync extends StatelessWidget {
   final Widget child;
 
-  /// When set, wait only for a complete sync within the [BucketPriority]
+  /// When set, wait only for a complete sync within the [StreamPriority]
   /// instead of a full sync.
-  final BucketPriority? priority;
+  final StreamPriority? priority;
 
   const GuardBySync({
     super.key,

demos/supabase-todolist/lib/widgets/guard_by_sync.dart

@@ -0,0 +1,78 @@
+import 'package:flutter/material.dart';
+
+import '../powersync.dart';
+import './todo_list_page.dart';
+import '../models/todo_list.dart';
+
+/// A variant of the `ListItem` that only shows a summary of completed and
+/// pending items when the respective list has an active sync stream.
+class SyncStreamsAwareListItem extends StatelessWidget {
+  SyncStreamsAwareListItem({
+    required this.list,
+  }) : super(key: ObjectKey(list));
+
+  final TodoList list;
+
+  Future<void> delete() async {
+    // Server will take care of deleting related todos
+    await list.delete();
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    viewList() {
+      var navigator = Navigator.of(context);
+
+      navigator.push(
+          MaterialPageRoute(builder: (context) => TodoListPage(list: list)));
+    }
+
+    return StreamBuilder(
+      stream: db.statusStream,
+      initialData: db.currentStatus,
+      builder: (context, asyncSnapshot) {
+        final status = asyncSnapshot.requireData;
+        final stream =
+            status.forStream(db.syncStream('todos', {'list': list.id}));
+
+        String subtext;
+        if (stream == null || !stream.subscription.active) {
+          subtext = 'Items not loaded - click to fetch.';
+        } else {
+          subtext =
+              '${list.pendingCount} pending, ${list.completedCount} completed';
+        }
+
+        return Card(
+          child: Column(
+            mainAxisSize: MainAxisSize.min,
+            children: <Widget>[
+              ListTile(
+                onTap: viewList,
+                leading: const Icon(Icons.list),
+                title: Text(list.name),
+                subtitle: Text(subtext),
+              ),
+              Row(
+                mainAxisAlignment: MainAxisAlignment.end,
+                children: <Widget>[
+                  IconButton(
+                    iconSize: 30,
+                    icon: const Icon(
+                      Icons.delete,
+                      color: Colors.red,
+                    ),
+                    tooltip: 'Delete List',
+                    alignment: Alignment.centerRight,
+                    onPressed: delete,
+                  ),
+                  const SizedBox(width: 8),
+                ],
+              ),
+            ],
+          ),
+        );
+      },
+    );
+  }
+}

demos/supabase-todolist/lib/widgets/list_item_sync_stream.dart

@@ -1,11 +1,13 @@
 import 'package:flutter/material.dart';
 import 'package:powersync/powersync.dart';
 
+import '../app_config.dart';
 import './list_item.dart';
 import './list_item_dialog.dart';
 import '../main.dart';
 import '../models/todo_list.dart';
 import 'guard_by_sync.dart';
+import 'list_item_sync_stream.dart';
 
 void _showAddDialog(BuildContext context) async {
   return showDialog<void>(
@@ -55,7 +57,9 @@ class ListsWidget extends StatelessWidget {
             return ListView(
               padding: const EdgeInsets.symmetric(vertical: 8.0),
               children: todoLists.map((list) {
-                return ListItemWidget(list: list);
+                return AppConfig.hasSyncStreams
+                    ? SyncStreamsAwareListItem(list: list)
+                    : ListItemWidget(list: list);
               }).toList(),
             );
           } else {
@@ -66,5 +70,5 @@ class ListsWidget extends StatelessWidget {
     );
   }
 
-  static final _listsPriority = BucketPriority(1);
+  static final _listsPriority = StreamPriority(1);
 }