feat: version check endpoint (#18572)

open-api/immich-openapi-specs.json

@@ -5563,6 +5563,38 @@
         ]
       }
     },
+    "/server/version-check": {
+      "get": {
+        "operationId": "getVersionCheck",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/VersionCheckStateResponseDto"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "security": [
+          {
+            "bearer": []
+          },
+          {
+            "cookie": []
+          },
+          {
+            "api_key": []
+          }
+        ],
+        "tags": [
+          "Server"
+        ]
+      }
+    },
     "/server/version-history": {
       "get": {
         "operationId": "getVersionHistory",
@@ -6846,6 +6878,38 @@
         ]
       }
     },
+    "/system-metadata/version-check-state": {
+      "get": {
+        "operationId": "getVersionCheckState",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/VersionCheckStateResponseDto"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "security": [
+          {
+            "bearer": []
+          },
+          {
+            "cookie": []
+          },
+          {
+            "api_key": []
+          }
+        ],
+        "tags": [
+          "System Metadata"
+        ]
+      }
+    },
     "/tags": {
       "get": {
         "operationId": "getAllTags",
@@ -14939,6 +15003,23 @@
         },
         "type": "object"
       },
+      "VersionCheckStateResponseDto": {
+        "properties": {
+          "checkedAt": {
+            "nullable": true,
+            "type": "string"
+          },
+          "releaseVersion": {
+            "nullable": true,
+            "type": "string"
+          }
+        },
+        "required": [
+          "checkedAt",
+          "releaseVersion"
+        ],
+        "type": "object"
+      },
       "VideoCodec": {
         "enum": [
           "h264",

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

@@ -1076,6 +1076,10 @@ export type ServerVersionResponseDto = {
     minor: number;
     patch: number;
 };
+export type VersionCheckStateResponseDto = {
+    checkedAt: string | null;
+    releaseVersion: string | null;
+};
 export type ServerVersionHistoryResponseDto = {
     createdAt: string;
     id: string;
@@ -2947,6 +2951,14 @@ export function getServerVersion(opts?: Oazapfts.RequestOpts) {
         ...opts
     }));
 }
+export function getVersionCheck(opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: VersionCheckStateResponseDto;
+    }>("/server/version-check", {
+        ...opts
+    }));
+}
 export function getVersionHistory(opts?: Oazapfts.RequestOpts) {
     return oazapfts.ok(oazapfts.fetchJson<{
         status: 200;
@@ -3284,6 +3296,14 @@ export function getReverseGeocodingState(opts?: Oazapfts.RequestOpts) {
         ...opts
     }));
 }
