Merge pull request #1698 from SatoshiPortal/refactor-locator

refactor: Unify Background Task Locator with the AppLocator into a single Dependency Injection Pattern

Author: ethicnology

lib/core/background_tasks/handler.dart

@@ -1,10 +1,10 @@
-import 'package:bb_mobile/core/background_tasks/locator.dart';
 import 'package:bb_mobile/core/background_tasks/tasks.dart';
 import 'package:bb_mobile/core/storage/sqlite_database.dart';
 import 'package:bb_mobile/core/swaps/domain/usecases/restart_swap_watcher_usecase.dart';
 import 'package:bb_mobile/core/utils/logger.dart' show log;
 import 'package:bb_mobile/core/wallet/domain/usecases/get_wallets_usecase.dart';
 import 'package:bb_mobile/core/wallet/domain/usecases/sync_wallet_usecase.dart';
+import 'package:bb_mobile/locator.dart';
 import 'package:bb_mobile/main.dart';
 import 'package:flutter_dotenv/flutter_dotenv.dart';
 import 'package:get_it/get_it.dart';
@@ -31,7 +31,7 @@ Future<bool> tasksHandler(String task) async {
       await driftIsolate.connect(singleClientMode: true),
     );
     final locator = GetIt.asNewInstance();
-    await TaskLocator.setup(locator, sqlite);
+    await AppLocator.setup(locator, sqlite);
 
     final syncWalletUsecase = locator<SyncWalletUsecase>();
     final getWalletsUsecase = locator<GetWalletsUsecase>();

lib/core/background_tasks/locator.dart

@@ -9,24 +9,24 @@ import 'package:bb_mobile/core/bitbox/domain/usecases/sign_psbt_bitbox_usecase.d
 import 'package:bb_mobile/core/bitbox/domain/usecases/unlock_bitbox_device_usecase.dart';
 import 'package:bb_mobile/core/bitbox/domain/usecases/verify_address_bitbox_usecase.dart';
 import 'package:bb_mobile/core/settings/data/settings_repository.dart';
