feat(mobile): use shared native client (#25942)

* use shared client in dart fix android * websocket integration platform-side headers update comment consistent platform check tweak websocket handling support streaming * redundant logging * fix proguard * formatting * handle onProgress * support videos on ios * inline return * improved ios impl * cleanup * sync stopForegroundBackup * voidify * future already completed * stream request on android * outdated ios ws code * use `choosePrivateKeyAlias` * return result * formatting * update tests * redundant check * handle custom headers * move completer outside of state * persist auth * dispose old socket * use group id for cookies * redundant headers * cache global ref * handle network switching * handle basic auth * apply custom headers immediately * video player update * fix * persist url * potential logout fix --------- Co-authored-by: Alex <alex.tran1502@gmail.com>
2026-03-22 16:29:27 +03:00 · 2026-03-05 12:04:45 -05:00
parent 35a521c6ec
commit a05c8c6087
57 changed files with 880 additions and 855 deletions
--- a/mobile/lib/providers/app_life_cycle.provider.dart
+++ b/mobile/lib/providers/app_life_cycle.provider.dart
@@ -232,7 +232,7 @@ class AppLifeCycleNotifier extends StateNotifier<AppLifeCycleEnum> {
    }
  }

-  Future<void> _performPause() async {
+  Future<void> _performPause() {
    if (_ref.read(authProvider).isAuthenticated) {
      if (!Store.isBetaTimelineEnabled) {
        // Do not cancel backup if manual upload is in progress
@@ -240,15 +240,13 @@ class AppLifeCycleNotifier extends StateNotifier<AppLifeCycleEnum> {
          _ref.read(backupProvider.notifier).cancelBackup();
        }
      } else {
-        await _ref.read(driftBackupProvider.notifier).stopForegroundBackup();
+        _ref.read(driftBackupProvider.notifier).stopForegroundBackup();
      }

      _ref.read(websocketProvider.notifier).disconnect();
    }

-    try {
-      await LogService.I.flush();
-    } catch (_) {}
+    return LogService.I.flush().catchError((_) {});
  }

  Future<void> handleAppDetached() async {
--- a/mobile/lib/providers/auth.provider.dart
+++ b/mobile/lib/providers/auth.provider.dart
@@ -124,6 +124,7 @@ class AuthNotifier extends StateNotifier<AuthState> {

  Future<bool> saveAuthInfo({required String accessToken}) async {
    await _apiService.setAccessToken(accessToken);
+    await _apiService.updateHeaders();

    final serverEndpoint = Store.get(StoreKey.serverEndpoint);
    final customHeaders = Store.tryGet(StoreKey.customHeaders);
--- a/mobile/lib/providers/backup/asset_upload_progress.provider.dart
+++ b/mobile/lib/providers/backup/asset_upload_progress.provider.dart
@@ -1,4 +1,5 @@
-import 'package:cancellation_token_http/http.dart';
+import 'dart:async';
+
 import 'package:hooks_riverpod/hooks_riverpod.dart';

 /// Tracks per-asset upload progress.
@@ -30,4 +31,4 @@ final assetUploadProgressProvider = NotifierProvider<AssetUploadProgressNotifier
  AssetUploadProgressNotifier.new,
 );

-final manualUploadCancelTokenProvider = StateProvider<CancellationToken?>((ref) => null);
+final manualUploadCancelTokenProvider = StateProvider<Completer<void>?>((ref) => null);
--- a/mobile/lib/providers/backup/backup.provider.dart
+++ b/mobile/lib/providers/backup/backup.provider.dart
@@ -1,6 +1,6 @@
+import 'dart:async';
 import 'dart:io';

-import 'package:cancellation_token_http/http.dart';
 import 'package:collection/collection.dart';
 import 'package:hooks_riverpod/hooks_riverpod.dart';
 import 'package:immich_mobile/domain/models/store.model.dart';
@@ -68,7 +68,6 @@ class BackupNotifier extends StateNotifier<BackUpState> {
          progressInFileSpeeds: const [],
          progressInFileSpeedUpdateTime: DateTime.now(),
          progressInFileSpeedUpdateSentBytes: 0,
-          cancelToken: CancellationToken(),
          autoBackup: Store.get(StoreKey.autoBackup, false),
          backgroundBackup: Store.get(StoreKey.backgroundBackup, false),
          backupRequireWifi: Store.get(StoreKey.backupRequireWifi, true),
@@ -102,6 +101,7 @@ class BackupNotifier extends StateNotifier<BackUpState> {
  final FileMediaRepository _fileMediaRepository;
  final BackupAlbumService _backupAlbumService;
  final Ref ref;
+  Completer<void>? _cancelToken;

  ///
  /// UI INTERACTION
@@ -454,7 +454,8 @@ class BackupNotifier extends StateNotifier<BackUpState> {
      }

      // Perform Backup
-      state = state.copyWith(cancelToken: CancellationToken());
+      _cancelToken?.complete();
+      _cancelToken = Completer<void>();

      final pmProgressHandler = Platform.isIOS ? PMProgressHandler() : null;

@@ -465,7 +466,7 @@ class BackupNotifier extends StateNotifier<BackUpState> {

      await _backupService.backupAsset(
        assetsWillBeBackup,
-        state.cancelToken,
+        _cancelToken!,
        pmProgressHandler: pmProgressHandler,
        onSuccess: _onAssetUploaded,
        onProgress: _onUploadProgress,
@@ -494,7 +495,8 @@ class BackupNotifier extends StateNotifier<BackUpState> {
    if (state.backupProgress != BackUpProgressEnum.inProgress) {
      notifyBackgroundServiceCanRun();
    }
-    state.cancelToken.cancel();
+    _cancelToken?.complete();
+    _cancelToken = null;
    state = state.copyWith(
      backupProgress: BackUpProgressEnum.idle,
      progressInPercentage: 0.0,
--- a/mobile/lib/providers/backup/drift_backup.provider.dart
+++ b/mobile/lib/providers/backup/drift_backup.provider.dart
@@ -1,6 +1,5 @@
 import 'dart:async';

-import 'package:cancellation_token_http/http.dart';
 import 'package:collection/collection.dart';
 import 'package:hooks_riverpod/hooks_riverpod.dart';
 import 'package:logging/logging.dart';
@@ -109,7 +108,6 @@ class DriftBackupState {
  final BackupError error;

  final Map<String, DriftUploadStatus> uploadItems;
-  final CancellationToken? cancelToken;

  final Map<String, double> iCloudDownloadProgress;

@@ -121,7 +119,6 @@ class DriftBackupState {
    required this.isSyncing,
    this.error = BackupError.none,
    required this.uploadItems,
-    this.cancelToken,
    this.iCloudDownloadProgress = const {},
  });

@@ -133,7 +130,6 @@ class DriftBackupState {
    bool? isSyncing,
    BackupError? error,
    Map<String, DriftUploadStatus>? uploadItems,
-    CancellationToken? cancelToken,
    Map<String, double>? iCloudDownloadProgress,
  }) {
    return DriftBackupState(
@@ -144,7 +140,6 @@ class DriftBackupState {
      isSyncing: isSyncing ?? this.isSyncing,
      error: error ?? this.error,
      uploadItems: uploadItems ?? this.uploadItems,
-      cancelToken: cancelToken ?? this.cancelToken,
      iCloudDownloadProgress: iCloudDownloadProgress ?? this.iCloudDownloadProgress,
    );
  }
@@ -153,7 +148,7 @@ class DriftBackupState {

  @override
  String toString() {
-    return 'DriftBackupState(totalCount: $totalCount, backupCount: $backupCount, remainderCount: $remainderCount, processingCount: $processingCount, isSyncing: $isSyncing, error: $error, uploadItems: $uploadItems, cancelToken: $cancelToken, iCloudDownloadProgress: $iCloudDownloadProgress)';
+    return 'DriftBackupState(totalCount: $totalCount, backupCount: $backupCount, remainderCount: $remainderCount, processingCount: $processingCount, isSyncing: $isSyncing, error: $error, uploadItems: $uploadItems, iCloudDownloadProgress: $iCloudDownloadProgress)';
  }

  @override
@@ -168,8 +163,7 @@ class DriftBackupState {
        other.isSyncing == isSyncing &&
        other.error == error &&
        mapEquals(other.iCloudDownloadProgress, iCloudDownloadProgress) &&
-        mapEquals(other.uploadItems, uploadItems) &&
-        other.cancelToken == cancelToken;
+        mapEquals(other.uploadItems, uploadItems);
  }

  @override
@@ -181,7 +175,6 @@ class DriftBackupState {
        isSyncing.hashCode ^
        error.hashCode ^
        uploadItems.hashCode ^
-        cancelToken.hashCode ^
        iCloudDownloadProgress.hashCode;
  }
 }
@@ -211,6 +204,7 @@ class DriftBackupNotifier extends StateNotifier<DriftBackupState> {
  final ForegroundUploadService _foregroundUploadService;
  final BackgroundUploadService _backgroundUploadService;
  final UploadSpeedManager _uploadSpeedManager;
+  Completer<void>? _cancelToken;

  final _logger = Logger("DriftBackupNotifier");

@@ -246,7 +240,7 @@ class DriftBackupNotifier extends StateNotifier<DriftBackupState> {
    );
  }

-  void updateError(BackupError error) async {
+  void updateError(BackupError error) {
    if (!mounted) {
      _logger.warning("Skip updateError: notifier disposed");
      return;
@@ -254,24 +248,23 @@ class DriftBackupNotifier extends StateNotifier<DriftBackupState> {
    state = state.copyWith(error: error);
  }

-  void updateSyncing(bool isSyncing) async {
+  void updateSyncing(bool isSyncing) {
    state = state.copyWith(isSyncing: isSyncing);
  }

-  Future<void> startForegroundBackup(String userId) async {
+  Future<void> startForegroundBackup(String userId) {
    // Cancel any existing backup before starting a new one
-    if (state.cancelToken != null) {
-      await stopForegroundBackup();
+    if (_cancelToken != null) {
+      stopForegroundBackup();
    }

    state = state.copyWith(error: BackupError.none);

-    final cancelToken = CancellationToken();
-    state = state.copyWith(cancelToken: cancelToken);
+    _cancelToken = Completer<void>();

    return _foregroundUploadService.uploadCandidates(
      userId,
-      cancelToken,
+      _cancelToken!,
      callbacks: UploadCallbacks(
        onProgress: _handleForegroundBackupProgress,
        onSuccess: _handleForegroundBackupSuccess,
@@ -281,10 +274,11 @@ class DriftBackupNotifier extends StateNotifier<DriftBackupState> {
    );
  }

-  Future<void> stopForegroundBackup() async {
-    state.cancelToken?.cancel();
+  void stopForegroundBackup() {
+    _cancelToken?.complete();
+    _cancelToken = null;
    _uploadSpeedManager.clear();
-    state = state.copyWith(cancelToken: null, uploadItems: {}, iCloudDownloadProgress: {});
+    state = state.copyWith(uploadItems: {}, iCloudDownloadProgress: {});
  }

  void _handleICloudProgress(String localAssetId, double progress) {
@@ -300,7 +294,7 @@ class DriftBackupNotifier extends StateNotifier<DriftBackupState> {
  }

  void _handleForegroundBackupProgress(String localAssetId, String filename, int bytes, int totalBytes) {
-    if (state.cancelToken == null) {
+    if (_cancelToken == null) {
      return;
    }

@@ -399,7 +393,7 @@ class DriftBackupNotifier extends StateNotifier<DriftBackupState> {
  }
 }

-final driftBackupCandidateProvider = FutureProvider.autoDispose<List<LocalAsset>>((ref) async {
+final driftBackupCandidateProvider = FutureProvider.autoDispose<List<LocalAsset>>((ref) {
  final user = ref.watch(currentUserProvider);
  if (user == null) {
    return [];
--- a/mobile/lib/providers/backup/manual_upload.provider.dart
+++ b/mobile/lib/providers/backup/manual_upload.provider.dart
@@ -1,7 +1,6 @@
 import 'dart:async';
 import 'dart:io';

-import 'package:cancellation_token_http/http.dart';
 import 'package:collection/collection.dart';
 import 'package:easy_localization/easy_localization.dart';
 import 'package:flutter/widgets.dart';
@@ -50,6 +49,7 @@ class ManualUploadNotifier extends StateNotifier<ManualUploadState> {
  final BackupService _backupService;
  final BackupAlbumService _backupAlbumService;
  final Ref ref;
+  Completer<void>? _cancelToken;

  ManualUploadNotifier(
    this._localNotificationService,
@@ -65,7 +65,6 @@ class ManualUploadNotifier extends StateNotifier<ManualUploadState> {
          progressInFileSpeeds: const [],
          progressInFileSpeedUpdateTime: DateTime.now(),
          progressInFileSpeedUpdateSentBytes: 0,
-          cancelToken: CancellationToken(),
          currentUploadAsset: CurrentUploadAsset(
            id: '...',
            fileCreatedAt: DateTime.parse('2020-10-04'),
@@ -236,7 +235,6 @@ class ManualUploadNotifier extends StateNotifier<ManualUploadState> {
            fileName: '...',
            fileType: '...',
          ),
-          cancelToken: CancellationToken(),
        );
        // Reset Error List
        ref.watch(errorBackupListProvider.notifier).empty();
@@ -252,11 +250,13 @@ class ManualUploadNotifier extends StateNotifier<ManualUploadState> {
        state = state.copyWith(showDetailedNotification: showDetailedNotification);
        final pmProgressHandler = Platform.isIOS ? PMProgressHandler() : null;

+        _cancelToken?.complete();
+        _cancelToken = Completer<void>();
        final bool ok = await ref
            .read(backupServiceProvider)
            .backupAsset(
              uploadAssets,
-              state.cancelToken,
+              _cancelToken!,
              pmProgressHandler: pmProgressHandler,
              onSuccess: _onAssetUploaded,
              onProgress: _onProgress,
@@ -273,14 +273,14 @@ class ManualUploadNotifier extends StateNotifier<ManualUploadState> {
        );

        // User cancelled upload
-        if (!ok && state.cancelToken.isCancelled) {
+        if (!ok && _cancelToken == null) {
          await _localNotificationService.showOrUpdateManualUploadStatus(
            "backup_manual_title".tr(),
            "backup_manual_cancelled".tr(),
            presentBanner: true,
          );
          hasErrors = true;
-        } else if (state.successfulUploads == 0 || (!ok && !state.cancelToken.isCancelled)) {
+        } else if (state.successfulUploads == 0 || (!ok && _cancelToken != null)) {
          await _localNotificationService.showOrUpdateManualUploadStatus(
            "backup_manual_title".tr(),
            "failed".tr(),
@@ -324,7 +324,8 @@ class ManualUploadNotifier extends StateNotifier<ManualUploadState> {
        _backupProvider.backupProgress != BackUpProgressEnum.manualInProgress) {
      _backupProvider.notifyBackgroundServiceCanRun();
    }
-    state.cancelToken.cancel();
+    _cancelToken?.complete();
+    _cancelToken = null;
    if (_backupProvider.backupProgress != BackUpProgressEnum.manualInProgress) {
      _backupProvider.updateBackupProgress(BackUpProgressEnum.idle);
    }
--- a/mobile/lib/providers/image/cache/image_loader.dart
+++ b/mobile/lib/providers/image/cache/image_loader.dart
@@ -1,40 +0,0 @@
-import 'dart:async';
-import 'dart:ui' as ui;
-
-import 'package:flutter/material.dart';
-import 'package:flutter_cache_manager/flutter_cache_manager.dart';
-import 'package:immich_mobile/providers/image/exceptions/image_loading_exception.dart';
-import 'package:immich_mobile/services/api.service.dart';
-
-/// Loads the codec from the URI and sends the events to the [chunkEvents] stream
-///
-/// Credit to [flutter_cached_network_image](https://github.com/Baseflow/flutter_cached_network_image/blob/develop/cached_network_image/lib/src/image_provider/_image_loader.dart)
-/// for this wonderful implementation of their image loader
-class ImageLoader {
-  static Future<ui.Codec> loadImageFromCache(
-    String uri, {
-    required CacheManager cache,
-    required ImageDecoderCallback decode,
-    StreamController<ImageChunkEvent>? chunkEvents,
-  }) async {
-    final headers = ApiService.getRequestHeaders();
-
-    final stream = cache.getFileStream(uri, withProgress: chunkEvents != null, headers: headers);
-
-    await for (final result in stream) {
-      if (result is DownloadProgress) {
-        // We are downloading the file, so update the [chunkEvents]
-        chunkEvents?.add(
-          ImageChunkEvent(cumulativeBytesLoaded: result.downloaded, expectedTotalBytes: result.totalSize),
-        );
-      } else if (result is FileInfo) {
-        // We have the file
-        final buffer = await ui.ImmutableBuffer.fromFilePath(result.file.path);
-        return decode(buffer);
-      }
-    }
-
-    // If we get here, the image failed to load from the cache stream
-    throw const ImageLoadingException('Could not load image from stream');
-  }
-}
--- a/mobile/lib/providers/image/cache/remote_image_cache_manager.dart
+++ b/mobile/lib/providers/image/cache/remote_image_cache_manager.dart
@@ -1,25 +0,0 @@
-import 'package:flutter_cache_manager/flutter_cache_manager.dart';
-
-class RemoteImageCacheManager extends CacheManager {
-  static const key = 'remoteImageCacheKey';
-  static final RemoteImageCacheManager _instance = RemoteImageCacheManager._();
-  static final _config = Config(key, maxNrOfCacheObjects: 500, stalePeriod: const Duration(days: 30));
-
-  factory RemoteImageCacheManager() {
-    return _instance;
-  }
-
-  RemoteImageCacheManager._() : super(_config);
-}
-
-class RemoteThumbnailCacheManager extends CacheManager {
-  static const key = 'remoteThumbnailCacheKey';
-  static final RemoteThumbnailCacheManager _instance = RemoteThumbnailCacheManager._();
-  static final _config = Config(key, maxNrOfCacheObjects: 5000, stalePeriod: const Duration(days: 30));
-
-  factory RemoteThumbnailCacheManager() {
-    return _instance;
-  }
-
-  RemoteThumbnailCacheManager._() : super(_config);
-}
--- a/mobile/lib/providers/image/cache/thumbnail_image_cache_manager.dart
+++ b/mobile/lib/providers/image/cache/thumbnail_image_cache_manager.dart
@@ -1,13 +0,0 @@
-import 'package:flutter_cache_manager/flutter_cache_manager.dart';
-
-/// The cache manager for thumbnail images [ImmichRemoteThumbnailProvider]
-class ThumbnailImageCacheManager extends CacheManager {
-  static const key = 'thumbnailImageCacheKey';
-  static final ThumbnailImageCacheManager _instance = ThumbnailImageCacheManager._();
-
-  factory ThumbnailImageCacheManager() {
-    return _instance;
-  }
-
-  ThumbnailImageCacheManager._() : super(Config(key, maxNrOfCacheObjects: 5000, stalePeriod: const Duration(days: 30)));
-}
--- a/mobile/lib/providers/infrastructure/action.provider.dart
+++ b/mobile/lib/providers/infrastructure/action.provider.dart
@@ -2,7 +2,6 @@ import 'dart:async';

 import 'package:auto_route/auto_route.dart';
 import 'package:background_downloader/background_downloader.dart';
-import 'package:cancellation_token_http/http.dart';
 import 'package:flutter/material.dart';
 import 'package:immich_mobile/constants/enums.dart';
 import 'package:immich_mobile/domain/models/asset/base_asset.model.dart';
@@ -455,7 +454,7 @@ class ActionNotifier extends Notifier<void> {
    final assetsToUpload = assets ?? _getAssets(source).whereType<LocalAsset>().toList();

    final progressNotifier = ref.read(assetUploadProgressProvider.notifier);
-    final cancelToken = CancellationToken();
+    final cancelToken = Completer<void>();
    ref.read(manualUploadCancelTokenProvider.notifier).state = cancelToken;

    // Initialize progress for all assets
@@ -466,7 +465,7 @@ class ActionNotifier extends Notifier<void> {
    try {
      await _foregroundUploadService.uploadManual(
        assetsToUpload,
-        cancelToken,
+        cancelToken: cancelToken,
        callbacks: UploadCallbacks(
          onProgress: (localAssetId, filename, bytes, totalBytes) {
            final progress = totalBytes > 0 ? bytes / totalBytes : 0.0;
--- a/mobile/lib/providers/websocket.provider.dart
+++ b/mobile/lib/providers/websocket.provider.dart
@@ -1,18 +1,17 @@
 import 'dart:async';
-import 'dart:convert';

 import 'package:collection/collection.dart';
 import 'package:hooks_riverpod/hooks_riverpod.dart';
 import 'package:immich_mobile/domain/models/store.model.dart';
 import 'package:immich_mobile/entities/asset.entity.dart';
 import 'package:immich_mobile/entities/store.entity.dart';
+import 'package:immich_mobile/infrastructure/repositories/network.repository.dart';
 import 'package:immich_mobile/models/server_info/server_version.model.dart';
 import 'package:immich_mobile/providers/asset.provider.dart';
 import 'package:immich_mobile/providers/auth.provider.dart';
 import 'package:immich_mobile/providers/background_sync.provider.dart';
 import 'package:immich_mobile/providers/db.provider.dart';
 import 'package:immich_mobile/providers/server_info.provider.dart';
-import 'package:immich_mobile/services/api.service.dart';
 import 'package:immich_mobile/services/sync.service.dart';
 import 'package:immich_mobile/utils/debounce.dart';
 import 'package:immich_mobile/utils/debug_print.dart';
@@ -99,11 +98,6 @@ class WebsocketNotifier extends StateNotifier<WebsocketState> {
    if (authenticationState.isAuthenticated) {
      try {
        final endpoint = Uri.parse(Store.get(StoreKey.serverEndpoint));
-        final headers = ApiService.getRequestHeaders();
-        if (endpoint.userInfo.isNotEmpty) {
-          headers["Authorization"] = "Basic ${base64.encode(utf8.encode(endpoint.userInfo))}";
-        }
-
        dPrint(() => "Attempting to connect to websocket");
        // Configure socket transports must be specified
        Socket socket = io(
@@ -111,11 +105,11 @@ class WebsocketNotifier extends StateNotifier<WebsocketState> {
          OptionBuilder()
              .setPath("${endpoint.path}/socket.io")
              .setTransports(['websocket'])
+              .setWebSocketConnector(NetworkRepository.createWebSocket)
              .enableReconnection()
              .enableForceNew()
              .enableForceNewConnection()
              .enableAutoConnect()
-              .setExtraHeaders(headers)
              .build(),
        );

@@ -160,11 +154,8 @@ class WebsocketNotifier extends StateNotifier<WebsocketState> {

    _batchedAssetUploadReady.clear();

-    var socket = state.socket?.disconnect();
-
-    if (socket?.disconnected == true) {
-      state = WebsocketState(isConnected: false, socket: null, pendingChanges: state.pendingChanges);
-    }
+    state.socket?.dispose();
+    state = WebsocketState(isConnected: false, socket: null, pendingChanges: state.pendingChanges);
  }

  void stopListenToEvent(String eventName) {