7085667460

Committed 04 Dec 2023 11:05AM UTC coverage: 89.703% (-0.1%) from 89.807%

Build # 7085667460

Build Type

push

github

Committed by

web-flow

Commit Message

Merge alerts, email and recovery features (#903)

- Removes `features.alerts` and `features.recovery` from the service configuration.
- These features are highly coupled to the email implementation which requires a deployed database.
- Setting `features.email` will now enable or disable the alerts, email and recovery related features.

Run Details

1408 of 1701 branches covered (0.0%)

Branch coverage included in aggregate %.

2 of 2 new or added lines in 2 files covered. (100.0%)

14 existing lines in 3 files now uncovered.

5239 of 5709 relevant lines covered (91.77%)

152.57 hits per line

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

37.5

/src/datasources/db/postgres-database.migration.hook.ts

import { Inject, Injectable, OnModuleInit } from '@nestjs/common';
import { ILoggingService, LoggingService } from '@/logging/logging.interface';
import * as shift from 'postgres-shift';
import postgres from 'postgres';

/**
 * The {@link PostgresDatabaseMigrationHook} is a Module Init hook meaning
 * that it will be executed once the dependencies are resolved.
 *
 * This happens before the Application Bootstraps, so route listeners are not
 * initiated and potentially generating queries.
 */
@Injectable({})
export class PostgresDatabaseMigrationHook implements OnModuleInit {
  private static LOCK_MAGIC_NUMBER = 132;

  constructor(
    @Inject('DB_INSTANCE') private readonly sql: postgres.Sql,
    @Inject(LoggingService) private readonly loggingService: ILoggingService,
  ) {}

  async onModuleInit() {
    this.loggingService.info('Checking migrations');
    try {
      // Acquire lock to perform a migration.
      // If the lock is not acquired, then a migration is being executed by another instance.
      // Migrations should strive to be idempotent as they can be executed by multiple instances
      // on the same database.
      await this
        .sql`SELECT pg_advisory_lock(${PostgresDatabaseMigrationHook.LOCK_MAGIC_NUMBER})`;
      // Perform migration
      await shift({ sql: this.sql });
      this.loggingService.info('Pending migrations executed');
    } catch (e) {
      // If there's an error performing a migration, we should throw the error
      // and prevent the service from starting
      this.loggingService.error(e);
      throw e;
    } finally {
      // the lock should be released if the migration completed (successfully or not)
      await this
        .sql`SELECT pg_advisory_unlock(${PostgresDatabaseMigrationHook.LOCK_MAGIC_NUMBER})`;
    }
  }
}

1	import { Inject, Injectable, OnModuleInit } from '@nestjs/common';	62✔
2	import { ILoggingService, LoggingService } from '@/logging/logging.interface';	62✔
3	import * as shift from 'postgres-shift';	62✔
4	import postgres from 'postgres';	62✔
5
6	/**
7	* The {@link PostgresDatabaseMigrationHook} is a Module Init hook meaning
8	* that it will be executed once the dependencies are resolved.
9	*
10	* This happens before the Application Bootstraps, so route listeners are not
11	* initiated and potentially generating queries.
12	*/
13	@Injectable({})
14	export class PostgresDatabaseMigrationHook implements OnModuleInit {	62✔
15	private static LOCK_MAGIC_NUMBER = 132;	62✔
16
17	constructor(
UNCOV 18	@Inject('DB_INSTANCE') private readonly sql: postgres.Sql,	×
UNCOV 19	@Inject(LoggingService) private readonly loggingService: ILoggingService,	×
20	) {}
21
22	async onModuleInit() {
UNCOV 23	this.loggingService.info('Checking migrations');	×
UNCOV 24	try {	×
25	// Acquire lock to perform a migration.
26	// If the lock is not acquired, then a migration is being executed by another instance.
27	// Migrations should strive to be idempotent as they can be executed by multiple instances
28	// on the same database.
UNCOV 29	await this	×
30	.sql`SELECT pg_advisory_lock(${PostgresDatabaseMigrationHook.LOCK_MAGIC_NUMBER})`;
31	// Perform migration
UNCOV 32	await shift({ sql: this.sql });	×
UNCOV 33	this.loggingService.info('Pending migrations executed');	×
34	} catch (e) {
35	// If there's an error performing a migration, we should throw the error
36	// and prevent the service from starting
37	this.loggingService.error(e);	×
38	throw e;	×
39	} finally {
40	// the lock should be released if the migration completed (successfully or not)
UNCOV 41	await this	×
42	.sql`SELECT pg_advisory_unlock(${PostgresDatabaseMigrationHook.LOCK_MAGIC_NUMBER})`;
43	}
44	}
45	}

safe-global / safe-client-gateway / 7085667460

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