fix(server): correct openapi response type for getServerLicense() (#11261)

* fix(server): correct openapi response type for getServerLicense()

* return 404 error when license doesn't exist

* update e2e test

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

@@ -254,7 +254,7 @@ describe('/server', () => {
         .set('Authorization', `Bearer ${admin.accessToken}`)
         .send(serverLicense);
       const { status } = await request(app).get('/server/license').set('Authorization', `Bearer ${admin.accessToken}`);
-      expect(status).toBe(200);
+      expect(status).toBe(404);
     });
   });
 

mobile/openapi/lib/api/server_api.dart

@@ -75,7 +75,7 @@ class ServerApi {
     );
   }
 
-  Future<Object?> getServerLicense() async {
+  Future<LicenseResponseDto?> getServerLicense() async {
     final response = await getServerLicenseWithHttpInfo();
     if (response.statusCode >= HttpStatus.badRequest) {
       throw ApiException(response.statusCode, await _decodeBodyBytes(response));
@@ -84,7 +84,7 @@ class ServerApi {
     // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
     // FormatException when trying to decode an empty string.
     if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
-      return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'Object',) as Object;
+      return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'LicenseResponseDto',) as LicenseResponseDto;
     
     }
     return null;

open-api/immich-openapi-specs.json

@@ -5022,11 +5022,14 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object"
+                  "$ref": "#/components/schemas/LicenseResponseDto"
                 }
               }
             },
             "description": ""
+          },
+          "404": {
+            "description": ""
           }
         },
         "security": [

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

@@ -880,12 +880,12 @@ export type ServerVersionResponseDto = {
     minor: number;
     patch: number;
 };
-export type LicenseKeyDto = {
+export type LicenseResponseDto = {
+    activatedAt: string;
     activationKey: string;
     licenseKey: string;
 };
-export type LicenseResponseDto = {
+export type LicenseKeyDto = {
-    activatedAt: string;
     activationKey: string;
     licenseKey: string;
 };
@@ -2511,7 +2511,9 @@ export function deleteServerLicense(opts?: Oazapfts.RequestOpts) {
 export function getServerLicense(opts?: Oazapfts.RequestOpts) {
     return oazapfts.ok(oazapfts.fetchJson<{
         status: 200;
-        data: object;
+        data: LicenseResponseDto;
+    } | {
+        status: 404;
     }>("/server/license", {
         ...opts
     }));

server/src/controllers/server.controller.ts

@@ -1,5 +1,5 @@
 import { Body, Controller, Delete, Get, Put } from '@nestjs/common';
-import { ApiExcludeEndpoint, ApiTags } from '@nestjs/swagger';
+import { ApiExcludeEndpoint, ApiNotFoundResponse, ApiTags } from '@nestjs/swagger';
 import { LicenseKeyDto, LicenseResponseDto } from 'src/dtos/license.dto';
 import {
   ServerAboutResponseDto,
@@ -95,7 +95,8 @@ export class ServerController {
 
   @Get('license')
   @Authenticated({ admin: true })
-  getServerLicense(): Promise<LicenseResponseDto | null> {
+  @ApiNotFoundResponse()
+  getServerLicense(): Promise<LicenseResponseDto> {
     return this.service.getLicense();
   }
 }

server/src/services/server.service.ts

@@ -1,4 +1,4 @@
-import { BadRequestException, Inject, Injectable } from '@nestjs/common';
+import { BadRequestException, Inject, Injectable, NotFoundException } from '@nestjs/common';
 import { getBuildMetadata, getServerLicensePublicKey } from 'src/config';
 import { serverVersion } from 'src/constants';
 import { StorageCore, StorageFolder } from 'src/cores/storage.core';
@@ -164,8 +164,12 @@ export class ServerService implements OnEvents {
     await this.systemMetadataRepository.delete(SystemMetadataKey.LICENSE);
   }
 
-  async getLicense(): Promise<LicenseResponseDto | null> {
+  async getLicense(): Promise<LicenseResponseDto> {
-    return this.systemMetadataRepository.get(SystemMetadataKey.LICENSE);
+    const license = await this.systemMetadataRepository.get(SystemMetadataKey.LICENSE);
+    if (!license) {
+      throw new NotFoundException();
+    }
+    return license;
   }
 
   async setLicense(dto: LicenseKeyDto): Promise<LicenseResponseDto> {

web/src/lib/components/user-settings-page/license-settings.svelte

@@ -10,6 +10,7 @@
     getAboutInfo,
     getMyUser,
     getServerLicense,
+    isHttpError,
     type LicenseResponseDto,
   } from '@immich/sdk';
   import Icon from '$lib/components/elements/icon.svelte';
@@ -36,7 +37,18 @@
     }
 
     if (isServerLicense && $user.isAdmin) {
-      serverLicenseInfo = (await getServerLicense()) as LicenseResponseDto | null;
+      serverLicenseInfo = await getServerLicenseInfo();
+    }
+  };
+
+  const getServerLicenseInfo = async () => {
+    try {
+      return await getServerLicense();
+    } catch (error) {
+      if (isHttpError(error) && error.status === 404) {
+        return null;
+      }
+      throw error;
     }
   };