High performance self-hosted photo and video management solution.
TypeScript backup-toolfluttergoogle-photosgoogle-photos-alternativejavascriptmobile-appnestjsnodejsphoto-galleryphotosphotos-managementself-hostedsveltesveltekittypescriptvideos
fix(mobile): cancel the iOS background uploads when the foreground backup starts (#31944)
Santo Shakil14cd2fdb0c14
diff --git a/mobile/lib/providers/backup/backup.provider.dart b/mobile/lib/providers/backup/backup.provider.dartindex d05c9a868c..3acc878ee6 100644--- a/mobile/lib/providers/backup/backup.provider.dart+++ b/mobile/lib/providers/backup/backup.provider.dart@@ -6,6 +6,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart';import 'package:immich_mobile/constants/constants.dart';import 'package:immich_mobile/domain/models/album/local_album.model.dart';import 'package:immich_mobile/domain/models/asset/base_asset.model.dart';+import 'package:immich_mobile/extensions/platform_extensions.dart';import 'package:immich_mobile/providers/infrastructure/db.provider.dart';import 'package:immich_mobile/providers/user.provider.dart';import 'package:immich_mobile/services/background_upload.service.dart';@@ -133,6 +134,12 @@ class BackupNotifier extends StateNotifier<BackupState> {final cancelToken = Completer<void>();_cancelToken = cancelToken;+ // TODO: Once the tmp cleanup is fixed, revert this and handle it differently.+ // Since we clean up tmp files whenever a foreground upload starts, we need to cancel ongoing background uploads.+ if (CurrentPlatform.isIOS) {+ await _backgroundUploadService.cancel();+ }+// Re-baseline the counters against the same DB read that feeds this run's candidate list,// otherwise a resume counts duplicate successes against the old baseline (#26215).await getBackupStatus(userId);diff --git a/mobile/lib/services/background_upload.service.dart b/mobile/lib/services/background_upload.service.dartindex ec4e12a84d..8d7d7361e5 100644--- a/mobile/lib/services/background_upload.service.dart+++ b/mobile/lib/services/background_upload.service.dart@@ -186,6 +186,8 @@ class BackgroundUploadService {await _storageRepository.clearCache();await _uploadRepository.reset(kBackupGroup);await _uploadRepository.deleteDatabaseRecords(kBackupGroup);+ await _uploadRepository.reset(kBackupLivePhotoGroup);+ await _uploadRepository.deleteDatabaseRecords(kBackupLivePhotoGroup);final activeTasks = await _uploadRepository.getActiveTasks(kBackupGroup);return activeTasks.length;@@ -287,9 +289,6 @@ class BackgroundUploadService {////// We implement two separate upload groups for this, the normal one for the video file/// and the higher priority group for the photo file because the video file is already uploaded.- ///- /// The cancel operation will only cancel the video group (normal group), the photo group will not- /// be touched, as the video file is already uploaded.if (entity.isLivePhoto) {file = await _storageRepository.getMotionFileForAsset(asset);diff --git a/mobile/test/providers/backup/backup_provider_test.dart b/mobile/test/providers/backup/backup_provider_test.dartindex 791ce295db..870050dfef 100644--- a/mobile/test/providers/backup/backup_provider_test.dart+++ b/mobile/test/providers/backup/backup_provider_test.dart@@ -1,5 +1,6 @@import 'dart:async';+import 'package:flutter/foundation.dart';import 'package:flutter_test/flutter_test.dart';import 'package:immich_mobile/providers/backup/backup.provider.dart';import 'package:immich_mobile/services/background_upload.service.dart';@@ -98,6 +99,27 @@ void main() {expect(notifier.state.backupCount, 84);});+ test('on iOS uploads start only after the background queue is cancelled', () async {+ debugDefaultTargetPlatformOverride = TargetPlatform.iOS;+ addTearDown(() => debugDefaultTargetPlatformOverride = null);+ mockCounts(total: 1, remainder: 1);+ final cancel = Completer<int>();+ when(() => backgroundUploadService.cancel()).thenAnswer((_) => cancel.future);+ when(+ () => foregroundUploadService.uploadCandidates(any(), any(), callbacks: any(named: 'callbacks')),+ ).thenAnswer((_) async {});++ final backup = notifier.startForegroundBackup('user-1');+ await pumpEventQueue();+ verifyNever(() => foregroundUploadService.uploadCandidates(any(), any(), callbacks: any(named: 'callbacks')));++ cancel.complete(0);+ await backup;+ verify(+ () => foregroundUploadService.uploadCandidates(any(), any(), callbacks: any(named: 'callbacks')),+ ).called(1);+ });+test('a late success after dispose does not throw', () async {mockCounts(total: 2, remainder: 2);final onSuccess = await startAndCaptureOnSuccess();diff --git a/mobile/test/services/background_upload.service_test.dart b/mobile/test/services/background_upload.service_test.dartindex 64e89935ea..4bdfe825ac 100644--- a/mobile/test/services/background_upload.service_test.dart+++ b/mobile/test/services/background_upload.service_test.dart@@ -7,6 +7,7 @@ import 'package:drift/native.dart';import 'package:flutter/foundation.dart';import 'package:flutter/services.dart';import 'package:flutter_test/flutter_test.dart';+import 'package:immich_mobile/constants/constants.dart';import 'package:immich_mobile/data/db/main/database.dart';import 'package:immich_mobile/domain/models/asset/base_asset.model.dart';import 'package:immich_mobile/domain/models/store.model.dart';@@ -460,4 +461,18 @@ void main() {verifyNoMoreInteractions(mockAssetService);});});++ group('cancel', () {+ test('also cancels the live photo still group', () async {+ when(() => mockStorageRepository.clearCache()).thenAnswer((_) async {});+ when(() => mockUploadRepository.reset(any())).thenAnswer((_) async => 0);+ when(() => mockUploadRepository.deleteDatabaseRecords(any())).thenAnswer((_) async {});+ when(() => mockUploadRepository.getActiveTasks(any())).thenAnswer((_) async => []);++ await sut.cancel();++ verify(() => mockUploadRepository.reset(kBackupLivePhotoGroup)).called(1);+ verify(() => mockUploadRepository.deleteDatabaseRecords(kBackupLivePhotoGroup)).called(1);+ });+ });}