chore(server): move services (#8133)

move services

server/src/services/database.service.ts

@@ -0,0 +1,158 @@
+import { Inject, Injectable } from '@nestjs/common';
+import { Version, VersionType } from 'src/domain/domain.constant';
+import { ImmichLogger } from 'src/infra/logger';
+import {
+  DatabaseExtension,
+  DatabaseLock,
+  IDatabaseRepository,
+  VectorExtension,
+  VectorIndex,
+  extName,
+} from 'src/interfaces/database.repository';
+
+@Injectable()
+export class DatabaseService {
+  private logger = new ImmichLogger(DatabaseService.name);
+  private vectorExt: VectorExtension;
+  minPostgresVersion = 14;
+  minVectorsVersion = new Version(0, 2, 0);
+  vectorsVersionPin = VersionType.MINOR;
+  minVectorVersion = new Version(0, 5, 0);
+  vectorVersionPin = VersionType.MAJOR;
+
+  constructor(@Inject(IDatabaseRepository) private databaseRepository: IDatabaseRepository) {
+    this.vectorExt = this.databaseRepository.getPreferredVectorExtension();
+  }
+
+  async init() {
+    await this.assertPostgresql();
+    await this.databaseRepository.withLock(DatabaseLock.Migrations, async () => {
+      await this.createVectorExtension();
+      await this.updateVectorExtension();
+      await this.assertVectorExtension();
+
+      try {
+        if (await this.databaseRepository.shouldReindex(VectorIndex.CLIP)) {
+          await this.databaseRepository.reindex(VectorIndex.CLIP);
+        }
+
+        if (await this.databaseRepository.shouldReindex(VectorIndex.FACE)) {
+          await this.databaseRepository.reindex(VectorIndex.FACE);
+        }
+      } catch (error) {
+        this.logger.warn(
+          'Could not run vector reindexing checks. If the extension was updated, please restart the Postgres instance.',
+        );
+        throw error;
+      }
+
+      await this.databaseRepository.runMigrations();
+    });
+  }
+
+  private async assertPostgresql() {
+    const { major } = await this.databaseRepository.getPostgresVersion();
+    if (major < this.minPostgresVersion) {
+      throw new Error(`
+        The PostgreSQL version is ${major}, which is older than the minimum supported version ${this.minPostgresVersion}.
+        Please upgrade to this version or later.`);
+    }
+  }
+
+  private async createVectorExtension() {
+    try {
+      await this.databaseRepository.createExtension(this.vectorExt);
+    } catch (error) {
+      const otherExt =
+        this.vectorExt === DatabaseExtension.VECTORS ? DatabaseExtension.VECTOR : DatabaseExtension.VECTORS;
+      this.logger.fatal(`
+        Failed to activate ${extName[this.vectorExt]} extension.
+        Please ensure the Postgres instance has ${extName[this.vectorExt]} installed.
+
+        If the Postgres instance already has ${extName[this.vectorExt]} installed, Immich may not have the necessary permissions to activate it.
+        In this case, please run 'CREATE EXTENSION IF NOT EXISTS ${this.vectorExt}' manually as a superuser.
+        See https://immich.app/docs/guides/database-queries for how to query the database.
+
+        Alternatively, if your Postgres instance has ${extName[otherExt]}, you may use this instead by setting the environment variable 'DB_VECTOR_EXTENSION=${extName[otherExt]}'.
+        Note that switching between the two extensions after a successful startup is not supported.
+        The exception is if your version of Immich prior to upgrading was 1.90.2 or earlier.
+        In this case, you may set either extension now, but you will not be able to switch to the other extension following a successful startup.
+      `);
+      throw error;
+    }
+  }
+
+  private async updateVectorExtension() {
+    const [version, availableVersion] = await Promise.all([
+      this.databaseRepository.getExtensionVersion(this.vectorExt),
+      this.databaseRepository.getAvailableExtensionVersion(this.vectorExt),
+    ]);
+    if (version == null) {
+      throw new Error(`Unexpected: ${extName[this.vectorExt]} extension is not installed.`);
+    }
+
+    if (availableVersion == null) {
+      return;
+    }
+
+    const maxVersion = this.vectorExt === DatabaseExtension.VECTOR ? this.vectorVersionPin : this.vectorsVersionPin;
+    const isNewer = availableVersion.isNewerThan(version);
+    if (isNewer == null || isNewer > maxVersion) {
+      return;
+    }
+
+    try {
+      this.logger.log(`Updating ${extName[this.vectorExt]} extension to ${availableVersion}`);
+      const { restartRequired } = await this.databaseRepository.updateVectorExtension(this.vectorExt, availableVersion);
+      if (restartRequired) {
+        this.logger.warn(`
+          The ${extName[this.vectorExt]} extension has been updated to ${availableVersion}.
+          Please restart the Postgres instance to complete the update.`);
+      }
+    } catch (error) {
+      this.logger.warn(`
+        The ${extName[this.vectorExt]} extension version is ${version}, but ${availableVersion} is available.
+        Immich attempted to update the extension, but failed to do so.
+        This may be because Immich does not have the necessary permissions to update the extension.
+
+        Please run 'ALTER EXTENSION ${this.vectorExt} UPDATE' manually as a superuser.
+        See https://immich.app/docs/guides/database-queries for how to query the database.`);
+      this.logger.error(error);
+    }
+  }
+
+  private async assertVectorExtension() {
+    const version = await this.databaseRepository.getExtensionVersion(this.vectorExt);
+    if (version == null) {
+      throw new Error(`Unexpected: The ${extName[this.vectorExt]} extension is not installed.`);
+    }
+
+    if (version.isEqual(new Version(0, 0, 0))) {
+      throw new Error(`
+        The ${extName[this.vectorExt]} extension version is ${version}, which means it is a nightly release.
+
+        Please run 'DROP EXTENSION IF EXISTS ${this.vectorExt}' and switch to a release version.
+        See https://immich.app/docs/guides/database-queries for how to query the database.`);
+    }
+
+    const minVersion = this.vectorExt === DatabaseExtension.VECTOR ? this.minVectorVersion : this.minVectorsVersion;
+    const maxVersion = this.vectorExt === DatabaseExtension.VECTOR ? this.vectorVersionPin : this.vectorsVersionPin;
+
+    if (version.isOlderThan(minVersion) || version.isNewerThan(minVersion) > maxVersion) {
+      const allowedReleaseType = maxVersion === VersionType.MAJOR ? '' : ` ${VersionType[maxVersion].toLowerCase()}`;
+      const releases =
+        maxVersion === VersionType.EQUAL
+          ? minVersion.toString()
+          : `${minVersion} and later${allowedReleaseType} releases`;
+
+      throw new Error(`
+        The ${extName[this.vectorExt]} extension version is ${version}, but Immich only supports ${releases}.
+
+        If the Postgres instance already has a compatible version installed, Immich may not have the necessary permissions to activate it.
+        In this case, please run 'ALTER EXTENSION UPDATE ${this.vectorExt}' manually as a superuser.
+        See https://immich.app/docs/guides/database-queries for how to query the database.
+
+        Otherwise, please update the version of ${extName[this.vectorExt]} in the Postgres instance to a compatible version.`);
+    }
+  }
+}