Skip to content

armgit / ente

Public Imported from GitHub
0

πŸ’š End-to-end encrypted cloud for everything.

[mobile][photos] Detect device storage exhaustion during backup (#11554)

Rahul Agarwal20636bf56c68
diff --git a/mobile/apps/photos/changes/device-storage-full.md b/mobile/apps/photos/changes/device-storage-full.md
new file mode 100644
index 0000000000..0928a1169c
--- /dev/null
+++ b/mobile/apps/photos/changes/device-storage-full.md
@@ -0,0 +1 @@
+- Improved handling of device out-of-storage errors.
diff --git a/mobile/apps/photos/lib/core/errors.dart b/mobile/apps/photos/lib/core/errors.dart
index 7d5bf21440..bd55442d8d 100644
--- a/mobile/apps/photos/lib/core/errors.dart
+++ b/mobile/apps/photos/lib/core/errors.dart
@@ -50,6 +50,8 @@ class NoActiveSubscriptionError extends Error implements LocallyHandledError {}
class StorageLimitExceededError extends Error implements LocallyHandledError {}
+class DeviceStorageFullError extends Error implements LocallyHandledError {}
+
// error when file size + current usage >= storage plan limit + buffer
class FileTooLargeForPlanError extends Error {}
diff --git a/mobile/apps/photos/lib/l10n/intl_en.arb b/mobile/apps/photos/lib/l10n/intl_en.arb
index 0fced6babe..6b68bfc33e 100644
--- a/mobile/apps/photos/lib/l10n/intl_en.arb
+++ b/mobile/apps/photos/lib/l10n/intl_en.arb
@@ -1153,6 +1153,7 @@
"type": "text"
},
"backupFailed": "Backup failed",
+ "backupPausedFreeUpDeviceStorage": "Backup is paused. Free up storage on this device to resume.",
"sorryBackupFailedDesc": "Sorry, we could not backup this file right now, we will retry later.",
"couldNotBackUpTryLater": "We could not backup your data.\nWe will retry later.",
"enteCanEncryptAndPreserveFilesOnlyIfYouGrant": "Ente can encrypt and preserve files only if you grant access to them",
diff --git a/mobile/apps/photos/lib/module/upload/service/file_uploader.dart b/mobile/apps/photos/lib/module/upload/service/file_uploader.dart
index 2b4299a3c1..d8d37cb1cf 100644
--- a/mobile/apps/photos/lib/module/upload/service/file_uploader.dart
+++ b/mobile/apps/photos/lib/module/upload/service/file_uploader.dart
@@ -40,6 +40,7 @@ import 'package:photos/services/collections_service.dart';
import 'package:photos/services/file_magic_service.dart';
import 'package:photos/services/sync/local_sync_service.dart';
import 'package:photos/services/sync/sync_service.dart';
+import "package:photos/utils/device_storage_error.dart";
import "package:photos/utils/file_key.dart";
import "package:photos/utils/network_util.dart";
import 'package:shared_preferences/shared_preferences.dart';
@@ -271,10 +272,17 @@ class FileUploader {
} catch (e) {
if (e is LockAlreadyAcquiredError) {
return _queue.moveToBackground(item);
- } else {
- _queue.fail(item, e);
+ }
+ if (isDeviceStorageFullError(e)) {
+ final error = DeviceStorageFullError();
+ _logger.warning("Device storage is full for ${file.tag}", e);
+ SyncService.instance.stopSync();
+ clearQueue(error);
+ _queue.fail(item, error);
return null;
}
+ _queue.fail(item, e);
+ return null;
} finally {
_queue.finishAttempt(item);
_pollQueue();
@@ -775,7 +783,9 @@ class FileUploader {
Bus.instance.fire(FileUploadedEvent(remoteFile));
return remoteFile;
} catch (e, s) {
- if (!(e is NoActiveSubscriptionError ||
+ if (isDeviceStorageFullError(e)) {
+ uploadHardFailure = true;
+ } else if (!(e is NoActiveSubscriptionError ||
e is StorageLimitExceededError ||
e is WiFiUnavailableError ||
e is SilentlyCancelUploadsError ||
diff --git a/mobile/apps/photos/lib/module/upload/upload_data.dart b/mobile/apps/photos/lib/module/upload/upload_data.dart
index 2ac3cd6afa..2c8861bb5f 100644
--- a/mobile/apps/photos/lib/module/upload/upload_data.dart
+++ b/mobile/apps/photos/lib/module/upload/upload_data.dart
@@ -26,6 +26,7 @@ import 'package:photos/module/upload/model/media_upload_data.dart';
import "package:photos/services/sync/local_sync_service.dart";
import "package:photos/src/rust/api/motion_photo_api.dart";
import "package:photos/utils/apple_photos_errors.dart";
+import "package:photos/utils/device_storage_error.dart";
import "package:photos/utils/image_util.dart";
final _logger = Logger("UploadData");
@@ -224,6 +225,9 @@ Future<Uint8List?> _getThumbnailForUpload(
}
return compressThumbnailToSizeLimit(thumbnailData);
} catch (e) {
+ if (isDeviceStorageFullError(e)) {
+ rethrow;
+ }
final String errMessage =
"thumbErr for ${file.fileType}, ${extension(file.displayName)} ${file.tag}";
_logger.warning(errMessage, e);
diff --git a/mobile/apps/photos/lib/services/sync/remote_sync_service.dart b/mobile/apps/photos/lib/services/sync/remote_sync_service.dart
index 5961fd0bae..05c8c9ed1a 100644
--- a/mobile/apps/photos/lib/services/sync/remote_sync_service.dart
+++ b/mobile/apps/photos/lib/services/sync/remote_sync_service.dart
@@ -97,8 +97,11 @@ class RemoteSyncService {
.listen((event) async {
if (event.type == EventType.addedOrUpdated) {
if (_existingSync == null) {
- // ignore: unawaited_futures
- sync();
+ try {
+ await sync();
+ } on DeviceStorageFullError catch (e) {
+ Bus.instance.fire(SyncStatusUpdate(SyncStatus.error, error: e));
+ }
}
}
});
@@ -218,6 +221,7 @@ class RemoteSyncService {
NoActiveSubscriptionError,
WiFiUnavailableError,
StorageLimitExceededError,
+ DeviceStorageFullError,
SyncStopRequestedError,
NoMediaLocationAccessError,
}.contains(e.runtimeType)) {
diff --git a/mobile/apps/photos/lib/services/sync/sync_service.dart b/mobile/apps/photos/lib/services/sync/sync_service.dart
index 49a8916474..a8bf7f3725 100644
--- a/mobile/apps/photos/lib/services/sync/sync_service.dart
+++ b/mobile/apps/photos/lib/services/sync/sync_service.dart
@@ -114,11 +114,11 @@ class SyncService {
_logger.warning("Sync requested before init, skipping");
return false;
}
- _syncStopRequested = false;
if (_existingSync != null) {
_logger.warning("Sync already in progress, skipping.");
return _existingSync!.future;
}
+ _syncStopRequested = false;
_existingSync = Completer<bool>();
bool successful = false;
try {
@@ -149,6 +149,8 @@ class SyncService {
Bus.instance.fire(
SyncStatusUpdate(SyncStatus.error, error: StorageLimitExceededError()),
);
+ } on DeviceStorageFullError catch (e) {
+ Bus.instance.fire(SyncStatusUpdate(SyncStatus.error, error: e));
} on UnauthorizedError {
_logger.info("Logging user out");
Bus.instance.fire(TriggerLogoutEvent());
diff --git a/mobile/apps/photos/lib/ui/home/header_error_widget.dart b/mobile/apps/photos/lib/ui/home/header_error_widget.dart
index be5053d672..54427d9e51 100644
--- a/mobile/apps/photos/lib/ui/home/header_error_widget.dart
+++ b/mobile/apps/photos/lib/ui/home/header_error_widget.dart
@@ -5,6 +5,7 @@ import "package:hugeicons/hugeicons.dart";
import 'package:photos/core/errors.dart';
import "package:photos/generated/l10n.dart";
import 'package:photos/ui/payment/subscription.dart';
+import "package:photos/ui/settings/backup/free_space_options.dart";
import 'package:photos/utils/email_util.dart';
class HeaderErrorWidget extends StatelessWidget {
@@ -48,6 +49,25 @@ class HeaderErrorWidget extends StatelessWidget {
},
),
);
+ } else if (_error is DeviceStorageFullError) {
+ return Padding(
+ padding: const EdgeInsets.symmetric(horizontal: 16.0, vertical: 6),
+ child: BannerComponent(
+ leadingIcon: HugeIcons.strokeRoundedAlertCircle,
+ title: AppLocalizations.of(context).freeUpDeviceSpace,
+ subtitle: AppLocalizations.of(
+ context,
+ ).backupPausedFreeUpDeviceStorage,
+ state: BannerComponentState.failure,
+ onTap: () async {
+ await routeToPage(
+ context,
+ const FreeUpSpaceOptionsScreen(),
+ forceCustomPageRoute: true,
+ );
+ },
+ ),
+ );
} else {
return Padding(
padding: const EdgeInsets.symmetric(horizontal: 16.0, vertical: 6),
diff --git a/mobile/apps/photos/lib/utils/device_storage_error.dart b/mobile/apps/photos/lib/utils/device_storage_error.dart
index 4bad454ddf..f505fbaee0 100644
--- a/mobile/apps/photos/lib/utils/device_storage_error.dart
+++ b/mobile/apps/photos/lib/utils/device_storage_error.dart
@@ -1,6 +1,7 @@
import "dart:io";
import "package:dio/dio.dart";
+import "package:flutter/services.dart" show PlatformException;
class DeviceStorageFullException implements Exception {
const DeviceStorageFullException();
@@ -14,8 +15,13 @@ bool isDeviceStorageFullError(Object error) {
return true;
}
if (error is FileSystemException) {
- final code = error.osError?.errorCode;
- return code == 28 || code == 112;
+ // ENOSPC on POSIX, ERROR_DISK_FULL on Windows.
+ return error.osError?.errorCode == (Platform.isWindows ? 112 : 28);
+ }
+ if (error is PlatformException) {
+ return error.code == "NSCocoaErrorDomain (640)" ||
+ error.code == "NSPOSIXErrorDomain (28)" ||
+ error.code == "PHPhotosErrorDomain (3305)";
}
if (error is DioException && error.error != null) {
return isDeviceStorageFullError(error.error!);