refactor: app metadata (#28113)

* refactor: app metadata

* refactor to per row store

* cleanup

* more test

* review changes

* more refactor

* refactor

---------

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

mobile/test/domain/services/log_service_test.dart

@@ -1,11 +1,11 @@
 import 'package:collection/collection.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:immich_mobile/constants/constants.dart';
+import 'package:immich_mobile/domain/models/config/system_config.dart';
 import 'package:immich_mobile/domain/models/log.model.dart';
-import 'package:immich_mobile/domain/models/store.model.dart';
+import 'package:immich_mobile/domain/models/metadata_key.dart';
 import 'package:immich_mobile/domain/services/log.service.dart';
 import 'package:immich_mobile/infrastructure/repositories/log.repository.dart';
-import 'package:immich_mobile/infrastructure/repositories/store.repository.dart';
 import 'package:logging/logging.dart';
 import 'package:mocktail/mocktail.dart';
 
@@ -29,21 +29,23 @@ final _kWarnLog = LogMessage(
 void main() {
   late LogService sut;
   late LogRepository mockLogRepo;
-  late DriftStoreRepository mockStoreRepo;
+  late MockMetadataRepository mockMetadataRepository;
 
   setUp(() async {
     mockLogRepo = MockLogRepository();
-    mockStoreRepo = MockDriftStoreRepository();
+    mockMetadataRepository = MockMetadataRepository();
 
     registerFallbackValue(_kInfoLog);
+    registerFallbackValue(LogLevel.info);
 
     when(() => mockLogRepo.truncate(limit: any(named: 'limit'))).thenAnswer((_) async => {});
-    when(() => mockStoreRepo.tryGet<int>(StoreKey.logLevel)).thenAnswer((_) async => LogLevel.fine.index);
+    when(() => mockMetadataRepository.systemConfig).thenReturn(const SystemConfig(logLevel: LogLevel.fine));
+    when(() => mockMetadataRepository.write<LogLevel>(MetadataKey.logLevel, any())).thenAnswer((_) async {});
     when(() => mockLogRepo.getAll()).thenAnswer((_) async => []);
     when(() => mockLogRepo.insert(any())).thenAnswer((_) async => true);
     when(() => mockLogRepo.insertAll(any())).thenAnswer((_) async => true);
 
-    sut = await LogService.create(logRepository: mockLogRepo, storeRepository: mockStoreRepo);
+    sut = await LogService.create(logRepository: mockLogRepo, metadataRepository: mockMetadataRepository);
   });
 
   tearDown(() async {
@@ -56,21 +58,22 @@ void main() {
       expect(limit, kLogTruncateLimit);
     });
 
-    test('Sets log level based on the store setting', () {
-      verify(() => mockStoreRepo.tryGet<int>(StoreKey.logLevel)).called(1);
+    test('Sets log level based on the metadata repository', () {
+      verify(() => mockMetadataRepository.systemConfig).called(1);
       expect(Logger.root.level, Level.FINE);
     });
   });
 
   group("Log Service Set Level:", () {
     setUp(() async {
-      when(() => mockStoreRepo.upsert<int>(StoreKey.logLevel, any())).thenAnswer((_) async => true);
       await sut.setLogLevel(LogLevel.shout);
     });
 
-    test('Updates the log level in store', () {
-      final index = verify(() => mockStoreRepo.upsert<int>(StoreKey.logLevel, captureAny())).captured.firstOrNull;
-      expect(index, LogLevel.shout.index);
+    test('Updates the log level via metadata repository', () {
+      final captured = verify(
+        () => mockMetadataRepository.write<LogLevel>(MetadataKey.logLevel, captureAny()),
+      ).captured.firstOrNull;
+      expect(captured, LogLevel.shout);
     });
 
     test('Sets log level on logger', () {
@@ -81,7 +84,11 @@ void main() {
   group("Log Service Buffer:", () {
     test('Buffers logs until timer elapses', () {
       TestUtils.fakeAsync((time) async {
-        sut = await LogService.create(logRepository: mockLogRepo, storeRepository: mockStoreRepo, shouldBuffer: true);
+        sut = await LogService.create(
+          logRepository: mockLogRepo,
+          metadataRepository: mockMetadataRepository,
+          shouldBuffer: true,
+        );
 
         final logger = Logger(_kInfoLog.logger!);
         logger.info(_kInfoLog.message);
@@ -95,7 +102,11 @@ void main() {
 
     test('Batch inserts all logs on timer', () {
       TestUtils.fakeAsync((time) async {
-        sut = await LogService.create(logRepository: mockLogRepo, storeRepository: mockStoreRepo, shouldBuffer: true);
+        sut = await LogService.create(
+          logRepository: mockLogRepo,
+          metadataRepository: mockMetadataRepository,
+          shouldBuffer: true,
+        );
 
         final logger = Logger(_kInfoLog.logger!);
         logger.info(_kInfoLog.message);
@@ -112,7 +123,11 @@ void main() {
 
     test('Does not buffer when off', () {
       TestUtils.fakeAsync((time) async {
-        sut = await LogService.create(logRepository: mockLogRepo, storeRepository: mockStoreRepo, shouldBuffer: false);
+        sut = await LogService.create(
+          logRepository: mockLogRepo,
+          metadataRepository: mockMetadataRepository,
+          shouldBuffer: false,
+        );
 
         final logger = Logger(_kInfoLog.logger!);
         logger.info(_kInfoLog.message);
@@ -142,7 +157,11 @@ void main() {
 
     test('Combines result from both DB + Buffer', () {
       TestUtils.fakeAsync((time) async {
-        sut = await LogService.create(logRepository: mockLogRepo, storeRepository: mockStoreRepo, shouldBuffer: true);
+        sut = await LogService.create(
+          logRepository: mockLogRepo,
+          metadataRepository: mockMetadataRepository,
+          shouldBuffer: true,
+        );
 
         final logger = Logger(_kWarnLog.logger!);
         logger.warning(_kWarnLog.message);

mobile/test/drift/main/generated/schema.dart

@@ -28,6 +28,7 @@ import 'schema_v21.dart' as v21;
 import 'schema_v22.dart' as v22;
 import 'schema_v23.dart' as v23;
 import 'schema_v24.dart' as v24;
+import 'schema_v25.dart' as v25;
 
 class GeneratedHelper implements SchemaInstantiationHelper {
   @override
@@ -81,6 +82,8 @@ class GeneratedHelper implements SchemaInstantiationHelper {
         return v23.DatabaseAtV23(db);
       case 24:
         return v24.DatabaseAtV24(db);
+      case 25:
+        return v25.DatabaseAtV25(db);
       default:
         throw MissingSchemaException(version, versions);
     }
@@ -111,5 +114,6 @@ class GeneratedHelper implements SchemaInstantiationHelper {
     22,
     23,
     24,
+    25,
   ];
 }

mobile/test/infrastructure/repository.mock.dart

@@ -2,6 +2,7 @@ import 'package:immich_mobile/infrastructure/repositories/backup.repository.dart
 import 'package:immich_mobile/infrastructure/repositories/local_album.repository.dart';
 import 'package:immich_mobile/infrastructure/repositories/local_asset.repository.dart';
 import 'package:immich_mobile/infrastructure/repositories/log.repository.dart';
+import 'package:immich_mobile/infrastructure/repositories/metadata.repository.dart';
 import 'package:immich_mobile/infrastructure/repositories/remote_album.repository.dart';
 import 'package:immich_mobile/infrastructure/repositories/remote_asset.repository.dart';
 import 'package:immich_mobile/infrastructure/repositories/storage.repository.dart';
@@ -17,6 +18,8 @@ import 'package:mocktail/mocktail.dart';
 
 class MockDriftStoreRepository extends Mock implements DriftStoreRepository {}
 
+class MockMetadataRepository extends Mock implements MetadataRepository {}
+
 class MockLogRepository extends Mock implements LogRepository {}
 
 class MockSyncStreamRepository extends Mock implements SyncStreamRepository {}

mobile/test/medium/repositories/metadata_repository_test.dart

@@ -0,0 +1,139 @@
+import 'package:drift/drift.dart';
+import 'package:flutter/material.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:immich_mobile/domain/models/log.model.dart';
+import 'package:immich_mobile/domain/models/metadata_key.dart';
+import 'package:immich_mobile/infrastructure/entities/metadata.entity.drift.dart';
+import 'package:immich_mobile/infrastructure/repositories/metadata.repository.dart';
+
+import '../repository_context.dart';
+
+void main() {
+  late MediumRepositoryContext ctx;
+  late MetadataRepository sut;
+
+  setUpAll(() async {
+    ctx = MediumRepositoryContext();
+    sut = await MetadataRepository.ensureInitialized(ctx.db);
+  });
+
+  tearDownAll(() async {
+    await ctx.dispose();
+  });
+
+  setUp(() async {
+    await ctx.db.delete(ctx.db.metadataEntity).go();
+    await MetadataRepository.refresh();
+  });
+
+  group('defaults', () {
+    test('appConfig returns key defaults when DB is empty', () {
+      expect(sut.appConfig.theme.mode, ThemeMode.system);
+    });
+
+    test('systemConfig returns key defaults when DB is empty', () {
+      expect(sut.systemConfig.logLevel, LogLevel.info);
+    });
+  });
+
+  group('write', () {
+    test('persists a value and reflects it in the composed view', () async {
+      await sut.write(.themeMode, ThemeMode.dark);
+      expect(sut.appConfig.theme.mode, ThemeMode.dark);
+    });
+
+    test('persists across domains independently', () async {
+      await sut.write(.themeMode, ThemeMode.light);
+      await sut.write(.logLevel, LogLevel.severe);
+      expect(sut.appConfig.theme.mode, ThemeMode.light);
+      expect(sut.systemConfig.logLevel, LogLevel.severe);
+    });
+  });
+
+  group('delete', () {
+    test('removes the row and reverts to default', () async {
+      await sut.write(.themeMode, ThemeMode.dark);
+      expect(sut.appConfig.theme.mode, ThemeMode.dark);
+
+      await sut.delete(.themeMode);
+      expect(sut.appConfig.theme.mode, ThemeMode.system);
+
+      final rows = await ctx.db.select(ctx.db.metadataEntity).get();
+      expect(rows, isEmpty);
+    });
+  });
+
+  group('refresh', () {
+    test('picks up rows that were inserted directly into the DB', () async {
+      await ctx.db
+          .into(ctx.db.metadataEntity)
+          .insert(
+            MetadataEntityCompanion.insert(
+              key: MetadataKey.themeMode.key,
+              value: ThemeMode.dark.name,
+              updatedAt: Value(DateTime.now()),
+            ),
+          );
+
+      // Cache hasn't seen this row yet — view still returns the default.
+      expect(sut.appConfig.theme.mode, ThemeMode.system);
+
+      await MetadataRepository.refresh();
+
+      expect(sut.appConfig.theme.mode, ThemeMode.dark);
+    });
+
+    test('drops cached values for rows that were deleted out from under the repo', () async {
+      await sut.write(.themeMode, ThemeMode.dark);
+      // Wipe the row directly. Cache still holds the old value.
+      await ctx.db.delete(ctx.db.metadataEntity).go();
+      expect(sut.appConfig.theme.mode, ThemeMode.dark);
+
+      await MetadataRepository.refresh();
+
+      expect(sut.appConfig.theme.mode, ThemeMode.system);
+    });
+
+    test('skips rows whose key is unknown to MetadataKey', () async {
+      await ctx.db
+          .into(ctx.db.metadataEntity)
+          .insert(
+            MetadataEntityCompanion.insert(
+              key: 'app-config.unknown.future-key',
+              value: 'whatever',
+              updatedAt: Value(DateTime.now()),
+            ),
+          );
+
+      await MetadataRepository.refresh();
+      expect(sut.appConfig.theme.mode, ThemeMode.system);
+    });
+  });
+
+  group('watch', () {
+    test('watchAppConfig emits the new value after a write', () async {
+      final expectation = expectLater(sut.watchAppConfig().map((c) => c.theme.mode), emitsThrough(ThemeMode.dark));
+      await sut.write(MetadataKey.themeMode, ThemeMode.dark);
+      await expectation;
+    });
+
+    test('watchAppConfig does not emit when only system-config rows change', () async {
+      final emissions = <ThemeMode>[];
+      // skip(1) drops the on-subscribe replay so we only capture emissions caused by the write below.
+      final sub = sut.watchAppConfig().skip(1).listen((c) => emissions.add(c.theme.mode));
+
+      await sut.write(MetadataKey.logLevel, LogLevel.severe);
+      await pumpEventQueue();
+      await sub.cancel();
+
+      expect(emissions, isEmpty);
+    });
+
+    test('watchSystemConfig emits the new value after a write', () async {
+      final expectation = expectLater(sut.watchSystemConfig().map((c) => c.logLevel), emitsThrough(LogLevel.warning));
+      await sut.write(MetadataKey.logLevel, LogLevel.warning);
+      await expectation;
+    });
+  });
+
+}

mobile/test/services/auth.service_test.dart

@@ -6,7 +6,6 @@ import 'package:immich_mobile/domain/services/store.service.dart';
 import 'package:immich_mobile/infrastructure/repositories/db.repository.dart';
 import 'package:immich_mobile/infrastructure/repositories/store.repository.dart';
 import 'package:immich_mobile/models/auth/auxilary_endpoint.model.dart';
-import 'package:immich_mobile/services/app_settings.service.dart';
 import 'package:immich_mobile/services/auth.service.dart';
 import 'package:mocktail/mocktail.dart';
 import 'package:openapi/api.dart';
@@ -109,36 +108,6 @@ void main() {
     });
   });
 
-  group('logout', () {
-    test('Should logout user', () async {
-      when(() => authApiRepository.logout()).thenAnswer((_) async => {});
-      when(() => backgroundSyncManager.cancel()).thenAnswer((_) async => {});
-      when(() => authRepository.clearLocalData()).thenAnswer((_) => Future.value(null));
-      when(
-        () => appSettingsService.setSetting(AppSettingsEnum.enableBackup, false),
-      ).thenAnswer((_) => Future.value(null));
-      await sut.logout();
-
-      verify(() => authApiRepository.logout()).called(1);
-      verify(() => backgroundSyncManager.cancel()).called(1);
-      verify(() => authRepository.clearLocalData()).called(1);
-    });
-
-    test('Should clear local data even on server error', () async {
-      when(() => authApiRepository.logout()).thenThrow(Exception('Server error'));
-      when(() => backgroundSyncManager.cancel()).thenAnswer((_) async => {});
-      when(() => authRepository.clearLocalData()).thenAnswer((_) => Future.value(null));
-      when(
-        () => appSettingsService.setSetting(AppSettingsEnum.enableBackup, false),
-      ).thenAnswer((_) => Future.value(null));
-      await sut.logout();
-
-      verify(() => authApiRepository.logout()).called(1);
-      verify(() => backgroundSyncManager.cancel()).called(1);
-      verify(() => authRepository.clearLocalData()).called(1);
-    });
-  });
-
   group('setOpenApiServiceEndpoint', () {
     setUp(() {
       when(() => networkService.getWifiName()).thenAnswer((_) async => 'TestWifi');

mobile/test/unit/repositories/metadata_repository_test.dart

@@ -0,0 +1,24 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:immich_mobile/domain/models/metadata_key.dart';
+
+void main() {
+  group('MetadataKey', () {
+    test('every key round-trips its default value losslessly', () {
+      for (final key in MetadataKey.values) {
+        final encoded = key.encode(key.defaultValue);
+        final decoded = key.decode(encoded);
+        expect(decoded, key.defaultValue, reason: 'round-trip failed for ${key.name}');
+      }
+    });
+
+    test('decode falls back to the default value when the raw input is unparseable', () {
+      for (final key in MetadataKey.values) {
+        expect(
+          key.decode('not a valid encoding for any key'),
+          key.defaultValue,
+          reason: 'fallback failed for ${key.name}',
+        );
+      }
+    });
+  });
+}