feat(mobile): Adds file upload progress stats

mobile/assets/i18n/en-US.json

@@ -477,4 +477,4 @@
   "viewer_remove_from_stack": "Remove from Stack",
   "viewer_stack_use_as_main_asset": "Use as Main Asset",
   "viewer_unstack": "Un-Stack"
-}
+}

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 ^

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;
   }
 }

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 ^

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,
     );
   }