这是indexloc提供的服务，不要输入任何密码
Skip to content

refactor: fastify plugin use dsl #2998

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 17, 2025
Merged

refactor: fastify plugin use dsl #2998

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...ges/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/fastify/default/fastify.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ export type RouteHandlers = {
Reply: DummyBResponses;
}>;
callWithDuplicateResponses: RouteHandler<{
Reply: Omit<CallWithDuplicateResponsesErrors, 'default'> & CallWithDuplicateResponsesResponses;
Reply: Omit<CallWithDuplicateResponsesErrors, "default"> & CallWithDuplicateResponsesResponses;
}>;
callWithResponses: RouteHandler<{
Reply: Omit<CallWithResponsesErrors, 'default'> & CallWithResponsesResponses;
Reply: Omit<CallWithResponsesErrors, "default"> & CallWithResponsesResponses;
}>;
collectionFormat: RouteHandler<{
Querystring: CollectionFormatData['query'];
Expand Down
16 changes: 8 additions & 8 deletions ...ges/openapi-ts-tests/main/test/__snapshots__/3.0.x/plugins/fastify/default/fastify.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import type { ApiVVersionODataControllerCountResponses, CallToTestOrderOfParamsD
export type RouteHandlers = {
import: RouteHandler<{
Body: ImportData['body'];
Reply: Omit<ImportResponses, 'default'>;
Reply: Omit<ImportResponses, "default">;
}>;
apiVVersionODataControllerCount: RouteHandler<{
Reply: ApiVVersionODataControllerCountResponses;
Expand Down Expand Up @@ -43,16 +43,16 @@ export type RouteHandlers = {
Querystring?: GetCallWithOptionalParamData['query'];
}>;
postCallWithOptionalParam: RouteHandler<{
Body: PostCallWithOptionalParamData['body'];
Body?: PostCallWithOptionalParamData['body'];
Querystring: PostCallWithOptionalParamData['query'];
Reply: PostCallWithOptionalParamResponses;
}>;
postApiVbyApiVersionRequestBody: RouteHandler<{
Body: PostApiVbyApiVersionRequestBodyData['body'];
Body?: PostApiVbyApiVersionRequestBodyData['body'];
Querystring?: PostApiVbyApiVersionRequestBodyData['query'];
}>;
postApiVbyApiVersionFormData: RouteHandler<{
Body: PostApiVbyApiVersionFormDataData['body'];
Body?: PostApiVbyApiVersionFormDataData['body'];
Querystring?: PostApiVbyApiVersionFormDataData['query'];
}>;
callWithDefaultParameters: RouteHandler<{
Expand All @@ -77,10 +77,10 @@ export type RouteHandlers = {
Reply: DummyBResponses;
}>;
callWithDuplicateResponses: RouteHandler<{
Reply: Omit<CallWithDuplicateResponsesErrors, 'default'> & CallWithDuplicateResponsesResponses;
Reply: Omit<CallWithDuplicateResponsesErrors, "default"> & CallWithDuplicateResponsesResponses;
}>;
callWithResponses: RouteHandler<{
Reply: Omit<CallWithResponsesErrors, 'default'> & CallWithResponsesResponses;
Reply: Omit<CallWithResponsesErrors, "default"> & CallWithResponsesResponses;
}>;
collectionFormat: RouteHandler<{
Querystring: CollectionFormatData['query'];
Expand All @@ -107,10 +107,10 @@ export type RouteHandlers = {
Reply: MultipartResponseResponses;
}>;
multipartRequest: RouteHandler<{
Body: MultipartRequestData['body'];
Body?: MultipartRequestData['body'];
}>;
complexParams: RouteHandler<{
Body: ComplexParamsData['body'];
Body?: ComplexParamsData['body'];
Params: ComplexParamsData['path'];
Reply: ComplexParamsResponses;
}>;
Expand Down
16 changes: 8 additions & 8 deletions ...ges/openapi-ts-tests/main/test/__snapshots__/3.1.x/plugins/fastify/default/fastify.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import type { ApiVVersionODataControllerCountResponses, CallToTestOrderOfParamsD
export type RouteHandlers = {
import: RouteHandler<{
Body: ImportData['body'];
Reply: Omit<ImportResponses, 'default'>;
Reply: Omit<ImportResponses, "default">;
}>;
apiVVersionODataControllerCount: RouteHandler<{
Reply: ApiVVersionODataControllerCountResponses;
Expand Down Expand Up @@ -43,16 +43,16 @@ export type RouteHandlers = {
Querystring?: GetCallWithOptionalParamData['query'];
}>;
postCallWithOptionalParam: RouteHandler<{
Body: PostCallWithOptionalParamData['body'];
Body?: PostCallWithOptionalParamData['body'];
Querystring: PostCallWithOptionalParamData['query'];
Reply: PostCallWithOptionalParamResponses;
}>;
postApiVbyApiVersionRequestBody: RouteHandler<{
Body: PostApiVbyApiVersionRequestBodyData['body'];
Body?: PostApiVbyApiVersionRequestBodyData['body'];
Querystring?: PostApiVbyApiVersionRequestBodyData['query'];
}>;
postApiVbyApiVersionFormData: RouteHandler<{
Body: PostApiVbyApiVersionFormDataData['body'];
Body?: PostApiVbyApiVersionFormDataData['body'];
Querystring?: PostApiVbyApiVersionFormDataData['query'];
}>;
callWithDefaultParameters: RouteHandler<{
Expand All @@ -77,10 +77,10 @@ export type RouteHandlers = {
Reply: DummyBResponses;
}>;
callWithDuplicateResponses: RouteHandler<{
Reply: Omit<CallWithDuplicateResponsesErrors, 'default'> & CallWithDuplicateResponsesResponses;
Reply: Omit<CallWithDuplicateResponsesErrors, "default"> & CallWithDuplicateResponsesResponses;
}>;
callWithResponses: RouteHandler<{
Reply: Omit<CallWithResponsesErrors, 'default'> & CallWithResponsesResponses;
Reply: Omit<CallWithResponsesErrors, "default"> & CallWithResponsesResponses;
}>;
collectionFormat: RouteHandler<{
Querystring: CollectionFormatData['query'];
Expand All @@ -107,10 +107,10 @@ export type RouteHandlers = {
Reply: MultipartResponseResponses;
}>;
multipartRequest: RouteHandler<{
Body: MultipartRequestData['body'];
Body?: MultipartRequestData['body'];
}>;
complexParams: RouteHandler<{
Body: ComplexParamsData['body'];
Body?: ComplexParamsData['body'];
Params: ComplexParamsData['path'];
Reply: ComplexParamsResponses;
}>;
Expand Down
144 changes: 56 additions & 88 deletions packages/openapi-ts/src/plugins/fastify/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
import type ts from 'typescript';

import { operationResponsesMap } from '~/ir/operation';
import { hasParameterGroupObjectRequired } from '~/ir/parameter';
import type { IR } from '~/ir/types';
import { type Property, tsc } from '~/tsc';
import { $ } from '~/ts-dsl';

import type { FastifyPlugin } from './types';

Expand All @@ -13,8 +11,8 @@ const operationToRouteHandler = ({
}: {
operation: IR.OperationObject;
plugin: FastifyPlugin['Instance'];
}): Property | undefined => {
const properties: Array<Property> = [];
}) => {
const type = $.type.object();

const symbolDataType = plugin.querySymbol({
category: 'type',
Expand All @@ -25,49 +23,49 @@ const operationToRouteHandler = ({
});
if (symbolDataType) {
if (operation.body) {
properties.push({
isRequired: operation.body.required,
name: 'Body',
type: `${symbolDataType.placeholder}['body']`,
});
type.prop('Body', (p) =>
p
.optional(!operation.body!.required)
.type(`${symbolDataType.placeholder}['body']`),
);
}

if (operation.parameters) {
if (operation.parameters.header) {
properties.push({
isRequired: hasParameterGroupObjectRequired(
operation.parameters.header,
),
name: 'Headers',
type: `${symbolDataType.placeholder}['headers']`,
});
type.prop('Headers', (p) =>
p
.optional(
!hasParameterGroupObjectRequired(operation.parameters!.header),
)
.type(`${symbolDataType.placeholder}['headers']`),
);
}

if (operation.parameters.path) {
properties.push({
isRequired: hasParameterGroupObjectRequired(
operation.parameters.path,
),
name: 'Params',
type: `${symbolDataType.placeholder}['path']`,
});
type.prop('Params', (p) =>
p
.optional(
!hasParameterGroupObjectRequired(operation.parameters!.path),
)
.type(`${symbolDataType.placeholder}['path']`),
);
}

if (operation.parameters.query) {
properties.push({
isRequired: hasParameterGroupObjectRequired(
operation.parameters.query,
),
name: 'Querystring',
type: `${symbolDataType.placeholder}['query']`,
});
type.prop('Querystring', (p) =>
p
.optional(
!hasParameterGroupObjectRequired(operation.parameters!.query),
)
.type(`${symbolDataType.placeholder}['query']`),
);
}
}
}

const { errors, responses } = operationResponsesMap(operation);

let errorsTypeReference: ts.TypeReferenceNode | undefined = undefined;
let errorsTypeReference: ReturnType<typeof $.type> | undefined;
const symbolErrorType = plugin.querySymbol({
category: 'type',
resource: 'operation',
Expand All @@ -79,25 +77,19 @@ const operationToRouteHandler = ({
if (keys.length) {
const hasDefaultResponse = keys.includes('default');
if (!hasDefaultResponse) {
errorsTypeReference = tsc.typeReferenceNode({
typeName: symbolErrorType.placeholder,
});
errorsTypeReference = $.type(symbolErrorType.placeholder);
} else if (keys.length > 1) {
const errorsType = tsc.typeReferenceNode({
typeName: symbolErrorType.placeholder,
});
const defaultType = tsc.literalTypeNode({
literal: tsc.stringLiteral({ text: 'default' }),
});
errorsTypeReference = tsc.typeReferenceNode({
typeArguments: [errorsType, defaultType],
typeName: 'Omit',
});
errorsTypeReference = $.type('Omit', (t) =>
t.generics(
$.type(symbolErrorType.placeholder),
$.type.literal('default'),
),
);
}
}
}

let responsesTypeReference: ts.TypeReferenceNode | undefined = undefined;
let responsesTypeReference: ReturnType<typeof $.type> | undefined = undefined;
const symbolResponseType = plugin.querySymbol({
category: 'type',
resource: 'operation',
Expand All @@ -109,37 +101,26 @@ const operationToRouteHandler = ({
if (keys.length) {
const hasDefaultResponse = keys.includes('default');
if (!hasDefaultResponse) {
responsesTypeReference = tsc.typeReferenceNode({
typeName: symbolResponseType.placeholder,
});
responsesTypeReference = $.type(symbolResponseType.placeholder);
} else if (keys.length > 1) {
const responsesType = tsc.typeReferenceNode({
typeName: symbolResponseType.placeholder,
});
const defaultType = tsc.literalTypeNode({
literal: tsc.stringLiteral({ text: 'default' }),
});
responsesTypeReference = tsc.typeReferenceNode({
typeArguments: [responsesType, defaultType],
typeName: 'Omit',
});
responsesTypeReference = $.type('Omit', (t) =>
t.generics(
$.type(symbolResponseType.placeholder),
$.type.literal('default'),
),
);
}
}
}

const replyTypes = [errorsTypeReference, responsesTypeReference].filter(
Boolean,
(t): t is ReturnType<typeof $.type> => t !== undefined,
);
if (replyTypes.length) {
properties.push({
name: 'Reply',
type: tsc.typeIntersectionNode({
types: replyTypes,
}),
});
type.prop('Reply', (p) => p.type($.type.and(...replyTypes)));
}

if (!properties.length) {
if (type.isEmpty) {
return;
}

Expand All @@ -148,19 +129,10 @@ const operationToRouteHandler = ({
resource: 'route-handler',
tool: 'fastify',
});
const routeHandler: Property = {
return {
name: operation.id,
type: tsc.typeReferenceNode({
typeArguments: [
tsc.typeInterfaceNode({
properties,
useLegacyResolution: false,
}),
],
typeName: symbolRouteHandler.placeholder,
}),
type: $.type(symbolRouteHandler.placeholder, (t) => t.generic(type)),
};
return routeHandler;
};

export const handler: FastifyPlugin['Handler'] = ({ plugin }) => {
Expand All @@ -181,28 +153,24 @@ export const handler: FastifyPlugin['Handler'] = ({ plugin }) => {
name: 'RouteHandlers',
});

const routeHandlers: Array<Property> = [];
const type = $.type.object();

plugin.forEach(
'operation',
({ operation }) => {
const routeHandler = operationToRouteHandler({ operation, plugin });
if (routeHandler) {
routeHandlers.push(routeHandler);
type.prop(routeHandler.name, (p) => p.type(routeHandler.type));
}
},
{
order: 'declarations',
},
);

const node = tsc.typeAliasDeclaration({
exportType: symbolRouteHandlers.exported,
name: symbolRouteHandlers.placeholder,
type: tsc.typeInterfaceNode({
properties: routeHandlers,
useLegacyResolution: false,
}),
});
const node = $.type
.alias(symbolRouteHandlers.placeholder)
.export(symbolRouteHandlers.exported)
.type(type);
plugin.setSymbolValue(symbolRouteHandlers, node);
};
Loading
Loading