11463033754

Committed 22 Oct 2024 02:36PM UTC coverage: 90.264% (-1.4%) from 91.686%

Build # 11463033754

Build Type

push

github

Committed by

web-flow

Commit Message

Orm (#1942)

* Add TypeOrm support.
* Introduce a new query logger to TypeORM.
* Ensure TypeORM migrations run after locking the database during startup.
* Establish database connection only when the database module is registered.

Run Details

2666 of 3269 branches covered (81.55%)

Branch coverage included in aggregate %.

133 of 275 new or added lines in 39 files covered. (48.36%)

1 existing line in 1 file now uncovered.

8849 of 9488 relevant lines covered (93.27%)

421.96 hits per line

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

12.24

/src/datasources/db/v2/postgresql-logger.service.ts

import { type ILoggingService } from '@/logging/logging.interface';
import { Injectable } from '@nestjs/common';
import {
  AbstractLogger,
  type LoggerOptions,
  type LogLevel,
  type LogMessage,
} from 'typeorm';

@Injectable()
export class PostgresqlLogger extends AbstractLogger {
  public constructor(
    private readonly loggingService: ILoggingService,
    public options?: LoggerOptions,
  ) {
    super(options);
  }
  /**
   * Write log to specific output.
   *
   * This is taken from the TypeOrm default implementation, check out {@link https://orkhan.gitbook.io/typeorm/docs/logging}
   */
  protected writeLog(
    level: LogLevel,
    logMessage: LogMessage | LogMessage[],
  ): void {
    const messages = this.prepareLogMessages(logMessage, {
      highlightSql: false,
    });

    for (const message of messages) {
      switch (message.type ?? level) {
        case 'log':
        case 'schema-build':
        case 'migration':
          this.loggingService.info(`${message.prefix} - ${message.message}`);
          break;

        case 'info':
        case 'query':
          if (message.prefix) {
            this.loggingService.info(`${message.prefix} - ${message.message}`);
          } else {
            this.loggingService.info(message.message);
          }
          break;

        case 'warn':
        case 'query-slow':
          if (message.prefix) {
            this.loggingService.warn(`${message.prefix} - ${message.message}`);
          } else {
            this.loggingService.warn(message.message);
          }
          break;

        case 'error':
        case 'query-error':
          if (message.prefix) {
            this.loggingService.error(`${message.prefix} - ${message.message}`);
          } else {
            this.loggingService.error(message.message);
          }
          break;
      }
    }
  }

  /**
   * Logs the executed query along with the request URL if available.
   *
   * @param {string} query - The SQL query string that is being executed.
   *
   * @returns {void} This method does not return anything.
   */
  public logQuery(query: string): void {
    if (this.loggingService) {
      this.loggingService.debug(`executing query: '${query}'`);
    }
  }
}

1	import { type ILoggingService } from '@/logging/logging.interface';
2	import { Injectable } from '@nestjs/common';	106✔
3	import {	106✔
4	AbstractLogger,
5	type LoggerOptions,
6	type LogLevel,
7	type LogMessage,
8	} from 'typeorm';
9
10	@Injectable()
11	export class PostgresqlLogger extends AbstractLogger {	106✔
12	public constructor(
13	private readonly loggingService: ILoggingService,	1,222✔
14	public options?: LoggerOptions,	1,222✔
15	) {
16	super(options);	1,222✔
17	}
18	/**
19	* Write log to specific output.
20	*
21	* This is taken from the TypeOrm default implementation, check out {@link https://orkhan.gitbook.io/typeorm/docs/logging}
22	*/
23	protected writeLog(
24	level: LogLevel,
25	logMessage: LogMessage \| LogMessage[],
26	): void {
NEW 27	const messages = this.prepareLogMessages(logMessage, {	×
28	highlightSql: false,
29	});
30
NEW 31	for (const message of messages) {	×
NEW 32	switch (message.type ?? level) {	×
33	case 'log':
34	case 'schema-build':
35	case 'migration':
NEW 36	this.loggingService.info(`${message.prefix} - ${message.message}`);	×
NEW 37	break;	×
38
39	case 'info':
40	case 'query':
NEW 41	if (message.prefix) {	×
NEW 42	this.loggingService.info(`${message.prefix} - ${message.message}`);	×
43	} else {
NEW 44	this.loggingService.info(message.message);	×
45	}
NEW 46	break;	×
47
48	case 'warn':
49	case 'query-slow':
NEW 50	if (message.prefix) {	×
NEW 51	this.loggingService.warn(`${message.prefix} - ${message.message}`);	×
52	} else {
NEW 53	this.loggingService.warn(message.message);	×
54	}
NEW 55	break;	×
56
57	case 'error':
58	case 'query-error':
NEW 59	if (message.prefix) {	×
NEW 60	this.loggingService.error(`${message.prefix} - ${message.message}`);	×
61	} else {
NEW 62	this.loggingService.error(message.message);	×
63	}
NEW 64	break;	×
65	}
66	}
67	}
68
69	/**
70	* Logs the executed query along with the request URL if available.
71	*
72	* @param {string} query - The SQL query string that is being executed.
73	*
74	* @returns {void} This method does not return anything.
75	*/
76	public logQuery(query: string): void {
NEW 77	if (this.loggingService) {	×
NEW 78	this.loggingService.debug(`executing query: '${query}'`);	×
79	}
80	}
81	}

safe-global / safe-client-gateway / 11463033754

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