Skip to content
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

Feat/Upload multiple files in different fields #1541

Merged
merged 3 commits into from
Jan 28, 2024
Merged

Feat/Upload multiple files in different fields #1541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
731a878
test: cases for multiple upload fields
jackey8616 Jan 16, 2024
05f5b11
feat: implementation of multiple upload fields
jackey8616 Jan 16, 2024
79a057e
chore: lint
jackey8616 Jan 24, 2024
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
8 changes: 5 additions & 3 deletions packages/cli/src/routeGeneration/routeGenerator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,16 +94,18 @@ export abstract class AbstractRouteGenerator<Config extends ExtendedRoutesConfig

const normalisedFullPath = normalisePath(`${normalisedBasePath}${normalisedControllerPath}${normalisedMethodPath}`, '/', '', false);

const uploadFileParameter = method.parameters.find(parameter => parameter.type.dataType === 'file');
const uploadFilesWithDifferentFieldParameter = method.parameters.filter(parameter => parameter.type.dataType === 'file');
const uploadFilesParameter = method.parameters.find(parameter => parameter.type.dataType === 'array' && parameter.type.elementType.dataType === 'file');
return {
fullPath: normalisedFullPath,
method: method.method.toLowerCase(),
name: method.name,
parameters: parameterObjs,
path: normalisedMethodPath,
uploadFile: !!uploadFileParameter,
uploadFileName: uploadFileParameter?.name,
uploadFile: uploadFilesWithDifferentFieldParameter.length > 0,
uploadFileName: uploadFilesWithDifferentFieldParameter.map((parameter) => ({
'name': parameter.name,
})),
uploadFiles: !!uploadFilesParameter,
uploadFilesName: uploadFilesParameter?.name,
security: method.security,
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/routeGeneration/templates/express/express.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export function RegisterRoutes(app: Router) {
authenticateMiddleware({{json security}}),
{{/if}}
{{#if uploadFile}}
upload.single('{{uploadFileName}}'),
upload.fields({{json uploadFileName}}),
{{/if}}
{{#if uploadFiles}}
upload.array('{{uploadFilesName}}'),
Expand Down
86 changes: 45 additions & 41 deletions packages/cli/src/routeGeneration/templates/express/expressTemplateService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Request as ExRequest, Response as ExResponse } from 'express';
import { FieldErrors, HttpStatusCodeLiteral, TsoaResponse, ValidateError, ValidationService } from "@tsoa/runtime";
import { FieldErrors, HttpStatusCodeLiteral, TsoaResponse, ValidateError, ValidationService } from '@tsoa/runtime';

import { TemplateService, isController } from '../templateService';

Expand All @@ -25,70 +25,74 @@ export class ExpressTemplateService implements TemplateService<ExRequest, ExResp

// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa

this.returnHandler(response, headers, statusCode, data)
this.returnHandler(response, headers, statusCode, data);
})
.catch((error: any) => next(error));
}

returnHandler(response: any, headers: any = {}, statusCode?: number, data?: any) {
if (response.headersSent) {
return;
return;
}
Object.keys(headers).forEach((name: string) => {
response.set(name, headers[name]);
response.set(name, headers[name]);
});
if (data && typeof data.pipe === 'function' && data.readable && typeof data._read === 'function') {
response.status(statusCode || 200)
data.pipe(response);
response.status(statusCode || 200);
data.pipe(response);
} else if (data !== null && data !== undefined) {
response.status(statusCode || 200).json(data);
response.status(statusCode || 200).json(data);
} else {
response.status(statusCode || 204).end();
response.status(statusCode || 204).end();
}
}

responder(response: any): TsoaResponse<HttpStatusCodeLiteral, unknown> {
responder(response: any): TsoaResponse<HttpStatusCodeLiteral, unknown> {
return (status, data, headers) => {
this.returnHandler(response, headers, status, data);
this.returnHandler(response, headers, status, data);
};
}

getValidatedArgs(args: any, request: ExRequest, response: ExResponse): any[] {
const fieldErrors: FieldErrors = {};
const values = Object.keys(args).map((key) => {
const name = args[key].name;
switch (args[key].in) {
case 'request':
return request;
case 'request-prop':
return this.validationService.ValidateParam(args[key], (request as any)[name], name, fieldErrors, undefined, this.minimalSwaggerConfig);
case 'query':
return this.validationService.ValidateParam(args[key], request.query[name], name, fieldErrors, undefined, this.minimalSwaggerConfig);
case 'queries':
return this.validationService.ValidateParam(args[key], request.query, name, fieldErrors, undefined, this.minimalSwaggerConfig);
case 'path':
return this.validationService.ValidateParam(args[key], request.params[name], name, fieldErrors, undefined, this.minimalSwaggerConfig);
case 'header':
return this.validationService.ValidateParam(args[key], request.header(name), name, fieldErrors, undefined, this.minimalSwaggerConfig);
case 'body':
return this.validationService.ValidateParam(args[key], request.body, name, fieldErrors, undefined, this.minimalSwaggerConfig);
case 'body-prop':
return this.validationService.ValidateParam(args[key], request.body[name], name, fieldErrors, 'body.', this.minimalSwaggerConfig);
case 'formData':
if (args[key].dataType === 'file') {
return this.validationService.ValidateParam(args[key], request.file, name, fieldErrors, undefined, this.minimalSwaggerConfig);
} else if (args[key].dataType === 'array' && args[key].array.dataType === 'file') {
return this.validationService.ValidateParam(args[key], request.files, name, fieldErrors, undefined, this.minimalSwaggerConfig);
} else {
return this.validationService.ValidateParam(args[key], request.body[name], name, fieldErrors, undefined, this.minimalSwaggerConfig);
}
case 'res':
return this.responder(response);
const fieldErrors: FieldErrors = {};
const values = Object.keys(args).map(key => {
const name = args[key].name;
switch (args[key].in) {
case 'request':
return request;
case 'request-prop':
return this.validationService.ValidateParam(args[key], (request as any)[name], name, fieldErrors, undefined, this.minimalSwaggerConfig);
case 'query':
return this.validationService.ValidateParam(args[key], request.query[name], name, fieldErrors, undefined, this.minimalSwaggerConfig);
case 'queries':
return this.validationService.ValidateParam(args[key], request.query, name, fieldErrors, undefined, this.minimalSwaggerConfig);
case 'path':
return this.validationService.ValidateParam(args[key], request.params[name], name, fieldErrors, undefined, this.minimalSwaggerConfig);
case 'header':
return this.validationService.ValidateParam(args[key], request.header(name), name, fieldErrors, undefined, this.minimalSwaggerConfig);
case 'body':
return this.validationService.ValidateParam(args[key], request.body, name, fieldErrors, undefined, this.minimalSwaggerConfig);
case 'body-prop':
return this.validationService.ValidateParam(args[key], request.body[name], name, fieldErrors, 'body.', this.minimalSwaggerConfig);
case 'formData': {
const formFiles = Object.keys(args).filter(argKey => args[argKey].dataType === 'file');
if (formFiles.length > 0) {
const requestFiles = request.files as { [fileName: string]: Express.Multer.File[] };
const fileArgs = this.validationService.ValidateParam(args[key], requestFiles[name], name, fieldErrors, undefined, this.minimalSwaggerConfig);
return fileArgs.length === 1 ? fileArgs[0] : fileArgs;
} else if (args[key].dataType === 'array' && args[key].array.dataType === 'file') {
return this.validationService.ValidateParam(args[key], request.files, name, fieldErrors, undefined, this.minimalSwaggerConfig);
} else {
return this.validationService.ValidateParam(args[key], request.body[name], name, fieldErrors, undefined, this.minimalSwaggerConfig);
}
}
case 'res':
return this.responder(response);
}
});

if (Object.keys(fieldErrors).length > 0) {
throw new ValidateError(fieldErrors, '');
throw new ValidateError(fieldErrors, '');
}
return values;
}
Expand Down
4 changes: 3 additions & 1 deletion packages/cli/src/routeGeneration/templates/hapi/hapi.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,11 @@ export function RegisterRoutes(server: any) {
},
{{/if}}
{{#if uploadFile}}
{{#each uploadFileName}}
{
method: fileUploadMiddleware('{{uploadFileName}}', false)
method: fileUploadMiddleware('{{name}}', false)
},
{{/each}}
{{/if}}
{{#if uploadFiles}}
{
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/routeGeneration/templates/koa/koa.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ export function RegisterRoutes(router: KoaRouter) {
authenticateMiddleware({{json security}}),
{{/if}}
{{#if uploadFile}}
upload.single('{{uploadFileName}}'),
upload.fields({{json uploadFileName}}),
{{/if}}
{{#if uploadFiles}}
upload.array('{{uploadFilesName}}'),
Expand Down
64 changes: 34 additions & 30 deletions packages/cli/src/routeGeneration/templates/koa/koaTemplateService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type { Context } from 'koa';
import { TsoaResponse, HttpStatusCodeLiteral, FieldErrors, ValidationService, ValidateError } from "@tsoa/runtime";
import { TemplateService, isController } from "../templateService";
import { TsoaResponse, HttpStatusCodeLiteral, FieldErrors, ValidationService, ValidateError } from '@tsoa/runtime';
import { TemplateService, isController } from '../templateService';

export class KoaTemplateService implements TemplateService<any, Context> {
private readonly validationService: ValidationService;
Expand All @@ -19,8 +19,8 @@ export class KoaTemplateService implements TemplateService<any, Context> {
let headers;

if (isController(controllerObj)) {
headers = controllerObj.getHeaders();
statusCode = controllerObj.getStatus() || statusCode;
headers = controllerObj.getHeaders();
statusCode = controllerObj.getStatus() || statusCode;
}
return this.returnHandler(context, headers, statusCode, data, next);
})
Expand All @@ -33,14 +33,14 @@ export class KoaTemplateService implements TemplateService<any, Context> {
returnHandler(context: Context, headers: any, statusCode?: number | undefined, data?: any, next?: any) {
if (!context.headerSent && !(context.response as any).__tsoaResponded) {
if (data !== null && data !== undefined) {
context.body = data;
context.status = 200;
context.body = data;
context.status = 200;
} else {
context.status = 204;
context.status = 204;
}

if (statusCode) {
context.status = statusCode;
context.status = statusCode;
}

context.set(headers);
Expand All @@ -49,48 +49,52 @@ export class KoaTemplateService implements TemplateService<any, Context> {
}
}

responder(context: any, next?: any): TsoaResponse<HttpStatusCodeLiteral, unknown> {
responder(context: any, next?: any): TsoaResponse<HttpStatusCodeLiteral, unknown> {
return (status, data, headers) => {
this.returnHandler(context, headers, status, data, next);
this.returnHandler(context, headers, status, data, next);
};
}

getValidatedArgs(args: any, request: any, context: Context, next: () => any): any[] {
const errorFields: FieldErrors = {};
const values = Object.keys(args).map(key => {
const name = args[key].name;
switch (args[key].in) {
const name = args[key].name;
switch (args[key].in) {
case 'request':
return context.request;
case 'request-prop':
return this.validationService.ValidateParam(args[key], (context.request as any)[name], name, errorFields, undefined, this.minimalSwaggerConfig);
case 'query':
return this.validationService.ValidateParam(args[key], context.request.query[name], name, errorFields, undefined, this.minimalSwaggerConfig);
return this.validationService.ValidateParam(args[key], context.request.query[name], name, errorFields, undefined, this.minimalSwaggerConfig);
case 'queries':
return this.validationService.ValidateParam(args[key], context.request.query, name, errorFields, undefined, this.minimalSwaggerConfig);
return this.validationService.ValidateParam(args[key], context.request.query, name, errorFields, undefined, this.minimalSwaggerConfig);
case 'path':
return this.validationService.ValidateParam(args[key], context.params[name], name, errorFields, undefined, this.minimalSwaggerConfig);
return this.validationService.ValidateParam(args[key], context.params[name], name, errorFields, undefined, this.minimalSwaggerConfig);
case 'header':
return this.validationService.ValidateParam(args[key], context.request.headers[name], name, errorFields, undefined, this.minimalSwaggerConfig);
return this.validationService.ValidateParam(args[key], context.request.headers[name], name, errorFields, undefined, this.minimalSwaggerConfig);
case 'body':
return this.validationService.ValidateParam(args[key], (context.request as any).body, name, errorFields, undefined, this.minimalSwaggerConfig);
return this.validationService.ValidateParam(args[key], (context.request as any).body, name, errorFields, undefined, this.minimalSwaggerConfig);
case 'body-prop':
return this.validationService.ValidateParam(args[key], (context.request as any).body[name], name, errorFields, 'body.', this.minimalSwaggerConfig);
case 'formData':
if (args[key].dataType === 'file') {
return this.validationService.ValidateParam(args[key], (context.request as any).file, name, errorFields, undefined, this.minimalSwaggerConfig);
} else if (args[key].dataType === 'array' && args[key].array.dataType === 'file') {
return this.validationService.ValidateParam(args[key], (context.request as any).files, name, errorFields, undefined, this.minimalSwaggerConfig);
} else {
return this.validationService.ValidateParam(args[key], (context.request as any).body[name], name, errorFields, undefined, this.minimalSwaggerConfig);
}
case 'res':
return this.responder(context, next);
return this.validationService.ValidateParam(args[key], (context.request as any).body[name], name, errorFields, 'body.', this.minimalSwaggerConfig);
case 'formData': {
const files = Object.keys(args).filter(argKey => args[argKey].dataType === 'file');
const contextRequest = context.request as any;
if (files.length > 0) {
const fileArgs = this.validationService.ValidateParam(args[key], contextRequest.files[name], name, errorFields, undefined, this.minimalSwaggerConfig);
return fileArgs.length === 1 ? fileArgs[0] : fileArgs;
} else if (args[key].dataType === 'array' && args[key].array.dataType === 'file') {
return this.validationService.ValidateParam(args[key], contextRequest.files, name, errorFields, undefined, this.minimalSwaggerConfig);
} else {
return this.validationService.ValidateParam(args[key], contextRequest.body[name], name, errorFields, undefined, this.minimalSwaggerConfig);
}
}
case 'res':
return this.responder(context, next);
}
});
if (Object.keys(errorFields).length > 0) {
throw new ValidateError(errorFields, '');
throw new ValidateError(errorFields, '');
}
return values;
}
}
}
8 changes: 8 additions & 0 deletions tests/fixtures/controllers/postController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,14 @@ export class PostTestController {
return files;
}

@Post('ManyFilesInDifferentFields')
public async postWithDifferentFields(
@UploadedFile('file_a') fileA: File,
@UploadedFile('file_b') fileB: File,
): Promise<File[]> {
return [fileA, fileB];
}

/**
*
* @param aFile File description of multipart
Expand Down
19 changes: 19 additions & 0 deletions tests/integration/express-server.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1524,6 +1524,25 @@ describe('Express Server', () => {
});
});

it('can post multiple files with different field', () => {
const formData = {
file_a: '@../package.json',
file_b: '@../tsconfig.json',
};
return verifyFileUploadRequest(`${basePath}/PostTest/ManyFilesInDifferentFields`, formData, (_err, res) => {
for (const file of res.body as File[]) {
const packageJsonBuffer = readFileSync(resolve(__dirname, `../${file.originalname}`));
const returnedBuffer = Buffer.from(file.buffer);
expect(file).to.not.be.undefined;
expect(file.fieldname).to.be.not.undefined;
expect(file.originalname).to.be.not.undefined;
expect(file.encoding).to.be.not.undefined;
expect(file.mimetype).to.equal('application/json');
expect(Buffer.compare(returnedBuffer, packageJsonBuffer)).to.equal(0);
}
});
});

function verifyFileUploadRequest(
path: string,
formData: any,
Expand Down
19 changes: 19 additions & 0 deletions tests/integration/hapi-server.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1423,6 +1423,25 @@ describe('Hapi Server', () => {
});
});

it('can post multiple files with different field', () => {
const formData = {
file_a: '@../package.json',
file_b: '@../tsconfig.json',
};
return verifyFileUploadRequest(`${basePath}/PostTest/ManyFilesInDifferentFields`, formData, (_err, res) => {
for (const file of res.body as File[]) {
const packageJsonBuffer = readFileSync(resolve(__dirname, `../${file.originalname}`));
const returnedBuffer = Buffer.from(file.buffer);
expect(file).to.not.be.undefined;
expect(file.fieldname).to.be.not.undefined;
expect(file.originalname).to.be.not.undefined;
expect(file.encoding).to.be.not.undefined;
expect(file.mimetype).to.equal('application/json');
expect(Buffer.compare(returnedBuffer, packageJsonBuffer)).to.equal(0);
}
});
});

function verifyFileUploadRequest(
path: string,
formData: any,
Expand Down
19 changes: 19 additions & 0 deletions tests/integration/koa-server.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1387,6 +1387,25 @@ describe('Koa Server', () => {
});
});

it('can post multiple files with different field', () => {
const formData = {
file_a: '@../package.json',
file_b: '@../tsconfig.json',
};
return verifyFileUploadRequest(`${basePath}/PostTest/ManyFilesInDifferentFields`, formData, (_err, res) => {
for (const file of res.body as File[]) {
const packageJsonBuffer = readFileSync(resolve(__dirname, `../${file.originalname}`));
const returnedBuffer = Buffer.from(file.buffer);
expect(file).to.not.be.undefined;
expect(file.fieldname).to.be.not.undefined;
expect(file.originalname).to.be.not.undefined;
expect(file.encoding).to.be.not.undefined;
expect(file.mimetype).to.equal('application/json');
expect(Buffer.compare(returnedBuffer, packageJsonBuffer)).to.equal(0);
}
});
});

function verifyFileUploadRequest(
path: string,
formData: any,
Expand Down
Loading