feat(mobile): sqlite (immich-app#16861)

* refactor: user entity

* chore: rebase fixes

* refactor: remove int user Id

* refactor: migrate store userId from int to string

* refactor: rename uid to id

* feat: drift

* pr feedback

* refactor: move common overrides to mixin

---------

Co-authored-by: shenlong-tanwen <[email protected]>

Author: shenlong-tanwen

.gitattributes

@@ -6,6 +6,9 @@ mobile/openapi/**/*.dart linguist-generated=true
 mobile/lib/**/*.g.dart -diff -merge
 mobile/lib/**/*.g.dart linguist-generated=true
 
+mobile/lib/**/*.drift.dart -diff -merge
+mobile/lib/**/*.drift.dart linguist-generated=true
+
 open-api/typescript-sdk/fetch-client.ts -diff -merge
 open-api/typescript-sdk/fetch-client.ts linguist-generated=true
 

.vscode/settings.json

@@ -39,6 +39,7 @@
   ],
   "explorer.fileNesting.enabled": true,
   "explorer.fileNesting.patterns": {
-    "*.ts": "${capture}.spec.ts,${capture}.mock.ts"
+    "*.ts": "${capture}.spec.ts,${capture}.mock.ts",
+    "*.dart": "${capture}.g.dart,${capture}.gr.dart,${capture}.drift.dart"
   }
 }

mobile/analysis_options.yaml

@@ -36,6 +36,8 @@ analyzer:
   exclude:
     - openapi/**
     - lib/generated_plugin_registrant.dart
+    - lib/**/*.g.dart
+    - lib/**/*.drift.dart
 
   plugins:
     - custom_lint

mobile/build.yaml

