feat(server): separate face clustering job (#5598)

* separate facial clustering job

* update api

* fixed some tests

* invert clustering

* hdbscan

* update api

* remove commented code

* wip dbscan

* cleanup

removed cluster endpoint

remove commented code

* fixes

updated tests

minor fixes and formatting

fixed queuing

refinements

* scale search range based on library size

* defer non-core faces

* optimizations

removed unused query option

* assign faces individually for correctness

fixed unit tests

remove unused method

* don't select face embedding

update sql

linting

fixed ml typing

* updated job mock

* paginate people query

* select face embeddings because typeorm

* fix setting face detection concurrency

* update sql

formatting

linting

* simplify logic

remove unused imports

* more specific delete signature

* more accurate typing for face stubs

* add migration

formatting

* chore: better typing

* don't select embedding by default

remove unused import

* updated sql

* use normal try/catch

* stricter concurrency typing and enforcement

* update api

* update job concurrency panel to show disabled queues

formatting

* check jobId in queueAll

fix tests

* remove outdated comment

* better facial recognition icon

* wording

wording

formatting

* fixed tests

* fix

* formatting & sql

* try to fix sql check

* more detailed description

* update sql

* formatting

* wording

* update `minFaces` description

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>

server/src/domain/media/media.service.spec.ts

@@ -70,7 +70,10 @@ describe(MediaService.name, () => {
         items: [assetStub.image],
         hasNextPage: false,
       });
-      personMock.getAll.mockResolvedValue([personStub.newThumbnail]);
+      personMock.getAll.mockResolvedValue({
+        items: [personStub.newThumbnail],
+        hasNextPage: false,
+      });
       personMock.getFacesByIds.mockResolvedValue([faceStub.face1]);
 
       await sut.handleQueueGenerateThumbnails({ force: true });
@@ -84,8 +87,7 @@ describe(MediaService.name, () => {
         },
       ]);
 
