huangang/fastify-file-upload

Fastify plugin for uploading files

fastify-file-upload

Fastify plugin to upload file.

Note: the v3.x series of this module covers Fastify v3. For Fastify v2 support refert to the v2.x series.

Install

npm i fastify-file-upload --save

Usage

'use strict'

const fastify = require('fastify')()
const fileUpload = require('fastify-file-upload')

fastify.register(fileUpload)

fastify.post('/upload', function (req, reply) {
  // some code to handle file
  const files = req.raw.files
  console.log(files)
  let fileArr = []
  for(let key in files){
    fileArr.push({
      name: files[key].name,
      mimetype: files[key].mimetype
    })
  }
  reply.send(fileArr)
})

fastify.listen(3000, err => {
  if (err) throw err
  console.log(`server listening on ${fastify.server.address().port}`)
})

Use Schema Demo (fastify version >= 2)

fastify.post('/uploadSchema', {
  schema: {
    summary: 'upload file',
    body: {
      type: 'object',
      properties: {
        file: { type: 'object' }
      },
      required: ['file']
    }
  },
  handler: (request, reply) => {
    const file = request.body.file
    console.log(file)
    reply.send({ file })
  }
})

Using Busboy Options

fastify.register(fileUpload, {
  limits: { fileSize: 50 * 1024 * 1024 },
});

Available Options

fastify-file-upload's Issues

4.0.0有BUG body中的字段和raw.files中的字段相同时, body中的字段会被覆盖造成数据丢失

#6 (comment)

Missing data in body (ignored other values to files)

We're sending data as in example bellow, due to this line:

     if (request.raw.files) {
        for (const key in request.raw.files) {
          request.body[key] = request.raw.files[key]
        }
      }

They got ignored and therefore not added into body, so I hope this helps somebody, @huangang maybe consider adding following 🙂

import fp from 'fastify-plugin'
import fileUpload from 'express-fileupload'

const setMultipart = (request, done): void => {
  request[Symbol('multipart')] = true
  done()
}

const fastifyUpload = (fastify, options, done) => {
  fastify.addContentTypeParser('multipart', setMultipart)

  options = options || {}
  fastify.use(fileUpload(options))

  fastify.addHook('preValidation', (request, reply, done) => {
    if (request.raw) {
      !request.body && (request.body = request.raw.body || {})
      if (request.raw.files) {
        request.body = { ...request.raw.body, ...request.raw.files }
      }
    }
    done()
  })
  done()
}

export default fp(fastifyUpload, {
  fastify: '>= 2.0.0',
  name: 'fastify-file-upload'
})

Example request

PUT http://localhost:3000/registration/938cecf7-fa10-4580-a4bd-978ca34f3b67
Content-Type: multipart/form-data; boundary=WebAppBoundary
x-token: vDkhBTJCwsdov0t55bzu4UHIN9AXZgYJGz3Fq326Rske8ZCm

--WebAppBoundary
Content-Disposition: form-data; name="files"; filename="logo.png"
Content-Type: image/png

< ./input.pdf

--WebAppBoundary
Content-Disposition: form-data; name="files"; filename="logo.png"
Content-Type: image/png

< ./input.png

--WebAppBoundary
Content-Disposition: form-data; name="data"

{}
--WebAppBoundary--

fastify-file-upload - expected '>=3.0.0' fastify version

HI,

ifError got unwanted exception: fastify-plugin: fastify-file-upload - expected '>=3.0.0' fastify version, '2.15.0' is installed

"fastify": "^3.2.0",
"fastify-autoload": "^3.0.7",
"fastify-file-upload": "^3.0.0"

在 Content-Length 和文件不一致时会引起程序崩溃 Cannot read property 'originalUrl' of null

复现 demo https://github.com/zhongshan1993/fastify-file-error-demo

在 触发 busboy 的 error 事件后，又触发了 finish 事件，导致 middie 中的 done 方法再次被调用，此时 req 的值为 null。

这种场景下，live 环境易收到外部攻击

How to use schemas with file "fastify-file-upload"?

I've fasted with a question about route's schema with uploading file. What type of JsonSchema should I use for this? For example:
headers: { type: 'object', properties: { 'x-user-id': { type: 'string' }, }, required: ['x-user-id'] }, body: { type: 'object', properties: { ??? } }, description: 'Uploading file', tags: ['Files'], response: { ... }

BUG

"fastify": "^3.27.4",
"fastify-file-upload": "^3.0.1"
进程阻断 无法正常启动

Property 'files' does not exist on type 'IncomingMessage'.ts(2339)

Unable to receive file data

I'm unable to loop through the files at the fastify end.

I've created a simple form with the help of bulma:

<form id="form-upload" action="/upload/submit" method="post">
  <div id="file-js-example" class="file has-name">
    <label class="file-label">
      <input class="file-input" type="file" name="files" id="files">
      <span class="file-cta">
        <span class="file-icon">
          <i class="fas fa-upload"></i>
        </span>
        <span class="file-label">
          Choose a file…
        </span>
      </span>
      <span class="file-name">
        No file uploaded
      </span>
    </label>
  </div>
</form>

Here is the fastify code:

www.fastify.post('/upload/submit', function (req, reply) {
  console.log(req.raw.files); // This returns null
});

I presume that I've done something wrong in creating the HTML form?
Thank you.

Upload file before jwt verify

Although jwt expired, still upload files to server? How do I solve this problem?

How to specify witch path I want to upload the file?

Can i specify the path where I uploading the file? And how to download a file?

how to know if upload progress is fail, broken or corrupted?

How to know if the upload progress fail, broken or corrupted?

Also how to add more action right after upload is completed?

request files - array or array array

Hello, i have a problem
If i send one file, i got Array

[
  {
    name: 'zzzzzzz.jpg',
   ............
  }
]

If i send several files i got Array Array

[
  [
    {
      name: 'zzzzzzz.jpg',
...............................
    },
    {
      name: 'zzzzzzz2.jpg',
.......................
    }
  ]
]

It's problem i think, uncomfortably

TypeScript support

Hi there,

just wonder if there any plans to support typescript or not?

Clean exit

how i use this, i follow the docs but fastify wont connect

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet.
We recommend using:

• CircleCI
• Travis CI
• Buildkite
• CodeShip
• Azure Pipelines
• TeamCity
• Buddy
• AppVeyor
  But Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.