feat: facial recognition (#2180)

server/libs/domain/src/job/job.constants.ts

@@ -3,6 +3,7 @@ export enum QueueName {
   METADATA_EXTRACTION = 'metadata-extraction-queue',
   VIDEO_CONVERSION = 'video-conversion-queue',
   OBJECT_TAGGING = 'object-tagging-queue',
+  RECOGNIZE_FACES = 'recognize-faces-queue',
   CLIP_ENCODING = 'clip-encoding-queue',
   BACKGROUND_TASK = 'background-task-queue',
   STORAGE_TEMPLATE_MIGRATION = 'storage-template-migration-queue',
@@ -48,16 +49,25 @@ export enum JobName {
   DETECT_OBJECTS = 'detect-objects',
   CLASSIFY_IMAGE = 'classify-image',
 
+  // facial recognition
+  QUEUE_RECOGNIZE_FACES = 'queue-recognize-faces',
+  RECOGNIZE_FACES = 'recognize-faces',
+  GENERATE_FACE_THUMBNAIL = 'generate-face-thumbnail',
+  PERSON_CLEANUP = 'person-cleanup',
+
   // cleanup
   DELETE_FILES = 'delete-files',
 
   // search
   SEARCH_INDEX_ASSETS = 'search-index-assets',
   SEARCH_INDEX_ASSET = 'search-index-asset',
+  SEARCH_INDEX_FACE = 'search-index-face',
+  SEARCH_INDEX_FACES = 'search-index-faces',
   SEARCH_INDEX_ALBUMS = 'search-index-albums',
   SEARCH_INDEX_ALBUM = 'search-index-album',
   SEARCH_REMOVE_ALBUM = 'search-remove-album',
   SEARCH_REMOVE_ASSET = 'search-remove-asset',
+  SEARCH_REMOVE_FACE = 'search-remove-face',
 
   // clip
   QUEUE_ENCODE_CLIP = 'queue-clip-encode',

server/libs/domain/src/job/job.interface.ts

@@ -1,4 +1,5 @@
 import { AlbumEntity, AssetEntity, UserEntity } from '@app/infra/entities';
+import { BoundingBox } from '../smart-info';
 
 export interface IBaseJob {
   force?: boolean;
@@ -12,6 +13,19 @@ export interface IAssetJob extends IBaseJob {
   asset: AssetEntity;
 }
 
+export interface IAssetFaceJob extends IBaseJob {
+  assetId: string;
+  personId: string;
+}
+
+export interface IFaceThumbnailJob extends IAssetFaceJob {
+  imageWidth: number;
+  imageHeight: number;
+  boundingBox: BoundingBox;
+  assetId: string;
+  personId: string;
+}
+
 export interface IBulkEntityJob extends IBaseJob {
   ids: string[];
 }

server/libs/domain/src/job/job.repository.ts

@@ -1,10 +1,12 @@
 import { JobName, QueueName } from './job.constants';
 import {
+  IAssetFaceJob,
   IAssetJob,
   IAssetUploadedJob,
   IBaseJob,
   IBulkEntityJob,
   IDeleteFilesJob,
+  IFaceThumbnailJob,
   IUserDeletionJob,
 } from './job.interface';
 
@@ -54,6 +56,11 @@ export type JobItem =
   | { name: JobName.DETECT_OBJECTS; data: IAssetJob }
   | { name: JobName.CLASSIFY_IMAGE; data: IAssetJob }
 
+  // Recognize Faces
+  | { name: JobName.QUEUE_RECOGNIZE_FACES; data: IBaseJob }
+  | { name: JobName.RECOGNIZE_FACES; data: IAssetJob }
+  | { name: JobName.GENERATE_FACE_THUMBNAIL; data: IFaceThumbnailJob }
+
   // Clip Embedding
   | { name: JobName.QUEUE_ENCODE_CLIP; data: IBaseJob }
   | { name: JobName.ENCODE_CLIP; data: IAssetJob }
@@ -61,13 +68,19 @@ export type JobItem =
   // Filesystem
   | { name: JobName.DELETE_FILES; data: IDeleteFilesJob }
 
+  // Asset Deletion
+  | { name: JobName.PERSON_CLEANUP }
+
   // Search
   | { name: JobName.SEARCH_INDEX_ASSETS }
   | { name: JobName.SEARCH_INDEX_ASSET; data: IBulkEntityJob }
+  | { name: JobName.SEARCH_INDEX_FACES }
+  | { name: JobName.SEARCH_INDEX_FACE; data: IAssetFaceJob }
   | { name: JobName.SEARCH_INDEX_ALBUMS }
   | { name: JobName.SEARCH_INDEX_ALBUM; data: IBulkEntityJob }
   | { name: JobName.SEARCH_REMOVE_ASSET; data: IBulkEntityJob }
-  | { name: JobName.SEARCH_REMOVE_ALBUM; data: IBulkEntityJob };
+  | { name: JobName.SEARCH_REMOVE_ALBUM; data: IBulkEntityJob }
+  | { name: JobName.SEARCH_REMOVE_FACE; data: IAssetFaceJob };
 
 export const IJobRepository = 'IJobRepository';
 

server/libs/domain/src/job/job.service.spec.ts

@@ -15,6 +15,17 @@ describe(JobService.name, () => {
     expect(sut).toBeDefined();
   });
 
+  describe('handleNightlyJobs', () => {
+    it('should run the scheduled jobs', async () => {
+      await sut.handleNightlyJobs();
+
+      expect(jobMock.queue.mock.calls).toEqual([
+        [{ name: JobName.USER_DELETE_CHECK }],
+        [{ name: JobName.PERSON_CLEANUP }],
+      ]);
+    });
+  });
+
   describe('getAllJobStatus', () => {
     it('should get all job statuses', async () => {
       jobMock.getJobCounts.mockResolvedValue({
@@ -54,6 +65,7 @@ describe(JobService.name, () => {
         'storage-template-migration-queue': expectedJobStatus,
         'thumbnail-generation-queue': expectedJobStatus,
         'video-conversion-queue': expectedJobStatus,
+        'recognize-faces-queue': expectedJobStatus,
       });
     });
   });

server/libs/domain/src/job/job.service.ts

@@ -11,6 +11,11 @@ export class JobService {
 
   constructor(@Inject(IJobRepository) private jobRepository: IJobRepository) {}
 
+  async handleNightlyJobs() {
+    await this.jobRepository.queue({ name: JobName.USER_DELETE_CHECK });
+    await this.jobRepository.queue({ name: JobName.PERSON_CLEANUP });
+  }
+
   handleCommand(queueName: QueueName, dto: JobCommandDto): Promise<void> {
     this.logger.debug(`Handling command: queue=${queueName},force=${dto.force}`);
 
@@ -73,6 +78,9 @@ export class JobService {
       case QueueName.THUMBNAIL_GENERATION:
         return this.jobRepository.queue({ name: JobName.QUEUE_GENERATE_THUMBNAILS, data: { force } });
 
+      case QueueName.RECOGNIZE_FACES:
+        return this.jobRepository.queue({ name: JobName.QUEUE_RECOGNIZE_FACES, data: { force } });
+
       default:
         throw new BadRequestException(`Invalid job name: ${name}`);
     }

server/libs/domain/src/job/response-dto/all-job-status-response.dto.ts

@@ -53,4 +53,7 @@ export class AllJobStatusResponseDto implements Record<QueueName, JobStatusDto>
 
   @ApiProperty({ type: JobStatusDto })
   [QueueName.SEARCH]!: JobStatusDto;
+
+  @ApiProperty({ type: JobStatusDto })
+  [QueueName.RECOGNIZE_FACES]!: JobStatusDto;
 }