feat: asset metadata (#20446)

server/src/controllers/asset.controller.spec.ts

@@ -1,4 +1,5 @@
 import { AssetController } from 'src/controllers/asset.controller';
+import { AssetMetadataKey } from 'src/enum';
 import { AssetService } from 'src/services/asset.service';
 import request from 'supertest';
 import { factory } from 'test/small.factory';
@@ -6,14 +7,16 @@ import { ControllerContext, controllerSetup, mockBaseService } from 'test/utils'
 
 describe(AssetController.name, () => {
   let ctx: ControllerContext;
+  const service = mockBaseService(AssetService);
 
   beforeAll(async () => {
-    ctx = await controllerSetup(AssetController, [{ provide: AssetService, useValue: mockBaseService(AssetService) }]);
+    ctx = await controllerSetup(AssetController, [{ provide: AssetService, useValue: service }]);
     return () => ctx.close();
   });
 
   beforeEach(() => {
     ctx.reset();
+    service.resetAllMocks();
   });
 
   describe('PUT /assets', () => {
@@ -115,4 +118,120 @@ describe(AssetController.name, () => {
       );
     });
   });
+
+  describe('GET /assets/:id/metadata', () => {
+    it('should be an authenticated route', async () => {
+      await request(ctx.getHttpServer()).get(`/assets/${factory.uuid()}/metadata`);
+      expect(ctx.authenticate).toHaveBeenCalled();
+    });
+  });
+
+  describe('PUT /assets/:id/metadata', () => {
+    it('should be an authenticated route', async () => {
+      await request(ctx.getHttpServer()).put(`/assets/${factory.uuid()}/metadata`).send({ items: [] });
+      expect(ctx.authenticate).toHaveBeenCalled();
+    });
+
+    it('should require a valid id', async () => {
+      const { status, body } = await request(ctx.getHttpServer()).put(`/assets/123/metadata`).send({ items: [] });
+      expect(status).toBe(400);
+      expect(body).toEqual(factory.responses.badRequest(expect.arrayContaining(['id must be a UUID'])));
+    });
+
+    it('should require items to be an array', async () => {
+      const { status, body } = await request(ctx.getHttpServer()).put(`/assets/${factory.uuid()}/metadata`).send({});
+      expect(status).toBe(400);
+      expect(body).toEqual(factory.responses.badRequest(['items must be an array']));
+    });
+
+    it('should require each item to have a valid key', async () => {
+      const { status, body } = await request(ctx.getHttpServer())
+        .put(`/assets/${factory.uuid()}/metadata`)
+        .send({ items: [{ key: 'someKey' }] });
+      expect(status).toBe(400);
+      expect(body).toEqual(
+        factory.responses.badRequest(
+          expect.arrayContaining([expect.stringContaining('items.0.key must be one of the following values')]),
+        ),
+      );
+    });
+
+    it('should require each item to have a value', async () => {
+      const { status, body } = await request(ctx.getHttpServer())
+        .put(`/assets/${factory.uuid()}/metadata`)
+        .send({ items: [{ key: 'mobile-app', value: null }] });
+      expect(status).toBe(400);
+      expect(body).toEqual(
+        factory.responses.badRequest(expect.arrayContaining([expect.stringContaining('value must be an object')])),
+      );
+    });
+
+    describe(AssetMetadataKey.MobileApp, () => {
+      it('should accept valid data and pass to service correctly', async () => {
+        const assetId = factory.uuid();
+        const { status } = await request(ctx.getHttpServer())
+          .put(`/assets/${assetId}/metadata`)
+          .send({ items: [{ key: 'mobile-app', value: { iCloudId: '123' } }] });
+        expect(service.upsertMetadata).toHaveBeenCalledWith(undefined, assetId, {
+          items: [{ key: 'mobile-app', value: { iCloudId: '123' } }],
+        });
+        expect(status).toBe(200);
+      });
+
+      it('should work without iCloudId', async () => {
+        const assetId = factory.uuid();
+        const { status } = await request(ctx.getHttpServer())
+          .put(`/assets/${assetId}/metadata`)
+          .send({ items: [{ key: 'mobile-app', value: {} }] });
+        expect(service.upsertMetadata).toHaveBeenCalledWith(undefined, assetId, {
+          items: [{ key: 'mobile-app', value: {} }],
+        });
+        expect(status).toBe(200);
+      });
+    });
+  });
+
+  describe('GET /assets/:id/metadata/:key', () => {
+    it('should be an authenticated route', async () => {
+      await request(ctx.getHttpServer()).get(`/assets/${factory.uuid()}/metadata/mobile-app`);
+      expect(ctx.authenticate).toHaveBeenCalled();
+    });
+
+    it('should require a valid id', async () => {
+      const { status, body } = await request(ctx.getHttpServer()).get(`/assets/123/metadata/mobile-app`);
+      expect(status).toBe(400);
+      expect(body).toEqual(factory.responses.badRequest(expect.arrayContaining(['id must be a UUID'])));
+    });
+
+    it('should require a valid key', async () => {
+      const { status, body } = await request(ctx.getHttpServer()).get(`/assets/${factory.uuid()}/metadata/invalid`);
+      expect(status).toBe(400);
+      expect(body).toEqual(
+        factory.responses.badRequest(
+          expect.arrayContaining([expect.stringContaining('key must be one of the following value')]),
+        ),
+      );
+    });
+  });
+
+  describe('DELETE /assets/:id/metadata/:key', () => {
+    it('should be an authenticated route', async () => {
+      await request(ctx.getHttpServer()).delete(`/assets/${factory.uuid()}/metadata/mobile-app`);
+      expect(ctx.authenticate).toHaveBeenCalled();
+    });
+
+    it('should require a valid id', async () => {
+      const { status, body } = await request(ctx.getHttpServer()).delete(`/assets/123/metadata/mobile-app`);
+      expect(status).toBe(400);
+      expect(body).toEqual(factory.responses.badRequest(['id must be a UUID']));
+    });
+
+    it('should require a valid key', async () => {
+      const { status, body } = await request(ctx.getHttpServer()).delete(`/assets/${factory.uuid()}/metadata/invalid`);
+      expect(status).toBe(400);
+      expect(body).toEqual(
+        factory.responses.badRequest([expect.stringContaining('key must be one of the following values')]),
+      );
+    });
+  });
 });

