OrmMigrationAndLogger

migrations/1726752966034-notification.ts

@@ -1,11 +1,11 @@
-import { MigrationInterface, QueryRunner } from 'typeorm';
+import type { MigrationInterface, QueryRunner } from 'typeorm';
 
 export class Notification1726752966034 implements MigrationInterface {
   name = 'Notification1726752966034';
 
   public async up(queryRunner: QueryRunner): Promise<void> {
     await queryRunner.query(
-      `CREATE TABLE "push_notification_devices" ("id" SERIAL NOT NULL, "device_type" character varying(255) NOT NULL CHECK (device_type IN ('ANDROID', 'IOS', 'WEB')), "device_uuid" uuid NOT NULL, "cloud_messaging_token" character varying(255) NOT NULL, "created_at" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(), "updated_at" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(), CONSTRAINT "device_uuid" UNIQUE ("device_uuid"), CONSTRAINT "PK_e387f5cc5b4f66d63804d596c64" PRIMARY KEY ("id"))`,
+      `CREATE TABLE "push_notification_devices" ("id" SERIAL NOT NULL, "device_type" character varying(255) NOT NULL, "device_uuid" uuid NOT NULL, "cloud_messaging_token" character varying(255) NOT NULL, "created_at" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(), "updated_at" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(), CONSTRAINT "device_uuid" UNIQUE ("device_uuid"), CONSTRAINT "PK_e387f5cc5b4f66d63804d596c64" PRIMARY KEY ("id"))`,
     );
     await queryRunner.query(
       `CREATE TABLE "notification_subscriptions" ("id" SERIAL NOT NULL, "chain_id" character varying(255) NOT NULL, "safe_address" character varying(42) NOT NULL, "signer_address" character varying(42), "created_at" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(), "updated_at" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(), "pushNotificationDeviceId" integer, CONSTRAINT "UQ_3c2531929422835e4f2717ec5db" UNIQUE ("chain_id", "safe_address", "pushNotificationDeviceId", "signer_address"), CONSTRAINT "PK_8cfec5d2a549ff20d1f4e648226" PRIMARY KEY ("id"))`,

migrations/1727451367471-notifications_enum.ts

@@ -0,0 +1,59 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class NotificationsEnum1727451367471 implements MigrationInterface {
+  name = 'NotificationsEnum1727451367471';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "notification_types" DROP CONSTRAINT "name"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "notification_types" DROP COLUMN "name"`,
+    );
+    await queryRunner.query(
+      `CREATE TYPE "public"."notification_types_name_enum" AS ENUM('CONFIRMATION_REQUEST', 'DELETED_MULTISIG_TRANSACTION', 'EXECUTED_MULTISIG_TRANSACTION', 'INCOMING_ETHER', 'INCOMING_TOKEN', 'MODULE_TRANSACTION', 'MESSAGE_CONFIRMATION_REQUEST')`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "notification_types" ADD "name" "public"."notification_types_name_enum" NOT NULL`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "notification_types" ADD CONSTRAINT "UQ_1d7eaa0dcf0fbfd0a8e6bdbc9c9" UNIQUE ("name")`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "push_notification_devices" DROP COLUMN "device_type"`,
+    );
+    await queryRunner.query(
+      `CREATE TYPE "public"."push_notification_devices_device_type_enum" AS ENUM('ANDROID', 'IOS', 'WEB')`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "push_notification_devices" ADD "device_type" "public"."push_notification_devices_device_type_enum" NOT NULL`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "push_notification_devices" DROP COLUMN "device_type"`,
+    );
+    await queryRunner.query(
+      `DROP TYPE "public"."push_notification_devices_device_type_enum"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "push_notification_devices" ADD "device_type" character varying(255) NOT NULL`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "notification_types" DROP CONSTRAINT "UQ_1d7eaa0dcf0fbfd0a8e6bdbc9c9"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "notification_types" DROP COLUMN "name"`,
+    );
+    await queryRunner.query(
+      `DROP TYPE "public"."notification_types_name_enum"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "notification_types" ADD "name" character varying(255) NOT NULL`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "notification_types" ADD CONSTRAINT "name" UNIQUE ("name")`,
+    );
+  }
+}

migrations/1727701600427-update_timestamp_trigger.ts

@@ -0,0 +1,19 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class UpdateTimestampTrigger1727701600427 implements MigrationInterface {
+  name = 'UpdateTimestampTrigger1727701600427';
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+        CREATE  FUNCTION update_updated_at()
+        RETURNS TRIGGER AS $$
+        BEGIN
+            NEW.updated_at = now();
+            RETURN NEW;
+        END;
+        $$ language 'plpgsql';`);
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`DROP FUNCTION IF EXISTS update_updated_at;`);
+  }
+}

migrations/1727701873513-notification_update_updated_at.ts

@@ -0,0 +1,33 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class NotificationUpdateUpdatedAt1727701873513
+  implements MigrationInterface
+{
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+            CREATE TRIGGER update_push_notification_devices_updated_at
+                BEFORE UPDATE
+                ON
+                    push_notification_devices
+                FOR EACH ROW
+            EXECUTE PROCEDURE update_updated_at();
+    `);
+    await queryRunner.query(`
+            CREATE TRIGGER update_notification_subscriptions_updated_at
+                BEFORE UPDATE
+                ON
+                    notification_subscriptions
+                FOR EACH ROW
+            EXECUTE PROCEDURE update_updated_at();
+    `);
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `DROP TRIGGER IF EXISTS update_push_notification_devices_updated_at ON push_notification_devices;`,
+    );
+    await queryRunner.query(
+      `DROP TRIGGER IF EXISTS update_notification_subscriptions_updated_at ON notification_subscriptions;`,
+    );
+  }
+}

