@fastify/static 8.0.2 → 8.0.4

package/.github/workflows/ci.yml

@@ -17,7 +17,7 @@ on:
 
 jobs:
   test:
-    uses: fastify/workflows/.github/workflows/plugins-ci.yml@v5.0.0
+    uses: fastify/workflows/.github/workflows/plugins-ci.yml@v5
     with:
       license-check: true
       lint: true

package/README.md

@@ -1,21 +1,30 @@
 # @fastify/static
 
-![CI](https://github.com/fastify/fastify-static/workflows/CI/badge.svg)
+[![CI](https://github.com/fastify/fastify-static/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/fastify/fastify-static/actions/workflows/ci.yml)
 [![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/)
+[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)
 
-Plugin for serving static files as fast as possible. Supports Fastify version `4.x`.
-
-| 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)          |
+Plugin for serving static files as fast as possible.
 
 ## Install
+```
+npm i @fastify/static
+```
+
+### Compatibility
+
+| Plugin version | Fastify version |
+| ---------------|-----------------|
+| `^8.x`         | `^5.x`          |
+| `^7.x`         | `^4.x`          |
+| `^5.x`         | `^3.x`          |
+| `^2.x`         | `^2.x`          |
+| `^1.x`         | `^1.x`          |
+
 
-`npm i @fastify/static`
+Please note that if a Fastify version is out of support, then so are the corresponding versions of this plugin
+in the table above.
+See [Fastify's LTS policy](https://github.com/fastify/fastify/blob/main/docs/Reference/LTS.md) for more details.
 
 ## Usage
 
@@ -136,7 +145,7 @@ If set to false prefix will get trailing "/" at the end. If set to true, prefix
 
 Default: `true`
 
-A flag that define if the fastify route hide-schema attribute is hidden or not
+A flag that defines if the fastify route hide-schema attribute is hidden or not
 
 #### `setHeaders`
 
@@ -153,17 +162,18 @@ where the arguments are:
 #### `send` Options
 
 The following options are also supported and will be passed directly to the
-[`send`](https://www.npmjs.com/package/send) module:
-
-- [`acceptRanges`](https://www.npmjs.com/package/send#acceptranges)
-- [`cacheControl`](https://www.npmjs.com/package/send#cachecontrol)
-- [`dotfiles`](https://www.npmjs.com/package/send#dotfiles)
-- [`etag`](https://www.npmjs.com/package/send#etag)
-- [`extensions`](https://www.npmjs.com/package/send#extensions)
-- [`immutable`](https://www.npmjs.com/package/send#immutable)
-- [`index`](https://www.npmjs.com/package/send#index)
-- [`lastModified`](https://www.npmjs.com/package/send#lastmodified)
-- [`maxAge`](https://www.npmjs.com/package/send#maxage)
+[`@fastify/send`](https://www.npmjs.com/package/@fastify/send) module:
+
+- [`acceptRanges`](https://www.npmjs.com/package/@fastify/send#acceptranges)
+- [`contentType`](https://www.npmjs.com/package/@fastify/send#contenttype)
+- [`cacheControl`](https://www.npmjs.com/package/@fastify/send#cachecontrol) (Enable or disable setting Cache-Control response header, defaults to true. **Important:** If you want to provide a custom Cache-Control response header, this option must be false.)
+- [`dotfiles`](https://www.npmjs.com/package/@fastify/send#dotfiles)
+- [`etag`](https://www.npmjs.com/package/@fastify/send#etag)
+- [`extensions`](https://www.npmjs.com/package/@fastify/send#extensions)
+- [`immutable`](https://www.npmjs.com/package/@fastify/send#immutable)
+- [`index`](https://www.npmjs.com/package/@fastify/send#index)
+- [`lastModified`](https://www.npmjs.com/package/@fastify/send#lastmodified)
+- [`maxAge`](https://www.npmjs.com/package/@fastify/send#maxage)
 
 You're able to alter this options when calling `reply.download('filename.html', options)` or `reply.download('filename.html', 'otherfilename.html', options)` on each response to a request.
 
@@ -198,7 +208,7 @@ with `ignoreTrailingSlash` set to `true`.
 
 Default: `(pathName, root, request) => true`
 
-This function allows filtering the served files. Also, with the help of the request object a more complex path authentication is possible. 
+This function allows filtering the served files. Also, with the help of the request object a more complex path authentication is possible.
 If the function returns `true`, the file will be served.
 If the function returns `false`, Fastify's 404 handler will be called.
 
@@ -206,7 +216,7 @@ If the function returns `false`, Fastify's 404 handler will be called.
 
 Default: `undefined`
 
-Under the hood we use [send](https://github.com/pillarjs/send#index) lib that by default supports "index.html" files. 
+Under the hood we use [`@fastify/send`](https://www.npmjs.com/package/@fastify/send) 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`
@@ -421,7 +431,7 @@ This option determines the output format when `json` is selected.
 
 Default: `false`
 
-Try to send the brotli encoded asset first (when supported within the `Accept-Encoding` headers), retry for gzip, then the fall back to the original `pathname`. You may choose to skip compression for smaller files that don't benefit from it.
+Try to send the brotli encoded asset first (when supported within the `Accept-Encoding` headers), retry for gzip, and then fall back to the original `pathname`. You may choose to skip compression for smaller files that do not benefit from it.
 
 Assume this structure with the compressed asset as a sibling of the un-compressed counterpart:
 
@@ -452,7 +462,7 @@ If a request matches the URL `prefix` but a file cannot be found for the
 request, Fastify's 404 handler will be called. You can set a custom 404
 handler with [`fastify.setNotFoundHandler()`](https://fastify.dev/docs/latest/Reference/Server/#setnotfoundhandler).
 
-When registering `@fastify/static` within an encapsulated context, the `wildcard` option may need to be set to `false` in order to support index resolution and nested not-found-handler:
+When registering `@fastify/static` within an encapsulated context, the `wildcard` option may need to be set to `false` to support index resolution and nested not-found-handler:
 
 ```js
 const app = require('fastify')();
@@ -469,7 +479,7 @@ app.register((childContext, _, done) => {
 }, { prefix: 'docs' });
 ```
 
-This code will send the `index.html` for the paths `docs`, `docs/`, and `docs/index.html`. For all other `docs/<undefined-routes>` it will reply with `404.html`. 
+This code will send the `index.html` for the paths `docs`, `docs/`, and `docs/index.html`. For all other `docs/<undefined-routes>` it will reply with `404.html`.
 
 ### Handling Errors
 
@@ -490,4 +500,4 @@ fastify.addHook('onSend', function (req, reply, payload, next) {
 
 ## License
 
-Licensed under [MIT](./LICENSE)
+Licensed under [MIT](./LICENSE).

package/eslint.config.js

@@ -1,6 +1,7 @@
 'use strict'
 
 module.exports = require('neostandard')({
+  ignores: require('neostandard').resolveIgnoresFromGitignore(),
   noJsx: true,
   ts: true,
 })

package/index.js

@@ -38,6 +38,7 @@ async function fastifyStatic (fastify, opts) {
   const sendOptions = {
     root: opts.root,
     acceptRanges: opts.acceptRanges,
+    contentType: opts.contentType,
     cacheControl: opts.cacheControl,
     dotfiles: opts.dotfiles,
     etag: opts.etag,
@@ -76,7 +77,7 @@ async function fastifyStatic (fastify, opts) {
   if (opts.decorateReply !== false) {
     fastify.decorateReply('sendFile', function (filePath, rootPath, options) {
       const opts = typeof rootPath === 'object' ? rootPath : options
-      const root = typeof rootPath === 'string' ? rootPath : opts && opts.root
+      const root = typeof rootPath === 'string' ? rootPath : opts?.root
       pumpSendToReply(
         this.request,
         this,
@@ -442,7 +443,7 @@ function checkRootPathForErrors (fastify, rootPath) {
 
 function checkPath (fastify, rootPath) {
   if (typeof rootPath !== 'string') {
-    throw new Error('"root" option must be a string')
+    throw new TypeError('"root" option must be a string')
   }
   if (path.isAbsolute(rootPath) === false) {
     throw new Error('"root" option must be an absolute path')
@@ -472,7 +473,7 @@ function getContentType (path) {
   if (!send.isUtf8MimeType(type)) {
     return type
   }
-  return `${type}; charset=UTF-8`
+  return `${type}; charset=utf-8`
 }
 
 function findIndexFile (pathname, root, indexFiles = ['index.html']) {

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@fastify/static",
-  "version": "8.0.2",
+  "version": "8.0.4",
   "description": "Plugin for serving static files as fast as possible.",
   "main": "index.js",
   "type": "commonjs",
   "types": "types/index.d.ts",
   "scripts": {
-    "coverage": "npm run test:unit -- --coverage-report=html",
+    "coverage": "c8 --reporter html borp --coverage --check-coverage --lines 100",
     "lint": "eslint",
     "lint:fix": "eslint --fix",
     "test": "npm run test:unit && npm run test:typescript",
     "test:typescript": "tsd",
-    "test:unit": "tap",
+    "test:unit": "borp -C --check-coverage --lines 100",
     "example": "node example/server.js"
   },
   "repository": {
@@ -23,14 +23,43 @@
     "static"
   ],
   "author": "Tommaso Allevi - @allevo",
+  "contributors": [
+    {
+      "name": "Matteo Collina",
+      "email": "hello@matteocollina.com"
+    },
+    {
+      "name": "Manuel Spigolon",
+      "email": "behemoth89@gmail.com"
+    },
+    {
+      "name": "Aras Abbasi",
+      "email": "aras.abbasi@gmail.com"
+    },
+    {
+      "name": "Frazer Smith",
+      "email": "frazer.dev@icloud.com",
+      "url": "https://github.com/fdawgs"
+    }
+  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/fastify/fastify-static/issues"
   },
   "homepage": "https://github.com/fastify/fastify-static",
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/fastify"
+    },
+    {
+      "type": "opencollective",
+      "url": "https://opencollective.com/fastify"
+    }
+  ],
   "dependencies": {
     "@fastify/accept-negotiator": "^2.0.0",
-    "@fastify/send": "^3.1.0",
+    "@fastify/send": "^3.2.0",
     "content-disposition": "^0.5.4",
     "fastify-plugin": "^5.0.0",
     "fastq": "^1.17.1",
@@ -40,14 +69,14 @@
     "@fastify/compress": "^8.0.0",
     "@fastify/pre-commit": "^2.1.0",
     "@types/node": "^22.0.0",
+    "borp": "^0.19.0",
+    "c8": "^10.1.3",
     "concat-stream": "^2.0.0",
-    "eslint": "^9.9.0",
-    "fastify": "^5.0.0",
-    "neostandard": "^0.11.3",
+    "eslint": "^9.17.0",
+    "fastify": "^5.1.0",
+    "neostandard": "^0.12.0",
     "pino": "^9.1.0",
     "proxyquire": "^2.1.3",
-    "simple-get": "^4.0.1",
-    "tap": "^18.7.1",
     "tsd": "^0.31.0"
   },
   "tsd": {

package/test/content-type.test.js

@@ -3,14 +3,13 @@
 /* eslint n/no-deprecated-api: "off" */
 
 const path = require('node:path')
-const { test } = require('tap')
-const simple = require('simple-get')
+const { test } = require('node:test')
 const Fastify = require('fastify')
 
 const fastifyStatic = require('../')
 
-test('register /content-type', t => {
-  t.plan(6)
+test('register /content-type', async t => {
+  t.plan(5)
 
   const pluginOptions = {
     root: path.join(__dirname, '/content-type'),
@@ -19,72 +18,55 @@ test('register /content-type', t => {
   const fastify = Fastify()
   fastify.register(fastifyStatic, pluginOptions)
 
-  t.teardown(fastify.close.bind(fastify))
+  t.after(() => fastify.close())
 
-  fastify.listen({ port: 0 }, (err) => {
-    t.error(err)
+  await fastify.listen({ port: 0 })
 
-    fastify.server.unref()
+  fastify.server.unref()
 
-    t.test('/content-type/index.html', (t) => {
-      t.plan(2)
-      simple.concat({
-        method: 'GET',
-        url: 'http://localhost:' + fastify.server.address().port + '/content-type/index.html'
-      }, (err, response) => {
-        t.error(err)
-        t.equal(response.headers['content-type'], 'text/html; charset=UTF-8')
-      })
-    })
+  await t.test('/content-type/index.html', async (t) => {
+    t.plan(2)
 
-    t.test('/content-type/index.css', (t) => {
-      t.plan(2)
-      simple.concat({
-        method: 'GET',
-        url: 'http://localhost:' + fastify.server.address().port + '/content-type/index.css'
-      }, (err, response) => {
-        t.error(err)
-        t.equal(response.headers['content-type'], 'text/css; charset=UTF-8')
-      })
-    })
+    const response = await fetch('http://localhost:' + fastify.server.address().port + '/content-type/index.html')
+    t.assert.ok(response.ok)
+    t.assert.deepStrictEqual(response.headers.get('content-type'), 'text/html; charset=utf-8')
+  })
 
-    t.test('/content-type/sample.jpg', (t) => {
-      t.plan(2)
-      simple.concat({
-        method: 'GET',
-        url: 'http://localhost:' + fastify.server.address().port + '/content-type/sample.jpg'
-      }, (err, response) => {
-        t.error(err)
-        t.equal(response.headers['content-type'], 'image/jpeg')
-      })
-    })
+  await t.test('/content-type/index.css', async (t) => {
+    t.plan(2)
 
-    t.test('/content-type/test.txt', (t) => {
-      t.plan(2)
-      simple.concat({
-        method: 'GET',
-        url: 'http://localhost:' + fastify.server.address().port + '/content-type/test.txt'
-      }, (err, response) => {
-        t.error(err)
-        t.equal(response.headers['content-type'], 'text/plain; charset=UTF-8')
-      })
-    })
+    const response = await fetch('http://localhost:' + fastify.server.address().port + '/content-type/index.css')
+    t.assert.ok(response.ok)
+    t.assert.deepStrictEqual(response.headers.get('content-type'), 'text/css; charset=utf-8')
+  })
 
-    t.test('/content-type/binary', (t) => {
-      t.plan(2)
-      simple.concat({
-        method: 'GET',
-        url: 'http://localhost:' + fastify.server.address().port + '/content-type/binary'
-      }, (err, response) => {
-        t.error(err)
-        t.equal(response.headers['content-type'], 'application/octet-stream')
-      })
-    })
+  await t.test('/content-type/sample.jpg', async (t) => {
+    t.plan(2)
+
+    const response = await fetch('http://localhost:' + fastify.server.address().port + '/content-type/sample.jpg')
+    t.assert.ok(response.ok)
+    t.assert.deepStrictEqual(response.headers.get('content-type'), 'image/jpeg')
+  })
+
+  await t.test('/content-type/test.txt', async (t) => {
+    t.plan(2)
+
+    const response = await fetch('http://localhost:' + fastify.server.address().port + '/content-type/test.txt')
+    t.assert.ok(response.ok)
+    t.assert.deepStrictEqual(response.headers.get('content-type'), 'text/plain; charset=utf-8')
+  })
+
+  await t.test('/content-type/binary', async (t) => {
+    t.plan(2)
+
+    const response = await fetch('http://localhost:' + fastify.server.address().port + '/content-type/binary')
+    t.assert.ok(response.ok)
+    t.assert.deepStrictEqual(response.headers.get('content-type'), 'application/octet-stream')
   })
 })
 
-test('register /content-type preCompressed', t => {
-  t.plan(6)
+test('register /content-type preCompressed', async t => {
+  t.plan(5)
 
   const pluginOptions = {
     root: path.join(__dirname, '/content-type'),
@@ -94,81 +76,69 @@ test('register /content-type preCompressed', t => {
   const fastify = Fastify()
   fastify.register(fastifyStatic, pluginOptions)
 
-  t.teardown(fastify.close.bind(fastify))
-
-  fastify.listen({ port: 0 }, (err) => {
-    t.error(err)
-
-    fastify.server.unref()
-
-    t.test('/content-type/index.html', (t) => {
-      t.plan(2)
-      simple.concat({
-        method: 'GET',
-        url: 'http://localhost:' + fastify.server.address().port + '/content-type/index.html',
-        headers: {
-          'accept-encoding': 'gzip, deflate, br'
-        }
-      }, (err, response) => {
-        t.error(err)
-        t.equal(response.headers['content-type'], 'text/html; charset=UTF-8')
-      })
+  t.after(() => fastify.close())
+
+  await fastify.listen({ port: 0 })
+
+  fastify.server.unref()
+
+  await t.test('/content-type/index.html', async (t) => {
+    t.plan(2)
+
+    const response = await fetch('http://localhost:' + fastify.server.address().port + '/content-type/index.html', {
+      headers: {
+        'accept-encoding': 'gzip, deflate, br'
+      }
     })
+    t.assert.ok(response.ok)
+    t.assert.deepStrictEqual(response.headers.get('content-type'), 'text/html; charset=utf-8')
+  })
+
+  await t.test('/content-type/index.css', async (t) => {
+    t.plan(2)
 
-    t.test('/content-type/index.css', (t) => {
-      t.plan(2)
-      simple.concat({
-        method: 'GET',
-        url: 'http://localhost:' + fastify.server.address().port + '/content-type/index.css',
-        headers: {
-          'accept-encoding': 'gzip, deflate, br'
-        }
-      }, (err, response) => {
-        t.error(err)
-        t.equal(response.headers['content-type'], 'text/css; charset=UTF-8')
-      })
+    const response = await fetch('http://localhost:' + fastify.server.address().port + '/content-type/index.css', {
+      headers: {
+        'accept-encoding': 'gzip, deflate, br'
+      }
     })
+    t.assert.ok(response.ok)
+    t.assert.deepStrictEqual(response.headers.get('content-type'), 'text/css; charset=utf-8')
+  })
+
+  await t.test('/content-type/sample.jpg', async (t) => {
+    t.plan(2)
 
-    t.test('/content-type/sample.jpg', (t) => {
-      t.plan(2)
-      simple.concat({
-        method: 'GET',
-        url: 'http://localhost:' + fastify.server.address().port + '/content-type/sample.jpg',
-        headers: {
-          'accept-encoding': 'gzip, deflate, br'
-        }
-      }, (err, response) => {
-        t.error(err)
-        t.equal(response.headers['content-type'], 'image/jpeg')
-      })
+    const response = await fetch('http://localhost:' + fastify.server.address().port + '/content-type/sample.jpg', {
+      headers: {
+        'accept-encoding': 'gzip, deflate, br'
+      }
     })
+    t.assert.ok(response.ok)
+    t.assert.deepStrictEqual(response.headers.get('content-type'), 'image/jpeg')
+  })
 
-    t.test('/content-type/test.txt', (t) => {
-      t.plan(2)
-      simple.concat({
-        method: 'GET',
-        url: 'http://localhost:' + fastify.server.address().port + '/content-type/test.txt',
-        headers: {
-          'accept-encoding': 'gzip, deflate, br'
-        }
-      }, (err, response) => {
-        t.error(err)
-        t.equal(response.headers['content-type'], 'text/plain; charset=UTF-8')
-      })
+  await t.test('/content-type/test.txt', async (t) => {
+    t.plan(2)
+
+    const response = await fetch('http://localhost:' + fastify.server.address().port + '/content-type/test.txt', {
+      headers: {
+        'accept-encoding': 'gzip, deflate, br'
+      }
     })
+    t.assert.ok(response.ok)
+    t.assert.deepStrictEqual(response.headers.get('content-type'), 'text/plain; charset=utf-8')
+  })
+
+  await t.test('/content-type/binary', async (t) => {
+    t.plan(2)
 
-    t.test('/content-type/binary', (t) => {
-      t.plan(2)
-      simple.concat({
-        method: 'GET',
-        url: 'http://localhost:' + fastify.server.address().port + '/content-type/binary',
-        headers: {
-          'accept-encoding': 'gzip, deflate, br'
-        }
-      }, (err, response) => {
-        t.error(err)
-        t.equal(response.headers['content-type'], 'application/octet-stream')
-      })
+    const response = await fetch('http://localhost:' + fastify.server.address().port + '/content-type/binary', {
+      headers: {
+        'accept-encoding': 'gzip, deflate, br'
+      }
     })
+    t.assert.ok(response.ok)
+    t.assert.deepStrictEqual(response.headers.get('content-type'), 'application/octet-stream')
   })
 })