Skip to content

High performance self-hosted photo and video management solution.

fix: add asset upload medium test (#25144)

Jason Rasmussen191401f2f1db
diff --git a/mobile/openapi/lib/api/assets_api.dart b/mobile/openapi/lib/api/assets_api.dart
index 18a0e35c4f..ac50d015ed 100644
--- a/mobile/openapi/lib/api/assets_api.dart
+++ b/mobile/openapi/lib/api/assets_api.dart
@@ -1353,8 +1353,6 @@ class AssetsApi {
///
/// * [DateTime] fileModifiedAt (required):
///
- /// * [List<AssetMetadataUpsertItemDto>] metadata (required):
- ///
/// * [String] key:
///
/// * [String] slug:
@@ -1370,10 +1368,12 @@ class AssetsApi {
///
/// * [String] livePhotoVideoId:
///
+ /// * [List<AssetMetadataUpsertItemDto>] metadata:
+ ///
/// * [MultipartFile] sidecarData:
///
/// * [AssetVisibility] visibility:
- Future<Response> uploadAssetWithHttpInfo(MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, List<AssetMetadataUpsertItemDto> metadata, { String? key, String? slug, String? xImmichChecksum, String? duration, String? filename, bool? isFavorite, String? livePhotoVideoId, MultipartFile? sidecarData, AssetVisibility? visibility, }) async {
+ Future<Response> uploadAssetWithHttpInfo(MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String? key, String? slug, String? xImmichChecksum, String? duration, String? filename, bool? isFavorite, String? livePhotoVideoId, List<AssetMetadataUpsertItemDto>? metadata, MultipartFile? sidecarData, AssetVisibility? visibility, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/assets';
@@ -1480,8 +1480,6 @@ class AssetsApi {
///
/// * [DateTime] fileModifiedAt (required):
///
- /// * [List<AssetMetadataUpsertItemDto>] metadata (required):
- ///
/// * [String] key:
///
/// * [String] slug:
@@ -1497,11 +1495,13 @@ class AssetsApi {
///
/// * [String] livePhotoVideoId:
///
+ /// * [List<AssetMetadataUpsertItemDto>] metadata:
+ ///
/// * [MultipartFile] sidecarData:
///
/// * [AssetVisibility] visibility:
- Future<AssetMediaResponseDto?> uploadAsset(MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, List<AssetMetadataUpsertItemDto> metadata, { String? key, String? slug, String? xImmichChecksum, String? duration, String? filename, bool? isFavorite, String? livePhotoVideoId, MultipartFile? sidecarData, AssetVisibility? visibility, }) async {
- final response = await uploadAssetWithHttpInfo(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, metadata, key: key, slug: slug, xImmichChecksum: xImmichChecksum, duration: duration, filename: filename, isFavorite: isFavorite, livePhotoVideoId: livePhotoVideoId, sidecarData: sidecarData, visibility: visibility, );
+ Future<AssetMediaResponseDto?> uploadAsset(MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String? key, String? slug, String? xImmichChecksum, String? duration, String? filename, bool? isFavorite, String? livePhotoVideoId, List<AssetMetadataUpsertItemDto>? metadata, MultipartFile? sidecarData, AssetVisibility? visibility, }) async {
+ final response = await uploadAssetWithHttpInfo(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, key: key, slug: slug, xImmichChecksum: xImmichChecksum, duration: duration, filename: filename, isFavorite: isFavorite, livePhotoVideoId: livePhotoVideoId, metadata: metadata, sidecarData: sidecarData, visibility: visibility, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.json
index e46f29b50d..25be8d2f45 100644
--- a/open-api/immich-openapi-specs.json
+++ b/open-api/immich-openapi-specs.json
@@ -15605,8 +15605,7 @@
"deviceAssetId",
"deviceId",
"fileCreatedAt",
- "fileModifiedAt",
- "metadata"
+ "fileModifiedAt"
],
"type": "object"
},
diff --git a/open-api/typescript-sdk/src/fetch-client.ts b/open-api/typescript-sdk/src/fetch-client.ts
index 560f1077b2..ab6b894c60 100644
--- a/open-api/typescript-sdk/src/fetch-client.ts
+++ b/open-api/typescript-sdk/src/fetch-client.ts
@@ -484,7 +484,7 @@ export type AssetMediaCreateDto = {
filename?: string;
isFavorite?: boolean;
livePhotoVideoId?: string;
- metadata: AssetMetadataUpsertItemDto[];
+ metadata?: AssetMetadataUpsertItemDto[];
sidecarData?: Blob;
visibility?: AssetVisibility;
};
diff --git a/server/src/dtos/asset-media.dto.ts b/server/src/dtos/asset-media.dto.ts
index 755069d827..262e2f9637 100644
--- a/server/src/dtos/asset-media.dto.ts
+++ b/server/src/dtos/asset-media.dto.ts
@@ -78,7 +78,7 @@ export class AssetMediaCreateDto extends AssetMediaBase {
@Optional()
@ValidateNested({ each: true })
@IsArray()
- metadata!: AssetMetadataUpsertItemDto[];
+ metadata?: AssetMetadataUpsertItemDto[];
@ApiProperty({ type: 'string', format: 'binary', required: false })
[UploadFieldName.SIDECAR_DATA]?: any;
diff --git a/server/src/repositories/asset.repository.ts b/server/src/repositories/asset.repository.ts
index 07e227ea11..e1d16b8a6a 100644
--- a/server/src/repositories/asset.repository.ts
+++ b/server/src/repositories/asset.repository.ts
@@ -258,6 +258,10 @@ export class AssetRepository {
}
upsertMetadata(id: string, items: Array<{ key: string; value: object }>) {
+ if (items.length === 0) {
+ return [];
+ }
+
return this.db
.insertInto('asset_metadata')
.values(items.map((item) => ({ assetId: id, ...item })))
diff --git a/server/test/medium.factory.ts b/server/test/medium.factory.ts
index 9cd91a5756..44ca231d8f 100644
--- a/server/test/medium.factory.ts
+++ b/server/test/medium.factory.ts
@@ -69,6 +69,7 @@ import { UserTable } from 'src/schema/tables/user.table';
import { BASE_SERVICE_DEPENDENCIES, BaseService } from 'src/services/base.service';
import { MetadataService } from 'src/services/metadata.service';
import { SyncService } from 'src/services/sync.service';
+import { UploadFile } from 'src/types';
import { mockEnvData } from 'test/repositories/config.repository.mock';
import { newTelemetryRepositoryMock } from 'test/repositories/telemetry.repository.mock';
import { factory, newDate, newEmbedding, newUuid } from 'test/small.factory';
@@ -746,6 +747,17 @@ const loginResponse = (): LoginResponseDto => {
};
};
+const uploadFile = (file: Partial<UploadFile> = {}) => {
+ return {
+ uuid: newUuid(),
+ checksum: randomBytes(32),
+ originalPath: '/path/to/file.jpg',
+ originalName: 'file.jpg',
+ size: 123_456,
+ ...file,
+ };
+};
+
export const mediumFactory = {
assetInsert,
assetFaceInsert,
@@ -760,4 +772,5 @@ export const mediumFactory = {
loginDetails,
loginResponse,
tagInsert,
+ uploadFile,
};
diff --git a/server/test/medium/specs/services/asset-media.service.spec.ts b/server/test/medium/specs/services/asset-media.service.spec.ts
new file mode 100644
index 0000000000..5089850b6f
--- /dev/null
+++ b/server/test/medium/specs/services/asset-media.service.spec.ts
@@ -0,0 +1,100 @@
+import { Kysely } from 'kysely';
+import { AssetMediaStatus } from 'src/dtos/asset-media-response.dto';
+import { AccessRepository } from 'src/repositories/access.repository';
+import { AssetRepository } from 'src/repositories/asset.repository';
+import { EventRepository } from 'src/repositories/event.repository';
+import { JobRepository } from 'src/repositories/job.repository';
+import { LoggingRepository } from 'src/repositories/logging.repository';
+import { StorageRepository } from 'src/repositories/storage.repository';
+import { UserRepository } from 'src/repositories/user.repository';
+import { DB } from 'src/schema';
+import { AssetMediaService } from 'src/services/asset-media.service';
+import { AssetService } from 'src/services/asset.service';
+import { mediumFactory, newMediumService } from 'test/medium.factory';
+import { factory } from 'test/small.factory';
+import { getKyselyDB } from 'test/utils';
+
+let defaultDatabase: Kysely<DB>;
+
+const setup = (db?: Kysely<DB>) => {
+ return newMediumService(AssetMediaService, {
+ database: db || defaultDatabase,
+ real: [AccessRepository, AssetRepository, UserRepository],
+ mock: [EventRepository, LoggingRepository, JobRepository, StorageRepository],
+ });
+};
+
+beforeAll(async () => {
+ defaultDatabase = await getKyselyDB();
+});
+
+describe(AssetService.name, () => {
+ describe('uploadAsset', () => {
+ it('should work', async () => {
+ const { sut, ctx } = setup();
+
+ ctx.getMock(StorageRepository).utimes.mockResolvedValue();
+ ctx.getMock(EventRepository).emit.mockResolvedValue();
+ ctx.getMock(JobRepository).queue.mockResolvedValue();
+
+ const { user } = await ctx.newUser();
+ const { asset } = await ctx.newAsset({ ownerId: user.id });
+ await ctx.newExif({ assetId: asset.id, fileSizeInByte: 12_345 });
+ const auth = factory.auth({ user: { id: user.id } });
+ const file = mediumFactory.uploadFile();
+
+ await expect(
+ sut.uploadAsset(
+ auth,
+ {
+ deviceId: 'some-id',
+ deviceAssetId: 'some-id',
+ fileModifiedAt: new Date(),
+ fileCreatedAt: new Date(),
+ assetData: Buffer.from('some data'),
+ },
+ file,
+ ),
+ ).resolves.toEqual({
+ id: expect.any(String),
+ status: AssetMediaStatus.CREATED,
+ });
+
+ expect(ctx.getMock(EventRepository).emit).toHaveBeenCalledWith('AssetCreate', {
+ asset: expect.objectContaining({ deviceAssetId: 'some-id' }),
+ });
+ });
+
+ it('should work with an empty metadata list', async () => {
+ const { sut, ctx } = setup();
+
+ ctx.getMock(StorageRepository).utimes.mockResolvedValue();
+ ctx.getMock(EventRepository).emit.mockResolvedValue();
+ ctx.getMock(JobRepository).queue.mockResolvedValue();
+
+ const { user } = await ctx.newUser();
+ const { asset } = await ctx.newAsset({ ownerId: user.id });
+ await ctx.newExif({ assetId: asset.id, fileSizeInByte: 12_345 });
+ const auth = factory.auth({ user: { id: user.id } });
+ const file = mediumFactory.uploadFile();
+
+ await expect(
+ sut.uploadAsset(
+ auth,
+ {
+ deviceId: 'some-id',
+ deviceAssetId: 'some-id',
+ fileModifiedAt: new Date(),
+ fileCreatedAt: new Date(),
+ assetData: Buffer.from('some data'),
+ metadata: [],
+ },
+ file,
+ ),
+ ).resolves.toEqual({
+ id: expect.any(String),
+ status: AssetMediaStatus.CREATED,
+ });
+ });
+ });
+});