feat(mobile): native clients (#21459)

* platform clients

* uppercase http method

* fix hot reload

* custom user agent

* init before app launch

* set defaults

* move to bootstrap

* unrelated change

* disable disk cache by default

* optimized decoding

* remove incremental

* android impl

* memory optimization

* lock approach is slower on ios

* conditional cronet

* clarify parameter

* enable disk cache

* set user agent

* flutter-side decode

* optimized http

* fixed locking

* refactor

* potential race conditions

* embedded cronet

* refactor, fix capacity handling

* fast path for known content length

* ios optimizations

* re-enable cache

* formatting

* bump concurrency

* clear cache button

* fix eviction race condition

* add extra cancellation check

* tighten dispose

* better error handling

* fix disposal

---------

Co-authored-by: Alex <alex.tran1502@gmail.com>

mobile/lib/infrastructure/loaders/image_request.dart

@@ -1,15 +1,12 @@
 import 'dart:async';
 import 'dart:ffi';
-import 'dart:io';
 import 'dart:ui' as ui;
 
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import 'package:ffi/ffi.dart';
 import 'package:immich_mobile/domain/models/asset/base_asset.model.dart';
-import 'package:immich_mobile/providers/image/cache/remote_image_cache_manager.dart';
 import 'package:immich_mobile/providers/infrastructure/platform.provider.dart';
-import 'package:logging/logging.dart';
 
 part 'local_image_request.dart';
 part 'thumbhash_image_request.dart';
@@ -37,27 +34,61 @@ abstract class ImageRequest {
 
   void _onCancelled();
 
-  Future<ui.FrameInfo?> _fromPlatformImage(Map<String, int> info) async {
-    final address = info['pointer'];
-    if (address == null) {
-      return null;
-    }
-
+  Future<ui.FrameInfo?> _fromEncodedPlatformImage(int address, int length) async {
     final pointer = Pointer<Uint8>.fromAddress(address);
     if (_isCancelled) {
       malloc.free(pointer);
       return null;
     }
 
-    final int actualWidth;
-    final int actualHeight;
-    final int actualSize;
     final ui.ImmutableBuffer buffer;
     try {
-      actualWidth = info['width']!;
-      actualHeight = info['height']!;
-      actualSize = actualWidth * actualHeight * 4;
-      buffer = await ImmutableBuffer.fromUint8List(pointer.asTypedList(actualSize));
+      buffer = await ImmutableBuffer.fromUint8List(pointer.asTypedList(length));
+    } finally {
+      malloc.free(pointer);
+    }
+
+    if (_isCancelled) {
+      buffer.dispose();
+      return null;
+    }
+
+    final descriptor = await ui.ImageDescriptor.encoded(buffer);
+    buffer.dispose();
+    if (_isCancelled) {
+      descriptor.dispose();
+      return null;
+    }
+
+    final codec = await descriptor.instantiateCodec();
+    if (_isCancelled) {
+      descriptor.dispose();
+      codec.dispose();
+      return null;
+    }
+
+    final frame = await codec.getNextFrame();
+    descriptor.dispose();
+    codec.dispose();
+    if (_isCancelled) {
+      frame.image.dispose();
+      return null;
+    }
+
+    return frame;
+  }
+
+  Future<ui.FrameInfo?> _fromDecodedPlatformImage(int address, int width, int height, int rowBytes) async {
+    final pointer = Pointer<Uint8>.fromAddress(address);
+    if (_isCancelled) {
+      malloc.free(pointer);
+      return null;
+    }
+
+    final size = rowBytes * height;
+    final ui.ImmutableBuffer buffer;
+    try {
+      buffer = await ImmutableBuffer.fromUint8List(pointer.asTypedList(size));
     } finally {
       malloc.free(pointer);
     }
@@ -69,18 +100,28 @@ abstract class ImageRequest {
 
     final descriptor = ui.ImageDescriptor.raw(
       buffer,
-      width: actualWidth,
-      height: actualHeight,
+      width: width,
+      height: height,
+      rowBytes: rowBytes,
       pixelFormat: ui.PixelFormat.rgba8888,
     );
+    buffer.dispose();
+
     final codec = await descriptor.instantiateCodec();
     if (_isCancelled) {
-      buffer.dispose();
       descriptor.dispose();
       codec.dispose();
       return null;
     }
 
-    return await codec.getNextFrame();
+    final frame = await codec.getNextFrame();
+    descriptor.dispose();
+    codec.dispose();
+    if (_isCancelled) {
+      frame.image.dispose();
+      return null;
+    }
+
+    return frame;
   }
 }

mobile/lib/infrastructure/loaders/local_image_request.dart

@@ -16,20 +16,23 @@ class LocalImageRequest extends ImageRequest {
       return null;
     }
 
-    final Map<String, int> info = await thumbnailApi.requestImage(
+    final info = await localImageApi.requestImage(
       localId,
       requestId: requestId,
       width: width,
       height: height,
       isVideo: assetType == AssetType.video,
     );
+    if (info == null) {
+      return null;
+    }
 
-    final frame = await _fromPlatformImage(info);
+    final frame = await _fromDecodedPlatformImage(info["pointer"]!, info["width"]!, info["height"]!, info["rowBytes"]!);
     return frame == null ? null : ImageInfo(image: frame.image, scale: scale);
   }
 
   @override
   Future<void> _onCancelled() {
-    return thumbnailApi.cancelImageRequest(requestId);
+    return localImageApi.cancelRequest(requestId);
   }
 }

mobile/lib/infrastructure/loaders/remote_image_request.dart

@@ -1,14 +1,10 @@
 part of 'image_request.dart';
 
 class RemoteImageRequest extends ImageRequest {
-  static final log = Logger('RemoteImageRequest');
-  static final client = HttpClient()..maxConnectionsPerHost = 16;
-  final RemoteCacheManager? cacheManager;
   final String uri;
   final Map<String, String> headers;
-  HttpClientRequest? _request;
 
-  RemoteImageRequest({required this.uri, required this.headers, this.cacheManager});
+  RemoteImageRequest({required this.uri, required this.headers});
 
   @override
   Future<ImageInfo?> load(ImageDecoderCallback decode, {double scale = 1.0}) async {
@@ -16,164 +12,18 @@ class RemoteImageRequest extends ImageRequest {
       return null;
     }
 
-    // TODO: the cache manager makes everything sequential with its DB calls and its operations cannot be cancelled,
-    //  so it ends up being a bottleneck.  We only prefer fetching from it when it can skip the DB call.
-    final cachedFileImage = await _loadCachedFile(uri, decode, scale, inMemoryOnly: true);
-    if (cachedFileImage != null) {
-      return cachedFileImage;
-    }
-
-    try {
-      final buffer = await _downloadImage(uri);
-      if (buffer == null) {
-        return null;
-      }
-
-      return await _decodeBuffer(buffer, decode, scale);
-    } catch (e) {
-      if (_isCancelled) {
-        return null;
-      }
-
-      final cachedFileImage = await _loadCachedFile(uri, decode, scale, inMemoryOnly: false);
-      if (cachedFileImage != null) {
-        return cachedFileImage;
-      }
-
-      rethrow;
-    } finally {
-      _request = null;
-    }
-  }
-
-  Future<ImmutableBuffer?> _downloadImage(String url) async {
-    if (_isCancelled) {
-      return null;
-    }
-
-    final request = _request = await client.getUrl(Uri.parse(url));
-    if (_isCancelled) {
-      request.abort();
-      return _request = null;
-    }
-
-    for (final entry in headers.entries) {
-      request.headers.set(entry.key, entry.value);
-    }
-    final response = await request.close();
-    if (_isCancelled) {
-      return null;
-    }
-
-    final cacheManager = this.cacheManager;
-    final streamController = StreamController<List<int>>(sync: true);
-    final Stream<List<int>> stream;
-    unawaited(cacheManager?.putStreamedFile(url, streamController.stream));
-    stream = response.map((chunk) {
-      if (_isCancelled) {
-        throw StateError('Cancelled request');
-      }
-      if (cacheManager != null) {
-        streamController.add(chunk);
-      }
-      return chunk;
-    });
-
-    try {
-      final Uint8List bytes = await _downloadBytes(stream, response.contentLength);
-      unawaited(streamController.close());
-      return await ImmutableBuffer.fromUint8List(bytes);
-    } catch (e) {
-      streamController.addError(e);
-      unawaited(streamController.close());
-      if (_isCancelled) {
-        return null;
-      }
-      rethrow;
-    }
-  }
-
-  Future<Uint8List> _downloadBytes(Stream<List<int>> stream, int length) async {
-    final Uint8List bytes;
-    int offset = 0;
-    if (length > 0) {
-      // Known content length - use pre-allocated buffer
-      bytes = Uint8List(length);
-      await stream.listen((chunk) {
-        bytes.setAll(offset, chunk);
-        offset += chunk.length;
-      }, cancelOnError: true).asFuture();
-    } else {
-      // Unknown content length - collect chunks dynamically
-      final chunks = <List<int>>[];
-      int totalLength = 0;
-      await stream.listen((chunk) {
-        chunks.add(chunk);
-        totalLength += chunk.length;
-      }, cancelOnError: true).asFuture();
-
-      bytes = Uint8List(totalLength);
-      for (final chunk in chunks) {
-        bytes.setAll(offset, chunk);
-        offset += chunk.length;
-      }
-    }
-
-    return bytes;
-  }
-
-  Future<ImageInfo?> _loadCachedFile(
-    String url,
-    ImageDecoderCallback decode,
-    double scale, {
-    required bool inMemoryOnly,
-  }) async {
-    final cacheManager = this.cacheManager;
-    if (_isCancelled || cacheManager == null) {
-      return null;
-    }
-
-    final file = await (inMemoryOnly ? cacheManager.getFileFromMemory(url) : cacheManager.getFileFromCache(url));
-    if (_isCancelled || file == null) {
-      return null;
-    }
-
-    try {
-      final buffer = await ImmutableBuffer.fromFilePath(file.file.path);
-      return await _decodeBuffer(buffer, decode, scale);
-    } catch (e) {
-      log.severe('Failed to decode cached image', e);
-      unawaited(_evictFile(url));
-      return null;
-    }
-  }
-
-  Future<void> _evictFile(String url) async {
-    try {
-      await cacheManager?.removeFile(url);
-    } catch (e) {
-      log.severe('Failed to remove cached image', e);
-    }
-  }
-
-  Future<ImageInfo?> _decodeBuffer(ImmutableBuffer buffer, ImageDecoderCallback decode, scale) async {
-    if (_isCancelled) {
-      buffer.dispose();
-      return null;
-    }
-    final codec = await decode(buffer);
-    if (_isCancelled) {
-      buffer.dispose();
-      codec.dispose();
-      return null;
-    }
-    final frame = await codec.getNextFrame();
-    return ImageInfo(image: frame.image, scale: scale);
+    final info = await remoteImageApi.requestImage(uri, headers: headers, requestId: requestId);
+    final frame = switch (info) {
+      {'pointer': int pointer, 'length': int length} => await _fromEncodedPlatformImage(pointer, length),
+      {'pointer': int pointer, 'width': int width, 'height': int height, 'rowBytes': int rowBytes} =>
+        await _fromDecodedPlatformImage(pointer, width, height, rowBytes),
+      _ => null,
+    };
+    return frame == null ? null : ImageInfo(image: frame.image, scale: scale);
   }
 
   @override
-  void _onCancelled() {
-    _request?.abort();
-    _request = null;
+  Future<void> _onCancelled() {
+    return remoteImageApi.cancelRequest(requestId);
   }
 }

mobile/lib/infrastructure/loaders/thumbhash_image_request.dart

@@ -11,8 +11,8 @@ class ThumbhashImageRequest extends ImageRequest {
       return null;
     }
 
-    final Map<String, int> info = await thumbnailApi.getThumbhash(thumbhash);
-    final frame = await _fromPlatformImage(info);
+    final Map<String, int> info = await localImageApi.getThumbhash(thumbhash);
+    final frame = await _fromDecodedPlatformImage(info["pointer"]!, info["width"]!, info["height"]!, info["rowBytes"]!);
     return frame == null ? null : ImageInfo(image: frame.image, scale: scale);
   }
 

mobile/lib/infrastructure/repositories/network.repository.dart

@@ -0,0 +1,67 @@
+import 'dart:io';
+
+import 'package:cronet_http/cronet_http.dart';
+import 'package:cupertino_http/cupertino_http.dart';
+import 'package:http/http.dart' as http;
+import 'package:immich_mobile/utils/user_agent.dart';
+import 'package:path_provider/path_provider.dart';
+
+class NetworkRepository {
+  static late Directory _cachePath;
+  static late String _userAgent;
+  static final _clients = <String, http.Client>{};
+
+  static Future<void> init() {
+    return (
+      getTemporaryDirectory().then((cachePath) => _cachePath = cachePath),
+      getUserAgentString().then((userAgent) => _userAgent = userAgent),
+    ).wait;
+  }
+
+  static void reset() {
+    Future.microtask(init);
+    for (final client in _clients.values) {
+      client.close();
+    }
+    _clients.clear();
+  }
+
+  const NetworkRepository();
+
+  /// Note: when disk caching is enabled, only one client may use a given directory at a time.
+  /// Different isolates or engines must use different directories.
+  http.Client getHttpClient(
+    String directoryName, {
+    CacheMode cacheMode = CacheMode.memory,
+    int diskCapacity = 0,
+    int maxConnections = 6,
+    int memoryCapacity = 10 << 20,
+  }) {
+    final cachedClient = _clients[directoryName];
+    if (cachedClient != null) {
+      return cachedClient;
+    }
+
+    final directory = Directory('${_cachePath.path}/$directoryName');
+    directory.createSync(recursive: true);
+    if (Platform.isAndroid) {
+      final engine = CronetEngine.build(
+        cacheMode: cacheMode,
+        cacheMaxSize: diskCapacity,
+        storagePath: directory.path,
+        userAgent: _userAgent,
+      );
+      return _clients[directoryName] = CronetClient.fromCronetEngine(engine, closeEngine: true);
+    }
+
+    final config = URLSessionConfiguration.defaultSessionConfiguration()
+      ..httpMaximumConnectionsPerHost = maxConnections
+      ..cache = URLCache.withCapacity(
+        diskCapacity: diskCapacity,
+        memoryCapacity: memoryCapacity,
+        directory: directory.uri,
+      )
+      ..httpAdditionalHeaders = {'User-Agent': _userAgent};
+    return _clients[directoryName] = CupertinoClient.fromSessionConfiguration(config);
+  }
+}