@fastify/static 6.5.1 → 6.6.1

package/README.md

@@ -201,11 +201,17 @@ Default: `undefined`
 Under the hood we use [send](https://github.com/pillarjs/send#index) lib that by default supports "index.html" files. 
 To disable this set false or to supply a new index pass a string or an array in preferred order.
 
+### `serveDotFiles`
+
+Default: `false`
+
+When `true`, files in hidden directories (e.g. `.foo`) will be served.
+
 #### `list`
 
 Default: `undefined`
 
-If set, it provide the directory list calling the directory path.
+If set, it provides the directory list calling the directory path.
 
 Default response is json.
 

package/example/public/.hidden/sample.json

@@ -0,0 +1 @@
+{"hello": "world"}

package/example/server-hidden-file.js

@@ -0,0 +1,15 @@
+'use strict'
+
+const path = require('path')
+const fastify = require('fastify')({ logger: { level: 'trace' } })
+
+fastify
+  .register(require('../'), {
+    // An absolute path containing static files to serve.
+    root: path.join(__dirname, '/public'),
+    wildcard: false,
+    serveDotFiles: true
+  })
+  .listen({ port: 3000 }, err => {
+    if (err) throw err
+  })

package/index.js

@@ -4,7 +4,7 @@ const path = require('path')
 const statSync = require('fs').statSync
 const { PassThrough } = require('readable-stream')
 const glob = require('glob')
-const send = require('send')
+const send = require('@fastify/send')
 const contentDisposition = require('content-disposition')
 const fp = require('fastify-plugin')
 const util = require('util')
@@ -37,7 +37,8 @@ async function fastifyStatic (fastify, opts) {
     immutable: opts.immutable,
     index: opts.index,
     lastModified: opts.lastModified,
-    maxAge: opts.maxAge
+    maxAge: opts.maxAge,
+    serveDotFiles: opts.serveDotFiles ?? false
   }
 
   const allowedPath = opts.allowedPath
@@ -336,7 +337,7 @@ async function fastifyStatic (fastify, opts) {
       const winSeparatorRegex = new RegExp(`\\${path.win32.sep}`, 'g')
 
       for (const rootPath of Array.isArray(sendOptions.root) ? sendOptions.root : [sendOptions.root]) {
-        const files = await globPromise(path.join(rootPath, globPattern).replace(winSeparatorRegex, path.posix.sep), { nodir: true })
+        const files = await globPromise(path.join(rootPath, globPattern).replace(winSeparatorRegex, path.posix.sep), { nodir: true, dot: sendOptions.serveDotFiles })
         const indexes = typeof opts.index === 'undefined' ? ['index.html'] : [].concat(opts.index)
 
         for (let file of files) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastify/static",
-  "version": "6.5.1",
+  "version": "6.6.1",
   "description": "Plugin for serving static files as fast as possible.",
   "main": "index.js",
   "types": "types/index.d.ts",
@@ -35,7 +35,7 @@
     "glob": "^8.0.1",
     "p-limit": "^3.1.0",
     "readable-stream": "^4.0.0",
-    "send": "^0.18.0"
+    "@fastify/send": "^1.0.0"
   },
   "devDependencies": {
     "@fastify/compress": "^6.0.0",
@@ -54,7 +54,7 @@
     "snazzy": "^9.0.0",
     "standard": "^17.0.0",
     "tap": "^16.0.0",
-    "tsd": "^0.24.1"
+    "tsd": "^0.25.0"
   },
   "tsd": {
     "directory": "test/types"

package/test/static-hidden/.hidden/sample.json

@@ -0,0 +1 @@
+{"hello": "world"}

package/test/static.test.js

@@ -51,6 +51,7 @@ const uncompressedStatic = fs
   .toString('utf8')
 const fooContent = fs.readFileSync('./test/static/foo.html').toString('utf8')
 const barContent = fs.readFileSync('./test/static2/bar.html').toString('utf8')
+const jsonHiddenContent = fs.readFileSync('./test/static-hidden/.hidden/sample.json').toString('utf8')
 
 const GENERIC_RESPONSE_CHECK_COUNT = 5
 function genericResponseChecks (t, response) {
@@ -1335,7 +1336,7 @@ t.test('send options', (t) => {
   }
   const fastify = Fastify({ logger: false })
   const fastifyStatic = require('proxyquire')('../', {
-    send: function sendStub (req, pathName, options) {
+    '@fastify/send': function sendStub (req, pathName, options) {
       t.equal(pathName, '/index.html')
       t.equal(options.root, path.join(__dirname, '/static'))
       t.equal(options.acceptRanges, 'acceptRanges')
@@ -3552,3 +3553,96 @@ t.test('should follow symbolic link without wildcard', (t) => {
     })
   })
 })
+
+t.test('should serve files into hidden dir with wildcard `false`', (t) => {
+  t.plan(9)
+
+  const pluginOptions = {
+    root: path.join(__dirname, '/static-hidden'),
+    wildcard: false,
+    serveDotFiles: true
+  }
+  const fastify = Fastify()
+  fastify.register(fastifyStatic, pluginOptions)
+
+  t.teardown(fastify.close.bind(fastify))
+
+  fastify.listen({ port: 0 }, (err) => {
+    t.error(err)
+
+    fastify.server.unref()
+
+    simple.concat({
+      method: 'GET',
+      url: 'http://localhost:' + fastify.server.address().port + '/.hidden/sample.json'
+    }, (err, response, body) => {
+      t.error(err)
+      t.equal(response.statusCode, 200)
+      t.equal(body.toString(), jsonHiddenContent)
+      t.ok(/application\/(json)/.test(response.headers['content-type']))
+      t.ok(response.headers.etag)
+      t.ok(response.headers['last-modified'])
+      t.ok(response.headers.date)
+      t.ok(response.headers['cache-control'])
+    })
+  })
+})
+
+t.test('should not found hidden file with wildcard is `false`', (t) => {
+  t.plan(3)
+
+  const pluginOptions = {
+    root: path.join(__dirname, '/static-hidden'),
+    wildcard: false
+  }
+  const fastify = Fastify()
+  fastify.register(fastifyStatic, pluginOptions)
+
+  t.teardown(fastify.close.bind(fastify))
+
+  fastify.listen({ port: 0 }, (err) => {
+    t.error(err)
+
+    fastify.server.unref()
+
+    simple.concat({
+      method: 'GET',
+      url: 'http://localhost:' + fastify.server.address().port + '/.hidden/sample.json'
+    }, (err, response, body) => {
+      t.error(err)
+      t.equal(response.statusCode, 404)
+    })
+  })
+})
+
+t.test('should serve files into hidden dir without wildcard option', (t) => {
+  t.plan(9)
+
+  const pluginOptions = {
+    root: path.join(__dirname, '/static-hidden')
+  }
+  const fastify = Fastify()
+  fastify.register(fastifyStatic, pluginOptions)
+
+  t.teardown(fastify.close.bind(fastify))
+
+  fastify.listen({ port: 0 }, (err) => {
+    t.error(err)
+
+    fastify.server.unref()
+
+    simple.concat({
+      method: 'GET',
+      url: 'http://localhost:' + fastify.server.address().port + '/.hidden/sample.json'
+    }, (err, response, body) => {
+      t.error(err)
+      t.equal(response.statusCode, 200)
+      t.equal(body.toString(), jsonHiddenContent)
+      t.ok(/application\/(json)/.test(response.headers['content-type']))
+      t.ok(response.headers.etag)
+      t.ok(response.headers['last-modified'])
+      t.ok(response.headers.date)
+      t.ok(response.headers['cache-control'])
+    })
+  })
+})

package/types/index.d.ts

@@ -73,6 +73,7 @@ declare namespace fastifyStatic {
     index?: string[] | string | false;
     lastModified?: boolean;
     maxAge?: string | number;
+    serveDotFiles?: boolean;
   }
 
   export interface FastifyStaticOptions extends SendOptions {