Skip to content

Commit

Permalink
feat(swagger): Provide URI version to operationIdFactory
Browse files Browse the repository at this point in the history 
Adds a new optional parameter to operationIdFactory to allow providing the API version prefix added to the operation's path.

This allows the operationIdFactory to generate unique IDs in the case of the same controller method being used for multiple API versions.

Default behavior is unchanged - the operation IDs will be of the form controllerKey_methodKey, but where necessary this can be customised using the URI version prefix.

This is based on the work completed in nestjs#1949. Those changes were reverted due to test failures.

This change adapts those changes to also support neutral versions which resolves the test failures.

Closes nestjs#2537
  • Loading branch information
@deongroenewald
deongroenewald committed Aug 2, 2023
1 parent 96ea50e commit 00b2b62
Show file tree
Hide file tree
Showing 4 changed files with 282 additions and 10 deletions.
14 changes: 13 additions & 1 deletion lib/interfaces/swagger-document-options.interface.ts
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
export type OperationIdFactory =
| ((
controllerKey: string,
methodKey: string,
pathVersionKey?: string
) => string)
| ((
controllerKey: string,
methodKey: string,
pathVersionKey?: string
) => string);

export interface SwaggerDocumentOptions {
/**
* List of modules to include in the specification
Expand All @@ -24,5 +36,5 @@ export interface SwaggerDocumentOptions {
* based on the `controllerKey` and `methodKey`
* @default () => controllerKey_methodKey
*/
operationIdFactory?: (controllerKey: string, methodKey: string) => string;
operationIdFactory?: OperationIdFactory;
}
46 changes: 39 additions & 7 deletions lib/swagger-explorer.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
import {
Controller,
Type,
VERSION_NEUTRAL,
VersioningOptions,
VersionValue
} from '@nestjs/common/interfaces';
Expand Down Expand Up @@ -53,6 +54,7 @@ import {
exploreApiTagsMetadata,
exploreGlobalApiTagsMetadata
} from './explorers/api-use-tags.explorer';
import { OperationIdFactory } from './interfaces';
import { DenormalizedDocResolvers } from './interfaces/denormalized-doc-resolvers.interface';
import { DenormalizedDoc } from './interfaces/denormalized-doc.interface';
import {
Expand All @@ -68,8 +70,10 @@ export class SwaggerExplorer {
private readonly mimetypeContentWrapper = new MimetypeContentWrapper();
private readonly metadataScanner = new MetadataScanner();
private readonly schemas: Record<string, SchemaObject> = {};
private operationIdFactory = (controllerKey: string, methodKey: string) =>
controllerKey ? `${controllerKey}_${methodKey}` : methodKey;
private operationIdFactory: OperationIdFactory = (
controllerKey: string,
methodKey: string
) => (controllerKey ? `${controllerKey}_${methodKey}` : methodKey);
private routePathFactory?: RoutePathFactory;

constructor(private readonly schemaObjectFactory: SchemaObjectFactory) {}
Expand All @@ -79,7 +83,7 @@ export class SwaggerExplorer {
applicationConfig: ApplicationConfig,
modulePath?: string | undefined,
globalPrefix?: string | undefined,
operationIdFactory?: (controllerKey: string, methodKey: string) => string
operationIdFactory?: OperationIdFactory
) {
this.routePathFactory = new RoutePathFactory(applicationConfig);
if (operationIdFactory) {
Expand Down Expand Up @@ -275,6 +279,25 @@ export class SwaggerExplorer {
metatype,
applicationConfig.getVersioning()
);

const versionOrVersions = methodVersion ?? controllerVersion;
let versions: string[] = [];
if (!!versionOrVersions) {
if (Array.isArray(versionOrVersions)) {
versions = versionOrVersions.filter(
(v) => v !== VERSION_NEUTRAL
) as string[];
} else if (versionOrVersions !== VERSION_NEUTRAL) {
versions = [versionOrVersions];
}

const versionConfig = applicationConfig.getVersioning();
if (versionConfig?.type == VersioningType.URI) {
const prefix = this.routePathFactory.getVersionPrefix(versionConfig);
versions = versions.map((v) => `${prefix}${v}`);
}
}

const allRoutePaths = this.routePathFactory.create(
{
methodPath,
Expand Down Expand Up @@ -302,24 +325,33 @@ export class SwaggerExplorer {
return validMethods.map((meth) => ({
method: meth.toLowerCase(),
path: fullPath === '' ? '/' : fullPath,
operationId: `${this.getOperationId(instance, method)}_${meth.toLowerCase()}`,
operationId: `${this.getOperationId(
instance,
method
)}_${meth.toLowerCase()}`,
...apiExtension
}));
}
const pathVersion = versions.find((v) => fullPath.includes(`/${v}/`));
return {
method: RequestMethod[requestMethod].toLowerCase(),
path: fullPath === '' ? '/' : fullPath,
operationId: this.getOperationId(instance, method),
operationId: this.getOperationId(instance, method, pathVersion),
...apiExtension
};
})
);
}

private getOperationId(instance: object, method: Function): string {
private getOperationId(
instance: object,
method: Function,
pathVersion?: string
): string {
return this.operationIdFactory(
instance.constructor?.name || '',
method.name
method.name,
pathVersion
);
}

Expand Down
8 changes: 6 additions & 2 deletions lib/swagger-scanner.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ import { ApplicationConfig, NestContainer } from '@nestjs/core';
import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper';
import { Module } from '@nestjs/core/injector/module';
import { flatten, isEmpty } from 'lodash';
import { OpenAPIObject, SwaggerDocumentOptions } from './interfaces';
import {
OpenAPIObject,
OperationIdFactory,
SwaggerDocumentOptions
} from './interfaces';
import { ModuleRoute } from './interfaces/module-route.interface';
import {
ReferenceObject,
Expand Down Expand Up @@ -106,7 +110,7 @@ export class SwaggerScanner {
modulePath: string | undefined,
globalPrefix: string | undefined,
applicationConfig: ApplicationConfig,
operationIdFactory?: (controllerKey: string, methodKey: string) => string
operationIdFactory?: OperationIdFactory
): ModuleRoute[] {
const denormalizedArray = [...controller.values()].map((ctrl) =>
this.explorer.exploreController(
Expand Down
224 changes: 224 additions & 0 deletions test/explorer/swagger-explorer.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ describe('SwaggerExplorer', () => {
controllerKey: string,
methodKey: string
) => `${controllerKey}.${methodKey}`;
const controllerKeyMethodKeyVersionKeyOperationIdFactory = (
controllerKey: string,
methodKey: string,
versionKey?: string
) =>
versionKey
? `${controllerKey}.${methodKey}.${versionKey}`
: `${controllerKey}.${methodKey}`;

describe('when module only uses metadata', () => {
class Foo {}
Expand Down Expand Up @@ -1325,6 +1333,10 @@ describe('SwaggerExplorer', () => {
const CONTROLLER_VERSION: VersionValue = '1';
const METHOD_VERSION: VersionValue = '2';
const CONTROLLER_MULTIPLE_VERSIONS: VersionValue = ['3', '4'];
const CONTROLLER_MULTIPLE_VERSIONS_NEUTRAL: VersionValue = [
'5',
VERSION_NEUTRAL
];

@Controller({ path: 'with-version', version: CONTROLLER_VERSION })
class WithVersionController {
Expand All @@ -1345,6 +1357,15 @@ describe('SwaggerExplorer', () => {
foo(): void {}
}

@Controller({
path: 'with-multiple-version-neutral',
version: CONTROLLER_MULTIPLE_VERSIONS_NEUTRAL
})
class WithMultipleVersionsNeutralController {
@Get()
foo(): void {}
}

beforeAll(() => {
explorer = new SwaggerExplorer(schemaObjectFactory);

Expand All @@ -1355,6 +1376,209 @@ describe('SwaggerExplorer', () => {
});
});

describe('and using the default operationIdFactory', () => {
it('should use controller version defined', () => {
const routes = explorer.exploreController(
{
instance: new WithVersionController(),
metatype: WithVersionController
} as InstanceWrapper<WithVersionController>,
config,
'modulePath',
'globalPrefix'
);

expect(routes[0].root.path).toEqual(
`/globalPrefix/v${CONTROLLER_VERSION}/modulePath/with-version`
);
expect(routes[0].root.operationId).toEqual(
`WithVersionController_foo`
);
});

it('should use route version defined', () => {
const routes = explorer.exploreController(
{
instance: new WithVersionController(),
metatype: WithVersionController
} as InstanceWrapper<WithVersionController>,
config,
'modulePath',
'globalPrefix'
);

expect(routes[1].root.path).toEqual(
`/globalPrefix/v${METHOD_VERSION}/modulePath/with-version`
);
expect(routes[1].root.operationId).toEqual(
`WithVersionController_bar`
);
});

it('should use multiple versions defined', () => {
const routes = explorer.exploreController(
{
instance: new WithMultipleVersionsController(),
metatype: WithMultipleVersionsController
} as InstanceWrapper<WithMultipleVersionsController>,
config,
'modulePath',
'globalPrefix'
);

expect(routes[0].root.path).toEqual(
`/globalPrefix/v${
CONTROLLER_MULTIPLE_VERSIONS[0] as string
}/modulePath/with-multiple-version`
);
expect(routes[0].root.operationId).toEqual(
`WithMultipleVersionsController_foo`
);
expect(routes[1].root.path).toEqual(
`/globalPrefix/v${
CONTROLLER_MULTIPLE_VERSIONS[1] as string
}/modulePath/with-multiple-version`
);
expect(routes[1].root.operationId).toEqual(
`WithMultipleVersionsController_foo`
);
});

it('should use multiple versions with neutral defined', () => {
const routes = explorer.exploreController(
{
instance: new WithMultipleVersionsNeutralController(),
metatype: WithMultipleVersionsNeutralController
} as InstanceWrapper<WithMultipleVersionsNeutralController>,
config,
'modulePath',
'globalPrefix'
);

expect(routes[0].root.path).toEqual(
`/globalPrefix/v${
CONTROLLER_MULTIPLE_VERSIONS_NEUTRAL[0] as string
}/modulePath/with-multiple-version-neutral`
);
expect(routes[0].root.operationId).toEqual(
`WithMultipleVersionsNeutralController_foo`
);

expect(routes[1].root.path).toEqual(
`/globalPrefix/modulePath/with-multiple-version-neutral`
);
expect(routes[1].root.operationId).toEqual(
`WithMultipleVersionsNeutralController_foo`
);
});
});

describe('and has an operationIdFactory that uses the method version', () => {
it('should use controller version defined', () => {
const routes = explorer.exploreController(
{
instance: new WithVersionController(),
metatype: WithVersionController
} as InstanceWrapper<WithVersionController>,
config,
'modulePath',
'globalPrefix',
controllerKeyMethodKeyVersionKeyOperationIdFactory
);

expect(routes[0].root.path).toEqual(
`/globalPrefix/v${CONTROLLER_VERSION}/modulePath/with-version`
);
expect(routes[0].root.operationId).toEqual(
`WithVersionController.foo.v${CONTROLLER_VERSION}`
);
});

it('should use route version defined', () => {
const routes = explorer.exploreController(
{
instance: new WithVersionController(),
metatype: WithVersionController
} as InstanceWrapper<WithVersionController>,
config,
'modulePath',
'globalPrefix',
controllerKeyMethodKeyVersionKeyOperationIdFactory
);

expect(routes[1].root.path).toEqual(
`/globalPrefix/v${METHOD_VERSION}/modulePath/with-version`
);
expect(routes[1].root.operationId).toEqual(
`WithVersionController.bar.v${METHOD_VERSION}`
);
});

it('should use multiple versions defined', () => {
const routes = explorer.exploreController(
{
instance: new WithMultipleVersionsController(),
metatype: WithMultipleVersionsController
} as InstanceWrapper<WithMultipleVersionsController>,
config,
'modulePath',
'globalPrefix',
controllerKeyMethodKeyVersionKeyOperationIdFactory
);

expect(routes[0].root.path).toEqual(
`/globalPrefix/v${
CONTROLLER_MULTIPLE_VERSIONS[0] as string
}/modulePath/with-multiple-version`
);
expect(routes[0].root.operationId).toEqual(
`WithMultipleVersionsController.foo.v${
CONTROLLER_MULTIPLE_VERSIONS[0] as string
}`
);
expect(routes[1].root.path).toEqual(
`/globalPrefix/v${
CONTROLLER_MULTIPLE_VERSIONS[1] as string
}/modulePath/with-multiple-version`
);
expect(routes[1].root.operationId).toEqual(
`WithMultipleVersionsController.foo.v${
CONTROLLER_MULTIPLE_VERSIONS[1] as string
}`
);
});

it('should use multiple versions with neutral defined', () => {
const routes = explorer.exploreController(
{
instance: new WithMultipleVersionsNeutralController(),
metatype: WithMultipleVersionsNeutralController
} as InstanceWrapper<WithMultipleVersionsNeutralController>,
config,
'modulePath',
'globalPrefix',
controllerKeyMethodKeyVersionKeyOperationIdFactory
);

expect(routes[0].root.path).toEqual(
`/globalPrefix/v${
CONTROLLER_MULTIPLE_VERSIONS_NEUTRAL[0] as string
}/modulePath/with-multiple-version-neutral`
);
expect(routes[0].root.operationId).toEqual(
`WithMultipleVersionsNeutralController.foo.v${
CONTROLLER_MULTIPLE_VERSIONS_NEUTRAL[0] as string
}`
);
expect(routes[1].root.path).toEqual(
`/globalPrefix/modulePath/with-multiple-version-neutral`
);
expect(routes[1].root.operationId).toEqual(
`WithMultipleVersionsNeutralController.foo`
);
});
});

it('should use controller version defined', () => {
const routes = explorer.exploreController(
{
Expand Down

0 comments on commit 00b2b62

Please sign in to comment.