test: e2e tests for get report and delete entries

2025-12-23 17:25:11 +03:00 · 2025-12-18 18:26:27 +00:00
parent 042335f3cd
commit bb4893d0d7
2 changed files with 250 additions and 18 deletions
--- a/e2e/src/api/specs/integrity.e2e-spec.ts
+++ b/e2e/src/api/specs/integrity.e2e-spec.ts
@@ -1,4 +1,11 @@
-import { IntegrityReportType, LoginResponseDto, ManualJobName, QueueName } from '@immich/sdk';
+import {
+  AssetMediaResponseDto,
+  IntegrityReportResponseDto,
+  IntegrityReportType,
+  LoginResponseDto,
+  ManualJobName,
+  QueueName,
+} from '@immich/sdk';
 import { readFile } from 'node:fs/promises';
 import { app, testAssetDir, utils } from 'src/utils';
 import request from 'supertest';
@@ -8,17 +15,15 @@ const assetFilepath = `${testAssetDir}/metadata/gps-position/thompson-springs.jp

 describe('/admin/integrity', () => {
  let admin: LoginResponseDto;
+  let asset: AssetMediaResponseDto;

  beforeAll(async () => {
    await utils.resetDatabase();
    admin = await utils.adminSetup();
  });

-  describe('POST /summary (& jobs)', async () => {
-    let baseline: Record<IntegrityReportType, number>;
-
  beforeAll(async () => {
-      await utils.createAsset(admin.accessToken, {
+    asset = await utils.createAsset(admin.accessToken, {
      assetData: {
        filename: 'asset.jpg',
        bytes: await readFile(assetFilepath),
@@ -33,6 +38,9 @@ describe('/admin/integrity', () => {
    await utils.copyFolder(`/data/upload/${admin.userId}-bak`, `/data/upload/${admin.userId}`);
  });

+  describe('POST /summary (& jobs)', async () => {
+    let baseline: Record<IntegrityReportType, number>;
+
    it.sequential('may report issues', async () => {
      await utils.createJob(admin.accessToken, {
        name: ManualJobName.IntegrityOrphanFiles,
@@ -195,4 +203,227 @@ describe('/admin/integrity', () => {
      );
    });
  });
+
+  describe('POST /report', async () => {
+    it.sequential('reports orphan files', async () => {
+      await utils.putTextFile('orphan', `/data/upload/${admin.userId}/orphan1.png`);
+
+      await utils.createJob(admin.accessToken, {
+        name: ManualJobName.IntegrityOrphanFiles,
+      });
+
+      await utils.waitForQueueFinish(admin.accessToken, QueueName.IntegrityCheck);
+
+      const { status, body } = await request(app)
+        .post('/admin/integrity/report')
+        .set('Authorization', `Bearer ${admin.accessToken}`)
+        .send({ type: 'orphan_file' });
+
+      expect(status).toBe(200);
+      expect(body).toEqual({
+        hasNextPage: expect.any(Boolean),
+        items: expect.arrayContaining([
+          {
+            id: expect.any(String),
+            type: 'orphan_file',
+            path: `/data/upload/${admin.userId}/orphan1.png`,
+            assetId: null,
+            fileAssetId: null,
+          },
+        ]),
+      });
+    });
+
+    it.sequential('reports missing files', async () => {
+      await utils.deleteFolder(`/data/upload/${admin.userId}`);
+
+      await utils.createJob(admin.accessToken, {
+        name: ManualJobName.IntegrityMissingFiles,
+      });
+
+      await utils.waitForQueueFinish(admin.accessToken, QueueName.IntegrityCheck);
+
+      const { status, body } = await request(app)
+        .post('/admin/integrity/report')
+        .set('Authorization', `Bearer ${admin.accessToken}`)
+        .send({ type: 'missing_file' });
+
+      expect(status).toBe(200);
+      expect(body).toEqual({
+        hasNextPage: expect.any(Boolean),
+        items: expect.arrayContaining([
+          {
+            id: expect.any(String),
+            type: 'missing_file',
+            path: expect.any(String),
+            assetId: asset.id,
+            fileAssetId: null,
+          },
+        ]),
+      });
+    });
+
+    it.sequential('reports checksum mismatched files', async () => {
+      await utils.truncateFolder(`/data/upload/${admin.userId}`);
+
+      await utils.createJob(admin.accessToken, {
+        name: ManualJobName.IntegrityChecksumMismatch,
+      });
+
+      await utils.waitForQueueFinish(admin.accessToken, QueueName.IntegrityCheck);
+
+      const { status, body } = await request(app)
+        .post('/admin/integrity/report')
+        .set('Authorization', `Bearer ${admin.accessToken}`)
+        .send({ type: 'checksum_mismatch' });
+
+      expect(status).toBe(200);
+      expect(body).toEqual({
+        hasNextPage: expect.any(Boolean),
+        items: expect.arrayContaining([
+          {
+            id: expect.any(String),
+            type: 'checksum_mismatch',
+            path: expect.any(String),
+            assetId: asset.id,
+            fileAssetId: null,
+          },
+        ]),
+      });
+    });
+  });
+
+  describe('DELETE /report/:id', async () => {
+    it.sequential('delete orphan files', async () => {
+      await utils.putTextFile('orphan', `/data/upload/${admin.userId}/orphan1.png`);
+
+      await utils.createJob(admin.accessToken, {
+        name: ManualJobName.IntegrityOrphanFiles,
+      });
+
+      await utils.waitForQueueFinish(admin.accessToken, QueueName.IntegrityCheck);
+
+      const { status: listStatus, body: listBody } = await request(app)
+        .post('/admin/integrity/report')
+        .set('Authorization', `Bearer ${admin.accessToken}`)
+        .send({ type: 'orphan_file' });
+
+      expect(listStatus).toBe(200);
+
+      const report = (listBody as IntegrityReportResponseDto).items.find(
+        (item) => item.path === `/data/upload/${admin.userId}/orphan1.png`,
+      )!;
+
+      const { status } = await request(app)
+        .delete(`/admin/integrity/report/${report.id}`)
+        .set('Authorization', `Bearer ${admin.accessToken}`)
+        .send();
+
+      expect(status).toBe(200);
+
+      await utils.createJob(admin.accessToken, {
+        name: ManualJobName.IntegrityOrphanFiles,
+      });
+
+      await utils.waitForQueueFinish(admin.accessToken, QueueName.IntegrityCheck);
+
+      const { status: listStatus2, body: listBody2 } = await request(app)
+        .post('/admin/integrity/report')
+        .set('Authorization', `Bearer ${admin.accessToken}`)
+        .send({ type: 'orphan_file' });
+
+      expect(listStatus2).toBe(200);
+      expect(listBody2).not.toBe(
+        expect.objectContaining({
+          items: expect.arrayContaining([
+            expect.objectContaining({
+              id: report.id,
+            }),
+          ]),
+        }),
+      );
+    });
+
+    it.sequential('delete assets missing files', async () => {
+      await utils.deleteFolder(`/data/upload/${admin.userId}`);
+
+      await utils.createJob(admin.accessToken, {
+        name: ManualJobName.IntegrityMissingFiles,
+      });
+
+      await utils.waitForQueueFinish(admin.accessToken, QueueName.IntegrityCheck);
+
+      const { status: listStatus, body: listBody } = await request(app)
+        .post('/admin/integrity/report')
+        .set('Authorization', `Bearer ${admin.accessToken}`)
+        .send({ type: 'missing_file' });
+
+      expect(listStatus).toBe(200);
+      expect(listBody.items.length).toBe(1);
+
+      const report = (listBody as IntegrityReportResponseDto).items[0];
+
+      const { status } = await request(app)
+        .delete(`/admin/integrity/report/${report.id}`)
+        .set('Authorization', `Bearer ${admin.accessToken}`)
+        .send();
+
+      expect(status).toBe(200);
+
+      await utils.createJob(admin.accessToken, {
+        name: ManualJobName.IntegrityMissingFiles,
+      });
+
+      await utils.waitForQueueFinish(admin.accessToken, QueueName.IntegrityCheck);
+
+      const { status: listStatus2, body: listBody2 } = await request(app)
+        .post('/admin/integrity/report')
+        .set('Authorization', `Bearer ${admin.accessToken}`)
+        .send({ type: 'missing_file' });
+
+      expect(listStatus2).toBe(200);
+      expect(listBody2.items.length).toBe(0);
+    });
+
+    it.sequential('delete assets with failing checksum', async () => {
+      await utils.truncateFolder(`/data/upload/${admin.userId}`);
+
+      await utils.createJob(admin.accessToken, {
+        name: ManualJobName.IntegrityChecksumMismatch,
+      });
+
+      await utils.waitForQueueFinish(admin.accessToken, QueueName.IntegrityCheck);
+
+      const { status: listStatus, body: listBody } = await request(app)
+        .post('/admin/integrity/report')
+        .set('Authorization', `Bearer ${admin.accessToken}`)
+        .send({ type: 'checksum_mismatch' });
+
+      expect(listStatus).toBe(200);
+      expect(listBody.items.length).toBe(1);
+
+      const report = (listBody as IntegrityReportResponseDto).items[0];
+
+      const { status } = await request(app)
+        .delete(`/admin/integrity/report/${report.id}`)
+        .set('Authorization', `Bearer ${admin.accessToken}`)
+        .send();
+
+      expect(status).toBe(200);
+
+      await utils.createJob(admin.accessToken, {
+        name: ManualJobName.IntegrityChecksumMismatch,
+      });
+
+      await utils.waitForQueueFinish(admin.accessToken, QueueName.IntegrityCheck);
+
+      const { status: listStatus2, body: listBody2 } = await request(app)
+        .post('/admin/integrity/report')
+        .set('Authorization', `Bearer ${admin.accessToken}`)
+        .send({ type: 'checksum_mismatch' });
+
+      expect(listStatus2).toBe(200);
+      expect(listBody2.items.length).toBe(0);
+    });
+  });
 });
--- a/server/src/controllers/integrity.controller.ts
+++ b/server/src/controllers/integrity.controller.ts
@@ -1,4 +1,4 @@
-import { Body, Controller, Delete, Get, Next, Param, Post, Res } from '@nestjs/common';
+import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Next, Param, Post, Res } from '@nestjs/common';
 import { ApiTags } from '@nestjs/swagger';
 import { NextFunction, Response } from 'express';
 import { Endpoint, HistoryBuilder } from 'src/decorators';
@@ -35,6 +35,7 @@ export class IntegrityController {
  }

  @Post('report')
+  @HttpCode(HttpStatus.OK)
  @Endpoint({
    summary: 'Get integrity report by type',
    description: 'Get all flagged items by integrity report type',