11842015063

Committed 14 Nov 2024 05:05PM UTC coverage: 89.399% (-0.04%) from 89.44%

Build # 11842015063

Build Type

Pull #2129

github

Committed by

web-flow

Commit Message

Merge 1a0c18ed7 into 461ba005b

Pull Request Pull Request #2129: refactor: change swagger operationId output

Run Details

2708 of 3379 branches covered (80.14%)

Branch coverage included in aggregate %.

5 of 5 new or added lines in 1 file covered. (100.0%)

2 existing lines in 1 file now uncovered.

9098 of 9827 relevant lines covered (92.58%)

466.5 hits per line

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

91.89

/src/app.provider.ts

import type { INestApplication } from '@nestjs/common';
import { VersioningType } from '@nestjs/common';
import type { SwaggerDocumentOptions} from '@nestjs/swagger';
import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
import { NestFactory } from '@nestjs/core';
import { IConfigurationService } from '@/config/configuration.service.interface';
import { json } from 'express';
import cookieParser from 'cookie-parser';

function configureVersioning(app: INestApplication): void {
  app.enableVersioning({
    type: VersioningType.URI,
  });
}

export function configureShutdownHooks(app: INestApplication): void {
  app.enableShutdownHooks();
}

function configureSwagger(app: INestApplication): void {
  const configurationService = app.get<IConfigurationService>(
    IConfigurationService,
  );

  const config = new DocumentBuilder()
    .setTitle('Safe Client Gateway')
    .setVersion(configurationService.get('about.version') ?? '')
    .build();

  const options: SwaggerDocumentOptions = {
    operationIdFactory: (
      _: string,
      methodKey: string,
      version: string | undefined,
    ) => `${version ? version : ''}${methodKey.charAt(0).toUpperCase()}${methodKey.slice(1)}`,
  };

  const document = SwaggerModule.createDocument(app, config, options);
  SwaggerModule.setup('api', app, document, {
    customfavIcon: '/favicon.png',
    customSiteTitle: 'Safe Client Gateway',
    customCss: `.topbar-wrapper img { content:url('logo.svg'); }`,
  });
}

function configureRequestBodyLimit(app: INestApplication): void {
  const configurationService = app.get<IConfigurationService>(
    IConfigurationService,
  );

  const jsonBodySizeLimit =
    configurationService.get<string>('express.jsonLimit');
  if (jsonBodySizeLimit) {
    app.use(json({ limit: jsonBodySizeLimit }));
  }
}

function configureCookies(app: INestApplication): void {
  app.use(cookieParser());
}

export const DEFAULT_CONFIGURATION: ((app: INestApplication) => void)[] = [
  configureVersioning,
  configureShutdownHooks,
  configureSwagger,
  configureRequestBodyLimit,
  configureCookies,
];

/**
 * The main goal of {@link AppProvider} is to provide
 * a {@link INestApplication}.
 *
 * Extensions of this class should return the application in
 * {@link getApp}.
 *
 * Each provider should have a {@link configuration} which specifies
 * the steps taken to configure the application
 */
export abstract class AppProvider<T> {
  protected abstract readonly configuration: ((
    app: INestApplication,
  ) => void)[];

  public async provide(module: T): Promise<INestApplication> {
    const app = await this.getApp(module);
    this.configuration.forEach((f) => f(app));
    return app;
  }

  protected abstract getApp(module: T): Promise<INestApplication>;
}

/**
 * The default {@link AppProvider}
 *
 * This provider should be used to retrieve the actual implementation of the
 * service
 */
export class DefaultAppProvider<T> extends AppProvider<T> {
  protected readonly configuration: ((app: INestApplication) => void)[] =
    DEFAULT_CONFIGURATION;

  protected getApp(module: T): Promise<INestApplication> {
    return NestFactory.create(module);
  }
}

