Skip to content

High performance self-hosted photo and video management solution.

feat: websocket background sync (#19888)

Alex59e7754bdce0
diff --git a/mobile/lib/domain/services/sync_stream.service.dart b/mobile/lib/domain/services/sync_stream.service.dart
index 48cf318a8b..6183865041 100644
--- a/mobile/lib/domain/services/sync_stream.service.dart
+++ b/mobile/lib/domain/services/sync_stream.service.dart
@@ -31,6 +31,59 @@ class SyncStreamService {
return _syncApiRepository.streamChanges(_handleEvents);
}
+ Future<void> handleWsAssetUploadReadyV1Batch(List<dynamic> batchData) async {
+ if (batchData.isEmpty) return;
+
+ _logger.info(
+ 'Processing batch of ${batchData.length} AssetUploadReadyV1 events',
+ );
+
+ final List<SyncAssetV1> assets = [];
+ final List<SyncAssetExifV1> exifs = [];
+
+ try {
+ for (final data in batchData) {
+ if (data is! Map<String, dynamic>) {
+ continue;
+ }
+
+ final payload = data;
+ final assetData = payload['asset'];
+ final exifData = payload['exif'];
+
+ if (assetData == null || exifData == null) {
+ continue;
+ }
+
+ final asset = SyncAssetV1.fromJson(assetData);
+ final exif = SyncAssetExifV1.fromJson(exifData);
+
+ if (asset != null && exif != null) {
+ assets.add(asset);
+ exifs.add(exif);
+ }
+ }
+
+ if (assets.isNotEmpty && exifs.isNotEmpty) {
+ await _syncStreamRepository.updateAssetsV1(
+ assets,
+ debugLabel: 'websocket-batch',
+ );
+ await _syncStreamRepository.updateAssetsExifV1(
+ exifs,
+ debugLabel: 'websocket-batch',
+ );
+ _logger.info('Successfully processed ${assets.length} assets in batch');
+ }
+ } catch (error, stackTrace) {
+ _logger.severe(
+ "Error processing AssetUploadReadyV1 websocket batch events",
+ error,
+ stackTrace,
+ );
+ }
+ }
+
Future<void> _handleEvents(List<SyncEvent> events, Function() abort) async {
List<SyncEvent> items = [];
for (final event in events) {
diff --git a/mobile/lib/domain/utils/background_sync.dart b/mobile/lib/domain/utils/background_sync.dart
index c8d2e2b624..c71f1a8315 100644
--- a/mobile/lib/domain/utils/background_sync.dart
+++ b/mobile/lib/domain/utils/background_sync.dart
@@ -6,6 +6,7 @@ import 'package:worker_manager/worker_manager.dart';
class BackgroundSyncManager {
Cancelable<void>? _syncTask;
+ Cancelable<void>? _syncWebsocketTask;
Cancelable<void>? _deviceAlbumSyncTask;
Cancelable<void>? _hashTask;
@@ -20,6 +21,12 @@ class BackgroundSyncManager {
_syncTask?.cancel();
_syncTask = null;
+ if (_syncWebsocketTask != null) {
+ futures.add(_syncWebsocketTask!.future);
+ }
+ _syncWebsocketTask?.cancel();
+ _syncWebsocketTask = null;
+
return Future.wait(futures);
}
@@ -72,4 +79,19 @@ class BackgroundSyncManager {
_syncTask = null;
});
}
+
+ Future<void> syncWebsocketBatch(List<dynamic> batchData) {
+ if (_syncWebsocketTask != null) {
+ return _syncWebsocketTask!.future;
+ }
+
+ _syncWebsocketTask = runInIsolateGentle(
+ computation: (ref) => ref
+ .read(syncStreamServiceProvider)
+ .handleWsAssetUploadReadyV1Batch(batchData),
+ );
+ return _syncWebsocketTask!.whenComplete(() {
+ _syncWebsocketTask = null;
+ });
+ }
}
diff --git a/mobile/lib/providers/websocket.provider.dart b/mobile/lib/providers/websocket.provider.dart
index 2600c6d8ee..d9db831776 100644
--- a/mobile/lib/providers/websocket.provider.dart
+++ b/mobile/lib/providers/websocket.provider.dart
@@ -1,3 +1,4 @@
+import 'dart:async';
import 'dart:convert';
import 'package:collection/collection.dart';
@@ -10,6 +11,7 @@ import 'package:immich_mobile/entities/store.entity.dart';
import 'package:immich_mobile/models/server_info/server_version.model.dart';
import 'package:immich_mobile/providers/asset.provider.dart';
import 'package:immich_mobile/providers/auth.provider.dart';
+import 'package:immich_mobile/providers/background_sync.provider.dart';
import 'package:immich_mobile/providers/db.provider.dart';
import 'package:immich_mobile/providers/server_info.provider.dart';
import 'package:immich_mobile/services/api.service.dart';
@@ -106,6 +108,18 @@ class WebsocketNotifier extends StateNotifier<WebsocketState> {
final Debouncer _debounce =
Debouncer(interval: const Duration(milliseconds: 500));
+ final Debouncer _batchDebouncer = Debouncer(
+ interval: const Duration(seconds: 5),
+ maxWaitTime: const Duration(seconds: 10),
+ );
+ final List<dynamic> _batchedAssetUploadReady = [];
+
+ @override
+ void dispose() {
+ _batchDebouncer.dispose();
+ super.dispose();
+ }
+
/// Connects websocket to server unless already connected
void connect() {
if (state.isConnected) return;
@@ -171,6 +185,7 @@ class WebsocketNotifier extends StateNotifier<WebsocketState> {
socket.on('on_asset_stack_update', _handleServerUpdates);
socket.on('on_asset_hidden', _handleOnAssetHidden);
socket.on('on_new_release', _handleReleaseUpdates);
+ socket.on('AssetUploadReadyV1', _handleSyncAssetUploadReady);
} catch (e) {
debugPrint("[WEBSOCKET] Catch Websocket Error - ${e.toString()}");
}
@@ -180,6 +195,8 @@ class WebsocketNotifier extends StateNotifier<WebsocketState> {
void disconnect() {
debugPrint("Attempting to disconnect from websocket");
+ _batchedAssetUploadReady.clear();
+
var socket = state.socket?.disconnect();
if (socket?.disconnected == true) {
@@ -288,7 +305,7 @@ class WebsocketNotifier extends StateNotifier<WebsocketState> {
}
}
- void handlePendingChanges() async {
+ Future<void> handlePendingChanges() async {
await _handlePendingUploaded();
await _handlePendingDeletes();
await _handlingPendingHidden();
@@ -347,6 +364,29 @@ class WebsocketNotifier extends StateNotifier<WebsocketState> {
.read(serverInfoProvider.notifier)
.handleNewRelease(serverVersion, releaseVersion);
}
+
+ void _handleSyncAssetUploadReady(dynamic data) {
+ _batchedAssetUploadReady.add(data);
+ _batchDebouncer.run(_processBatchedAssetUploadReady);
+ }
+
+ void _processBatchedAssetUploadReady() {
+ if (_batchedAssetUploadReady.isEmpty) {
+ return;
+ }
+
+ try {
+ unawaited(
+ _ref
+ .read(backgroundSyncProvider)
+ .syncWebsocketBatch(_batchedAssetUploadReady.toList()),
+ );
+ } catch (error) {
+ _log.severe("Error processing batched AssetUploadReadyV1 events: $error");
+ }
+
+ _batchedAssetUploadReady.clear();
+ }
}
final websocketProvider =