fastify 2.7.1 → 2.11.0

package/test/stream.test.js

@@ -140,7 +140,7 @@ test('onSend hook stream', t => {
 })
 
 test('Destroying streams prematurely', t => {
-  t.plan(5)
+  t.plan(6)
 
   let fastify = null
   const logStream = split(JSON.parse)
@@ -190,7 +190,9 @@ test('Destroying streams prematurely', t => {
       response.on('readable', function () {
         response.destroy()
       })
-      response.on('close', function () {
+
+      // Node bug? Node never emits 'close' here.
+      response.on('aborted', function () {
         t.pass('Response closed')
       })
     })
@@ -198,7 +200,7 @@ test('Destroying streams prematurely', t => {
 })
 
 test('Destroying streams prematurely should call close method', t => {
-  t.plan(6)
+  t.plan(7)
 
   let fastify = null
   const logStream = split(JSON.parse)
@@ -249,7 +251,8 @@ test('Destroying streams prematurely should call close method', t => {
       response.on('readable', function () {
         response.destroy()
       })
-      response.on('close', function () {
+      // Node bug? Node never emits 'close' here.
+      response.on('aborted', function () {
         t.pass('Response closed')
       })
     })
@@ -257,7 +260,7 @@ test('Destroying streams prematurely should call close method', t => {
 })
 
 test('Destroying streams prematurely should call abort method', t => {
-  t.plan(6)
+  t.plan(7)
 
   let fastify = null
   const logStream = split(JSON.parse)
@@ -309,7 +312,8 @@ test('Destroying streams prematurely should call abort method', t => {
       response.on('readable', function () {
         response.destroy()
       })
-      response.on('close', function () {
+      // Node bug? Node never emits 'close' here.
+      response.on('aborted', function () {
         t.pass('Response closed')
       })
     })

package/test/throw.test.js

@@ -25,6 +25,52 @@ test('Fastify should throw on multiple assignment to the same route', t => {
   })
 })
 
+test('Fastify should throw for an invalid schema, printing the error route - headers', t => {
+  t.plan(2)
+
+  const badSchema = {
+    type: 'object',
+    properties: {
+      bad: {
+        type: 'bad-type'
+      }
+    }
+  }
+
+  const fastify = Fastify()
+  fastify.get('/', { schema: { headers: badSchema } }, () => {})
+  fastify.get('/not-loaded', { schema: { headers: badSchema } }, () => {})
+
+  fastify.ready(err => {
+    t.is(err.code, 'FST_ERR_SCH_BUILD')
+    t.isLike(err.message, /Failed building the schema for GET: \//)
+  })
+})
+
+test('Fastify should throw for an invalid schema, printing the error route - body', t => {
+  t.plan(2)
+
+  const badSchema = {
+    type: 'object',
+    properties: {
+      bad: {
+        type: 'bad-type'
+      }
+    }
+  }
+
+  const fastify = Fastify()
+  fastify.register((instance, opts, next) => {
+    instance.post('/form', { schema: { body: badSchema } }, () => {})
+    next()
+  }, { prefix: 'hello' })
+
+  fastify.ready(err => {
+    t.is(err.code, 'FST_ERR_SCH_BUILD')
+    t.isLike(err.message, /Failed building the schema for POST: \/hello\/form/)
+  })
+})
+
 test('Should throw on unsupported method', t => {
   t.plan(1)
   const fastify = Fastify()
@@ -131,7 +177,7 @@ test('Should throw on duplicate request decorator', t => {
     t.fail()
   } catch (e) {
     t.is(e.code, 'FST_ERR_DEC_ALREADY_PRESENT')
-    t.is(e.message, `FST_ERR_DEC_ALREADY_PRESENT: The decorator 'foo' has already been added!`)
+    t.is(e.message, "FST_ERR_DEC_ALREADY_PRESENT: The decorator 'foo' has already been added!")
   }
 })
 
@@ -146,7 +192,7 @@ test('Should throw if request decorator dependencies are not met', t => {
     t.fail()
   } catch (e) {
     t.is(e.code, 'FST_ERR_DEC_MISSING_DEPENDENCY')
-    t.is(e.message, `FST_ERR_DEC_MISSING_DEPENDENCY: The decorator is missing dependency 'world'.`)
+    t.is(e.message, "FST_ERR_DEC_MISSING_DEPENDENCY: The decorator is missing dependency 'world'.")
   }
 })
 

package/test/types/index.ts

@@ -64,7 +64,31 @@ const cors = require('cors')
     maxParamLength: 200,
     querystringParser: (str: string) => ({ str: str, strArray: [str] }),
     modifyCoreObjects: true,
-    return503OnClosing: true
+    return503OnClosing: true,
+    genReqId: () => {
+      if (Math.random() > 0.5) {
+        return Math.random().toString()
+      }
+      return Math.random()
+    },
+    requestIdHeader: 'request-id',
+    requestIdLogLabel: 'reqId',
+    serverFactory: (handler, options) => {
+      const server = http.createServer((req, res) => {
+        handler(req, res)
+      })
+      return server
+    }
+  })
+
+  // http2 server factory option
+  const otherHttp2Server = fastify({
+    serverFactory: (handler, options) => {
+      const server = http2.createServer((req, res) => {
+        handler(req, res)
+      })
+      return server
+    }
   })
 
   // custom types
@@ -102,6 +126,25 @@ server.use('/', (req, res, next) => {
   console.log(`${req.method} ${req.url}`)
 })
 
+// Custom middleware with multiple paths
+server.use(['/foo', '/bar'], (req, res, next) => {
+  console.log(`${req.method} ${req.url}`)
+})
+
+// Third party plugin
+// Also check if async functions are allowed to be passed to .register()
+// https://github.com/fastify/fastify/pull/1841
+// All function parameters should be inferrable and should not produce 'any'
+const thirdPartyPlugin: fastify.Plugin<http2.Http2SecureServer, http2.Http2ServerRequest, http2.Http2ServerResponse, {}> = (instance, options, callback) => {}
+const thirdPartyPluginAsync: fastify.Plugin<http2.Http2SecureServer, http2.Http2ServerRequest, http2.Http2ServerResponse, {}> = async (instance, options) => {}
+
+server.register(thirdPartyPlugin)
+server.register(thirdPartyPluginAsync)
+
+// Custom plugin
+server.register((instance, options, callback) => {})
+server.register(async (instance, options) => {})
+
 /**
  * Test various hooks and different signatures
  */
@@ -117,6 +160,18 @@ server.addHook('preHandler', function (req, reply, next) {
   }
 })
 
+server.addHook('preHandler', async function (req, reply) {
+  this.log.debug('`this` is not `any`')
+  if (req.body.error) {
+    throw new Error('testing if middleware errors can be passed')
+  } else {
+    // `stream` can be accessed correctly because `server` is an http2 server.
+    console.log('req stream', req.req.stream)
+    console.log('res stream', reply.res.stream)
+    reply.code(200).send('ok')
+  }
+})
+
 server.addHook('onRequest', function (req, reply, next) {
   this.log.debug('`this` is not `any`')
   console.log(`${req.raw.method} ${req.raw.url}`)
@@ -207,8 +262,13 @@ const opts: fastify.RouteShorthandOptions<http2.Http2SecureServer, http2.Http2Se
   schemaCompiler: (schema: Object) => () => {},
   bodyLimit: 5000,
   logLevel: 'trace',
+  version: '1.0.0',
   config: { }
 }
+const optsWithHandler: fastify.RouteShorthandOptions<http2.Http2SecureServer, http2.Http2ServerRequest, http2.Http2ServerResponse> = {
+  ...opts,
+  handler (req, reply) { reply.send({ hello: 'route' }) }
+}
 
 // Chaining and route definitions
 server
@@ -250,6 +310,7 @@ server
     reply.header('Content-Type', 'application/json').code(200)
     reply.send({ hello: 'world' })
   })
+  .get('/optsWithHandler', optsWithHandler)
   .get('/status', function (req, reply) {
     reply.status(204).send()
   })
@@ -279,17 +340,21 @@ server
       .headers({ 'Content-Type': 'application/json' })
       .send({ hello: 'world' })
   })
+  .post('/optsWithHandler', optsWithHandler)
   .head('/', {}, function (req, reply) {
     reply.send()
   })
+  .head('/optsWithHandler', optsWithHandler)
   .delete('/', opts, function (req, reply) {
     reply.send({ hello: 'world' })
   })
+  .delete('/optsWithHandler', optsWithHandler)
   .patch('/:id', opts, function (req, reply) {
     req.log.info(`incoming id is ${req.params.id}`)
 
     reply.send({ hello: 'world' })
   })
+  .patch('/optsWithHandler', optsWithHandler)
   .route({
     method: ['GET', 'POST', 'PUT'],
     url: '/multi-route',
@@ -317,6 +382,7 @@ server
   .all('/all/with-opts', opts, function (req, reply) {
     reply.send(req.headers)
   })
+  .all('/optsWithHandler', optsWithHandler)
   .route({
     method: 'GET',
     url: '/headers',
@@ -522,6 +588,13 @@ server.setSchemaCompiler(function (schema: object) {
   return () => true
 })
 
+server.setSchemaResolver(function (ref: string) {
+  return {
+    $id: ref,
+    type: 'string'
+  }
+})
+
 server.addSchema({})
 
 server.addContentTypeParser('*', (req, done) => {
@@ -635,3 +708,15 @@ server3.close(() => {})
     done()
   }
 }
+
+type TestReplyDecoration = (this: fastify.FastifyReply<http.ServerResponse>) => void
+
+const server4 = fastify()
+const testReplyDecoration: TestReplyDecoration = function () {
+  console.log('can access request from reply decorator', this.request.id)
+}
+server4.decorateReply('test-request-accessible-from-reply', testReplyDecoration)
+
+server4.get('/', (req, reply) => {
+  reply.removeHeader('x-foo').removeHeader('x-bar').send({})
+})

package/test/validation-error-handling.test.js

@@ -278,7 +278,7 @@ test('should return a defined output message parsing AJV errors', t => {
     url: '/'
   }, (err, res) => {
     t.error(err)
-    t.strictEqual(res.payload, `{"statusCode":400,"error":"Bad Request","message":"body should have required property 'name', body should have required property 'work'"}`)
+    t.strictEqual(res.payload, '{"statusCode":400,"error":"Bad Request","message":"body should have required property \'name\', body should have required property \'work\'"}')
   })
 })
 
@@ -306,7 +306,7 @@ test('should return a defined output message parsing JOI errors', t => {
     url: '/'
   }, (err, res) => {
     t.error(err)
-    t.strictEqual(res.payload, `{"statusCode":400,"error":"Bad Request","message":"child \\"name\\" fails because [\\"name\\" is required]"}`)
+    t.strictEqual(res.payload, '{"statusCode":400,"error":"Bad Request","message":"child \\"name\\" fails because [\\"name\\" is required]"}')
   })
 })
 
@@ -337,6 +337,6 @@ test('should return a defined output message parsing JOI error details', t => {
     url: '/'
   }, (err, res) => {
     t.error(err)
-    t.strictEqual(res.payload, `{"statusCode":400,"error":"Bad Request","message":"body \\"name\\" is required"}`)
+    t.strictEqual(res.payload, '{"statusCode":400,"error":"Bad Request","message":"body \\"name\\" is required"}')
   })
 })

package/test/versioned-routes.test.js

@@ -417,7 +417,7 @@ test('Should register a versioned route with custome versioning strategy', t =>
       }
     },
     deriveVersion: (req, ctx) => {
-      return req.headers['accept']
+      return req.headers.accept
     }
   }
 

package/docs/Middlewares.md

@@ -1,59 +0,0 @@
-<h1 align="center">Fastify</h1>
-
-## Middlewares
-
-Fastify out of the box provides an asynchronous [middleware engine](https://github.com/fastify/middie) compatible with [Express](https://expressjs.com/) and [Restify](http://restify.com/) middlewares.
-
-*If you need a visual feedback to understand when the middlewares are executed take a look to the [lifecycle](https://github.com/fastify/fastify/blob/master/docs/Lifecycle.md) page.*
-
-Fastify middlewares don't support the full syntax `middleware(err, req, res, next)`, because error handling is done inside Fastify.
-Furthermore methods added by Express and Restify to the enhanced versions of `req` and `res` are not supported in Fastify middlewares.
-
-Also, if you are using a middleware that bundles different, smaller middlewares, such as [*helmet*](https://helmetjs.github.io/), we recommend to use the single modules to get better performances.
-
-```js
-fastify.use(require('cors')())
-fastify.use(require('dns-prefetch-control')())
-fastify.use(require('frameguard')())
-fastify.use(require('hide-powered-by')())
-fastify.use(require('hsts')())
-fastify.use(require('ienoopen')())
-fastify.use(require('x-xss-protection')())
-```
-
-or, in the specific case of *helmet*, you can use the [*fastify-helmet*](https://github.com/fastify/fastify-helmet) [plugin](Plugins.md), which is an optimized helmet integration for fastify:
-
-```js
-const fastify = require('fastify')()
-const helmet = require('fastify-helmet')
-
-fastify.register(helmet)
-```
-
-Remember that middlewares can be encapsulated, this means that you can decide where your middlewares should run by using `register` as explained in the [plugins guide](https://github.com/fastify/fastify/blob/master/docs/Plugins-Guide.md).
-
-Fastify middlewares also do not expose the `send` method or other methods specific to the Fastify [Reply]('./Reply.md' "Reply") instance. This is because Fastify wraps the incoming `req` and `res` Node instances using the [Request](./Request.md "Request") and [Reply](./Reply.md "Reply") objects internally, but this is done after the middlewares phase. If you need to create a middleware you have to use the Node `req` and `res` instances. Otherwise, you can use the `preHandler` hook that has the [Request](./Request.md "Request") and [Reply](./Reply.md "Reply") Fastify instances. For more information, see [Hooks](./Hooks.md "Hooks").
-
-<a name="restrict-usage"></a>
-#### Restrict middleware execution to a certain path(s)
-If you need to run a middleware only under certain path(s), just pass the path as first parameter to `use` and you are done!
-
-*Note that this does not support routes with parameters, (eg: `/user/:id/comments`) and wildcard is not supported in multiple paths.*
-
-```js
-const path = require('path')
-const serveStatic = require('serve-static')
-
-// Single path
-fastify.use('/css', serveStatic(path.join(__dirname, '/assets')))
-
-// Wildcard path
-fastify.use('/css/*', serveStatic(path.join(__dirname, '/assets')))
-
-// Multiple paths
-fastify.use(['/css', '/js'], serveStatic(path.join(__dirname, '/assets')))
-```
-
-<a name="express-middleware"></a>
-#### Express middleware compatibility
-Express modifies the prototype of the node core Request and Response objects heavily so Fastify cannot guarantee full middleware compatibility. Express specific functionality such as `res.sendFile()`, `res.send()` or `express.Router()` instances will not work with Fastify. For example, [cors](https://github.com/expressjs/cors) is compatible while [passport](https://github.com/jaredhanson/passport) is not.