High performance self-hosted photo and video management solution.
TypeScript backup-toolfluttergoogle-photosgoogle-photos-alternativejavascriptmobile-appnestjsnodejsphoto-galleryphotosphotos-managementself-hostedsveltesveltekittypescriptvideos
feat: UserMetadata sync (#19882)
Daniel Dietzlerdf581cc0d53a
diff --git a/mobile/openapi/README.md b/mobile/openapi/README.mdindex 5b90e4a633..5085052c05 100644--- a/mobile/openapi/README.md+++ b/mobile/openapi/README.md@@ -490,6 +490,8 @@ Class | Method | HTTP request | Description- [SyncStackV1](doc//SyncStackV1.md)- [SyncStreamDto](doc//SyncStreamDto.md)- [SyncUserDeleteV1](doc//SyncUserDeleteV1.md)+ - [SyncUserMetadataDeleteV1](doc//SyncUserMetadataDeleteV1.md)+ - [SyncUserMetadataV1](doc//SyncUserMetadataV1.md)- [SyncUserV1](doc//SyncUserV1.md)- [SystemConfigBackupsDto](doc//SystemConfigBackupsDto.md)- [SystemConfigDto](doc//SystemConfigDto.md)diff --git a/mobile/openapi/lib/api.dart b/mobile/openapi/lib/api.dartindex 4de0614cf6..f30481ecce 100644--- a/mobile/openapi/lib/api.dart+++ b/mobile/openapi/lib/api.dart@@ -272,6 +272,8 @@ part 'model/sync_stack_delete_v1.dart';part 'model/sync_stack_v1.dart';part 'model/sync_stream_dto.dart';part 'model/sync_user_delete_v1.dart';+part 'model/sync_user_metadata_delete_v1.dart';+part 'model/sync_user_metadata_v1.dart';part 'model/sync_user_v1.dart';part 'model/system_config_backups_dto.dart';part 'model/system_config_dto.dart';diff --git a/mobile/openapi/lib/api_client.dart b/mobile/openapi/lib/api_client.dartindex 26113a1115..f1cf05f110 100644--- a/mobile/openapi/lib/api_client.dart+++ b/mobile/openapi/lib/api_client.dart@@ -600,6 +600,10 @@ class ApiClient {return SyncStreamDto.fromJson(value);case 'SyncUserDeleteV1':return SyncUserDeleteV1.fromJson(value);+ case 'SyncUserMetadataDeleteV1':+ return SyncUserMetadataDeleteV1.fromJson(value);+ case 'SyncUserMetadataV1':+ return SyncUserMetadataV1.fromJson(value);case 'SyncUserV1':return SyncUserV1.fromJson(value);case 'SystemConfigBackupsDto':diff --git a/mobile/openapi/lib/model/sync_entity_type.dart b/mobile/openapi/lib/model/sync_entity_type.dartindex 1d09a6dbe0..61f94401c7 100644--- a/mobile/openapi/lib/model/sync_entity_type.dart+++ b/mobile/openapi/lib/model/sync_entity_type.dart@@ -58,6 +58,8 @@ class SyncEntityType {static const stackDeleteV1 = SyncEntityType._(r'StackDeleteV1');static const personV1 = SyncEntityType._(r'PersonV1');static const personDeleteV1 = SyncEntityType._(r'PersonDeleteV1');+ static const userMetadataV1 = SyncEntityType._(r'UserMetadataV1');+ static const userMetadataDeleteV1 = SyncEntityType._(r'UserMetadataDeleteV1');static const syncAckV1 = SyncEntityType._(r'SyncAckV1');static const syncResetV1 = SyncEntityType._(r'SyncResetV1');@@ -98,6 +100,8 @@ class SyncEntityType {stackDeleteV1,personV1,personDeleteV1,+ userMetadataV1,+ userMetadataDeleteV1,syncAckV1,syncResetV1,];@@ -173,6 +177,8 @@ class SyncEntityTypeTypeTransformer {case r'StackDeleteV1': return SyncEntityType.stackDeleteV1;case r'PersonV1': return SyncEntityType.personV1;case r'PersonDeleteV1': return SyncEntityType.personDeleteV1;+ case r'UserMetadataV1': return SyncEntityType.userMetadataV1;+ case r'UserMetadataDeleteV1': return SyncEntityType.userMetadataDeleteV1;case r'SyncAckV1': return SyncEntityType.syncAckV1;case r'SyncResetV1': return SyncEntityType.syncResetV1;default:diff --git a/mobile/openapi/lib/model/sync_request_type.dart b/mobile/openapi/lib/model/sync_request_type.dartindex 0b121d96c6..75ce852f9f 100644--- a/mobile/openapi/lib/model/sync_request_type.dart+++ b/mobile/openapi/lib/model/sync_request_type.dart@@ -39,6 +39,7 @@ class SyncRequestType {static const stacksV1 = SyncRequestType._(r'StacksV1');static const usersV1 = SyncRequestType._(r'UsersV1');static const peopleV1 = SyncRequestType._(r'PeopleV1');+ static const userMetadataV1 = SyncRequestType._(r'UserMetadataV1');/// List of all possible values in this [enum][SyncRequestType].static const values = <SyncRequestType>[@@ -58,6 +59,7 @@ class SyncRequestType {stacksV1,usersV1,peopleV1,+ userMetadataV1,];static SyncRequestType? fromJson(dynamic value) => SyncRequestTypeTypeTransformer().decode(value);@@ -112,6 +114,7 @@ class SyncRequestTypeTypeTransformer {case r'StacksV1': return SyncRequestType.stacksV1;case r'UsersV1': return SyncRequestType.usersV1;case r'PeopleV1': return SyncRequestType.peopleV1;+ case r'UserMetadataV1': return SyncRequestType.userMetadataV1;default:if (!allowNull) {throw ArgumentError('Unknown enum value to decode: $data');diff --git a/mobile/openapi/lib/model/sync_user_metadata_delete_v1.dart b/mobile/openapi/lib/model/sync_user_metadata_delete_v1.dartnew file mode 100644index 0000000000..e9dd733295--- /dev/null+++ b/mobile/openapi/lib/model/sync_user_metadata_delete_v1.dart@@ -0,0 +1,107 @@+//+// AUTO-GENERATED FILE, DO NOT MODIFY!+//+// @dart=2.18++// ignore_for_file: unused_element, unused_import+// ignore_for_file: always_put_required_named_parameters_first+// ignore_for_file: constant_identifier_names+// ignore_for_file: lines_longer_than_80_chars++part of openapi.api;++class SyncUserMetadataDeleteV1 {+ /// Returns a new [SyncUserMetadataDeleteV1] instance.+ SyncUserMetadataDeleteV1({+ required this.key,+ required this.userId,+ });++ String key;++ String userId;++ @override+ bool operator ==(Object other) => identical(this, other) || other is SyncUserMetadataDeleteV1 &&+ other.key == key &&+ other.userId == userId;++ @override+ int get hashCode =>+ // ignore: unnecessary_parenthesis+ (key.hashCode) ++ (userId.hashCode);++ @override+ String toString() => 'SyncUserMetadataDeleteV1[key=$key, userId=$userId]';++ Map<String, dynamic> toJson() {+ final json = <String, dynamic>{};+ json[r'key'] = this.key;+ json[r'userId'] = this.userId;+ return json;+ }++ /// Returns a new [SyncUserMetadataDeleteV1] instance and imports its values from+ /// [value] if it's a [Map], null otherwise.+ // ignore: prefer_constructors_over_static_methods+ static SyncUserMetadataDeleteV1? fromJson(dynamic value) {+ upgradeDto(value, "SyncUserMetadataDeleteV1");+ if (value is Map) {+ final json = value.cast<String, dynamic>();++ return SyncUserMetadataDeleteV1(+ key: mapValueOfType<String>(json, r'key')!,+ userId: mapValueOfType<String>(json, r'userId')!,+ );+ }+ return null;+ }++ static List<SyncUserMetadataDeleteV1> listFromJson(dynamic json, {bool growable = false,}) {+ final result = <SyncUserMetadataDeleteV1>[];+ if (json is List && json.isNotEmpty) {+ for (final row in json) {+ final value = SyncUserMetadataDeleteV1.fromJson(row);+ if (value != null) {+ result.add(value);+ }+ }+ }+ return result.toList(growable: growable);+ }++ static Map<String, SyncUserMetadataDeleteV1> mapFromJson(dynamic json) {+ final map = <String, SyncUserMetadataDeleteV1>{};+ if (json is Map && json.isNotEmpty) {+ json = json.cast<String, dynamic>(); // ignore: parameter_assignments+ for (final entry in json.entries) {+ final value = SyncUserMetadataDeleteV1.fromJson(entry.value);+ if (value != null) {+ map[entry.key] = value;+ }+ }+ }+ return map;+ }++ // maps a json object with a list of SyncUserMetadataDeleteV1-objects as value to a dart map+ static Map<String, List<SyncUserMetadataDeleteV1>> mapListFromJson(dynamic json, {bool growable = false,}) {+ final map = <String, List<SyncUserMetadataDeleteV1>>{};+ if (json is Map && json.isNotEmpty) {+ // ignore: parameter_assignments+ json = json.cast<String, dynamic>();+ for (final entry in json.entries) {+ map[entry.key] = SyncUserMetadataDeleteV1.listFromJson(entry.value, growable: growable,);+ }+ }+ return map;+ }++ /// The list of required keys that must be present in a JSON.+ static const requiredKeys = <String>{+ 'key',+ 'userId',+ };+}+diff --git a/mobile/openapi/lib/model/sync_user_metadata_v1.dart b/mobile/openapi/lib/model/sync_user_metadata_v1.dartnew file mode 100644index 0000000000..0b060dc17c--- /dev/null+++ b/mobile/openapi/lib/model/sync_user_metadata_v1.dart@@ -0,0 +1,115 @@+//+// AUTO-GENERATED FILE, DO NOT MODIFY!+//+// @dart=2.18++// ignore_for_file: unused_element, unused_import+// ignore_for_file: always_put_required_named_parameters_first+// ignore_for_file: constant_identifier_names+// ignore_for_file: lines_longer_than_80_chars++part of openapi.api;++class SyncUserMetadataV1 {+ /// Returns a new [SyncUserMetadataV1] instance.+ SyncUserMetadataV1({+ required this.key,+ required this.userId,+ required this.value,+ });++ String key;++ String userId;++ Object value;++ @override+ bool operator ==(Object other) => identical(this, other) || other is SyncUserMetadataV1 &&+ other.key == key &&+ other.userId == userId &&+ other.value == value;++ @override+ int get hashCode =>+ // ignore: unnecessary_parenthesis+ (key.hashCode) ++ (userId.hashCode) ++ (value.hashCode);++ @override+ String toString() => 'SyncUserMetadataV1[key=$key, userId=$userId, value=$value]';++ Map<String, dynamic> toJson() {+ final json = <String, dynamic>{};+ json[r'key'] = this.key;+ json[r'userId'] = this.userId;+ json[r'value'] = this.value;+ return json;+ }++ /// Returns a new [SyncUserMetadataV1] instance and imports its values from+ /// [value] if it's a [Map], null otherwise.+ // ignore: prefer_constructors_over_static_methods+ static SyncUserMetadataV1? fromJson(dynamic value) {+ upgradeDto(value, "SyncUserMetadataV1");+ if (value is Map) {+ final json = value.cast<String, dynamic>();++ return SyncUserMetadataV1(+ key: mapValueOfType<String>(json, r'key')!,+ userId: mapValueOfType<String>(json, r'userId')!,+ value: mapValueOfType<Object>(json, r'value')!,+ );+ }+ return null;+ }++ static List<SyncUserMetadataV1> listFromJson(dynamic json, {bool growable = false,}) {+ final result = <SyncUserMetadataV1>[];+ if (json is List && json.isNotEmpty) {+ for (final row in json) {+ final value = SyncUserMetadataV1.fromJson(row);+ if (value != null) {+ result.add(value);+ }+ }+ }+ return result.toList(growable: growable);+ }++ static Map<String, SyncUserMetadataV1> mapFromJson(dynamic json) {+ final map = <String, SyncUserMetadataV1>{};+ if (json is Map && json.isNotEmpty) {+ json = json.cast<String, dynamic>(); // ignore: parameter_assignments+ for (final entry in json.entries) {+ final value = SyncUserMetadataV1.fromJson(entry.value);+ if (value != null) {+ map[entry.key] = value;+ }+ }+ }+ return map;+ }++ // maps a json object with a list of SyncUserMetadataV1-objects as value to a dart map+ static Map<String, List<SyncUserMetadataV1>> mapListFromJson(dynamic json, {bool growable = false,}) {+ final map = <String, List<SyncUserMetadataV1>>{};+ if (json is Map && json.isNotEmpty) {+ // ignore: parameter_assignments+ json = json.cast<String, dynamic>();+ for (final entry in json.entries) {+ map[entry.key] = SyncUserMetadataV1.listFromJson(entry.value, growable: growable,);+ }+ }+ return map;+ }++ /// The list of required keys that must be present in a JSON.+ static const requiredKeys = <String>{+ 'key',+ 'userId',+ 'value',+ };+}+diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.jsonindex 2e6c70adaa..18204c21f3 100644--- a/open-api/immich-openapi-specs.json+++ b/open-api/immich-openapi-specs.json@@ -13902,6 +13902,8 @@"StackDeleteV1","PersonV1","PersonDeleteV1",+ "UserMetadataV1",+ "UserMetadataDeleteV1","SyncAckV1","SyncResetV1"],@@ -14137,7 +14139,8 @@"PartnerStacksV1","StacksV1","UsersV1",- "PeopleV1"+ "PeopleV1",+ "UserMetadataV1"],"type": "string"},@@ -14213,6 +14216,40 @@],"type": "object"},+ "SyncUserMetadataDeleteV1": {+ "properties": {+ "key": {+ "type": "string"+ },+ "userId": {+ "type": "string"+ }+ },+ "required": [+ "key",+ "userId"+ ],+ "type": "object"+ },+ "SyncUserMetadataV1": {+ "properties": {+ "key": {+ "type": "string"+ },+ "userId": {+ "type": "string"+ },+ "value": {+ "type": "object"+ }+ },+ "required": [+ "key",+ "userId",+ "value"+ ],+ "type": "object"+ },"SyncUserV1": {"properties": {"deletedAt": {diff --git a/open-api/typescript-sdk/src/fetch-client.ts b/open-api/typescript-sdk/src/fetch-client.tsindex f7fc9fe61e..88dee9bf0b 100644--- a/open-api/typescript-sdk/src/fetch-client.ts+++ b/open-api/typescript-sdk/src/fetch-client.ts@@ -4116,6 +4116,8 @@ export enum SyncEntityType {StackDeleteV1 = "StackDeleteV1",PersonV1 = "PersonV1",PersonDeleteV1 = "PersonDeleteV1",+ UserMetadataV1 = "UserMetadataV1",+ UserMetadataDeleteV1 = "UserMetadataDeleteV1",SyncAckV1 = "SyncAckV1",SyncResetV1 = "SyncResetV1"}@@ -4135,7 +4137,8 @@ export enum SyncRequestType {PartnerStacksV1 = "PartnerStacksV1",StacksV1 = "StacksV1",UsersV1 = "UsersV1",- PeopleV1 = "PeopleV1"+ PeopleV1 = "PeopleV1",+ UserMetadataV1 = "UserMetadataV1"}export enum TranscodeHWAccel {Nvenc = "nvenc",diff --git a/server/src/dtos/sync.dto.ts b/server/src/dtos/sync.dto.tsindex ff5df03eaf..abd7d7b694 100644--- a/server/src/dtos/sync.dto.ts+++ b/server/src/dtos/sync.dto.ts@@ -10,7 +10,9 @@ import {MemoryType,SyncEntityType,SyncRequestType,+ UserMetadataKey,} from 'src/enum';+import { UserMetadata } from 'src/types';import { Optional, ValidateBoolean, ValidateDate, ValidateUUID } from 'src/validation';export class AssetFullSyncDto {@@ -253,6 +255,19 @@ export class SyncPersonDeleteV1 {personId!: string;}+@ExtraModel()+export class SyncUserMetadataV1 {+ userId!: string;+ key!: string;+ value!: UserMetadata[UserMetadataKey];+}++@ExtraModel()+export class SyncUserMetadataDeleteV1 {+ userId!: string;+ key!: string;+}+@ExtraModel()export class SyncAckV1 {}@@ -295,6 +310,8 @@ export type SyncItem = {[SyncEntityType.PartnerStackV1]: SyncStackV1;[SyncEntityType.PersonV1]: SyncPersonV1;[SyncEntityType.PersonDeleteV1]: SyncPersonDeleteV1;+ [SyncEntityType.UserMetadataV1]: SyncUserMetadataV1;+ [SyncEntityType.UserMetadataDeleteV1]: SyncUserMetadataDeleteV1;[SyncEntityType.SyncAckV1]: SyncAckV1;[SyncEntityType.SyncResetV1]: SyncResetV1;};diff --git a/server/src/enum.ts b/server/src/enum.tsindex 6d960e1fbb..dca0f09555 100644--- a/server/src/enum.ts+++ b/server/src/enum.ts@@ -589,6 +589,7 @@ export enum SyncRequestType {StacksV1 = 'StacksV1',UsersV1 = 'UsersV1',PeopleV1 = 'PeopleV1',+ UserMetadataV1 = 'UserMetadataV1',}export enum SyncEntityType {@@ -639,6 +640,9 @@ export enum SyncEntityType {PersonV1 = 'PersonV1',PersonDeleteV1 = 'PersonDeleteV1',+ UserMetadataV1 = 'UserMetadataV1',+ UserMetadataDeleteV1 = 'UserMetadataDeleteV1',+SyncAckV1 = 'SyncAckV1',SyncResetV1 = 'SyncResetV1',}diff --git a/server/src/queries/sync.repository.sql b/server/src/queries/sync.repository.sqlindex f68be8c83f..ac3632ad4a 100644--- a/server/src/queries/sync.repository.sql+++ b/server/src/queries/sync.repository.sql@@ -835,3 +835,30 @@ where"updatedAt" < now() - interval '1 millisecond'order by"updateId" asc++-- SyncRepository.userMetadata.getDeletes+select+ "id",+ "userId",+ "key"+from+ "user_metadata_audit"+where+ "userId" = $1+ and "deletedAt" < now() - interval '1 millisecond'+order by+ "id" asc++-- SyncRepository.userMetadata.getUpserts+select+ "userId",+ "key",+ "value",+ "updateId"+from+ "user_metadata"+where+ "userId" = $1+ and "updatedAt" < now() - interval '1 millisecond'+order by+ "updateId" ascdiff --git a/server/src/repositories/sync.repository.ts b/server/src/repositories/sync.repository.tsindex 3bc09c97eb..f9d65f7244 100644--- a/server/src/repositories/sync.repository.ts+++ b/server/src/repositories/sync.repository.ts@@ -16,7 +16,8 @@ type AuditTables =| 'memories_audit'| 'memory_assets_audit'| 'stacks_audit'- | 'person_audit';+ | 'person_audit'+ | 'user_metadata_audit';type UpsertTables =| 'users'| 'partners'@@ -27,7 +28,8 @@ type UpsertTables =| 'memories'| 'memories_assets_assets'| 'asset_stack'- | 'person';+ | 'person'+ | 'user_metadata';@Injectable()export class SyncRepository {@@ -47,6 +49,7 @@ export class SyncRepository {people: PersonSync;stack: StackSync;user: UserSync;+ userMetadata: UserMetadataSync;constructor(@InjectKysely() private db: Kysely<DB>) {this.album = new AlbumSync(this.db);@@ -65,32 +68,31 @@ export class SyncRepository {this.people = new PersonSync(this.db);this.stack = new StackSync(this.db);this.user = new UserSync(this.db);+ this.userMetadata = new UserMetadataSync(this.db);}}class BaseSync {constructor(protected db: Kysely<DB>) {}- protected auditTableFilters<T extends keyof Pick<DB, AuditTables>, D>(- qb: SelectQueryBuilder<DB, T, D>,- ack?: SyncAck,- ) {- const builder = qb as SelectQueryBuilder<DB, AuditTables, D>;- return builder- .where('deletedAt', '<', sql.raw<Date>("now() - interval '1 millisecond'"))- .$if(!!ack, (qb) => qb.where('id', '>', ack!.updateId))- .orderBy('id', 'asc') as SelectQueryBuilder<DB, T, D>;- }-- protected upsertTableFilters<T extends keyof Pick<DB, UpsertTables>, D>(- qb: SelectQueryBuilder<DB, T, D>,- ack?: SyncAck,- ) {- const builder = qb as SelectQueryBuilder<DB, UpsertTables, D>;- return builder- .where('updatedAt', '<', sql.raw<Date>("now() - interval '1 millisecond'"))- .$if(!!ack, (qb) => qb.where('updateId', '>', ack!.updateId))- .orderBy('updateId', 'asc') as SelectQueryBuilder<DB, T, D>;+ protected auditTableFilters(ack?: SyncAck) {+ return <T extends keyof Pick<DB, AuditTables>, D>(qb: SelectQueryBuilder<DB, T, D>) => {+ const builder = qb as SelectQueryBuilder<DB, AuditTables, D>;+ return builder+ .where('deletedAt', '<', sql.raw<Date>("now() - interval '1 millisecond'"))+ .$if(!!ack, (qb) => qb.where('id', '>', ack!.updateId))+ .orderBy('id', 'asc') as SelectQueryBuilder<DB, T, D>;+ };+ }++ protected upsertTableFilters(ack?: SyncAck) {+ return <T extends keyof Pick<DB, UpsertTables>, D>(qb: SelectQueryBuilder<DB, T, D>) => {+ const builder = qb as SelectQueryBuilder<DB, UpsertTables, D>;+ return builder+ .where('updatedAt', '<', sql.raw<Date>("now() - interval '1 millisecond'"))+ .$if(!!ack, (qb) => qb.where('updateId', '>', ack!.updateId))+ .orderBy('updateId', 'asc') as SelectQueryBuilder<DB, T, D>;+ };}}@@ -113,7 +115,7 @@ class AlbumSync extends BaseSync {.selectFrom('albums_audit').select(['id', 'albumId']).where('userId', '=', userId)- .$call((qb) => this.auditTableFilters(qb, ack))+ .$call(this.auditTableFilters(ack)).stream();}@@ -246,7 +248,7 @@ class AlbumToAssetSync extends BaseSync {),),)- .$call((qb) => this.auditTableFilters(qb, ack))+ .$call(this.auditTableFilters(ack)).stream();}@@ -303,7 +305,7 @@ class AlbumUserSync extends BaseSync {),),)- .$call((qb) => this.auditTableFilters(qb, ack))+ .$call(this.auditTableFilters(ack)).stream();}@@ -345,7 +347,7 @@ class AssetSync extends BaseSync {.selectFrom('assets_audit').select(['id', 'assetId']).where('ownerId', '=', userId)- .$call((qb) => this.auditTableFilters(qb, ack))+ .$call(this.auditTableFilters(ack)).stream();}@@ -356,7 +358,7 @@ class AssetSync extends BaseSync {.select(columns.syncAsset).select('assets.updateId').where('ownerId', '=', userId)- .$call((qb) => this.upsertTableFilters(qb, ack))+ .$call(this.upsertTableFilters(ack)).stream();}}@@ -368,7 +370,7 @@ class PersonSync extends BaseSync {.selectFrom('person_audit').select(['id', 'personId']).where('ownerId', '=', userId)- .$call((qb) => this.auditTableFilters(qb, ack))+ .$call(this.auditTableFilters(ack)).stream();}@@ -391,7 +393,7 @@ class PersonSync extends BaseSync {'faceAssetId',]).where('ownerId', '=', userId)- .$call((qb) => this.upsertTableFilters(qb, ack))+ .$call(this.upsertTableFilters(ack)).stream();}}@@ -404,7 +406,7 @@ class AssetExifSync extends BaseSync {.select(columns.syncAssetExif).select('exif.updateId').where('assetId', 'in', (eb) => eb.selectFrom('assets').select('id').where('ownerId', '=', userId))- .$call((qb) => this.upsertTableFilters(qb, ack))+ .$call(this.upsertTableFilters(ack)).stream();}}@@ -416,7 +418,7 @@ class MemorySync extends BaseSync {.selectFrom('memories_audit').select(['id', 'memoryId']).where('userId', '=', userId)- .$call((qb) => this.auditTableFilters(qb, ack))+ .$call(this.auditTableFilters(ack)).stream();}@@ -440,7 +442,7 @@ class MemorySync extends BaseSync {]).select('updateId').where('ownerId', '=', userId)- .$call((qb) => this.upsertTableFilters(qb, ack))+ .$call(this.upsertTableFilters(ack)).stream();}}@@ -452,7 +454,7 @@ class MemoryToAssetSync extends BaseSync {.selectFrom('memory_assets_audit').select(['id', 'memoryId', 'assetId']).where('memoryId', 'in', (eb) => eb.selectFrom('memories').select('id').where('ownerId', '=', userId))- .$call((qb) => this.auditTableFilters(qb, ack))+ .$call(this.auditTableFilters(ack)).stream();}@@ -463,7 +465,7 @@ class MemoryToAssetSync extends BaseSync {.select(['memoriesId as memoryId', 'assetsId as assetId']).select('updateId').where('memoriesId', 'in', (eb) => eb.selectFrom('memories').select('id').where('ownerId', '=', userId))- .$call((qb) => this.upsertTableFilters(qb, ack))+ .$call(this.upsertTableFilters(ack)).stream();}}@@ -487,7 +489,7 @@ class PartnerSync extends BaseSync {.selectFrom('partners_audit').select(['id', 'sharedById', 'sharedWithId']).where((eb) => eb.or([eb('sharedById', '=', userId), eb('sharedWithId', '=', userId)]))- .$call((qb) => this.auditTableFilters(qb, ack))+ .$call(this.auditTableFilters(ack)).stream();}@@ -497,7 +499,7 @@ class PartnerSync extends BaseSync {.selectFrom('partners').select(['sharedById', 'sharedWithId', 'inTimeline', 'updateId']).where((eb) => eb.or([eb('sharedById', '=', userId), eb('sharedWithId', '=', userId)]))- .$call((qb) => this.upsertTableFilters(qb, ack))+ .$call(this.upsertTableFilters(ack)).stream();}}@@ -525,7 +527,7 @@ class PartnerAssetsSync extends BaseSync {.where('ownerId', 'in', (eb) =>eb.selectFrom('partners').select(['sharedById']).where('sharedWithId', '=', userId),)- .$call((qb) => this.auditTableFilters(qb, ack))+ .$call(this.auditTableFilters(ack)).stream();}@@ -538,7 +540,7 @@ class PartnerAssetsSync extends BaseSync {.where('ownerId', 'in', (eb) =>eb.selectFrom('partners').select(['sharedById']).where('sharedWithId', '=', userId),)- .$call((qb) => this.upsertTableFilters(qb, ack))+ .$call(this.upsertTableFilters(ack)).stream();}}@@ -573,7 +575,7 @@ class PartnerAssetExifsSync extends BaseSync {eb.selectFrom('partners').select(['sharedById']).where('sharedWithId', '=', userId),),)- .$call((qb) => this.upsertTableFilters(qb, ack))+ .$call(this.upsertTableFilters(ack)).stream();}}@@ -585,7 +587,7 @@ class StackSync extends BaseSync {.selectFrom('stacks_audit').select(['id', 'stackId']).where('userId', '=', userId)- .$call((qb) => this.auditTableFilters(qb, ack))+ .$call(this.auditTableFilters(ack)).stream();}@@ -596,7 +598,7 @@ class StackSync extends BaseSync {.select(columns.syncStack).select('updateId').where('ownerId', '=', userId)- .$call((qb) => this.upsertTableFilters(qb, ack))+ .$call(this.upsertTableFilters(ack)).stream();}}@@ -610,7 +612,7 @@ class PartnerStackSync extends BaseSync {.where('userId', 'in', (eb) =>eb.selectFrom('partners').select(['sharedById']).where('sharedWithId', '=', userId),)- .$call((qb) => this.auditTableFilters(qb, ack))+ .$call(this.auditTableFilters(ack)).stream();}@@ -637,18 +639,15 @@ class PartnerStackSync extends BaseSync {.where('ownerId', 'in', (eb) =>eb.selectFrom('partners').select(['sharedById']).where('sharedWithId', '=', userId),)- .$call((qb) => this.upsertTableFilters(qb, ack))+ .$call(this.upsertTableFilters(ack)).stream();}}+class UserSync extends BaseSync {@GenerateSql({ params: [], stream: true })getDeletes(ack?: SyncAck) {- return this.db- .selectFrom('users_audit')- .select(['id', 'userId'])- .$call((qb) => this.auditTableFilters(qb, ack))- .stream();+ return this.db.selectFrom('users_audit').select(['id', 'userId']).$call(this.auditTableFilters(ack)).stream();}@GenerateSql({ params: [], stream: true })@@ -656,7 +655,29 @@ class UserSync extends BaseSync {return this.db.selectFrom('users').select(['id', 'name', 'email', 'deletedAt', 'updateId'])- .$call((qb) => this.upsertTableFilters(qb, ack))+ .$call(this.upsertTableFilters(ack))+ .stream();+ }+}++class UserMetadataSync extends BaseSync {+ @GenerateSql({ params: [DummyValue.UUID], stream: true })+ getDeletes(userId: string, ack?: SyncAck) {+ return this.db+ .selectFrom('user_metadata_audit')+ .select(['id', 'userId', 'key'])+ .where('userId', '=', userId)+ .$call(this.auditTableFilters(ack))+ .stream();+ }++ @GenerateSql({ params: [DummyValue.UUID], stream: true })+ getUpserts(userId: string, ack?: SyncAck) {+ return this.db+ .selectFrom('user_metadata')+ .select(['userId', 'key', 'value', 'updateId'])+ .where('userId', '=', userId)+ .$call(this.upsertTableFilters(ack)).stream();}}diff --git a/server/src/schema/functions.ts b/server/src/schema/functions.tsindex 424ceb0d33..335201a6c4 100644--- a/server/src/schema/functions.ts+++ b/server/src/schema/functions.ts@@ -216,3 +216,16 @@ export const person_delete_audit = registerFunction({RETURN NULL;END`,});++export const user_metadata_audit = registerFunction({+ name: 'user_metadata_audit',+ returnType: 'TRIGGER',+ language: 'PLPGSQL',+ body: `+ BEGIN+ INSERT INTO user_metadata_audit ("userId", "key")+ SELECT "userId", "key"+ FROM OLD;+ RETURN NULL;+ END`,+});diff --git a/server/src/schema/index.ts b/server/src/schema/index.tsindex f564e8c7f0..384e47df79 100644--- a/server/src/schema/index.ts+++ b/server/src/schema/index.ts@@ -57,6 +57,7 @@ import { TagAssetTable } from 'src/schema/tables/tag-asset.table';import { TagClosureTable } from 'src/schema/tables/tag-closure.table';import { TagTable } from 'src/schema/tables/tag.table';import { UserAuditTable } from 'src/schema/tables/user-audit.table';+import { UserMetadataAuditTable } from 'src/schema/tables/user-metadata-audit.table';import { UserMetadataTable } from 'src/schema/tables/user-metadata.table';import { UserTable } from 'src/schema/tables/user.table';import { VersionHistoryTable } from 'src/schema/tables/version-history.table';@@ -108,6 +109,7 @@ export class ImmichDatabase {TagClosureTable,UserAuditTable,UserMetadataTable,+ UserMetadataAuditTable,UserTable,VersionHistoryTable,];@@ -128,6 +130,7 @@ export class ImmichDatabase {memory_assets_delete_audit,stacks_delete_audit,person_delete_audit,+ users_delete_audit,];enum = [assets_status_enum, asset_face_source_type, asset_visibility_enum];@@ -182,6 +185,7 @@ export interface DB {tags: TagTable;tags_closure: TagClosureTable;user_metadata: UserMetadataTable;+ user_metadata_audit: UserMetadataAuditTable;users: UserTable;users_audit: UserAuditTable;version_history: VersionHistoryTable;diff --git a/server/src/schema/migrations/1752250924342-UserMetadataSync.ts b/server/src/schema/migrations/1752250924342-UserMetadataSync.tsnew file mode 100644index 0000000000..20778d8010--- /dev/null+++ b/server/src/schema/migrations/1752250924342-UserMetadataSync.ts@@ -0,0 +1,56 @@+import { Kysely, sql } from 'kysely';++export async function up(db: Kysely<any>): Promise<void> {+ await sql`CREATE OR REPLACE FUNCTION user_metadata_audit()+ RETURNS TRIGGER+ LANGUAGE PLPGSQL+ AS $$+ BEGIN+ INSERT INTO user_metadata_audit ("userId", "key")+ SELECT "userId", "key"+ FROM OLD;+ RETURN NULL;+ END+ $$;`.execute(db);+ await sql`CREATE TABLE "user_metadata_audit" (+ "id" uuid NOT NULL DEFAULT immich_uuid_v7(),+ "userId" uuid NOT NULL,+ "key" character varying NOT NULL,+ "deletedAt" timestamp with time zone NOT NULL DEFAULT clock_timestamp(),+ CONSTRAINT "PK_15d5cc4d65ac966233b9921acac" PRIMARY KEY ("id")+);`.execute(db);+ await sql`CREATE INDEX "IDX_user_metadata_audit_user_id" ON "user_metadata_audit" ("userId");`.execute(db);+ await sql`CREATE INDEX "IDX_user_metadata_audit_key" ON "user_metadata_audit" ("key");`.execute(db);+ await sql`CREATE INDEX "IDX_user_metadata_audit_deleted_at" ON "user_metadata_audit" ("deletedAt");`.execute(db);+ await sql`ALTER TABLE "user_metadata" ADD "updateId" uuid NOT NULL DEFAULT immich_uuid_v7();`.execute(db);+ await sql`ALTER TABLE "user_metadata" ADD "updatedAt" timestamp with time zone NOT NULL DEFAULT now();`.execute(db);+ await sql`CREATE INDEX "IDX_user_metadata_update_id" ON "user_metadata" ("updateId");`.execute(db);+ await sql`CREATE INDEX "IDX_user_metadata_updated_at" ON "user_metadata" ("updatedAt");`.execute(db);+ await sql`CREATE OR REPLACE TRIGGER "user_metadata_audit"+ AFTER DELETE ON "user_metadata"+ REFERENCING OLD TABLE AS "old"+ FOR EACH STATEMENT+ WHEN (pg_trigger_depth() = 0)+ EXECUTE FUNCTION user_metadata_audit();`.execute(db);+ await sql`CREATE OR REPLACE TRIGGER "user_metadata_updated_at"+ BEFORE UPDATE ON "user_metadata"+ FOR EACH ROW+ EXECUTE FUNCTION updated_at();`.execute(db);+ await sql`INSERT INTO "migration_overrides" ("name", "value") VALUES ('function_user_metadata_audit', '{"type":"function","name":"user_metadata_audit","sql":"CREATE OR REPLACE FUNCTION user_metadata_audit()\\n RETURNS TRIGGER\\n LANGUAGE PLPGSQL\\n AS $$\\n BEGIN\\n INSERT INTO user_metadata_audit (\\"userId\\", \\"key\\")\\n SELECT \\"userId\\", \\"key\\"\\n FROM OLD;\\n RETURN NULL;\\n END\\n $$;"}'::jsonb);`.execute(db);+ await sql`INSERT INTO "migration_overrides" ("name", "value") VALUES ('trigger_user_metadata_audit', '{"type":"trigger","name":"user_metadata_audit","sql":"CREATE OR REPLACE TRIGGER \\"user_metadata_audit\\"\\n AFTER DELETE ON \\"user_metadata\\"\\n REFERENCING OLD TABLE AS \\"old\\"\\n FOR EACH STATEMENT\\n WHEN (pg_trigger_depth() = 0)\\n EXECUTE FUNCTION user_metadata_audit();"}'::jsonb);`.execute(db);+ await sql`INSERT INTO "migration_overrides" ("name", "value") VALUES ('trigger_user_metadata_updated_at', '{"type":"trigger","name":"user_metadata_updated_at","sql":"CREATE OR REPLACE TRIGGER \\"user_metadata_updated_at\\"\\n BEFORE UPDATE ON \\"user_metadata\\"\\n FOR EACH ROW\\n EXECUTE FUNCTION updated_at();"}'::jsonb);`.execute(db);+}++export async function down(db: Kysely<any>): Promise<void> {+ await sql`DROP TRIGGER "user_metadata_audit" ON "user_metadata";`.execute(db);+ await sql`DROP TRIGGER "user_metadata_updated_at" ON "user_metadata";`.execute(db);+ await sql`DROP INDEX "IDX_user_metadata_update_id";`.execute(db);+ await sql`DROP INDEX "IDX_user_metadata_updated_at";`.execute(db);+ await sql`ALTER TABLE "user_metadata" DROP COLUMN "updateId";`.execute(db);+ await sql`ALTER TABLE "user_metadata" DROP COLUMN "updatedAt";`.execute(db);+ await sql`DROP TABLE "user_metadata_audit";`.execute(db);+ await sql`DROP FUNCTION user_metadata_audit;`.execute(db);+ await sql`DELETE FROM "migration_overrides" WHERE "name" = 'function_user_metadata_audit';`.execute(db);+ await sql`DELETE FROM "migration_overrides" WHERE "name" = 'trigger_user_metadata_audit';`.execute(db);+ await sql`DELETE FROM "migration_overrides" WHERE "name" = 'trigger_user_metadata_updated_at';`.execute(db);+}diff --git a/server/src/schema/tables/user-metadata-audit.table.ts b/server/src/schema/tables/user-metadata-audit.table.tsnew file mode 100644index 0000000000..de7d21c874--- /dev/null+++ b/server/src/schema/tables/user-metadata-audit.table.ts@@ -0,0 +1,17 @@+import { PrimaryGeneratedUuidV7Column } from 'src/decorators';+import { Column, CreateDateColumn, Generated, Table, Timestamp } from 'src/sql-tools';++@Table('user_metadata_audit')+export class UserMetadataAuditTable {+ @PrimaryGeneratedUuidV7Column()+ id!: Generated<string>;++ @Column({ type: 'uuid', indexName: 'IDX_user_metadata_audit_user_id' })+ userId!: string;++ @Column({ indexName: 'IDX_user_metadata_audit_key' })+ key!: string;++ @CreateDateColumn({ default: () => 'clock_timestamp()', indexName: 'IDX_user_metadata_audit_deleted_at' })+ deletedAt!: Generated<Timestamp>;+}diff --git a/server/src/schema/tables/user-metadata.table.ts b/server/src/schema/tables/user-metadata.table.tsindex 04b457867f..a453ec6677 100644--- a/server/src/schema/tables/user-metadata.table.ts+++ b/server/src/schema/tables/user-metadata.table.ts@@ -1,9 +1,27 @@+import { UpdatedAtTrigger, UpdateIdColumn } from 'src/decorators';import { UserMetadataKey } from 'src/enum';+import { user_metadata_audit } from 'src/schema/functions';import { UserTable } from 'src/schema/tables/user.table';-import { Column, ForeignKeyColumn, PrimaryColumn, Table } from 'src/sql-tools';+import {+ AfterDeleteTrigger,+ Column,+ ForeignKeyColumn,+ Generated,+ PrimaryColumn,+ Table,+ Timestamp,+ UpdateDateColumn,+} from 'src/sql-tools';import { UserMetadata, UserMetadataItem } from 'src/types';+@UpdatedAtTrigger('user_metadata_updated_at')@Table('user_metadata')+@AfterDeleteTrigger({+ scope: 'statement',+ function: user_metadata_audit,+ referencingOldTableAs: 'old',+ when: 'pg_trigger_depth() = 0',+})export class UserMetadataTable<T extends keyof UserMetadata = UserMetadataKey> implements UserMetadataItem<T> {@ForeignKeyColumn(() => UserTable, {onUpdate: 'CASCADE',@@ -19,4 +37,10 @@ export class UserMetadataTable<T extends keyof UserMetadata = UserMetadataKey> i@Column({ type: 'jsonb' })value!: UserMetadata[T];++ @UpdateIdColumn({ indexName: 'IDX_user_metadata_update_id' })+ updateId!: Generated<string>;++ @UpdateDateColumn({ indexName: 'IDX_user_metadata_updated_at' })+ updatedAt!: Generated<Timestamp>;}diff --git a/server/src/services/sync.service.ts b/server/src/services/sync.service.tsindex 2cec72a3b5..9779498d70 100644--- a/server/src/services/sync.service.ts+++ b/server/src/services/sync.service.ts@@ -70,6 +70,7 @@ export const SYNC_TYPES_ORDER = [SyncRequestType.MemoriesV1,SyncRequestType.MemoryToAssetsV1,SyncRequestType.PeopleV1,+ SyncRequestType.UserMetadataV1,];const throwSessionRequired = () => {@@ -155,6 +156,7 @@ export class SyncService extends BaseService {[SyncRequestType.StacksV1]: () => this.syncStackV1(response, checkpointMap, auth),[SyncRequestType.PartnerStacksV1]: () => this.syncPartnerStackV1(response, checkpointMap, auth, session.id),[SyncRequestType.PeopleV1]: () => this.syncPeopleV1(response, checkpointMap, auth),+ [SyncRequestType.UserMetadataV1]: () => this.syncUserMetadataV1(response, checkpointMap, auth),};for (const type of SYNC_TYPES_ORDER.filter((type) => dto.types.includes(type))) {@@ -604,6 +606,22 @@ export class SyncService extends BaseService {}}+ private async syncUserMetadataV1(response: Writable, checkpointMap: CheckpointMap, auth: AuthDto) {+ const deleteType = SyncEntityType.UserMetadataDeleteV1;+ const deletes = this.syncRepository.userMetadata.getDeletes(auth.user.id, checkpointMap[deleteType]);++ for await (const { id, ...data } of deletes) {+ send(response, { type: deleteType, ids: [id], data });+ }++ const upsertType = SyncEntityType.UserMetadataV1;+ const upserts = this.syncRepository.userMetadata.getUpserts(auth.user.id, checkpointMap[upsertType]);++ for await (const { updateId, ...data } of upserts) {+ send(response, { type: upsertType, ids: [updateId], data });+ }+ }+private async upsertBackfillCheckpoint(item: { type: SyncEntityType; sessionId: string; createId: string }) {const { type, sessionId, createId } = item;await this.syncCheckpointRepository.upsertAll([diff --git a/server/test/medium/specs/sync/sync-user-metadata.spec.ts b/server/test/medium/specs/sync/sync-user-metadata.spec.tsnew file mode 100644index 0000000000..bb4a500a60--- /dev/null+++ b/server/test/medium/specs/sync/sync-user-metadata.spec.ts@@ -0,0 +1,123 @@+import { Kysely } from 'kysely';+import { SyncEntityType, SyncRequestType, UserMetadataKey } from 'src/enum';+import { UserRepository } from 'src/repositories/user.repository';+import { DB } from 'src/schema';+import { SyncTestContext } from 'test/medium.factory';+import { getKyselyDB } from 'test/utils';++let defaultDatabase: Kysely<DB>;++const setup = async (db?: Kysely<DB>) => {+ const ctx = new SyncTestContext(db || defaultDatabase);+ const { auth, user, session } = await ctx.newSyncAuthUser();+ return { auth, user, session, ctx };+};++beforeAll(async () => {+ defaultDatabase = await getKyselyDB();+});++describe(SyncEntityType.UserMetadataV1, () => {+ it('should detect and sync new user metadata', async () => {+ const { auth, user, ctx } = await setup();++ const userRepo = ctx.get(UserRepository);+ await userRepo.upsertMetadata(user.id, { key: UserMetadataKey.ONBOARDING, value: { isOnboarded: true } });++ const response = await ctx.syncStream(auth, [SyncRequestType.UserMetadataV1]);+ expect(response).toHaveLength(1);+ expect(response).toEqual([+ {+ ack: expect.any(String),+ data: {+ key: UserMetadataKey.ONBOARDING,+ userId: user.id,+ value: { isOnboarded: true },+ },+ type: 'UserMetadataV1',+ },+ ]);++ await ctx.syncAckAll(auth, response);+ await expect(ctx.syncStream(auth, [SyncRequestType.UserMetadataV1])).resolves.toEqual([]);+ });++ it('should update user metadata', async () => {+ const { auth, user, ctx } = await setup();++ const userRepo = ctx.get(UserRepository);+ await userRepo.upsertMetadata(user.id, { key: UserMetadataKey.ONBOARDING, value: { isOnboarded: true } });++ const response = await ctx.syncStream(auth, [SyncRequestType.UserMetadataV1]);+ expect(response).toHaveLength(1);+ expect(response).toEqual([+ {+ ack: expect.any(String),+ data: {+ key: UserMetadataKey.ONBOARDING,+ userId: user.id,+ value: { isOnboarded: true },+ },+ type: 'UserMetadataV1',+ },+ ]);++ await ctx.syncAckAll(auth, response);++ await userRepo.upsertMetadata(user.id, { key: UserMetadataKey.ONBOARDING, value: { isOnboarded: false } });++ const updatedResponse = await ctx.syncStream(auth, [SyncRequestType.UserMetadataV1]);+ expect(updatedResponse).toEqual([+ {+ ack: expect.any(String),+ data: {+ key: UserMetadataKey.ONBOARDING,+ userId: user.id,+ value: { isOnboarded: false },+ },+ type: 'UserMetadataV1',+ },+ ]);++ await ctx.syncAckAll(auth, updatedResponse);+ await expect(ctx.syncStream(auth, [SyncRequestType.UserMetadataV1])).resolves.toEqual([]);+ });+});++describe(SyncEntityType.UserMetadataDeleteV1, () => {+ it('should delete and sync user metadata', async () => {+ const { auth, user, ctx } = await setup();++ const userRepo = ctx.get(UserRepository);+ await userRepo.upsertMetadata(user.id, { key: UserMetadataKey.ONBOARDING, value: { isOnboarded: true } });++ const response = await ctx.syncStream(auth, [SyncRequestType.UserMetadataV1]);+ expect(response).toHaveLength(1);+ expect(response).toEqual([+ {+ ack: expect.any(String),+ data: {+ key: UserMetadataKey.ONBOARDING,+ userId: user.id,+ value: { isOnboarded: true },+ },+ type: 'UserMetadataV1',+ },+ ]);++ await ctx.syncAckAll(auth, response);++ await userRepo.deleteMetadata(auth.user.id, UserMetadataKey.ONBOARDING);++ await expect(ctx.syncStream(auth, [SyncRequestType.UserMetadataV1])).resolves.toEqual([+ {+ ack: expect.any(String),+ data: {+ userId: user.id,+ key: UserMetadataKey.ONBOARDING,+ },+ type: 'UserMetadataDeleteV1',+ },+ ]);+ });+});