Skip to content

High performance self-hosted photo and video management solution.

14.8 KB
Raw Blame
import { BadRequestException } from '@nestjs/common';
import { BulkIdErrorReason } from 'src/dtos/asset-ids.response.dto.js';
import { JobName, JobStatus } from 'src/enum.js';
import { TagService } from 'src/services/tag.service.js';
import { authStub } from 'test/fixtures/auth.stub.js';
import { tagResponseStub, tagStub } from 'test/fixtures/tag.stub.js';
import { ServiceMocks, newTestService } from 'test/utils.js';

describe(TagService.name, () => {
  let sut: TagService;
  let mocks: ServiceMocks;

  beforeEach(() => {
    ({ sut, mocks } = newTestService(TagService));

    mocks.access.tag.checkOwnerAccess.mockResolvedValue(new Set(['tag-1']));
  });

  it('should work', () => {
    expect(sut).toBeDefined();
  });

  describe('getAll', () => {
    it('should return all tags for a user', async () => {
      mocks.tag.getAll.mockResolvedValue([tagStub.tag]);
      await expect(sut.getAll(authStub.admin)).resolves.toEqual([tagResponseStub.tag1]);
      expect(mocks.tag.getAll).toHaveBeenCalledWith(authStub.admin.user.id);
    });
  });

  describe('get', () => {
    it('should throw an error for an invalid id', async () => {
      await expect(sut.get(authStub.admin, 'tag-1')).rejects.toBeInstanceOf(BadRequestException);
      expect(mocks.tag.get).toHaveBeenCalledWith('tag-1');
    });

    it('should return a tag for a user', async () => {
      mocks.tag.get.mockResolvedValue(tagStub.tag);
      await expect(sut.get(authStub.admin, 'tag-1')).resolves.toEqual(tagResponseStub.tag1);
      expect(mocks.tag.get).toHaveBeenCalledWith('tag-1');
    });
  });

  describe('create', () => {
    it('should throw an error for no parent tag access', async () => {
      mocks.access.tag.checkOwnerAccess.mockResolvedValue(new Set());
      await expect(sut.create(authStub.admin, { name: 'tag', parentId: 'tag-parent' })).rejects.toBeInstanceOf(
        BadRequestException,
      );
      expect(mocks.tag.create).not.toHaveBeenCalled();
    });

    it('should create a tag with a parent', async () => {
      mocks.access.tag.checkOwnerAccess.mockResolvedValue(new Set(['tag-parent']));
      mocks.tag.create.mockResolvedValue(tagStub.tagCreate);
      mocks.tag.get.mockResolvedValueOnce(tagStub.parentUpsert);
      mocks.tag.get.mockResolvedValueOnce(tagStub.childUpsert);
      await expect(sut.create(authStub.admin, { name: 'tagA', parentId: 'tag-parent' })).resolves.toBeDefined();
      expect(mocks.tag.create).toHaveBeenCalledWith(expect.objectContaining({ value: 'Parent/tagA' }));
    });

    it('should handle invalid parent ids', async () => {
      mocks.access.tag.checkOwnerAccess.mockResolvedValue(new Set(['tag-parent']));
      await expect(sut.create(authStub.admin, { name: 'tagA', parentId: 'tag-parent' })).rejects.toBeInstanceOf(
        BadRequestException,
      );
      expect(mocks.tag.create).not.toHaveBeenCalled();
    });
  });

  describe('create', () => {
    it('should throw an error for a duplicate tag', async () => {
      mocks.tag.getByValue.mockResolvedValue(tagStub.tag);
      await expect(sut.create(authStub.admin, { name: 'tag-1' })).rejects.toBeInstanceOf(BadRequestException);
      expect(mocks.tag.getByValue).toHaveBeenCalledWith(authStub.admin.user.id, 'tag-1');
      expect(mocks.tag.create).not.toHaveBeenCalled();
    });

    it('should create a new tag', async () => {
      mocks.tag.create.mockResolvedValue(tagStub.tagCreate);
      await expect(sut.create(authStub.admin, { name: 'tag-1' })).resolves.toEqual(tagResponseStub.tag1);
      expect(mocks.tag.create).toHaveBeenCalledWith({
        userId: authStub.admin.user.id,
        value: 'tag-1',
      });
    });

    it('should create a new tag with optional color', async () => {
      mocks.tag.create.mockResolvedValue(tagStub.colorCreate);
      mocks.tag.getByValue.mockResolvedValue(void 0);

      await expect(sut.create(authStub.admin, { name: 'tag-1', color: '#000000' })).resolves.toEqual(
        tagResponseStub.color1,
      );

      expect(mocks.tag.create).toHaveBeenCalledWith({
        userId: authStub.admin.user.id,
        value: 'tag-1',
        color: '#000000',
      });
    });
  });

  describe('update', () => {
    it('should throw an error for no update permission', async () => {
      mocks.access.tag.checkOwnerAccess.mockResolvedValue(new Set());
      await expect(sut.update(authStub.admin, 'tag-1', { name: 'tag', color: '#000000' })).rejects.toBeInstanceOf(
        BadRequestException,
      );
      expect(mocks.tag.update).not.toHaveBeenCalled();
    });

    it('should throw an error if updated tag name has a slash', async () => {
      mocks.access.tag.checkOwnerAccess.mockResolvedValue(new Set(['tag-parent']));
      await expect(sut.update(authStub.admin, 'tag-1', { name: 'tag/test2', color: '#000000' })).rejects.toBeInstanceOf(
        BadRequestException,
      );
      expect(mocks.tag.update).not.toHaveBeenCalled();
    });

    it('should update a tag', async () => {
      mocks.access.tag.checkOwnerAccess.mockResolvedValue(new Set(['tag-1']));
      mocks.tag.update.mockResolvedValue(tagStub.colorCreate);
      mocks.tag.get.mockResolvedValue(tagStub.tag);
      mocks.tag.getAssetIdsByTagId.mockResolvedValue(['asset-1']);
      mocks.asset.getForUpdateTags.mockResolvedValue({ tags: [{ value: 'tag' }] });
      await expect(sut.update(authStub.admin, 'tag-1', { name: 'tag', color: '#000000' })).resolves.toEqual(
        tagResponseStub.color1,
      );
      expect(mocks.tag.getAssetIdsByTagId).toHaveBeenCalledWith('tag-1');
      expect(mocks.tag.update).toHaveBeenCalledWith('tag-1', { value: 'tag', color: '#000000' });
      expect(mocks.asset.upsertExif).toHaveBeenCalledWith({
        exif: { assetId: 'asset-1', lockedProperties: ['tags'], tags: ['tag'] },
        lockedPropertiesBehavior: 'append',
      });
      expect(mocks.job.queueAll).toHaveBeenCalledWith([{ name: JobName.SidecarWrite, data: { id: 'asset-1' } }]);
    });

    it('should not sync assets when only the tag color changes', async () => {
      mocks.access.tag.checkOwnerAccess.mockResolvedValue(new Set(['tag-1']));
      mocks.tag.update.mockResolvedValue(tagStub.colorCreate);
      mocks.tag.get.mockResolvedValue(tagStub.tag);

      await sut.update(authStub.admin, 'tag-1', { color: '#000000' });

      expect(mocks.tag.getAssetIdsByTagId).not.toHaveBeenCalled();
      expect(mocks.asset.upsertExif).not.toHaveBeenCalled();
      expect(mocks.job.queueAll).not.toHaveBeenCalled();
    });
  });

  describe('upsert', () => {
    it('should upsert a new tag', async () => {
      mocks.tag.upsertValue.mockResolvedValue(tagStub.parentUpsert);
      await expect(sut.upsert(authStub.admin, { tags: ['Parent'] })).resolves.toBeDefined();
      expect(mocks.tag.upsertValue).toHaveBeenCalledWith({
        value: 'Parent',
        userId: 'admin_id',
        parentId: undefined,
      });
    });

    it('should upsert a nested tag', async () => {
      mocks.tag.upsertValue.mockResolvedValueOnce(tagStub.parentUpsert);
      mocks.tag.upsertValue.mockResolvedValueOnce(tagStub.childUpsert);
      await expect(sut.upsert(authStub.admin, { tags: ['Parent/Child'] })).resolves.toBeDefined();
      expect(mocks.tag.upsertValue).toHaveBeenNthCalledWith(1, {
        value: 'Parent',
        userId: 'admin_id',
        parentId: undefined,
      });
      expect(mocks.tag.upsertValue).toHaveBeenNthCalledWith(2, {
        value: 'Parent/Child',
        userId: 'admin_id',
        parentId: 'tag-parent',
      });
    });

    it('should upsert a tag and ignore leading and trailing slashes', async () => {
      mocks.tag.upsertValue.mockResolvedValueOnce(tagStub.parentUpsert);
      mocks.tag.upsertValue.mockResolvedValueOnce(tagStub.childUpsert);
      await expect(sut.upsert(authStub.admin, { tags: ['/Parent/Child/'] })).resolves.toBeDefined();
      expect(mocks.tag.upsertValue).toHaveBeenNthCalledWith(1, {
        value: 'Parent',
        userId: 'admin_id',
        parentId: undefined,
      });
      expect(mocks.tag.upsertValue).toHaveBeenNthCalledWith(2, {
        value: 'Parent/Child',
        userId: 'admin_id',
        parentId: 'tag-parent',
      });
    });
  });

  describe('remove', () => {
    it('should throw an error for an invalid id', async () => {
      mocks.access.tag.checkOwnerAccess.mockResolvedValue(new Set());
      await expect(sut.remove(authStub.admin, 'tag-1')).rejects.toBeInstanceOf(BadRequestException);
      expect(mocks.tag.delete).not.toHaveBeenCalled();
    });

    it('should remove a tag', async () => {
      mocks.tag.get.mockResolvedValue(tagStub.tag);
      mocks.tag.delete.mockResolvedValue();
      mocks.tag.getAssetIdsByTagId.mockResolvedValue(['asset-1']);
      mocks.asset.getForUpdateTags.mockResolvedValue({ tags: [] });

      await sut.remove(authStub.admin, 'tag-1');
      expect(mocks.tag.getAssetIdsByTagId).toHaveBeenCalledWith('tag-1');
      expect(mocks.tag.delete).toHaveBeenCalledWith('tag-1');
      expect(mocks.asset.upsertExif).toHaveBeenCalledWith({
        exif: { assetId: 'asset-1', lockedProperties: ['tags'], tags: [] },
        lockedPropertiesBehavior: 'append',
      });
      expect(mocks.job.queueAll).toHaveBeenCalledWith([{ name: JobName.SidecarWrite, data: { id: 'asset-1' } }]);
    });
  });

  describe('bulkTagAssets', () => {
    it('should handle invalid requests', async () => {
      mocks.access.tag.checkOwnerAccess.mockResolvedValue(new Set());
      mocks.tag.upsertAssetIds.mockResolvedValue([]);
      await expect(sut.bulkTagAssets(authStub.admin, { tagIds: ['tag-1'], assetIds: ['asset-1'] })).resolves.toEqual({
        count: 0,
      });
      expect(mocks.tag.upsertAssetIds).toHaveBeenCalledWith([]);
    });

    it('should upsert records', async () => {
      mocks.access.tag.checkOwnerAccess.mockResolvedValue(new Set(['tag-1', 'tag-2']));
      mocks.access.asset.checkOwnerAccess.mockResolvedValue(new Set(['asset-1', 'asset-2', 'asset-3']));
      mocks.asset.getForUpdateTags.mockResolvedValue({ tags: [{ value: 'tag-1' }, { value: 'tag-2' }] });
      mocks.tag.upsertAssetIds.mockResolvedValue([
        { tagId: 'tag-1', assetId: 'asset-1' },
        { tagId: 'tag-1', assetId: 'asset-2' },
        { tagId: 'tag-1', assetId: 'asset-3' },
        { tagId: 'tag-2', assetId: 'asset-1' },
        { tagId: 'tag-2', assetId: 'asset-2' },
        { tagId: 'tag-2', assetId: 'asset-3' },
      ]);
      await expect(
        sut.bulkTagAssets(authStub.admin, { tagIds: ['tag-1', 'tag-2'], assetIds: ['asset-1', 'asset-2', 'asset-3'] }),
      ).resolves.toEqual({
        count: 6,
      });
      expect(mocks.asset.upsertExif).toHaveBeenCalledWith(
        expect.objectContaining({
          exif: { assetId: 'asset-1', lockedProperties: ['tags'], tags: ['tag-1', 'tag-2'] },
          lockedPropertiesBehavior: 'append',
        }),
      );
      expect(mocks.asset.upsertExif).toHaveBeenCalledWith(
        expect.objectContaining({
          exif: { assetId: 'asset-2', lockedProperties: ['tags'], tags: ['tag-1', 'tag-2'] },
          lockedPropertiesBehavior: 'append',
        }),
      );
      expect(mocks.asset.upsertExif).toHaveBeenCalledWith(
        expect.objectContaining({
          exif: { assetId: 'asset-3', lockedProperties: ['tags'], tags: ['tag-1', 'tag-2'] },
          lockedPropertiesBehavior: 'append',
        }),
      );
      expect(mocks.tag.upsertAssetIds).toHaveBeenCalledWith([
        { tagId: 'tag-1', assetId: 'asset-1' },
        { tagId: 'tag-1', assetId: 'asset-2' },
        { tagId: 'tag-1', assetId: 'asset-3' },
        { tagId: 'tag-2', assetId: 'asset-1' },
        { tagId: 'tag-2', assetId: 'asset-2' },
        { tagId: 'tag-2', assetId: 'asset-3' },
      ]);
    });
  });

  describe('addAssets', () => {
    it('should handle invalid ids', async () => {
      mocks.tag.getAssetIds.mockResolvedValue(new Set());
      await expect(sut.addAssets(authStub.admin, 'tag-1', { ids: ['asset-1'] })).resolves.toEqual([
        { id: 'asset-1', success: false, error: 'no_permission' },
      ]);
      expect(mocks.tag.getAssetIds).toHaveBeenCalledWith('tag-1', ['asset-1']);
      expect(mocks.tag.addAssetIds).not.toHaveBeenCalled();
    });

    it('should accept accept ids that are new and reject the rest', async () => {
      mocks.tag.get.mockResolvedValue(tagStub.tag);
      mocks.tag.getAssetIds.mockResolvedValue(new Set(['asset-1']));
      mocks.tag.addAssetIds.mockResolvedValue();
      mocks.asset.getForUpdateTags.mockResolvedValue({ tags: [{ value: 'tag-1' }] });
      mocks.access.asset.checkOwnerAccess.mockResolvedValue(new Set(['asset-2']));

      await expect(
        sut.addAssets(authStub.admin, 'tag-1', {
          ids: ['asset-1', 'asset-2'],
        }),
      ).resolves.toEqual([
        { id: 'asset-1', success: false, error: BulkIdErrorReason.DUPLICATE },
        { id: 'asset-2', success: true },
      ]);

      expect(mocks.asset.upsertExif).not.toHaveBeenCalledWith(
        expect.objectContaining({
          exif: { assetId: 'asset-1', lockedProperties: ['tags'], tags: ['tag-1'] },
          lockedPropertiesBehavior: 'append',
        }),
      );
      expect(mocks.asset.upsertExif).toHaveBeenCalledWith(
        expect.objectContaining({
          exif: { assetId: 'asset-2', lockedProperties: ['tags'], tags: ['tag-1'] },
          lockedPropertiesBehavior: 'append',
        }),
      );
      expect(mocks.tag.getAssetIds).toHaveBeenCalledWith('tag-1', ['asset-1', 'asset-2']);
      expect(mocks.tag.addAssetIds).toHaveBeenCalledWith('tag-1', ['asset-2']);
    });
  });

  describe('removeAssets', () => {
    it('should throw an error for an invalid id', async () => {
      mocks.tag.getAssetIds.mockResolvedValue(new Set());
      mocks.tag.removeAssetIds.mockResolvedValue();
      mocks.asset.getForUpdateTags.mockResolvedValue({ tags: [] });

      await expect(sut.removeAssets(authStub.admin, 'tag-1', { ids: ['asset-1'] })).resolves.toEqual([
        { id: 'asset-1', success: false, error: 'not_found' },
      ]);
    });

    it('should accept accept ids that are tagged and reject the rest', async () => {
      mocks.tag.get.mockResolvedValue(tagStub.tag);
      mocks.tag.getAssetIds.mockResolvedValue(new Set(['asset-1']));
      mocks.tag.removeAssetIds.mockResolvedValue();
      mocks.asset.getForUpdateTags.mockResolvedValue({ tags: [] });

      await expect(
        sut.removeAssets(authStub.admin, 'tag-1', {
          ids: ['asset-1', 'asset-2'],
        }),
      ).resolves.toEqual([
        { id: 'asset-1', success: true },
        { id: 'asset-2', success: false, error: BulkIdErrorReason.NOT_FOUND },
      ]);

      expect(mocks.tag.getAssetIds).toHaveBeenCalledWith('tag-1', ['asset-1', 'asset-2']);
      expect(mocks.tag.removeAssetIds).toHaveBeenCalledWith('tag-1', ['asset-1']);
    });
  });

  describe('handleTagCleanup', () => {
    it('should delete empty tags', async () => {
      mocks.tag.deleteEmptyTags.mockResolvedValue();

      await expect(sut.handleTagCleanup()).resolves.toBe(JobStatus.Success);

      expect(mocks.tag.deleteEmptyTags).toHaveBeenCalled();
    });
  });
});