-import 'package:bb_mobile/locator.dart';
+import 'package:get_it/get_it.dart';
 
 class BitBoxCoreLocator {
-  static void registerDatasources() {
+  static void registerDatasources(GetIt locator) {
     locator.registerLazySingleton<BitBoxDeviceDatasource>(
       () => BitBoxDeviceDatasource(),
     );
   }
 
-  static void registerRepositories() {
+  static void registerRepositories(GetIt locator) {
     locator.registerLazySingleton<BitBoxDeviceRepository>(
       () => BitBoxDeviceRepositoryImpl(
         datasource: locator<BitBoxDeviceDatasource>(),
       ),
     );
   }
 
-  static void registerUsecases() {
+  static void registerUsecases(GetIt locator) {
     locator.registerLazySingleton<ScanBitBoxDevicesUsecase>(
       () => ScanBitBoxDevicesUsecase(
         repository: locator<BitBoxDeviceRepository>(),

lib/core/bitbox/bitbox_locator.dart

@@ -16,14 +16,14 @@ import 'package:bb_mobile/core/storage/storage_locator.dart';
 import 'package:bb_mobile/core/swaps/swaps_locator.dart';
 import 'package:bb_mobile/core/tor/tor_locator.dart';
 import 'package:bb_mobile/core/wallet/wallet_locator.dart';
-import 'package:bb_mobile/locator.dart';
+import 'package:get_it/get_it.dart';
 
 class CoreLocator {
-  static void register() {
-    locator.registerLazySingleton<SqliteDatabase>(() => SqliteDatabase());
+  static void register(GetIt locator, SqliteDatabase database) {
+    locator.registerLazySingleton<SqliteDatabase>(() => database);
   }
 
-  static Future<void> registerDatasources() async {
+  static Future<void> registerDatasources(GetIt locator) async {
     LabelsLocator.registerDatasources(locator);
     await TorLocator.registerDatasources(locator);
     BlockchainLocator.registerDatasources(locator);
@@ -39,19 +39,19 @@ class CoreLocator {
     await WalletLocator.registerDatasources(locator);
     await SettingsLocator.registerDatasources(locator);
     Bip85DerivationsLocator.registerDatasources(locator);
-    LedgerLocator.registerDatasources();
-    BitBoxCoreLocator.registerDatasources();
+    LedgerLocator.registerDatasources(locator);
+    BitBoxCoreLocator.registerDatasources(locator);
   }
 
-  static void registerPorts() {
+  static void registerPorts(GetIt locator) {
     ElectrumLocator.registerPorts(locator);
     BlockchainLocator.registerPorts(locator);
     MempoolLocator.registerPorts(locator);
     SwapsLocator.registerPorts(locator);
     WalletLocator.registerPorts(locator);
   }
 
-  static Future<void> registerRepositories() async {
+  static Future<void> registerRepositories(GetIt locator) async {
     LabelsLocator.registerRepositories(locator);
     await TorLocator.registerRepositories(locator);
     BlockchainLocator.registerRepositories(locator);
@@ -67,17 +67,17 @@ class CoreLocator {
     SwapsLocator.registerRepositories(locator);
     WalletLocator.registerRepositories(locator);
     Bip85DerivationsLocator.registerRepositories(locator);
-    LedgerLocator.registerRepositories();
-    BitBoxCoreLocator.registerRepositories();
+    LedgerLocator.registerRepositories(locator);
+    BitBoxCoreLocator.registerRepositories(locator);
   }
 
-  static void registerServices() {
+  static void registerServices(GetIt locator) {
     MempoolLocator.registerServices(locator);
     SeedLocator.registerServices(locator);
     SwapsLocator.registerServices(locator);
   }
 
-  static void registerUsecases() {
+  static void registerUsecases(GetIt locator) {
     LabelsLocator.registerUseCases(locator);
     ElectrumLocator.registerUsecases(locator);
     BlockchainLocator.registerUsecases(locator);
@@ -93,7 +93,7 @@ class CoreLocator {
     TorLocator.registerUsecases(locator);
     WalletLocator.registerUsecases(locator);
     Bip85DerivationsLocator.registerUsecases(locator);
-    LedgerLocator.registerUsecases();
-    BitBoxCoreLocator.registerUsecases();
+    LedgerLocator.registerUsecases(locator);
+    BitBoxCoreLocator.registerUsecases(locator);
   }
 }

lib/core/core_locator.dart

@@ -7,24 +7,24 @@ import 'package:bb_mobile/core/ledger/domain/usecases/scan_ledger_devices_usecas
 import 'package:bb_mobile/core/ledger/domain/usecases/sign_psbt_ledger_usecase.dart';
 import 'package:bb_mobile/core/ledger/domain/usecases/verify_address_ledger_usecase.dart';
 import 'package:bb_mobile/core/settings/data/settings_repository.dart';
-import 'package:bb_mobile/locator.dart';
+import 'package:get_it/get_it.dart';
 
 class LedgerLocator {
-  static void registerDatasources() {
+  static void registerDatasources(GetIt locator) {
     locator.registerLazySingleton<LedgerDeviceDatasource>(
       () => LedgerDeviceDatasource(),
     );
   }
 
-  static void registerRepositories() {
+  static void registerRepositories(GetIt locator) {
     locator.registerLazySingleton<LedgerDeviceRepository>(
       () => LedgerDeviceRepositoryImpl(
         datasource: locator<LedgerDeviceDatasource>(),
       ),
     );
   }
 
-  static void registerUsecases() {
+  static void registerUsecases(GetIt locator) {
     locator.registerFactory<ScanLedgerDevicesUsecase>(
       () => ScanLedgerDevicesUsecase(
         repository: locator<LedgerDeviceRepository>(),

lib/core/ledger/ledger_locator.dart

@@ -1,23 +1,23 @@
 import 'package:bb_mobile/core/wallet/data/repositories/wallet_address_repository.dart';
 import 'package:bb_mobile/features/address_view/domain/usecases/get_address_list_usecase.dart';
 import 'package:bb_mobile/features/address_view/presentation/address_view_bloc.dart';
-import 'package:bb_mobile/locator.dart';
+import 'package:get_it/get_it.dart';
 
 class AddressViewLocator {
-  static void setup() {
-    registerUsecases();
-    registerBlocs();
+  static void setup(GetIt locator) {
+    registerUsecases(locator);
+    registerBlocs(locator);
   }
 
-  static void registerUsecases() {
+  static void registerUsecases(GetIt locator) {
     locator.registerFactory<GetAddressListUsecase>(
       () => GetAddressListUsecase(
         walletAddressRepository: locator<WalletAddressRepository>(),
       ),
     );
   }
 
-  static void registerBlocs() {
+  static void registerBlocs(GetIt locator) {
     // Register the AddressViewBloc with the locator
     locator.registerFactoryParam<AddressViewBloc, String, int?>(
       (walletId, limit) => AddressViewBloc(

lib/features/address_view/address_view_locator.dart

@@ -3,10 +3,10 @@ import 'package:bb_mobile/core/seed/domain/usecases/get_all_seeds_usecase.dart';
 import 'package:bb_mobile/core/seed/domain/usecases/process_and_separate_seeds_usecase.dart';
 import 'package:bb_mobile/core/wallet/domain/usecases/get_wallets_usecase.dart';
 import 'package:bb_mobile/features/all_seed_view/presentation/all_seed_view_cubit.dart';
-import 'package:bb_mobile/locator.dart';
+import 'package:get_it/get_it.dart';
 
 class AllSeedViewLocator {
-  static void setup() {
+  static void setup(GetIt locator) {
     locator.registerFactory<AllSeedViewCubit>(
       () => AllSeedViewCubit(
         getAllSeedsUsecase: locator<GetAllSeedsUsecase>(),

lib/features/all_seed_view/all_seed_view_locator.dart

@@ -12,10 +12,10 @@ import 'package:bb_mobile/features/app_startup/presentation/bloc/app_startup_blo
 import 'package:bb_mobile/features/app_unlock/domain/usecases/check_pin_code_exists_usecase.dart';
 import 'package:bb_mobile/features/pin_code/data/repositories/pin_code_repository.dart';
 import 'package:bb_mobile/features/test_wallet_backup/domain/usecases/check_backup_usecase.dart';
-import 'package:bb_mobile/locator.dart';
+import 'package:get_it/get_it.dart';
 
 class AppStartupLocator {
-  static void setup() {
+  static void setup(GetIt locator) {
     // Use cases
     locator.registerFactory<ResetAppDataUsecase>(
       () =>

lib/features/app_startup/app_startup_locator.dart

@@ -8,10 +8,10 @@ import 'package:bb_mobile/features/app_unlock/domain/usecases/check_pin_code_exi
 import 'package:bb_mobile/features/app_unlock/domain/usecases/get_latest_unlock_attempt_usecase.dart';
 import 'package:bb_mobile/features/app_unlock/presentation/bloc/app_unlock_bloc.dart';
 import 'package:bb_mobile/features/pin_code/data/repositories/pin_code_repository.dart';
-import 'package:bb_mobile/locator.dart';
+import 'package:get_it/get_it.dart';
 
 class AppUnlockLocator {
-  static void setup() {
+  static void setup(GetIt locator) {
     // Repositories
     locator.registerLazySingleton<FailedUnlockAttemptsRepository>(
       () => FailedUnlockAttemptsRepository(

lib/features/app_unlock/app_unlock_locator.dart

@@ -3,10 +3,10 @@ import 'package:bb_mobile/core/swaps/domain/usecases/get_auto_swap_settings_usec
 import 'package:bb_mobile/core/swaps/domain/usecases/save_auto_swap_settings_usecase.dart';
 import 'package:bb_mobile/core/wallet/data/repositories/wallet_repository.dart';
 import 'package:bb_mobile/features/autoswap/presentation/autoswap_settings_cubit.dart';
-import 'package:bb_mobile/locator.dart';
+import 'package:get_it/get_it.dart';
 
 class AutoSwapLocator {
-  static void setup() {
+  static void setup(GetIt locator) {
     // Register the cubit
     locator.registerFactory<AutoSwapSettingsCubit>(
       () => AutoSwapSettingsCubit(