refactor: use action property for setting maint. mode

e2e/src/api/specs/maintenance.e2e-spec.ts

@@ -39,7 +39,7 @@ describe('/admin/maintenance', () => {
   describe.sequential('POST /', () => {
     it('should require authentication', async () => {
       const { status, body } = await request(app).post('/admin/maintenance').send({
-        maintenanceMode: false,
+        action: 'end',
       });
       expect(status).toBe(401);
       expect(body).toEqual(errorDto.unauthorized);
@@ -49,7 +49,7 @@ describe('/admin/maintenance', () => {
       const { status, body } = await request(app)
         .post('/admin/maintenance')
         .set('Authorization', `Bearer ${nonAdmin.accessToken}`)
-        .send({ maintenanceMode: false });
+        .send({ action: 'end' });
       expect(status).toBe(403);
       expect(body).toEqual(errorDto.forbidden);
     });
@@ -58,7 +58,7 @@ describe('/admin/maintenance', () => {
       const { status } = await request(app)
         .post('/admin/maintenance')
         .set('Authorization', `Bearer ${admin.accessToken}`)
-        .send({ maintenanceMode: false });
+        .send({ action: 'end' });
       expect(status).toBe(201);
     });
 
@@ -67,7 +67,7 @@ describe('/admin/maintenance', () => {
         .post('/admin/maintenance')
         .set('Authorization', `Bearer ${admin.accessToken}`)
         .send({
-          maintenanceMode: true,
+          action: 'start',
         });
       expect(status).toBe(201);
 
@@ -139,7 +139,7 @@ describe('/admin/maintenance', () => {
         const { status } = await request(app)
           .post('/admin/maintenance')
           .set('cookie', cookie!)
-          .send({ maintenanceMode: true });
+          .send({ action: 'start' });
         expect(status).toBe(201);
       });
     });
@@ -151,7 +151,7 @@ describe('/admin/maintenance', () => {
     it('should exit maintenance mode', async () => {
       console.info('using', cookie!);
       const { status } = await request(app).post('/admin/maintenance').set('cookie', cookie!).send({
-        maintenanceMode: false,
+        action: 'end',
       });
 
       expect(status).toBe(201);

mobile/openapi/README.md

@@ -405,6 +405,7 @@ Class | Method | HTTP request | Description
  - [LoginResponseDto](doc//LoginResponseDto.md)
  - [LogoutResponseDto](doc//LogoutResponseDto.md)
  - [MachineLearningAvailabilityChecksDto](doc//MachineLearningAvailabilityChecksDto.md)
+ - [MaintenanceAction](doc//MaintenanceAction.md)
  - [MaintenanceAuthDto](doc//MaintenanceAuthDto.md)
  - [MaintenanceLoginDto](doc//MaintenanceLoginDto.md)
  - [ManualJobName](doc//ManualJobName.md)

mobile/openapi/lib/api.dart

@@ -168,6 +168,7 @@ part 'model/login_credential_dto.dart';
 part 'model/login_response_dto.dart';
 part 'model/logout_response_dto.dart';
 part 'model/machine_learning_availability_checks_dto.dart';
+part 'model/maintenance_action.dart';
 part 'model/maintenance_auth_dto.dart';
 part 'model/maintenance_login_dto.dart';
 part 'model/manual_job_name.dart';

mobile/openapi/lib/api_client.dart

@@ -390,6 +390,8 @@ class ApiClient {
           return LogoutResponseDto.fromJson(value);
         case 'MachineLearningAvailabilityChecksDto':
           return MachineLearningAvailabilityChecksDto.fromJson(value);
+        case 'MaintenanceAction':
+          return MaintenanceActionTypeTransformer().decode(value);
         case 'MaintenanceAuthDto':
           return MaintenanceAuthDto.fromJson(value);
         case 'MaintenanceLoginDto':

mobile/openapi/lib/api_helper.dart

@@ -103,6 +103,9 @@ String parameterToString(dynamic value) {
   if (value is LogLevel) {
     return LogLevelTypeTransformer().encode(value).toString();
   }
+  if (value is MaintenanceAction) {
+    return MaintenanceActionTypeTransformer().encode(value).toString();
+  }
   if (value is ManualJobName) {
     return ManualJobNameTypeTransformer().encode(value).toString();
   }

mobile/openapi/lib/model/maintenance_action.dart

@@ -0,0 +1,85 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.18
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+part of openapi.api;
+
+
+class MaintenanceAction {
+  /// Instantiate a new enum with the provided [value].
+  const MaintenanceAction._(this.value);
+
+  /// The underlying value of this enum member.
+  final String value;
+
+  @override
+  String toString() => value;
+
+  String toJson() => value;
+
+  static const start = MaintenanceAction._(r'start');
+  static const end = MaintenanceAction._(r'end');
+
+  /// List of all possible values in this [enum][MaintenanceAction].
+  static const values = <MaintenanceAction>[
+    start,
+    end,
+  ];
+
+  static MaintenanceAction? fromJson(dynamic value) => MaintenanceActionTypeTransformer().decode(value);
+
+  static List<MaintenanceAction> listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <MaintenanceAction>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = MaintenanceAction.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+}
+
+/// Transformation class that can [encode] an instance of [MaintenanceAction] to String,
+/// and [decode] dynamic data back to [MaintenanceAction].
+class MaintenanceActionTypeTransformer {
+  factory MaintenanceActionTypeTransformer() => _instance ??= const MaintenanceActionTypeTransformer._();
+
+  const MaintenanceActionTypeTransformer._();
+
+  String encode(MaintenanceAction data) => data.value;
+
+  /// Decodes a [dynamic value][data] to a MaintenanceAction.
+  ///
+  /// If [allowNull] is true and the [dynamic value][data] cannot be decoded successfully,
+  /// then null is returned. However, if [allowNull] is false and the [dynamic value][data]
+  /// cannot be decoded successfully, then an [UnimplementedError] is thrown.
+  ///
+  /// The [allowNull] is very handy when an API changes and a new enum value is added or removed,
+  /// and users are still using an old app with the old code.
+  MaintenanceAction? decode(dynamic data, {bool allowNull = true}) {
+    if (data != null) {
+      switch (data) {
+        case r'start': return MaintenanceAction.start;
+        case r'end': return MaintenanceAction.end;
+        default:
+          if (!allowNull) {
+            throw ArgumentError('Unknown enum value to decode: $data');
+          }
+      }
+    }
+    return null;
+  }
+
+  /// Singleton [MaintenanceActionTypeTransformer] instance.
+  static MaintenanceActionTypeTransformer? _instance;
+}
+

mobile/openapi/lib/model/set_maintenance_mode_dto.dart

@@ -13,26 +13,26 @@ part of openapi.api;
 class SetMaintenanceModeDto {
   /// Returns a new [SetMaintenanceModeDto] instance.
   SetMaintenanceModeDto({
-    required this.maintenanceMode,
+    required this.action,
   });
 
-  bool maintenanceMode;
+  MaintenanceAction action;
 
   @override
   bool operator ==(Object other) => identical(this, other) || other is SetMaintenanceModeDto &&
-    other.maintenanceMode == maintenanceMode;
+    other.action == action;
 
   @override
   int get hashCode =>
     // ignore: unnecessary_parenthesis
-    (maintenanceMode.hashCode);
+    (action.hashCode);
 
   @override
-  String toString() => 'SetMaintenanceModeDto[maintenanceMode=$maintenanceMode]';
+  String toString() => 'SetMaintenanceModeDto[action=$action]';
 
   Map<String, dynamic> toJson() {
     final json = <String, dynamic>{};
-      json[r'maintenanceMode'] = this.maintenanceMode;
+      json[r'action'] = this.action;
     return json;
   }
 
@@ -45,7 +45,7 @@ class SetMaintenanceModeDto {
       final json = value.cast<String, dynamic>();
 
       return SetMaintenanceModeDto(
-        maintenanceMode: mapValueOfType<bool>(json, r'maintenanceMode')!,
+        action: MaintenanceAction.fromJson(json[r'action'])!,
       );
     }
     return null;
@@ -93,7 +93,7 @@ class SetMaintenanceModeDto {
 
   /// The list of required keys that must be present in a JSON.
   static const requiredKeys = <String>{
-    'maintenanceMode',
+    'action',
   };
 }
 

open-api/immich-openapi-specs.json

@@ -16306,6 +16306,13 @@
         ],
         "type": "object"
       },
+      "MaintenanceAction": {
+        "enum": [
+          "start",
+          "end"
+        ],
+        "type": "string"
+      },
       "MaintenanceAuthDto": {
         "properties": {
           "username": {
@@ -18578,12 +18585,16 @@
       },
       "SetMaintenanceModeDto": {
         "properties": {
-          "maintenanceMode": {
-            "type": "boolean"
+          "action": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/MaintenanceAction"
+              }
+            ]
           }
         },
         "required": [
-          "maintenanceMode"
+          "action"
         ],
         "type": "object"
       },

open-api/typescript-sdk/src/fetch-client.ts

@@ -41,7 +41,7 @@ export type ActivityStatisticsResponseDto = {
     likes: number;
 };
 export type SetMaintenanceModeDto = {
-    maintenanceMode: boolean;
+    action: MaintenanceAction;
 };
 export type MaintenanceLoginDto = {
     token?: string;
@@ -4881,6 +4881,10 @@ export enum UserAvatarColor {
     Gray = "gray",
     Amber = "amber"
 }
+export enum MaintenanceAction {
+    Start = "start",
+    End = "end"
+}
 export enum NotificationLevel {
     Success = "success",
     Error = "error",

server/src/controllers/maintenance.controller.ts

@@ -4,7 +4,7 @@ import { Response } from 'express';
 import { Endpoint, HistoryBuilder } from 'src/decorators';
 import { AuthDto } from 'src/dtos/auth.dto';
 import { MaintenanceAuthDto, MaintenanceLoginDto, SetMaintenanceModeDto } from 'src/dtos/maintenance.dto';
-import { ApiTag, ImmichCookie, Permission } from 'src/enum';
+import { ApiTag, ImmichCookie, MaintenanceAction, Permission } from 'src/enum';
 import { Auth, Authenticated } from 'src/middleware/auth.guard';
 import { MaintenanceService } from 'src/services/maintenance.service';
 import { respondWithCookie } from 'src/utils/response';
@@ -36,7 +36,7 @@ export class MaintenanceController {
     @Body() dto: SetMaintenanceModeDto,
     @Res({ passthrough: true }) res: Response,
   ): Promise<void> {
-    if (dto.maintenanceMode) {
+    if (dto.action === MaintenanceAction.Start) {
       const { jwt } = await this.service.startMaintenance(auth.user.name);
       return respondWithCookie(res, undefined, {
         isSecure: false,

server/src/dtos/maintenance.dto.ts

@@ -1,8 +1,9 @@
-import { ValidateBoolean, ValidateString } from 'src/validation';
+import { MaintenanceAction } from 'src/enum';
+import { ValidateEnum, ValidateString } from 'src/validation';
 
 export class SetMaintenanceModeDto {
-  @ValidateBoolean()
-  maintenanceMode!: boolean;
+  @ValidateEnum({ enum: MaintenanceAction, name: 'MaintenanceAction' })
+  action!: MaintenanceAction;
 }
 
 export class MaintenanceLoginDto {

server/src/enum.ts

@@ -646,6 +646,11 @@ export enum DatabaseLock {
   MemoryCreation = 777,
 }
 
+export enum MaintenanceAction {
+  Start = 'start',
+  End = 'end',
+}
+
 export enum ExitCode {
   AppRestart = 7,
 }

server/src/maintenance/maintenance-worker.controller.ts

@@ -2,7 +2,7 @@ import { Body, Controller, Get, Post, Req, Res } from '@nestjs/common';
 import { Request, Response } from 'express';
 import { MaintenanceAuthDto, MaintenanceLoginDto, SetMaintenanceModeDto } from 'src/dtos/maintenance.dto';
 import { ServerConfigDto } from 'src/dtos/server.dto';
-import { ImmichCookie } from 'src/enum';
+import { ImmichCookie, MaintenanceAction } from 'src/enum';
 import { MaintenanceRoute } from 'src/maintenance/maintenance-auth.guard';
 import { MaintenanceWorkerService } from 'src/maintenance/maintenance-worker.service';
 import { respondWithCookie } from 'src/utils/response';
@@ -33,7 +33,7 @@ export class MaintenanceWorkerController {
   @Post('admin/maintenance')
   @MaintenanceRoute()
   async setMaintenanceMode(@Body() dto: SetMaintenanceModeDto): Promise<void> {
-    if (!dto.maintenanceMode) {
+    if (dto.action === MaintenanceAction.End) {
       await this.service.endMaintenance();
     }
   }

web/src/lib/components/admin-settings/MaintenanceSettings.svelte

@@ -1,6 +1,6 @@
 <script lang="ts">
   import { handleError } from '$lib/utils/handle-error';
-  import { setMaintenanceMode } from '@immich/sdk';
+  import { MaintenanceAction, setMaintenanceMode } from '@immich/sdk';
   import { Button } from '@immich/ui';
   import { t } from 'svelte-i18n';
   import { fade } from 'svelte/transition';
@@ -15,7 +15,7 @@
     try {
       await setMaintenanceMode({
         setMaintenanceModeDto: {
-          maintenanceMode: true,
+          action: MaintenanceAction.Start,
         },
       });
     } catch (error) {

web/src/routes/maintenance/+page.svelte

@@ -3,7 +3,7 @@
   import FormatMessage from '$lib/elements/FormatMessage.svelte';
   import { maintenanceAuth } from '$lib/stores/maintenance.store';
   import { handleError } from '$lib/utils/handle-error';
-  import { setMaintenanceMode } from '@immich/sdk';
+  import { MaintenanceAction, setMaintenanceMode } from '@immich/sdk';
   import { Button, Heading, Link } from '@immich/ui';
   import { t } from 'svelte-i18n';
 
@@ -18,7 +18,7 @@
     try {
       await setMaintenanceMode({
         setMaintenanceModeDto: {
-          maintenanceMode: false,
+          action: MaintenanceAction.End,
         },
       });
     } catch (error) {