@@ -0,0 +1,24 @@
+targets:
+   $default:
+     builders:
+       #drift @DriftDatabase()
+       drift_dev:
+         # Disable default builder to use modular builder instead
+         enabled: false
+       drift_dev:analyzer:
+         enabled: true
+         options: &drift_options
+           store_date_time_values_as_text: true
+           named_parameters: true
+           write_from_json_string_constructor: false
+           data_class_to_companions: false
+           # Required for make-migrations
+           databases:
+             main: lib/infrastructure/repositories/db.repository.dart
+         generate_for: &drift_generate_for
+           - lib/infrastructure/entities/*.dart
+           - lib/infrastructure/repositories/db.repository.dart
+       drift_dev:modular:
+         enabled: true
+         options: *drift_options
+         generate_for: *drift_generate_for

mobile/drift_schemas/main/drift_schema_v1.json

@@ -0,0 +1 @@
+{"_meta":{"description":"This file contains a serialized version of schema entities for drift.","version":"1.2.0"},"options":{"store_date_time_values_as_text":true},"entities":[{"id":0,"references":[],"type":"table","data":{"name":"user_entity","was_declared_in_moor":false,"columns":[{"name":"id","getter_name":"id","moor_type":"blob","nullable":false,"customConstraints":null,"default_dart":null,"default_client_dart":null,"dsl_features":[]},{"name":"name","getter_name":"name","moor_type":"string","nullable":false,"customConstraints":null,"default_dart":null,"default_client_dart":null,"dsl_features":[]},{"name":"is_admin","getter_name":"isAdmin","moor_type":"bool","nullable":false,"customConstraints":null,"defaultConstraints":"CHECK (\"is_admin\" IN (0, 1))","dialectAwareDefaultConstraints":{"sqlite":"CHECK (\"is_admin\" IN (0, 1))"},"default_dart":"const CustomExpression('0')","default_client_dart":null,"dsl_features":[]},{"name":"email","getter_name":"email","moor_type":"string","nullable":false,"customConstraints":null,"default_dart":null,"default_client_dart":null,"dsl_features":[]},{"name":"profile_image_path","getter_name":"profileImagePath","moor_type":"string","nullable":true,"customConstraints":null,"default_dart":null,"default_client_dart":null,"dsl_features":[]},{"name":"updated_at","getter_name":"updatedAt","moor_type":"dateTime","nullable":false,"customConstraints":null,"default_dart":"const CustomExpression('CURRENT_TIMESTAMP')","default_client_dart":null,"dsl_features":[]},{"name":"quota_size_in_bytes","getter_name":"quotaSizeInBytes","moor_type":"int","nullable":true,"customConstraints":null,"default_dart":null,"default_client_dart":null,"dsl_features":[]},{"name":"quota_usage_in_bytes","getter_name":"quotaUsageInBytes","moor_type":"int","nullable":false,"customConstraints":null,"default_dart":"const CustomExpression('0')","default_client_dart":null,"dsl_features":[]}],"is_virtual":false,"without_rowid":true,"constraints":[],"strict":true,"explicit_pk":["id"]}},{"id":1,"references":[0],"type":"table","data":{"name":"user_metadata_entity","was_declared_in_moor":false,"columns":[{"name":"user_id","getter_name":"userId","moor_type":"blob","nullable":false,"customConstraints":null,"defaultConstraints":"REFERENCES user_entity (id) ON DELETE CASCADE","dialectAwareDefaultConstraints":{"sqlite":"REFERENCES user_entity (id) ON DELETE CASCADE"},"default_dart":null,"default_client_dart":null,"dsl_features":["unknown"]},{"name":"preferences","getter_name":"preferences","moor_type":"string","nullable":false,"customConstraints":null,"default_dart":null,"default_client_dart":null,"dsl_features":[],"type_converter":{"dart_expr":"userPreferenceConverter","dart_type_name":"UserPreferences"}}],"is_virtual":false,"without_rowid":true,"constraints":[],"strict":true,"explicit_pk":["user_id"]}},{"id":2,"references":[0],"type":"table","data":{"name":"partner_entity","was_declared_in_moor":false,"columns":[{"name":"shared_by_id","getter_name":"sharedById","moor_type":"blob","nullable":false,"customConstraints":null,"defaultConstraints":"REFERENCES user_entity (id) ON DELETE CASCADE","dialectAwareDefaultConstraints":{"sqlite":"REFERENCES user_entity (id) ON DELETE CASCADE"},"default_dart":null,"default_client_dart":null,"dsl_features":["unknown"]},{"name":"shared_with_id","getter_name":"sharedWithId","moor_type":"blob","nullable":false,"customConstraints":null,"defaultConstraints":"REFERENCES user_entity (id) ON DELETE CASCADE","dialectAwareDefaultConstraints":{"sqlite":"REFERENCES user_entity (id) ON DELETE CASCADE"},"default_dart":null,"default_client_dart":null,"dsl_features":["unknown"]},{"name":"in_timeline","getter_name":"inTimeline","moor_type":"bool","nullable":false,"customConstraints":null,"defaultConstraints":"CHECK (\"in_timeline\" IN (0, 1))","dialectAwareDefaultConstraints":{"sqlite":"CHECK (\"in_timeline\" IN (0, 1))"},"default_dart":"const CustomExpression('0')","default_client_dart":null,"dsl_features":[]}],"is_virtual":false,"without_rowid":true,"constraints":[],"strict":true,"explicit_pk":["shared_by_id","shared_with_id"]}}]}

mobile/lib/domain/models/user.model.dart

@@ -1,32 +1,4 @@
-import 'dart:ui';
-
-enum AvatarColor {
-  // do not change this order or reuse indices for other purposes, adding is OK
-  primary,
-  pink,
-  red,
-  yellow,
-  blue,
-  green,
-  purple,
-  orange,
-  gray,
-  amber;
-
-  Color toColor({bool isDarkTheme = false}) => switch (this) {
-        AvatarColor.primary =>
-          isDarkTheme ? const Color(0xFFABCBFA) : const Color(0xFF4250AF),
-        AvatarColor.pink => const Color.fromARGB(255, 244, 114, 182),
-        AvatarColor.red => const Color.fromARGB(255, 239, 68, 68),
-        AvatarColor.yellow => const Color.fromARGB(255, 234, 179, 8),
-        AvatarColor.blue => const Color.fromARGB(255, 59, 130, 246),
-        AvatarColor.green => const Color.fromARGB(255, 22, 163, 74),
-        AvatarColor.purple => const Color.fromARGB(255, 147, 51, 234),
-        AvatarColor.orange => const Color.fromARGB(255, 234, 88, 12),
-        AvatarColor.gray => const Color.fromARGB(255, 75, 85, 99),
-        AvatarColor.amber => const Color.fromARGB(255, 217, 119, 6),
-      };
-}
+import 'package:immich_mobile/domain/models/user_metadata.model.dart';
 
 // TODO: Rename to User once Isar is removed
 class UserDto {

mobile/lib/domain/models/user_metadata.model.dart

@@ -0,0 +1,105 @@
+import 'dart:ui';
+
+enum AvatarColor {
+  // do not change this order or reuse indices for other purposes, adding is OK
+  primary("primary"),
+  pink("pink"),
+  red("red"),
+  yellow("yellow"),
+  blue("blue"),
+  green("green"),
+  purple("purple"),
+  orange("orange"),
+  gray("gray"),
+  amber("amber");
+
+  final String value;
+  const AvatarColor(this.value);
+
+  Color toColor({bool isDarkTheme = false}) => switch (this) {
+        AvatarColor.primary =>
+          isDarkTheme ? const Color(0xFFABCBFA) : const Color(0xFF4250AF),
+        AvatarColor.pink => const Color.fromARGB(255, 244, 114, 182),
+        AvatarColor.red => const Color.fromARGB(255, 239, 68, 68),
+        AvatarColor.yellow => const Color.fromARGB(255, 234, 179, 8),
+        AvatarColor.blue => const Color.fromARGB(255, 59, 130, 246),
+        AvatarColor.green => const Color.fromARGB(255, 22, 163, 74),
+        AvatarColor.purple => const Color.fromARGB(255, 147, 51, 234),
+        AvatarColor.orange => const Color.fromARGB(255, 234, 88, 12),
+        AvatarColor.gray => const Color.fromARGB(255, 75, 85, 99),
+        AvatarColor.amber => const Color.fromARGB(255, 217, 119, 6),
+      };
+}
+
+class UserPreferences {
+  final bool foldersEnabled;
+  final bool memoriesEnabled;
+  final bool peopleEnabled;
+  final bool ratingsEnabled;
+  final bool sharedLinksEnabled;
+  final bool tagsEnabled;
+  final AvatarColor userAvatarColor;
+  final bool showSupportBadge;
+
+  const UserPreferences({
+    this.foldersEnabled = false,
+    this.memoriesEnabled = true,
+    this.peopleEnabled = true,
+    this.ratingsEnabled = false,
+    this.sharedLinksEnabled = true,
+    this.tagsEnabled = false,
+    this.userAvatarColor = AvatarColor.primary,
+    this.showSupportBadge = true,
+  });
+
+  UserPreferences copyWith({
+    bool? foldersEnabled,
+    bool? memoriesEnabled,
+    bool? peopleEnabled,
+    bool? ratingsEnabled,
+    bool? sharedLinksEnabled,
+    bool? tagsEnabled,
+    AvatarColor? userAvatarColor,
+    bool? showSupportBadge,
+  }) {
+    return UserPreferences(
+      foldersEnabled: foldersEnabled ?? this.foldersEnabled,
+      memoriesEnabled: memoriesEnabled ?? this.memoriesEnabled,
+      peopleEnabled: peopleEnabled ?? this.peopleEnabled,
+      ratingsEnabled: ratingsEnabled ?? this.ratingsEnabled,
+      sharedLinksEnabled: sharedLinksEnabled ?? this.sharedLinksEnabled,
+      tagsEnabled: tagsEnabled ?? this.tagsEnabled,
+      userAvatarColor: userAvatarColor ?? this.userAvatarColor,
+      showSupportBadge: showSupportBadge ?? this.showSupportBadge,
+    );
+  }
+
+  Map<String, Object?> toMap() {
+    final preferences = <String, Object?>{};
+    preferences["folders-Enabled"] = foldersEnabled;
+    preferences["memories-Enabled"] = memoriesEnabled;
+    preferences["people-Enabled"] = peopleEnabled;
+    preferences["ratings-Enabled"] = ratingsEnabled;
+    preferences["sharedLinks-Enabled"] = sharedLinksEnabled;
+    preferences["tags-Enabled"] = tagsEnabled;
+    preferences["avatar-Color"] = userAvatarColor.value;
+    preferences["purchase-ShowSupportBadge"] = showSupportBadge;
+    return preferences;
+  }
+
+  factory UserPreferences.fromMap(Map<String, Object?> map) {
+    return UserPreferences(
+      foldersEnabled: map["folders-Enabled"] as bool? ?? false,
+      memoriesEnabled: map["memories-Enabled"] as bool? ?? true,
+      peopleEnabled: map["people-Enabled"] as bool? ?? true,
+      ratingsEnabled: map["ratings-Enabled"] as bool? ?? false,
+      sharedLinksEnabled: map["sharedLinks-Enabled"] as bool? ?? true,
+      tagsEnabled: map["tags-Enabled"] as bool? ?? false,
+      userAvatarColor: AvatarColor.values.firstWhere(
+        (e) => e.value == map["avatar-Color"] as String?,
+        orElse: () => AvatarColor.primary,
+      ),
+      showSupportBadge: map["purchase-ShowSupportBadge"] as bool? ?? true,
+    );
+  }
+}

mobile/lib/infrastructure/entities/partner.entity.dart

@@ -0,0 +1,18 @@
+import 'package:drift/drift.dart';
+import 'package:immich_mobile/infrastructure/entities/user.entity.dart';
+import 'package:immich_mobile/infrastructure/utils/drift_default.mixin.dart';
+
+class PartnerEntity extends Table with DriftDefaultsMixin {
+  const PartnerEntity();
+
+  BlobColumn get sharedById =>
+      blob().references(UserEntity, #id, onDelete: KeyAction.cascade)();
+
+  BlobColumn get sharedWithId =>
+      blob().references(UserEntity, #id, onDelete: KeyAction.cascade)();
+
+  BoolColumn get inTimeline => boolean().withDefault(const Constant(false))();
+
+  @override
+  Set<Column> get primaryKey => {sharedById, sharedWithId};
+}