feat: track upgrade history (#13097)

open-api/immich-openapi-specs.json

@@ -5088,6 +5088,30 @@
         ]
       }
     },
+    "/server/version-history": {
+      "get": {
+        "operationId": "getVersionHistory",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "items": {
+                    "$ref": "#/components/schemas/ServerVersionHistoryResponseDto"
+                  },
+                  "type": "array"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "tags": [
+          "Server"
+        ]
+      }
+    },
     "/sessions": {
       "delete": {
         "operationId": "deleteAllSessions",
@@ -11042,6 +11066,26 @@
         ],
         "type": "object"
       },
+      "ServerVersionHistoryResponseDto": {
+        "properties": {
+          "createdAt": {
+            "format": "date-time",
+            "type": "string"
+          },
+          "id": {
+            "type": "string"
+          },
+          "version": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "createdAt",
+          "id",
+          "version"
+        ],
+        "type": "object"
+      },
       "ServerVersionResponseDto": {
         "properties": {
           "major": {

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

@@ -1000,6 +1000,11 @@ export type ServerVersionResponseDto = {
     minor: number;
     patch: number;
 };
+export type ServerVersionHistoryResponseDto = {
+    createdAt: string;
+    id: string;
+    version: string;
+};
 export type SessionResponseDto = {
     createdAt: string;
     current: boolean;
@@ -2667,6 +2672,14 @@ export function getServerVersion(opts?: Oazapfts.RequestOpts) {
         ...opts
     }));
 }
+export function getVersionHistory(opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: ServerVersionHistoryResponseDto[];
+    }>("/server/version-history", {
+        ...opts
+    }));
+}
 export function deleteAllSessions(opts?: Oazapfts.RequestOpts) {
     return oazapfts.ok(oazapfts.fetchText("/sessions", {
         ...opts,

server/src/controllers/server.controller.ts

@@ -10,6 +10,7 @@ import {
   ServerStatsResponseDto,
   ServerStorageResponseDto,
   ServerThemeDto,
+  ServerVersionHistoryResponseDto,
   ServerVersionResponseDto,
 } from 'src/dtos/server.dto';
 import { Authenticated } from 'src/middleware/auth.guard';
@@ -46,6 +47,11 @@ export class ServerController {
     return this.versionService.getVersion();
   }
 
+  @Get('version-history')
+  getVersionHistory(): Promise<ServerVersionHistoryResponseDto[]> {
+    return this.versionService.getVersionHistory();
+  }
+
   @Get('features')
   getServerFeatures(): Promise<ServerFeaturesDto> {
     return this.service.getFeatures();

server/src/dtos/server.dto.ts

@@ -68,6 +68,12 @@ export class ServerVersionResponseDto {
   }
 }
 
+export class ServerVersionHistoryResponseDto {
+  id!: string;
+  createdAt!: Date;
+  version!: string;
+}
+
 export class UsageByUserDto {
   @ApiProperty({ type: 'string' })
   userId!: string;

server/src/entities/index.ts

@@ -25,6 +25,7 @@ import { SystemMetadataEntity } from 'src/entities/system-metadata.entity';
 import { TagEntity } from 'src/entities/tag.entity';
 import { UserMetadataEntity } from 'src/entities/user-metadata.entity';
 import { UserEntity } from 'src/entities/user.entity';
+import { VersionHistoryEntity } from 'src/entities/version-history.entity';
 
 export const entities = [
   ActivityEntity,
@@ -54,4 +55,5 @@ export const entities = [
   UserMetadataEntity,
   SessionEntity,
   LibraryEntity,
+  VersionHistoryEntity,
 ];

server/src/entities/version-history.entity.ts

@@ -0,0 +1,13 @@
+import { Column, CreateDateColumn, Entity, PrimaryGeneratedColumn } from 'typeorm';
+
+@Entity('version_history')
+export class VersionHistoryEntity {
+  @PrimaryGeneratedColumn('uuid')
+  id!: string;
+
+  @CreateDateColumn({ type: 'timestamptz' })
+  createdAt!: Date;
+
+  @Column()
+  version!: string;
+}

server/src/interfaces/database.interface.ts

@@ -17,6 +17,7 @@ export enum DatabaseLock {
   Migrations = 200,
   SystemFileMounts = 300,
   StorageTemplateMigration = 420,
+  VersionHistory = 500,
   CLIPDimSize = 512,
   LibraryWatch = 1337,
   GetSystemConfig = 69,

server/src/interfaces/version-history.interface.ts

@@ -0,0 +1,9 @@
+import { VersionHistoryEntity } from 'src/entities/version-history.entity';
+
+export const IVersionHistoryRepository = 'IVersionHistoryRepository';
+
+export interface IVersionHistoryRepository {
+  create(version: Omit<VersionHistoryEntity, 'id' | 'createdAt'>): Promise<VersionHistoryEntity>;
+  getAll(): Promise<VersionHistoryEntity[]>;
+  getLatest(): Promise<VersionHistoryEntity | null>;
+}

server/src/migrations/1727797340951-AddVersionHistory.ts

@@ -0,0 +1,14 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class AddVersionHistory1727797340951 implements MigrationInterface {
+    name = 'AddVersionHistory1727797340951'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`CREATE TABLE "version_history" ("id" uuid NOT NULL DEFAULT uuid_generate_v4(), "createdAt" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(), "version" character varying NOT NULL, CONSTRAINT "PK_5db259cbb09ce82c0d13cfd1b23" PRIMARY KEY ("id"))`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`DROP TABLE "version_history"`);
+    }
+
+}

server/src/repositories/index.ts

@@ -32,6 +32,7 @@ import { ISystemMetadataRepository } from 'src/interfaces/system-metadata.interf
 import { ITagRepository } from 'src/interfaces/tag.interface';
 import { ITrashRepository } from 'src/interfaces/trash.interface';
 import { IUserRepository } from 'src/interfaces/user.interface';
+import { IVersionHistoryRepository } from 'src/interfaces/version-history.interface';
 import { IViewRepository } from 'src/interfaces/view.interface';
 import { AccessRepository } from 'src/repositories/access.repository';
 import { ActivityRepository } from 'src/repositories/activity.repository';
@@ -67,6 +68,7 @@ import { SystemMetadataRepository } from 'src/repositories/system-metadata.repos
 import { TagRepository } from 'src/repositories/tag.repository';
 import { TrashRepository } from 'src/repositories/trash.repository';
 import { UserRepository } from 'src/repositories/user.repository';
+import { VersionHistoryRepository } from 'src/repositories/version-history.repository';
 import { ViewRepository } from 'src/repositories/view-repository';
 
 export const repositories = [
@@ -104,5 +106,6 @@ export const repositories = [
   { provide: ITagRepository, useClass: TagRepository },
   { provide: ITrashRepository, useClass: TrashRepository },
   { provide: IUserRepository, useClass: UserRepository },
+  { provide: IVersionHistoryRepository, useClass: VersionHistoryRepository },
   { provide: IViewRepository, useClass: ViewRepository },
 ];

server/src/repositories/version-history.repository.ts

@@ -0,0 +1,25 @@
+import { Injectable } from '@nestjs/common';
+import { InjectRepository } from '@nestjs/typeorm';
+import { VersionHistoryEntity } from 'src/entities/version-history.entity';
+import { IVersionHistoryRepository } from 'src/interfaces/version-history.interface';
+import { Instrumentation } from 'src/utils/instrumentation';
+import { Repository } from 'typeorm';
+
+@Instrumentation()
+@Injectable()
+export class VersionHistoryRepository implements IVersionHistoryRepository {
+  constructor(@InjectRepository(VersionHistoryEntity) private repository: Repository<VersionHistoryEntity>) {}
+
+  async getAll(): Promise<VersionHistoryEntity[]> {
+    return this.repository.find({ order: { createdAt: 'DESC' } });
+  }
+
+  async getLatest(): Promise<VersionHistoryEntity | null> {
+    const results = await this.repository.find({ order: { createdAt: 'DESC' }, take: 1 });
+    return results[0] || null;
+  }
+
+  create(version: Omit<VersionHistoryEntity, 'id' | 'createdAt'>): Promise<VersionHistoryEntity> {
+    return this.repository.save(version);
+  }
+}

server/src/services/version.service.spec.ts

@@ -1,17 +1,21 @@
 import { DateTime } from 'luxon';
 import { serverVersion } from 'src/constants';
 import { SystemMetadataKey } from 'src/enum';
+import { IDatabaseRepository } from 'src/interfaces/database.interface';
 import { IEventRepository } from 'src/interfaces/event.interface';
 import { IJobRepository, JobName, JobStatus } from 'src/interfaces/job.interface';
 import { ILoggerRepository } from 'src/interfaces/logger.interface';
 import { IServerInfoRepository } from 'src/interfaces/server-info.interface';
 import { ISystemMetadataRepository } from 'src/interfaces/system-metadata.interface';
+import { IVersionHistoryRepository } from 'src/interfaces/version-history.interface';
 import { VersionService } from 'src/services/version.service';
+import { newDatabaseRepositoryMock } from 'test/repositories/database.repository.mock';
 import { newEventRepositoryMock } from 'test/repositories/event.repository.mock';
 import { newJobRepositoryMock } from 'test/repositories/job.repository.mock';
 import { newLoggerRepositoryMock } from 'test/repositories/logger.repository.mock';
 import { newServerInfoRepositoryMock } from 'test/repositories/server-info.repository.mock';
 import { newSystemMetadataRepositoryMock } from 'test/repositories/system-metadata.repository.mock';
+import { newVersionHistoryRepositoryMock } from 'test/repositories/version-history.repository.mock';
 import { Mocked } from 'vitest';
 
 const mockRelease = (version: string) => ({
@@ -26,26 +30,47 @@ const mockRelease = (version: string) => ({
 
 describe(VersionService.name, () => {
   let sut: VersionService;
+  let databaseMock: Mocked<IDatabaseRepository>;
   let eventMock: Mocked<IEventRepository>;
   let jobMock: Mocked<IJobRepository>;
   let serverMock: Mocked<IServerInfoRepository>;
   let systemMock: Mocked<ISystemMetadataRepository>;
+  let versionMock: Mocked<IVersionHistoryRepository>;
   let loggerMock: Mocked<ILoggerRepository>;
 
   beforeEach(() => {
+    databaseMock = newDatabaseRepositoryMock();
     eventMock = newEventRepositoryMock();
     jobMock = newJobRepositoryMock();
     serverMock = newServerInfoRepositoryMock();
     systemMock = newSystemMetadataRepositoryMock();
+    versionMock = newVersionHistoryRepositoryMock();
     loggerMock = newLoggerRepositoryMock();
 
-    sut = new VersionService(eventMock, jobMock, serverMock, systemMock, loggerMock);
+    sut = new VersionService(databaseMock, eventMock, jobMock, serverMock, systemMock, versionMock, loggerMock);
   });
 
   it('should work', () => {
     expect(sut).toBeDefined();
   });
 
+  describe('onBootstrap', () => {
+    it('should record a new version', async () => {
+      await expect(sut.onBootstrap()).resolves.toBeUndefined();
+      expect(versionMock.create).toHaveBeenCalledWith({ version: expect.any(String) });
+    });
+
+    it('should skip a duplicate version', async () => {
+      versionMock.getLatest.mockResolvedValue({
+        id: 'version-1',
+        createdAt: new Date(),
+        version: serverVersion.toString(),
+      });
+      await expect(sut.onBootstrap()).resolves.toBeUndefined();
+      expect(versionMock.create).not.toHaveBeenCalled();
+    });
+  });
+
   describe('getVersion', () => {
     it('should respond the server version', () => {
       expect(sut.getVersion()).toEqual({
@@ -56,6 +81,14 @@ describe(VersionService.name, () => {
     });
   });
 
+  describe('getVersionHistory', () => {
+    it('should respond the server version history', async () => {
+      const upgrade = { id: 'upgrade-1', createdAt: new Date(), version: '1.0.0' };
+      versionMock.getAll.mockResolvedValue([upgrade]);
+      await expect(sut.getVersionHistory()).resolves.toEqual([upgrade]);
+    });
+  });
+
   describe('handQueueVersionCheck', () => {
     it('should queue a version check job', async () => {
       await expect(sut.handleQueueVersionCheck()).resolves.toBeUndefined();

server/src/services/version.service.ts

@@ -6,11 +6,13 @@ import { OnEvent } from 'src/decorators';
 import { ReleaseNotification, ServerVersionResponseDto } from 'src/dtos/server.dto';
 import { VersionCheckMetadata } from 'src/entities/system-metadata.entity';
 import { SystemMetadataKey } from 'src/enum';
+import { DatabaseLock, IDatabaseRepository } from 'src/interfaces/database.interface';
 import { ArgOf, IEventRepository } from 'src/interfaces/event.interface';
 import { IJobRepository, JobName, JobStatus } from 'src/interfaces/job.interface';
 import { ILoggerRepository } from 'src/interfaces/logger.interface';
 import { IServerInfoRepository } from 'src/interfaces/server-info.interface';
 import { ISystemMetadataRepository } from 'src/interfaces/system-metadata.interface';
+import { IVersionHistoryRepository } from 'src/interfaces/version-history.interface';
 import { BaseService } from 'src/services/base.service';
 
 const asNotification = ({ checkedAt, releaseVersion }: VersionCheckMetadata): ReleaseNotification => {
@@ -25,10 +27,12 @@ const asNotification = ({ checkedAt, releaseVersion }: VersionCheckMetadata): Re
 @Injectable()
 export class VersionService extends BaseService {
   constructor(
+    @Inject(IDatabaseRepository) private databaseRepository: IDatabaseRepository,
     @Inject(IEventRepository) private eventRepository: IEventRepository,
     @Inject(IJobRepository) private jobRepository: IJobRepository,
     @Inject(IServerInfoRepository) private repository: IServerInfoRepository,
     @Inject(ISystemMetadataRepository) systemMetadataRepository: ISystemMetadataRepository,
+    @Inject(IVersionHistoryRepository) private versionRepository: IVersionHistoryRepository,
     @Inject(ILoggerRepository) logger: ILoggerRepository,
   ) {
     super(systemMetadataRepository, logger);
@@ -38,12 +42,25 @@ export class VersionService extends BaseService {
   @OnEvent({ name: 'app.bootstrap' })
   async onBootstrap(): Promise<void> {
     await this.handleVersionCheck();
+
+    await this.databaseRepository.withLock(DatabaseLock.VersionHistory, async () => {
+      const latest = await this.versionRepository.getLatest();
+      const current = serverVersion.toString();
+      if (!latest || latest.version !== current) {
+        this.logger.log(`Version has changed, adding ${current} to history`);
+        await this.versionRepository.create({ version: current });
+      }
+    });
   }
 
   getVersion() {
     return ServerVersionResponseDto.fromSemVer(serverVersion);
   }
 
+  getVersionHistory() {
+    return this.versionRepository.getAll();
+  }
+
   async handleQueueVersionCheck() {
     await this.jobRepository.queue({ name: JobName.VERSION_CHECK, data: {} });
   }

server/test/repositories/version-history.repository.mock.ts

@@ -0,0 +1,10 @@
+import { IVersionHistoryRepository } from 'src/interfaces/version-history.interface';
+import { Mocked, vitest } from 'vitest';
+
+export const newVersionHistoryRepositoryMock = (): Mocked<IVersionHistoryRepository> => {
+  return {
+    getAll: vitest.fn().mockResolvedValue([]),
+    getLatest: vitest.fn(),
+    create: vitest.fn(),
+  };
+};

web/src/lib/components/shared-components/server-about-modal.svelte

@@ -1,19 +1,19 @@
 <script lang="ts">
   import FullScreenModal from '$lib/components/shared-components/full-screen-modal.svelte';
   import Portal from '$lib/components/shared-components/portal/portal.svelte';
-  import { type ServerAboutResponseDto } from '@immich/sdk';
+  import { type ServerAboutResponseDto, type ServerVersionHistoryResponseDto } from '@immich/sdk';
+  import { DateTime } from 'luxon';
   import { t } from 'svelte-i18n';
 
   export let onClose: () => void;
 
   export let info: ServerAboutResponseDto;
+  export let versions: ServerVersionHistoryResponseDto[];
 </script>
 
 <Portal>
   <FullScreenModal title={$t('about')} {onClose}>
-    <div
-      class="immich-scrollbar max-h-[500px] overflow-y-auto flex flex-col sm:grid sm:grid-cols-2 gap-1 text-immich-primary dark:text-immich-dark-primary"
-    >
+    <div class="flex flex-col sm:grid sm:grid-cols-2 gap-1 text-immich-primary dark:text-immich-dark-primary">
       <div>
         <label class="font-medium text-immich-primary dark:text-immich-dark-primary text-sm" for="version-desc"
           >Immich</label
@@ -151,6 +151,35 @@
           </div>
         </div>
       {/if}
+
+      <div class="col-span-full">
+        <label class="font-medium text-immich-primary dark:text-immich-dark-primary text-sm" for="version-history"
+          >{$t('version_history')}</label
+        >
+        <ul id="version-history" class="list-none">
+          {#each versions.slice(0, 5) as item (item.id)}
+            {@const createdAt = DateTime.fromISO(item.createdAt)}
+            <li>
+              <span
+                class="immich-form-label pb-2 text-xs"
+                id="version-history"
+                title={createdAt.toLocaleString(DateTime.DATETIME_SHORT_WITH_SECONDS)}
+              >
+                {$t('version_history_item', {
+                  values: {
+                    version: item.version,
+                    date: createdAt.toLocaleString({
+                      month: 'short',
+                      day: 'numeric',
+                      year: 'numeric',
+                    }),
+                  },
+                })}
+              </span>
+            </li>
+          {/each}
+        </ul>
+      </div>
     </div>
   </FullScreenModal>
 </Portal>

web/src/lib/components/shared-components/side-bar/server-status.svelte

@@ -4,7 +4,12 @@
   import { requestServerInfo } from '$lib/utils/auth';
   import { onMount } from 'svelte';
   import { t } from 'svelte-i18n';
-  import { getAboutInfo, type ServerAboutResponseDto } from '@immich/sdk';
+  import {
+    getAboutInfo,
+    getVersionHistory,
+    type ServerAboutResponseDto,
+    type ServerVersionHistoryResponseDto,
+  } from '@immich/sdk';
 
   const { serverVersion, connected } = websocketStore;
 
@@ -12,16 +17,17 @@
 
   $: version = $serverVersion ? `v${$serverVersion.major}.${$serverVersion.minor}.${$serverVersion.patch}` : null;
 
-  let aboutInfo: ServerAboutResponseDto;
+  let info: ServerAboutResponseDto;
+  let versions: ServerVersionHistoryResponseDto[] = [];
 
   onMount(async () => {
     await requestServerInfo();
-    aboutInfo = await getAboutInfo();
+    [info, versions] = await Promise.all([getAboutInfo(), getVersionHistory()]);
   });
 </script>
 
 {#if isOpen}
-  <ServerAboutModal onClose={() => (isOpen = false)} info={aboutInfo} />
+  <ServerAboutModal onClose={() => (isOpen = false)} {info} {versions} />
 {/if}
 
 <div

web/src/lib/components/shared-components/side-bar/storage-space.svelte

@@ -1,5 +1,4 @@
 <script lang="ts">
-  import ServerAboutModal from '$lib/components/shared-components/server-about-modal.svelte';
   import { locale } from '$lib/stores/preferences.store';
   import { serverInfo } from '$lib/stores/server-info.store';
   import { user } from '$lib/stores/user.store';
@@ -8,18 +7,14 @@
   import { t } from 'svelte-i18n';
   import { getByteUnitString } from '../../../utils/byte-units';
   import LoadingSpinner from '../loading-spinner.svelte';
-  import { getAboutInfo, type ServerAboutResponseDto } from '@immich/sdk';
 
   let usageClasses = '';
-  let isOpen = false;
 
   $: hasQuota = $user?.quotaSizeInBytes !== null;
   $: availableBytes = (hasQuota ? $user?.quotaSizeInBytes : $serverInfo?.diskSizeRaw) || 0;
   $: usedBytes = (hasQuota ? $user?.quotaUsageInBytes : $serverInfo?.diskUseRaw) || 0;
   $: usedPercentage = Math.min(Math.round((usedBytes / availableBytes) * 100), 100);
 
-  let aboutInfo: ServerAboutResponseDto;
-
   const onUpdate = () => {
     usageClasses = getUsageClass();
   };
@@ -42,14 +37,9 @@
 
   onMount(async () => {
     await requestServerInfo();
-    aboutInfo = await getAboutInfo();
   });
 </script>
 
-{#if isOpen}
-  <ServerAboutModal onClose={() => (isOpen = false)} info={aboutInfo} />
-{/if}
-
 <div
   class="hidden md:block storage-status p-4 bg-gray-100 dark:bg-immich-dark-primary/10 ml-4 rounded-lg text-sm"
   title={$t('storage_usage', {

web/src/lib/i18n/en.json

@@ -1278,6 +1278,8 @@
   "version": "Version",
   "version_announcement_closing": "Your friend, Alex",
   "version_announcement_message": "Hi friend, there is a new version of the application please take your time to visit the <link>release notes</link> and ensure your <code>docker-compose.yml</code>, and <code>.env</code> setup is up-to-date to prevent any misconfigurations, especially if you use WatchTower or any mechanism that handles updating your application automatically.",
+  "version_history": "Version History",
+  "version_history_item": "Installed {version} on {date}",
   "video": "Video",
   "video_hover_setting": "Play video thumbnail on hover",
   "video_hover_setting_description": "Play video thumbnail when mouse is hovering over item. Even when disabled, playback can be started by hovering over the play icon.",