mirror of
https://github.com/immich-app/immich.git
synced 2026-03-23 04:19:10 +03:00
1262 lines
53 KiB
TypeScript
1262 lines
53 KiB
TypeScript
import { BadRequestException, NotFoundException } from '@nestjs/common';
|
|
import { BulkIdErrorReason } from 'src/dtos/asset-ids.response.dto';
|
|
import { mapFaces, mapPerson } from 'src/dtos/person.dto';
|
|
import { AssetFileType, CacheControl, JobName, JobStatus, SourceType, SystemMetadataKey } from 'src/enum';
|
|
import { FaceSearchResult } from 'src/repositories/search.repository';
|
|
import { PersonService } from 'src/services/person.service';
|
|
import { ImmichFileResponse } from 'src/utils/file';
|
|
import { AssetFaceFactory } from 'test/factories/asset-face.factory';
|
|
import { AssetFactory } from 'test/factories/asset.factory';
|
|
import { AuthFactory } from 'test/factories/auth.factory';
|
|
import { PersonFactory } from 'test/factories/person.factory';
|
|
import { UserFactory } from 'test/factories/user.factory';
|
|
import { authStub } from 'test/fixtures/auth.stub';
|
|
import { systemConfigStub } from 'test/fixtures/system-config.stub';
|
|
import { getAsDetectedFace, getForFacialRecognitionJob } from 'test/mappers';
|
|
import { newDate, newUuid } from 'test/small.factory';
|
|
import { makeStream, newTestService, ServiceMocks } from 'test/utils';
|
|
|
|
describe(PersonService.name, () => {
|
|
let sut: PersonService;
|
|
let mocks: ServiceMocks;
|
|
|
|
beforeEach(() => {
|
|
({ sut, mocks } = newTestService(PersonService));
|
|
});
|
|
|
|
it('should be defined', () => {
|
|
expect(sut).toBeDefined();
|
|
});
|
|
|
|
describe('getAll', () => {
|
|
it('should get all hidden and visible people with thumbnails', async () => {
|
|
const auth = AuthFactory.create();
|
|
const [person, hiddenPerson] = [PersonFactory.create(), PersonFactory.create({ isHidden: true })];
|
|
|
|
mocks.person.getAllForUser.mockResolvedValue({
|
|
items: [person, hiddenPerson],
|
|
hasNextPage: false,
|
|
});
|
|
mocks.person.getNumberOfPeople.mockResolvedValue({ total: 2, hidden: 1 });
|
|
await expect(sut.getAll(auth, { withHidden: true, page: 1, size: 10 })).resolves.toEqual({
|
|
hasNextPage: false,
|
|
total: 2,
|
|
hidden: 1,
|
|
people: [
|
|
expect.objectContaining({ id: person.id, isHidden: false }),
|
|
expect.objectContaining({
|
|
id: hiddenPerson.id,
|
|
isHidden: true,
|
|
}),
|
|
],
|
|
});
|
|
expect(mocks.person.getAllForUser).toHaveBeenCalledWith({ skip: 0, take: 10 }, auth.user.id, {
|
|
minimumFaceCount: 3,
|
|
withHidden: true,
|
|
});
|
|
});
|
|
|
|
it('should get all visible people and favorites should be first in the array', async () => {
|
|
const auth = AuthFactory.create();
|
|
const [isFavorite, person] = [PersonFactory.create({ isFavorite: true }), PersonFactory.create()];
|
|
|
|
mocks.person.getAllForUser.mockResolvedValue({
|
|
items: [isFavorite, person],
|
|
hasNextPage: false,
|
|
});
|
|
mocks.person.getNumberOfPeople.mockResolvedValue({ total: 2, hidden: 1 });
|
|
await expect(sut.getAll(auth, { withHidden: false, page: 1, size: 10 })).resolves.toEqual({
|
|
hasNextPage: false,
|
|
total: 2,
|
|
hidden: 1,
|
|
people: [
|
|
expect.objectContaining({
|
|
id: isFavorite.id,
|
|
isFavorite: true,
|
|
}),
|
|
expect.objectContaining({ id: person.id, isFavorite: false }),
|
|
],
|
|
});
|
|
expect(mocks.person.getAllForUser).toHaveBeenCalledWith({ skip: 0, take: 10 }, auth.user.id, {
|
|
minimumFaceCount: 3,
|
|
withHidden: false,
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('getById', () => {
|
|
it('should require person.read permission', async () => {
|
|
const auth = AuthFactory.create();
|
|
const person = PersonFactory.create();
|
|
mocks.person.getById.mockResolvedValue(person);
|
|
await expect(sut.getById(auth, person.id)).rejects.toBeInstanceOf(BadRequestException);
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
|
|
it('should throw a bad request when person is not found', async () => {
|
|
const auth = AuthFactory.create();
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set(['unknown']));
|
|
await expect(sut.getById(auth, 'unknown')).rejects.toBeInstanceOf(BadRequestException);
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set(['unknown']));
|
|
});
|
|
|
|
it('should get a person by id', async () => {
|
|
const auth = AuthFactory.create();
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.person.getById.mockResolvedValue(person);
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set([person.id]));
|
|
await expect(sut.getById(auth, person.id)).resolves.toEqual(expect.objectContaining({ id: person.id }));
|
|
expect(mocks.person.getById).toHaveBeenCalledWith(person.id);
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
});
|
|
|
|
describe('getThumbnail', () => {
|
|
it('should require person.read permission', async () => {
|
|
const auth = AuthFactory.create();
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.person.getById.mockResolvedValue(person);
|
|
await expect(sut.getThumbnail(auth, person.id)).rejects.toBeInstanceOf(BadRequestException);
|
|
expect(mocks.storage.createReadStream).not.toHaveBeenCalled();
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
|
|
it('should throw an error when personId is invalid', async () => {
|
|
const auth = AuthFactory.create();
|
|
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set(['unknown']));
|
|
await expect(sut.getThumbnail(auth, 'unknown')).rejects.toBeInstanceOf(NotFoundException);
|
|
expect(mocks.storage.createReadStream).not.toHaveBeenCalled();
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set(['unknown']));
|
|
});
|
|
|
|
it('should throw an error when person has no thumbnail', async () => {
|
|
const auth = AuthFactory.create();
|
|
const person = PersonFactory.create({ thumbnailPath: '' });
|
|
|
|
mocks.person.getById.mockResolvedValue(person);
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set([person.id]));
|
|
await expect(sut.getThumbnail(auth, person.id)).rejects.toBeInstanceOf(NotFoundException);
|
|
expect(mocks.storage.createReadStream).not.toHaveBeenCalled();
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
|
|
it('should serve the thumbnail', async () => {
|
|
const auth = AuthFactory.create();
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.person.getById.mockResolvedValue(person);
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set([person.id]));
|
|
await expect(sut.getThumbnail(auth, person.id)).resolves.toEqual(
|
|
new ImmichFileResponse({
|
|
path: person.thumbnailPath,
|
|
contentType: 'image/jpeg',
|
|
cacheControl: CacheControl.PrivateWithoutCache,
|
|
}),
|
|
);
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
});
|
|
|
|
describe('update', () => {
|
|
it('should require person.write permission', async () => {
|
|
const auth = AuthFactory.create();
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.person.getById.mockResolvedValue(person);
|
|
await expect(sut.update(auth, person.id, { name: 'Person 1' })).rejects.toBeInstanceOf(BadRequestException);
|
|
expect(mocks.person.update).not.toHaveBeenCalled();
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
|
|
it('should throw an error when personId is invalid', async () => {
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set());
|
|
await expect(sut.update(authStub.admin, 'person-1', { name: 'Person 1' })).rejects.toBeInstanceOf(
|
|
BadRequestException,
|
|
);
|
|
expect(mocks.person.update).not.toHaveBeenCalled();
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(authStub.admin.user.id, new Set(['person-1']));
|
|
});
|
|
|
|
it("should update a person's name", async () => {
|
|
const auth = AuthFactory.create();
|
|
const person = PersonFactory.create({ name: 'Person 1' });
|
|
|
|
mocks.person.update.mockResolvedValue(person);
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set([person.id]));
|
|
|
|
await expect(sut.update(auth, person.id, { name: 'Person 1' })).resolves.toEqual(
|
|
expect.objectContaining({ id: person.id, name: 'Person 1' }),
|
|
);
|
|
|
|
expect(mocks.person.update).toHaveBeenCalledWith({ id: person.id, name: 'Person 1' });
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
|
|
it("should update a person's date of birth", async () => {
|
|
const auth = AuthFactory.create();
|
|
const person = PersonFactory.create({ birthDate: new Date('1976-06-30') });
|
|
|
|
mocks.person.update.mockResolvedValue(person);
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set([person.id]));
|
|
|
|
await expect(sut.update(auth, person.id, { birthDate: new Date('1976-06-30') })).resolves.toEqual({
|
|
id: person.id,
|
|
name: person.name,
|
|
birthDate: '1976-06-30',
|
|
thumbnailPath: person.thumbnailPath,
|
|
isHidden: false,
|
|
isFavorite: false,
|
|
updatedAt: expect.any(Date),
|
|
});
|
|
expect(mocks.person.update).toHaveBeenCalledWith({ id: person.id, birthDate: new Date('1976-06-30') });
|
|
expect(mocks.job.queue).not.toHaveBeenCalled();
|
|
expect(mocks.job.queueAll).not.toHaveBeenCalled();
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
|
|
it('should update a person visibility', async () => {
|
|
const auth = AuthFactory.create();
|
|
const person = PersonFactory.create({ isHidden: true });
|
|
|
|
mocks.person.update.mockResolvedValue(person);
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set([person.id]));
|
|
|
|
await expect(sut.update(auth, person.id, { isHidden: true })).resolves.toEqual(
|
|
expect.objectContaining({ isHidden: true }),
|
|
);
|
|
|
|
expect(mocks.person.update).toHaveBeenCalledWith({ id: person.id, isHidden: true });
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
|
|
it('should update a person favorite status', async () => {
|
|
const auth = AuthFactory.create();
|
|
const person = PersonFactory.create({ isFavorite: true });
|
|
|
|
mocks.person.update.mockResolvedValue(person);
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set([person.id]));
|
|
|
|
await expect(sut.update(auth, person.id, { isFavorite: true })).resolves.toEqual(
|
|
expect.objectContaining({ isFavorite: true }),
|
|
);
|
|
|
|
expect(mocks.person.update).toHaveBeenCalledWith({ id: person.id, isFavorite: true });
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
|
|
it("should update a person's thumbnailPath", async () => {
|
|
const face = AssetFaceFactory.create();
|
|
const auth = AuthFactory.create();
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.person.update.mockResolvedValue(person);
|
|
mocks.person.getForFeatureFaceUpdate.mockResolvedValue(face);
|
|
mocks.access.asset.checkOwnerAccess.mockResolvedValue(new Set([face.assetId]));
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set([person.id]));
|
|
|
|
await expect(sut.update(auth, person.id, { featureFaceAssetId: face.assetId })).resolves.toEqual(
|
|
expect.objectContaining({ id: person.id }),
|
|
);
|
|
|
|
expect(mocks.person.update).toHaveBeenCalledWith({ id: person.id, faceAssetId: face.id });
|
|
expect(mocks.person.getForFeatureFaceUpdate).toHaveBeenCalledWith({
|
|
assetId: face.assetId,
|
|
personId: person.id,
|
|
});
|
|
expect(mocks.job.queue).toHaveBeenCalledWith({
|
|
name: JobName.PersonGenerateThumbnail,
|
|
data: { id: person.id },
|
|
});
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
|
|
it('should throw an error when the face feature assetId is invalid', async () => {
|
|
const auth = AuthFactory.create();
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.person.getById.mockResolvedValue(person);
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set([person.id]));
|
|
|
|
await expect(sut.update(auth, person.id, { featureFaceAssetId: '-1' })).rejects.toThrow(BadRequestException);
|
|
expect(mocks.person.update).not.toHaveBeenCalled();
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
});
|
|
|
|
describe('updateAll', () => {
|
|
it('should throw an error when personId is invalid', async () => {
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set());
|
|
|
|
await expect(sut.updateAll(authStub.admin, { people: [{ id: 'person-1', name: 'Person 1' }] })).resolves.toEqual([
|
|
{ error: BulkIdErrorReason.UNKNOWN, id: 'person-1', success: false },
|
|
]);
|
|
expect(mocks.person.update).not.toHaveBeenCalled();
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(authStub.admin.user.id, new Set(['person-1']));
|
|
});
|
|
});
|
|
|
|
describe('reassignFaces', () => {
|
|
it('should throw an error if user has no access to the person', async () => {
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set());
|
|
|
|
await expect(
|
|
sut.reassignFaces(AuthFactory.create(), 'person-id', {
|
|
data: [{ personId: 'asset-face-1', assetId: '' }],
|
|
}),
|
|
).rejects.toBeInstanceOf(BadRequestException);
|
|
expect(mocks.job.queue).not.toHaveBeenCalledWith();
|
|
expect(mocks.job.queueAll).not.toHaveBeenCalledWith();
|
|
});
|
|
|
|
it('should reassign a face', async () => {
|
|
const face = AssetFaceFactory.create();
|
|
const auth = AuthFactory.create();
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set([person.id]));
|
|
mocks.person.getById.mockResolvedValue(person);
|
|
mocks.access.person.checkFaceOwnerAccess.mockResolvedValue(new Set([face.id]));
|
|
mocks.person.getFacesByIds.mockResolvedValue([face]);
|
|
mocks.person.reassignFace.mockResolvedValue(1);
|
|
mocks.person.getRandomFace.mockResolvedValue(AssetFaceFactory.create());
|
|
mocks.person.refreshFaces.mockResolvedValue();
|
|
mocks.person.reassignFace.mockResolvedValue(5);
|
|
mocks.person.update.mockResolvedValue(person);
|
|
|
|
await expect(
|
|
sut.reassignFaces(auth, person.id, {
|
|
data: [{ personId: person.id, assetId: face.assetId }],
|
|
}),
|
|
).resolves.toBeDefined();
|
|
|
|
expect(mocks.job.queueAll).toHaveBeenCalledWith([
|
|
{
|
|
name: JobName.PersonGenerateThumbnail,
|
|
data: { id: person.id },
|
|
},
|
|
]);
|
|
});
|
|
});
|
|
|
|
describe('handlePersonMigration', () => {
|
|
it('should not move person files', async () => {
|
|
await expect(sut.handlePersonMigration(PersonFactory.create())).resolves.toBe(JobStatus.Failed);
|
|
});
|
|
});
|
|
|
|
describe('getFacesById', () => {
|
|
it('should get the bounding boxes for an asset', async () => {
|
|
const auth = AuthFactory.create();
|
|
const face = AssetFaceFactory.create();
|
|
const asset = AssetFactory.from({ id: face.assetId }).exif().build();
|
|
mocks.access.asset.checkOwnerAccess.mockResolvedValue(new Set([asset.id]));
|
|
mocks.person.getFaces.mockResolvedValue([face]);
|
|
mocks.asset.getForFaces.mockResolvedValue({ edits: [], ...asset.exifInfo });
|
|
await expect(sut.getFacesById(auth, { id: face.assetId })).resolves.toStrictEqual([mapFaces(face, auth)]);
|
|
});
|
|
|
|
it('should reject if the user has not access to the asset', async () => {
|
|
const face = AssetFaceFactory.create();
|
|
mocks.access.asset.checkOwnerAccess.mockResolvedValue(new Set());
|
|
mocks.person.getFaces.mockResolvedValue([face]);
|
|
await expect(sut.getFacesById(AuthFactory.create(), { id: face.assetId })).rejects.toBeInstanceOf(
|
|
BadRequestException,
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('createNewFeaturePhoto', () => {
|
|
it('should change person feature photo', async () => {
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.person.getRandomFace.mockResolvedValue(AssetFaceFactory.create());
|
|
await sut.createNewFeaturePhoto([person.id]);
|
|
expect(mocks.job.queueAll).toHaveBeenCalledWith([
|
|
{
|
|
name: JobName.PersonGenerateThumbnail,
|
|
data: { id: person.id },
|
|
},
|
|
]);
|
|
});
|
|
});
|
|
|
|
describe('reassignFacesById', () => {
|
|
it('should create a new person', async () => {
|
|
const face = AssetFaceFactory.create();
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set([person.id]));
|
|
mocks.access.person.checkFaceOwnerAccess.mockResolvedValue(new Set([face.id]));
|
|
mocks.person.getFaceById.mockResolvedValue(face);
|
|
mocks.person.reassignFace.mockResolvedValue(1);
|
|
mocks.person.getById.mockResolvedValue(person);
|
|
await expect(sut.reassignFacesById(AuthFactory.create(), person.id, { id: face.id })).resolves.toEqual({
|
|
birthDate: person.birthDate,
|
|
isHidden: person.isHidden,
|
|
isFavorite: person.isFavorite,
|
|
id: person.id,
|
|
name: person.name,
|
|
thumbnailPath: person.thumbnailPath,
|
|
updatedAt: expect.any(Date),
|
|
});
|
|
|
|
expect(mocks.job.queue).not.toHaveBeenCalledWith();
|
|
expect(mocks.job.queueAll).not.toHaveBeenCalledWith();
|
|
});
|
|
|
|
it('should fail if user has not the correct permissions on the asset', async () => {
|
|
const face = AssetFaceFactory.create();
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set([person.id]));
|
|
mocks.person.getFaceById.mockResolvedValue(face);
|
|
mocks.person.reassignFace.mockResolvedValue(1);
|
|
mocks.person.getById.mockResolvedValue(person);
|
|
await expect(
|
|
sut.reassignFacesById(AuthFactory.create(), person.id, {
|
|
id: face.id,
|
|
}),
|
|
).rejects.toBeInstanceOf(BadRequestException);
|
|
|
|
expect(mocks.job.queue).not.toHaveBeenCalledWith();
|
|
expect(mocks.job.queueAll).not.toHaveBeenCalledWith();
|
|
});
|
|
});
|
|
|
|
describe('createPerson', () => {
|
|
it('should create a new person', async () => {
|
|
const auth = AuthFactory.create();
|
|
|
|
mocks.person.create.mockResolvedValue(PersonFactory.create());
|
|
await expect(sut.create(auth, {})).resolves.toBeDefined();
|
|
|
|
expect(mocks.person.create).toHaveBeenCalledWith({ ownerId: auth.user.id });
|
|
});
|
|
});
|
|
|
|
describe('handlePersonCleanup', () => {
|
|
it('should delete people without faces', async () => {
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.person.getAllWithoutFaces.mockResolvedValue([person]);
|
|
|
|
await sut.handlePersonCleanup();
|
|
|
|
expect(mocks.person.delete).toHaveBeenCalledWith([person.id]);
|
|
expect(mocks.storage.unlink).toHaveBeenCalledWith(person.thumbnailPath);
|
|
});
|
|
});
|
|
|
|
describe('handleQueueDetectFaces', () => {
|
|
it('should skip if machine learning is disabled', async () => {
|
|
mocks.systemMetadata.get.mockResolvedValue(systemConfigStub.machineLearningDisabled);
|
|
|
|
await expect(sut.handleQueueDetectFaces({})).resolves.toBe(JobStatus.Skipped);
|
|
expect(mocks.job.queue).not.toHaveBeenCalled();
|
|
expect(mocks.job.queueAll).not.toHaveBeenCalled();
|
|
expect(mocks.systemMetadata.get).toHaveBeenCalled();
|
|
});
|
|
|
|
it('should queue missing assets', async () => {
|
|
const asset = AssetFactory.create();
|
|
mocks.assetJob.streamForDetectFacesJob.mockReturnValue(makeStream([asset]));
|
|
|
|
await sut.handleQueueDetectFaces({ force: false });
|
|
|
|
expect(mocks.assetJob.streamForDetectFacesJob).toHaveBeenCalledWith(false);
|
|
expect(mocks.person.vacuum).not.toHaveBeenCalled();
|
|
expect(mocks.job.queueAll).toHaveBeenCalledWith([
|
|
{
|
|
name: JobName.AssetDetectFaces,
|
|
data: { id: asset.id },
|
|
},
|
|
]);
|
|
});
|
|
|
|
it('should queue all assets', async () => {
|
|
const asset = AssetFactory.create();
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.assetJob.streamForDetectFacesJob.mockReturnValue(makeStream([asset]));
|
|
mocks.person.getAllWithoutFaces.mockResolvedValue([person]);
|
|
|
|
await sut.handleQueueDetectFaces({ force: true });
|
|
|
|
expect(mocks.person.deleteFaces).toHaveBeenCalledWith({ sourceType: SourceType.MachineLearning });
|
|
expect(mocks.person.delete).toHaveBeenCalledWith([person.id]);
|
|
expect(mocks.person.vacuum).toHaveBeenCalledWith({ reindexVectors: true });
|
|
expect(mocks.storage.unlink).toHaveBeenCalledWith(person.thumbnailPath);
|
|
expect(mocks.assetJob.streamForDetectFacesJob).toHaveBeenCalledWith(true);
|
|
expect(mocks.job.queueAll).toHaveBeenCalledWith([
|
|
{
|
|
name: JobName.AssetDetectFaces,
|
|
data: { id: asset.id },
|
|
},
|
|
]);
|
|
});
|
|
|
|
it('should refresh all assets', async () => {
|
|
const asset = AssetFactory.create();
|
|
mocks.assetJob.streamForDetectFacesJob.mockReturnValue(makeStream([asset]));
|
|
|
|
await sut.handleQueueDetectFaces({ force: undefined });
|
|
|
|
expect(mocks.person.delete).not.toHaveBeenCalled();
|
|
expect(mocks.person.deleteFaces).not.toHaveBeenCalled();
|
|
expect(mocks.person.vacuum).not.toHaveBeenCalled();
|
|
expect(mocks.storage.unlink).not.toHaveBeenCalled();
|
|
expect(mocks.assetJob.streamForDetectFacesJob).toHaveBeenCalledWith(undefined);
|
|
expect(mocks.job.queueAll).toHaveBeenCalledWith([
|
|
{
|
|
name: JobName.AssetDetectFaces,
|
|
data: { id: asset.id },
|
|
},
|
|
]);
|
|
expect(mocks.job.queue).toHaveBeenCalledWith({ name: JobName.PersonCleanup });
|
|
});
|
|
|
|
it('should delete existing people and faces if forced', async () => {
|
|
const asset = AssetFactory.create();
|
|
const face = AssetFaceFactory.from().person().build();
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.person.getAll.mockReturnValue(makeStream([face.person!, person]));
|
|
mocks.person.getAllFaces.mockReturnValue(makeStream([face]));
|
|
mocks.assetJob.streamForDetectFacesJob.mockReturnValue(makeStream([asset]));
|
|
mocks.person.getAllWithoutFaces.mockResolvedValue([person]);
|
|
mocks.person.deleteFaces.mockResolvedValue();
|
|
|
|
await sut.handleQueueDetectFaces({ force: true });
|
|
|
|
expect(mocks.assetJob.streamForDetectFacesJob).toHaveBeenCalledWith(true);
|
|
expect(mocks.job.queueAll).toHaveBeenCalledWith([
|
|
{
|
|
name: JobName.AssetDetectFaces,
|
|
data: { id: asset.id },
|
|
},
|
|
]);
|
|
expect(mocks.person.delete).toHaveBeenCalledWith([person.id]);
|
|
expect(mocks.storage.unlink).toHaveBeenCalledWith(person.thumbnailPath);
|
|
expect(mocks.person.vacuum).toHaveBeenCalledWith({ reindexVectors: true });
|
|
});
|
|
});
|
|
|
|
describe('handleQueueRecognizeFaces', () => {
|
|
it('should skip if machine learning is disabled', async () => {
|
|
mocks.job.getJobCounts.mockResolvedValue({
|
|
active: 1,
|
|
waiting: 0,
|
|
paused: 0,
|
|
completed: 0,
|
|
failed: 0,
|
|
delayed: 0,
|
|
});
|
|
mocks.systemMetadata.get.mockResolvedValue(systemConfigStub.machineLearningDisabled);
|
|
|
|
await expect(sut.handleQueueRecognizeFaces({})).resolves.toBe(JobStatus.Skipped);
|
|
expect(mocks.job.queueAll).not.toHaveBeenCalled();
|
|
expect(mocks.systemMetadata.get).toHaveBeenCalled();
|
|
expect(mocks.systemMetadata.set).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should skip if recognition jobs are already queued', async () => {
|
|
mocks.job.getJobCounts.mockResolvedValue({
|
|
active: 1,
|
|
waiting: 1,
|
|
paused: 0,
|
|
completed: 0,
|
|
failed: 0,
|
|
delayed: 0,
|
|
});
|
|
|
|
await expect(sut.handleQueueRecognizeFaces({})).resolves.toBe(JobStatus.Skipped);
|
|
expect(mocks.job.queueAll).not.toHaveBeenCalled();
|
|
expect(mocks.systemMetadata.set).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should queue missing assets', async () => {
|
|
const face = AssetFaceFactory.create();
|
|
mocks.job.getJobCounts.mockResolvedValue({
|
|
active: 1,
|
|
waiting: 0,
|
|
paused: 0,
|
|
completed: 0,
|
|
failed: 0,
|
|
delayed: 0,
|
|
});
|
|
mocks.person.getAllFaces.mockReturnValue(makeStream([face]));
|
|
mocks.person.getAllWithoutFaces.mockResolvedValue([]);
|
|
|
|
await sut.handleQueueRecognizeFaces({});
|
|
|
|
expect(mocks.person.getAllFaces).toHaveBeenCalledWith({
|
|
personId: null,
|
|
sourceType: SourceType.MachineLearning,
|
|
});
|
|
expect(mocks.job.queueAll).toHaveBeenCalledWith([
|
|
{
|
|
name: JobName.FacialRecognition,
|
|
data: { id: face.id, deferred: false },
|
|
},
|
|
]);
|
|
expect(mocks.systemMetadata.set).toHaveBeenCalledWith(SystemMetadataKey.FacialRecognitionState, {
|
|
lastRun: expect.any(String),
|
|
});
|
|
expect(mocks.person.vacuum).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should queue all assets', async () => {
|
|
const face = AssetFaceFactory.create();
|
|
mocks.job.getJobCounts.mockResolvedValue({
|
|
active: 1,
|
|
waiting: 0,
|
|
paused: 0,
|
|
completed: 0,
|
|
failed: 0,
|
|
delayed: 0,
|
|
});
|
|
mocks.person.getAll.mockReturnValue(makeStream());
|
|
mocks.person.getAllFaces.mockReturnValue(makeStream([face]));
|
|
mocks.person.getAllWithoutFaces.mockResolvedValue([]);
|
|
|
|
await sut.handleQueueRecognizeFaces({ force: true });
|
|
|
|
expect(mocks.person.getAllFaces).toHaveBeenCalledWith(undefined);
|
|
expect(mocks.job.queueAll).toHaveBeenCalledWith([
|
|
{
|
|
name: JobName.FacialRecognition,
|
|
data: { id: face.id, deferred: false },
|
|
},
|
|
]);
|
|
expect(mocks.systemMetadata.set).toHaveBeenCalledWith(SystemMetadataKey.FacialRecognitionState, {
|
|
lastRun: expect.any(String),
|
|
});
|
|
expect(mocks.person.vacuum).toHaveBeenCalledWith({ reindexVectors: false });
|
|
});
|
|
|
|
it('should run nightly if new face has been added since last run', async () => {
|
|
const face = AssetFaceFactory.create();
|
|
mocks.person.getLatestFaceDate.mockResolvedValue(new Date().toISOString());
|
|
mocks.person.getAllFaces.mockReturnValue(makeStream([face]));
|
|
mocks.job.getJobCounts.mockResolvedValue({
|
|
active: 1,
|
|
waiting: 0,
|
|
paused: 0,
|
|
completed: 0,
|
|
failed: 0,
|
|
delayed: 0,
|
|
});
|
|
mocks.person.getAll.mockReturnValue(makeStream());
|
|
mocks.person.getAllFaces.mockReturnValue(makeStream([face]));
|
|
mocks.person.getAllWithoutFaces.mockResolvedValue([]);
|
|
mocks.person.unassignFaces.mockResolvedValue();
|
|
|
|
await sut.handleQueueRecognizeFaces({ force: false, nightly: true });
|
|
|
|
expect(mocks.systemMetadata.get).toHaveBeenCalledWith(SystemMetadataKey.FacialRecognitionState);
|
|
expect(mocks.person.getLatestFaceDate).toHaveBeenCalledOnce();
|
|
expect(mocks.person.getAllFaces).toHaveBeenCalledWith({
|
|
personId: null,
|
|
sourceType: SourceType.MachineLearning,
|
|
});
|
|
expect(mocks.job.queueAll).toHaveBeenCalledWith([
|
|
{
|
|
name: JobName.FacialRecognition,
|
|
data: { id: face.id, deferred: false },
|
|
},
|
|
]);
|
|
expect(mocks.systemMetadata.set).toHaveBeenCalledWith(SystemMetadataKey.FacialRecognitionState, {
|
|
lastRun: expect.any(String),
|
|
});
|
|
expect(mocks.person.vacuum).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should skip nightly if no new face has been added since last run', async () => {
|
|
const lastRun = new Date();
|
|
|
|
mocks.systemMetadata.get.mockResolvedValue({ lastRun: lastRun.toISOString() });
|
|
mocks.person.getLatestFaceDate.mockResolvedValue(new Date(lastRun.getTime() - 1).toISOString());
|
|
mocks.person.getAllFaces.mockReturnValue(makeStream([AssetFaceFactory.create()]));
|
|
mocks.person.getAllWithoutFaces.mockResolvedValue([]);
|
|
|
|
await sut.handleQueueRecognizeFaces({ force: true, nightly: true });
|
|
|
|
expect(mocks.systemMetadata.get).toHaveBeenCalledWith(SystemMetadataKey.FacialRecognitionState);
|
|
expect(mocks.person.getLatestFaceDate).toHaveBeenCalledOnce();
|
|
expect(mocks.person.getAllFaces).not.toHaveBeenCalled();
|
|
expect(mocks.job.queueAll).not.toHaveBeenCalled();
|
|
expect(mocks.systemMetadata.set).not.toHaveBeenCalled();
|
|
expect(mocks.person.vacuum).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should delete existing people if forced', async () => {
|
|
const face = AssetFaceFactory.from().person().build();
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.job.getJobCounts.mockResolvedValue({
|
|
active: 1,
|
|
waiting: 0,
|
|
paused: 0,
|
|
completed: 0,
|
|
failed: 0,
|
|
delayed: 0,
|
|
});
|
|
mocks.person.getAll.mockReturnValue(makeStream([face.person!, person]));
|
|
mocks.person.getAllFaces.mockReturnValue(makeStream([face]));
|
|
mocks.person.getAllWithoutFaces.mockResolvedValue([person]);
|
|
mocks.person.unassignFaces.mockResolvedValue();
|
|
|
|
await sut.handleQueueRecognizeFaces({ force: true });
|
|
|
|
expect(mocks.person.deleteFaces).not.toHaveBeenCalled();
|
|
expect(mocks.person.unassignFaces).toHaveBeenCalledWith({ sourceType: SourceType.MachineLearning });
|
|
expect(mocks.job.queueAll).toHaveBeenCalledWith([
|
|
{
|
|
name: JobName.FacialRecognition,
|
|
data: { id: face.id, deferred: false },
|
|
},
|
|
]);
|
|
expect(mocks.person.delete).toHaveBeenCalledWith([person.id]);
|
|
expect(mocks.storage.unlink).toHaveBeenCalledWith(person.thumbnailPath);
|
|
expect(mocks.person.vacuum).toHaveBeenCalledWith({ reindexVectors: false });
|
|
});
|
|
});
|
|
|
|
describe('handleDetectFaces', () => {
|
|
it('should skip if machine learning is disabled', async () => {
|
|
mocks.systemMetadata.get.mockResolvedValue(systemConfigStub.machineLearningDisabled);
|
|
|
|
await expect(sut.handleDetectFaces({ id: 'foo' })).resolves.toBe(JobStatus.Skipped);
|
|
expect(mocks.asset.getByIds).not.toHaveBeenCalled();
|
|
expect(mocks.systemMetadata.get).toHaveBeenCalled();
|
|
});
|
|
|
|
it('should skip when no resize path', async () => {
|
|
const asset = AssetFactory.create();
|
|
mocks.assetJob.getForDetectFacesJob.mockResolvedValue(asset);
|
|
await sut.handleDetectFaces({ id: asset.id });
|
|
expect(mocks.machineLearning.detectFaces).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should handle no results', async () => {
|
|
const start = Date.now();
|
|
const asset = AssetFactory.from().file({ type: AssetFileType.Preview }).build();
|
|
|
|
mocks.machineLearning.detectFaces.mockResolvedValue({ imageHeight: 500, imageWidth: 400, faces: [] });
|
|
mocks.assetJob.getForDetectFacesJob.mockResolvedValue(asset);
|
|
await sut.handleDetectFaces({ id: asset.id });
|
|
expect(mocks.machineLearning.detectFaces).toHaveBeenCalledWith(
|
|
asset.files[0].path,
|
|
expect.objectContaining({ minScore: 0.7, modelName: 'buffalo_l' }),
|
|
);
|
|
expect(mocks.job.queue).not.toHaveBeenCalled();
|
|
expect(mocks.job.queueAll).not.toHaveBeenCalled();
|
|
|
|
expect(mocks.asset.upsertJobStatus).toHaveBeenCalledWith({
|
|
assetId: asset.id,
|
|
facesRecognizedAt: expect.any(Date),
|
|
});
|
|
const facesRecognizedAt = mocks.asset.upsertJobStatus.mock.calls[0][0].facesRecognizedAt as Date;
|
|
expect(facesRecognizedAt.getTime()).toBeGreaterThan(start);
|
|
});
|
|
|
|
it('should create a face with no person and queue recognition job', async () => {
|
|
const asset = AssetFactory.from().file({ type: AssetFileType.Preview }).build();
|
|
const face = AssetFaceFactory.create({ assetId: asset.id });
|
|
mocks.crypto.randomUUID.mockReturnValue(face.id);
|
|
mocks.machineLearning.detectFaces.mockResolvedValue(getAsDetectedFace(face));
|
|
mocks.search.searchFaces.mockResolvedValue([{ ...face, distance: 0.7 }]);
|
|
mocks.assetJob.getForDetectFacesJob.mockResolvedValue(asset);
|
|
mocks.person.refreshFaces.mockResolvedValue();
|
|
|
|
await sut.handleDetectFaces({ id: asset.id });
|
|
|
|
expect(mocks.person.refreshFaces).toHaveBeenCalledWith(
|
|
[expect.objectContaining({ id: face.id, assetId: asset.id })],
|
|
[],
|
|
[{ faceId: face.id, embedding: '[1, 2, 3, 4]' }],
|
|
);
|
|
expect(mocks.job.queueAll).toHaveBeenCalledWith([
|
|
{ name: JobName.FacialRecognitionQueueAll, data: { force: false } },
|
|
{ name: JobName.FacialRecognition, data: { id: face.id } },
|
|
]);
|
|
expect(mocks.person.reassignFace).not.toHaveBeenCalled();
|
|
expect(mocks.person.reassignFaces).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should delete an existing face not among the new detected faces', async () => {
|
|
const asset = AssetFactory.from().face().file({ type: AssetFileType.Preview }).build();
|
|
mocks.machineLearning.detectFaces.mockResolvedValue({ faces: [], imageHeight: 500, imageWidth: 400 });
|
|
mocks.assetJob.getForDetectFacesJob.mockResolvedValue(asset);
|
|
|
|
await sut.handleDetectFaces({ id: asset.id });
|
|
|
|
expect(mocks.person.refreshFaces).toHaveBeenCalledWith([], [asset.faces[0].id], []);
|
|
expect(mocks.job.queueAll).not.toHaveBeenCalled();
|
|
expect(mocks.person.reassignFace).not.toHaveBeenCalled();
|
|
expect(mocks.person.reassignFaces).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should add new face and delete an existing face not among the new detected faces', async () => {
|
|
const assetId = newUuid();
|
|
const face = AssetFaceFactory.create({
|
|
assetId,
|
|
boundingBoxX1: 200,
|
|
boundingBoxX2: 300,
|
|
boundingBoxY1: 200,
|
|
boundingBoxY2: 300,
|
|
});
|
|
const asset = AssetFactory.from({ id: assetId }).face().file({ type: AssetFileType.Preview }).build();
|
|
mocks.machineLearning.detectFaces.mockResolvedValue(getAsDetectedFace(face));
|
|
mocks.assetJob.getForDetectFacesJob.mockResolvedValue(asset);
|
|
mocks.crypto.randomUUID.mockReturnValue(face.id);
|
|
mocks.person.refreshFaces.mockResolvedValue();
|
|
|
|
await sut.handleDetectFaces({ id: asset.id });
|
|
|
|
expect(mocks.person.refreshFaces).toHaveBeenCalledWith(
|
|
[expect.objectContaining({ id: face.id, assetId: asset.id })],
|
|
[asset.faces[0].id],
|
|
[{ faceId: face.id, embedding: '[1, 2, 3, 4]' }],
|
|
);
|
|
expect(mocks.job.queueAll).toHaveBeenCalledWith([
|
|
{ name: JobName.FacialRecognitionQueueAll, data: { force: false } },
|
|
{ name: JobName.FacialRecognition, data: { id: face.id } },
|
|
]);
|
|
expect(mocks.person.reassignFace).not.toHaveBeenCalled();
|
|
expect(mocks.person.reassignFaces).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should add embedding to matching metadata face', async () => {
|
|
const face = AssetFaceFactory.create({ sourceType: SourceType.Exif });
|
|
const asset = AssetFactory.from().face(face).file({ type: AssetFileType.Preview }).build();
|
|
mocks.machineLearning.detectFaces.mockResolvedValue(getAsDetectedFace(face));
|
|
mocks.assetJob.getForDetectFacesJob.mockResolvedValue(asset);
|
|
mocks.person.refreshFaces.mockResolvedValue();
|
|
|
|
await sut.handleDetectFaces({ id: asset.id });
|
|
|
|
expect(mocks.person.refreshFaces).toHaveBeenCalledWith([], [], [{ faceId: face.id, embedding: '[1, 2, 3, 4]' }]);
|
|
expect(mocks.job.queueAll).not.toHaveBeenCalled();
|
|
expect(mocks.person.reassignFace).not.toHaveBeenCalled();
|
|
expect(mocks.person.reassignFaces).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should not add embedding to non-matching metadata face', async () => {
|
|
const assetId = newUuid();
|
|
const face = AssetFaceFactory.create({ assetId, sourceType: SourceType.Exif });
|
|
const asset = AssetFactory.from({ id: assetId }).file({ type: AssetFileType.Preview }).build();
|
|
mocks.machineLearning.detectFaces.mockResolvedValue(getAsDetectedFace(face));
|
|
mocks.assetJob.getForDetectFacesJob.mockResolvedValue(asset);
|
|
mocks.crypto.randomUUID.mockReturnValue(face.id);
|
|
|
|
await sut.handleDetectFaces({ id: asset.id });
|
|
|
|
expect(mocks.person.refreshFaces).toHaveBeenCalledWith(
|
|
[expect.objectContaining({ id: face.id, assetId: asset.id })],
|
|
[],
|
|
[{ faceId: face.id, embedding: '[1, 2, 3, 4]' }],
|
|
);
|
|
expect(mocks.job.queueAll).toHaveBeenCalledWith([
|
|
{ name: JobName.FacialRecognitionQueueAll, data: { force: false } },
|
|
{ name: JobName.FacialRecognition, data: { id: face.id } },
|
|
]);
|
|
expect(mocks.person.reassignFace).not.toHaveBeenCalled();
|
|
expect(mocks.person.reassignFaces).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
describe('handleRecognizeFaces', () => {
|
|
it('should fail if face does not exist', async () => {
|
|
expect(await sut.handleRecognizeFaces({ id: 'unknown-face' })).toBe(JobStatus.Failed);
|
|
|
|
expect(mocks.person.reassignFaces).not.toHaveBeenCalled();
|
|
expect(mocks.person.create).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should fail if face does not have asset', async () => {
|
|
const face = AssetFaceFactory.create();
|
|
mocks.person.getFaceForFacialRecognitionJob.mockResolvedValue(getForFacialRecognitionJob(face, null));
|
|
|
|
expect(await sut.handleRecognizeFaces({ id: face.id })).toBe(JobStatus.Failed);
|
|
|
|
expect(mocks.person.reassignFaces).not.toHaveBeenCalled();
|
|
expect(mocks.person.create).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should skip if face already has an assigned person', async () => {
|
|
const asset = AssetFactory.create();
|
|
const face = AssetFaceFactory.from({ assetId: asset.id }).person().build();
|
|
mocks.person.getFaceForFacialRecognitionJob.mockResolvedValue(getForFacialRecognitionJob(face, asset));
|
|
|
|
expect(await sut.handleRecognizeFaces({ id: face.id })).toBe(JobStatus.Skipped);
|
|
|
|
expect(mocks.person.reassignFaces).not.toHaveBeenCalled();
|
|
expect(mocks.person.create).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should match existing person', async () => {
|
|
const asset = AssetFactory.create();
|
|
|
|
const [noPerson1, noPerson2, primaryFace, face] = [
|
|
AssetFaceFactory.create({ assetId: asset.id }),
|
|
AssetFaceFactory.create(),
|
|
AssetFaceFactory.from().person().build(),
|
|
AssetFaceFactory.from().person().build(),
|
|
];
|
|
|
|
const faces = [
|
|
{ ...noPerson1, distance: 0 },
|
|
{ ...primaryFace, distance: 0.2 },
|
|
{ ...noPerson2, distance: 0.3 },
|
|
{ ...face, distance: 0.4 },
|
|
] as FaceSearchResult[];
|
|
|
|
mocks.systemMetadata.get.mockResolvedValue({ machineLearning: { facialRecognition: { minFaces: 1 } } });
|
|
mocks.search.searchFaces.mockResolvedValue(faces);
|
|
mocks.person.getFaceForFacialRecognitionJob.mockResolvedValue(getForFacialRecognitionJob(noPerson1, asset));
|
|
mocks.person.create.mockResolvedValue(primaryFace.person!);
|
|
|
|
await sut.handleRecognizeFaces({ id: noPerson1.id });
|
|
|
|
expect(mocks.person.create).not.toHaveBeenCalled();
|
|
expect(mocks.person.reassignFaces).toHaveBeenCalledTimes(1);
|
|
expect(mocks.person.reassignFaces).toHaveBeenCalledWith({
|
|
faceIds: expect.arrayContaining([noPerson1.id]),
|
|
newPersonId: primaryFace.person!.id,
|
|
});
|
|
expect(mocks.person.reassignFaces).toHaveBeenCalledWith({
|
|
faceIds: expect.not.arrayContaining([face.id]),
|
|
newPersonId: primaryFace.person!.id,
|
|
});
|
|
});
|
|
|
|
it('should match existing person if their birth date is unknown', async () => {
|
|
const asset = AssetFactory.create();
|
|
const [noPerson, face, faceWithBirthDate] = [
|
|
AssetFaceFactory.create({ assetId: asset.id }),
|
|
AssetFaceFactory.from().person().build(),
|
|
AssetFaceFactory.from().person({ birthDate: newDate() }).build(),
|
|
];
|
|
|
|
const faces = [
|
|
{ ...noPerson, distance: 0 },
|
|
{ ...face, distance: 0.2 },
|
|
{ ...faceWithBirthDate, distance: 0.3 },
|
|
] as FaceSearchResult[];
|
|
|
|
mocks.systemMetadata.get.mockResolvedValue({ machineLearning: { facialRecognition: { minFaces: 1 } } });
|
|
mocks.search.searchFaces.mockResolvedValue(faces);
|
|
mocks.person.getFaceForFacialRecognitionJob.mockResolvedValue(getForFacialRecognitionJob(noPerson, asset));
|
|
mocks.person.create.mockResolvedValue(face.person!);
|
|
|
|
await sut.handleRecognizeFaces({ id: noPerson.id });
|
|
|
|
expect(mocks.person.create).not.toHaveBeenCalled();
|
|
expect(mocks.person.reassignFaces).toHaveBeenCalledTimes(1);
|
|
expect(mocks.person.reassignFaces).toHaveBeenCalledWith({
|
|
faceIds: expect.arrayContaining([noPerson.id]),
|
|
newPersonId: face.person!.id,
|
|
});
|
|
expect(mocks.person.reassignFaces).toHaveBeenCalledWith({
|
|
faceIds: expect.not.arrayContaining([face.id]),
|
|
newPersonId: face.person!.id,
|
|
});
|
|
});
|
|
|
|
it('should match existing person if their birth date is before file creation', async () => {
|
|
const asset = AssetFactory.create();
|
|
const [noPerson, face, faceWithBirthDate] = [
|
|
AssetFaceFactory.create({ assetId: asset.id }),
|
|
AssetFaceFactory.from().person().build(),
|
|
AssetFaceFactory.from().person({ birthDate: newDate() }).build(),
|
|
];
|
|
|
|
const faces = [
|
|
{ ...noPerson, distance: 0 },
|
|
{ ...faceWithBirthDate, distance: 0.2 },
|
|
{ ...face, distance: 0.3 },
|
|
] as FaceSearchResult[];
|
|
|
|
mocks.systemMetadata.get.mockResolvedValue({ machineLearning: { facialRecognition: { minFaces: 1 } } });
|
|
mocks.search.searchFaces.mockResolvedValue(faces);
|
|
mocks.person.getFaceForFacialRecognitionJob.mockResolvedValue(getForFacialRecognitionJob(noPerson, asset));
|
|
mocks.person.create.mockResolvedValue(face.person!);
|
|
|
|
await sut.handleRecognizeFaces({ id: noPerson.id });
|
|
|
|
expect(mocks.person.create).not.toHaveBeenCalled();
|
|
expect(mocks.person.reassignFaces).toHaveBeenCalledTimes(1);
|
|
expect(mocks.person.reassignFaces).toHaveBeenCalledWith({
|
|
faceIds: expect.arrayContaining([noPerson.id]),
|
|
newPersonId: faceWithBirthDate.person!.id,
|
|
});
|
|
expect(mocks.person.reassignFaces).toHaveBeenCalledWith({
|
|
faceIds: expect.not.arrayContaining([face.id]),
|
|
newPersonId: faceWithBirthDate.person!.id,
|
|
});
|
|
});
|
|
|
|
it('should create a new person if the face is a core point with no person', async () => {
|
|
const asset = AssetFactory.create();
|
|
const [noPerson1, noPerson2] = [AssetFaceFactory.create({ assetId: asset.id }), AssetFaceFactory.create()];
|
|
const person = PersonFactory.create();
|
|
|
|
const faces = [
|
|
{ ...noPerson1, distance: 0 },
|
|
{ ...noPerson2, distance: 0.3 },
|
|
] as FaceSearchResult[];
|
|
|
|
mocks.systemMetadata.get.mockResolvedValue({ machineLearning: { facialRecognition: { minFaces: 1 } } });
|
|
mocks.search.searchFaces.mockResolvedValue(faces);
|
|
mocks.person.getFaceForFacialRecognitionJob.mockResolvedValue(getForFacialRecognitionJob(noPerson1, asset));
|
|
mocks.person.create.mockResolvedValue(person);
|
|
|
|
await sut.handleRecognizeFaces({ id: noPerson1.id });
|
|
|
|
expect(mocks.person.create).toHaveBeenCalledWith({
|
|
ownerId: asset.ownerId,
|
|
faceAssetId: noPerson1.id,
|
|
});
|
|
expect(mocks.person.reassignFaces).toHaveBeenCalledWith({
|
|
faceIds: [noPerson1.id],
|
|
newPersonId: person.id,
|
|
});
|
|
});
|
|
|
|
it('should not queue face with no matches', async () => {
|
|
const asset = AssetFactory.create();
|
|
const face = AssetFaceFactory.create({ assetId: asset.id });
|
|
const faces = [{ ...face, distance: 0 }] as FaceSearchResult[];
|
|
|
|
mocks.search.searchFaces.mockResolvedValue(faces);
|
|
mocks.person.getFaceForFacialRecognitionJob.mockResolvedValue(getForFacialRecognitionJob(face, asset));
|
|
mocks.person.create.mockResolvedValue(PersonFactory.create());
|
|
|
|
await sut.handleRecognizeFaces({ id: face.id });
|
|
|
|
expect(mocks.job.queue).not.toHaveBeenCalled();
|
|
expect(mocks.search.searchFaces).toHaveBeenCalledTimes(1);
|
|
expect(mocks.person.create).not.toHaveBeenCalled();
|
|
expect(mocks.person.reassignFaces).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should defer non-core faces to end of queue', async () => {
|
|
const asset = AssetFactory.create();
|
|
const [noPerson1, noPerson2] = [AssetFaceFactory.create({ assetId: asset.id }), AssetFaceFactory.create()];
|
|
|
|
const faces = [
|
|
{ ...noPerson1, distance: 0 },
|
|
{ ...noPerson2, distance: 0.4 },
|
|
] as FaceSearchResult[];
|
|
|
|
mocks.systemMetadata.get.mockResolvedValue({ machineLearning: { facialRecognition: { minFaces: 3 } } });
|
|
mocks.search.searchFaces.mockResolvedValue(faces);
|
|
mocks.person.getFaceForFacialRecognitionJob.mockResolvedValue(getForFacialRecognitionJob(noPerson1, asset));
|
|
mocks.person.create.mockResolvedValue(PersonFactory.create());
|
|
|
|
await sut.handleRecognizeFaces({ id: noPerson1.id });
|
|
|
|
expect(mocks.job.queue).toHaveBeenCalledWith({
|
|
name: JobName.FacialRecognition,
|
|
data: { id: noPerson1.id, deferred: true },
|
|
});
|
|
expect(mocks.search.searchFaces).toHaveBeenCalledTimes(1);
|
|
expect(mocks.person.create).not.toHaveBeenCalled();
|
|
expect(mocks.person.reassignFaces).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should not assign person to deferred non-core face with no matching person', async () => {
|
|
const asset = AssetFactory.create();
|
|
const [noPerson1, noPerson2] = [AssetFaceFactory.create({ assetId: asset.id }), AssetFaceFactory.create()];
|
|
|
|
const faces = [
|
|
{ ...noPerson1, distance: 0 },
|
|
{ ...noPerson2, distance: 0.4 },
|
|
] as FaceSearchResult[];
|
|
|
|
mocks.systemMetadata.get.mockResolvedValue({ machineLearning: { facialRecognition: { minFaces: 3 } } });
|
|
mocks.search.searchFaces.mockResolvedValueOnce(faces).mockResolvedValueOnce([]);
|
|
mocks.person.getFaceForFacialRecognitionJob.mockResolvedValue(getForFacialRecognitionJob(noPerson1, asset));
|
|
mocks.person.create.mockResolvedValue(PersonFactory.create());
|
|
|
|
await sut.handleRecognizeFaces({ id: noPerson1.id, deferred: true });
|
|
|
|
expect(mocks.job.queue).not.toHaveBeenCalled();
|
|
expect(mocks.search.searchFaces).toHaveBeenCalledTimes(2);
|
|
expect(mocks.person.create).not.toHaveBeenCalled();
|
|
expect(mocks.person.reassignFaces).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
describe('mergePerson', () => {
|
|
it('should require person.write and person.merge permission', async () => {
|
|
const auth = AuthFactory.create();
|
|
const [person, mergePerson] = [PersonFactory.create(), PersonFactory.create()];
|
|
|
|
mocks.person.getById.mockResolvedValueOnce(person);
|
|
mocks.person.getById.mockResolvedValueOnce(mergePerson);
|
|
|
|
await expect(sut.mergePerson(auth, person.id, { ids: [mergePerson.id] })).rejects.toBeInstanceOf(
|
|
BadRequestException,
|
|
);
|
|
|
|
expect(mocks.person.reassignFaces).not.toHaveBeenCalled();
|
|
|
|
expect(mocks.person.delete).not.toHaveBeenCalled();
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
|
|
it('should merge two people without smart merge', async () => {
|
|
const auth = AuthFactory.create();
|
|
const [person, mergePerson] = [PersonFactory.create(), PersonFactory.create()];
|
|
|
|
mocks.person.getById.mockResolvedValueOnce(person);
|
|
mocks.person.getById.mockResolvedValueOnce(mergePerson);
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValueOnce(new Set([person.id]));
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValueOnce(new Set([mergePerson.id]));
|
|
|
|
await expect(sut.mergePerson(auth, person.id, { ids: [mergePerson.id] })).resolves.toEqual([
|
|
{ id: mergePerson.id, success: true },
|
|
]);
|
|
|
|
expect(mocks.person.reassignFaces).toHaveBeenCalledWith({
|
|
newPersonId: person.id,
|
|
oldPersonId: mergePerson.id,
|
|
});
|
|
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
|
|
it('should merge two people with smart merge', async () => {
|
|
const auth = AuthFactory.create();
|
|
const [person, mergePerson] = [
|
|
PersonFactory.create({ name: undefined }),
|
|
PersonFactory.create({ name: 'Merge person' }),
|
|
];
|
|
|
|
mocks.person.getById.mockResolvedValueOnce(person);
|
|
mocks.person.getById.mockResolvedValueOnce(mergePerson);
|
|
mocks.person.update.mockResolvedValue({ ...person, name: mergePerson.name });
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValueOnce(new Set([person.id]));
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValueOnce(new Set([mergePerson.id]));
|
|
|
|
await expect(sut.mergePerson(auth, person.id, { ids: [mergePerson.id] })).resolves.toEqual([
|
|
{ id: mergePerson.id, success: true },
|
|
]);
|
|
|
|
expect(mocks.person.reassignFaces).toHaveBeenCalledWith({
|
|
newPersonId: person.id,
|
|
oldPersonId: mergePerson.id,
|
|
});
|
|
|
|
expect(mocks.person.update).toHaveBeenCalledWith({
|
|
id: person.id,
|
|
name: mergePerson.name,
|
|
});
|
|
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
|
|
it('should throw an error when the primary person is not found', async () => {
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set(['person-1']));
|
|
|
|
await expect(sut.mergePerson(authStub.admin, 'person-1', { ids: ['person-2'] })).rejects.toBeInstanceOf(
|
|
BadRequestException,
|
|
);
|
|
|
|
expect(mocks.person.delete).not.toHaveBeenCalled();
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(authStub.admin.user.id, new Set(['person-1']));
|
|
});
|
|
|
|
it('should handle invalid merge ids', async () => {
|
|
const auth = AuthFactory.create();
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.person.getById.mockResolvedValueOnce(person);
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValueOnce(new Set([person.id]));
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValueOnce(new Set(['unknown']));
|
|
|
|
await expect(sut.mergePerson(auth, person.id, { ids: ['unknown'] })).resolves.toEqual([
|
|
{ id: 'unknown', success: false, error: BulkIdErrorReason.NOT_FOUND },
|
|
]);
|
|
|
|
expect(mocks.person.reassignFaces).not.toHaveBeenCalled();
|
|
expect(mocks.person.delete).not.toHaveBeenCalled();
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
|
|
it('should handle an error reassigning faces', async () => {
|
|
const auth = AuthFactory.create();
|
|
const [person, mergePerson] = [PersonFactory.create(), PersonFactory.create()];
|
|
|
|
mocks.person.getById.mockResolvedValueOnce(person);
|
|
mocks.person.getById.mockResolvedValueOnce(mergePerson);
|
|
mocks.person.reassignFaces.mockRejectedValue(new Error('update failed'));
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValueOnce(new Set([person.id]));
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValueOnce(new Set([mergePerson.id]));
|
|
|
|
await expect(sut.mergePerson(auth, person.id, { ids: [mergePerson.id] })).resolves.toEqual([
|
|
{ id: mergePerson.id, success: false, error: BulkIdErrorReason.UNKNOWN },
|
|
]);
|
|
|
|
expect(mocks.person.delete).not.toHaveBeenCalled();
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
});
|
|
|
|
describe('getStatistics', () => {
|
|
it('should get correct number of person', async () => {
|
|
const auth = AuthFactory.create();
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.person.getById.mockResolvedValue(person);
|
|
mocks.person.getStatistics.mockResolvedValue({ assets: 3 });
|
|
mocks.access.person.checkOwnerAccess.mockResolvedValue(new Set([person.id]));
|
|
await expect(sut.getStatistics(auth, person.id)).resolves.toEqual({ assets: 3 });
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
|
|
it('should require person.read permission', async () => {
|
|
const auth = AuthFactory.create();
|
|
const person = PersonFactory.create();
|
|
|
|
mocks.person.getById.mockResolvedValue(person);
|
|
await expect(sut.getStatistics(auth, person.id)).rejects.toBeInstanceOf(BadRequestException);
|
|
expect(mocks.access.person.checkOwnerAccess).toHaveBeenCalledWith(auth.user.id, new Set([person.id]));
|
|
});
|
|
});
|
|
|
|
describe('mapFace', () => {
|
|
it('should map a face', () => {
|
|
const user = UserFactory.create();
|
|
const auth = AuthFactory.create({ id: user.id });
|
|
const person = PersonFactory.create({ ownerId: user.id });
|
|
const face = AssetFaceFactory.from().person(person).build();
|
|
|
|
expect(mapFaces(face, auth)).toEqual({
|
|
boundingBoxX1: 100,
|
|
boundingBoxX2: 200,
|
|
boundingBoxY1: 100,
|
|
boundingBoxY2: 200,
|
|
id: face.id,
|
|
imageHeight: 500,
|
|
imageWidth: 400,
|
|
sourceType: SourceType.MachineLearning,
|
|
person: mapPerson(person),
|
|
});
|
|
});
|
|
|
|
it('should not map person if person is null', () => {
|
|
expect(mapFaces(AssetFaceFactory.create(), AuthFactory.create()).person).toBeNull();
|
|
});
|
|
|
|
it('should not map person if person does not match auth user id', () => {
|
|
expect(mapFaces(AssetFaceFactory.from().person().build(), AuthFactory.create()).person).toBeNull();
|
|
});
|
|
});
|
|
});
|