feat(mobile): configurable background backup delay (#1068)

let's the user configure how much to delay the trigger for running the backup whenever assets are changed on the device
2025-10-29 17:40:28 +00:00 · 2022-12-08 16:51:36 +01:00
parent a97b761eda
commit c23b2479f7
8 changed files with 122 additions and 12 deletions
--- a/mobile/lib/modules/backup/background_service/background.service.dart
+++ b/mobile/lib/modules/backup/background_service/background.service.dart
@@ -86,6 +86,8 @@ class BackgroundService {
  Future<bool> configureService({
    bool requireUnmetered = true,
    bool requireCharging = false,
+    int triggerUpdateDelay = 5000,
+    int triggerMaxDelay = 50000,
  }) async {
    if (!Platform.isAndroid) {
      return true;
@@ -93,7 +95,12 @@ class BackgroundService {
    try {
      final bool ok = await _foregroundChannel.invokeMethod(
        'configure',
-        [requireUnmetered, requireCharging],
+        [
+          requireUnmetered,
+          requireCharging,
+          triggerUpdateDelay,
+          triggerMaxDelay
+        ],
      );
      return ok;
    } catch (error) {
--- a/mobile/lib/modules/backup/models/backup_state.model.dart
+++ b/mobile/lib/modules/backup/models/backup_state.model.dart
@@ -18,6 +18,7 @@ class BackUpState {
  final bool backgroundBackup;
  final bool backupRequireWifi;
  final bool backupRequireCharging;
+  final int backupTriggerDelay;

  /// All available albums on the device
  final List<AvailableAlbum> availableAlbums;
@@ -42,6 +43,7 @@ class BackUpState {
    required this.backgroundBackup,
    required this.backupRequireWifi,
    required this.backupRequireCharging,
+    required this.backupTriggerDelay,
    required this.availableAlbums,
    required this.selectedBackupAlbums,
    required this.excludedBackupAlbums,
@@ -59,6 +61,7 @@ class BackUpState {
    bool? backgroundBackup,
    bool? backupRequireWifi,
    bool? backupRequireCharging,
+    int? backupTriggerDelay,
    List<AvailableAlbum>? availableAlbums,
    Set<AvailableAlbum>? selectedBackupAlbums,
    Set<AvailableAlbum>? excludedBackupAlbums,
@@ -76,6 +79,7 @@ class BackUpState {
      backupRequireWifi: backupRequireWifi ?? this.backupRequireWifi,
      backupRequireCharging:
          backupRequireCharging ?? this.backupRequireCharging,
+      backupTriggerDelay: backupTriggerDelay ?? this.backupTriggerDelay,
      availableAlbums: availableAlbums ?? this.availableAlbums,
      selectedBackupAlbums: selectedBackupAlbums ?? this.selectedBackupAlbums,
      excludedBackupAlbums: excludedBackupAlbums ?? this.excludedBackupAlbums,
@@ -88,7 +92,7 @@ class BackUpState {

  @override
  String toString() {
-    return 'BackUpState(backupProgress: $backupProgress, allAssetsInDatabase: $allAssetsInDatabase, progressInPercentage: $progressInPercentage, cancelToken: $cancelToken, serverInfo: $serverInfo, backgroundBackup: $backgroundBackup, backupRequireWifi: $backupRequireWifi, backupRequireCharging: $backupRequireCharging, availableAlbums: $availableAlbums, selectedBackupAlbums: $selectedBackupAlbums, excludedBackupAlbums: $excludedBackupAlbums, allUniqueAssets: $allUniqueAssets, selectedAlbumsBackupAssetsIds: $selectedAlbumsBackupAssetsIds, currentUploadAsset: $currentUploadAsset)';
+    return 'BackUpState(backupProgress: $backupProgress, allAssetsInDatabase: $allAssetsInDatabase, progressInPercentage: $progressInPercentage, cancelToken: $cancelToken, serverInfo: $serverInfo, backgroundBackup: $backgroundBackup, backupRequireWifi: $backupRequireWifi, backupRequireCharging: $backupRequireCharging, backupTriggerDelay: $backupTriggerDelay, availableAlbums: $availableAlbums, selectedBackupAlbums: $selectedBackupAlbums, excludedBackupAlbums: $excludedBackupAlbums, allUniqueAssets: $allUniqueAssets, selectedAlbumsBackupAssetsIds: $selectedAlbumsBackupAssetsIds, currentUploadAsset: $currentUploadAsset)';
  }

  @override
@@ -105,6 +109,7 @@ class BackUpState {
        other.backgroundBackup == backgroundBackup &&
        other.backupRequireWifi == backupRequireWifi &&
        other.backupRequireCharging == backupRequireCharging &&
+        other.backupTriggerDelay == backupTriggerDelay &&
        collectionEquals(other.availableAlbums, availableAlbums) &&
        collectionEquals(other.selectedBackupAlbums, selectedBackupAlbums) &&
        collectionEquals(other.excludedBackupAlbums, excludedBackupAlbums) &&
@@ -126,6 +131,7 @@ class BackUpState {
        backgroundBackup.hashCode ^
        backupRequireWifi.hashCode ^
        backupRequireCharging.hashCode ^
+        backupTriggerDelay.hashCode ^
        availableAlbums.hashCode ^
        selectedBackupAlbums.hashCode ^
        excludedBackupAlbums.hashCode ^
--- a/mobile/lib/modules/backup/providers/backup.provider.dart
+++ b/mobile/lib/modules/backup/providers/backup.provider.dart
@@ -38,6 +38,7 @@ class BackupNotifier extends StateNotifier<BackUpState> {
            backgroundBackup: false,
            backupRequireWifi: true,
            backupRequireCharging: false,
+            backupTriggerDelay: 5000,
            serverInfo: ServerInfoResponseDto(
              diskAvailable: "0",
              diskAvailableRaw: 0,
@@ -119,18 +120,26 @@ class BackupNotifier extends StateNotifier<BackUpState> {
    bool? enabled,
    bool? requireWifi,
    bool? requireCharging,
+    int? triggerDelay,
    required void Function(String msg) onError,
    required void Function() onBatteryInfo,
  }) async {
-    assert(enabled != null || requireWifi != null || requireCharging != null);
+    assert(
+      enabled != null ||
+          requireWifi != null ||
+          requireCharging != null ||
+          triggerDelay != null,
+    );
    if (Platform.isAndroid) {
      final bool wasEnabled = state.backgroundBackup;
      final bool wasWifi = state.backupRequireWifi;
-      final bool wasCharing = state.backupRequireCharging;
+      final bool wasCharging = state.backupRequireCharging;
+      final int oldTriggerDelay = state.backupTriggerDelay;
      state = state.copyWith(
        backgroundBackup: enabled,
        backupRequireWifi: requireWifi,
        backupRequireCharging: requireCharging,
+        backupTriggerDelay: triggerDelay,
      );

      if (state.backgroundBackup) {
@@ -145,17 +154,22 @@ class BackupNotifier extends StateNotifier<BackUpState> {
            await _backgroundService.configureService(
              requireUnmetered: state.backupRequireWifi,
              requireCharging: state.backupRequireCharging,
+              triggerUpdateDelay: state.backupTriggerDelay,
+              triggerMaxDelay: state.backupTriggerDelay * 10,
            );
        if (success) {
-          await Hive.box(backgroundBackupInfoBox)
-              .put(backupRequireWifi, state.backupRequireWifi);
-          await Hive.box(backgroundBackupInfoBox)
-              .put(backupRequireCharging, state.backupRequireCharging);
+          final box = Hive.box(backgroundBackupInfoBox);
+          await Future.wait([
+            box.put(backupRequireWifi, state.backupRequireWifi),
+            box.put(backupRequireCharging, state.backupRequireCharging),
+            box.put(backupTriggerDelay, state.backupTriggerDelay),
+          ]);
        } else {
          state = state.copyWith(
            backgroundBackup: wasEnabled,
            backupRequireWifi: wasWifi,
-            backupRequireCharging: wasCharing,
+            backupRequireCharging: wasCharging,
+            backupTriggerDelay: oldTriggerDelay,
          );
          onError("backup_controller_page_background_configure_error");
        }
@@ -602,6 +616,7 @@ class BackupNotifier extends StateNotifier<BackUpState> {
        excludedBackupAlbums: excludedAlbums,
        backupRequireWifi: backgroundBox.get(backupRequireWifi),
        backupRequireCharging: backgroundBox.get(backupRequireCharging),
+        backupTriggerDelay: backgroundBox.get(backupTriggerDelay),
      );
    }
    return _resumeBackup();
--- a/mobile/lib/modules/backup/views/backup_controller_page.dart
+++ b/mobile/lib/modules/backup/views/backup_controller_page.dart
@@ -198,6 +198,46 @@ class BackupControllerPage extends HookConsumerWidget {
      final bool isWifiRequired = backupState.backupRequireWifi;
      final bool isChargingRequired = backupState.backupRequireCharging;
      final Color activeColor = Theme.of(context).primaryColor;
+
+      String formatBackupDelaySliderValue(double v) {
+        if (v == 0.0) {
+          return 'setting_notifications_notify_seconds'.tr(args: const ['5']);
+        } else if (v == 1.0) {
+          return 'setting_notifications_notify_seconds'.tr(args: const ['30']);
+        } else if (v == 2.0) {
+          return 'setting_notifications_notify_minutes'.tr(args: const ['2']);
+        } else {
+          return 'setting_notifications_notify_minutes'.tr(args: const ['10']);
+        }
+      }
+
+      int backupDelayToMilliseconds(double v) {
+        if (v == 0.0) {
+          return 5000;
+        } else if (v == 1.0) {
+          return 30000;
+        } else if (v == 2.0) {
+          return 120000;
+        } else {
+          return 600000;
+        }
+      }
+
+      double backupDelayToSliderValue(int ms) {
+        if (ms == 5000) {
+          return 0.0;
+        } else if (ms == 30000) {
+          return 1.0;
+        } else if (ms == 120000) {
+          return 2.0;
+        } else {
+          return 3.0;
+        }
+      }
+
+      final triggerDelay =
+          useState(backupDelayToSliderValue(backupState.backupTriggerDelay));
+
      return ListTile(
        isThreeLine: true,
        leading: isBackgroundEnabled
@@ -264,6 +304,35 @@ class BackupControllerPage extends HookConsumerWidget {
                        )
                    : null,
              ),
+            if (isBackgroundEnabled)
+              ListTile(
+                isThreeLine: false,
+                dense: true,
+                enabled: hasExclusiveAccess,
+                title: const Text(
+                  'backup_controller_page_background_delay',
+                  style: TextStyle(
+                    fontWeight: FontWeight.bold,
+                  ),
+                ).tr(args: [formatBackupDelaySliderValue(triggerDelay.value)]),
+                subtitle: Slider(
+                  value: triggerDelay.value,
+                  onChanged: hasExclusiveAccess
+                      ? (double v) => triggerDelay.value = v
+                      : null,
+                  onChangeEnd: (double v) => ref
+                      .read(backupProvider.notifier)
+                      .configureBackgroundBackup(
+                        triggerDelay: backupDelayToMilliseconds(v),
+                        onError: showErrorToUser,
+                        onBatteryInfo: showBatteryOptimizationInfoToUser,
+                      ),
+                  max: 3.0,
+                  divisions: 3,
+                  label: formatBackupDelaySliderValue(triggerDelay.value),
+                  activeColor: Theme.of(context).primaryColor,
+                ),
+              ),
            ElevatedButton(
              onPressed: () =>
                  ref.read(backupProvider.notifier).configureBackgroundBackup(