+export function getVersionCheckState(opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: VersionCheckStateResponseDto;
+    }>("/system-metadata/version-check-state", {
+        ...opts
+    }));
+}
 export function getAllTags(opts?: Oazapfts.RequestOpts) {
     return oazapfts.ok(oazapfts.fetchJson<{
         status: 200;

server/src/controllers/server.controller.spec.ts

@@ -1,5 +1,6 @@
 import { ServerController } from 'src/controllers/server.controller';
 import { ServerService } from 'src/services/server.service';
+import { SystemMetadataService } from 'src/services/system-metadata.service';
 import { VersionService } from 'src/services/version.service';
 import request from 'supertest';
 import { ControllerContext, controllerSetup, mockBaseService } from 'test/utils';
@@ -7,11 +8,13 @@ import { ControllerContext, controllerSetup, mockBaseService } from 'test/utils'
 describe(ServerController.name, () => {
   let ctx: ControllerContext;
   const serverService = mockBaseService(ServerService);
+  const systemMetadataService = mockBaseService(SystemMetadataService);
   const versionService = mockBaseService(VersionService);
 
   beforeAll(async () => {
     ctx = await controllerSetup(ServerController, [
       { provide: ServerService, useValue: serverService },
+      { provide: SystemMetadataService, useValue: systemMetadataService },
       { provide: VersionService, useValue: versionService },
     ]);
     return () => ctx.close();

server/src/controllers/server.controller.ts

@@ -13,8 +13,10 @@ import {
   ServerVersionHistoryResponseDto,
   ServerVersionResponseDto,
 } from 'src/dtos/server.dto';
+import { VersionCheckStateResponseDto } from 'src/dtos/system-metadata.dto';
 import { Authenticated } from 'src/middleware/auth.guard';
 import { ServerService } from 'src/services/server.service';
+import { SystemMetadataService } from 'src/services/system-metadata.service';
 import { VersionService } from 'src/services/version.service';
 
 @ApiTags('Server')
@@ -22,6 +24,7 @@ import { VersionService } from 'src/services/version.service';
 export class ServerController {
   constructor(
     private service: ServerService,
+    private systemMetadataService: SystemMetadataService,
     private versionService: VersionService,
   ) {}
 
@@ -96,4 +99,10 @@ export class ServerController {
   getServerLicense(): Promise<LicenseResponseDto> {
     return this.service.getLicense();
   }
+
+  @Get('version-check')
+  @Authenticated()
+  getVersionCheck(): Promise<VersionCheckStateResponseDto> {
+    return this.systemMetadataService.getVersionCheckState();
+  }
 }

server/src/controllers/system-metadata.controller.ts

@@ -1,6 +1,10 @@
 import { Body, Controller, Get, HttpCode, HttpStatus, Post } from '@nestjs/common';
 import { ApiTags } from '@nestjs/swagger';
-import { AdminOnboardingUpdateDto, ReverseGeocodingStateResponseDto } from 'src/dtos/system-metadata.dto';
+import {
+  AdminOnboardingUpdateDto,
+  ReverseGeocodingStateResponseDto,
+  VersionCheckStateResponseDto,
+} from 'src/dtos/system-metadata.dto';
 import { Permission } from 'src/enum';
 import { Authenticated } from 'src/middleware/auth.guard';
 import { SystemMetadataService } from 'src/services/system-metadata.service';
@@ -28,4 +32,10 @@ export class SystemMetadataController {
   getReverseGeocodingState(): Promise<ReverseGeocodingStateResponseDto> {
     return this.service.getReverseGeocodingState();
   }
+
+  @Get('version-check-state')
+  @Authenticated({ permission: Permission.SYSTEM_METADATA_READ, admin: true })
+  getVersionCheckState(): Promise<VersionCheckStateResponseDto> {
+    return this.service.getVersionCheckState();
+  }
 }

server/src/dtos/system-metadata.dto.ts

@@ -13,3 +13,8 @@ export class ReverseGeocodingStateResponseDto {
   lastUpdate!: string | null;
   lastImportFileName!: string | null;
 }
+
+export class VersionCheckStateResponseDto {
+  checkedAt!: string | null;
+  releaseVersion!: string | null;
+}

server/src/services/system-metadata.service.ts

@@ -3,6 +3,7 @@ import {
   AdminOnboardingResponseDto,
   AdminOnboardingUpdateDto,
   ReverseGeocodingStateResponseDto,
+  VersionCheckStateResponseDto,
 } from 'src/dtos/system-metadata.dto';
 import { SystemMetadataKey } from 'src/enum';
 import { BaseService } from 'src/services/base.service';
@@ -24,4 +25,9 @@ export class SystemMetadataService extends BaseService {
     const value = await this.systemMetadataRepository.get(SystemMetadataKey.REVERSE_GEOCODING_STATE);
     return { lastUpdate: null, lastImportFileName: null, ...value };
   }
+
+  async getVersionCheckState(): Promise<VersionCheckStateResponseDto> {
+    const value = await this.systemMetadataRepository.get(SystemMetadataKey.VERSION_CHECK_STATE);
+    return { checkedAt: null, releaseVersion: null, ...value };
+  }
 }