fix: prevent background worker when main app is running (#22252)

* fix: prevent background worker only when the main app is actively running

* handle ref disposals better

---------

Co-authored-by: shenlong-tanwen <139912620+shalong-tanwen@users.noreply.github.com>
Co-authored-by: Alex <alex.tran1502@gmail.com>

mobile/lib/domain/services/background_worker.service.dart

@@ -10,11 +10,13 @@ import 'package:immich_mobile/constants/constants.dart';
 import 'package:immich_mobile/domain/services/log.service.dart';
 import 'package:immich_mobile/entities/store.entity.dart';
 import 'package:immich_mobile/extensions/network_capability_extensions.dart';
+import 'package:immich_mobile/extensions/platform_extensions.dart';
 import 'package:immich_mobile/extensions/translate_extensions.dart';
 import 'package:immich_mobile/generated/intl_keys.g.dart';
 import 'package:immich_mobile/infrastructure/repositories/db.repository.dart';
 import 'package:immich_mobile/infrastructure/repositories/logger_db.repository.dart';
 import 'package:immich_mobile/platform/background_worker_api.g.dart';
+import 'package:immich_mobile/platform/background_worker_lock_api.g.dart';
 import 'package:immich_mobile/providers/app_settings.provider.dart';
 import 'package:immich_mobile/providers/background_sync.provider.dart';
 import 'package:immich_mobile/providers/backup/drift_backup.provider.dart';
@@ -58,7 +60,7 @@ class BackgroundWorkerFgService {
 }
 
 class BackgroundWorkerBgService extends BackgroundWorkerFlutterApi {
-  late final ProviderContainer _ref;
+  ProviderContainer? _ref;
   final Isar _isar;
   final Drift _drift;
   final DriftLogger _driftLogger;
@@ -83,29 +85,31 @@ class BackgroundWorkerBgService extends BackgroundWorkerFlutterApi {
     BackgroundWorkerFlutterApi.setUp(this);
   }
 
-  bool get _isBackupEnabled => _ref.read(appSettingsServiceProvider).getSetting(AppSettingsEnum.enableBackup);
+  bool get _isBackupEnabled => _ref?.read(appSettingsServiceProvider).getSetting(AppSettingsEnum.enableBackup) ?? false;
 
   Future<void> init() async {
     try {
       HttpSSLOptions.apply(applyNative: false);
 
-      await Future.wait([
-        loadTranslations(),
-        workerManager.init(dynamicSpawning: true),
-        _ref.read(authServiceProvider).setOpenApiServiceEndpoint(),
-        // Initialize the file downloader
-        FileDownloader().configure(
-          globalConfig: [
-            // maxConcurrent: 6, maxConcurrentByHost(server):6, maxConcurrentByGroup: 3
-            (Config.holdingQueue, (6, 6, 3)),
-            // On Android, if files are larger than 256MB, run in foreground service
-            (Config.runInForegroundIfFileLargerThan, 256),
-          ],
-        ),
-        FileDownloader().trackTasksInGroup(kDownloadGroupLivePhoto, markDownloadedComplete: false),
-        FileDownloader().trackTasks(),
-        _ref.read(fileMediaRepositoryProvider).enableBackgroundAccess(),
-      ]);
+      await Future.wait(
+        [
+          loadTranslations(),
+          workerManager.init(dynamicSpawning: true),
+          _ref?.read(authServiceProvider).setOpenApiServiceEndpoint(),
+          // Initialize the file downloader
+          FileDownloader().configure(
+            globalConfig: [
+              // maxConcurrent: 6, maxConcurrentByHost(server):6, maxConcurrentByGroup: 3
+              (Config.holdingQueue, (6, 6, 3)),
+              // On Android, if files are larger than 256MB, run in foreground service
+              (Config.runInForegroundIfFileLargerThan, 256),
+            ],
+          ),
+          FileDownloader().trackTasksInGroup(kDownloadGroupLivePhoto, markDownloadedComplete: false),
+          FileDownloader().trackTasks(),
+          _ref?.read(fileMediaRepositoryProvider).enableBackgroundAccess(),
+        ].nonNulls,
+      );
 
       configureFileDownloaderNotifications();
 
@@ -178,15 +182,17 @@ class BackgroundWorkerBgService extends BackgroundWorkerFlutterApi {
   }
 
   Future<void> _cleanup() async {
-    if (_isCleanedUp) {
+    // If ref is null, it means the service was never initialized properly
+    if (_isCleanedUp || _ref == null) {
       return;
     }
 
     try {
-      final backgroundSyncManager = _ref.read(backgroundSyncProvider);
-      final nativeSyncApi = _ref.read(nativeSyncApiProvider);
       _isCleanedUp = true;
-      _ref.dispose();
+      final backgroundSyncManager = _ref?.read(backgroundSyncProvider);
+      final nativeSyncApi = _ref?.read(nativeSyncApiProvider);
+      _ref?.dispose();
+      _ref = null;
 
       _cancellationToken.cancel();
       _logger.info("Cleaning up background worker");
@@ -199,14 +205,14 @@ class BackgroundWorkerBgService extends BackgroundWorkerFlutterApi {
         Store.dispose(),
         _drift.close(),
         _driftLogger.close(),
-        backgroundSyncManager.cancel(),
-        nativeSyncApi.cancelHashing(),
+        backgroundSyncManager?.cancel(),
+        nativeSyncApi?.cancelHashing(),
       ];
 
       if (_isar.isOpen) {
         cleanupFutures.add(_isar.close());
       }
-      await Future.wait(cleanupFutures);
+      await Future.wait(cleanupFutures.nonNulls);
       _logger.info("Background worker resources cleaned up");
     } catch (error, stack) {
       dPrint(() => 'Failed to cleanup background worker: $error with stack: $stack');
@@ -216,14 +222,18 @@ class BackgroundWorkerBgService extends BackgroundWorkerFlutterApi {
   Future<void> _handleBackup() async {
     await runZonedGuarded(
       () async {
-        if (!_isBackupEnabled || _isCleanedUp) {
+        if (_isCleanedUp) {
+          return;
+        }
+
+        if (!_isBackupEnabled) {
           _logger.info("[_handleBackup 1] Backup is disabled. Skipping backup routine");
           return;
         }
 
         _logger.info("[_handleBackup 2] Enqueuing assets for backup from the background service");
 
-        final currentUser = _ref.read(currentUserProvider);
+        final currentUser = _ref?.read(currentUserProvider);
         if (currentUser == null) {
           _logger.warning("[_handleBackup 3] No current user found. Skipping backup from background");
           return;
@@ -231,19 +241,18 @@ class BackgroundWorkerBgService extends BackgroundWorkerFlutterApi {
 
         _logger.info("[_handleBackup 4] Resume backup from background");
         if (Platform.isIOS) {
-          return _ref.read(driftBackupProvider.notifier).handleBackupResume(currentUser.id);
+          return _ref?.read(driftBackupProvider.notifier).handleBackupResume(currentUser.id);
         }
 
-        final canPing = await _ref.read(serverInfoServiceProvider).ping();
+        final canPing = await _ref?.read(serverInfoServiceProvider).ping() ?? false;
         if (!canPing) {
           _logger.warning("[_handleBackup 5] Server is not reachable. Skipping backup from background");
           return;
         }
 
-        final networkCapabilities = await _ref.read(connectivityApiProvider).getCapabilities();
-
+        final networkCapabilities = await _ref?.read(connectivityApiProvider).getCapabilities() ?? [];
         return _ref
-            .read(uploadServiceProvider)
+            ?.read(uploadServiceProvider)
             .startBackupWithHttpClient(currentUser.id, networkCapabilities.hasWifi, _cancellationToken);
       },
       (error, stack) {
@@ -253,18 +262,18 @@ class BackgroundWorkerBgService extends BackgroundWorkerFlutterApi {
   }
 
   Future<void> _syncAssets({Duration? hashTimeout}) async {
-    await _ref.read(backgroundSyncProvider).syncLocal();
+    await _ref?.read(backgroundSyncProvider).syncLocal();
     if (_isCleanedUp) {
       return;
     }
 
-    await _ref.read(backgroundSyncProvider).syncRemote();
+    await _ref?.read(backgroundSyncProvider).syncRemote();
     if (_isCleanedUp) {
       return;
     }
 
-    var hashFuture = _ref.read(backgroundSyncProvider).hashAssets();
-    if (hashTimeout != null) {
+    var hashFuture = _ref?.read(backgroundSyncProvider).hashAssets();
+    if (hashTimeout != null && hashFuture != null) {
       hashFuture = hashFuture.timeout(
         hashTimeout,
         onTimeout: () {
@@ -277,6 +286,23 @@ class BackgroundWorkerBgService extends BackgroundWorkerFlutterApi {
   }
 }
 
+class BackgroundWorkerLockService {
+  final BackgroundWorkerLockApi _hostApi;
+  const BackgroundWorkerLockService(this._hostApi);
+
+  Future<void> lock() async {
+    if (CurrentPlatform.isAndroid) {
+      return _hostApi.lock();
+    }
+  }
+
+  Future<void> unlock() async {
+    if (CurrentPlatform.isAndroid) {
+      return _hostApi.unlock();
+    }
+  }
+}
+
 /// Native entry invoked from the background worker. If renaming or moving this to a different
 /// library, make sure to update the entry points and URI in native workers as well
 @pragma('vm:entry-point')

mobile/lib/main.dart

@@ -12,9 +12,11 @@ import 'package:flutter_displaymode/flutter_displaymode.dart';
 import 'package:hooks_riverpod/hooks_riverpod.dart';
 import 'package:immich_mobile/constants/constants.dart';
 import 'package:immich_mobile/constants/locales.dart';
+import 'package:immich_mobile/domain/services/background_worker.service.dart';
 import 'package:immich_mobile/entities/store.entity.dart';
 import 'package:immich_mobile/extensions/build_context_extensions.dart';
 import 'package:immich_mobile/generated/codegen_loader.g.dart';
+import 'package:immich_mobile/platform/background_worker_lock_api.g.dart';
 import 'package:immich_mobile/providers/app_life_cycle.provider.dart';
 import 'package:immich_mobile/providers/asset_viewer/share_intent_upload.provider.dart';
 import 'package:immich_mobile/providers/db.provider.dart';
@@ -32,6 +34,7 @@ import 'package:immich_mobile/theme/dynamic_theme.dart';
 import 'package:immich_mobile/theme/theme_data.dart';
 import 'package:immich_mobile/utils/bootstrap.dart';
 import 'package:immich_mobile/utils/cache/widgets_binding.dart';
+import 'package:immich_mobile/utils/debug_print.dart';
 import 'package:immich_mobile/utils/http_ssl_options.dart';
 import 'package:immich_mobile/utils/licenses.dart';
 import 'package:immich_mobile/utils/migration.dart';
@@ -39,10 +42,10 @@ import 'package:intl/date_symbol_data_local.dart';
 import 'package:logging/logging.dart';
 import 'package:timezone/data/latest.dart';
 import 'package:worker_manager/worker_manager.dart';
-import 'package:immich_mobile/utils/debug_print.dart';
 
 void main() async {
   ImmichWidgetsBinding();
+  unawaited(BackgroundWorkerLockService(BackgroundWorkerLockApi()).lock());
   final (isar, drift, logDb) = await Bootstrap.initDB();
   await Bootstrap.initDomain(isar, drift, logDb);
   await initApp();

mobile/lib/pages/common/splash_screen.page.dart

@@ -1,3 +1,5 @@
+import 'dart:async';
+
 import 'package:auto_route/auto_route.dart';
 import 'package:flutter/material.dart';
 import 'package:hooks_riverpod/hooks_riverpod.dart';

mobile/lib/platform/background_worker_lock_api.g.dart

@@ -0,0 +1,97 @@
+// Autogenerated from Pigeon (v26.0.0), do not edit directly.
+// See also: https://pub.dev/packages/pigeon
+// ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, prefer_null_aware_operators, omit_local_variable_types, unused_shown_name, unnecessary_import, no_leading_underscores_for_local_identifiers
+
+import 'dart:async';
+import 'dart:typed_data' show Float64List, Int32List, Int64List, Uint8List;
+
+import 'package:flutter/foundation.dart' show ReadBuffer, WriteBuffer;
+import 'package:flutter/services.dart';
+
+PlatformException _createConnectionError(String channelName) {
+  return PlatformException(
+    code: 'channel-error',
+    message: 'Unable to establish connection on channel: "$channelName".',
+  );
+}
+
+class _PigeonCodec extends StandardMessageCodec {
+  const _PigeonCodec();
+  @override
+  void writeValue(WriteBuffer buffer, Object? value) {
+    if (value is int) {
+      buffer.putUint8(4);
+      buffer.putInt64(value);
+    } else {
+      super.writeValue(buffer, value);
+    }
+  }
+
+  @override
+  Object? readValueOfType(int type, ReadBuffer buffer) {
+    switch (type) {
+      default:
+        return super.readValueOfType(type, buffer);
+    }
+  }
+}
+
+class BackgroundWorkerLockApi {
+  /// Constructor for [BackgroundWorkerLockApi].  The [binaryMessenger] named argument is
+  /// available for dependency injection.  If it is left null, the default
+  /// BinaryMessenger will be used which routes to the host platform.
+  BackgroundWorkerLockApi({BinaryMessenger? binaryMessenger, String messageChannelSuffix = ''})
+    : pigeonVar_binaryMessenger = binaryMessenger,
+      pigeonVar_messageChannelSuffix = messageChannelSuffix.isNotEmpty ? '.$messageChannelSuffix' : '';
+  final BinaryMessenger? pigeonVar_binaryMessenger;
+
+  static const MessageCodec<Object?> pigeonChannelCodec = _PigeonCodec();
+
+  final String pigeonVar_messageChannelSuffix;
+
+  Future<void> lock() async {
+    final String pigeonVar_channelName =
+        'dev.flutter.pigeon.immich_mobile.BackgroundWorkerLockApi.lock$pigeonVar_messageChannelSuffix';
+    final BasicMessageChannel<Object?> pigeonVar_channel = BasicMessageChannel<Object?>(
+      pigeonVar_channelName,
+      pigeonChannelCodec,
+      binaryMessenger: pigeonVar_binaryMessenger,
+    );
+    final Future<Object?> pigeonVar_sendFuture = pigeonVar_channel.send(null);
+    final List<Object?>? pigeonVar_replyList = await pigeonVar_sendFuture as List<Object?>?;
+    if (pigeonVar_replyList == null) {
+      throw _createConnectionError(pigeonVar_channelName);
+    } else if (pigeonVar_replyList.length > 1) {
+      throw PlatformException(
+        code: pigeonVar_replyList[0]! as String,
+        message: pigeonVar_replyList[1] as String?,
+        details: pigeonVar_replyList[2],
+      );
+    } else {
+      return;
+    }
+  }
+
+  Future<void> unlock() async {
+    final String pigeonVar_channelName =
+        'dev.flutter.pigeon.immich_mobile.BackgroundWorkerLockApi.unlock$pigeonVar_messageChannelSuffix';
+    final BasicMessageChannel<Object?> pigeonVar_channel = BasicMessageChannel<Object?>(
+      pigeonVar_channelName,
+      pigeonChannelCodec,
+      binaryMessenger: pigeonVar_binaryMessenger,
+    );
+    final Future<Object?> pigeonVar_sendFuture = pigeonVar_channel.send(null);
+    final List<Object?>? pigeonVar_replyList = await pigeonVar_sendFuture as List<Object?>?;
+    if (pigeonVar_replyList == null) {
+      throw _createConnectionError(pigeonVar_channelName);
+    } else if (pigeonVar_replyList.length > 1) {
+      throw PlatformException(
+        code: pigeonVar_replyList[0]! as String,
+        message: pigeonVar_replyList[1] as String?,
+        details: pigeonVar_replyList[2],
+      );
+    } else {
+      return;
+    }
+  }
+}

mobile/lib/providers/app_life_cycle.provider.dart

@@ -15,6 +15,7 @@ import 'package:immich_mobile/providers/backup/drift_backup.provider.dart';
 import 'package:immich_mobile/providers/backup/ios_background_settings.provider.dart';
 import 'package:immich_mobile/providers/backup/manual_upload.provider.dart';
 import 'package:immich_mobile/providers/gallery_permission.provider.dart';
+import 'package:immich_mobile/providers/infrastructure/platform.provider.dart';
 import 'package:immich_mobile/providers/memory.provider.dart';
 import 'package:immich_mobile/providers/notification_permission.provider.dart';
 import 'package:immich_mobile/providers/server_info.provider.dart';
@@ -138,6 +139,7 @@ class AppLifeCycleNotifier extends StateNotifier<AppLifeCycleEnum> {
 
   Future<void> _handleBetaTimelineResume() async {
     _ref.read(backupProvider.notifier).cancelBackup();
+    unawaited(_ref.read(backgroundWorkerLockServiceProvider).lock());
 
     // Give isolates time to complete any ongoing database transactions
     await Future.delayed(const Duration(milliseconds: 500));
@@ -209,6 +211,9 @@ class AppLifeCycleNotifier extends StateNotifier<AppLifeCycleEnum> {
     _pauseOperation = Completer<void>();
 
     try {
+      if (Store.isBetaTimelineEnabled) {
+        unawaited(_ref.read(backgroundWorkerLockServiceProvider).unlock());
+      }
       await _performPause();
     } catch (e, stackTrace) {
       _log.severe("Error during app pause", e, stackTrace);
@@ -240,6 +245,10 @@ class AppLifeCycleNotifier extends StateNotifier<AppLifeCycleEnum> {
   Future<void> handleAppDetached() async {
     state = AppLifeCycleEnum.detached;
 
+    if (Store.isBetaTimelineEnabled) {
+      unawaited(_ref.read(backgroundWorkerLockServiceProvider).unlock());
+    }
+
     // Flush logs before closing database
     try {
       LogService.I.flush();

mobile/lib/providers/infrastructure/platform.provider.dart

@@ -1,12 +1,17 @@
 import 'package:hooks_riverpod/hooks_riverpod.dart';
 import 'package:immich_mobile/domain/services/background_worker.service.dart';
 import 'package:immich_mobile/platform/background_worker_api.g.dart';
+import 'package:immich_mobile/platform/background_worker_lock_api.g.dart';
 import 'package:immich_mobile/platform/connectivity_api.g.dart';
 import 'package:immich_mobile/platform/native_sync_api.g.dart';
 import 'package:immich_mobile/platform/thumbnail_api.g.dart';
 
 final backgroundWorkerFgServiceProvider = Provider((_) => BackgroundWorkerFgService(BackgroundWorkerFgHostApi()));
 
+final backgroundWorkerLockServiceProvider = Provider<BackgroundWorkerLockService>(
+  (_) => BackgroundWorkerLockService(BackgroundWorkerLockApi()),
+);
+
 final nativeSyncApiProvider = Provider<NativeSyncApi>((_) => NativeSyncApi());
 
 final connectivityApiProvider = Provider<ConnectivityApi>((_) => ConnectivityApi());