9546514333

Committed 17 Jun 2024 11:01AM UTC coverage: 49.473% (-42.8%) from 92.296%

Build # 9546514333

Build Type

push

github

Committed by

web-flow

Commit Message

Add `PostgresDatabaseMigrator` for (testing) migration (#1655)

Adds a new `PostgresDatabaseMigrator` that has the core logic of `postgres-shift`, as well as a testing method. The `migrate` method mirrors `postgres-shift` and the `test` method reuses part of it, executing each migration in a separate transaction. It allows us to interact with the database _before_ and _after_ a migration has executed, stopping after the desired migration:

- Create `PostgresDatabaseMigrator` and inject it
- Remove `postgres-shift` and associated definition/patch, replacing usage with the above
- Add appropriate test coverage

Run Details

394 of 2367 branches covered (16.65%)

Branch coverage included in aggregate %.

10 of 62 new or added lines in 3 files covered. (16.13%)

2191 existing lines in 221 files now uncovered.

3969 of 6452 relevant lines covered (61.52%)

12.49 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

42.11

/src/datasources/db/postgres-database.module.ts

import postgres from 'postgres';
import { Module } from '@nestjs/common';
import { PostgresDatabaseShutdownHook } from '@/datasources/db/postgres-database.shutdown.hook';
import { IConfigurationService } from '@/config/configuration.service.interface';
import { PostgresDatabaseMigrationHook } from '@/datasources/db/postgres-database.migration.hook';
import fs from 'fs';
import { PostgresDatabaseMigrator } from '@/datasources/db/postgres-database.migrator';

function dbFactory(configurationService: IConfigurationService): postgres.Sql {
  const caPath = configurationService.get<string>('db.postgres.ssl.caPath');
  const ca: string | undefined =
    caPath && caPath.length > 0 ? fs.readFileSync(caPath, 'utf8') : undefined;

  const sslConfig = configurationService.getOrThrow('db.postgres.ssl.enabled')
    ? {
        requestCert: configurationService.getOrThrow(
          'db.postgres.ssl.requestCert',
        ),
        rejectUnauthorized: configurationService.getOrThrow(
          'db.postgres.ssl.rejectUnauthorized',
        ),
        ca,
      }
    : false;
  return postgres({
    host: configurationService.getOrThrow('db.postgres.host'),
    port: configurationService.getOrThrow('db.postgres.port'),
    db: configurationService.getOrThrow('db.postgres.database'),
    user: configurationService.getOrThrow('db.postgres.username'),
    password: configurationService.getOrThrow('db.postgres.password'),
    ssl: sslConfig,
  });
}

function migratorFactory(sql: postgres.Sql): PostgresDatabaseMigrator {
  return new PostgresDatabaseMigrator(sql);
}

@Module({
  providers: [
    {
      provide: 'DB_INSTANCE',
      useFactory: dbFactory,
      inject: [IConfigurationService],
    },
    {
      provide: PostgresDatabaseMigrator,
      useFactory: migratorFactory,
      inject: ['DB_INSTANCE'],
    },
    PostgresDatabaseShutdownHook,
    PostgresDatabaseMigrationHook,
  ],
  exports: ['DB_INSTANCE'],
})
export class PostgresDatabaseModule {}

1	import postgres from 'postgres';	16✔
2	import { Module } from '@nestjs/common';	16✔
3	import { PostgresDatabaseShutdownHook } from '@/datasources/db/postgres-database.shutdown.hook';	16✔
4	import { IConfigurationService } from '@/config/configuration.service.interface';	16✔
5	import { PostgresDatabaseMigrationHook } from '@/datasources/db/postgres-database.migration.hook';	16✔
6	import fs from 'fs';	16✔
7	import { PostgresDatabaseMigrator } from '@/datasources/db/postgres-database.migrator';	16✔
8
9	function dbFactory(configurationService: IConfigurationService): postgres.Sql {
UNCOV 10	const caPath = configurationService.get<string>('db.postgres.ssl.caPath');	×
11	const ca: string \| undefined =
UNCOV 12	caPath && caPath.length > 0 ? fs.readFileSync(caPath, 'utf8') : undefined;	×
13
UNCOV 14	const sslConfig = configurationService.getOrThrow('db.postgres.ssl.enabled')	×
15	? {
16	requestCert: configurationService.getOrThrow(
17	'db.postgres.ssl.requestCert',
18	),
19	rejectUnauthorized: configurationService.getOrThrow(
20	'db.postgres.ssl.rejectUnauthorized',
21	),
22	ca,
23	}
24	: false;
UNCOV 25	return postgres({	×
26	host: configurationService.getOrThrow('db.postgres.host'),
27	port: configurationService.getOrThrow('db.postgres.port'),
28	db: configurationService.getOrThrow('db.postgres.database'),
29	user: configurationService.getOrThrow('db.postgres.username'),
30	password: configurationService.getOrThrow('db.postgres.password'),
31	ssl: sslConfig,
32	});
33	}
34
35	function migratorFactory(sql: postgres.Sql): PostgresDatabaseMigrator {
NEW 36	return new PostgresDatabaseMigrator(sql);	×
37	}
38
39	@Module({
40	providers: [
41	{
42	provide: 'DB_INSTANCE',
43	useFactory: dbFactory,
44	inject: [IConfigurationService],
45	},
46	{
47	provide: PostgresDatabaseMigrator,
48	useFactory: migratorFactory,
49	inject: ['DB_INSTANCE'],
50	},
51	PostgresDatabaseShutdownHook,
52	PostgresDatabaseMigrationHook,
53	],
54	exports: ['DB_INSTANCE'],
55	})
56	export class PostgresDatabaseModule {}	16✔

safe-global / safe-client-gateway / 9546514333

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous