Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve backup UX #8533

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions mobile/assets/i18n/en-US.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@
"backup_background_service_in_progress_notification": "Backing up your assets…",
"backup_background_service_upload_failure_notification": "Failed to upload {}",
"backup_controller_page_albums": "Backup Albums",
"backup_controller_page_asset_backed_up": "backed up",
"backup_controller_page_automatic_backup_disabled": "Automatic backup is disabled.",
"backup_controller_page_backed_up": "Backed Up",
"backup_controller_page_background_app_refresh_disabled_content": "Enable background app refresh in Settings > General > Background App Refresh in order to use background backup.",
"backup_controller_page_background_app_refresh_disabled_title": "Background app refresh disabled",
"backup_controller_page_background_app_refresh_enable_button_text": "Go to settings",
Expand All @@ -87,9 +90,17 @@
"backup_controller_page_excluded": "Excluded: ",
"backup_controller_page_failed": "Failed ({})",
"backup_controller_page_filename": "File name: {} [{}]",
"backup_controller_page_icloud_download": "iCloud Download",
"backup_controller_page_id": "ID: {}",
"backup_controller_page_in_background": "Running in background",
"backup_controller_page_in_background_interact": "Background backup is currently running, cannot start manual backup.",
"backup_controller_page_in_background_interact_ok": "Ok",
"backup_controller_page_info": "Backup Information",
"backup_controller_page_immich_upload": "Immich Upload ({})",
"backup_controller_page_none_selected": "None selected",
"backup_controller_page_no_albums_selected_body": "To begin backing up, select some albums!",
"backup_controller_page_no_albums_selected_header": "No albums selected",
"backup_controller_page_quota_used": "Quota Used",
"backup_controller_page_remainder": "Remainder",
"backup_controller_page_remainder_sub": "Remaining photos and videos to back up from selection",
"backup_controller_page_select": "Select",
Expand Down
13 changes: 12 additions & 1 deletion mobile/lib/modules/backup/models/backup_state.model.dart
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ class BackUpState {
final bool backupRequireWifi;
final bool backupRequireCharging;
final int backupTriggerDelay;
final DateTime? lastBackupTimestamp;

/// All available albums on the device
final List<AvailableAlbum> availableAlbums;
Expand All @@ -46,6 +47,9 @@ class BackUpState {
/// All assets from the selected albums that have been backup
final Set<String> selectedAlbumsBackupAssetsIds;

/// All assets from the selected albums that have errored on backup
final Set<String> selectedAlbumsBackupErrorAssetsIds;

// Current Backup Asset
final CurrentUploadAsset currentUploadAsset;

Expand All @@ -66,11 +70,13 @@ class BackUpState {
required this.backupRequireWifi,
required this.backupRequireCharging,
required this.backupTriggerDelay,
required this.lastBackupTimestamp,
required this.availableAlbums,
required this.selectedBackupAlbums,
required this.excludedBackupAlbums,
required this.allUniqueAssets,
required this.selectedAlbumsBackupAssetsIds,
required this.selectedAlbumsBackupErrorAssetsIds,
required this.currentUploadAsset,
});

Expand All @@ -91,11 +97,13 @@ class BackUpState {
bool? backupRequireWifi,
bool? backupRequireCharging,
int? backupTriggerDelay,
DateTime? lastBackupTimestamp,
List<AvailableAlbum>? availableAlbums,
Set<AvailableAlbum>? selectedBackupAlbums,
Set<AvailableAlbum>? excludedBackupAlbums,
Set<AssetEntity>? allUniqueAssets,
Set<String>? selectedAlbumsBackupAssetsIds,
Set<String>? selectedAlbumsBackupErrorAssetsIds,
CurrentUploadAsset? currentUploadAsset,
}) {
return BackUpState(
Expand All @@ -119,19 +127,22 @@ class BackUpState {
backupRequireCharging:
backupRequireCharging ?? this.backupRequireCharging,
backupTriggerDelay: backupTriggerDelay ?? this.backupTriggerDelay,
lastBackupTimestamp: lastBackupTimestamp ?? this.lastBackupTimestamp,
availableAlbums: availableAlbums ?? this.availableAlbums,
selectedBackupAlbums: selectedBackupAlbums ?? this.selectedBackupAlbums,
excludedBackupAlbums: excludedBackupAlbums ?? this.excludedBackupAlbums,
allUniqueAssets: allUniqueAssets ?? this.allUniqueAssets,
selectedAlbumsBackupAssetsIds:
selectedAlbumsBackupAssetsIds ?? this.selectedAlbumsBackupAssetsIds,
selectedAlbumsBackupErrorAssetsIds: selectedAlbumsBackupErrorAssetsIds ??
this.selectedAlbumsBackupErrorAssetsIds,
currentUploadAsset: currentUploadAsset ?? this.currentUploadAsset,
);
}

@override
String toString() {
return 'BackUpState(backupProgress: $backupProgress, allAssetsInDatabase: $allAssetsInDatabase, progressInPercentage: $progressInPercentage, progressInFileSize: $progressInFileSize, progressInFileSpeed: $progressInFileSpeed, progressInFileSpeeds: $progressInFileSpeeds, progressInFileSpeedUpdateTime: $progressInFileSpeedUpdateTime, progressInFileSpeedUpdateSentBytes: $progressInFileSpeedUpdateSentBytes, iCloudDownloadProgress: $iCloudDownloadProgress, cancelToken: $cancelToken, serverInfo: $serverInfo, autoBackup: $autoBackup, backgroundBackup: $backgroundBackup, backupRequireWifi: $backupRequireWifi, backupRequireCharging: $backupRequireCharging, backupTriggerDelay: $backupTriggerDelay, availableAlbums: $availableAlbums, selectedBackupAlbums: $selectedBackupAlbums, excludedBackupAlbums: $excludedBackupAlbums, allUniqueAssets: $allUniqueAssets, selectedAlbumsBackupAssetsIds: $selectedAlbumsBackupAssetsIds, currentUploadAsset: $currentUploadAsset)';
return 'BackUpState(backupProgress: $backupProgress, allAssetsInDatabase: $allAssetsInDatabase, progressInPercentage: $progressInPercentage, progressInFileSize: $progressInFileSize, progressInFileSpeed: $progressInFileSpeed, progressInFileSpeeds: $progressInFileSpeeds, progressInFileSpeedUpdateTime: $progressInFileSpeedUpdateTime, progressInFileSpeedUpdateSentBytes: $progressInFileSpeedUpdateSentBytes, iCloudDownloadProgress: $iCloudDownloadProgress, cancelToken: $cancelToken, serverInfo: $serverInfo, autoBackup: $autoBackup, backgroundBackup: $backgroundBackup, backupRequireWifi: $backupRequireWifi, backupRequireCharging: $backupRequireCharging, backupTriggerDelay: $backupTriggerDelay, availableAlbums: $availableAlbums, selectedBackupAlbums: $selectedBackupAlbums, excludedBackupAlbums: $excludedBackupAlbums, allUniqueAssets: $allUniqueAssets, selectedAlbumsBackupAssetsIds: $selectedAlbumsBackupAssetsIds, selectedAlbumsBackupErrorAssetsIds: $selectedAlbumsBackupErrorAssetsIds, currentUploadAsset: $currentUploadAsset)';
}

@override
Expand Down
33 changes: 28 additions & 5 deletions mobile/lib/modules/backup/providers/backup.provider.dart
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ class BackupNotifier extends StateNotifier<BackUpState> {
backupRequireCharging:
Store.get(StoreKey.backupRequireCharging, false),
backupTriggerDelay: Store.get(StoreKey.backupTriggerDelay, 5000),
lastBackupTimestamp: Store.tryGet(StoreKey.lastBackupTimestamp),
serverInfo: const ServerDiskInfo(
diskAvailable: "0",
diskSize: "0",
Expand All @@ -64,6 +65,7 @@ class BackupNotifier extends StateNotifier<BackUpState> {
excludedBackupAlbums: const {},
allUniqueAssets: const {},
selectedAlbumsBackupAssetsIds: const {},
selectedAlbumsBackupErrorAssetsIds: const {},
currentUploadAsset: CurrentUploadAsset(
id: '...',
fileCreatedAt: DateTime.parse('2020-10-04'),
Expand Down Expand Up @@ -406,8 +408,14 @@ class BackupNotifier extends StateNotifier<BackUpState> {
/// Invoke backup process
Future<void> startBackupProcess() async {
debugPrint("Start backup process");
assert(state.backupProgress == BackUpProgressEnum.idle);
state = state.copyWith(backupProgress: BackUpProgressEnum.inProgress);
assert(
state.backupProgress == BackUpProgressEnum.idle ||
state.backupProgress == BackUpProgressEnum.done,
);
state = state.copyWith(
backupProgress: BackUpProgressEnum.inProgress,
selectedAlbumsBackupErrorAssetsIds: const {},
);

await getBackupInfo();

Expand Down Expand Up @@ -450,6 +458,9 @@ class BackupNotifier extends StateNotifier<BackUpState> {
_onSetCurrentBackupAsset,
_onBackupError,
);
var timestamp = DateTime.now();
Store.put(StoreKey.lastBackupTimestamp, timestamp);
state = state.copyWith(lastBackupTimestamp: timestamp);
await notifyBackgroundServiceCanRun();
} else {
openAppSettings();
Expand All @@ -463,7 +474,14 @@ class BackupNotifier extends StateNotifier<BackUpState> {
}

void _onBackupError(ErrorUploadAsset errorAssetInfo) {
state = state.copyWith(
selectedAlbumsBackupErrorAssetsIds: {
...state.selectedAlbumsBackupErrorAssetsIds,
errorAssetInfo.id,
},
);
ref.watch(errorBackupListProvider.notifier).add(errorAssetInfo);
_checkBackupFinished();
}

void _onSetCurrentBackupAsset(CurrentUploadAsset currentUploadAsset) {
Expand Down Expand Up @@ -506,8 +524,15 @@ class BackupNotifier extends StateNotifier<BackUpState> {
);
}

_checkBackupFinished();

updateServerInfo();
}

void _checkBackupFinished() {
if (state.allUniqueAssets.length -
state.selectedAlbumsBackupAssetsIds.length ==
state.selectedAlbumsBackupAssetsIds.length -
state.selectedAlbumsBackupErrorAssetsIds.length ==
0) {
final latestAssetBackup =
state.allUniqueAssets.map((e) => e.modifiedDateTime).reduce(
Expand All @@ -529,8 +554,6 @@ class BackupNotifier extends StateNotifier<BackUpState> {
);
_updatePersistentAlbumsSelection();
}

updateServerInfo();
}

void _onUploadProgress(int sent, int total) {
Expand Down
47 changes: 40 additions & 7 deletions mobile/lib/modules/backup/services/backup.service.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import 'dart:async';
import 'dart:convert';
import 'dart:io';

import 'package:cancellation_token_http/http.dart';
import 'package:collection/collection.dart';
import 'package:flutter/material.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
Expand Down Expand Up @@ -353,8 +354,30 @@ class BackupService {
),
);

var response =
await httpClient.send(req, cancellationToken: cancelToken);
StreamedResponse response;

try {
response =
await httpClient.send(req, cancellationToken: cancelToken);
} catch (err) {
debugPrint(
"Error(network) uploading ${entity.id} | $originalFileName | Created on ${entity.createDateTime} | $err",
);

errorCb(
ErrorUploadAsset(
asset: entity,
id: entity.id,
fileCreatedAt: entity.createDateTime,
fileName: originalFileName,
fileType: _getAssetType(entity.type),
errorMessage: err.toString(),
),
);

anyErrors = true;
continue;
}

if (response.statusCode == 200) {
// asset is a duplicate (already exists on the server)
Expand All @@ -365,12 +388,22 @@ class BackupService {
uploadSuccessCb(entity.id, deviceId, false);
} else {
var data = await response.stream.bytesToString();
var error = jsonDecode(data);
var errorMessage = error['message'] ?? error['error'];
String errorMessage;

debugPrint(
"Error(${error['statusCode']}) uploading ${entity.id} | $originalFileName | Created on ${entity.createDateTime} | ${error['error']}",
);
try {
var error = jsonDecode(data);
errorMessage = error['message'] ?? error['error'];
debugPrint(
"Error(${error['statusCode']}) uploading ${entity.id} | $originalFileName | Created on ${entity.createDateTime} | ${error['error']}",
);
} catch (err) {
// server returned invalid response
debugPrint(
"Error(HTTP ${response.statusCode}) uploading ${entity.id} | $originalFileName | Created on ${entity.createDateTime} | $data",
);

errorMessage = "HTTP ${response.statusCode}: $data";
}

errorCb(
ErrorUploadAsset(
Expand Down
60 changes: 0 additions & 60 deletions mobile/lib/modules/backup/ui/backup_info_card.dart

This file was deleted.