fastify 4.0.0-alpha.2 → 4.0.0-alpha.3

package/docs/Guides/Ecosystem.md

@@ -8,6 +8,9 @@ section.
 
 #### [Core](#core)
 
+- [`aws-lambda-fastify`](https://github.com/fastify/aws-lambda-fastify) allows you to
+  easily build serverless web applications/services and RESTful APIs using Fastify
+  on top of AWS Lambda and Amazon API Gateway.
 - [`fastify-accepts`](https://github.com/fastify/fastify-accepts) to have
   [accepts](https://www.npmjs.com/package/accepts) in your request object.
 - [`fastify-accepts-serializer`](https://github.com/fastify/fastify-accepts-serializer)
@@ -295,6 +298,8 @@ section.
   An error handling plugin for Fastify that uses enhanced HTTP errors.
 - [`fastify-https-redirect`](https://github.com/tomsvogel/fastify-https-redirect)
   Fastify plugin for auto-redirect from HTTP to HTTPS.
+- [`fatify-impressions`](https://github.com/manju4ever/fastify-impressions) Fastify
+  plugin to track impressions of all the routes.
 - [`fastify-influxdb`](https://github.com/alex-ppg/fastify-influxdb) Fastify
   InfluxDB plugin connecting to an InfluxDB instance via the Influx default
   package.
@@ -334,6 +339,8 @@ section.
 - [`fastify-mongoose-driver`](https://github.com/alex-ppg/fastify-mongoose)
   Fastify Mongoose plugin that connects to a MongoDB via the Mongoose plugin
   with support for Models.
+- [`fastify-mqtt`](https://github.com/love-lena/fastify-mqtt) Plugin to share
+  [mqtt](https://www.npmjs.com/package/mqtt) client across Fastify.
 - [`fastify-msgpack`](https://github.com/kenriortega/fastify-msgpack) Fastify
   and MessagePack, together at last. Uses @msgpack/msgpack by default.
 - [`fastify-multer`](https://github.com/fox1t/fastify-multer) Multer is a plugin
@@ -484,6 +491,8 @@ section.
   waterline. Decorates Fastify with waterline models.
 - [`fastify-webpack-hmr`](https://github.com/lependu/fastify-webpack-hmr)
   Webpack hot module reloading plugin for Fastify.
+- [`fastify-webpack-hot`](https://github.com/gajus/fastify-webpack-hot)
+  Webpack Hot Module Replacement for Fastify.
 - [`fastify-ws`](https://github.com/gj/fastify-ws) WebSocket integration for
   Fastify — with support for WebSocket lifecycle hooks instead of a single
   handler function. Built upon [ws](https://github.com/websockets/ws) and

package/docs/Reference/Reply.md

@@ -13,6 +13,9 @@
   - [.getHeaders()](#getheaders)
   - [.removeHeader(key)](#removeheaderkey)
   - [.hasHeader(key)](#hasheaderkey)
+  - [.trailer(key, function)](#trailerkey-function)
+  - [.hasTrailer(key)](#hastrailerkey)
+  - [.removeTrailer(key)](#removetrailerkey)
   - [.redirect([code,] dest)](#redirectcode--dest)
   - [.callNotFound()](#callnotfound)
   - [.getResponseTime()](#getresponsetime)
@@ -47,6 +50,9 @@ object that exposes the following functions and properties:
 - `.getHeaders()` - Gets a shallow copy of all current response headers.
 - `.removeHeader(key)` - Remove the value of a previously set header.
 - `.hasHeader(name)` - Determine if a header has been set.
+- `.trailer(key, function)` - Sets a response trailer.
+- `.hasTrailer(key)` - Determine if a trailer has been set.
+- `.removeTrailer(key)` - Remove the value of a previously set trailer.
 - `.type(value)` - Sets the header `Content-Type`.
 - `.redirect([code,] dest)` - Redirect to the specified url, the status code is
   optional (default to `302`).
@@ -199,6 +205,49 @@ reply.getHeader('x-foo') // undefined
 
 Returns a boolean indicating if the specified header has been set.
 
+### .trailer(key, function)
+<a id="trailer"></a>
+
+Sets a response trailer. Trailer usually used when you want some header that require heavy resources to be sent after the `data`, for example `Server-Timing`, `Etag`. It can ensure the client get the response data as soon as possible.
+
+*Note: The header `Transfer-Encoding: chunked` will be added once you use the trailer. It is a hard requipment for using trailer in Node.js.*
+
+*Note: Currently, the computation function only supports synchronous function. That means `async-await` and `promise` are not supported.*
+
+```js
+reply.trailer('server-timing', function() {
+  return 'db;dur=53, app;dur=47.2'
+})
+
+const { createHash } = require('crypto')
+// trailer function also recieve two argument
+// @param {object} reply fastify reply
+// @param {string|Buffer|null} payload payload that already sent, note that it will be null when stream is sent
+reply.trailer('content-md5', function(reply, payload) {
+  const hash = createHash('md5')
+  hash.update(payload)
+  return hash.disgest('hex')
+})
+```
+
+### .hasTrailer(key)
+<a id="hasTrailer"></a>
+
+Returns a boolean indicating if the specified trailer has been set.
+
+### .removeTrailer(key)
+<a id="removeTrailer"></a>
+
+Remove the value of a previously set trailer.
+```js
+reply.trailer('server-timing', function() {
+  return 'db;dur=53, app;dur=47.2'
+})
+reply.removeTrailer('server-timing')
+reply.getTrailer('server-timing') // undefined
+```
+
+
 ### .redirect([code ,] dest)
 <a id="redirect"></a>
 
@@ -261,6 +310,7 @@ Sets the content type for the response. This is a shortcut for
 ```js
 reply.type('text/html')
 ```
+If the `Content-Type` has a JSON subtype, and the charset parameter is not set, `utf-8` will be used as the charset by default.
 
 ### .serializer(func)
 <a id="serializer"></a>

package/docs/Reference/Server.md

@@ -821,7 +821,7 @@ fastify.ready().then(() => {
 #### listen
 <a id="listen"></a>
 
-Starts the server and internally waits for the the `.ready()` event. The
+Starts the server and internally waits for the `.ready()` event. The
 signature is `.listen([options][, callback])`. Both the `options` object and the
 `callback` parameters follow the [Node.js
 core][https://nodejs.org/api/net.html#serverlistenoptions-callback] parameter

package/examples/parser.js

@@ -2,7 +2,7 @@
 
 const fastify = require('../fastify')({ logger: true })
 const jsonParser = require('fast-json-body')
-const qs = require('qs')
+const querystring = require('querystring')
 
 // Handled by fastify
 // curl -X POST -d '{"hello":"world"}' -H'Content-type: application/json' http://localhost:3000/
@@ -22,7 +22,7 @@ fastify.addContentTypeParser('application/x-www-form-urlencoded', function (requ
   })
   payload.on('end', function () {
     try {
-      const parsed = qs.parse(body)
+      const parsed = querystring.parse(body)
       done(null, parsed)
     } catch (e) {
       done(e)
@@ -31,6 +31,16 @@ fastify.addContentTypeParser('application/x-www-form-urlencoded', function (requ
   payload.on('error', done)
 })
 
+// curl -X POST -d '{"hello":"world"}' -H'Content-type: application/vnd.custom+json' http://localhost:3000/
+fastify.addContentTypeParser(/^application\/.+\+json$/, { parseAs: 'string' }, fastify.getDefaultJsonParser('error', 'ignore'))
+
+// remove default json parser
+// curl -X POST -d '{"hello":"world"}' -H'Content-type: application/json' http://localhost:3000/ is now no longer handled by fastify
+fastify.removeContentTypeParser('application/json')
+
+// This call would remove any content type parser
+// fastify.removeAllContentTypeParsers()
+
 fastify
   .post('/', function (req, reply) {
     reply.send(req.body)

package/fastify.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const VERSION = '4.0.0-alpha.2'
+const VERSION = '4.0.0-alpha.3'
 
 const Avvio = require('avvio')
 const http = require('http')

package/lib/errors.js

@@ -152,6 +152,14 @@ const codes = {
     'FST_ERR_BAD_STATUS_CODE',
     'Called reply with an invalid status code: %s'
   ),
+  FST_ERR_BAD_TRAILER_NAME: createError(
+    'FST_ERR_BAD_TRAILER_NAME',
+    'Called reply.trailer with an invalid header name: %s'
+  ),
+  FST_ERR_BAD_TRAILER_VALUE: createError(
+    'FST_ERR_BAD_TRAILER_VALUE',
+    "Called reply.trailer('%s', fn) with an invalid type: %s. Expected a function."
+  ),
 
   /**
    * schemas

package/lib/reply.js

@@ -12,6 +12,7 @@ const {
   kReplySerializerDefault,
   kReplyIsError,
   kReplyHeaders,
+  kReplyTrailers,
   kReplyHasStatusCode,
   kReplyIsRunningOnErrorHook,
   kReplyNextErrorHandler,
@@ -35,7 +36,9 @@ const {
   FST_ERR_REP_ALREADY_SENT,
   FST_ERR_REP_SENT_VALUE,
   FST_ERR_SEND_INSIDE_ONERR,
-  FST_ERR_BAD_STATUS_CODE
+  FST_ERR_BAD_STATUS_CODE,
+  FST_ERR_BAD_TRAILER_NAME,
+  FST_ERR_BAD_TRAILER_VALUE
 } = require('./errors')
 const warning = require('./warnings')
 
@@ -47,6 +50,7 @@ function Reply (res, request, log) {
   this[kReplyIsRunningOnErrorHook] = false
   this.request = request
   this[kReplyHeaders] = {}
+  this[kReplyTrailers] = null
   this[kReplyHasStatusCode] = false
   this[kReplyStartTime] = undefined
   this.log = log
@@ -158,22 +162,14 @@ Reply.prototype.send = function (payload) {
     if (hasContentType === false) {
       this[kReplyHeaders]['content-type'] = CONTENT_TYPE.JSON
     } else {
-      // If hasContentType === true, we have a JSON mimetype
+      // If user doesn't set charset, we will set charset to utf-8
       if (contentType.indexOf('charset') === -1) {
-        // If we have simply application/json instead of a custom json mimetype
-        if (contentType.indexOf('/json') > -1) {
-          this[kReplyHeaders]['content-type'] = CONTENT_TYPE.JSON
+        const customContentType = contentType.trim()
+        if (customContentType.endsWith(';')) {
+          // custom content-type is ended with ';'
+          this[kReplyHeaders]['content-type'] = `${customContentType} charset=utf-8`
         } else {
-          const currContentType = this[kReplyHeaders]['content-type']
-          // We extract the custom mimetype part (e.g. 'hal+' from 'application/hal+json')
-          const customJsonType = currContentType.substring(
-            currContentType.indexOf('/'),
-            currContentType.indexOf('json') + 4
-          )
-
-          // We ensure we set the header to the proper JSON content-type if necessary
-          // (e.g. 'application/hal+json' instead of 'application/json')
-          this[kReplyHeaders]['content-type'] = CONTENT_TYPE.JSON.replace('/json', customJsonType)
+          this[kReplyHeaders]['content-type'] = `${customContentType}; charset=utf-8`
         }
       }
     }
@@ -252,6 +248,47 @@ Reply.prototype.headers = function (headers) {
   return this
 }
 
+// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Trailer#directives
+// https://httpwg.org/specs/rfc7230.html#chunked.trailer.part
+const INVALID_TRAILERS = new Set([
+  'transfer-encoding',
+  'content-length',
+  'host',
+  'cache-control',
+  'max-forwards',
+  'te',
+  'authorization',
+  'set-cookie',
+  'content-encoding',
+  'content-type',
+  'content-range',
+  'trailer'
+])
+
+Reply.prototype.trailer = function (key, fn) {
+  key = key.toLowerCase()
+  if (INVALID_TRAILERS.has(key)) {
+    throw new FST_ERR_BAD_TRAILER_NAME(key)
+  }
+  if (typeof fn !== 'function') {
+    throw new FST_ERR_BAD_TRAILER_VALUE(key, typeof fn)
+  }
+  if (this[kReplyTrailers] === null) this[kReplyTrailers] = {}
+  this[kReplyTrailers][key] = fn
+  return this
+}
+
+Reply.prototype.hasTrailer = function (key) {
+  if (this[kReplyTrailers] === null) return false
+  return this[kReplyTrailers][key.toLowerCase()] !== undefined
+}
+
+Reply.prototype.removeTrailer = function (key) {
+  if (this[kReplyTrailers] === null) return this
+  this[kReplyTrailers][key.toLowerCase()] = undefined
+  return this
+}
+
 Reply.prototype.code = function (code) {
   const intValue = parseInt(code)
   if (isNaN(intValue) || intValue < 100 || intValue > 600) {
@@ -404,6 +441,20 @@ function onSendEnd (reply, payload) {
   const req = reply.request
   const statusCode = res.statusCode
 
+  // we check if we need to update the trailers header and set it
+  if (reply[kReplyTrailers] !== null) {
+    const trailerHeaders = Object.keys(reply[kReplyTrailers])
+    let header = ''
+    for (const trailerName of trailerHeaders) {
+      if (typeof reply[kReplyTrailers][trailerName] !== 'function') continue
+      header += ' '
+      header += trailerName
+    }
+    // it must be chunked for trailer to work
+    reply.header('Transfer-Encoding', 'chunked')
+    reply.header('Trailer', header.trim())
+  }
+
   if (payload === undefined || payload === null) {
     // according to https://tools.ietf.org/html/rfc7230#section-3.3.2
     // we cannot send a content-length for 304 and 204, and all status code
@@ -414,6 +465,7 @@ function onSendEnd (reply, payload) {
     }
 
     res.writeHead(statusCode, reply[kReplyHeaders])
+    sendTrailer(payload, res, reply)
     // avoid ArgumentsAdaptorTrampoline from V8
     res.end(null, null, null)
     return
@@ -435,9 +487,12 @@ function onSendEnd (reply, payload) {
   }
 
   res.writeHead(statusCode, reply[kReplyHeaders])
-
+  // write payload first
+  res.write(payload)
+  // then send trailers
+  sendTrailer(payload, res, reply)
   // avoid ArgumentsAdaptorTrampoline from V8
-  res.end(payload, null, null)
+  res.end(null, null, null)
 }
 
 function logStreamError (logger, err, res) {
@@ -454,6 +509,9 @@ function sendStream (payload, res, reply) {
   let sourceOpen = true
   let errorLogged = false
 
+  // set trailer when stream ended
+  sendStreamTrailer(payload, res, reply)
+
   eos(payload, { readable: true, writable: false }, function (err) {
     sourceOpen = false
     if (err != null) {
@@ -502,6 +560,22 @@ function sendStream (payload, res, reply) {
   payload.pipe(res)
 }
 
+function sendTrailer (payload, res, reply) {
+  if (reply[kReplyTrailers] === null) return
+  const trailerHeaders = Object.keys(reply[kReplyTrailers])
+  const trailers = {}
+  for (const trailerName of trailerHeaders) {
+    if (typeof reply[kReplyTrailers][trailerName] !== 'function') continue
+    trailers[trailerName] = reply[kReplyTrailers][trailerName](reply, payload)
+  }
+  res.addTrailers(trailers)
+}
+
+function sendStreamTrailer (payload, res, reply) {
+  if (reply[kReplyTrailers] === null) return
+  payload.on('end', () => sendTrailer(null, res, reply))
+}
+
 function onErrorHook (reply, error, cb) {
   if (reply.context.onError !== null && !reply[kReplyNextErrorHandler]) {
     reply[kReplyIsRunningOnErrorHook] = true
@@ -581,6 +655,7 @@ function buildReply (R) {
     this[kReplySerializer] = null
     this.request = request
     this[kReplyHeaders] = {}
+    this[kReplyTrailers] = null
     this[kReplyStartTime] = undefined
     this[kReplyEndTime] = undefined
     this.log = log

package/lib/server.js

@@ -78,6 +78,7 @@ function createServer (options, httpHandler) {
           })
         })
       }
+      return listening
     }
 
     this.ready(listenCallback.call(this, server, listenOptions))

package/lib/symbols.js

@@ -30,6 +30,7 @@ const keys = {
   kReplySerializer: Symbol('fastify.reply.serializer'),
   kReplyIsError: Symbol('fastify.reply.isError'),
   kReplyHeaders: Symbol('fastify.reply.headers'),
+  kReplyTrailers: Symbol('fastify.reply.trailers'),
   kReplyHasStatusCode: Symbol('fastify.reply.hasStatusCode'),
   kReplyHijacked: Symbol('fastify.reply.hijacked'),
   kReplyStartTime: Symbol('fastify.reply.startTime'),

package/lib/validation.js

@@ -27,13 +27,14 @@ function compileSchemasForSerialization (context, compile) {
 }
 
 function compileSchemasForValidation (context, compile) {
-  if (!context.schema) {
+  const { schema } = context
+  if (!schema) {
     return
   }
 
   const { method, url } = context.config || {}
 
-  const headers = context.schema.headers
+  const headers = schema.headers
   if (headers && Object.getPrototypeOf(headers) !== Object.prototype) {
     // do not mess with non-literals, e.g. Joi schemas
     context[headersSchema] = compile({ schema: headers, method, url, httpPart: 'headers' })
@@ -54,16 +55,16 @@ function compileSchemasForValidation (context, compile) {
     context[headersSchema] = compile({ schema: headersSchemaLowerCase, method, url, httpPart: 'headers' })
   }
 
-  if (context.schema.body) {
-    context[bodySchema] = compile({ schema: context.schema.body, method, url, httpPart: 'body' })
+  if (schema.body) {
+    context[bodySchema] = compile({ schema: schema.body, method, url, httpPart: 'body' })
   }
 
-  if (context.schema.querystring) {
-    context[querystringSchema] = compile({ schema: context.schema.querystring, method, url, httpPart: 'querystring' })
+  if (schema.querystring) {
+    context[querystringSchema] = compile({ schema: schema.querystring, method, url, httpPart: 'querystring' })
   }
 
-  if (context.schema.params) {
-    context[paramsSchema] = compile({ schema: context.schema.params, method, url, httpPart: 'params' })
+  if (schema.params) {
+    context[paramsSchema] = compile({ schema: schema.params, method, url, httpPart: 'params' })
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify",
-  "version": "4.0.0-alpha.2",
+  "version": "4.0.0-alpha.3",
   "description": "Fast and low overhead web framework, for Node.js",
   "main": "fastify.js",
   "type": "commonjs",
@@ -161,7 +161,7 @@
     "proxyquire": "^2.1.3",
     "pump": "^3.0.0",
     "self-cert": "^2.0.0",
-    "send": "^0.17.2",
+    "send": "^0.18.0",
     "serve-static": "^1.14.1",
     "simple-get": "^4.0.0",
     "snazzy": "^9.0.0",