refactor: migrate map repository to kysely (immich-app#15348)

* chore: migrate map repository to kysely * chore: add kysely codegen command, exclude from prettier and re-run it on latest migrations * refactor: migrate map repository to kysely * chore: dont log postgres notices
vladd11 · Jan 25, 2025 · a0cbb9f · a0cbb9f
1 parent 09f44f5
commit a0cbb9f
Show file tree

Hide file tree

Showing 6 changed files with 139 additions and 115 deletions.
diff --git a/server/.prettierignore b/server/.prettierignore
@@ -10,6 +10,7 @@ node_modules
 coverage
 dist
 **/migrations/**
+db.d.ts
 
 # Ignore files for PNPM, NPM and YARN
 pnpm-lock.yaml

diff --git a/server/package.json b/server/package.json
@@ -29,6 +29,7 @@
     "typeorm:migrations:revert": "typeorm migration:revert -d ./dist/bin/database.js",
     "typeorm:schema:drop": "typeorm query -d ./dist/bin/database.js 'DROP schema public cascade; CREATE schema public;'",
     "typeorm:schema:reset": "npm run typeorm:schema:drop && npm run typeorm:migrations:run",
+    "kysely:codegen": "npx kysely-codegen --include-pattern=\"(public|vectors).*\" --dialect postgres --url postgres://postgres:postgres@localhost/immich --log-level debug --out-file=./src/db.d.ts",
     "sync:open-api": "node ./dist/bin/sync-open-api.js",
     "sync:sql": "node ./dist/bin/sync-sql.js",
     "email:dev": "email dev -p 3050 --dir src/emails"

diff --git a/server/src/db.d.ts b/server/src/db.d.ts
@@ -3,16 +3,21 @@
  * Please do not edit it manually.
  */
 
-import type { ColumnType } from 'kysely';
+import type { ColumnType } from "kysely";
 
-export type ArrayType<T> = ArrayTypeImpl<T> extends (infer U)[] ? U[] : ArrayTypeImpl<T>;
+export type ArrayType<T> = ArrayTypeImpl<T> extends (infer U)[]
+  ? U[]
+  : ArrayTypeImpl<T>;
 
-export type ArrayTypeImpl<T> = T extends ColumnType<infer S, infer I, infer U> ? ColumnType<S[], I[], U[]> : T[];
+export type ArrayTypeImpl<T> = T extends ColumnType<infer S, infer I, infer U>
+  ? ColumnType<S[], I[], U[]>
+  : T[];
 
-export type AssetsStatusEnum = 'active' | 'deleted' | 'trashed';
+export type AssetsStatusEnum = "active" | "deleted" | "trashed";
 
-export type Generated<T> =
-  T extends ColumnType<infer S, infer I, infer U> ? ColumnType<S, I | undefined, U> : ColumnType<T, T | undefined, T>;
+export type Generated<T> = T extends ColumnType<infer S, infer I, infer U>
+  ? ColumnType<S, I | undefined, U>
+  : ColumnType<T, T | undefined, T>;
 
 export type Int8 = ColumnType<string, bigint | number | string, bigint | number | string>;
 
@@ -28,7 +33,7 @@ export type JsonPrimitive = boolean | number | string | null;
 
 export type JsonValue = JsonArray | JsonObject | JsonPrimitive;
 
-export type Sourcetype = 'exif' | 'machine-learning';
+export type Sourcetype = "exif" | "machine-learning";
 
 export type Timestamp = ColumnType<Date, Date | string, Date | string>;
 
@@ -257,7 +262,7 @@ export interface NaturalearthCountries {
   admin: string;
   admin_a3: string;
   coordinates: string;
-  id: number;
+  id: Generated<number>;
   type: string;
 }
 
@@ -433,6 +438,6 @@ export interface DB {
   tags_closure: TagsClosure;
   user_metadata: UserMetadata;
   users: Users;
-  'vectors.pg_vector_index_stat': VectorsPgVectorIndexStat;
+  "vectors.pg_vector_index_stat": VectorsPgVectorIndexStat;
   version_history: VersionHistory;
 }
diff --git a/server/src/repositories/config.repository.spec.ts b/server/src/repositories/config.repository.spec.ts
@@ -83,7 +83,7 @@ describe('getEnv', () => {
         config: {
           kysely: {
             dialect: expect.any(PostgresJSDialect),
-            log: ['error'],
+            log: expect.any(Function),
           },
           typeorm: expect.objectContaining({
             type: 'postgres',

diff --git a/server/src/repositories/config.repository.ts b/server/src/repositories/config.repository.ts
@@ -5,7 +5,7 @@ import { Request, Response } from 'express';
 import { PostgresJSDialect } from 'kysely-postgres-js';
 import { CLS_ID } from 'nestjs-cls';
 import { join, resolve } from 'node:path';
-import postgres from 'postgres';
+import postgres, { Notice } from 'postgres';
 import { citiesFile, excludePaths, IWorker } from 'src/constants';
 import { Telemetry } from 'src/decorators';
 import { EnvDto } from 'src/dtos/env.dto';
@@ -99,6 +99,11 @@ const getEnv = (): EnvData => {
   }
 
   const driverOptions = {
+    onnotice: (notice: Notice) => {
+      if (notice['severity'] !== 'NOTICE') {
+        console.warn('Postgres notice:', notice);
+      }
+    },
     max: 10,
     types: {
       date: {
@@ -194,7 +199,16 @@ const getEnv = (): EnvData => {
           dialect: new PostgresJSDialect({
             postgres: databaseUrl ? postgres(databaseUrl, driverOptions) : postgres({ ...parts, ...driverOptions }),
           }),
-          log: ['error'] as const,
+          log(event) {
+            if (event.level === 'error') {
+              console.error('Query failed :', {
+                durationMs: event.queryDurationMillis,
+                error: event.error,
+                sql: event.query.sql,
+                params: event.query.parameters,
+              });
+            }
+          },
         },
       },