refactor: split integrity out of maintenance controller/service

server/src/services/integrity.service.spec.ts

@@ -0,0 +1,22 @@
+import { IntegrityService } from 'src/services/integrity.service';
+import { newTestService, ServiceMocks } from 'test/utils';
+
+describe(IntegrityService.name, () => {
+  let sut: IntegrityService;
+  let mocks: ServiceMocks;
+
+  beforeEach(() => {
+    ({ sut, mocks } = newTestService(IntegrityService));
+  });
+
+  it('should work', () => {
+    expect(sut).toBeDefined();
+  });
+
+  describe.skip('getIntegrityReportSummary'); // just calls repository
+  describe.skip('getIntegrityReport'); // just calls repository
+  describe.skip('getIntegrityReportCsv'); // just calls repository
+
+  describe.todo('getIntegrityReportFile');
+  describe.todo('deleteIntegrityReport');
+});

server/src/services/integrity.service.ts

@@ -2,13 +2,21 @@ import { Injectable } from '@nestjs/common';
 import { createHash } from 'node:crypto';
 import { createReadStream } from 'node:fs';
 import { stat } from 'node:fs/promises';
-import { Writable } from 'node:stream';
+import { basename } from 'node:path';
+import { Readable, Writable } from 'node:stream';
 import { pipeline } from 'node:stream/promises';
 import { JOBS_LIBRARY_PAGINATION_SIZE } from 'src/constants';
 import { StorageCore } from 'src/cores/storage.core';
 import { OnEvent, OnJob } from 'src/decorators';
