From 305bf60f97f358b55fc5964d1844873d4b3d7752 Mon Sep 17 00:00:00 2001 From: izzy Date: Wed, 3 Dec 2025 11:10:33 +0000 Subject: [PATCH] refactor: ensure detect install is consistently named --- open-api/immich-openapi-specs.json | 60 +++++++++---------- .../src/controllers/maintenance.controller.ts | 4 +- server/src/dtos/maintenance.dto.ts | 6 +- .../maintenance-worker.controller.ts | 6 +- .../maintenance/maintenance-worker.service.ts | 4 +- server/src/services/maintenance.service.ts | 4 +- server/src/utils/maintenance.ts | 4 +- 7 files changed, 44 insertions(+), 44 deletions(-) diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.json index e20de055ad..0e2613d430 100644 --- a/open-api/immich-openapi-specs.json +++ b/open-api/immich-openapi-specs.json @@ -613,7 +613,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MaintenanceIntegrityResponseDto" + "$ref": "#/components/schemas/MaintenanceDetectInstallResponseDto" } } }, @@ -17218,11 +17218,11 @@ ], "type": "object" }, - "MaintenanceIntegrityResponseDto": { + "MaintenanceDetectInstallResponseDto": { "properties": { "storage": { "items": { - "$ref": "#/components/schemas/MaintenanceStorageFolderIntegrityDto" + "$ref": "#/components/schemas/MaintenanceDetectInstallStorageFolderDto" }, "type": "array" } @@ -17232,6 +17232,33 @@ ], "type": "object" }, + "MaintenanceDetectInstallStorageFolderDto": { + "properties": { + "files": { + "type": "number" + }, + "folder": { + "allOf": [ + { + "$ref": "#/components/schemas/StorageFolder" + } + ] + }, + "readable": { + "type": "boolean" + }, + "writable": { + "type": "boolean" + } + }, + "required": [ + "files", + "folder", + "readable", + "writable" + ], + "type": "object" + }, "MaintenanceListBackupsResponseDto": { "properties": { "backups": { @@ -17282,33 +17309,6 @@ ], "type": "object" }, - "MaintenanceStorageFolderIntegrityDto": { - "properties": { - "files": { - "type": "number" - }, - "folder": { - "allOf": [ - { - "$ref": "#/components/schemas/StorageFolder" - } - ] - }, - "readable": { - "type": "boolean" - }, - "writable": { - "type": "boolean" - } - }, - "required": [ - "files", - "folder", - "readable", - "writable" - ], - "type": "object" - }, "MaintenanceUploadBackupDto": { "properties": { "file": { diff --git a/server/src/controllers/maintenance.controller.ts b/server/src/controllers/maintenance.controller.ts index a6b5e21787..6e678189e7 100644 --- a/server/src/controllers/maintenance.controller.ts +++ b/server/src/controllers/maintenance.controller.ts @@ -5,7 +5,7 @@ import { Endpoint, HistoryBuilder } from 'src/decorators'; import { AuthDto } from 'src/dtos/auth.dto'; import { MaintenanceAuthDto, - MaintenanceIntegrityResponseDto, + MaintenanceDetectInstallResponseDto, MaintenanceLoginDto, MaintenanceStatusResponseDto, SetMaintenanceModeDto, @@ -37,7 +37,7 @@ export class MaintenanceController { description: 'Collect integrity checks and other heuristics about local data.', history: new HistoryBuilder().added('v2.4.0').alpha('v2.4.0'), }) - detectPriorInstall(): Promise { + detectPriorInstall(): Promise { return this.service.detectPriorInstall(); } diff --git a/server/src/dtos/maintenance.dto.ts b/server/src/dtos/maintenance.dto.ts index 0b8587d8c6..4e76b1fbb1 100644 --- a/server/src/dtos/maintenance.dto.ts +++ b/server/src/dtos/maintenance.dto.ts @@ -30,7 +30,7 @@ export class MaintenanceStatusResponseDto { error?: string; } -export class MaintenanceStorageFolderIntegrityDto { +export class MaintenanceDetectInstallStorageFolderDto { @ValidateEnum({ enum: StorageFolder, name: 'StorageFolder' }) folder!: StorageFolder; readable!: boolean; @@ -38,8 +38,8 @@ export class MaintenanceStorageFolderIntegrityDto { files!: number; } -export class MaintenanceIntegrityResponseDto { - storage!: MaintenanceStorageFolderIntegrityDto[]; +export class MaintenanceDetectInstallResponseDto { + storage!: MaintenanceDetectInstallStorageFolderDto[]; } export class MaintenanceListBackupsResponseDto { diff --git a/server/src/maintenance/maintenance-worker.controller.ts b/server/src/maintenance/maintenance-worker.controller.ts index 4259b1289a..4d4ef40a65 100644 --- a/server/src/maintenance/maintenance-worker.controller.ts +++ b/server/src/maintenance/maintenance-worker.controller.ts @@ -15,7 +15,7 @@ import { FileInterceptor } from '@nestjs/platform-express'; import { NextFunction, Request, Response } from 'express'; import { MaintenanceAuthDto, - MaintenanceIntegrityResponseDto, + MaintenanceDetectInstallResponseDto, MaintenanceListBackupsResponseDto, MaintenanceLoginDto, MaintenanceStatusResponseDto, @@ -49,8 +49,8 @@ export class MaintenanceWorkerController { return this.service.status(request.cookies[ImmichCookie.MaintenanceToken]); } - @Get('admin/maintenance/integrity') - detectPriorInstall(): Promise { + @Get('admin/maintenance/detect-install') + detectPriorInstall(): Promise { return this.service.detectPriorInstall(); } diff --git a/server/src/maintenance/maintenance-worker.service.ts b/server/src/maintenance/maintenance-worker.service.ts index 2607d612ac..626640020d 100644 --- a/server/src/maintenance/maintenance-worker.service.ts +++ b/server/src/maintenance/maintenance-worker.service.ts @@ -8,7 +8,7 @@ import { join } from 'node:path'; import { StorageCore } from 'src/cores/storage.core'; import { MaintenanceAuthDto, - MaintenanceIntegrityResponseDto, + MaintenanceDetectInstallResponseDto, MaintenanceStatusResponseDto, SetMaintenanceModeDto, } from 'src/dtos/maintenance.dto'; @@ -258,7 +258,7 @@ export class MaintenanceWorkerService { } } - detectPriorInstall(): Promise { + detectPriorInstall(): Promise { return detectPriorInstall(this.storageRepository); } diff --git a/server/src/services/maintenance.service.ts b/server/src/services/maintenance.service.ts index 92ab27392c..1951c69d95 100644 --- a/server/src/services/maintenance.service.ts +++ b/server/src/services/maintenance.service.ts @@ -2,7 +2,7 @@ import { BadRequestException, Injectable } from '@nestjs/common'; import { OnEvent } from 'src/decorators'; import { MaintenanceAuthDto, - MaintenanceIntegrityResponseDto, + MaintenanceDetectInstallResponseDto, MaintenanceStatusResponseDto, SetMaintenanceModeDto, } from 'src/dtos/maintenance.dto'; @@ -35,7 +35,7 @@ export class MaintenanceService extends BaseService { }; } - detectPriorInstall(): Promise { + detectPriorInstall(): Promise { return detectPriorInstall(this.storageRepository); } diff --git a/server/src/utils/maintenance.ts b/server/src/utils/maintenance.ts index 8691f57985..04dd7796fc 100644 --- a/server/src/utils/maintenance.ts +++ b/server/src/utils/maintenance.ts @@ -5,7 +5,7 @@ import { randomBytes } from 'node:crypto'; import { join } from 'node:path'; import { Server as SocketIO } from 'socket.io'; import { StorageCore } from 'src/cores/storage.core'; -import { MaintenanceAuthDto, MaintenanceIntegrityResponseDto } from 'src/dtos/maintenance.dto'; +import { MaintenanceAuthDto, MaintenanceDetectInstallResponseDto } from 'src/dtos/maintenance.dto'; import { StorageFolder } from 'src/enum'; import { ConfigRepository } from 'src/repositories/config.repository'; import { AppRestartEvent } from 'src/repositories/event.repository'; @@ -79,7 +79,7 @@ export function generateMaintenanceSecret(): string { export async function detectPriorInstall( storageRepository: StorageRepository, -): Promise { +): Promise { return { storage: await Promise.all( Object.values(StorageFolder).map(async (folder) => {