Skip to content

High performance self-hosted photo and video management solution.

feat(server): SyncAssetEditV1 (#26446)

Brandon Wees3c9fb651d0a6
diff --git a/mobile/openapi/README.md b/mobile/openapi/README.md
index 02daa8543d..bb437787cb 100644
--- a/mobile/openapi/README.md
+++ b/mobile/openapi/README.md
@@ -576,6 +576,8 @@ Class | Method | HTTP request | Description
- [SyncAlbumUserV1](doc//SyncAlbumUserV1.md)
- [SyncAlbumV1](doc//SyncAlbumV1.md)
- [SyncAssetDeleteV1](doc//SyncAssetDeleteV1.md)
+ - [SyncAssetEditDeleteV1](doc//SyncAssetEditDeleteV1.md)
+ - [SyncAssetEditV1](doc//SyncAssetEditV1.md)
- [SyncAssetExifV1](doc//SyncAssetExifV1.md)
- [SyncAssetFaceDeleteV1](doc//SyncAssetFaceDeleteV1.md)
- [SyncAssetFaceV1](doc//SyncAssetFaceV1.md)
diff --git a/mobile/openapi/lib/api.dart b/mobile/openapi/lib/api.dart
index bfbe829d8d..253e8a6811 100644
--- a/mobile/openapi/lib/api.dart
+++ b/mobile/openapi/lib/api.dart
@@ -315,6 +315,8 @@ part 'model/sync_album_user_delete_v1.dart';
part 'model/sync_album_user_v1.dart';
part 'model/sync_album_v1.dart';
part 'model/sync_asset_delete_v1.dart';
+part 'model/sync_asset_edit_delete_v1.dart';
+part 'model/sync_asset_edit_v1.dart';
part 'model/sync_asset_exif_v1.dart';
part 'model/sync_asset_face_delete_v1.dart';
part 'model/sync_asset_face_v1.dart';
diff --git a/mobile/openapi/lib/api_client.dart b/mobile/openapi/lib/api_client.dart
index e703542b52..bfe469e7c0 100644
--- a/mobile/openapi/lib/api_client.dart
+++ b/mobile/openapi/lib/api_client.dart
@@ -676,6 +676,10 @@ class ApiClient {
return SyncAlbumV1.fromJson(value);
case 'SyncAssetDeleteV1':
return SyncAssetDeleteV1.fromJson(value);
+ case 'SyncAssetEditDeleteV1':
+ return SyncAssetEditDeleteV1.fromJson(value);
+ case 'SyncAssetEditV1':
+ return SyncAssetEditV1.fromJson(value);
case 'SyncAssetExifV1':
return SyncAssetExifV1.fromJson(value);
case 'SyncAssetFaceDeleteV1':
diff --git a/mobile/openapi/lib/model/sync_asset_edit_delete_v1.dart b/mobile/openapi/lib/model/sync_asset_edit_delete_v1.dart
new file mode 100644
index 0000000000..68af280290
--- /dev/null
+++ b/mobile/openapi/lib/model/sync_asset_edit_delete_v1.dart
@@ -0,0 +1,99 @@
+//
+// 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 SyncAssetEditDeleteV1 {
+ /// Returns a new [SyncAssetEditDeleteV1] instance.
+ SyncAssetEditDeleteV1({
+ required this.editId,
+ });
+
+ String editId;
+
+ @override
+ bool operator ==(Object other) => identical(this, other) || other is SyncAssetEditDeleteV1 &&
+ other.editId == editId;
+
+ @override
+ int get hashCode =>
+ // ignore: unnecessary_parenthesis
+ (editId.hashCode);
+
+ @override
+ String toString() => 'SyncAssetEditDeleteV1[editId=$editId]';
+
+ Map<String, dynamic> toJson() {
+ final json = <String, dynamic>{};
+ json[r'editId'] = this.editId;
+ return json;
+ }
+
+ /// Returns a new [SyncAssetEditDeleteV1] instance and imports its values from
+ /// [value] if it's a [Map], null otherwise.
+ // ignore: prefer_constructors_over_static_methods
+ static SyncAssetEditDeleteV1? fromJson(dynamic value) {
+ upgradeDto(value, "SyncAssetEditDeleteV1");
+ if (value is Map) {
+ final json = value.cast<String, dynamic>();
+
+ return SyncAssetEditDeleteV1(
+ editId: mapValueOfType<String>(json, r'editId')!,
+ );
+ }
+ return null;
+ }
+
+ static List<SyncAssetEditDeleteV1> listFromJson(dynamic json, {bool growable = false,}) {
+ final result = <SyncAssetEditDeleteV1>[];
+ if (json is List && json.isNotEmpty) {
+ for (final row in json) {
+ final value = SyncAssetEditDeleteV1.fromJson(row);
+ if (value != null) {
+ result.add(value);
+ }
+ }
+ }
+ return result.toList(growable: growable);
+ }
+
+ static Map<String, SyncAssetEditDeleteV1> mapFromJson(dynamic json) {
+ final map = <String, SyncAssetEditDeleteV1>{};
+ if (json is Map && json.isNotEmpty) {
+ json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+ for (final entry in json.entries) {
+ final value = SyncAssetEditDeleteV1.fromJson(entry.value);
+ if (value != null) {
+ map[entry.key] = value;
+ }
+ }
+ }
+ return map;
+ }
+
+ // maps a json object with a list of SyncAssetEditDeleteV1-objects as value to a dart map
+ static Map<String, List<SyncAssetEditDeleteV1>> mapListFromJson(dynamic json, {bool growable = false,}) {
+ final map = <String, List<SyncAssetEditDeleteV1>>{};
+ if (json is Map && json.isNotEmpty) {
+ // ignore: parameter_assignments
+ json = json.cast<String, dynamic>();
+ for (final entry in json.entries) {
+ map[entry.key] = SyncAssetEditDeleteV1.listFromJson(entry.value, growable: growable,);
+ }
+ }
+ return map;
+ }
+
+ /// The list of required keys that must be present in a JSON.
+ static const requiredKeys = <String>{
+ 'editId',
+ };
+}
+
diff --git a/mobile/openapi/lib/model/sync_asset_edit_v1.dart b/mobile/openapi/lib/model/sync_asset_edit_v1.dart
new file mode 100644
index 0000000000..3cc2673bfc
--- /dev/null
+++ b/mobile/openapi/lib/model/sync_asset_edit_v1.dart
@@ -0,0 +1,131 @@
+//
+// 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 SyncAssetEditV1 {
+ /// Returns a new [SyncAssetEditV1] instance.
+ SyncAssetEditV1({
+ required this.action,
+ required this.assetId,
+ required this.id,
+ required this.parameters,
+ required this.sequence,
+ });
+
+ AssetEditAction action;
+
+ String assetId;
+
+ String id;
+
+ Object parameters;
+
+ int sequence;
+
+ @override
+ bool operator ==(Object other) => identical(this, other) || other is SyncAssetEditV1 &&
+ other.action == action &&
+ other.assetId == assetId &&
+ other.id == id &&
+ other.parameters == parameters &&
+ other.sequence == sequence;
+
+ @override
+ int get hashCode =>
+ // ignore: unnecessary_parenthesis
+ (action.hashCode) +
+ (assetId.hashCode) +
+ (id.hashCode) +
+ (parameters.hashCode) +
+ (sequence.hashCode);
+
+ @override
+ String toString() => 'SyncAssetEditV1[action=$action, assetId=$assetId, id=$id, parameters=$parameters, sequence=$sequence]';
+
+ Map<String, dynamic> toJson() {
+ final json = <String, dynamic>{};
+ json[r'action'] = this.action;
+ json[r'assetId'] = this.assetId;
+ json[r'id'] = this.id;
+ json[r'parameters'] = this.parameters;
+ json[r'sequence'] = this.sequence;
+ return json;
+ }
+
+ /// Returns a new [SyncAssetEditV1] instance and imports its values from
+ /// [value] if it's a [Map], null otherwise.
+ // ignore: prefer_constructors_over_static_methods
+ static SyncAssetEditV1? fromJson(dynamic value) {
+ upgradeDto(value, "SyncAssetEditV1");
+ if (value is Map) {
+ final json = value.cast<String, dynamic>();
+
+ return SyncAssetEditV1(
+ action: AssetEditAction.fromJson(json[r'action'])!,
+ assetId: mapValueOfType<String>(json, r'assetId')!,
+ id: mapValueOfType<String>(json, r'id')!,
+ parameters: mapValueOfType<Object>(json, r'parameters')!,
+ sequence: mapValueOfType<int>(json, r'sequence')!,
+ );
+ }
+ return null;
+ }
+
+ static List<SyncAssetEditV1> listFromJson(dynamic json, {bool growable = false,}) {
+ final result = <SyncAssetEditV1>[];
+ if (json is List && json.isNotEmpty) {
+ for (final row in json) {
+ final value = SyncAssetEditV1.fromJson(row);
+ if (value != null) {
+ result.add(value);
+ }
+ }
+ }
+ return result.toList(growable: growable);
+ }
+
+ static Map<String, SyncAssetEditV1> mapFromJson(dynamic json) {
+ final map = <String, SyncAssetEditV1>{};
+ if (json is Map && json.isNotEmpty) {
+ json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+ for (final entry in json.entries) {
+ final value = SyncAssetEditV1.fromJson(entry.value);
+ if (value != null) {
+ map[entry.key] = value;
+ }
+ }
+ }
+ return map;
+ }
+
+ // maps a json object with a list of SyncAssetEditV1-objects as value to a dart map
+ static Map<String, List<SyncAssetEditV1>> mapListFromJson(dynamic json, {bool growable = false,}) {
+ final map = <String, List<SyncAssetEditV1>>{};
+ if (json is Map && json.isNotEmpty) {
+ // ignore: parameter_assignments
+ json = json.cast<String, dynamic>();
+ for (final entry in json.entries) {
+ map[entry.key] = SyncAssetEditV1.listFromJson(entry.value, growable: growable,);
+ }
+ }
+ return map;
+ }
+
+ /// The list of required keys that must be present in a JSON.
+ static const requiredKeys = <String>{
+ 'action',
+ 'assetId',
+ 'id',
+ 'parameters',
+ 'sequence',
+ };
+}
+
diff --git a/mobile/openapi/lib/model/sync_entity_type.dart b/mobile/openapi/lib/model/sync_entity_type.dart
index e7605a5dd1..e8db2dc4d3 100644
--- a/mobile/openapi/lib/model/sync_entity_type.dart
+++ b/mobile/openapi/lib/model/sync_entity_type.dart
@@ -29,6 +29,8 @@ class SyncEntityType {
static const assetV1 = SyncEntityType._(r'AssetV1');
static const assetDeleteV1 = SyncEntityType._(r'AssetDeleteV1');
static const assetExifV1 = SyncEntityType._(r'AssetExifV1');
+ static const assetEditV1 = SyncEntityType._(r'AssetEditV1');
+ static const assetEditDeleteV1 = SyncEntityType._(r'AssetEditDeleteV1');
static const assetMetadataV1 = SyncEntityType._(r'AssetMetadataV1');
static const assetMetadataDeleteV1 = SyncEntityType._(r'AssetMetadataDeleteV1');
static const partnerV1 = SyncEntityType._(r'PartnerV1');
@@ -80,6 +82,8 @@ class SyncEntityType {
assetV1,
assetDeleteV1,
assetExifV1,
+ assetEditV1,
+ assetEditDeleteV1,
assetMetadataV1,
assetMetadataDeleteV1,
partnerV1,
@@ -166,6 +170,8 @@ class SyncEntityTypeTypeTransformer {
case r'AssetV1': return SyncEntityType.assetV1;
case r'AssetDeleteV1': return SyncEntityType.assetDeleteV1;
case r'AssetExifV1': return SyncEntityType.assetExifV1;
+ case r'AssetEditV1': return SyncEntityType.assetEditV1;
+ case r'AssetEditDeleteV1': return SyncEntityType.assetEditDeleteV1;
case r'AssetMetadataV1': return SyncEntityType.assetMetadataV1;
case r'AssetMetadataDeleteV1': return SyncEntityType.assetMetadataDeleteV1;
case r'PartnerV1': return SyncEntityType.partnerV1;
diff --git a/mobile/openapi/lib/model/sync_request_type.dart b/mobile/openapi/lib/model/sync_request_type.dart
index 3614394d55..671081c0a5 100644
--- a/mobile/openapi/lib/model/sync_request_type.dart
+++ b/mobile/openapi/lib/model/sync_request_type.dart
@@ -30,6 +30,7 @@ class SyncRequestType {
static const albumAssetExifsV1 = SyncRequestType._(r'AlbumAssetExifsV1');
static const assetsV1 = SyncRequestType._(r'AssetsV1');
static const assetExifsV1 = SyncRequestType._(r'AssetExifsV1');
+ static const assetEditsV1 = SyncRequestType._(r'AssetEditsV1');
static const assetMetadataV1 = SyncRequestType._(r'AssetMetadataV1');
static const authUsersV1 = SyncRequestType._(r'AuthUsersV1');
static const memoriesV1 = SyncRequestType._(r'MemoriesV1');
@@ -54,6 +55,7 @@ class SyncRequestType {
albumAssetExifsV1,
assetsV1,
assetExifsV1,
+ assetEditsV1,
assetMetadataV1,
authUsersV1,
memoriesV1,
@@ -113,6 +115,7 @@ class SyncRequestTypeTypeTransformer {
case r'AlbumAssetExifsV1': return SyncRequestType.albumAssetExifsV1;
case r'AssetsV1': return SyncRequestType.assetsV1;
case r'AssetExifsV1': return SyncRequestType.assetExifsV1;
+ case r'AssetEditsV1': return SyncRequestType.assetEditsV1;
case r'AssetMetadataV1': return SyncRequestType.assetMetadataV1;
case r'AuthUsersV1': return SyncRequestType.authUsersV1;
case r'MemoriesV1': return SyncRequestType.memoriesV1;
diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.json
index f7702b0ce4..85ea126a6d 100644
--- a/open-api/immich-openapi-specs.json
+++ b/open-api/immich-openapi-specs.json
@@ -22614,6 +22614,48 @@
],
"type": "object"
},
+ "SyncAssetEditDeleteV1": {
+ "properties": {
+ "editId": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "editId"
+ ],
+ "type": "object"
+ },
+ "SyncAssetEditV1": {
+ "properties": {
+ "action": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AssetEditAction"
+ }
+ ]
+ },
+ "assetId": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "parameters": {
+ "type": "object"
+ },
+ "sequence": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "action",
+ "assetId",
+ "id",
+ "parameters",
+ "sequence"
+ ],
+ "type": "object"
+ },
"SyncAssetExifV1": {
"properties": {
"assetId": {
@@ -23163,6 +23205,8 @@
"AssetV1",
"AssetDeleteV1",
"AssetExifV1",
+ "AssetEditV1",
+ "AssetEditDeleteV1",
"AssetMetadataV1",
"AssetMetadataDeleteV1",
"PartnerV1",
@@ -23460,6 +23504,7 @@
"AlbumAssetExifsV1",
"AssetsV1",
"AssetExifsV1",
+ "AssetEditsV1",
"AssetMetadataV1",
"AuthUsersV1",
"MemoriesV1",
diff --git a/open-api/typescript-sdk/src/fetch-client.ts b/open-api/typescript-sdk/src/fetch-client.ts
index 7c1f940a91..9dae33541e 100644
--- a/open-api/typescript-sdk/src/fetch-client.ts
+++ b/open-api/typescript-sdk/src/fetch-client.ts
@@ -2967,6 +2967,16 @@ export type SyncAssetDeleteV1 = {
/** Asset ID */
assetId: string;
};
+export type SyncAssetEditDeleteV1 = {
+ editId: string;
+};
+export type SyncAssetEditV1 = {
+ action: AssetEditAction;
+ assetId: string;
+ id: string;
+ parameters: object;
+ sequence: number;
+};
export type SyncAssetExifV1 = {
/** Asset ID */
assetId: string;
@@ -7230,6 +7240,8 @@ export enum SyncEntityType {
AssetV1 = "AssetV1",
AssetDeleteV1 = "AssetDeleteV1",
AssetExifV1 = "AssetExifV1",
+ AssetEditV1 = "AssetEditV1",
+ AssetEditDeleteV1 = "AssetEditDeleteV1",
AssetMetadataV1 = "AssetMetadataV1",
AssetMetadataDeleteV1 = "AssetMetadataDeleteV1",
PartnerV1 = "PartnerV1",
@@ -7281,6 +7293,7 @@ export enum SyncRequestType {
AlbumAssetExifsV1 = "AlbumAssetExifsV1",
AssetsV1 = "AssetsV1",
AssetExifsV1 = "AssetExifsV1",
+ AssetEditsV1 = "AssetEditsV1",
AssetMetadataV1 = "AssetMetadataV1",
AuthUsersV1 = "AuthUsersV1",
MemoriesV1 = "MemoriesV1",
diff --git a/server/src/database.ts b/server/src/database.ts
index 5d29cbb043..ec614df9e0 100644
--- a/server/src/database.ts
+++ b/server/src/database.ts
@@ -437,6 +437,13 @@ export const columns = {
'asset_exif.rating',
'asset_exif.fps',
],
+ syncAssetEdit: [
+ 'asset_edit.id',
+ 'asset_edit.assetId',
+ 'asset_edit.sequence',
+ 'asset_edit.action',
+ 'asset_edit.parameters',
+ ],
exif: [
'asset_exif.assetId',
'asset_exif.autoStackId',
diff --git a/server/src/dtos/editing.dto.ts b/server/src/dtos/editing.dto.ts
index fcdfdcad5f..8217fec41c 100644
--- a/server/src/dtos/editing.dto.ts
+++ b/server/src/dtos/editing.dto.ts
@@ -1,7 +1,6 @@
-import { ApiProperty, getSchemaPath } from '@nestjs/swagger';
+import { ApiExtraModels, ApiProperty, getSchemaPath } from '@nestjs/swagger';
import { Type } from 'class-transformer';
import { ArrayMinSize, IsEnum, IsInt, Min, ValidateNested } from 'class-validator';
-import { ExtraModel } from 'src/dtos/sync.dto';
import { IsAxisAlignedRotation, IsUniqueEditActions, ValidateEnum, ValidateUUID } from 'src/validation';
export enum AssetEditAction {
@@ -15,7 +14,6 @@ export enum MirrorAxis {
Vertical = 'vertical',
}
-@ExtraModel()
export class CropParameters {
@IsInt()
@Min(0)
@@ -38,14 +36,12 @@ export class CropParameters {
height!: number;
}
-@ExtraModel()
export class RotateParameters {
@IsAxisAlignedRotation()
@ApiProperty({ description: 'Rotation angle in degrees' })
angle!: number;
}
-@ExtraModel()
export class MirrorParameters {
@IsEnum(MirrorAxis)
@ApiProperty({ enum: MirrorAxis, enumName: 'MirrorAxis', description: 'Axis to mirror along' })
@@ -67,6 +63,7 @@ export type AssetEditActionItem =
parameters: MirrorParameters;
};
+@ApiExtraModels(CropParameters, RotateParameters, MirrorParameters)
export class AssetEditActionItemDto {
@ValidateEnum({ name: 'AssetEditAction', enum: AssetEditAction, description: 'Type of edit action to perform' })
action!: AssetEditAction;
diff --git a/server/src/dtos/sync.dto.ts b/server/src/dtos/sync.dto.ts
index c1b85c0430..9a1332d303 100644
--- a/server/src/dtos/sync.dto.ts
+++ b/server/src/dtos/sync.dto.ts
@@ -2,6 +2,7 @@
import { ApiProperty } from '@nestjs/swagger';
import { ArrayMaxSize, IsInt, IsPositive, IsString } from 'class-validator';
import { AssetResponseDto } from 'src/dtos/asset-response.dto';
+import { AssetEditAction } from 'src/dtos/editing.dto';
import {
AlbumUserRole,
AssetOrder,
@@ -218,6 +219,24 @@ export class SyncAssetExifV1 {
fps!: number | null;
}
+@ExtraModel()
+export class SyncAssetEditV1 {
+ id!: string;
+ assetId!: string;
+
+ @ValidateEnum({ enum: AssetEditAction, name: 'AssetEditAction' })
+ action!: AssetEditAction;
+ parameters!: object;
+
+ @ApiProperty({ type: 'integer' })
+ sequence!: number;
+}
+
+@ExtraModel()
+export class SyncAssetEditDeleteV1 {
+ editId!: string;
+}
+
@ExtraModel()
export class SyncAssetMetadataV1 {
@ApiProperty({ description: 'Asset ID' })
@@ -480,6 +499,8 @@ export type SyncItem = {
[SyncEntityType.AssetMetadataV1]: SyncAssetMetadataV1;
[SyncEntityType.AssetMetadataDeleteV1]: SyncAssetMetadataDeleteV1;
[SyncEntityType.AssetExifV1]: SyncAssetExifV1;
+ [SyncEntityType.AssetEditV1]: SyncAssetEditV1;
+ [SyncEntityType.AssetEditDeleteV1]: SyncAssetEditDeleteV1;
[SyncEntityType.PartnerAssetV1]: SyncAssetV1;
[SyncEntityType.PartnerAssetBackfillV1]: SyncAssetV1;
[SyncEntityType.PartnerAssetDeleteV1]: SyncAssetDeleteV1;
diff --git a/server/src/enum.ts b/server/src/enum.ts
index 802b3c96e0..2aa9bd2aa6 100644
--- a/server/src/enum.ts
+++ b/server/src/enum.ts
@@ -720,6 +720,7 @@ export enum SyncRequestType {
AlbumAssetExifsV1 = 'AlbumAssetExifsV1',
AssetsV1 = 'AssetsV1',
AssetExifsV1 = 'AssetExifsV1',
+ AssetEditsV1 = 'AssetEditsV1',
AssetMetadataV1 = 'AssetMetadataV1',
AuthUsersV1 = 'AuthUsersV1',
MemoriesV1 = 'MemoriesV1',
@@ -745,6 +746,8 @@ export enum SyncEntityType {
AssetV1 = 'AssetV1',
AssetDeleteV1 = 'AssetDeleteV1',
AssetExifV1 = 'AssetExifV1',
+ AssetEditV1 = 'AssetEditV1',
+ AssetEditDeleteV1 = 'AssetEditDeleteV1',
AssetMetadataV1 = 'AssetMetadataV1',
AssetMetadataDeleteV1 = 'AssetMetadataDeleteV1',
diff --git a/server/src/queries/asset.edit.repository.sql b/server/src/queries/asset.edit.repository.sql
index 9330305973..44dca38031 100644
--- a/server/src/queries/asset.edit.repository.sql
+++ b/server/src/queries/asset.edit.repository.sql
@@ -18,3 +18,17 @@ where
"assetId" = $1
order by
"sequence" asc
+
+-- AssetEditRepository.getWithSyncInfo
+select
+ "asset_edit"."id",
+ "asset_edit"."assetId",
+ "asset_edit"."sequence",
+ "asset_edit"."action",
+ "asset_edit"."parameters"
+from
+ "asset_edit"
+where
+ "assetId" = $1
+order by
+ "sequence" asc
diff --git a/server/src/queries/sync.repository.sql b/server/src/queries/sync.repository.sql
index 68a85e4c0f..43c6a380bf 100644
--- a/server/src/queries/sync.repository.sql
+++ b/server/src/queries/sync.repository.sql
@@ -514,6 +514,38 @@ where
order by
"asset_exif"."updateId" asc
+-- SyncRepository.assetEdit.getDeletes
+select
+ "asset_edit_audit"."id",
+ "editId"
+from
+ "asset_edit_audit" as "asset_edit_audit"
+ inner join "asset" on "asset"."id" = "asset_edit_audit"."assetId"
+where
+ "asset_edit_audit"."id" < $1
+ and "asset_edit_audit"."id" > $2
+ and "asset"."ownerId" = $3
+order by
+ "asset_edit_audit"."id" asc
+
+-- SyncRepository.assetEdit.getUpserts
+select
+ "asset_edit"."id",
+ "asset_edit"."assetId",
+ "asset_edit"."sequence",
+ "asset_edit"."action",
+ "asset_edit"."parameters",
+ "asset_edit"."updateId"
+from
+ "asset_edit" as "asset_edit"
+ inner join "asset" on "asset"."id" = "asset_edit"."assetId"
+where
+ "asset_edit"."updateId" < $1
+ and "asset_edit"."updateId" > $2
+ and "asset"."ownerId" = $3
+order by
+ "asset_edit"."updateId" asc
+
-- SyncRepository.assetFace.getDeletes
select
"asset_face_audit"."id",
diff --git a/server/src/repositories/asset-edit.repository.ts b/server/src/repositories/asset-edit.repository.ts
index 23c7c3a0b9..164ebec6b6 100644
--- a/server/src/repositories/asset-edit.repository.ts
+++ b/server/src/repositories/asset-edit.repository.ts
@@ -1,6 +1,7 @@
import { Injectable } from '@nestjs/common';
import { Kysely } from 'kysely';
import { InjectKysely } from 'nestjs-kysely';
+import { columns } from 'src/database';
import { DummyValue, GenerateSql } from 'src/decorators';
import { AssetEditActionItem, AssetEditActionItemResponseDto } from 'src/dtos/editing.dto';
import { DB } from 'src/schema';
@@ -9,9 +10,7 @@ import { DB } from 'src/schema';
export class AssetEditRepository {
constructor(@InjectKysely() private db: Kysely<DB>) {}
- @GenerateSql({
- params: [DummyValue.UUID],
- })
+ @GenerateSql({ params: [DummyValue.UUID] })
replaceAll(assetId: string, edits: AssetEditActionItem[]): Promise<AssetEditActionItemResponseDto[]> {
return this.db.transaction().execute(async (trx) => {
await trx.deleteFrom('asset_edit').where('assetId', '=', assetId).execute();
@@ -28,9 +27,7 @@ export class AssetEditRepository {
});
}
- @GenerateSql({
- params: [DummyValue.UUID],
- })
+ @GenerateSql({ params: [DummyValue.UUID] })
getAll(assetId: string): Promise<AssetEditActionItemResponseDto[]> {
return this.db
.selectFrom('asset_edit')
@@ -39,4 +36,14 @@ export class AssetEditRepository {
.orderBy('sequence', 'asc')
.execute();
}
+
+ @GenerateSql({ params: [DummyValue.UUID] })
+ getWithSyncInfo(assetId: string) {
+ return this.db
+ .selectFrom('asset_edit')
+ .select(columns.syncAssetEdit)
+ .where('assetId', '=', assetId)
+ .orderBy('sequence', 'asc')
+ .execute();
+ }
}
diff --git a/server/src/repositories/sync.repository.ts b/server/src/repositories/sync.repository.ts
index f851038dc6..b2fa144ca4 100644
--- a/server/src/repositories/sync.repository.ts
+++ b/server/src/repositories/sync.repository.ts
@@ -53,6 +53,7 @@ export class SyncRepository {
albumUser: AlbumUserSync;
asset: AssetSync;
assetExif: AssetExifSync;
+ assetEdit: AssetEditSync;
assetFace: AssetFaceSync;
assetMetadata: AssetMetadataSync;
authUser: AuthUserSync;
@@ -75,6 +76,7 @@ export class SyncRepository {
this.albumUser = new AlbumUserSync(this.db);
this.asset = new AssetSync(this.db);
this.assetExif = new AssetExifSync(this.db);
+ this.assetEdit = new AssetEditSync(this.db);
this.assetFace = new AssetFaceSync(this.db);
this.assetMetadata = new AssetMetadataSync(this.db);
this.authUser = new AuthUserSync(this.db);
@@ -91,7 +93,7 @@ export class SyncRepository {
}
}
-class BaseSync {
+export class BaseSync {
constructor(protected db: Kysely<DB>) {}
protected backfillQuery<T extends keyof DB>(t: T, { nowId, beforeUpdateId, afterUpdateId }: SyncBackfillOptions) {
@@ -501,6 +503,30 @@ class AssetExifSync extends BaseSync {
}
}
+class AssetEditSync extends BaseSync {
+ @GenerateSql({ params: [dummyQueryOptions], stream: true })
+ getDeletes(options: SyncQueryOptions) {
+ return this.auditQuery('asset_edit_audit', options)
+ .select(['asset_edit_audit.id', 'editId'])
+ .innerJoin('asset', 'asset.id', 'asset_edit_audit.assetId')
+ .where('asset.ownerId', '=', options.userId)
+ .stream();
+ }
+
+ cleanupAuditTable(daysAgo: number) {
+ return this.auditCleanup('asset_edit_audit', daysAgo);
+ }
+
+ @GenerateSql({ params: [dummyQueryOptions], stream: true })
+ getUpserts(options: SyncQueryOptions) {
+ return this.upsertQuery('asset_edit', options)
+ .select([...columns.syncAssetEdit, 'asset_edit.updateId'])
+ .innerJoin('asset', 'asset.id', 'asset_edit.assetId')
+ .where('asset.ownerId', '=', options.userId)
+ .stream();
+ }
+}
+
class MemorySync extends BaseSync {
@GenerateSql({ params: [dummyQueryOptions], stream: true })
getDeletes(options: SyncQueryOptions) {
diff --git a/server/src/repositories/websocket.repository.ts b/server/src/repositories/websocket.repository.ts
index bfed556895..235d2f2a84 100644
--- a/server/src/repositories/websocket.repository.ts
+++ b/server/src/repositories/websocket.repository.ts
@@ -11,7 +11,7 @@ import { AssetResponseDto } from 'src/dtos/asset-response.dto';
import { AuthDto } from 'src/dtos/auth.dto';
import { NotificationDto } from 'src/dtos/notification.dto';
import { ReleaseNotification, ServerVersionResponseDto } from 'src/dtos/server.dto';
-import { SyncAssetExifV1, SyncAssetV1 } from 'src/dtos/sync.dto';
+import { SyncAssetEditV1, SyncAssetExifV1, SyncAssetV1 } from 'src/dtos/sync.dto';
import { AppRestartEvent, ArgsOf, EventRepository } from 'src/repositories/event.repository';
import { LoggingRepository } from 'src/repositories/logging.repository';
import { handlePromiseError } from 'src/utils/misc';
@@ -37,7 +37,7 @@ export interface ClientEventMap {
AssetUploadReadyV1: [{ asset: SyncAssetV1; exif: SyncAssetExifV1 }];
AppRestartV1: [AppRestartEvent];
- AssetEditReadyV1: [{ asset: SyncAssetV1 }];
+ AssetEditReadyV1: [{ asset: SyncAssetV1; edit: SyncAssetEditV1[] }];
}
export type AuthFn = (client: Socket) => Promise<AuthDto>;
diff --git a/server/src/schema/functions.ts b/server/src/schema/functions.ts
index 6acfc45750..d143e582ca 100644
--- a/server/src/schema/functions.ts
+++ b/server/src/schema/functions.ts
@@ -286,3 +286,16 @@ export const asset_edit_delete = registerFunction({
END
`,
});
+
+export const asset_edit_audit = registerFunction({
+ name: 'asset_edit_audit',
+ returnType: 'TRIGGER',
+ language: 'PLPGSQL',
+ body: `
+ BEGIN
+ INSERT INTO asset_edit_audit ("editId", "assetId")
+ SELECT "id", "assetId"
+ FROM OLD;
+ RETURN NULL;
+ END`,
+});
diff --git a/server/src/schema/index.ts b/server/src/schema/index.ts
index 790973785f..2426c2aab7 100644
--- a/server/src/schema/index.ts
+++ b/server/src/schema/index.ts
@@ -29,6 +29,7 @@ import { AlbumUserTable } from 'src/schema/tables/album-user.table';
import { AlbumTable } from 'src/schema/tables/album.table';
import { ApiKeyTable } from 'src/schema/tables/api-key.table';
import { AssetAuditTable } from 'src/schema/tables/asset-audit.table';
+import { AssetEditAuditTable } from 'src/schema/tables/asset-edit-audit.table';
import { AssetEditTable } from 'src/schema/tables/asset-edit.table';
import { AssetExifTable } from 'src/schema/tables/asset-exif.table';
import { AssetFaceAuditTable } from 'src/schema/tables/asset-face-audit.table';
@@ -88,6 +89,7 @@ export class ImmichDatabase {
ApiKeyTable,
AssetAuditTable,
AssetEditTable,
+ AssetEditAuditTable,
AssetFaceTable,
AssetFaceAuditTable,
AssetMetadataTable,
@@ -184,6 +186,7 @@ export interface DB {
asset: AssetTable;
asset_audit: AssetAuditTable;
asset_edit: AssetEditTable;
+ asset_edit_audit: AssetEditAuditTable;
asset_exif: AssetExifTable;
asset_face: AssetFaceTable;
asset_face_audit: AssetFaceAuditTable;
diff --git a/server/src/schema/migrations/1771873813973-AssetEditSync.ts b/server/src/schema/migrations/1771873813973-AssetEditSync.ts
new file mode 100644
index 0000000000..4f5be1ddcd
--- /dev/null
+++ b/server/src/schema/migrations/1771873813973-AssetEditSync.ts
@@ -0,0 +1,53 @@
+import { Kysely, sql } from 'kysely';
+
+export async function up(db: Kysely<any>): Promise<void> {
+ await sql`CREATE OR REPLACE FUNCTION asset_edit_audit()
+ RETURNS TRIGGER
+ LANGUAGE PLPGSQL
+ AS $$
+ BEGIN
+ INSERT INTO asset_edit_audit ("editId", "assetId")
+ SELECT "id", "assetId"
+ FROM OLD;
+ RETURN NULL;
+ END
+ $$;`.execute(db);
+ await sql`CREATE TABLE "asset_edit_audit" (
+ "id" uuid NOT NULL DEFAULT immich_uuid_v7(),
+ "editId" uuid NOT NULL,
+ "assetId" uuid NOT NULL,
+ "deletedAt" timestamp with time zone NOT NULL DEFAULT clock_timestamp(),
+ CONSTRAINT "asset_edit_audit_pkey" PRIMARY KEY ("id")
+);`.execute(db);
+ await sql`CREATE INDEX "asset_edit_audit_assetId_idx" ON "asset_edit_audit" ("assetId");`.execute(db);
+ await sql`CREATE INDEX "asset_edit_audit_deletedAt_idx" ON "asset_edit_audit" ("deletedAt");`.execute(db);
+ await sql`ALTER TABLE "asset_edit" ADD "updatedAt" timestamp with time zone NOT NULL DEFAULT now();`.execute(db);
+ await sql`ALTER TABLE "asset_edit" ADD "updateId" uuid NOT NULL DEFAULT immich_uuid_v7();`.execute(db);
+ await sql`CREATE INDEX "asset_edit_updateId_idx" ON "asset_edit" ("updateId");`.execute(db);
+ await sql`CREATE OR REPLACE TRIGGER "asset_edit_audit"
+ AFTER DELETE ON "asset_edit"
+ REFERENCING OLD TABLE AS "old"
+ FOR EACH STATEMENT
+ WHEN (pg_trigger_depth() = 0)
+ EXECUTE FUNCTION asset_edit_audit();`.execute(db);
+ await sql`CREATE OR REPLACE TRIGGER "asset_edit_updatedAt"
+ BEFORE UPDATE ON "asset_edit"
+ FOR EACH ROW
+ EXECUTE FUNCTION updated_at();`.execute(db);
+ await sql`INSERT INTO "migration_overrides" ("name", "value") VALUES ('function_asset_edit_audit', '{"type":"function","name":"asset_edit_audit","sql":"CREATE OR REPLACE FUNCTION asset_edit_audit()\\n RETURNS TRIGGER\\n LANGUAGE PLPGSQL\\n AS $$\\n BEGIN\\n INSERT INTO asset_edit_audit (\\"editId\\", \\"assetId\\")\\n SELECT \\"id\\", \\"assetId\\"\\n FROM OLD;\\n RETURN NULL;\\n END\\n $$;"}'::jsonb);`.execute(db);
+ await sql`INSERT INTO "migration_overrides" ("name", "value") VALUES ('trigger_asset_edit_audit', '{"type":"trigger","name":"asset_edit_audit","sql":"CREATE OR REPLACE TRIGGER \\"asset_edit_audit\\"\\n AFTER DELETE ON \\"asset_edit\\"\\n REFERENCING OLD TABLE AS \\"old\\"\\n FOR EACH STATEMENT\\n WHEN (pg_trigger_depth() = 0)\\n EXECUTE FUNCTION asset_edit_audit();"}'::jsonb);`.execute(db);
+ await sql`INSERT INTO "migration_overrides" ("name", "value") VALUES ('trigger_asset_edit_updatedAt', '{"type":"trigger","name":"asset_edit_updatedAt","sql":"CREATE OR REPLACE TRIGGER \\"asset_edit_updatedAt\\"\\n BEFORE UPDATE ON \\"asset_edit\\"\\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 "asset_edit_audit" ON "asset_edit";`.execute(db);
+ await sql`DROP TRIGGER "asset_edit_updatedAt" ON "asset_edit";`.execute(db);
+ await sql`DROP INDEX "asset_edit_updateId_idx";`.execute(db);
+ await sql`ALTER TABLE "asset_edit" DROP COLUMN "updatedAt";`.execute(db);
+ await sql`ALTER TABLE "asset_edit" DROP COLUMN "updateId";`.execute(db);
+ await sql`DROP TABLE "asset_edit_audit";`.execute(db);
+ await sql`DROP FUNCTION asset_edit_audit;`.execute(db);
+ await sql`DELETE FROM "migration_overrides" WHERE "name" = 'function_asset_edit_audit';`.execute(db);
+ await sql`DELETE FROM "migration_overrides" WHERE "name" = 'trigger_asset_edit_audit';`.execute(db);
+ await sql`DELETE FROM "migration_overrides" WHERE "name" = 'trigger_asset_edit_updatedAt';`.execute(db);
+}
diff --git a/server/src/schema/tables/asset-edit-audit.table.ts b/server/src/schema/tables/asset-edit-audit.table.ts
new file mode 100644
index 0000000000..9c8b29f374
--- /dev/null
+++ b/server/src/schema/tables/asset-edit-audit.table.ts
@@ -0,0 +1,17 @@
+import { Column, CreateDateColumn, Generated, Table, Timestamp } from '@immich/sql-tools';
+import { PrimaryGeneratedUuidV7Column } from 'src/decorators';
+
+@Table('asset_edit_audit')
+export class AssetEditAuditTable {
+ @PrimaryGeneratedUuidV7Column()
+ id!: Generated<string>;
+
+ @Column({ type: 'uuid' })
+ editId!: string;
+
+ @Column({ type: 'uuid', index: true })
+ assetId!: string;
+
+ @CreateDateColumn({ default: () => 'clock_timestamp()', index: true })
+ deletedAt!: Generated<Timestamp>;
+}
diff --git a/server/src/schema/tables/asset-edit.table.ts b/server/src/schema/tables/asset-edit.table.ts
index 1ec6bf081c..2e9d2be20d 100644
--- a/server/src/schema/tables/asset-edit.table.ts
+++ b/server/src/schema/tables/asset-edit.table.ts
@@ -6,13 +6,17 @@ import {
Generated,
PrimaryGeneratedColumn,
Table,
+ Timestamp,
Unique,
+ UpdateDateColumn,
} from '@immich/sql-tools';
+import { UpdatedAtTrigger, UpdateIdColumn } from 'src/decorators';
import { AssetEditAction, AssetEditParameters } from 'src/dtos/editing.dto';
-import { asset_edit_delete, asset_edit_insert } from 'src/schema/functions';
+import { asset_edit_audit, asset_edit_delete, asset_edit_insert } from 'src/schema/functions';
import { AssetTable } from 'src/schema/tables/asset.table';
@Table('asset_edit')
+@UpdatedAtTrigger('asset_edit_updatedAt')
@AfterInsertTrigger({ scope: 'statement', function: asset_edit_insert, referencingNewTableAs: 'inserted_edit' })
@AfterDeleteTrigger({
scope: 'statement',
@@ -20,6 +24,12 @@ import { AssetTable } from 'src/schema/tables/asset.table';
referencingOldTableAs: 'deleted_edit',
when: 'pg_trigger_depth() = 0',
})
+@AfterDeleteTrigger({
+ scope: 'statement',
+ function: asset_edit_audit,
+ referencingOldTableAs: 'old',
+ when: 'pg_trigger_depth() = 0',
+})
@Unique({ columns: ['assetId', 'sequence'] })
export class AssetEditTable {
@PrimaryGeneratedColumn()
@@ -36,4 +46,10 @@ export class AssetEditTable {
@Column({ type: 'integer' })
sequence!: number;
+
+ @UpdateDateColumn()
+ updatedAt!: Generated<Timestamp>;
+
+ @UpdateIdColumn({ index: true })
+ updateId!: Generated<string>;
}
diff --git a/server/src/services/asset.service.ts b/server/src/services/asset.service.ts
index 32225545bb..f41004dd1c 100644
--- a/server/src/services/asset.service.ts
+++ b/server/src/services/asset.service.ts
@@ -546,6 +546,7 @@ export class AssetService extends BaseService {
async getAssetEdits(auth: AuthDto, id: string): Promise<AssetEditsResponseDto> {
await this.requireAccess({ auth, permission: Permission.AssetRead, ids: [id] });
const edits = await this.assetEditRepository.getAll(id);
+
return {
assetId: id,
edits,
diff --git a/server/src/services/job.service.ts b/server/src/services/job.service.ts
index 2a47745a6c..7c9581ff9a 100644
--- a/server/src/services/job.service.ts
+++ b/server/src/services/job.service.ts
@@ -98,6 +98,7 @@ export class JobService extends BaseService {
case JobName.AssetEditThumbnailGeneration: {
const asset = await this.assetRepository.getById(item.data.id);
+ const edits = await this.assetEditRepository.getWithSyncInfo(item.data.id);
if (asset) {
this.websocketRepository.clientSend('AssetEditReadyV1', asset.ownerId, {
@@ -122,6 +123,7 @@ export class JobService extends BaseService {
height: asset.height,
isEdited: asset.isEdited,
},
+ edit: edits,
});
}
diff --git a/server/src/services/sync.service.ts b/server/src/services/sync.service.ts
index 76fd129f50..9bdeca14d7 100644
--- a/server/src/services/sync.service.ts
+++ b/server/src/services/sync.service.ts
@@ -89,6 +89,7 @@ export const SYNC_TYPES_ORDER = [
SyncRequestType.AssetFacesV2,
SyncRequestType.UserMetadataV1,
SyncRequestType.AssetMetadataV1,
+ SyncRequestType.AssetEditsV1,
];
const throwSessionRequired = () => {
@@ -175,6 +176,7 @@ export class SyncService extends BaseService {
[SyncRequestType.PartnersV1]: () => this.syncPartnersV1(options, response, checkpointMap),
[SyncRequestType.AssetsV1]: () => this.syncAssetsV1(options, response, checkpointMap),
[SyncRequestType.AssetExifsV1]: () => this.syncAssetExifsV1(options, response, checkpointMap),
+ [SyncRequestType.AssetEditsV1]: () => this.syncAssetEditsV1(options, response, checkpointMap),
[SyncRequestType.PartnerAssetsV1]: () => this.syncPartnerAssetsV1(options, response, checkpointMap, session.id),
[SyncRequestType.AssetMetadataV1]: () => this.syncAssetMetadataV1(options, response, checkpointMap, auth),
[SyncRequestType.PartnerAssetExifsV1]: () =>
@@ -215,6 +217,7 @@ export class SyncService extends BaseService {
await this.syncRepository.asset.cleanupAuditTable(pruneThreshold);
await this.syncRepository.assetFace.cleanupAuditTable(pruneThreshold);
await this.syncRepository.assetMetadata.cleanupAuditTable(pruneThreshold);
+ await this.syncRepository.assetEdit.cleanupAuditTable(pruneThreshold);
await this.syncRepository.memory.cleanupAuditTable(pruneThreshold);
await this.syncRepository.memoryToAsset.cleanupAuditTable(pruneThreshold);
await this.syncRepository.partner.cleanupAuditTable(pruneThreshold);
@@ -352,6 +355,21 @@ export class SyncService extends BaseService {
}
}
+ private async syncAssetEditsV1(options: SyncQueryOptions, response: Writable, checkpointMap: CheckpointMap) {
+ const deleteType = SyncEntityType.AssetEditDeleteV1;
+ const deletes = this.syncRepository.assetEdit.getDeletes({ ...options, ack: checkpointMap[deleteType] });
+
+ for await (const { id, ...data } of deletes) {
+ send(response, { type: deleteType, ids: [id], data });
+ }
+ const upsertType = SyncEntityType.AssetEditV1;
+ const upserts = this.syncRepository.assetEdit.getUpserts({ ...options, ack: checkpointMap[upsertType] });
+
+ for await (const { updateId, ...data } of upserts) {
+ send(response, { type: upsertType, ids: [updateId], data });
+ }
+ }
+
private async syncPartnerAssetExifsV1(
options: SyncQueryOptions,
response: Writable,
diff --git a/server/test/factories/asset-edit.factory.ts b/server/test/factories/asset-edit.factory.ts
index ba15da4b69..897ed26d61 100644
--- a/server/test/factories/asset-edit.factory.ts
+++ b/server/test/factories/asset-edit.factory.ts
@@ -4,7 +4,7 @@ import { AssetEditTable } from 'src/schema/tables/asset-edit.table';
import { AssetFactory } from 'test/factories/asset.factory';
import { build } from 'test/factories/builder.factory';
import { AssetEditLike, AssetLike, FactoryBuilder } from 'test/factories/types';
-import { newUuid } from 'test/small.factory';
+import { newDate, newUuid } from 'test/small.factory';
export class AssetEditFactory {
private constructor(private readonly value: Selectable<AssetEditTable>) {}
@@ -15,6 +15,7 @@ export class AssetEditFactory {
static from(dto: AssetEditLike = {}) {
const id = dto.id ?? newUuid();
+ const updateId = dto.updateId ?? newUuid();
return new AssetEditFactory({
id,
@@ -22,6 +23,8 @@ export class AssetEditFactory {
action: AssetEditAction.Crop,
parameters: { x: 5, y: 6, width: 200, height: 100 },
sequence: 1,
+ updateId,
+ updatedAt: newDate(),
...dto,
});
}
diff --git a/server/test/medium/specs/services/audit.database.spec.ts b/server/test/medium/specs/services/audit.database.spec.ts
index 7506fcf2c3..b4ddf78a4f 100644
--- a/server/test/medium/specs/services/audit.database.spec.ts
+++ b/server/test/medium/specs/services/audit.database.spec.ts
@@ -1,3 +1,5 @@
+import { AssetEditAction } from 'src/dtos/editing.dto';
+import { AssetEditRepository } from 'src/repositories/asset-edit.repository';
import { LoggingRepository } from 'src/repositories/logging.repository';
import { PartnerRepository } from 'src/repositories/partner.repository';
import { UserRepository } from 'src/repositories/user.repository';
@@ -45,6 +47,27 @@ describe('audit', () => {
});
});
+ describe('asset_edit_audit', () => {
+ it('should not cascade asset deletes to asset_edit_audit', async () => {
+ const assetEditRepo = ctx.get(AssetEditRepository);
+ const { user } = await ctx.newUser();
+ const { asset } = await ctx.newAsset({ ownerId: user.id });
+
+ await assetEditRepo.replaceAll(asset.id, [
+ {
+ action: AssetEditAction.Crop,
+ parameters: { x: 10, y: 20, width: 100, height: 200 },
+ },
+ ]);
+
+ await ctx.database.deleteFrom('asset').where('id', '=', asset.id).execute();
+
+ await expect(
+ ctx.database.selectFrom('asset_edit_audit').select(['id']).where('assetId', '=', asset.id).execute(),
+ ).resolves.toHaveLength(0);
+ });
+ });
+
describe('assets_audit', () => {
it('should not cascade user deletes to assets_audit', async () => {
const userRepo = ctx.get(UserRepository);
diff --git a/server/test/medium/specs/services/sync.service.spec.ts b/server/test/medium/specs/services/sync.service.spec.ts
index b5443d7e62..c040d584b8 100644
--- a/server/test/medium/specs/services/sync.service.spec.ts
+++ b/server/test/medium/specs/services/sync.service.spec.ts
@@ -1,9 +1,10 @@
+import { schemaFromCode } from '@immich/sql-tools';
import { Kysely } from 'kysely';
import { DateTime } from 'luxon';
import { AssetMetadataKey, UserMetadataKey } from 'src/enum';
import { DatabaseRepository } from 'src/repositories/database.repository';
import { LoggingRepository } from 'src/repositories/logging.repository';
-import { SyncRepository } from 'src/repositories/sync.repository';
+import { BaseSync, SyncRepository } from 'src/repositories/sync.repository';
import { DB } from 'src/schema';
import { SyncService } from 'src/services/sync.service';
import { newMediumService } from 'test/medium.factory';
@@ -222,5 +223,21 @@ describe(SyncService.name, () => {
expect(after).toHaveLength(1);
expect(after[0].id).toBe(keep.id);
});
+
+ it('should cleanup every table', async () => {
+ const { sut } = setup();
+
+ const auditTables = schemaFromCode()
+ .tables.filter((table) => table.name.endsWith('_audit'))
+ .map(({ name }) => name);
+
+ const auditCleanupSpy = vi.spyOn(BaseSync.prototype as any, 'auditCleanup');
+ await expect(sut.onAuditTableCleanup()).resolves.toBeUndefined();
+
+ expect(auditCleanupSpy).toHaveBeenCalledTimes(auditTables.length);
+ for (const table of auditTables) {
+ expect(auditCleanupSpy, `Audit table ${table} was not cleaned up`).toHaveBeenCalledWith(table, 31);
+ }
+ });
});
});
diff --git a/server/test/medium/specs/sync/sync-asset-edit.spec.ts b/server/test/medium/specs/sync/sync-asset-edit.spec.ts
new file mode 100644
index 0000000000..43b2450b49
--- /dev/null
+++ b/server/test/medium/specs/sync/sync-asset-edit.spec.ts
@@ -0,0 +1,300 @@
+import { Kysely } from 'kysely';
+import { AssetEditAction, MirrorAxis } from 'src/dtos/editing.dto';
+import { SyncEntityType, SyncRequestType } from 'src/enum';
+import { AssetEditRepository } from 'src/repositories/asset-edit.repository';
+import { DB } from 'src/schema';
+import { SyncTestContext } from 'test/medium.factory';
+import { factory } from 'test/small.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(SyncRequestType.AssetEditsV1, () => {
+ it('should detect and sync the first asset edit', async () => {
+ const { auth, ctx } = await setup();
+ const { asset } = await ctx.newAsset({ ownerId: auth.user.id });
+ const assetEditRepo = ctx.get(AssetEditRepository);
+
+ await assetEditRepo.replaceAll(asset.id, [
+ {
+ action: AssetEditAction.Crop,
+ parameters: { x: 10, y: 20, width: 100, height: 200 },
+ },
+ ]);
+
+ const response = await ctx.syncStream(auth, [SyncRequestType.AssetEditsV1]);
+ expect(response).toEqual([
+ {
+ ack: expect.any(String),
+ data: {
+ id: expect.any(String),
+ assetId: asset.id,
+ action: AssetEditAction.Crop,
+ parameters: { x: 10, y: 20, width: 100, height: 200 },
+ sequence: 0,
+ },
+ type: SyncEntityType.AssetEditV1,
+ },
+ expect.objectContaining({ type: SyncEntityType.SyncCompleteV1 }),
+ ]);
+
+ await ctx.syncAckAll(auth, response);
+ await ctx.assertSyncIsComplete(auth, [SyncRequestType.AssetEditsV1]);
+ });
+
+ it('should detect and sync multiple asset edits for the same asset', async () => {
+ const { auth, ctx } = await setup();
+ const { asset } = await ctx.newAsset({ ownerId: auth.user.id });
+ const assetEditRepo = ctx.get(AssetEditRepository);
+
+ await assetEditRepo.replaceAll(asset.id, [
+ {
+ action: AssetEditAction.Crop,
+ parameters: { x: 10, y: 20, width: 100, height: 200 },
+ },
+ {
+ action: AssetEditAction.Rotate,
+ parameters: { angle: 90 },
+ },
+ {
+ action: AssetEditAction.Mirror,
+ parameters: { axis: MirrorAxis.Horizontal },
+ },
+ ]);
+
+ const response = await ctx.syncStream(auth, [SyncRequestType.AssetEditsV1]);
+ expect(response).toEqual(
+ expect.arrayContaining([
+ {
+ ack: expect.any(String),
+ data: {
+ id: expect.any(String),
+ assetId: asset.id,
+ action: AssetEditAction.Crop,
+ parameters: { x: 10, y: 20, width: 100, height: 200 },
+ sequence: 0,
+ },
+ type: SyncEntityType.AssetEditV1,
+ },
+ {
+ ack: expect.any(String),
+ data: {
+ id: expect.any(String),
+ assetId: asset.id,
+ action: AssetEditAction.Rotate,
+ parameters: { angle: 90 },
+ sequence: 1,
+ },
+ type: SyncEntityType.AssetEditV1,
+ },
+ {
+ ack: expect.any(String),
+ data: {
+ id: expect.any(String),
+ assetId: asset.id,
+ action: AssetEditAction.Mirror,
+ parameters: { axis: MirrorAxis.Horizontal },
+ sequence: 2,
+ },
+ type: SyncEntityType.AssetEditV1,
+ },
+ expect.objectContaining({ type: SyncEntityType.SyncCompleteV1 }),
+ ]),
+ );
+
+ await ctx.syncAckAll(auth, response);
+ await ctx.assertSyncIsComplete(auth, [SyncRequestType.AssetEditsV1]);
+ });
+
+ it('should detect and sync updated edits', async () => {
+ const { auth, ctx } = await setup();
+ const { asset } = await ctx.newAsset({ ownerId: auth.user.id });
+ const assetEditRepo = ctx.get(AssetEditRepository);
+
+ // Create initial edit
+ const edits = await assetEditRepo.replaceAll(asset.id, [
+ {
+ action: AssetEditAction.Crop,
+ parameters: { x: 10, y: 20, width: 100, height: 200 },
+ },
+ ]);
+
+ const response1 = await ctx.syncStream(auth, [SyncRequestType.AssetEditsV1]);
+ await ctx.syncAckAll(auth, response1);
+ await ctx.assertSyncIsComplete(auth, [SyncRequestType.AssetEditsV1]);
+
+ // update the existing edit
+ await ctx.database
+ .updateTable('asset_edit')
+ .set({
+ parameters: { x: 50, y: 60, width: 150, height: 250 },
+ })
+ .where('id', '=', edits[0].id)
+ .execute();
+
+ const response2 = await ctx.syncStream(auth, [SyncRequestType.AssetEditsV1]);
+ expect(response2).toEqual(
+ expect.arrayContaining([
+ {
+ ack: expect.any(String),
+ data: {
+ id: expect.any(String),
+ assetId: asset.id,
+ action: AssetEditAction.Crop,
+ parameters: { x: 50, y: 60, width: 150, height: 250 },
+ sequence: 0,
+ },
+ type: SyncEntityType.AssetEditV1,
+ },
+ expect.objectContaining({ type: SyncEntityType.SyncCompleteV1 }),
+ ]),
+ );
+
+ await ctx.syncAckAll(auth, response2);
+ await ctx.assertSyncIsComplete(auth, [SyncRequestType.AssetEditsV1]);
+ });
+
+ it('should detect and sync deleted asset edits', async () => {
+ const { auth, ctx } = await setup();
+ const { asset } = await ctx.newAsset({ ownerId: auth.user.id });
+ const assetEditRepo = ctx.get(AssetEditRepository);
+
+ // Create initial edit
+ const edits = await assetEditRepo.replaceAll(asset.id, [
+ {
+ action: AssetEditAction.Crop,
+ parameters: { x: 10, y: 20, width: 100, height: 200 },
+ },
+ ]);
+
+ const response1 = await ctx.syncStream(auth, [SyncRequestType.AssetEditsV1]);
+ await ctx.syncAckAll(auth, response1);
+ await ctx.assertSyncIsComplete(auth, [SyncRequestType.AssetEditsV1]);
+
+ // Delete all edits
+ await assetEditRepo.replaceAll(asset.id, []);
+
+ const response2 = await ctx.syncStream(auth, [SyncRequestType.AssetEditsV1]);
+ expect(response2).toEqual(
+ expect.arrayContaining([
+ {
+ ack: expect.any(String),
+ data: {
+ editId: edits[0].id,
+ },
+ type: SyncEntityType.AssetEditDeleteV1,
+ },
+ expect.objectContaining({ type: SyncEntityType.SyncCompleteV1 }),
+ ]),
+ );
+
+ await ctx.syncAckAll(auth, response2);
+ await ctx.assertSyncIsComplete(auth, [SyncRequestType.AssetEditsV1]);
+ });
+
+ it('should only sync asset edits for own user', async () => {
+ const { auth, ctx } = await setup();
+ const { user: user2 } = await ctx.newUser();
+ const { asset } = await ctx.newAsset({ ownerId: user2.id });
+ const assetEditRepo = ctx.get(AssetEditRepository);
+ const { session } = await ctx.newSession({ userId: user2.id });
+ const auth2 = factory.auth({ session, user: user2 });
+
+ await assetEditRepo.replaceAll(asset.id, [
+ {
+ action: AssetEditAction.Crop,
+ parameters: { x: 10, y: 20, width: 100, height: 200 },
+ },
+ ]);
+
+ // User 2 should see their own edit
+ await expect(ctx.syncStream(auth2, [SyncRequestType.AssetEditsV1])).resolves.toEqual([
+ expect.objectContaining({ type: SyncEntityType.AssetEditV1 }),
+ expect.objectContaining({ type: SyncEntityType.SyncCompleteV1 }),
+ ]);
+
+ // User 1 should not see user 2's edit
+ await ctx.assertSyncIsComplete(auth, [SyncRequestType.AssetEditsV1]);
+ });
+
+ it('should sync edits for multiple assets', async () => {
+ const { auth, ctx } = await setup();
+ const { asset: asset1 } = await ctx.newAsset({ ownerId: auth.user.id });
+ const { asset: asset2 } = await ctx.newAsset({ ownerId: auth.user.id });
+ const assetEditRepo = ctx.get(AssetEditRepository);
+
+ await assetEditRepo.replaceAll(asset1.id, [
+ {
+ action: AssetEditAction.Crop,
+ parameters: { x: 10, y: 20, width: 100, height: 200 },
+ },
+ ]);
+
+ await assetEditRepo.replaceAll(asset2.id, [
+ {
+ action: AssetEditAction.Rotate,
+ parameters: { angle: 270 },
+ },
+ ]);
+
+ const response = await ctx.syncStream(auth, [SyncRequestType.AssetEditsV1]);
+ expect(response).toEqual(
+ expect.arrayContaining([
+ {
+ ack: expect.any(String),
+ data: {
+ id: expect.any(String),
+ assetId: asset1.id,
+ action: AssetEditAction.Crop,
+ parameters: { x: 10, y: 20, width: 100, height: 200 },
+ sequence: 0,
+ },
+ type: SyncEntityType.AssetEditV1,
+ },
+ {
+ ack: expect.any(String),
+ data: {
+ id: expect.any(String),
+ assetId: asset2.id,
+ action: AssetEditAction.Rotate,
+ parameters: { angle: 270 },
+ sequence: 0,
+ },
+ type: SyncEntityType.AssetEditV1,
+ },
+ expect.objectContaining({ type: SyncEntityType.SyncCompleteV1 }),
+ ]),
+ );
+
+ await ctx.syncAckAll(auth, response);
+ await ctx.assertSyncIsComplete(auth, [SyncRequestType.AssetEditsV1]);
+ });
+
+ it('should not sync edits for partner assets', async () => {
+ const { auth, ctx } = await setup();
+ const { user: partner } = await ctx.newUser();
+ await ctx.newPartner({ sharedById: partner.id, sharedWithId: auth.user.id });
+ const { asset } = await ctx.newAsset({ ownerId: partner.id });
+ const assetEditRepo = ctx.get(AssetEditRepository);
+
+ await assetEditRepo.replaceAll(asset.id, [
+ {
+ action: AssetEditAction.Crop,
+ parameters: { x: 10, y: 20, width: 100, height: 200 },
+ },
+ ]);
+
+ // Should not see partner's asset edits in own sync
+ await ctx.assertSyncIsComplete(auth, [SyncRequestType.AssetEditsV1]);
+ });
+});
diff --git a/web/src/lib/stores/websocket.ts b/web/src/lib/stores/websocket.ts
index 32aa52fccb..204e44f84e 100644
--- a/web/src/lib/stores/websocket.ts
+++ b/web/src/lib/stores/websocket.ts
@@ -12,6 +12,7 @@ import {
type MaintenanceStatusResponseDto,
type NotificationDto,
type ServerVersionResponseDto,
+ type SyncAssetEditV1,
type SyncAssetV1,
} from '@immich/sdk';
import { io, type Socket } from 'socket.io-client';
@@ -41,7 +42,7 @@ export interface Events {
AppRestartV1: (event: AppRestartEvent) => void;
MaintenanceStatusV1: (event: MaintenanceStatusResponseDto) => void;
- AssetEditReadyV1: (data: { asset: SyncAssetV1 }) => void;
+ AssetEditReadyV1: (data: { asset: SyncAssetV1; edit: SyncAssetEditV1[] }) => void;
}
const websocket: Socket<Events> = io({