Skip to content

Commit

Permalink
Support for saveRequestFiles with attachFieldsToBody set true (#409)
Browse files Browse the repository at this point in the history
* wip: failing test added

* fix: save request files from body added

* chore: test assertions extended

* feat: saveRequestFiles error on null buff added

* chore: fixed linting

* chore: fixed linting

* chore: async removed from filesFromFields generator
  • Loading branch information
Ceres6 authored Jan 13, 2023
1 parent c716093 commit 4c0079c
Show file tree
Hide file tree
Showing 2 changed files with 177 additions and 4 deletions.
38 changes: 34 additions & 4 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const util = require('util')
const createError = require('@fastify/error')
const sendToWormhole = require('stream-wormhole')
const deepmergeAll = require('@fastify/deepmerge')({ all: true })
const { PassThrough, pipeline } = require('stream')
const { PassThrough, pipeline, Readable } = require('stream')
const pump = util.promisify(pipeline)
const secureJSON = require('secure-json-parse')

Expand All @@ -27,6 +27,7 @@ const RequestFileTooLargeError = createError('FST_REQ_FILE_TOO_LARGE', 'request
const PrototypeViolationError = createError('FST_PROTO_VIOLATION', 'prototype property is not allowed as field name', 400)
const InvalidMultipartContentTypeError = createError('FST_INVALID_MULTIPART_CONTENT_TYPE', 'the request is not multipart', 406)
const InvalidJSONFieldError = createError('FST_INVALID_JSON_FIELD_ERROR', 'a request field is not a valid JSON as declared by its Content-Type', 406)
const FileBufferNotFoundError = createError('FST_FILE_BUFFER_NOT_FOUND', 'the file buffer was not found', 500)

function setMultipart (req, payload, done) {
// nothing to do, it will be done by the Request.multipart object
Expand Down Expand Up @@ -109,6 +110,7 @@ function busboy (options) {
}

function fastifyMultipart (fastify, options, done) {
const attachFieldsToBody = options.attachFieldsToBody
if (options.addToBody === true) {
if (typeof options.sharedSchemaId === 'string') {
fastify.addSchema({
Expand Down Expand Up @@ -187,7 +189,8 @@ function fastifyMultipart (fastify, options, done) {
FieldsLimitError,
PrototypeViolationError,
InvalidMultipartContentTypeError,
RequestFileTooLargeError
RequestFileTooLargeError,
FileBufferNotFoundError
})

fastify.addContentTypeParser('multipart/form-data', setMultipart)
Expand Down Expand Up @@ -507,10 +510,14 @@ function fastifyMultipart (fastify, options, done) {
}

async function saveRequestFiles (options) {
let files
if (attachFieldsToBody === true) {
files = filesFromFields.call(this, this.body)
} else {
files = await this.files(options)
}
const requestFiles = []
const tmpdir = (options && options.tmpdir) || os.tmpdir()

const files = await this.files(options)
this.tmpUploads = []
for await (const file of files) {
const filepath = path.join(tmpdir, toID() + path.extname(file.filename))
Expand All @@ -528,6 +535,29 @@ function fastifyMultipart (fastify, options, done) {
return requestFiles
}

function * filesFromFields (container) {
try {
for (const field of Object.values(container)) {
if (Array.isArray(field)) {
for (const subField of filesFromFields.call(this, field)) {
yield subField
}
}
if (!field.file) {
continue
}
if (!field._buf) {
throw new FileBufferNotFoundError()
}
field.file = Readable.from(field._buf)
yield field
}
} catch (err) {
this.log.error({ err }, 'save request file failed')
throw err
}
}

async function cleanRequestFiles () {
if (!this.tmpUploads) {
return
Expand Down
143 changes: 143 additions & 0 deletions test/fix-313.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
'use strict'

const test = require('tap').test
const FormData = require('form-data')
const Fastify = require('fastify')
const multipart = require('..')
const http = require('http')
const path = require('path')
const fs = require('fs')
const { access } = require('fs').promises
const EventEmitter = require('events')
const { once } = EventEmitter

const filePath = path.join(__dirname, '../README.md')

test('should store file on disk, remove on response when attach fields to body is true', async function (t) {
t.plan(22)

const fastify = Fastify()
t.teardown(fastify.close.bind(fastify))

fastify.register(multipart, {
attachFieldsToBody: true
})

fastify.post('/', async function (req, reply) {
t.ok(req.isMultipart())

const files = await req.saveRequestFiles()

t.ok(files[0].filepath)
t.equal(files[0].fieldname, 'upload')
t.equal(files[0].filename, 'README.md')
t.equal(files[0].encoding, '7bit')
t.equal(files[0].mimetype, 'text/markdown')
t.ok(files[0].fields.upload)
t.ok(files[1].filepath)
t.equal(files[1].fieldname, 'upload')
t.equal(files[1].filename, 'README.md')
t.equal(files[1].encoding, '7bit')
t.equal(files[1].mimetype, 'text/markdown')
t.ok(files[1].fields.upload)
t.ok(files[2].filepath)
t.equal(files[2].fieldname, 'other')
t.equal(files[2].filename, 'README.md')
t.equal(files[2].encoding, '7bit')
t.equal(files[2].mimetype, 'text/markdown')
t.ok(files[2].fields.upload)

await access(files[0].filepath, fs.constants.F_OK)
await access(files[1].filepath, fs.constants.F_OK)
await access(files[2].filepath, fs.constants.F_OK)

reply.code(200).send()
})
const ee = new EventEmitter()

// ensure that file is removed after response
fastify.addHook('onResponse', async (request, reply) => {
try {
await access(request.tmpUploads[0], fs.constants.F_OK)
} catch (error) {
t.equal(error.code, 'ENOENT')
t.pass('Temp file was removed after response')
ee.emit('response')
}
})

await fastify.listen({ port: 0 })
// request
const form = new FormData()
const opts = {
protocol: 'http:',
hostname: 'localhost',
port: fastify.server.address().port,
path: '/',
headers: form.getHeaders(),
method: 'POST'
}

const req = http.request(opts)
form.append('upload', fs.createReadStream(filePath))
form.append('upload', fs.createReadStream(filePath))
form.append('other', fs.createReadStream(filePath))

form.pipe(req)

const [res] = await once(req, 'response')
t.equal(res.statusCode, 200)
res.resume()
await once(res, 'end')
await once(ee, 'response')
})

test('should throw on saving request files when attach fields to body is true but buffer is not stored', async function (t) {
t.plan(3)

const fastify = Fastify()
t.teardown(fastify.close.bind(fastify))

fastify.register(multipart, {
attachFieldsToBody: true,
onFile: async (part) => {
for await (const chunk of part.file) {
chunk.toString()
}
}
})

fastify.post('/', async function (req, reply) {
t.ok(req.isMultipart())

try {
await req.saveRequestFiles()
reply.code(200).send()
} catch (error) {
t.ok(error instanceof fastify.multipartErrors.FileBufferNotFoundError)
reply.code(500).send()
}
})

await fastify.listen({ port: 0 })
// request
const form = new FormData()
const opts = {
protocol: 'http:',
hostname: 'localhost',
port: fastify.server.address().port,
path: '/',
headers: form.getHeaders(),
method: 'POST'
}

const req = http.request(opts)
form.append('upload', fs.createReadStream(filePath))

form.pipe(req)

const [res] = await once(req, 'response')
t.equal(res.statusCode, 500)
res.resume()
await once(res, 'end')
})

0 comments on commit 4c0079c

Please sign in to comment.