feat(mobile): Adds file upload progress stats (#7760)

* feat(mobile): Adds file upload progress stats: current upload file size uploaded, current file size and formatted bytes per second upload speed. Closes #7379 * chore(mobile): Fix stan issues * chore(mobile): Remove non-'en-US' translations, as I saw on another PR review (just looking around) that localisation is done via Localizely and this was the instruction (to only provide the en-US localisation). * fix(mobile): Provide boundary checks to ensure overflow issues are accounted for on erroneous upload speed calculation, sometimes the numbers received back from the upload handler can be a bit wild. * fix(mobile): Some heuristic bug fixing. Whilst thinking what could trigger overflow issues or 'zero' readouts, left over values from the previous file may do that. So adding the last upload sent bytes to the values to be reset may help! The time isn't necessary, as the period/cycle is inconsequential in this circumstance, well it should be anyway. * fix(mobile): Actually, in combination to the last commit, some more heuristic bug fixing. I was thinking it would be advantageous not to reset the update time, as it would trigger a quicker first upload speed calculation. However, I realised that could also cause the calculation to be incorrect on the first cycle as the period wouldn't align. Not really sure if it would be a big deal, but I'm taking wild guesses in the dark here. Again, some purely heuristic debugging as I can't re-produce the underlying issue. This is mainly just ensuring that the state is fully reset and is a known state at the beginning of each file as a common strategy to reduce issues. * refactor(mobile): Move the UI for the file progress to underneath the progress bar, it makes more sense there than in the file information table which contains only static information pertaining to the file itself. Switching to a monospace font to keep the UI from jumping around as the numbers change. * refactor(mobile): In order to have the UI always present an 'active' upload speed (as per the discussion on PR #7760), this stores the 'upload speeds' (capped at the latest 10) in a list and calculates the current upload speed as the average over them. This way the UI can always display a 'constant' upload speed during uploading, instead of starting a fresh when each file starts uploading. Limiting it to the 10 latest keeps the average somewhat recent and ensures some level of sensible memory allocation.
immich-app · Mar 14, 2024 · 9bd79ff · 9bd79ff
1 parent c04dfdf
commit 9bd79ff
Show file tree

Hide file tree

Showing 8 changed files with 229 additions and 5 deletions.
diff --git a/mobile/lib/modules/backup/models/backup_state.model.dart b/mobile/lib/modules/backup/models/backup_state.model.dart
@@ -21,6 +21,11 @@ class BackUpState {
   final BackUpProgressEnum backupProgress;
   final List<String> allAssetsInDatabase;
   final double progressInPercentage;
+  final String progressInFileSize;
+  final double progressInFileSpeed;
+  final List<double> progressInFileSpeeds;
+  final DateTime progressInFileSpeedUpdateTime;
+  final int progressInFileSpeedUpdateSentBytes;
   final double iCloudDownloadProgress;
   final CancellationToken cancelToken;
   final ServerDiskInfo serverInfo;
@@ -48,6 +53,11 @@ class BackUpState {
     required this.backupProgress,
     required this.allAssetsInDatabase,
     required this.progressInPercentage,
+    required this.progressInFileSize,
+    required this.progressInFileSpeed,
+    required this.progressInFileSpeeds,
+    required this.progressInFileSpeedUpdateTime,
+    required this.progressInFileSpeedUpdateSentBytes,
     required this.iCloudDownloadProgress,
     required this.cancelToken,
     required this.serverInfo,
@@ -68,6 +78,11 @@ class BackUpState {
     BackUpProgressEnum? backupProgress,
     List<String>? allAssetsInDatabase,
     double? progressInPercentage,
+    String? progressInFileSize,
+    double? progressInFileSpeed,
+    List<double>? progressInFileSpeeds,
+    DateTime? progressInFileSpeedUpdateTime,
+    int? progressInFileSpeedUpdateSentBytes,
     double? iCloudDownloadProgress,
     CancellationToken? cancelToken,
     ServerDiskInfo? serverInfo,
@@ -87,6 +102,13 @@ class BackUpState {
       backupProgress: backupProgress ?? this.backupProgress,
       allAssetsInDatabase: allAssetsInDatabase ?? this.allAssetsInDatabase,
       progressInPercentage: progressInPercentage ?? this.progressInPercentage,
+      progressInFileSize: progressInFileSize ?? this.progressInFileSize,
+      progressInFileSpeed: progressInFileSpeed ?? this.progressInFileSpeed,
+      progressInFileSpeeds: progressInFileSpeeds ?? this.progressInFileSpeeds,
+      progressInFileSpeedUpdateTime:
+          progressInFileSpeedUpdateTime ?? this.progressInFileSpeedUpdateTime,
+      progressInFileSpeedUpdateSentBytes: progressInFileSpeedUpdateSentBytes ??
+          this.progressInFileSpeedUpdateSentBytes,
       iCloudDownloadProgress:
           iCloudDownloadProgress ?? this.iCloudDownloadProgress,
       cancelToken: cancelToken ?? this.cancelToken,
@@ -109,7 +131,7 @@ class BackUpState {
 
   @override
   String toString() {
-    return 'BackUpState(backupProgress: $backupProgress, allAssetsInDatabase: $allAssetsInDatabase, progressInPercentage: $progressInPercentage, 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, currentUploadAsset: $currentUploadAsset)';
   }
 
   @override
@@ -120,6 +142,12 @@ class BackUpState {
     return other.backupProgress == backupProgress &&
         collectionEquals(other.allAssetsInDatabase, allAssetsInDatabase) &&
         other.progressInPercentage == progressInPercentage &&
+        other.progressInFileSize == progressInFileSize &&
+        other.progressInFileSpeed == progressInFileSpeed &&
+        collectionEquals(other.progressInFileSpeeds, progressInFileSpeeds) &&
+        other.progressInFileSpeedUpdateTime == progressInFileSpeedUpdateTime &&
+        other.progressInFileSpeedUpdateSentBytes ==
+            progressInFileSpeedUpdateSentBytes &&
         other.iCloudDownloadProgress == iCloudDownloadProgress &&
         other.cancelToken == cancelToken &&
         other.serverInfo == serverInfo &&
@@ -144,6 +172,11 @@ class BackUpState {
     return backupProgress.hashCode ^
         allAssetsInDatabase.hashCode ^
         progressInPercentage.hashCode ^
+        progressInFileSize.hashCode ^
+        progressInFileSpeed.hashCode ^
+        progressInFileSpeeds.hashCode ^
+        progressInFileSpeedUpdateTime.hashCode ^
+        progressInFileSpeedUpdateSentBytes.hashCode ^
         iCloudDownloadProgress.hashCode ^
         cancelToken.hashCode ^
         serverInfo.hashCode ^

diff --git a/mobile/lib/modules/backup/models/current_upload_asset.model.dart b/mobile/lib/modules/backup/models/current_upload_asset.model.dart
@@ -6,13 +6,15 @@ class CurrentUploadAsset {
   final DateTime fileCreatedAt;
   final String fileName;
   final String fileType;
+  final int? fileSize;
   final bool? iCloudAsset;
 
   CurrentUploadAsset({
     required this.id,
     required this.fileCreatedAt,
     required this.fileName,
     required this.fileType,
+    this.fileSize,
     this.iCloudAsset,
   });
 
@@ -21,13 +23,15 @@ class CurrentUploadAsset {
     DateTime? fileCreatedAt,
     String? fileName,
     String? fileType,
+    int? fileSize,
     bool? iCloudAsset,
   }) {
     return CurrentUploadAsset(
       id: id ?? this.id,
       fileCreatedAt: fileCreatedAt ?? this.fileCreatedAt,
       fileName: fileName ?? this.fileName,
       fileType: fileType ?? this.fileType,
+      fileSize: fileSize ?? this.fileSize,
       iCloudAsset: iCloudAsset ?? this.iCloudAsset,
     );
   }
@@ -38,6 +42,7 @@ class CurrentUploadAsset {
       'fileCreatedAt': fileCreatedAt.millisecondsSinceEpoch,
       'fileName': fileName,
       'fileType': fileType,
+      'fileSize': fileSize,
       'iCloudAsset': iCloudAsset,
     };
   }
@@ -49,6 +54,7 @@ class CurrentUploadAsset {
           DateTime.fromMillisecondsSinceEpoch(map['fileCreatedAt'] as int),
       fileName: map['fileName'] as String,
       fileType: map['fileType'] as String,
+      fileSize: map['fileSize'] as int,
       iCloudAsset:
           map['iCloudAsset'] != null ? map['iCloudAsset'] as bool : null,
     );
@@ -61,7 +67,7 @@ class CurrentUploadAsset {
 
   @override
   String toString() {
-    return 'CurrentUploadAsset(id: $id, fileCreatedAt: $fileCreatedAt, fileName: $fileName, fileType: $fileType, iCloudAsset: $iCloudAsset)';
+    return 'CurrentUploadAsset(id: $id, fileCreatedAt: $fileCreatedAt, fileName: $fileName, fileType: $fileType, fileSize: $fileSize, iCloudAsset: $iCloudAsset)';
   }
 
   @override
@@ -72,6 +78,7 @@ class CurrentUploadAsset {
         other.fileCreatedAt == fileCreatedAt &&
         other.fileName == fileName &&
         other.fileType == fileType &&
+        other.fileSize == fileSize &&
         other.iCloudAsset == iCloudAsset;
   }
 
@@ -81,6 +88,7 @@ class CurrentUploadAsset {
         fileCreatedAt.hashCode ^
         fileName.hashCode ^
         fileType.hashCode ^
+        fileSize.hashCode ^
         iCloudAsset.hashCode;
   }
 }
diff --git a/mobile/lib/modules/backup/models/manual_upload_state.model.dart b/mobile/lib/modules/backup/models/manual_upload_state.model.dart
@@ -1,4 +1,6 @@
 import 'package:cancellation_token_http/http.dart';
+import 'package:collection/collection.dart';
+
 import 'package:immich_mobile/modules/backup/models/current_upload_asset.model.dart';
 
 class ManualUploadState {
@@ -14,9 +16,19 @@ class ManualUploadState {
   final int totalAssetsToUpload;
   final int successfulUploads;
   final double progressInPercentage;
+  final String progressInFileSize;
+  final double progressInFileSpeed;
+  final List<double> progressInFileSpeeds;
+  final DateTime progressInFileSpeedUpdateTime;
+  final int progressInFileSpeedUpdateSentBytes;
 
   const ManualUploadState({
     required this.progressInPercentage,
+    required this.progressInFileSize,
+    required this.progressInFileSpeed,
+    required this.progressInFileSpeeds,
+    required this.progressInFileSpeedUpdateTime,
+    required this.progressInFileSpeedUpdateSentBytes,
     required this.cancelToken,
     required this.currentUploadAsset,
     required this.totalAssetsToUpload,
@@ -27,6 +39,11 @@ class ManualUploadState {
 
   ManualUploadState copyWith({
     double? progressInPercentage,
+    String? progressInFileSize,
+    double? progressInFileSpeed,
+    List<double>? progressInFileSpeeds,
+    DateTime? progressInFileSpeedUpdateTime,
+    int? progressInFileSpeedUpdateSentBytes,
     CancellationToken? cancelToken,
     CurrentUploadAsset? currentUploadAsset,
     int? totalAssetsToUpload,
@@ -36,6 +53,13 @@ class ManualUploadState {
   }) {
     return ManualUploadState(
       progressInPercentage: progressInPercentage ?? this.progressInPercentage,
+      progressInFileSize: progressInFileSize ?? this.progressInFileSize,
+      progressInFileSpeed: progressInFileSpeed ?? this.progressInFileSpeed,
+      progressInFileSpeeds: progressInFileSpeeds ?? this.progressInFileSpeeds,
+      progressInFileSpeedUpdateTime:
+          progressInFileSpeedUpdateTime ?? this.progressInFileSpeedUpdateTime,
+      progressInFileSpeedUpdateSentBytes: progressInFileSpeedUpdateSentBytes ??
+          this.progressInFileSpeedUpdateSentBytes,
       cancelToken: cancelToken ?? this.cancelToken,
       currentUploadAsset: currentUploadAsset ?? this.currentUploadAsset,
       totalAssetsToUpload: totalAssetsToUpload ?? this.totalAssetsToUpload,
@@ -48,15 +72,22 @@ class ManualUploadState {
 
   @override
   String toString() {
-    return 'ManualUploadState(progressInPercentage: $progressInPercentage, cancelToken: $cancelToken, currentUploadAsset: $currentUploadAsset, totalAssetsToUpload: $totalAssetsToUpload, successfulUploads: $successfulUploads, currentAssetIndex: $currentAssetIndex, showDetailedNotification: $showDetailedNotification)';
+    return 'ManualUploadState(progressInPercentage: $progressInPercentage, progressInFileSize: $progressInFileSize, progressInFileSpeed: $progressInFileSpeed, progressInFileSpeeds: $progressInFileSpeeds, progressInFileSpeedUpdateTime: $progressInFileSpeedUpdateTime, progressInFileSpeedUpdateSentBytes: $progressInFileSpeedUpdateSentBytes, cancelToken: $cancelToken, currentUploadAsset: $currentUploadAsset, totalAssetsToUpload: $totalAssetsToUpload, successfulUploads: $successfulUploads, currentAssetIndex: $currentAssetIndex, showDetailedNotification: $showDetailedNotification)';
   }
 
   @override
   bool operator ==(Object other) {
     if (identical(this, other)) return true;
+    final collectionEquals = const DeepCollectionEquality().equals;
 
     return other is ManualUploadState &&
         other.progressInPercentage == progressInPercentage &&
+        other.progressInFileSize == progressInFileSize &&
+        other.progressInFileSpeed == progressInFileSpeed &&
+        collectionEquals(other.progressInFileSpeeds, progressInFileSpeeds) &&
+        other.progressInFileSpeedUpdateTime == progressInFileSpeedUpdateTime &&
+        other.progressInFileSpeedUpdateSentBytes ==
+            progressInFileSpeedUpdateSentBytes &&
         other.cancelToken == cancelToken &&
         other.currentUploadAsset == currentUploadAsset &&
         other.totalAssetsToUpload == totalAssetsToUpload &&
@@ -68,6 +99,11 @@ class ManualUploadState {
   @override
   int get hashCode {
     return progressInPercentage.hashCode ^
+        progressInFileSize.hashCode ^
+        progressInFileSpeed.hashCode ^
+        progressInFileSpeeds.hashCode ^
+        progressInFileSpeedUpdateTime.hashCode ^
+        progressInFileSpeedUpdateSentBytes.hashCode ^
         cancelToken.hashCode ^
         currentUploadAsset.hashCode ^
         totalAssetsToUpload.hashCode ^

diff --git a/mobile/lib/modules/backup/providers/backup.provider.dart b/mobile/lib/modules/backup/providers/backup.provider.dart
@@ -20,6 +20,7 @@ import 'package:immich_mobile/shared/models/store.dart';
 import 'package:immich_mobile/shared/providers/app_state.provider.dart';
 import 'package:immich_mobile/shared/providers/db.provider.dart';
 import 'package:immich_mobile/shared/services/server_info.service.dart';
+import 'package:immich_mobile/utils/backup_progress.dart';
 import 'package:immich_mobile/utils/diff.dart';
 import 'package:isar/isar.dart';
 import 'package:logging/logging.dart';
@@ -40,6 +41,11 @@ class BackupNotifier extends StateNotifier<BackUpState> {
             backupProgress: BackUpProgressEnum.idle,
             allAssetsInDatabase: const [],
             progressInPercentage: 0,
+            progressInFileSize: "0 B / 0 B",
+            progressInFileSpeed: 0,
+            progressInFileSpeeds: const [],
+            progressInFileSpeedUpdateTime: DateTime.now(),
+            progressInFileSpeedUpdateSentBytes: 0,
             cancelToken: CancellationToken(),
             autoBackup: Store.get(StoreKey.autoBackup, false),
             backgroundBackup: Store.get(StoreKey.backgroundBackup, false),
@@ -63,6 +69,7 @@ class BackupNotifier extends StateNotifier<BackUpState> {
               fileCreatedAt: DateTime.parse('2020-10-04'),
               fileName: '...',
               fileType: '...',
+              fileSize: 0,
               iCloudAsset: false,
             ),
             iCloudDownloadProgress: 0.0,
@@ -495,6 +502,10 @@ class BackupNotifier extends StateNotifier<BackUpState> {
     state = state.copyWith(
       backupProgress: BackUpProgressEnum.idle,
       progressInPercentage: 0.0,
+      progressInFileSize: "0 B / 0 B",
+      progressInFileSpeed: 0,
+      progressInFileSpeedUpdateTime: DateTime.now(),
+      progressInFileSpeedUpdateSentBytes: 0,
     );
   }
 
@@ -535,6 +546,10 @@ class BackupNotifier extends StateNotifier<BackUpState> {
             .toSet(),
         backupProgress: BackUpProgressEnum.done,
         progressInPercentage: 0.0,
+        progressInFileSize: "0 B / 0 B",
+        progressInFileSpeed: 0,
+        progressInFileSpeedUpdateTime: DateTime.now(),
+        progressInFileSpeedUpdateSentBytes: 0,
       );
       _updatePersistentAlbumsSelection();
     }
@@ -543,8 +558,36 @@ class BackupNotifier extends StateNotifier<BackUpState> {
   }
 
   void _onUploadProgress(int sent, int total) {
+    double lastUploadSpeed = state.progressInFileSpeed;
+    List<double> lastUploadSpeeds = state.progressInFileSpeeds.toList();
+    DateTime lastUpdateTime = state.progressInFileSpeedUpdateTime;
+    int lastSentBytes = state.progressInFileSpeedUpdateSentBytes;
+
+    final now = DateTime.now();
+    final duration = now.difference(lastUpdateTime);
+
+    // Keep the upload speed average span limited, to keep it somewhat relevant
+    if (lastUploadSpeeds.length > 10) {
+      lastUploadSpeeds.removeAt(0);
+    }
+
+    if (duration.inSeconds > 0) {
+      lastUploadSpeeds.add(
+        ((sent - lastSentBytes) / duration.inSeconds).abs().roundToDouble(),
+      );
+
+      lastUploadSpeed = lastUploadSpeeds.average.abs().roundToDouble();
+      lastUpdateTime = now;
+      lastSentBytes = sent;
+    }
+
     state = state.copyWith(
       progressInPercentage: (sent.toDouble() / total.toDouble() * 100),
+      progressInFileSize: humanReadableFileBytesProgress(sent, total),
+      progressInFileSpeed: lastUploadSpeed,
+      progressInFileSpeeds: lastUploadSpeeds,
+      progressInFileSpeedUpdateTime: lastUpdateTime,
+      progressInFileSpeedUpdateSentBytes: lastSentBytes,
     );
   }