Set exposeHeadRoutes: true by default (#2826)

* Set exposeHeadRoutes: true by default

* docs

* remove todo

* Updated test

build/build-validation.js

@@ -25,7 +25,8 @@ const defaultInitOptions = {
   pluginTimeout: 10000,
   requestIdHeader: 'request-id',
   requestIdLogLabel: 'reqId',
-  http2SessionTimeout: 5000
+  http2SessionTimeout: 5000,
+  exposeHeadRoutes: true
 }
 
 function customRule0 (schemaParamValue, validatedParamValue, validationSchemaObject, currentDataPath, validatedParamObject, validatedParam) {
@@ -79,7 +80,8 @@ const schema = {
     pluginTimeout: { type: 'integer', default: defaultInitOptions.pluginTimeout },
     requestIdHeader: { type: 'string', default: defaultInitOptions.requestIdHeader },
     requestIdLogLabel: { type: 'string', default: defaultInitOptions.requestIdLogLabel },
-    http2SessionTimeout: { type: 'integer', default: defaultInitOptions.http2SessionTimeout }
+    http2SessionTimeout: { type: 'integer', default: defaultInitOptions.http2SessionTimeout },
+    exposeHeadRoutes: { type: 'boolean', default: defaultInitOptions.exposeHeadRoutes }
   }
 }
 

docs/Server.md

@@ -333,7 +333,7 @@ const fastify = require('fastify')({
 
 Automatically creates a sibling `HEAD` route for each `GET` route defined. If you want a custom `HEAD` handler without disabling this option, make sure to define it before the `GET` route.
 
-+ Default: `false`
++ Default: `true`
 
 <a name="versioning"></a>
 ### `versioning`

fastify.js

@@ -96,7 +96,6 @@ function fastify (options) {
   const requestIdLogLabel = options.requestIdLogLabel || 'reqId'
   const bodyLimit = options.bodyLimit || defaultInitOptions.bodyLimit
   const disableRequestLogging = options.disableRequestLogging || false
-  const exposeHeadRoutes = options.exposeHeadRoutes != null ? options.exposeHeadRoutes : false
 
   const ajvOptions = Object.assign({
     customOptions: {},
@@ -130,10 +129,12 @@ function fastify (options) {
   options.disableRequestLogging = disableRequestLogging
   options.ajv = ajvOptions
   options.clientErrorHandler = options.clientErrorHandler || defaultClientErrorHandler
-  options.exposeHeadRoutes = exposeHeadRoutes
 
   const initialConfig = getSecuredInitialConfig(options)
 
+  // exposeHeadRoutes have its defult set from the validatorfrom the validatorfrom the validatorfrom the validator
+  options.exposeHeadRoutes = initialConfig.exposeHeadRoutes
+
   // Default router
   const router = buildRouting({
     config: {

test/context-config.test.js

@@ -119,3 +119,55 @@ test('config with exposeHeadRoutes', t => {
     t.deepEquals(JSON.parse(response.payload), { url: '/no-config', method: 'GET' })
   })
 })
+
+test('config without exposeHeadRoutes', t => {
+  t.plan(9)
+  const fastify = Fastify({ exposeHeadRoutes: false })
+
+  fastify.get('/get', {
+    schema: schema.schema,
+    config: Object.assign({}, schema.config)
+  }, handler)
+
+  fastify.route({
+    method: 'GET',
+    url: '/route',
+    schema: schema.schema,
+    handler: handler,
+    config: Object.assign({}, schema.config)
+  })
+
+  fastify.route({
+    method: 'GET',
+    url: '/no-config',
+    schema: schema.schema,
+    handler: handler
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/get'
+  }, (err, response) => {
+    t.error(err)
+    t.strictEqual(response.statusCode, 200)
+    t.deepEquals(JSON.parse(response.payload), Object.assign({ url: '/get', method: 'GET' }, schema.config))
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/route'
+  }, (err, response) => {
+    t.error(err)
+    t.strictEqual(response.statusCode, 200)
+    t.deepEquals(JSON.parse(response.payload), Object.assign({ url: '/route', method: 'GET' }, schema.config))
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/no-config'
+  }, (err, response) => {
+    t.error(err)
+    t.strictEqual(response.statusCode, 200)
+    t.deepEquals(JSON.parse(response.payload), { url: '/no-config', method: 'GET' })
+  })
+})

test/hooks-async.test.js

@@ -13,7 +13,7 @@ process.removeAllListeners('warning')
 test('async hooks', t => {
   t.plan(21)
 
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.addHook('onRequest', async function (request, reply) {
     await sleep(1)
     request.test = 'the request is coming'

test/hooks.test.js

@@ -16,7 +16,7 @@ process.removeAllListeners('warning')
 
 test('hooks', t => {
   t.plan(43)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   try {
     fastify.addHook('preHandler', function (request, reply, done) {
@@ -342,7 +342,7 @@ test('preHandler hook should support encapsulation / 5', t => {
 
 test('onRoute hook should be called / 1', t => {
   t.plan(2)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   fastify.register((instance, opts, done) => {
     instance.addHook('onRoute', () => {
@@ -363,7 +363,7 @@ test('onRoute hook should be called / 2', t => {
   t.plan(5)
   let firstHandler = 0
   let secondHandler = 0
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.addHook('onRoute', (route) => {
     t.pass()
     firstHandler++
@@ -391,7 +391,7 @@ test('onRoute hook should be called / 2', t => {
 
 test('onRoute hook should be called / 3', t => {
   t.plan(5)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   function handler (req, reply) {
     reply.send()
@@ -423,7 +423,7 @@ test('onRoute hook should be called / 3', t => {
 
 test('onRoute hook should be called (encapsulation support) / 4', t => {
   t.plan(4)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   fastify.addHook('onRoute', () => {
     t.pass()
@@ -450,7 +450,7 @@ test('onRoute hook should be called (encapsulation support) / 4', t => {
 
 test('onRoute hook should be called (encapsulation support) / 5', t => {
   t.plan(2)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   fastify.get('/first', function (req, reply) {
     reply.send()
@@ -477,7 +477,7 @@ test('onRoute hook should be called (encapsulation support) / 5', t => {
 
 test('onRoute hook should be called (encapsulation support) / 6', t => {
   t.plan(1)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   fastify.get('/first', function (req, reply) {
     reply.send()
@@ -494,7 +494,7 @@ test('onRoute hook should be called (encapsulation support) / 6', t => {
 
 test('onRoute should keep the context', t => {
   t.plan(4)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.register((instance, opts, done) => {
     instance.decorate('test', true)
     instance.addHook('onRoute', onRoute)
@@ -519,7 +519,7 @@ test('onRoute should keep the context', t => {
 
 test('onRoute hook should pass correct route', t => {
   t.plan(9)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.addHook('onRoute', (route) => {
     t.strictEqual(route.method, 'GET')
     t.strictEqual(route.url, '/')
@@ -547,7 +547,7 @@ test('onRoute hook should pass correct route', t => {
 
 test('onRoute hook should pass correct route with custom prefix', t => {
   t.plan(11)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.addHook('onRoute', function (route) {
     t.strictEqual(route.method, 'GET')
     t.strictEqual(route.url, '/v1/foo')
@@ -577,7 +577,7 @@ test('onRoute hook should pass correct route with custom prefix', t => {
 
 test('onRoute hook should pass correct route with custom options', t => {
   t.plan(6)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.register((instance, opts, done) => {
     instance.addHook('onRoute', function (route) {
       t.strictEqual(route.method, 'GET')
@@ -605,7 +605,7 @@ test('onRoute hook should pass correct route with custom options', t => {
 
 test('onRoute hook should receive any route option', t => {
   t.plan(5)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.register((instance, opts, done) => {
     instance.addHook('onRoute', function (route) {
       t.strictEqual(route.method, 'GET')
@@ -626,7 +626,7 @@ test('onRoute hook should receive any route option', t => {
 
 test('onRoute hook should preserve system route configuration', t => {
   t.plan(5)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.register((instance, opts, done) => {
     instance.addHook('onRoute', function (route) {
       t.strictEqual(route.method, 'GET')
@@ -650,7 +650,7 @@ test('onRoute hook should preserve handler function in options of shorthand rout
 
   const handler = (req, reply) => {}
 
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.register((instance, opts, done) => {
     instance.addHook('onRoute', function (route) {
       t.strictEqual(route.handler, handler)
@@ -671,7 +671,7 @@ test('onRoute hook should be called once when prefixTrailingSlash', t => {
   let onRouteCalled = 0
   let routePatched = 0
 
-  const fastify = Fastify({ ignoreTrailingSlash: false })
+  const fastify = Fastify({ ignoreTrailingSlash: false, exposeHeadRoutes: false })
 
   // a plugin that patches route options, similar to fastify-compress
   fastify.register(fp(function myPlugin (instance, opts, next) {
@@ -710,7 +710,7 @@ test('onRoute hook should be called once when prefixTrailingSlash', t => {
 test('onRoute hook should able to change the route url', t => {
   t.plan(5)
 
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   fastify.register((instance, opts, done) => {
     instance.addHook('onRoute', (route) => {
@@ -740,9 +740,9 @@ test('onRoute hook should able to change the route url', t => {
   })
 })
 
-test('onRoute hook that throws should be caught ', t => {
+test('onRoute hook that throws should be caught', t => {
   t.plan(1)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   fastify.register((instance, opts, done) => {
     instance.addHook('onRoute', () => {
@@ -761,7 +761,7 @@ test('onRoute hook that throws should be caught ', t => {
 
 test('onRoute hook with many prefix', t => {
   t.plan(3)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   const handler = (req, reply) => { reply.send({}) }
 
   const onRouteChecks = [

test/internals/initialConfig.test.js

@@ -31,7 +31,8 @@ test('without options passed to Fastify, initialConfig should expose default val
     pluginTimeout: 10000,
     requestIdHeader: 'request-id',
     requestIdLogLabel: 'reqId',
-    http2SessionTimeout: 5000
+    http2SessionTimeout: 5000,
+    exposeHeadRoutes: true
   }
 
   t.deepEquals(Fastify().initialConfig, fastifyDefaultOptions)
@@ -242,7 +243,8 @@ test('Should not have issues when passing stream options to Pino.js', t => {
       pluginTimeout: 10000,
       requestIdHeader: 'request-id',
       requestIdLogLabel: 'reqId',
-      http2SessionTimeout: 5000
+      http2SessionTimeout: 5000,
+      exposeHeadRoutes: true
     })
   } catch (error) {
     t.fail()

test/pretty-print.test.js

@@ -7,7 +7,7 @@ const Fastify = require('..')
 test('pretty print - static routes', t => {
   t.plan(2)
 
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.get('/test', () => {})
   fastify.get('/test/hello', () => {})
   fastify.get('/hello/world', () => {})
@@ -29,7 +29,7 @@ test('pretty print - static routes', t => {
 test('pretty print - parametric routes', t => {
   t.plan(2)
 
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.get('/test', () => {})
   fastify.get('/test/:hello', () => {})
   fastify.get('/hello/:world', () => {})
@@ -51,7 +51,7 @@ test('pretty print - parametric routes', t => {
 test('pretty print - mixed parametric routes', t => {
   t.plan(2)
 
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.get('/test', () => {})
   fastify.get('/test/:hello', () => {})
   fastify.post('/test/:hello', () => {})
@@ -75,7 +75,7 @@ test('pretty print - mixed parametric routes', t => {
 test('pretty print - wildcard routes', t => {
   t.plan(2)
 
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.get('/test', () => {})
   fastify.get('/test/*', () => {})
   fastify.get('/hello/*', () => {})

test/route-prefix.test.js

@@ -565,7 +565,8 @@ test('matches only /prefix/  with a / route - prefixTrailingSlash: "slash", igno
 test('calls onRoute only once when prefixing', async t => {
   t.plan(1)
   const fastify = Fastify({
-    ignoreTrailingSlash: false
+    ignoreTrailingSlash: false,
+    exposeHeadRoutes: false
   })
 
   let onRouteCalled = 0