Merge pull request #1583 from jackey8616/fix/1580_mixed_form_data_with_file

Fix/mixed form-data w/ file cause 'length' problem

Author: WoH

packages/runtime/src/routeGeneration/templates/express/expressTemplateService.ts

@@ -83,15 +83,14 @@ export class ExpressTemplateService extends TemplateService<ExpressApiHandlerPar
           return this.validationService.ValidateParam(param, request.body[name], name, fieldErrors, 'body.', this.minimalSwaggerConfig);
         case 'formData': {
           const files = Object.values(args).filter(param => param.dataType === 'file');
-          if (files.length > 0) {
+          if (param.dataType === 'file' && files.length > 0) {
             const requestFiles = request.files as { [fileName: string]: Express.Multer.File[] };
             const fileArgs = this.validationService.ValidateParam(param, requestFiles[name], name, fieldErrors, undefined, this.minimalSwaggerConfig);
             return fileArgs.length === 1 ? fileArgs[0] : fileArgs;
           } else if (param.dataType === 'array' && param.array && param.array.dataType === 'file') {
             return this.validationService.ValidateParam(param, request.files, name, fieldErrors, undefined, this.minimalSwaggerConfig);
-          } else {
-            return this.validationService.ValidateParam(param, request.body[name], name, fieldErrors, undefined, this.minimalSwaggerConfig);
           }
+          return this.validationService.ValidateParam(param, request.body[name], name, fieldErrors, undefined, this.minimalSwaggerConfig);
         }
         case 'res':
           return (status: number | undefined, data: any, headers: any) => {

packages/runtime/src/routeGeneration/templates/koa/koaTemplateService.ts

@@ -93,14 +93,13 @@ export class KoaTemplateService extends TemplateService<KoaApiHandlerParameters,
         case 'formData': {
           const files = Object.values(args).filter(param => param.dataType === 'file');
           const contextRequest = context.request as any;
-          if (files.length > 0) {
+          if (param.dataType === 'file' && files.length > 0) {
             const fileArgs = this.validationService.ValidateParam(param, contextRequest.files[name], name, errorFields, undefined, this.minimalSwaggerConfig);
             return fileArgs.length === 1 ? fileArgs[0] : fileArgs;
           } else if (param.dataType === 'array' && param.array && param.array.dataType === 'file') {
             return this.validationService.ValidateParam(param, contextRequest.files, name, errorFields, undefined, this.minimalSwaggerConfig);
-          } else {
-            return this.validationService.ValidateParam(param, contextRequest.body[name], name, errorFields, undefined, this.minimalSwaggerConfig);
           }
+          return this.validationService.ValidateParam(param, contextRequest.body[name], name, errorFields, undefined, this.minimalSwaggerConfig);
         }
         case 'res':
           return async (status: number | undefined, data: any, headers: any): Promise<void> => {

tests/fixtures/controllers/postController.ts

@@ -75,6 +75,14 @@ export class PostTestController {
     return [fileA, fileB];
   }
 
+  @Post('MixedFormDataWithFile')
+  public async mixedFormDataWithFile(
+    @FormField('username') username: string,
+    @UploadedFile('avatar') avatar: File,
+  ): Promise<{ username: string; avatar: File; }> {
+    return { username, avatar };
+  }
+
   /**
    *
    * @param aFile File description of multipart

tests/integration/express-server.spec.ts

@@ -1560,6 +1560,25 @@ describe('Express Server', () => {
       });
     });
 
+    it('can post mixed form data content with file', () => {
+      const formData = {
+        username: 'test',
+        avatar: '@../tsconfig.json',
+      };
+      return verifyFileUploadRequest(`${basePath}/PostTest/MixedFormDataWithFile`, formData, (_err, res) => {
+        const file = res.body.avatar;
+        const packageJsonBuffer = readFileSync(resolve(__dirname, `../${file.originalname}`));
+        const returnedBuffer = Buffer.from(file.buffer);
+        expect(res.body.username).to.equal(formData.username);
+        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,

tests/integration/hapi-server.spec.ts

@@ -1443,6 +1443,25 @@ describe('Hapi Server', () => {
       });
     });
 
+    it('can post mixed form data content with file', () => {
+      const formData = {
+        username: 'test',
+        avatar: '@../tsconfig.json',
+      };
+      return verifyFileUploadRequest(`${basePath}/PostTest/MixedFormDataWithFile`, formData, (_err, res) => {
+        const file = res.body.avatar;
+        const packageJsonBuffer = readFileSync(resolve(__dirname, `../${file.originalname}`));
+        const returnedBuffer = Buffer.from(file.buffer);
+        expect(res.body.username).to.equal(formData.username);
+        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,

tests/integration/koa-server.spec.ts

@@ -1423,6 +1423,25 @@ describe('Koa Server', () => {
       });
     });
 
+    it('can post mixed form data content with file', () => {
+      const formData = {
+        username: 'test',
+        avatar: '@../tsconfig.json',
+      };
+      return verifyFileUploadRequest(`${basePath}/PostTest/MixedFormDataWithFile`, formData, (_err, res) => {
+        const file = res.body.avatar;
+        const packageJsonBuffer = readFileSync(resolve(__dirname, `../${file.originalname}`));
+        const returnedBuffer = Buffer.from(file.buffer);
+        expect(res.body.username).to.equal(formData.username);
+        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,