import { AssetType } from '@app/infra/entities'; import { BadRequestException, UnauthorizedException } from '@nestjs/common'; import { assetStub, authStub, IAccessRepositoryMock, newAccessRepositoryMock, newAssetRepositoryMock, newCryptoRepositoryMock, newStorageRepositoryMock, } from '@test'; import { when } from 'jest-when'; import { Readable } from 'stream'; import { ICryptoRepository } from '../crypto'; import { IStorageRepository } from '../storage'; import { AssetStats, IAssetRepository } from './asset.repository'; import { AssetService, UploadFieldName } from './asset.service'; import { AssetStatsResponseDto, DownloadResponseDto } from './dto'; import { mapAsset } from './response-dto'; const downloadResponse: DownloadResponseDto = { totalSize: 105_000, archives: [ { assetIds: ['asset-id', 'asset-id'], size: 105_000, }, ], }; const stats: AssetStats = { [AssetType.IMAGE]: 10, [AssetType.VIDEO]: 23, [AssetType.AUDIO]: 0, [AssetType.OTHER]: 0, }; const statResponse: AssetStatsResponseDto = { images: 10, videos: 23, total: 33, }; const uploadFile = { nullAuth: { authUser: null, fieldName: UploadFieldName.ASSET_DATA, file: { checksum: Buffer.from('checksum', 'utf8'), originalPath: 'upload/admin/image.jpeg', originalName: 'image.jpeg', }, }, filename: (fieldName: UploadFieldName, filename: string) => { return { authUser: authStub.admin, fieldName, file: { mimeType: 'image/jpeg', checksum: Buffer.from('checksum', 'utf8'), originalPath: `upload/admin/${filename}`, originalName: filename, }, }; }, }; const validImages = [ '.3fr', '.ari', '.arw', '.avif', '.cap', '.cin', '.cr2', '.cr3', '.crw', '.dcr', '.dng', '.erf', '.fff', '.gif', '.heic', '.heif', '.iiq', '.jpeg', '.jpg', '.jxl', '.k25', '.kdc', '.mrw', '.nef', '.orf', '.ori', '.pef', '.png', '.raf', '.raw', '.rwl', '.sr2', '.srf', '.srw', '.tiff', '.webp', '.x3f', ]; const validVideos = ['.3gp', '.avi', '.flv', '.m2ts', '.mkv', '.mov', '.mp4', '.mpg', '.mts', '.webm', '.wmv']; const uploadTests = [ { label: 'asset images', fieldName: UploadFieldName.ASSET_DATA, valid: validImages, invalid: ['.html', '.xml'], }, { label: 'asset videos', fieldName: UploadFieldName.ASSET_DATA, valid: validVideos, invalid: ['.html', '.xml'], }, { label: 'live photo', fieldName: UploadFieldName.LIVE_PHOTO_DATA, valid: validVideos, invalid: ['.html', '.jpeg', '.jpg', '.xml'], }, { label: 'sidecar', fieldName: UploadFieldName.SIDECAR_DATA, valid: ['.xmp'], invalid: ['.html', '.jpeg', '.jpg', '.mov', '.mp4', '.xml'], }, { label: 'profile', fieldName: UploadFieldName.PROFILE_DATA, valid: ['.avif', '.dng', '.heic', '.heif', '.jpeg', '.jpg', '.png', '.webp'], invalid: ['.arf', '.cr2', '.html', '.mov', '.mp4', '.xml'], }, ]; describe(AssetService.name, () => { let sut: AssetService; let accessMock: IAccessRepositoryMock; let assetMock: jest.Mocked<IAssetRepository>; let cryptoMock: jest.Mocked<ICryptoRepository>; let storageMock: jest.Mocked<IStorageRepository>; it('should work', () => { expect(sut).toBeDefined(); }); beforeEach(async () => { accessMock = newAccessRepositoryMock(); assetMock = newAssetRepositoryMock(); cryptoMock = newCryptoRepositoryMock(); storageMock = newStorageRepositoryMock(); sut = new AssetService(accessMock, assetMock, cryptoMock, storageMock); }); describe('canUpload', () => { it('should require an authenticated user', () => { expect(() => sut.canUploadFile(uploadFile.nullAuth)).toThrowError(UnauthorizedException); }); for (const { fieldName, valid, invalid } of uploadTests) { describe(fieldName, () => { for (const filetype of valid) { it(`should accept ${filetype}`, () => { expect(sut.canUploadFile(uploadFile.filename(fieldName, `asset${filetype}`))).toEqual(true); }); } for (const filetype of invalid) { it(`should reject ${filetype}`, () => { expect(() => sut.canUploadFile(uploadFile.filename(fieldName, `asset${filetype}`))).toThrowError( BadRequestException, ); }); } it('should be sorted (valid)', () => { // TODO: use toSorted in NodeJS 20. expect(valid).toEqual([...valid].sort()); }); it('should be sorted (invalid)', () => { // TODO: use toSorted in NodeJS 20. expect(invalid).toEqual([...invalid].sort()); }); }); } }); describe('getUploadFilename', () => { it('should require authentication', () => { expect(() => sut.getUploadFilename(uploadFile.nullAuth)).toThrowError(UnauthorizedException); }); it('should be the original extension for asset upload', () => { expect(sut.getUploadFilename(uploadFile.filename(UploadFieldName.ASSET_DATA, 'image.jpg'))).toEqual( 'random-uuid.jpg', ); }); it('should be the mov extension for live photo upload', () => { expect(sut.getUploadFilename(uploadFile.filename(UploadFieldName.LIVE_PHOTO_DATA, 'image.mp4'))).toEqual( 'random-uuid.mov', ); }); it('should be the xmp extension for sidecar upload', () => { expect(sut.getUploadFilename(uploadFile.filename(UploadFieldName.SIDECAR_DATA, 'image.html'))).toEqual( 'random-uuid.xmp', ); }); it('should be the original extension for profile upload', () => { expect(sut.getUploadFilename(uploadFile.filename(UploadFieldName.PROFILE_DATA, 'image.jpg'))).toEqual( 'random-uuid.jpg', ); }); }); describe('getUploadFolder', () => { it('should require authentication', () => { expect(() => sut.getUploadFolder(uploadFile.nullAuth)).toThrowError(UnauthorizedException); }); it('should return profile for profile uploads', () => { expect(sut.getUploadFolder(uploadFile.filename(UploadFieldName.PROFILE_DATA, 'image.jpg'))).toEqual( 'upload/profile/admin_id', ); expect(storageMock.mkdirSync).toHaveBeenCalledWith('upload/profile/admin_id'); }); it('should return upload for everything else', () => { expect(sut.getUploadFolder(uploadFile.filename(UploadFieldName.ASSET_DATA, 'image.jpg'))).toEqual( 'upload/upload/admin_id', ); expect(storageMock.mkdirSync).toHaveBeenCalledWith('upload/upload/admin_id'); }); }); describe('getMapMarkers', () => { it('should get geo information of assets', async () => { assetMock.getMapMarkers.mockResolvedValue( [assetStub.withLocation].map((asset) => ({ id: asset.id, /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion */ lat: asset.exifInfo!.latitude!, /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion */ lon: asset.exifInfo!.longitude!, })), ); const markers = await sut.getMapMarkers(authStub.user1, {}); expect(markers).toHaveLength(1); expect(markers[0]).toEqual({ id: assetStub.withLocation.id, lat: 100, lon: 100, }); }); }); describe('getMemoryLane', () => { it('should get pictures for each year', async () => { assetMock.getByDate.mockResolvedValue([]); await expect(sut.getMemoryLane(authStub.admin, { timestamp: new Date(2023, 5, 15), years: 10 })).resolves.toEqual( [], ); expect(assetMock.getByDate).toHaveBeenCalledTimes(10); expect(assetMock.getByDate.mock.calls).toEqual([ [authStub.admin.id, new Date('2022-06-15T00:00:00.000Z')], [authStub.admin.id, new Date('2021-06-15T00:00:00.000Z')], [authStub.admin.id, new Date('2020-06-15T00:00:00.000Z')], [authStub.admin.id, new Date('2019-06-15T00:00:00.000Z')], [authStub.admin.id, new Date('2018-06-15T00:00:00.000Z')], [authStub.admin.id, new Date('2017-06-15T00:00:00.000Z')], [authStub.admin.id, new Date('2016-06-15T00:00:00.000Z')], [authStub.admin.id, new Date('2015-06-15T00:00:00.000Z')], [authStub.admin.id, new Date('2014-06-15T00:00:00.000Z')], [authStub.admin.id, new Date('2013-06-15T00:00:00.000Z')], ]); }); it('should keep hours from the date', async () => { assetMock.getByDate.mockResolvedValue([]); await expect( sut.getMemoryLane(authStub.admin, { timestamp: new Date(2023, 5, 15, 5), years: 2 }), ).resolves.toEqual([]); expect(assetMock.getByDate).toHaveBeenCalledTimes(2); expect(assetMock.getByDate.mock.calls).toEqual([ [authStub.admin.id, new Date('2022-06-15T05:00:00.000Z')], [authStub.admin.id, new Date('2021-06-15T05:00:00.000Z')], ]); }); it('should set the title correctly', async () => { when(assetMock.getByDate) .calledWith(authStub.admin.id, new Date('2022-06-15T00:00:00.000Z')) .mockResolvedValue([assetStub.image]); when(assetMock.getByDate) .calledWith(authStub.admin.id, new Date('2021-06-15T00:00:00.000Z')) .mockResolvedValue([assetStub.video]); await expect(sut.getMemoryLane(authStub.admin, { timestamp: new Date(2023, 5, 15), years: 2 })).resolves.toEqual([ { title: '1 year since...', assets: [mapAsset(assetStub.image)] }, { title: '2 years since...', assets: [mapAsset(assetStub.video)] }, ]); expect(assetMock.getByDate).toHaveBeenCalledTimes(2); expect(assetMock.getByDate.mock.calls).toEqual([ [authStub.admin.id, new Date('2022-06-15T00:00:00.000Z')], [authStub.admin.id, new Date('2021-06-15T00:00:00.000Z')], ]); }); }); describe('downloadFile', () => { it('should require the asset.download permission', async () => { accessMock.asset.hasOwnerAccess.mockResolvedValue(false); accessMock.asset.hasAlbumAccess.mockResolvedValue(false); accessMock.asset.hasPartnerAccess.mockResolvedValue(false); await expect(sut.downloadFile(authStub.admin, 'asset-1')).rejects.toBeInstanceOf(BadRequestException); expect(accessMock.asset.hasOwnerAccess).toHaveBeenCalledWith(authStub.admin.id, 'asset-1'); expect(accessMock.asset.hasAlbumAccess).toHaveBeenCalledWith(authStub.admin.id, 'asset-1'); expect(accessMock.asset.hasPartnerAccess).toHaveBeenCalledWith(authStub.admin.id, 'asset-1'); }); it('should throw an error if the asset is not found', async () => { accessMock.asset.hasOwnerAccess.mockResolvedValue(true); assetMock.getByIds.mockResolvedValue([]); await expect(sut.downloadFile(authStub.admin, 'asset-1')).rejects.toBeInstanceOf(BadRequestException); expect(assetMock.getByIds).toHaveBeenCalledWith(['asset-1']); }); it('should download a file', async () => { const stream = new Readable(); accessMock.asset.hasOwnerAccess.mockResolvedValue(true); assetMock.getByIds.mockResolvedValue([assetStub.image]); storageMock.createReadStream.mockResolvedValue({ stream }); await expect(sut.downloadFile(authStub.admin, 'asset-1')).resolves.toEqual({ stream }); expect(storageMock.createReadStream).toHaveBeenCalledWith(assetStub.image.originalPath, 'image/jpeg'); }); it('should download an archive', async () => { const archiveMock = { addFile: jest.fn(), finalize: jest.fn(), stream: new Readable(), }; accessMock.asset.hasOwnerAccess.mockResolvedValue(true); assetMock.getByIds.mockResolvedValue([assetStub.noResizePath, assetStub.noWebpPath]); storageMock.createZipStream.mockReturnValue(archiveMock); await expect(sut.downloadArchive(authStub.admin, { assetIds: ['asset-1', 'asset-2'] })).resolves.toEqual({ stream: archiveMock.stream, }); expect(archiveMock.addFile).toHaveBeenCalledTimes(2); expect(archiveMock.addFile).toHaveBeenNthCalledWith(1, 'upload/library/IMG_123.jpg', 'IMG_123.jpg'); expect(archiveMock.addFile).toHaveBeenNthCalledWith(2, 'upload/library/IMG_456.jpg', 'IMG_456.jpg'); }); it('should handle duplicate file names', async () => { const archiveMock = { addFile: jest.fn(), finalize: jest.fn(), stream: new Readable(), }; accessMock.asset.hasOwnerAccess.mockResolvedValue(true); assetMock.getByIds.mockResolvedValue([assetStub.noResizePath, assetStub.noResizePath]); storageMock.createZipStream.mockReturnValue(archiveMock); await expect(sut.downloadArchive(authStub.admin, { assetIds: ['asset-1', 'asset-2'] })).resolves.toEqual({ stream: archiveMock.stream, }); expect(archiveMock.addFile).toHaveBeenCalledTimes(2); expect(archiveMock.addFile).toHaveBeenNthCalledWith(1, 'upload/library/IMG_123.jpg', 'IMG_123.jpg'); expect(archiveMock.addFile).toHaveBeenNthCalledWith(2, 'upload/library/IMG_123.jpg', 'IMG_123+1.jpg'); }); }); describe('getDownloadInfo', () => { it('should throw an error for an invalid dto', async () => { await expect(sut.getDownloadInfo(authStub.admin, {})).rejects.toBeInstanceOf(BadRequestException); }); it('should return a list of archives (assetIds)', async () => { accessMock.asset.hasOwnerAccess.mockResolvedValue(true); assetMock.getByIds.mockResolvedValue([assetStub.image, assetStub.video]); const assetIds = ['asset-1', 'asset-2']; await expect(sut.getDownloadInfo(authStub.admin, { assetIds })).resolves.toEqual(downloadResponse); expect(assetMock.getByIds).toHaveBeenCalledWith(['asset-1', 'asset-2']); }); it('should return a list of archives (albumId)', async () => { accessMock.album.hasOwnerAccess.mockResolvedValue(true); assetMock.getByAlbumId.mockResolvedValue({ items: [assetStub.image, assetStub.video], hasNextPage: false, }); await expect(sut.getDownloadInfo(authStub.admin, { albumId: 'album-1' })).resolves.toEqual(downloadResponse); expect(accessMock.album.hasOwnerAccess).toHaveBeenCalledWith(authStub.admin.id, 'album-1'); expect(assetMock.getByAlbumId).toHaveBeenCalledWith({ take: 2500, skip: 0 }, 'album-1'); }); it('should return a list of archives (userId)', async () => { assetMock.getByUserId.mockResolvedValue({ items: [assetStub.image, assetStub.video], hasNextPage: false, }); await expect(sut.getDownloadInfo(authStub.admin, { userId: authStub.admin.id })).resolves.toEqual( downloadResponse, ); expect(assetMock.getByUserId).toHaveBeenCalledWith({ take: 2500, skip: 0 }, authStub.admin.id); }); it('should split archives by size', async () => { assetMock.getByUserId.mockResolvedValue({ items: [ { ...assetStub.image, id: 'asset-1' }, { ...assetStub.video, id: 'asset-2' }, { ...assetStub.withLocation, id: 'asset-3' }, { ...assetStub.noWebpPath, id: 'asset-4' }, ], hasNextPage: false, }); await expect( sut.getDownloadInfo(authStub.admin, { userId: authStub.admin.id, archiveSize: 30_000, }), ).resolves.toEqual({ totalSize: 251_456, archives: [ { assetIds: ['asset-1', 'asset-2'], size: 105_000 }, { assetIds: ['asset-3', 'asset-4'], size: 146_456 }, ], }); }); it('should include the video portion of a live photo', async () => { accessMock.asset.hasOwnerAccess.mockResolvedValue(true); when(assetMock.getByIds) .calledWith([assetStub.livePhotoStillAsset.id]) .mockResolvedValue([assetStub.livePhotoStillAsset]); when(assetMock.getByIds) .calledWith([assetStub.livePhotoMotionAsset.id]) .mockResolvedValue([assetStub.livePhotoMotionAsset]); const assetIds = [assetStub.livePhotoStillAsset.id]; await expect(sut.getDownloadInfo(authStub.admin, { assetIds })).resolves.toEqual({ totalSize: 125_000, archives: [ { assetIds: [assetStub.livePhotoStillAsset.id, assetStub.livePhotoMotionAsset.id], size: 125_000, }, ], }); }); }); describe('getStatistics', () => { it('should get the statistics for a user, excluding archived assets', async () => { assetMock.getStatistics.mockResolvedValue(stats); await expect(sut.getStatistics(authStub.admin, { isArchived: false })).resolves.toEqual(statResponse); expect(assetMock.getStatistics).toHaveBeenCalledWith(authStub.admin.id, { isArchived: false }); }); it('should get the statistics for a user for archived assets', async () => { assetMock.getStatistics.mockResolvedValue(stats); await expect(sut.getStatistics(authStub.admin, { isArchived: true })).resolves.toEqual(statResponse); expect(assetMock.getStatistics).toHaveBeenCalledWith(authStub.admin.id, { isArchived: true }); }); it('should get the statistics for a user for favorite assets', async () => { assetMock.getStatistics.mockResolvedValue(stats); await expect(sut.getStatistics(authStub.admin, { isFavorite: true })).resolves.toEqual(statResponse); expect(assetMock.getStatistics).toHaveBeenCalledWith(authStub.admin.id, { isFavorite: true }); }); it('should get the statistics for a user for all assets', async () => { assetMock.getStatistics.mockResolvedValue(stats); await expect(sut.getStatistics(authStub.admin, {})).resolves.toEqual(statResponse); expect(assetMock.getStatistics).toHaveBeenCalledWith(authStub.admin.id, {}); }); }); describe('updateAll', () => { it('should require asset write access for all ids', async () => { accessMock.asset.hasOwnerAccess.mockResolvedValue(false); await expect( sut.updateAll(authStub.admin, { ids: ['asset-1'], isArchived: false, }), ).rejects.toBeInstanceOf(BadRequestException); }); it('should update all assets', async () => { accessMock.asset.hasOwnerAccess.mockResolvedValue(true); await sut.updateAll(authStub.admin, { ids: ['asset-1', 'asset-2'], isArchived: true }); expect(assetMock.updateAll).toHaveBeenCalledWith(['asset-1', 'asset-2'], { isArchived: true }); }); }); });