-      expect(personMock.getAll).toHaveBeenCalled();
-      expect(personMock.getAllWithoutThumbnail).not.toHaveBeenCalled();
+      expect(personMock.getAll).toHaveBeenCalledWith({ skip: 0, take: 1000 }, {});
       expect(jobMock.queueAll).toHaveBeenCalledWith([
         {
           name: JobName.GENERATE_PERSON_THUMBNAIL,
@@ -99,7 +101,10 @@ describe(MediaService.name, () => {
         items: [assetStub.image],
         hasNextPage: false,
       });
-      personMock.getAllWithoutThumbnail.mockResolvedValue([personStub.noThumbnail]);
+      personMock.getAll.mockResolvedValue({
+        items: [personStub.noThumbnail],
+        hasNextPage: false,
+      });
       personMock.getRandomFace.mockResolvedValue(faceStub.face1);
 
       await sut.handleQueueGenerateThumbnails({ force: false });
@@ -107,8 +112,7 @@ describe(MediaService.name, () => {
       expect(assetMock.getAll).not.toHaveBeenCalled();
       expect(assetMock.getWithout).toHaveBeenCalledWith({ skip: 0, take: 1000 }, WithoutProperty.THUMBNAIL);
 
-      expect(personMock.getAll).not.toHaveBeenCalled();
-      expect(personMock.getAllWithoutThumbnail).toHaveBeenCalled();
+      expect(personMock.getAll).toHaveBeenCalledWith({ skip: 0, take: 1000 }, { where: { thumbnailPath: '' } });
       expect(personMock.getRandomFace).toHaveBeenCalled();
       expect(jobMock.queueAll).toHaveBeenCalledWith([
         {
@@ -125,7 +129,10 @@ describe(MediaService.name, () => {
         items: [assetStub.noResizePath],
         hasNextPage: false,
       });
-      personMock.getAllWithoutThumbnail.mockResolvedValue([]);
+      personMock.getAll.mockResolvedValue({
+        items: [],
+        hasNextPage: false,
+      });
 
       await sut.handleQueueGenerateThumbnails({ force: false });
 
@@ -138,8 +145,7 @@ describe(MediaService.name, () => {
         },
       ]);
 
-      expect(personMock.getAll).not.toHaveBeenCalled();
-      expect(personMock.getAllWithoutThumbnail).toHaveBeenCalled();
+      expect(personMock.getAll).toHaveBeenCalledWith({ skip: 0, take: 1000 }, { where: { thumbnailPath: '' } });
     });
 
     it('should queue all assets with missing webp path', async () => {
@@ -147,7 +153,10 @@ describe(MediaService.name, () => {
         items: [assetStub.noWebpPath],
         hasNextPage: false,
       });
-      personMock.getAllWithoutThumbnail.mockResolvedValue([]);
+      personMock.getAll.mockResolvedValue({
+        items: [],
+        hasNextPage: false,
+      });
 
       await sut.handleQueueGenerateThumbnails({ force: false });
 
@@ -160,8 +169,7 @@ describe(MediaService.name, () => {
         },
       ]);
 
-      expect(personMock.getAll).not.toHaveBeenCalled();
-      expect(personMock.getAllWithoutThumbnail).toHaveBeenCalled();
+      expect(personMock.getAll).toHaveBeenCalledWith({ skip: 0, take: 1000 }, { where: { thumbnailPath: '' } });
     });
 
     it('should queue all assets with missing thumbhash', async () => {
@@ -169,7 +177,10 @@ describe(MediaService.name, () => {
         items: [assetStub.noThumbhash],
         hasNextPage: false,
       });
-      personMock.getAllWithoutThumbnail.mockResolvedValue([]);
+      personMock.getAll.mockResolvedValue({
+        items: [],
+        hasNextPage: false,
+      });
 
       await sut.handleQueueGenerateThumbnails({ force: false });
 
@@ -182,8 +193,7 @@ describe(MediaService.name, () => {
         },
       ]);
 
-      expect(personMock.getAll).not.toHaveBeenCalled();
-      expect(personMock.getAllWithoutThumbnail).toHaveBeenCalled();
+      expect(personMock.getAll).toHaveBeenCalledWith({ skip: 0, take: 1000 }, { where: { thumbnailPath: '' } });
     });
   });
 
@@ -394,7 +404,10 @@ describe(MediaService.name, () => {
         items: [assetStub.video],
         hasNextPage: false,
       });
-      personMock.getAll.mockResolvedValue([]);
+      personMock.getAll.mockResolvedValue({
+        items: [],
+        hasNextPage: false,
+      });
 
       await sut.handleQueueVideoConversion({ force: true });
 

server/src/domain/media/media.service.ts

@@ -93,20 +93,24 @@ export class MediaService {
       await this.jobRepository.queueAll(jobs);
     }
 
-    const people = force ? await this.personRepository.getAll() : await this.personRepository.getAllWithoutThumbnail();
-
     const jobs: JobItem[] = [];
-    for (const person of people) {
-      if (!person.faceAssetId) {
-        const face = await this.personRepository.getRandomFace(person.id);
-        if (!face) {
-          continue;
+    const personPagination = usePagination(JOBS_ASSET_PAGINATION_SIZE, (pagination) =>
+      this.personRepository.getAll(pagination, { where: force ? undefined : { thumbnailPath: '' } }),
+    );
+
+    for await (const people of personPagination) {
+      for (const person of people) {
+        if (!person.faceAssetId) {
+          const face = await this.personRepository.getRandomFace(person.id);
+          if (!face) {
+            continue;
+          }
+
+          await this.personRepository.update({ id: person.id, faceAssetId: face.assetId });
         }
 
-        await this.personRepository.update({ id: person.id, faceAssetId: face.assetId });
+        jobs.push({ name: JobName.GENERATE_PERSON_THUMBNAIL, data: { id: person.id } });
       }
-
-      jobs.push({ name: JobName.GENERATE_PERSON_THUMBNAIL, data: { id: person.id } });
     }
 
     await this.jobRepository.queueAll(jobs);
@@ -131,11 +135,16 @@ export class MediaService {
       );
     }
 
-    const people = await this.personRepository.getAll();
-    await this.jobRepository.queueAll(
-      people.map((person) => ({ name: JobName.MIGRATE_PERSON, data: { id: person.id } })),
+    const personPagination = usePagination(JOBS_ASSET_PAGINATION_SIZE, (pagination) =>
+      this.personRepository.getAll(pagination),
     );
 
+    for await (const people of personPagination) {
+      await this.jobRepository.queueAll(
+        people.map((person) => ({ name: JobName.MIGRATE_PERSON, data: { id: person.id } })),
+      );
+    }
+
     return true;
   }