migrations/1726754508107-notification_types.ts → migrations/1727702843994-notification_types.ts

@@ -1,6 +1,7 @@
 import { MigrationInterface, QueryRunner } from 'typeorm';
 
-export class NotificationTypes1726754508107 implements MigrationInterface {
+export class NotificationTypes1727702843994 implements MigrationInterface {
+  name = 'NotificationTypes1727702843994';
   public async up(queryRunner: QueryRunner): Promise<void> {
     await queryRunner.query(
       `INSERT INTO "notification_types" ("name") VALUES ('CONFIRMATION_REQUEST'),('DELETED_MULTISIG_TRANSACTION'),('EXECUTED_MULTISIG_TRANSACTION'),('INCOMING_ETHER'),('INCOMING_TOKEN'),('MESSAGE_CONFIRMATION_REQUEST'),('MODULE_TRANSACTION');`,

migrations/tests/1727702843993-test.ts

@@ -0,0 +1,11 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class NotificationTypes1727702843994 implements MigrationInterface {
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`SELECT now() as current_timestamp`);
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`SELECT now() as current_timestamp`);
+  }
+}

package.json

@@ -95,8 +95,7 @@
       "^.+\\.(t|j)s$": "ts-jest"
     },
     "roots": [
-      "./src",
-      "./migrations"
+      "./src"
     ],
     "collectCoverageFrom": [
       "**/*.(t|j)s"
@@ -106,7 +105,8 @@
       "index.ts",
       ".+\\/__tests__\\/.+\\.builder.(t|j)s",
       ".+\\/__tests__\\/.+\\.factory.(t|j)s",
-      ".e2e-spec.ts"
+      ".e2e-spec.ts",
+      "dist"
     ],
     "testEnvironment": "node",
     "moduleNameMapper": {

src/__tests__/db.factory.ts

@@ -13,7 +13,9 @@ export class TestDbFactory {
   private readonly mainConnection: postgres.Sql;
 
   constructor() {
-    this.mainConnection = this.connect(this.config.db.postgres.database);
+    this.mainConnection = this.connect(
+      this.config.db.connection.postgres.database,
+    );
   }
 
   async createTestDatabase(dbName: string): Promise<postgres.Sql> {
@@ -38,7 +40,8 @@ export class TestDbFactory {
    * @returns {@link postgres.Sql} pointing to the database
    */
   private connect(dbName: string): postgres.Sql {
-    const { host, port, username, password, ssl } = this.config.db.postgres;
+    const { host, port, username, password, ssl } =
+      this.config.db.connection.postgres;
     const sslEnabled = !this.isCIContext && ssl.enabled;
     return postgres({
       host,

src/app.module.ts

@@ -54,6 +54,10 @@ import { TargetedMessagingModule } from '@/routes/targeted-messaging/targeted-me
 import { ConfigModule, ConfigService } from '@nestjs/config';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { postgresConfig } from '@/config/entities/postgres.config';
+import {
+  LoggingService,
+  type ILoggingService,
+} from '@/logging/logging.interface';
 
 @Module({})
 export class AppModule implements NestModule {
@@ -131,18 +135,22 @@ export class AppModule implements NestModule {
         }),
         TypeOrmModule.forRootAsync({
           imports: [ConfigModule],
-          useFactory: async (configService: ConfigService) => {
-            const typeormConfig = await configService.getOrThrow('typeorm');
+          useFactory: async (
+            configService: ConfigService,
+            loggingService: ILoggingService,
+          ) => {
+            const typeormConfig = configService.getOrThrow('db.orm');
             const postgresConfigObject = postgresConfig(
-              await configService.getOrThrow('db.postgres'),
+              await configService.getOrThrow('db.connection.postgres'),
+              loggingService,
             );
 
             return {
               ...typeormConfig,
               ...postgresConfigObject,
             };
           },
-          inject: [ConfigService],
+          inject: [ConfigService, LoggingService],
         }),
       ],
       providers: [

src/config/entities/__tests__/configuration.ts

@@ -23,7 +23,7 @@ export default (): ReturnType<typeof configuration> => ({
   },
   application: {
     isProduction: faker.datatype.boolean(),
-    runMigrations: true,
+    runMigrations: false,
     port: faker.internet.port().toString(),
   },
   auth: {
@@ -84,20 +84,32 @@ export default (): ReturnType<typeof configuration> => ({
       apiKey: faker.string.hexadecimal({ length: 32 }),
     },
   },
-  typeorm: { autoLoadEntities: true, manualInitialization: true },
   db: {
-    postgres: {
-      schema: process.env.POSTGRES_SCHEMA || 'main',
-      host: process.env.POSTGRES_TEST_HOST || 'localhost',
-      port: process.env.POSTGRES_TEST_PORT || '5433',
-      database: process.env.POSTGRES_TEST_DB || 'test-db',
-      username: process.env.POSTGRES_TEST_USER || 'postgres',
-      password: process.env.POSTGRES_TEST_PASSWORD || 'postgres',
-      ssl: {
-        enabled: true,
-        requestCert: true,
-        rejectUnauthorized: true,
-        caPath: process.env.POSTGRES_SSL_CA_PATH,
+    migrator: {
+      migrationsExecute: true,
+      numberOfRetries: process.env.DB_TEST_MIGRATIONS_NUMBER_OF_RETRIES ?? 5,
+      retryAfter: process.env.DB_TEST_MIGRATIONS_RETRY_AFTER ?? 1000, // Milliseconds
+    },
+    orm: {
+      autoLoadEntities: true,
+      manualInitialization: true,
+      migrationsRun: false,
+      migrationsTableName: 'migrations_typeorm',
+    },
+    connection: {
+      postgres: {
+        schema: process.env.POSTGRES_SCHEMA || 'main',
+        host: process.env.POSTGRES_TEST_HOST || 'localhost',
+        port: process.env.POSTGRES_TEST_PORT || '5433',
+        database: process.env.POSTGRES_TEST_DB || 'test-db',
+        username: process.env.POSTGRES_TEST_USER || 'postgres',
+        password: process.env.POSTGRES_TEST_PASSWORD || 'postgres',
+        ssl: {
+          enabled: true,
+          requestCert: true,
+          rejectUnauthorized: true,
+          caPath: process.env.POSTGRES_SSL_CA_PATH,
+        },
       },
     },
   },

src/config/entities/configuration.ts

@@ -1,4 +1,5 @@
 // Custom configuration for the application
+
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 export default () => ({
   about: {
@@ -44,8 +45,8 @@ export default () => ({
   application: {
     isProduction: process.env.CGW_ENV === 'production',
     // Enables/disables the execution of migrations on startup.
-    // Defaults to true.
-    runMigrations: process.env.RUN_MIGRATIONS?.toLowerCase() !== 'false',
+    // Defaults to false.
+    runMigrations: process.env.RUN_MIGRATIONS?.toLowerCase() === 'true',
     port: process.env.APPLICATION_PORT || '3000',
   },
   auth: {
@@ -131,26 +132,39 @@ export default () => ({
       apiKey: process.env.INFURA_API_KEY,
     },
   },
-  typeorm: { autoLoadEntities: true, manualInitialization: true },
   db: {
-    postgres: {
-      host: process.env.POSTGRES_HOST || 'localhost',
-      port: process.env.POSTGRES_PORT || '5432',
-      database: process.env.POSTGRES_DB || 'safe-client-gateway',
-      schema: process.env.POSTGRES_SCHEMA || 'main', //@TODO: use this schema
-      username: process.env.POSTGRES_USER || 'postgres',
-      password: process.env.POSTGRES_PASSWORD || 'postgres',
-      ssl: {
-        enabled: process.env.POSTGRES_SSL_ENABLED?.toLowerCase() === 'true',
-        requestCert:
-          process.env.POSTGRES_SSL_REQUEST_CERT?.toLowerCase() !== 'false',
-        // If the value is not explicitly set to false, default should be true
-        // If not false the server will reject any connection which is not authorized with the list of supplied CAs
-        // https://nodejs.org/docs/latest-v20.x/api/tls.html#tlscreateserveroptions-secureconnectionlistener
-        rejectUnauthorized:
-          process.env.POSTGRES_SSL_REJECT_UNAUTHORIZED?.toLowerCase() !==
-          'false',
-        caPath: process.env.POSTGRES_SSL_CA_PATH,
+    migrator: {
+      migrationsExecute:
+        process.env.DB_MIGRATIONS_EXECUTE?.toLowerCase() !== 'false',
+      numberOfRetries: process.env.DB_MIGRATIONS_NUMBER_OF_RETRIES ?? 5,
+      retryAfter: process.env.DB_MIGRATIONS_RETRY_AFTER ?? 1000, // Milliseconds
+    },
+    orm: {
+      migrationsRun: false,
+      autoLoadEntities: true,
+      manualInitialization: true,
+      migrationsTableName: 'migrations_typeorm',
+    },
+    connection: {
+      postgres: {
+        host: process.env.POSTGRES_HOST || 'localhost',
+        port: process.env.POSTGRES_PORT || '5432',
+        database: process.env.POSTGRES_DB || 'safe-client-gateway',
+        schema: process.env.POSTGRES_SCHEMA || 'main', //@TODO: use this schema
+        username: process.env.POSTGRES_USER || 'postgres',
+        password: process.env.POSTGRES_PASSWORD || 'postgres',
+        ssl: {
+          enabled: process.env.POSTGRES_SSL_ENABLED?.toLowerCase() === 'true',
+          requestCert:
+            process.env.POSTGRES_SSL_REQUEST_CERT?.toLowerCase() !== 'false',
+          // If the value is not explicitly set to false, default should be true
+          // If not false the server will reject any connection which is not authorized with the list of supplied CAs
+          // https://nodejs.org/docs/latest-v20.x/api/tls.html#tlscreateserveroptions-secureconnectionlistener
+          rejectUnauthorized:
+            process.env.POSTGRES_SSL_REJECT_UNAUTHORIZED?.toLowerCase() !==
+            'false',
+          caPath: process.env.POSTGRES_SSL_CA_PATH,
+        },
       },
     },
   },

src/config/entities/orm.config.ts

@@ -2,6 +2,9 @@ import { DataSource } from 'typeorm';
 import configuration from '@/config/entities/configuration';
 import { postgresConfig } from '@/config/entities/postgres.config';
 
-export default new DataSource(
-  postgresConfig({ ...configuration().db.postgres, type: 'postgres' }),
-);
+export default new DataSource({
+  ...postgresConfig({
+    ...configuration().db.connection.postgres,
+    type: 'postgres',
+  }),
+});

src/config/entities/postgres.config.ts

@@ -1,3 +1,5 @@
+import { PostgresqlLogger } from '@/datasources/db/v2/postgresql-logger.service';
+import type { ILoggingService } from '@/logging/logging.interface';
 import { readFileSync } from 'fs';
 import type { PostgresConnectionOptions } from 'typeorm/driver/postgres/PostgresConnectionOptions';
 
@@ -18,6 +20,7 @@ interface IPostgresEnvConfig {
 
 export const postgresConfig = (
   postgresEnvConfig: IPostgresEnvConfig,
+  logger?: ILoggingService,
 ): PostgresConnectionOptions => {
   const isCIContext = process.env.CI?.toLowerCase() === 'true';
   const isSslEnabled = !isCIContext && postgresEnvConfig.ssl.enabled;
@@ -37,7 +40,7 @@ export const postgresConfig = (
     password: postgresEnvConfig.password,
     database: postgresEnvConfig.database,
     migrations: ['dist/migrations/*.js'],
-    // logging: !isCIContext,
+    logger: new PostgresqlLogger(undefined, logger),
     ssl: isSslEnabled
       ? {
           ca: postgresCa,