chore(attachments): minor improvements and fix loop (#70)

* chore(attachments): minor improvements

* docs: update changelog

* chore: pr reverts

---------

Co-authored-by: DominicGBauer <dominic@nomanini.com>

Author: DominicGBauer

demos/supabase-todolist/pubspec.lock

@@ -429,7 +429,7 @@ packages:
       path: "../../packages/powersync_attachments_helper"
       relative: true
     source: path
-    version: "0.3.0"
+    version: "0.3.1"
   realtime_client:
     dependency: transitive
     description:

packages/powersync_attachments_helper/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.3.1
+
+- Add periodic syncing and deleting of attachments
+- Remove unnecessary delete
+- Fix loop
+
 ## 0.3.0
 
 - BREAKING CHANGE: `reconcileId` has been removed in favour of `reconcileIds`. This will require a change to `watchIds` implementation which is shown in `example/getting_started.dart`

packages/powersync_attachments_helper/lib/src/attachments_queue.dart

@@ -33,14 +33,18 @@ abstract class AbstractAttachmentQueue {
   /// Return true if you want to ignore attachment
   Future<bool> Function(Attachment attachment, Object exception)? onUploadError;
 
+  /// Interval in minutes to periodically run [syncingService.startPeriodicSync]
+  /// Default is 5 minutes
+  int intervalInMinutes;
+
   AbstractAttachmentQueue(
       {required this.db,
       required this.remoteStorage,
       this.attachmentDirectoryName = 'attachments',
       this.attachmentsQueueTableName = defaultAttachmentsQueueTableName,
       this.onDownloadError,
       this.onUploadError,
-      performInitialSync = true}) {
+      this.intervalInMinutes = 5}) {
     attachmentsService = AttachmentsService(
         db, localStorage, attachmentDirectoryName, attachmentsQueueTableName);
     syncingService = SyncingService(
@@ -68,6 +72,7 @@ abstract class AbstractAttachmentQueue {
 
     watchIds();
     syncingService.watchAttachments();
+    syncingService.startPeriodicSync(intervalInMinutes);
 
     db.statusStream.listen((status) {
       if (db.currentStatus.connected) {

packages/powersync_attachments_helper/lib/src/attachments_service.dart

@@ -93,10 +93,6 @@ class AttachmentsService {
       (id, filename, local_uri, media_type, size, timestamp, state) VALUES (?, ?, ?, ?, ?, ?, ?)
     ''', updatedRecords);
 
-    await db.executeBatch('''
-      DELETE FROM $table WHERE id = ?
-    ''', ids);
-
     return;
   }
 

packages/powersync_attachments_helper/lib/src/syncing_service.dart

@@ -20,6 +20,7 @@ class SyncingService {
   final Future<bool> Function(Attachment attachment, Object exception)?
       onUploadError;
   bool isProcessing = false;
+  Timer? timer;
 
   SyncingService(this.db, this.remoteStorage, this.localStorage,
       this.attachmentsService, this.getLocalUri,
@@ -166,8 +167,7 @@ class SyncingService {
       bool fileExists = await file.exists();
 
       if (fileExists) {
-        log.info('ignore file $id.$fileExtension as it already exists');
-        return;
+        continue;
       }
 
       log.info('Adding $id to queue');
@@ -179,4 +179,24 @@ class SyncingService {
 
     await attachmentsService.saveAttachments(attachments);
   }
+
+  /// Delete attachments which have been archived
+  deleteArchivedAttachments() async {
+    await db.execute('''
+      DELETE FROM ${attachmentsService.table}
+      WHERE state = ${AttachmentState.archived.index}
+    ''');
+  }
+
+  /// Periodically sync attachments and delete archived attachments
+  void startPeriodicSync(int intervalInMinutes) {
+    timer?.cancel();
+
+    timer = Timer.periodic(Duration(minutes: intervalInMinutes), (timer) {
+      log.info('Syncing attachments');
+      runSync();
+      log.info('Deleting archived attachments');
+      deleteArchivedAttachments();
+    });
+  }
 }

packages/powersync_attachments_helper/pubspec.yaml

@@ -1,6 +1,6 @@
 name: powersync_attachments_helper
 description: A helper library for handling attachments when using PowerSync.
-version: 0.3.0
+version: 0.3.1
 repository: https://github.com/powersync-ja/powersync.dart
 homepage: https://www.powersync.com/
 environment:
@@ -12,7 +12,7 @@ dependencies:
 
   powersync: ^1.2.2
   logging: ^1.2.0
-  sqlite_async: ^0.6.0
+  sqlite_async: ^0.6.1
   path_provider: ^2.1.2
 
 dev_dependencies: