chore(web): update job dashboard (#5745)

* rename clip encoding to smart search * update job subtitles * update api * update smart search job title and subtitle * fix `getJobName` * change smart search icon * formatting * wording * update reference to clip * formatting * update reference to Encode CLIP
2025-12-23 09:15:05 +03:00 · 2023-12-16 11:50:46 -05:00
parent a2deba4734
commit cb1201e690
22 changed files with 99 additions and 98 deletions
--- a/server/src/domain/job/job.constants.ts
+++ b/server/src/domain/job/job.constants.ts
@@ -4,7 +4,7 @@ export enum QueueName {
  VIDEO_CONVERSION = 'videoConversion',
  OBJECT_TAGGING = 'objectTagging',
  RECOGNIZE_FACES = 'recognizeFaces',
-  CLIP_ENCODING = 'clipEncoding',
+  SMART_SEARCH = 'smartSearch',
  BACKGROUND_TASK = 'backgroundTask',
  STORAGE_TEMPLATE_MIGRATION = 'storageTemplateMigration',
  MIGRATION = 'migration',
@@ -135,8 +135,8 @@ export const JOBS_TO_QUEUE: Record<JobName, QueueName> = {
  [JobName.RECOGNIZE_FACES]: QueueName.RECOGNIZE_FACES,

  // clip
-  [JobName.QUEUE_ENCODE_CLIP]: QueueName.CLIP_ENCODING,
-  [JobName.ENCODE_CLIP]: QueueName.CLIP_ENCODING,
+  [JobName.QUEUE_ENCODE_CLIP]: QueueName.SMART_SEARCH,
+  [JobName.ENCODE_CLIP]: QueueName.SMART_SEARCH,

  // XMP sidecars
  [JobName.QUEUE_SIDECAR]: QueueName.SIDECAR,
--- a/server/src/domain/job/job.dto.ts
+++ b/server/src/domain/job/job.dto.ts
@@ -63,7 +63,7 @@ export class AllJobStatusResponseDto implements Record<QueueName, JobStatusDto>
  [QueueName.OBJECT_TAGGING]!: JobStatusDto;

  @ApiProperty({ type: JobStatusDto })
-  [QueueName.CLIP_ENCODING]!: JobStatusDto;
+  [QueueName.SMART_SEARCH]!: JobStatusDto;

  @ApiProperty({ type: JobStatusDto })
  [QueueName.STORAGE_TEMPLATE_MIGRATION]!: JobStatusDto;
--- a/server/src/domain/job/job.service.spec.ts
+++ b/server/src/domain/job/job.service.spec.ts
@@ -97,7 +97,7 @@ describe(JobService.name, () => {

      await expect(sut.getAllJobsStatus()).resolves.toEqual({
        [QueueName.BACKGROUND_TASK]: expectedJobStatus,
-        [QueueName.CLIP_ENCODING]: expectedJobStatus,
+        [QueueName.SMART_SEARCH]: expectedJobStatus,
        [QueueName.METADATA_EXTRACTION]: expectedJobStatus,
        [QueueName.OBJECT_TAGGING]: expectedJobStatus,
        [QueueName.SEARCH]: expectedJobStatus,
@@ -171,7 +171,7 @@ describe(JobService.name, () => {
    it('should handle a start clip encoding command', async () => {
      jobMock.getQueueStatus.mockResolvedValue({ isActive: false, isPaused: false });

-      await sut.handleCommand(QueueName.CLIP_ENCODING, { command: JobCommand.START, force: false });
+      await sut.handleCommand(QueueName.SMART_SEARCH, { command: JobCommand.START, force: false });

      expect(jobMock.queue).toHaveBeenCalledWith({ name: JobName.QUEUE_ENCODE_CLIP, data: { force: false } });
    });
@@ -232,7 +232,7 @@ describe(JobService.name, () => {
      SystemConfigCore.create(newSystemConfigRepositoryMock(false)).config$.next({
        job: {
          [QueueName.BACKGROUND_TASK]: { concurrency: 10 },
-          [QueueName.CLIP_ENCODING]: { concurrency: 10 },
+          [QueueName.SMART_SEARCH]: { concurrency: 10 },
          [QueueName.METADATA_EXTRACTION]: { concurrency: 10 },
          [QueueName.OBJECT_TAGGING]: { concurrency: 10 },
          [QueueName.RECOGNIZE_FACES]: { concurrency: 10 },
@@ -247,7 +247,7 @@ describe(JobService.name, () => {
      } as SystemConfig);

      expect(jobMock.setConcurrency).toHaveBeenCalledWith(QueueName.BACKGROUND_TASK, 10);
-      expect(jobMock.setConcurrency).toHaveBeenCalledWith(QueueName.CLIP_ENCODING, 10);
+      expect(jobMock.setConcurrency).toHaveBeenCalledWith(QueueName.SMART_SEARCH, 10);
      expect(jobMock.setConcurrency).toHaveBeenCalledWith(QueueName.METADATA_EXTRACTION, 10);
      expect(jobMock.setConcurrency).toHaveBeenCalledWith(QueueName.OBJECT_TAGGING, 10);
      expect(jobMock.setConcurrency).toHaveBeenCalledWith(QueueName.RECOGNIZE_FACES, 10);
@@ -367,7 +367,7 @@ describe(JobService.name, () => {

    const featureTests: Array<{ queue: QueueName; feature: FeatureFlag; configKey: SystemConfigKey }> = [
      {
-        queue: QueueName.CLIP_ENCODING,
+        queue: QueueName.SMART_SEARCH,
        feature: FeatureFlag.CLIP_ENCODE,
        configKey: SystemConfigKey.MACHINE_LEARNING_CLIP_ENABLED,
      },
--- a/server/src/domain/job/job.service.ts
+++ b/server/src/domain/job/job.service.ts
@@ -98,7 +98,7 @@ export class JobService {
        await this.configCore.requireFeature(FeatureFlag.TAG_IMAGE);
        return this.jobRepository.queue({ name: JobName.QUEUE_OBJECT_TAGGING, data: { force } });

-      case QueueName.CLIP_ENCODING:
+      case QueueName.SMART_SEARCH:
        await this.configCore.requireFeature(FeatureFlag.CLIP_ENCODE);
        return this.jobRepository.queue({ name: JobName.QUEUE_ENCODE_CLIP, data: { force } });

--- a/server/src/domain/smart-info/smart-info.service.ts
+++ b/server/src/domain/smart-info/smart-info.service.ts
@@ -29,13 +29,13 @@ export class SmartInfoService {
  }

  async init() {
-    await this.jobRepository.pause(QueueName.CLIP_ENCODING);
+    await this.jobRepository.pause(QueueName.SMART_SEARCH);

-    let { isActive } = await this.jobRepository.getQueueStatus(QueueName.CLIP_ENCODING);
+    let { isActive } = await this.jobRepository.getQueueStatus(QueueName.SMART_SEARCH);
    while (isActive) {
      this.logger.verbose('Waiting for CLIP encoding queue to stop...');
      await setTimeout(1000).then(async () => {
-        ({ isActive } = await this.jobRepository.getQueueStatus(QueueName.CLIP_ENCODING));
+        ({ isActive } = await this.jobRepository.getQueueStatus(QueueName.SMART_SEARCH));
      });
    }

@@ -43,7 +43,7 @@ export class SmartInfoService {

    await this.repository.init(machineLearning.clip.modelName);

-    await this.jobRepository.resume(QueueName.CLIP_ENCODING);
+    await this.jobRepository.resume(QueueName.SMART_SEARCH);
  }

  async handleQueueObjectTagging({ force }: IBaseJob) {
--- a/server/src/domain/system-config/dto/system-config-job.dto.ts
+++ b/server/src/domain/system-config/dto/system-config-job.dto.ts
@@ -39,7 +39,7 @@ export class SystemConfigJobDto implements Record<QueueName, JobSettingsDto> {
  @ValidateNested()
  @IsObject()
  @Type(() => JobSettingsDto)
-  [QueueName.CLIP_ENCODING]!: JobSettingsDto;
+  [QueueName.SMART_SEARCH]!: JobSettingsDto;

  @ApiProperty({ type: JobSettingsDto })
  @ValidateNested()
--- a/server/src/domain/system-config/system-config.core.ts
+++ b/server/src/domain/system-config/system-config.core.ts
@@ -47,7 +47,7 @@ export const defaults = Object.freeze<SystemConfig>({
  },
  job: {
    [QueueName.BACKGROUND_TASK]: { concurrency: 5 },
-    [QueueName.CLIP_ENCODING]: { concurrency: 2 },
+    [QueueName.SMART_SEARCH]: { concurrency: 2 },
    [QueueName.METADATA_EXTRACTION]: { concurrency: 5 },
    [QueueName.OBJECT_TAGGING]: { concurrency: 2 },
    [QueueName.RECOGNIZE_FACES]: { concurrency: 2 },
--- a/server/src/domain/system-config/system-config.service.spec.ts
+++ b/server/src/domain/system-config/system-config.service.spec.ts
@@ -27,7 +27,7 @@ const updates: SystemConfigEntity[] = [
 const updatedConfig = Object.freeze<SystemConfig>({
  job: {
    [QueueName.BACKGROUND_TASK]: { concurrency: 5 },
-    [QueueName.CLIP_ENCODING]: { concurrency: 2 },
+    [QueueName.SMART_SEARCH]: { concurrency: 2 },
    [QueueName.METADATA_EXTRACTION]: { concurrency: 5 },
    [QueueName.OBJECT_TAGGING]: { concurrency: 2 },
    [QueueName.RECOGNIZE_FACES]: { concurrency: 2 },