refactor(server): update album (#2562)

* refactor: update album

* fix: remove unnecessary decorator

server/apps/immich/src/api-v1/album/album-repository.ts

@@ -6,7 +6,7 @@ import { Repository } from 'typeorm';
 import { AddAssetsDto } from './dto/add-assets.dto';
 import { AddUsersDto } from './dto/add-users.dto';
 import { RemoveAssetsDto } from './dto/remove-assets.dto';
-import { UpdateAlbumDto } from './dto/update-album.dto';
+import { UpdateAlbumDto } from '@app/domain';
 import { AlbumCountResponseDto } from './response-dto/album-count-response.dto';
 import { AddAssetsResponseDto } from './response-dto/add-assets-response.dto';
 

server/apps/immich/src/api-v1/album/album.controller.ts

@@ -1,4 +1,4 @@
-import { Controller, Get, Post, Body, Patch, Param, Delete, Put, Query, Response } from '@nestjs/common';
+import { Controller, Get, Post, Body, Param, Delete, Put, Query, Response } from '@nestjs/common';
 import { ParseMeUUIDPipe } from '../validation/parse-me-uuid-pipe';
 import { AlbumService } from './album.service';
 import { Authenticated } from '../../decorators/authenticated.decorator';
@@ -6,7 +6,6 @@ import { AuthUserDto, GetAuthUser } from '../../decorators/auth-user.decorator';
 import { AddAssetsDto } from './dto/add-assets.dto';
 import { AddUsersDto } from './dto/add-users.dto';
 import { RemoveAssetsDto } from './dto/remove-assets.dto';
-import { UpdateAlbumDto } from './dto/update-album.dto';
 import { ApiOkResponse, ApiTags } from '@nestjs/swagger';
 import { AlbumResponseDto } from '@app/domain';
 import { AlbumCountResponseDto } from './response-dto/album-count-response.dto';
@@ -94,14 +93,6 @@ export class AlbumController {
     return this.service.removeUser(authUser, id, userId);
   }
 
-  @Authenticated()
-  @Patch(':id')
-  updateAlbumInfo(@GetAuthUser() authUser: AuthUserDto, @Param() { id }: UUIDParamDto, @Body() dto: UpdateAlbumDto) {
-    // TODO: Handle nonexistent albumThumbnailAssetId.
-    // TODO: Disallow setting asset from other user as albumThumbnailAssetId.
-    return this.service.update(authUser, id, dto);
-  }
-
   @Authenticated({ isShared: true })
   @Get(':id/download')
   @ApiOkResponse({ content: { 'application/zip': { schema: { type: 'string', format: 'binary' } } } })

server/apps/immich/src/api-v1/album/album.service.spec.ts

@@ -2,7 +2,7 @@ import { AlbumService } from './album.service';
 import { AuthUserDto } from '../../decorators/auth-user.decorator';
 import { BadRequestException, NotFoundException, ForbiddenException } from '@nestjs/common';
 import { AlbumEntity, UserEntity } from '@app/infra/entities';
-import { AlbumResponseDto, ICryptoRepository, IJobRepository, JobName, mapUser } from '@app/domain';
+import { AlbumResponseDto, ICryptoRepository, IJobRepository, mapUser } from '@app/domain';
 import { AddAssetsResponseDto } from './response-dto/add-assets-response.dto';
 import { IAlbumRepository } from './album-repository';
 import { DownloadService } from '../../modules/download/download.service';
@@ -259,44 +259,6 @@ describe('Album service', () => {
     await expect(sut.removeUser(authUser, albumEntity.id, authUser.id)).rejects.toBeInstanceOf(BadRequestException);
   });
 
-  it('updates a owned album', async () => {
-    const albumEntity = _getOwnedAlbum();
-    const albumId = albumEntity.id;
-    const updatedAlbumName = 'new album name';
-    const updatedAlbumThumbnailAssetId = '69d2f917-0b31-48d8-9d7d-673b523f1aac';
-    albumRepositoryMock.get.mockImplementation(() => Promise.resolve<AlbumEntity>(albumEntity));
-    const updatedAlbum = { ...albumEntity, albumName: updatedAlbumName };
-    albumRepositoryMock.updateAlbum.mockResolvedValue(updatedAlbum);
-
-    const result = await sut.update(authUser, albumId, {
-      albumName: updatedAlbumName,
-      albumThumbnailAssetId: updatedAlbumThumbnailAssetId,
-    });
-
-    expect(result.id).toEqual(albumId);
-    expect(result.albumName).toEqual(updatedAlbumName);
-    expect(albumRepositoryMock.updateAlbum).toHaveBeenCalledTimes(1);
-    expect(albumRepositoryMock.updateAlbum).toHaveBeenCalledWith(albumEntity, {
-      albumName: updatedAlbumName,
-      albumThumbnailAssetId: updatedAlbumThumbnailAssetId,
-    });
-    expect(jobMock.queue).toHaveBeenCalledWith({ name: JobName.SEARCH_INDEX_ALBUM, data: { ids: [updatedAlbum.id] } });
-  });
-
-  it('prevents updating a not owned album (shared with auth user)', async () => {
-    const albumEntity = _getSharedWithAuthUserAlbum();
-    const albumId = albumEntity.id;
-
-    albumRepositoryMock.get.mockImplementation(() => Promise.resolve<AlbumEntity>(albumEntity));
-
-    await expect(
-      sut.update(authUser, albumId, {
-        albumName: 'new album name',
-        albumThumbnailAssetId: '69d2f917-0b31-48d8-9d7d-673b523f1aac',
-      }),
-    ).rejects.toBeInstanceOf(ForbiddenException);
-  });
-
   it('adds assets to owned album', async () => {
     const albumEntity = _getOwnedAlbum();
 

server/apps/immich/src/api-v1/album/album.service.ts

@@ -3,7 +3,6 @@ import { AuthUserDto } from '../../decorators/auth-user.decorator';
 import { AlbumEntity, SharedLinkType } from '@app/infra/entities';
 import { AddUsersDto } from './dto/add-users.dto';
 import { RemoveAssetsDto } from './dto/remove-assets.dto';
-import { UpdateAlbumDto } from './dto/update-album.dto';
 import { AlbumResponseDto, IJobRepository, JobName, mapAlbum } from '@app/domain';
 import { IAlbumRepository } from './album-repository';
 import { AlbumCountResponseDto } from './response-dto/album-count-response.dto';
@@ -116,20 +115,6 @@ export class AlbumService {
     };
   }
 
-  async update(authUser: AuthUserDto, albumId: string, dto: UpdateAlbumDto): Promise<AlbumResponseDto> {
-    const album = await this._getAlbum({ authUser, albumId });
-
-    if (authUser.id != album.ownerId) {
-      throw new BadRequestException('Unauthorized to change album info');
-    }
-
-    const updatedAlbum = await this.albumRepository.updateAlbum(album, dto);
-
-    await this.jobRepository.queue({ name: JobName.SEARCH_INDEX_ALBUM, data: { ids: [updatedAlbum.id] } });
-
-    return mapAlbum(updatedAlbum);
-  }
-
   async getCountByUserId(authUser: AuthUserDto): Promise<AlbumCountResponseDto> {
     return this.albumRepository.getCountByUserId(authUser.id);
   }

server/apps/immich/src/api-v1/album/dto/update-album.dto.ts

@@ -1,12 +0,0 @@
-import { ApiProperty } from '@nestjs/swagger';
-import { ValidateUUID } from 'apps/immich/src/decorators/validate-uuid.decorator';
-import { IsOptional } from 'class-validator';
-
-export class UpdateAlbumDto {
-  @IsOptional()
-  @ApiProperty()
-  albumName?: string;
-
-  @ValidateUUID({ optional: true })
-  albumThumbnailAssetId?: string;
-}

server/apps/immich/src/controllers/album.controller.ts

@@ -1,10 +1,11 @@
-import { AlbumService, AuthUserDto, CreateAlbumDto } from '@app/domain';
+/*  */ import { AlbumService, AuthUserDto, CreateAlbumDto, UpdateAlbumDto } from '@app/domain';
 import { GetAlbumsDto } from '@app/domain/album/dto/get-albums.dto';
-import { Body, Controller, Get, Post, Query } from '@nestjs/common';
+import { Body, Controller, Get, Param, Patch, Post, Query } from '@nestjs/common';
 import { ApiTags } from '@nestjs/swagger';
 import { GetAuthUser } from '../decorators/auth-user.decorator';
 import { Authenticated } from '../decorators/authenticated.decorator';
 import { UseValidation } from '../decorators/use-validation.decorator';
+import { UUIDParamDto } from './dto/uuid-param.dto';
 
 @ApiTags('Album')
 @Controller('album')
@@ -22,4 +23,9 @@ export class AlbumController {
   createAlbum(@GetAuthUser() authUser: AuthUserDto, @Body() dto: CreateAlbumDto) {
     return this.service.create(authUser, dto);
   }
+
+  @Patch(':id')
+  updateAlbumInfo(@GetAuthUser() authUser: AuthUserDto, @Param() { id }: UUIDParamDto, @Body() dto: UpdateAlbumDto) {
+    return this.service.update(authUser, id, dto);
+  }
 }