@fastify/static 6.5.0 → 6.6.0

package/.github/workflows/ci.yml

@@ -14,4 +14,5 @@ jobs:
   test:
     uses: fastify/workflows/.github/workflows/plugins-ci.yml@v3
     with:
+      license-check: true
       lint: true

package/README.md

@@ -4,10 +4,14 @@
 [![NPM version](https://img.shields.io/npm/v/@fastify/static.svg?style=flat)](https://www.npmjs.com/package/@fastify/static)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
 
-Plugin for serving static files as fast as possible. Supports Fastify version `3.x`.
+Plugin for serving static files as fast as possible. Supports Fastify version `4.x`.
 
-Please refer to [this branch](https://github.com/fastify/fastify-static/tree/2.x) and related versions for Fastify `^2.0.0` compatibility.
-Please refer to [this branch](https://github.com/fastify/fastify-static/tree/1.x) and related versions for Fastify `^1.11.0` compatibility.
+| Fastify version | branch                                                               |
+| --------------- | -------------------------------------------------------------------- |
+| `^4.x`          | This branch                                                          |
+| `^3.x`          | [`v5.x`](https://github.com/fastify/fastify-static/tree/v5.x)         |
+| `^2.x`          | [`2.x`](https://github.com/fastify/fastify-static/tree/2.x)          |
+| `^1.11.x`       | [`1.x`](https://github.com/fastify/fastify-static/tree/1.x)          |
 
 ## Install
 
@@ -16,7 +20,7 @@ Please refer to [this branch](https://github.com/fastify/fastify-static/tree/1.x
 ## Usage
 
 ```js
-const fastify = require('fastify')()
+const fastify = require('fastify')({logger: true})
 const path = require('path')
 
 fastify.register(require('@fastify/static'), {
@@ -25,15 +29,25 @@ fastify.register(require('@fastify/static'), {
 })
 
 fastify.get('/another/path', function (req, reply) {
-  return reply.sendFile('myHtml.html') // serving path.join(__dirname, 'public', 'myHtml.html') directly
+  reply.sendFile('myHtml.html') // serving path.join(__dirname, 'public', 'myHtml.html') directly
+})
+
+fastify.get('/another/patch-async', async function (req, reply) {
+  return reply.sendFile('myHtml.html')
 })
 
 fastify.get('/path/with/different/root', function (req, reply) {
-  return reply.sendFile('myHtml.html', path.join(__dirname, 'build')) // serving a file from a different root location
+  reply.sendFile('myHtml.html', path.join(__dirname, 'build')) // serving a file from a different root location
 })
 
 fastify.get('/another/path', function (req, reply) {
-  return reply.sendFile('myHtml.html', { cacheControl: false }) // overriding the options disabling cache-control headers
+  reply.sendFile('myHtml.html', { cacheControl: false }) // overriding the options disabling cache-control headers
+})
+
+// Run the server!
+fastify.listen({ port: 3000 }, (err, address) => {
+  if (err) throw err
+  // Server is now listening on ${address}
 })
 ```
 
@@ -69,15 +83,20 @@ fastify.register(require('@fastify/static'), {
 })
 
 fastify.get('/another/path', function (req, reply) {
-  return reply.download('myHtml.html', 'custom-filename.html') // sending path.join(__dirname, 'public', 'myHtml.html') directly with custom filename
+  reply.download('myHtml.html', 'custom-filename.html') // sending path.join(__dirname, 'public', 'myHtml.html') directly with custom filename
+})
+
+fastify.get('another/patch-async', async function (req, reply) {
+  // an async handler must always return the reply object
+  return reply.download('myHtml.html', 'custom-filename.html')
 })
 
 fastify.get('/path/without/cache/control', function (req, reply) {
-  return reply.download('myHtml.html', { cacheControl: false }) // serving a file disabling cache-control headers
+  reply.download('myHtml.html', { cacheControl: false }) // serving a file disabling cache-control headers
 })
 
 fastify.get('/path/without/cache/control', function (req, reply) {
-  return reply.download('myHtml.html', 'custom-filename.html', { cacheControl: false })
+  reply.download('myHtml.html', 'custom-filename.html', { cacheControl: false })
 })
 
 ```
@@ -182,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-compress.js

@@ -10,6 +10,6 @@ fastify
     // An absolute path containing static files to serve.
     root: path.join(__dirname, '/public')
   })
-  .listen(3000, err => {
+  .listen({ port: 3000 }, err => {
     if (err) throw err
   })

package/example/server-dir-list.js

@@ -44,6 +44,6 @@ fastify
       render: (dirs, files) => handlebarTemplate({ dirs, files })
     }
   })
-  .listen(3000, err => {
+  .listen({ port: 3000 }, err => {
     if (err) throw err
   })

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/example/server.js

@@ -8,6 +8,6 @@ fastify
     // An absolute path containing static files to serve.
     root: path.join(__dirname, '/public')
   })
-  .listen(3000, err => {
+  .listen({ port: 3000 }, err => {
     if (err) throw err
   })

package/index.js

@@ -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) {
@@ -518,3 +519,5 @@ module.exports = fp(fastifyStatic, {
   fastify: '4.x',
   name: '@fastify/static'
 })
+module.exports.default = fastifyStatic
+module.exports.fastifyStatic = fastifyStatic

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@fastify/static",
-  "version": "6.5.0",
+  "version": "6.6.0",
   "description": "Plugin for serving static files as fast as possible.",
   "main": "index.js",
-  "types": "index.d.ts",
+  "types": "types/index.d.ts",
   "scripts": {
     "lint": "standard | snazzy",
     "lint:fix": "standard --fix",
@@ -39,6 +39,7 @@
   },
   "devDependencies": {
     "@fastify/compress": "^6.0.0",
+    "@fastify/pre-commit": "^2.0.2",
     "@types/node": "^18.0.0",
     "@typescript-eslint/eslint-plugin": "^2.29.0",
     "@typescript-eslint/parser": "^2.29.0",
@@ -47,14 +48,13 @@
     "eslint-plugin-typescript": "^0.14.0",
     "fastify": "^4.0.0-rc.2",
     "handlebars": "^4.7.6",
-    "pre-commit": "^1.2.2",
+    "pino": "^8.4.2",
     "proxyquire": "^2.1.0",
     "simple-get": "^4.0.0",
     "snazzy": "^9.0.0",
     "standard": "^17.0.0",
     "tap": "^16.0.0",
-    "tsd": "^0.22.0",
-    "typescript": "^4.0.2"
+    "tsd": "^0.24.1"
   },
   "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) {
@@ -808,7 +809,7 @@ t.test('serving disabled', (t) => {
   fastify.register(fastifyStatic, pluginOptions)
 
   fastify.get('/foo/bar', (request, reply) => {
-    return reply.sendFile('index.html')
+    reply.sendFile('index.html')
   })
 
   t.teardown(fastify.close.bind(fastify))
@@ -856,18 +857,18 @@ t.test('sendFile', (t) => {
   fastify.register(fastifyStatic, pluginOptions)
 
   fastify.get('/foo/bar', function (req, reply) {
-    return reply.sendFile('/index.html')
+    reply.sendFile('/index.html')
   })
 
   fastify.get('/root/path/override/test', (request, reply) => {
-    return reply.sendFile(
+    reply.sendFile(
       '/foo.html',
       path.join(__dirname, 'static', 'deep', 'path', 'for', 'test', 'purpose')
     )
   })
 
   fastify.get('/foo/bar/options/override/test', function (req, reply) {
-    return reply.sendFile('/index.html', { maxAge })
+    reply.sendFile('/index.html', { maxAge })
   })
 
   fastify.listen({ port: 0 }, (err) => {
@@ -1066,26 +1067,26 @@ t.test('download', (t) => {
   fastify.register(fastifyStatic, pluginOptions)
 
   fastify.get('/foo/bar', function (req, reply) {
-    return reply.download('/index.html')
+    reply.download('/index.html')
   })
 
   fastify.get('/foo/bar/change', function (req, reply) {
-    return reply.download('/index.html', 'hello-world.html')
+    reply.download('/index.html', 'hello-world.html')
   })
 
   fastify.get('/foo/bar/override', function (req, reply) {
-    return reply.download('/index.html', 'hello-world.html', {
+    reply.download('/index.html', 'hello-world.html', {
       maxAge: '2 hours',
       immutable: true
     })
   })
 
   fastify.get('/foo/bar/override/2', function (req, reply) {
-    return reply.download('/index.html', { acceptRanges: false })
+    reply.download('/index.html', { acceptRanges: false })
   })
 
   fastify.get('/root/path/override/test', (request, reply) => {
-    return reply.download('/foo.html', {
+    reply.download('/foo.html', {
       root: path.join(
         __dirname,
         'static',
@@ -1099,7 +1100,7 @@ t.test('download', (t) => {
   })
 
   fastify.get('/root/path/override/test/change', (request, reply) => {
-    return reply.download('/foo.html', 'hello-world.html', {
+    reply.download('/foo.html', 'hello-world.html', {
       root: path.join(
         __dirname,
         'static',
@@ -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/{index.d.ts → types/index.d.ts}

@@ -2,7 +2,7 @@
 //                 Leo <https://github.com/leomelzer>
 /// <reference types="node" />
 
-import { FastifyPluginCallback, FastifyReply, FastifyRequest } from 'fastify';
+import { FastifyPluginAsync, FastifyRequest } from 'fastify';
 import { Stats } from 'fs';
 
 declare module "fastify" {
@@ -16,7 +16,7 @@ declare module "fastify" {
   }
 }
 
-type FastifyStaticPlugin = FastifyPluginCallback<NonNullable<fastifyStatic.FastifyStaticOptions>>;
+type FastifyStaticPlugin = FastifyPluginAsync<NonNullable<fastifyStatic.FastifyStaticOptions>>;
 
 declare namespace fastifyStatic {
   export interface ExtendedInformation {
@@ -73,6 +73,7 @@ declare namespace fastifyStatic {
     index?: string[] | string | false;
     lastModified?: boolean;
     maxAge?: string | number;
+    serveDotFiles?: boolean;
   }
 
   export interface FastifyStaticOptions extends SendOptions {

package/{test/types/index.ts → types/index.test-d.ts}

@@ -1,14 +1,14 @@
-import fastify, { FastifyInstance, FastifyPluginCallback, FastifyRequest } from 'fastify'
+import fastify, { FastifyInstance, FastifyPluginAsync, FastifyRequest } from 'fastify'
 import { Server } from 'http';
 import { expectAssignable, expectError, expectType } from 'tsd'
-import * as fastifyStaticStar from '../..';
+import * as fastifyStaticStar from '..';
 import fastifyStatic, {
   FastifyStaticOptions, 
   fastifyStatic as fastifyStaticNamed,
-} from '../..'
+} from '..'
 
-import fastifyStaticCjsImport = require('../..');
-const fastifyStaticCjs = require('../..');
+import fastifyStaticCjsImport = require('..');
+const fastifyStaticCjs = require('..');
 
 const app: FastifyInstance = fastify();
 
@@ -20,12 +20,12 @@ app.register(fastifyStaticCjsImport.fastifyStatic);
 app.register(fastifyStaticStar.default);
 app.register(fastifyStaticStar.fastifyStatic);
 
-expectType<FastifyPluginCallback<FastifyStaticOptions, Server>>(fastifyStatic);
-expectType<FastifyPluginCallback<FastifyStaticOptions, Server>>(fastifyStaticNamed);
-expectType<FastifyPluginCallback<FastifyStaticOptions, Server>>(fastifyStaticCjsImport.default);
-expectType<FastifyPluginCallback<FastifyStaticOptions, Server>>(fastifyStaticCjsImport.fastifyStatic);
-expectType<FastifyPluginCallback<FastifyStaticOptions, Server>>(fastifyStaticStar.default);
-expectType<FastifyPluginCallback<FastifyStaticOptions, Server>>(
+expectType<FastifyPluginAsync<FastifyStaticOptions, Server>>(fastifyStatic);
+expectType<FastifyPluginAsync<FastifyStaticOptions, Server>>(fastifyStaticNamed);
+expectType<FastifyPluginAsync<FastifyStaticOptions, Server>>(fastifyStaticCjsImport.default);
+expectType<FastifyPluginAsync<FastifyStaticOptions, Server>>(fastifyStaticCjsImport.fastifyStatic);
+expectType<FastifyPluginAsync<FastifyStaticOptions, Server>>(fastifyStaticStar.default);
+expectType<FastifyPluginAsync<FastifyStaticOptions, Server>>(
 fastifyStaticStar.fastifyStatic
 );
 expectType<any>(fastifyStaticCjs);

package/.eslintrc

@@ -1 +0,0 @@
-{ "extends": "standard" }