feat: add support for maxFields on multipart body

Closes #19 Fixes #18
adonisjs · May 24, 2019 · 39e544d · 39e544d
1 parent abcd2bb
commit 39e544d
Show file tree

Hide file tree

Showing 7 changed files with 62 additions and 19 deletions.
diff --git a/config/index.ts b/config/index.ts
@@ -154,6 +154,17 @@ export const config: BodyParserConfig = {
  */
  encoding: 'utf-8',
 
+ /*
+ |--------------------------------------------------------------------------
+ | Max Fields
+ |--------------------------------------------------------------------------
+ |
+ | The maximum number of fields allowed in the request body. The field includes
+ | text inputs and files both.
+ |
+ */
+ maxFields: 1000,
+
  /*
  |--------------------------------------------------------------------------
  | Request body limit

diff --git a/japaFile.js b/japaFile.js
@@ -2,5 +2,5 @@ require('ts-node/register')
 
 const { configure } = require('japa')
 configure({
- files: ['test/**/body-parser.spec.ts']
+ files: ['test/**/*.spec.ts']
 })
diff --git a/src/BodyParser/index.ts b/src/BodyParser/index.ts
@@ -99,7 +99,9 @@ export class BodyParserMiddleware {
  const multipartConfig = this._getConfigFor('multipart')
 
  if (this._isType(request, multipartConfig.types)) {
- request['multipart'] = new Multipart(request.request)
+ request['multipart'] = new Multipart(request.request, {
+ maxFields: multipartConfig.maxFields,
+ })
 
  /**
  * Skip parsing when `autoProcess` is disabled or route matches one

diff --git a/src/Contracts/index.ts b/src/Contracts/index.ts
@@ -94,6 +94,7 @@ declare module '@ioc:Adonis/Src/BodyParser' {
  */
  type BodyParserMultipartConfig = BodyParserBaseConfig & {
  autoProcess: boolean,
+ maxFields: number,
  processManually: string[],
  tmpFileName (): string,
  }

diff --git a/src/Multipart/index.ts b/src/Multipart/index.ts
@@ -74,7 +74,7 @@ export class Multipart implements MultipartContract {
  */
  public consumed = false
 
- constructor (private _request: IncomingMessage) {
+ constructor (private _request: IncomingMessage, private _config: { maxFields: number }) {
  }
 
  /**
@@ -203,13 +203,19 @@ export class Multipart implements MultipartContract {
  return
  }
 
- const form = new multiparty.Form()
+ const form = new multiparty.Form(this._config)
 
  /**
  * Raise error when form encounters an
  * error
  */
- form.on('error', reject)
+ form.on('error', (error: Error) => {
+ if (error.message === 'maxFields 1 exceeded.') {
+ reject(new Exception('Max fields limit exceeded', 413, 'E_REQUEST_ENTITY_TOO_LARGE'))
+ } else {
+ reject(error)
+ }
+ })
 
  /**
  * Process each part at a time and also resolve the

diff --git a/test/file.spec.ts b/test/file.spec.ts
@@ -22,7 +22,7 @@ test.group('File', () => {
  const server = createServer(async (req, res) => {
  let file: File | null = null
 
- const multipart = new Multipart(req)
+ const multipart = new Multipart(req, { maxFields: 1000 })
  multipart.onFile('package', async (p) => {
  file = new File({
  fileName: p.filename,
@@ -67,7 +67,7 @@ test.group('File', () => {
  const server = createServer(async (req, res) => {
  let file: File | null = null
 
- const multipart = new Multipart(req)
+ const multipart = new Multipart(req, { maxFields: 1000 })
  multipart.onFile('package', async (p) => {
  file = new File({
  fileName: p.filename,
@@ -94,7 +94,7 @@ test.group('File', () => {
  const server = createServer(async (req, res) => {
  let file: File | null = null
 
- const multipart = new Multipart(req)
+ const multipart = new Multipart(req, { maxFields: 1000 })
  multipart.onFile('package', async (p) => {
  file = new File({
  fileName: p.filename,
@@ -138,7 +138,7 @@ test.group('File', () => {
  const server = createServer(async (req, res) => {
  let file: File | null = null
 
- const multipart = new Multipart(req)
+ const multipart = new Multipart(req, { maxFields: 1000 })
  multipart.onFile('package', async (p) => {
  file = new File({
  fileName: p.filename,

diff --git a/test/multipart.spec.ts b/test/multipart.spec.ts
@@ -29,7 +29,7 @@ test.group('Multipart', () => {
  let part: null | MultipartStream = null
 
  const server = createServer(async (req, res) => {
- const multipart = new Multipart(req)
+ const multipart = new Multipart(req, { maxFields: 1000 })
  multipart.onFile('package', async (p) => {
  part = p
  part.resume()
@@ -49,7 +49,7 @@ test.group('Multipart', () => {
  let part: null | MultipartStream = null
 
  const server = createServer(async (req, res) => {
- const multipart = new Multipart(req)
+ const multipart = new Multipart(req, { maxFields: 1000 })
  multipart.onFile('package', async () => {
  throw new Error('Cannot process')
  })
@@ -73,7 +73,7 @@ test.group('Multipart', () => {
  const stack: string[] = []
 
  const server = createServer(async (req, res) => {
- const multipart = new Multipart(req)
+ const multipart = new Multipart(req, { maxFields: 1000 })
  multipart.onFile('package', async (part) => {
  stack.push('before')
  part.resume()
@@ -94,7 +94,7 @@ test.group('Multipart', () => {
  const SAMPLE_FILE_PATH = join(__dirname, './sample.json')
 
  const server = createServer(async (req, res) => {
- const multipart = new Multipart(req)
+ const multipart = new Multipart(req, { maxFields: 1000 })
 
  multipart.onFile('package', async (part) => {
  part.pipe(createWriteStream(SAMPLE_FILE_PATH))
@@ -115,7 +115,7 @@ test.group('Multipart', () => {
  const stack: string[] = []
 
  const server = createServer(async (req, res) => {
- const multipart = new Multipart(req)
+ const multipart = new Multipart(req, { maxFields: 1000 })
  multipart.onFile('package', async (part) => {
  stack.push('before')
  part.resume()
@@ -136,7 +136,7 @@ test.group('Multipart', () => {
  const stack: string[] = []
 
  const server = createServer(async (req, res) => {
- const multipart = new Multipart(req)
+ const multipart = new Multipart(req, { maxFields: 1000 })
  multipart.onFile('package', async (part) => {
  stack.push('before')
  part.resume()
@@ -157,7 +157,7 @@ test.group('Multipart', () => {
  const stack: string[] = []
 
  const server = createServer(async (req, res) => {
- const multipart = new Multipart(req)
+ const multipart = new Multipart(req, { maxFields: 1000 })
  multipart.onFile('*', async (part) => {
  stack.push('before')
  part.resume()
@@ -179,7 +179,7 @@ test.group('Multipart', () => {
  assert.plan(3)
 
  const server = createServer(async (req, res) => {
- const multipart = new Multipart(req)
+ const multipart = new Multipart(req, { maxFields: 1000 })
  multipart.onFile('*', async (part) => {
  stack.push('file')
  part.resume()
@@ -206,7 +206,7 @@ test.group('Multipart', () => {
 
  test('pass errors from field handler to upstream', async (assert) => {
  const server = createServer(async (req, res) => {
- const multipart = new Multipart(req)
+ const multipart = new Multipart(req, { maxFields: 1000 })
  multipart.onField('name', () => {
  throw new Error('bad name')
  })
@@ -230,7 +230,7 @@ test.group('Multipart', () => {
 
  test('raise error when process is invoked multipart times', async (assert) => {
  const server = createServer(async (req, res) => {
- const multipart = new Multipart(req)
+ const multipart = new Multipart(req, { maxFields: 1000 })
  try {
  await multipart.process()
  await multipart.process()
@@ -247,4 +247,27 @@ test.group('Multipart', () => {
 
  assert.equal(text, 'E_RUNTIME_EXCEPTION: multipart stream has already been consumed')
  })
+
+ test('raise error when maxFields are crossed', async (assert) => {
+ const server = createServer(async (req, res) => {
+ const multipart = new Multipart(req, { maxFields: 1 })
+ multipart.onField('*', async () => {
+ })
+
+ try {
+ await multipart.process()
+ res.end()
+ } catch (error) {
+ res.writeHead(500)
+ res.end(error.message)
+ }
+ })
+
+ const { text } = await supertest(server)
+ .post('/')
+ .field('name', 'virk')
+ .field('age', '22')
+
+ assert.equal(text, 'E_REQUEST_ENTITY_TOO_LARGE: Max fields limit exceeded')
+ })
 })