High performance self-hosted photo and video management solution.
TypeScript backup-toolfluttergoogle-photosgoogle-photos-alternativejavascriptmobile-appnestjsnodejsphoto-galleryphotosphotos-managementself-hostedsveltesveltekittypescriptvideos
refactor(mobile): extract CachedKeyValueRepository (#28789)
shenlong3485dbffdae5
diff --git a/mobile/lib/domain/models/settings_key.dart b/mobile/lib/domain/models/settings_key.dartindex 00c5286e07..4308d69555 100644--- a/mobile/lib/domain/models/settings_key.dart+++ b/mobile/lib/domain/models/settings_key.dart@@ -1,17 +1,16 @@-import 'dart:convert';-import 'package:flutter/material.dart';import 'package:immich_mobile/constants/colors.dart';import 'package:immich_mobile/constants/enums.dart';import 'package:immich_mobile/domain/models/log.model.dart';import 'package:immich_mobile/domain/models/timeline.model.dart';+import 'package:immich_mobile/domain/models/value_codec.dart';import 'package:immich_mobile/providers/album/album_sort_by_options.provider.dart';import 'package:immich_mobile/utils/semver.dart';enum SettingsKey<T> {// Theme- themePrimaryColor<ImmichColorPreset>(codec: _EnumCodec(ImmichColorPreset.values)),- themeMode<ThemeMode>(codec: _EnumCodec(ThemeMode.values)),+ themePrimaryColor<ImmichColorPreset>(codec: EnumCodec(ImmichColorPreset.values)),+ themeMode<ThemeMode>(codec: EnumCodec(ThemeMode.values)),themeDynamic<bool>(),themeColorfulInterface<bool>(),@@ -27,13 +26,13 @@ enum SettingsKey<T> {// NetworknetworkAutoEndpointSwitching<bool>(),+ networkExternalEndpointList<List<String>>(codec: ListCodec(PrimitiveCodec.string)),+ networkCustomHeaders<Map<String, String>>(codec: MapCodec(PrimitiveCodec.string, PrimitiveCodec.string)),networkPreferredWifiName<String?>(),networkLocalEndpoint<String?>(),- networkExternalEndpointList<List<String>>(codec: _ListCodec(_PrimitiveCodec.string)),- networkCustomHeaders<Map<String, String>>(codec: _MapCodec(_PrimitiveCodec.string, _PrimitiveCodec.string)),// Album- albumSortMode<AlbumSortMode>(codec: _EnumCodec(AlbumSortMode.values)),+ albumSortMode<AlbumSortMode>(codec: EnumCodec(AlbumSortMode.values)),albumIsReverse<bool>(),albumIsGrid<bool>(),@@ -47,195 +46,45 @@ enum SettingsKey<T> {// TimelinetimelineTilesPerRow<int>(),- timelineGroupAssetsBy<GroupAssetsBy>(codec: _EnumCodec(GroupAssetsBy.values)),+ timelineGroupAssetsBy<GroupAssetsBy>(codec: EnumCodec(GroupAssetsBy.values)),timelineStorageIndicator<bool>(),// Log- logLevel<LogLevel>(codec: _EnumCodec(LogLevel.values)),+ logLevel<LogLevel>(codec: EnumCodec(LogLevel.values)),// MapmapShowFavoriteOnly<bool>(),mapRelativeDate<int>(),mapIncludeArchived<bool>(),- mapThemeMode<ThemeMode>(codec: _EnumCodec(ThemeMode.values)),+ mapThemeMode<ThemeMode>(codec: EnumCodec(ThemeMode.values)),mapWithPartners<bool>(),// CleanupcleanupKeepFavorites<bool>(),- cleanupKeepMediaType<AssetKeepType>(codec: _EnumCodec(AssetKeepType.values)),- cleanupKeepAlbumIds<List<String>>(codec: _ListCodec(_PrimitiveCodec.string)),+ cleanupKeepMediaType<AssetKeepType>(codec: EnumCodec(AssetKeepType.values)),+ cleanupKeepAlbumIds<List<String>>(codec: ListCodec(PrimitiveCodec.string)),cleanupCutoffDaysAgo<int>(),cleanupDefaultsInitialized<bool>(),// Share- shareFileType<ShareAssetType>(codec: _EnumCodec(ShareAssetType.values)),+ shareFileType<ShareAssetType>(codec: EnumCodec(ShareAssetType.values)),// SlideshowslideshowRepeat<bool>(),slideshowDuration<int>(),- slideshowLook<SlideshowLook>(codec: _EnumCodec(SlideshowLook.values)),- slideshowDirection<SlideshowDirection>(codec: _EnumCodec(SlideshowDirection.values)),+ slideshowLook<SlideshowLook>(codec: EnumCodec(SlideshowLook.values)),+ slideshowDirection<SlideshowDirection>(codec: EnumCodec(SlideshowDirection.values)),// Feature message- featureMessageSeenRelease<SemVer>(codec: _SemVerCodec());+ featureMessageSeenRelease<SemVer>(codec: SemVerCodec());- final _SettingsCodec<T>? _codecOverride;+ final ValueCodec<T>? _codecOverride;- const SettingsKey({_SettingsCodec<T>? codec}) : _codecOverride = codec;+ const SettingsKey({ValueCodec<T>? codec}) : _codecOverride = codec;- _SettingsCodec<T> get _codec => _codecOverride ?? _SettingsCodec.forType(T);+ ValueCodec<T> get _codec => _codecOverride ?? ValueCodec.forType(T);String encode(T value) => _codec.encode(value);T decode(String raw) => _codec.decode(raw);}--sealed class _SettingsCodec<T> {- const _SettingsCodec();-- String encode(T value);- T decode(String raw);-- static final Map<Type, _SettingsCodec<Object>> _primitives = {- ..._register<int>(_PrimitiveCodec.integer),- ..._register<double>(_PrimitiveCodec.real),- ..._register<bool>(_PrimitiveCodec.boolean),- ..._register<String>(_PrimitiveCodec.string),- ..._register<DateTime>(const _DateTimeCodec()),- };-- static Map<Type, _SettingsCodec<Object>> _register<T>(_SettingsCodec<Object> codec) => {- T: codec,- // Reifies the nullable type T so it can be used as a key in the _primitives map- _typeOf<T?>(): codec,- };-- static Type _typeOf<T>() => T;-- static _SettingsCodec<T> forType<T>(Type runtimeType) {- final codec = _primitives[runtimeType];- if (codec == null) {- throw StateError('No primitive codec for $runtimeType. Provide an explicit codec when defining the SettingsKey.');- }- return codec as _SettingsCodec<T>;- }-}--final class _EnumCodec<T extends Enum> extends _SettingsCodec<T> {- final List<T> values;-- const _EnumCodec(this.values);-- @override- String encode(T value) => value.name;-- @override- T decode(String raw) => values.firstWhere((v) => v.name == raw);-}--final class _DateTimeCodec extends _SettingsCodec<DateTime> {- const _DateTimeCodec();-- @override- String encode(DateTime value) => value.toIso8601String();-- @override- DateTime decode(String raw) => DateTime.parse(raw);-}--final class _SemVerCodec extends _SettingsCodec<SemVer> {- const _SemVerCodec();-- @override- String encode(SemVer value) => value.toString();-- @override- SemVer decode(String raw) => SemVer.fromString(raw);-}--final class _MapCodec<K extends Object, V extends Object> extends _SettingsCodec<Map<K, V>> {- final _SettingsCodec<K> _keyCodec;- final _SettingsCodec<V> _valueCodec;-- const _MapCodec(this._keyCodec, this._valueCodec);-- @override- String encode(Map<K, V> value) {- final entries = <String, String>{};- value.forEach((k, v) => entries[_keyCodec.encode(k)] = _valueCodec.encode(v));- return jsonEncode(entries);- }-- @override- Map<K, V> decode(String raw) {- try {- final decoded = jsonDecode(raw);- if (decoded is! Map) {- return {};- }- final result = <K, V>{};- for (final entry in decoded.entries) {- final rawKey = entry.key;- final rawValue = entry.value;- if (rawKey is! String || rawValue is! String) {- return {};- }- final k = _keyCodec.decode(rawKey);- final v = _valueCodec.decode(rawValue);- result[k] = v;- }- return result;- } on FormatException {- return {};- }- }-}--final class _ListCodec<T extends Object> extends _SettingsCodec<List<T>> {- final _SettingsCodec<T> _elementCodec;-- const _ListCodec(this._elementCodec);-- @override- String encode(List<T> value) => jsonEncode(value.map(_elementCodec.encode).toList());-- @override- List<T> decode(String raw) {- try {- final decoded = jsonDecode(raw);- if (decoded is! List) {- return [];- }- final result = <T>[];- for (final item in decoded) {- if (item is! String) {- return [];- }- final element = _elementCodec.decode(item);- result.add(element);- }- return result;- } on FormatException {- return [];- }- }-}--final class _PrimitiveCodec<T extends Object> extends _SettingsCodec<T> {- final T Function(String) _parse;-- const _PrimitiveCodec._(this._parse);-- @override- String encode(T value) => value.toString();-- @override- T decode(String raw) => _parse(raw);-- static const integer = _PrimitiveCodec<int>._(int.parse);- static const real = _PrimitiveCodec<double>._(double.parse);- static const boolean = _PrimitiveCodec<bool>._(bool.parse);- static const string = _PrimitiveCodec<String>._(_identity);-- static String _identity(String s) => s;-}diff --git a/mobile/lib/domain/models/value_codec.dart b/mobile/lib/domain/models/value_codec.dartnew file mode 100644index 0000000000..814ef1b926--- /dev/null+++ b/mobile/lib/domain/models/value_codec.dart@@ -0,0 +1,153 @@+import 'dart:convert';++import 'package:immich_mobile/utils/semver.dart';++sealed class ValueCodec<T> {+ const ValueCodec();++ String encode(T value);+ T decode(String raw);++ static final Map<Type, ValueCodec<Object>> _primitives = {+ ..._register<int>(PrimitiveCodec.integer),+ ..._register<double>(PrimitiveCodec.real),+ ..._register<bool>(PrimitiveCodec.boolean),+ ..._register<String>(PrimitiveCodec.string),+ ..._register<DateTime>(const DateTimeCodec()),+ };++ static Map<Type, ValueCodec<Object>> _register<T>(ValueCodec<Object> codec) => {+ T: codec,+ // Reifies the nullable type T so it can be used as a key in the _primitives map+ _typeOf<T?>(): codec,+ };++ static Type _typeOf<T>() => T;++ static ValueCodec<T> forType<T>(Type runtimeType) {+ final codec = _primitives[runtimeType];+ if (codec == null) {+ throw StateError('No primitive codec for $runtimeType. Provide an explicit codec when defining the key.');+ }+ return codec as ValueCodec<T>;+ }+}++final class EnumCodec<T extends Enum> extends ValueCodec<T> {+ final List<T> values;++ const EnumCodec(this.values);++ @override+ String encode(T value) => value.name;++ @override+ T decode(String raw) => values.firstWhere((v) => v.name == raw);+}++final class DateTimeCodec extends ValueCodec<DateTime> {+ const DateTimeCodec();++ @override+ String encode(DateTime value) => value.toIso8601String();++ @override+ DateTime decode(String raw) => DateTime.parse(raw);+}++final class SemVerCodec extends ValueCodec<SemVer> {+ const SemVerCodec();++ @override+ String encode(SemVer value) => value.toString();++ @override+ SemVer decode(String raw) => SemVer.fromString(raw);+}++final class MapCodec<K extends Object, V extends Object> extends ValueCodec<Map<K, V>> {+ final ValueCodec<K> _keyCodec;+ final ValueCodec<V> _valueCodec;++ const MapCodec(this._keyCodec, this._valueCodec);++ @override+ String encode(Map<K, V> value) {+ final entries = <String, String>{};+ value.forEach((k, v) => entries[_keyCodec.encode(k)] = _valueCodec.encode(v));+ return jsonEncode(entries);+ }++ @override+ Map<K, V> decode(String raw) {+ try {+ final decoded = jsonDecode(raw);+ if (decoded is! Map) {+ return {};+ }+ final result = <K, V>{};+ for (final entry in decoded.entries) {+ final rawKey = entry.key;+ final rawValue = entry.value;+ if (rawKey is! String || rawValue is! String) {+ continue;+ }+ final k = _keyCodec.decode(rawKey);+ final v = _valueCodec.decode(rawValue);+ result[k] = v;+ }+ return result;+ } on FormatException {+ return {};+ }+ }+}++final class ListCodec<T extends Object> extends ValueCodec<List<T>> {+ final ValueCodec<T> _elementCodec;++ const ListCodec(this._elementCodec);++ @override+ String encode(List<T> value) => jsonEncode(value.map(_elementCodec.encode).toList());++ @override+ List<T> decode(String raw) {+ try {+ final decoded = jsonDecode(raw);+ if (decoded is! List) {+ return [];+ }+ final result = <T>[];+ for (final item in decoded) {+ if (item is! String) {+ return [];+ }+ final element = _elementCodec.decode(item);+ result.add(element);+ }+ return result;+ } on FormatException {+ return [];+ }+ }+}++final class PrimitiveCodec<T extends Object> extends ValueCodec<T> {+ final T Function(String) _parse;++ const PrimitiveCodec._(this._parse);++ @override+ String encode(T value) => value.toString();++ @override+ T decode(String raw) => _parse(raw);++ static const integer = PrimitiveCodec<int>._(int.parse);+ static const real = PrimitiveCodec<double>._(double.parse);+ static const boolean = PrimitiveCodec<bool>._(bool.parse);+ static const string = PrimitiveCodec<String>._(_identity);++ static String _identity(String s) => s;+}diff --git a/mobile/lib/infrastructure/repositories/cached_key_value_repository.dart b/mobile/lib/infrastructure/repositories/cached_key_value_repository.dartnew file mode 100644index 0000000000..afeb31fa27--- /dev/null+++ b/mobile/lib/infrastructure/repositories/cached_key_value_repository.dart@@ -0,0 +1,41 @@+import 'package:collection/collection.dart';+import 'package:drift/drift.dart';+// ignore: depend_on_referenced_packages+import 'package:meta/meta.dart';++abstract class CachedKeyValueRepository<K extends Enum, S> {+ CachedKeyValueRepository(this._snapshot);++ S _snapshot;+ S get snapshot => _snapshot;+ @protected+ set snapshot(S value) => _snapshot = value;++ List<K> get keys;++ Object decodeValue(K key, String raw);++ S buildSnapshot(Map<K, Object?> overrides);++ Selectable<({String key, String? value})> selectable();++ Future<void> refresh() async => _snapshot = _build(await selectable().get());++ Stream<S> watchSnapshot() => selectable().watch().map((rows) => _snapshot = _build(rows));++ S _build(List<({String key, String? value})> rows) => buildSnapshot(+ rows.fold({}, (overrides, row) {+ final key = keys.firstWhereOrNull((key) => key.name == row.key);+ if (key == null) {+ return overrides;+ }++ Object? decodedValue;+ if (row.value != null) {+ decodedValue = decodeValue(key, row.value!);+ }++ return {...overrides, key: decodedValue};+ }),+ );+}diff --git a/mobile/lib/infrastructure/repositories/settings.repository.dart b/mobile/lib/infrastructure/repositories/settings.repository.dartindex c974963f6a..7063779336 100644--- a/mobile/lib/infrastructure/repositories/settings.repository.dart+++ b/mobile/lib/infrastructure/repositories/settings.repository.dart@@ -1,13 +1,14 @@-import 'package:collection/collection.dart';+import 'package:drift/drift.dart';import 'package:immich_mobile/domain/models/config/app_config.dart';import 'package:immich_mobile/domain/models/settings_key.dart';import 'package:immich_mobile/infrastructure/entities/settings.entity.drift.dart';+import 'package:immich_mobile/infrastructure/repositories/cached_key_value_repository.dart';import 'package:immich_mobile/infrastructure/repositories/db.repository.dart';-class SettingsRepository extends DriftDatabaseRepository {+class SettingsRepository extends CachedKeyValueRepository<SettingsKey, AppConfig> {final Drift _db;- SettingsRepository._(this._db) : super(_db);+ SettingsRepository._(this._db) : super(const .new());static SettingsRepository? _instance;@@ -19,9 +20,6 @@ class SettingsRepository extends DriftDatabaseRepository {return instance;}- AppConfig _appConfig = const .new();- AppConfig get appConfig => _appConfig;-static Future<SettingsRepository> ensureInitialized(Drift db) async {if (_instance == null) {final instance = SettingsRepository._(db);@@ -31,7 +29,20 @@ class SettingsRepository extends DriftDatabaseRepository {return _instance!;}- Future<void> refresh() async => _applyOverrides(await _db.select(_db.settingsEntity).get());+ @override+ List<SettingsKey> get keys => SettingsKey.values;++ @override+ Object decodeValue(SettingsKey key, String raw) => key.decode(raw);++ @override+ AppConfig buildSnapshot(Map<SettingsKey, Object?> overrides) => AppConfig.fromEntries(overrides);++ @override+ Selectable<({String key, String? value})> selectable() =>+ _db.select(_db.settingsEntity).map((row) => (key: row.key, value: row.value));++ AppConfig get appConfig => snapshot;Future<void> clear(Iterable<SettingsKey> keys) async {if (keys.isEmpty) {@@ -41,13 +52,15 @@ class SettingsRepository extends DriftDatabaseRepository {final names = keys.map((key) => key.name).toList();await (_db.delete(_db.settingsEntity)..where((row) => row.key.isIn(names))).go();+ var config = snapshot;for (final key in keys) {- _appConfig = _appConfig.write(key, defaultConfig.read(key));+ config = config.write(key, defaultConfig.read(key));}+ snapshot = config;}Future<void> write<T, U extends T>(SettingsKey<T> key, U value) async {- if (value == _appConfig.read(key)) {+ if (value == snapshot.read(key)) {return;}@@ -65,29 +78,8 @@ class SettingsRepository extends DriftDatabaseRepository {.insertOnConflictUpdate(SettingsEntityCompanion.insert(key: key.name, value: .new(resolvedValue), updatedAt: .new(DateTime.now())),);- _appConfig = _appConfig.write(key, value);+ snapshot = snapshot.write(key, value);}- Stream<AppConfig> watchConfig() => _db.select(_db.settingsEntity).watch().map((rows) {- _applyOverrides(rows);- return _appConfig;- });-- void _applyOverrides(List<SettingsEntityData> rows) {- _appConfig = AppConfig.fromEntries(- rows.fold({}, (overrides, row) {- final metadataKey = SettingsKey.values.firstWhereOrNull((key) => key.name == row.key);- if (metadataKey == null) {- return overrides;- }-- Object? decodedValue;- if (row.value != null) {- decodedValue = metadataKey.decode(row.value!);- }-- return {...overrides, metadataKey: decodedValue};- }),- );- }+ Stream<AppConfig> watchConfig() => watchSnapshot();}