1	import type { INestApplication } from '@nestjs/common';
2	import { VersioningType } from '@nestjs/common';	104✔
3	import type { SwaggerDocumentOptions} from '@nestjs/swagger';
4	import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';	104✔
5	import { NestFactory } from '@nestjs/core';	104✔
6	import { IConfigurationService } from '@/config/configuration.service.interface';	104✔
7	import { json } from 'express';	104✔
8	import cookieParser from 'cookie-parser';	104✔
9
10	function configureVersioning(app: INestApplication): void {
11	app.enableVersioning({	1,372✔
12	type: VersioningType.URI,
13	});
14	}
15
16	export function configureShutdownHooks(app: INestApplication): void {	104✔
17	app.enableShutdownHooks();	×
18	}
19
20	function configureSwagger(app: INestApplication): void {
21	const configurationService = app.get<IConfigurationService>(	1,372✔
22	IConfigurationService,
23	);
24
25	const config = new DocumentBuilder()	1,372✔
26	.setTitle('Safe Client Gateway')
27	.setVersion(configurationService.get('about.version') ?? '')	2,058✔
28	.build();
29
30	const options: SwaggerDocumentOptions = {	1,372✔
31	operationIdFactory: (
32	_: string,
33	methodKey: string,
34	version: string \| undefined,
35	) => `${version ? version : ''}${methodKey.charAt(0).toUpperCase()}${methodKey.slice(1)}`,	74,998✔
36	};
37
38	const document = SwaggerModule.createDocument(app, config, options);	1,372✔
39	SwaggerModule.setup('api', app, document, {	1,372✔
40	customfavIcon: '/favicon.png',
41	customSiteTitle: 'Safe Client Gateway',
42	customCss: `.topbar-wrapper img { content:url('logo.svg'); }`,
43	});
44	}
45
46	function configureRequestBodyLimit(app: INestApplication): void {
47	const configurationService = app.get<IConfigurationService>(	1,372✔
48	IConfigurationService,
49	);
50
51	const jsonBodySizeLimit =
52	configurationService.get<string>('express.jsonLimit');	1,372✔
53	if (jsonBodySizeLimit) {	1,372✔
54	app.use(json({ limit: jsonBodySizeLimit }));	1,372✔
55	}
56	}
57
58	function configureCookies(app: INestApplication): void {
59	app.use(cookieParser());	1,372✔
60	}
61
62	export const DEFAULT_CONFIGURATION: ((app: INestApplication) => void)[] = [	104✔
63	configureVersioning,
64	configureShutdownHooks,
65	configureSwagger,
66	configureRequestBodyLimit,
67	configureCookies,
68	];
69
70	/**
71	* The main goal of {@link AppProvider} is to provide
72	* a {@link INestApplication}.
73	*
74	* Extensions of this class should return the application in
75	* {@link getApp}.
76	*
77	* Each provider should have a {@link configuration} which specifies
78	* the steps taken to configure the application
79	*/
80	export abstract class AppProvider<T> {	104✔
81	protected abstract readonly configuration: ((
82	app: INestApplication,
83	) => void)[];
84
85	public async provide(module: T): Promise<INestApplication> {
86	const app = await this.getApp(module);	1,372✔
87	this.configuration.forEach((f) => f(app));	5,488✔
88	return app;	1,372✔
89	}
90
91	protected abstract getApp(module: T): Promise<INestApplication>;
92	}
93
94	/**
95	* The default {@link AppProvider}
96	*
97	* This provider should be used to retrieve the actual implementation of the
98	* service
99	*/
100	export class DefaultAppProvider<T> extends AppProvider<T> {	104✔
UNCOV 101	protected readonly configuration: ((app: INestApplication) => void)[] =	×
102	DEFAULT_CONFIGURATION;
103
104	protected getApp(module: T): Promise<INestApplication> {
UNCOV 105	return NestFactory.create(module);	×
106	}
107	}

safe-global / safe-client-gateway / 11842015063

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