server/src/controllers/asset.controller.ts

@@ -6,6 +6,9 @@ import {
   AssetBulkDeleteDto,
   AssetBulkUpdateDto,
   AssetJobsDto,
+  AssetMetadataResponseDto,
+  AssetMetadataRouteParams,
+  AssetMetadataUpsertDto,
   AssetStatsDto,
   AssetStatsResponseDto,
   DeviceIdDto,
@@ -85,4 +88,36 @@ export class AssetController {
   ): Promise<AssetResponseDto> {
     return this.service.update(auth, id, dto);
   }
+
+  @Get(':id/metadata')
+  @Authenticated({ permission: Permission.AssetRead })
+  getAssetMetadata(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<AssetMetadataResponseDto[]> {
+    return this.service.getMetadata(auth, id);
+  }
+
+  @Put(':id/metadata')
+  @Authenticated({ permission: Permission.AssetUpdate })
+  updateAssetMetadata(
+    @Auth() auth: AuthDto,
+    @Param() { id }: UUIDParamDto,
+    @Body() dto: AssetMetadataUpsertDto,
+  ): Promise<AssetMetadataResponseDto[]> {
+    return this.service.upsertMetadata(auth, id, dto);
+  }
+
+  @Get(':id/metadata/:key')
+  @Authenticated({ permission: Permission.AssetRead })
+  getAssetMetadataByKey(
+    @Auth() auth: AuthDto,
+    @Param() { id, key }: AssetMetadataRouteParams,
+  ): Promise<AssetMetadataResponseDto> {
+    return this.service.getMetadataByKey(auth, id, key);
+  }
+
+  @Delete(':id/metadata/:key')
+  @Authenticated({ permission: Permission.AssetUpdate })
+  @HttpCode(HttpStatus.NO_CONTENT)
+  deleteAssetMetadata(@Auth() auth: AuthDto, @Param() { id, key }: AssetMetadataRouteParams): Promise<void> {
+    return this.service.deleteMetadataByKey(auth, id, key);
+  }
 }