11842071706

Committed 14 Nov 2024 05:08PM UTC coverage: 89.444% (+0.004%) from 89.44%

Build # 11842071706

Build Type

Pull #2129

github

Committed by

compojoom

Commit Message

refactor: change swagger operationId output

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

Run Details

2714 of 3379 branches covered (80.32%)

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.39 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	) =>
36	`${version ? version : ''}${methodKey.charAt(0).toUpperCase()}${methodKey.slice(1)}`,	74,998✔
37	};
38
39	const document = SwaggerModule.createDocument(app, config, options);	1,372✔
40	SwaggerModule.setup('api', app, document, {	1,372✔
41	customfavIcon: '/favicon.png',
42	customSiteTitle: 'Safe Client Gateway',
43	customCss: `.topbar-wrapper img { content:url('logo.svg'); }`,
44	});
45	}
46
47	function configureRequestBodyLimit(app: INestApplication): void {
48	const configurationService = app.get<IConfigurationService>(	1,372✔
49	IConfigurationService,
50	);
51
52	const jsonBodySizeLimit =
53	configurationService.get<string>('express.jsonLimit');	1,372✔
54	if (jsonBodySizeLimit) {	1,372✔
55	app.use(json({ limit: jsonBodySizeLimit }));	1,372✔
56	}
57	}
58
59	function configureCookies(app: INestApplication): void {
60	app.use(cookieParser());	1,372✔
61	}
62
63	export const DEFAULT_CONFIGURATION: ((app: INestApplication) => void)[] = [	104✔
64	configureVersioning,
65	configureShutdownHooks,
66	configureSwagger,
67	configureRequestBodyLimit,
68	configureCookies,
69	];
70
71	/**
72	* The main goal of {@link AppProvider} is to provide
73	* a {@link INestApplication}.
74	*
75	* Extensions of this class should return the application in
76	* {@link getApp}.
77	*
78	* Each provider should have a {@link configuration} which specifies
79	* the steps taken to configure the application
80	*/
81	export abstract class AppProvider<T> {	104✔
82	protected abstract readonly configuration: ((
83	app: INestApplication,
84	) => void)[];
85
86	public async provide(module: T): Promise<INestApplication> {
87	const app = await this.getApp(module);	1,372✔
88	this.configuration.forEach((f) => f(app));	5,488✔
89	return app;	1,372✔
90	}
91
92	protected abstract getApp(module: T): Promise<INestApplication>;
93	}
94
95	/**
96	* The default {@link AppProvider}
97	*
98	* This provider should be used to retrieve the actual implementation of the
99	* service
100	*/
101	export class DefaultAppProvider<T> extends AppProvider<T> {	104✔
UNCOV 102	protected readonly configuration: ((app: INestApplication) => void)[] =	×
103	DEFAULT_CONFIGURATION;
104
105	protected getApp(module: T): Promise<INestApplication> {
UNCOV 106	return NestFactory.create(module);	×
107	}
108	}

safe-global / safe-client-gateway / 11842071706

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