+import { AuthDto } from 'src/dtos/auth.dto';
+import {
+  MaintenanceGetIntegrityReportDto,
+  MaintenanceIntegrityReportResponseDto,
+  MaintenanceIntegrityReportSummaryResponseDto,
+} from 'src/dtos/maintenance.dto';
 import {
   AssetStatus,
+  CacheControl,
   DatabaseLock,
   ImmichWorker,
   IntegrityReportType,
@@ -28,6 +36,7 @@ import {
   IIntegrityPathWithChecksumJob,
   IIntegrityPathWithReportJob,
 } from 'src/types';
+import { ImmichFileResponse } from 'src/utils/file';
 import { handlePromiseError } from 'src/utils/misc';
 
 /**
@@ -145,6 +154,54 @@ export class IntegrityService extends BaseService {
     });
   }
 
+  getIntegrityReportSummary(): Promise<MaintenanceIntegrityReportSummaryResponseDto> {
+    return this.integrityRepository.getIntegrityReportSummary();
+  }
+
+  async getIntegrityReport(dto: MaintenanceGetIntegrityReportDto): Promise<MaintenanceIntegrityReportResponseDto> {
+    return {
+      items: await this.integrityRepository.getIntegrityReports(dto.type),
+    };
+  }
+
+  getIntegrityReportCsv(type: IntegrityReportType): Readable {
+    return this.integrityRepository.streamIntegrityReportsCSV(type);
+  }
+
+  async getIntegrityReportFile(id: string): Promise<ImmichFileResponse> {
+    const { path } = await this.integrityRepository.getById(id);
+
+    return new ImmichFileResponse({
+      path,
+      fileName: basename(path),
+      contentType: 'application/octet-stream',
+      cacheControl: CacheControl.PrivateWithoutCache,
+    });
+  }
+
+  async deleteIntegrityReport(auth: AuthDto, id: string): Promise<void> {
+    const { path, assetId, fileAssetId } = await this.integrityRepository.getById(id);
+
+    if (assetId) {
+      await this.assetRepository.updateAll([assetId], {
+        deletedAt: new Date(),
+        status: AssetStatus.Trashed,
+      });
+
+      await this.eventRepository.emit('AssetTrashAll', {
+        assetIds: [assetId],
+        userId: auth.user.id,
+      });
+
+      await this.integrityRepository.deleteById(id);
+    } else if (fileAssetId) {
+      await this.assetRepository.deleteFiles([{ id: fileAssetId }]);
+    } else {
+      await this.storageRepository.unlink(path);
+      await this.integrityRepository.deleteById(id);
+    }
+  }
+
   @OnJob({ name: JobName.IntegrityOrphanedFilesQueueAll, queue: QueueName.IntegrityCheck })
   async handleOrphanedFilesQueueAll({ refreshOnly }: IIntegrityJob = {}): Promise<JobStatus> {
     this.logger.log(`Checking for out of date orphaned file reports...`);

server/src/services/maintenance.service.spec.ts

@@ -106,7 +106,4 @@ describe(MaintenanceService.name, () => {
       expect(mocks.systemMetadata.get).toHaveBeenCalledTimes(1);
     });
   });
-
-  describe.skip('getIntegrityReportSummary'); // just calls repository
-  describe.skip('getIntegrityReport'); // just calls repository
 });

server/src/services/maintenance.service.ts

@@ -1,18 +1,9 @@
 import { Injectable } from '@nestjs/common';
-import { basename } from 'node:path';
-import { Readable } from 'node:stream';
 import { OnEvent } from 'src/decorators';
-import { AuthDto } from 'src/dtos/auth.dto';
-import {
-  MaintenanceAuthDto,
-  MaintenanceGetIntegrityReportDto,
-  MaintenanceIntegrityReportResponseDto,
-  MaintenanceIntegrityReportSummaryResponseDto,
-} from 'src/dtos/maintenance.dto';
-import { AssetStatus, CacheControl, IntegrityReportType, SystemMetadataKey } from 'src/enum';
+import { MaintenanceAuthDto } from 'src/dtos/maintenance.dto';
+import { SystemMetadataKey } from 'src/enum';
 import { BaseService } from 'src/services/base.service';
 import { MaintenanceModeState } from 'src/types';
-import { ImmichFileResponse } from 'src/utils/file';
 import { createMaintenanceLoginUrl, generateMaintenanceSecret, signMaintenanceJwt } from 'src/utils/maintenance';
 import { getExternalDomain } from 'src/utils/misc';
 
@@ -59,52 +50,4 @@ export class MaintenanceService extends BaseService {
 
     return await createMaintenanceLoginUrl(baseUrl, auth, secret);
   }
-
-  getIntegrityReportSummary(): Promise<MaintenanceIntegrityReportSummaryResponseDto> {
-    return this.integrityRepository.getIntegrityReportSummary();
-  }
-
-  async getIntegrityReport(dto: MaintenanceGetIntegrityReportDto): Promise<MaintenanceIntegrityReportResponseDto> {
-    return {
-      items: await this.integrityRepository.getIntegrityReports(dto.type),
-    };
-  }
-
-  getIntegrityReportCsv(type: IntegrityReportType): Readable {
-    return this.integrityRepository.streamIntegrityReportsCSV(type);
-  }
-
-  async getIntegrityReportFile(id: string): Promise<ImmichFileResponse> {
-    const { path } = await this.integrityRepository.getById(id);
-
-    return new ImmichFileResponse({
-      path,
-      fileName: basename(path),
-      contentType: 'application/octet-stream',
-      cacheControl: CacheControl.PrivateWithoutCache,
-    });
-  }
-
-  async deleteIntegrityReport(auth: AuthDto, id: string): Promise<void> {
-    const { path, assetId, fileAssetId } = await this.integrityRepository.getById(id);
-
-    if (assetId) {
-      await this.assetRepository.updateAll([assetId], {
-        deletedAt: new Date(),
-        status: AssetStatus.Trashed,
-      });
-
-      await this.eventRepository.emit('AssetTrashAll', {
-        assetIds: [assetId],
-        userId: auth.user.id,
-      });
-
-      await this.integrityRepository.deleteById(id);
-    } else if (fileAssetId) {
-      await this.assetRepository.deleteFiles([{ id: fileAssetId }]);
-    } else {
-      await this.storageRepository.unlink(path);
-      await this.integrityRepository.deleteById(id);
-    }
-  }
 }