feat: ability to delete all reports (and corresponding objects)

server/src/controllers/maintenance.controller.ts

@@ -82,6 +82,17 @@ export class MaintenanceController {
     return this.service.getIntegrityReport(dto);
   }
 
+  @Delete('integrity/report/:id')
+  @Endpoint({
+    summary: 'Delete report entry and perform corresponding deletion action',
+    description: '...',
+    history: new HistoryBuilder().added('v9.9.9').alpha('v9.9.9'),
+  })
+  @Authenticated({ permission: Permission.Maintenance, admin: true })
+  async deleteIntegrityReport(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<void> {
+    await this.service.deleteIntegrityReport(auth, id);
+  }
+
   @Get('integrity/report/:type/csv')
   @Endpoint({
     summary: 'Export integrity report by type as CSV',
@@ -113,15 +124,4 @@ export class MaintenanceController {
   ): Promise<void> {
     await sendFile(res, next, () => this.service.getIntegrityReportFile(id), this.logger);
   }
-
-  @Delete('integrity/report/:id/file')
-  @Endpoint({
-    summary: 'Delete associated file if it exists',
-    description: '...',
-    history: new HistoryBuilder().added('v9.9.9').alpha('v9.9.9'),
-  })
-  @Authenticated({ permission: Permission.Maintenance, admin: true })
-  async deleteIntegrityReportFile(@Param() { id }: UUIDParamDto): Promise<void> {
-    await this.service.deleteIntegrityReportFile(id);
-  }
 }

server/src/dtos/maintenance.dto.ts

@@ -37,6 +37,11 @@ export class MaintenanceGetIntegrityReportDto {
   // page?: number;
 }
 
+export class MaintenanceDeleteIntegrityReportDto {
+  @ValidateEnum({ enum: IntegrityReportType, name: 'IntegrityReportType' })
+  type!: IntegrityReportType;
+}
+
 class MaintenanceIntegrityReportDto {
   id!: string;
   @ValidateEnum({ enum: IntegrityReportType, name: 'IntegrityReportType' })

server/src/enum.ts

@@ -364,6 +364,9 @@ export enum ManualJobName {
   IntegrityMissingFilesRefresh = `integrity-missing-files-refresh`,
   IntegrityOrphanFilesRefresh = `integrity-orphan-files-refresh`,
   IntegrityChecksumFilesRefresh = `integrity-checksum-mismatch-refresh`,
+  IntegrityMissingFilesDeleteAll = `integrity-missing-files-delete-all`,
+  IntegrityOrphanFilesDeleteAll = `integrity-orphan-files-delete-all`,
+  IntegrityChecksumFilesDeleteAll = `integrity-checksum-mismatch-delete-all`,
 }
 
 export enum AssetPathType {
@@ -660,6 +663,7 @@ export enum JobName {
   IntegrityMissingFilesRefresh = 'IntegrityMissingFilesRefresh',
   IntegrityChecksumFiles = 'IntegrityChecksumFiles',
   IntegrityChecksumFilesRefresh = 'IntegrityChecksumFilesRefresh',
+  IntegrityReportDelete = 'IntegrityReportDelete',
 }
 
 export enum QueueCommand {

server/src/repositories/integrity-report.repository.ts

@@ -2,6 +2,7 @@ import { Injectable } from '@nestjs/common';
 import { Insertable, Kysely } from 'kysely';
 import { InjectKysely } from 'nestjs-kysely';
 import { Readable } from 'node:stream';
+import { DummyValue, GenerateSql } from 'src/decorators';
 import {
   MaintenanceGetIntegrityReportDto,
   MaintenanceIntegrityReportResponseDto,
@@ -101,4 +102,15 @@ export class IntegrityReportRepository {
   deleteByIds(ids: string[]) {
     return this.db.deleteFrom('integrity_report').where('id', 'in', ids).execute();
   }
+
+  @GenerateSql({ params: [DummyValue.STRING], stream: true })
+  streamIntegrityReportsByProperty(property?: 'assetId' | 'fileAssetId', filterType?: IntegrityReportType) {
+    return this.db
+      .selectFrom('integrity_report')
+      .select(['id', 'path', 'assetId', 'fileAssetId'])
+      .$if(filterType !== undefined, (eb) => eb.where('type', '=', filterType!))
+      .$if(property === undefined, (eb) => eb.where('assetId', 'is', null).where('fileAssetId', 'is', null))
+      .$if(property !== undefined, (eb) => eb.where(property!, 'is not', null))
+      .stream();
+  }
 }

server/src/services/integrity.service.ts

@@ -8,6 +8,7 @@ import { JOBS_LIBRARY_PAGINATION_SIZE } from 'src/constants';
 import { StorageCore } from 'src/cores/storage.core';
 import { OnEvent, OnJob } from 'src/decorators';
 import {
+  AssetStatus,
   DatabaseLock,
   ImmichWorker,
   IntegrityReportType,
@@ -20,6 +21,7 @@ import {
 import { ArgOf } from 'src/repositories/event.repository';
 import { BaseService } from 'src/services/base.service';
 import {
+  IIntegrityDeleteReportJob,
   IIntegrityJob,
   IIntegrityMissingFilesJob,
   IIntegrityOrphanedFilesJob,
@@ -42,7 +44,7 @@ import { handlePromiseError } from 'src/utils/misc';
  *     Check whether files exist on disk
  *
  *   * Reports must include origin (asset or asset_file) & ID for further action
- *   * Can perform trash (asset) or dereference (asset_file)
+ *   * Can perform trash (asset) or delete (asset_file)
  *
  * Checksum Mismatch:
  *   Paths & checksums are queried from asset(originalPath, checksum)
@@ -548,6 +550,68 @@ export class IntegrityService extends BaseService {
     this.logger.log(`Processed ${paths.length} paths and found ${reportIds.length} report(s) out of date.`);
     return JobStatus.Success;
   }
+
+  @OnJob({ name: JobName.IntegrityReportDelete, queue: QueueName.BackgroundTask })
+  async handleDeleteIntegrityReport({ type }: IIntegrityDeleteReportJob): Promise<JobStatus> {
+    this.logger.log(`Deleting all entries for ${type ?? 'all types of'} integrity report`);
+
+    let properties;
+    switch (type) {
+      case IntegrityReportType.ChecksumFail: {
+        properties = ['assetId'] as const;
+        break;
+      }
+      case IntegrityReportType.MissingFile: {
+        properties = ['assetId', 'fileAssetId'] as const;
+        break;
+      }
+      case IntegrityReportType.OrphanFile: {
+        properties = [void 0] as const;
+        break;
+      }
+      default: {
+        properties = [void 0, 'assetId', 'fileAssetId'] as const;
+        break;
+      }
+    }
+
+    for (const property of properties) {
+      const reports = this.integrityReportRepository.streamIntegrityReportsByProperty(property, type);
+      for await (const report of chunk(reports, JOBS_LIBRARY_PAGINATION_SIZE)) {
+        // todo: queue sub-job here instead?
+
+        switch (property) {
+          case 'assetId': {
+            const ids = report.map(({ assetId }) => assetId!);
+            await this.assetRepository.updateAll(ids, {
+              deletedAt: new Date(),
+              status: AssetStatus.Trashed,
+            });
+
+            await this.eventRepository.emit('AssetTrashAll', {
+              assetIds: ids,
+              userId: '', // ???
+            });
+
+            await this.integrityReportRepository.deleteByIds(report.map(({ id }) => id));
+            break;
+          }
+          case 'fileAssetId': {
+            await this.assetRepository.deleteFiles(report.map(({ fileAssetId }) => ({ id: fileAssetId! })));
+            break;
+          }
+          default: {
+            await Promise.all(report.map(({ path }) => this.storageRepository.unlink(path).catch(() => void 0)));
+            await this.integrityReportRepository.deleteByIds(report.map(({ id }) => id));
+            break;
+          }
+        }
+      }
+    }
+
+    this.logger.log('Finished deleting integrity report.');
+    return JobStatus.Success;
+  }
 }
 
 async function* chunk<T>(generator: AsyncIterableIterator<T>, n: number) {

server/src/services/job.service.ts

@@ -2,7 +2,7 @@ import { BadRequestException, Injectable } from '@nestjs/common';
 import { OnEvent } from 'src/decorators';
 import { mapAsset } from 'src/dtos/asset-response.dto';
 import { JobCreateDto } from 'src/dtos/job.dto';
-import { AssetType, AssetVisibility, JobName, JobStatus, ManualJobName } from 'src/enum';
+import { AssetType, AssetVisibility, IntegrityReportType, JobName, JobStatus, ManualJobName } from 'src/enum';
 import { ArgsOf } from 'src/repositories/event.repository';
 import { BaseService } from 'src/services/base.service';
 import { JobItem } from 'src/types';
@@ -58,6 +58,18 @@ const asJobItem = (dto: JobCreateDto): JobItem => {
       return { name: JobName.IntegrityChecksumFiles, data: { refreshOnly: true } };
     }
 
+    case ManualJobName.IntegrityMissingFilesDeleteAll: {
+      return { name: JobName.IntegrityReportDelete, data: { type: IntegrityReportType.MissingFile } };
+    }
+
+    case ManualJobName.IntegrityOrphanFilesDeleteAll: {
+      return { name: JobName.IntegrityReportDelete, data: { type: IntegrityReportType.OrphanFile } };
+    }
+
+    case ManualJobName.IntegrityChecksumFilesDeleteAll: {
+      return { name: JobName.IntegrityReportDelete, data: { type: IntegrityReportType.ChecksumFail } };
+    }
+
     default: {
       throw new BadRequestException('Invalid job name');
     }

server/src/services/maintenance.service.ts

@@ -2,13 +2,14 @@ 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 { CacheControl, IntegrityReportType, SystemMetadataKey } from 'src/enum';
+import { AssetStatus, CacheControl, IntegrityReportType, SystemMetadataKey } from 'src/enum';
 import { BaseService } from 'src/services/base.service';
 import { MaintenanceModeState } from 'src/types';
 import { ImmichFileResponse } from 'src/utils/file';
@@ -82,9 +83,26 @@ export class MaintenanceService extends BaseService {
     });
   }
 
-  async deleteIntegrityReportFile(id: string): Promise<void> {
-    const { path } = await this.integrityReportRepository.getById(id);
-    await this.storageRepository.unlink(path);
-    await this.integrityReportRepository.deleteById(id);
+  async deleteIntegrityReport(auth: AuthDto, id: string): Promise<void> {
+    const { path, assetId, fileAssetId } = await this.integrityReportRepository.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.integrityReportRepository.deleteById(id);
+    } else if (fileAssetId) {
+      await this.assetRepository.deleteFiles([{ id: fileAssetId }]);
+    } else {
+      await this.storageRepository.unlink(path);
+      await this.integrityReportRepository.deleteById(id);
+    }
   }
 }

server/src/types.ts

@@ -10,6 +10,7 @@ import {
   DatabaseSslMode,
   ExifOrientation,
   ImageFormat,
+  IntegrityReportType,
   JobName,
   MemoryType,
   PluginTriggerType,
@@ -286,6 +287,10 @@ export interface IIntegrityJob {
   refreshOnly?: boolean;
 }
 
+export interface IIntegrityDeleteReportJob {
+  type?: IntegrityReportType;
+}
+
 export interface IIntegrityOrphanedFilesJob {
   type: 'asset' | 'asset_file';
   paths: string[];
@@ -427,7 +432,8 @@ export type JobItem =
   | { name: JobName.IntegrityMissingFiles; data: IIntegrityPathWithReportJob }
   | { name: JobName.IntegrityMissingFilesRefresh; data: IIntegrityPathWithReportJob }
   | { name: JobName.IntegrityChecksumFiles; data?: IIntegrityJob }
-  | { name: JobName.IntegrityChecksumFilesRefresh; data?: IIntegrityPathWithChecksumJob };
+  | { name: JobName.IntegrityChecksumFilesRefresh; data?: IIntegrityPathWithChecksumJob }
+  | { name: JobName.IntegrityReportDelete; data: IIntegrityDeleteReportJob };
 
 export type VectorExtension = (typeof VECTOR_EXTENSIONS)[number];