@fastify/static 8.0.1 → 8.0.3

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

@@ -153,17 +153,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 +199,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 +207,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 [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`
@@ -469,7 +470,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
 

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,
@@ -350,7 +351,11 @@ async function fastifyStatic (fastify, opts) {
         break
       }
       case 'file': {
-        reply.code(statusCode)
+        // reply.raw.statusCode by default 200
+        // when ever the user changed it, we respect the status code
+        // otherwise use send provided status code
+        const newStatusCode = reply.statusCode !== 200 ? reply.statusCode : statusCode
+        reply.code(newStatusCode)
         if (setHeaders !== undefined) {
           setHeaders(reply.raw, metadata.path, metadata.stat)
         }
@@ -468,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,6 +1,6 @@
 {
   "name": "@fastify/static",
-  "version": "8.0.1",
+  "version": "8.0.3",
   "description": "Plugin for serving static files as fast as possible.",
   "main": "index.js",
   "type": "commonjs",
@@ -30,7 +30,7 @@
   "homepage": "https://github.com/fastify/fastify-static",
   "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",
@@ -42,7 +42,7 @@
     "@types/node": "^22.0.0",
     "concat-stream": "^2.0.0",
     "eslint": "^9.9.0",
-    "fastify": "^5.0.0",
+    "fastify": "^5.1.0",
     "neostandard": "^0.11.3",
     "pino": "^9.1.0",
     "proxyquire": "^2.1.3",

package/test/content-type.test.js

@@ -33,7 +33,7 @@ test('register /content-type', t => {
         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')
+        t.equal(response.headers['content-type'], 'text/html; charset=utf-8')
       })
     })
 
@@ -44,7 +44,7 @@ test('register /content-type', t => {
         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')
+        t.equal(response.headers['content-type'], 'text/css; charset=utf-8')
       })
     })
 
@@ -66,7 +66,7 @@ test('register /content-type', t => {
         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')
+        t.equal(response.headers['content-type'], 'text/plain; charset=utf-8')
       })
     })
 
@@ -111,7 +111,7 @@ test('register /content-type preCompressed', t => {
         }
       }, (err, response) => {
         t.error(err)
-        t.equal(response.headers['content-type'], 'text/html; charset=UTF-8')
+        t.equal(response.headers['content-type'], 'text/html; charset=utf-8')
       })
     })
 
@@ -125,7 +125,7 @@ test('register /content-type preCompressed', t => {
         }
       }, (err, response) => {
         t.error(err)
-        t.equal(response.headers['content-type'], 'text/css; charset=UTF-8')
+        t.equal(response.headers['content-type'], 'text/css; charset=utf-8')
       })
     })
 
@@ -153,7 +153,7 @@ test('register /content-type preCompressed', t => {
         }
       }, (err, response) => {
         t.error(err)
-        t.equal(response.headers['content-type'], 'text/plain; charset=UTF-8')
+        t.equal(response.headers['content-type'], 'text/plain; charset=utf-8')
       })
     })
 

package/test/static/shallow/no-link

@@ -0,0 +1 @@
+/none

package/test/static-symbolic-link/dir/symlink

@@ -0,0 +1 @@
+../origin

package/test/static.test.js

@@ -1377,10 +1377,11 @@ t.test('root not found warning', (t) => {
 })
 
 t.test('send options', (t) => {
-  t.plan(11)
+  t.plan(12)
   const pluginOptions = {
     root: path.join(__dirname, '/static'),
     acceptRanges: 'acceptRanges',
+    contentType: 'contentType',
     cacheControl: 'cacheControl',
     dotfiles: 'dotfiles',
     etag: 'etag',
@@ -1396,6 +1397,7 @@ t.test('send options', (t) => {
       t.equal(pathName, '/index.html')
       t.equal(options.root, path.join(__dirname, '/static'))
       t.equal(options.acceptRanges, 'acceptRanges')
+      t.equal(options.contentType, 'contentType')
       t.equal(options.cacheControl, 'cacheControl')
       t.equal(options.dotfiles, 'dotfiles')
       t.equal(options.etag, 'etag')
@@ -4017,9 +4019,86 @@ t.test('content-length in head route should not return zero when using wildcard'
     }, (err, response, body) => {
       t.error(err)
       t.equal(response.statusCode, 200)
-      t.equal(response.headers['content-type'], 'text/html; charset=UTF-8')
+      t.equal(response.headers['content-type'], 'text/html; charset=utf-8')
       t.equal(response.headers['content-length'], contentLength)
       t.equal(body.toString(), '')
     })
   })
 })
+
+t.test('respect the .code when using with sendFile', t => {
+  t.plan(6)
+
+  const pluginOptions = {
+    root: path.join(__dirname, '/static')
+  }
+  const fastify = Fastify()
+
+  fastify.register(fastifyStatic, pluginOptions)
+
+  fastify.get('/custom', (_, reply) => {
+    return reply.code(404).type('text/html').sendFile('foo.html')
+  })
+
+  t.teardown(fastify.close.bind(fastify))
+
+  fastify.listen({ port: 0 }, err => {
+    t.error(err)
+
+    fastify.server.unref()
+
+    const file = fs.readFileSync(path.join(__dirname, '/static/foo.html'))
+    const contentLength = Buffer.byteLength(file).toString()
+
+    simple.concat({
+      method: 'HEAD',
+      url: 'http://localhost:' + fastify.server.address().port + '/custom',
+      followRedirect: false
+    }, (err, response, body) => {
+      t.error(err)
+      t.equal(response.statusCode, 404)
+      t.equal(response.headers['content-type'], 'text/html; charset=utf-8')
+      t.equal(response.headers['content-length'], contentLength)
+      t.equal(body.toString(), '')
+    })
+  })
+})
+
+t.test('respect the .type when using with sendFile with contentType disabled', t => {
+  t.plan(6)
+
+  const pluginOptions = {
+    root: path.join(__dirname, '/static'),
+    contentType: false
+  }
+  const fastify = Fastify()
+
+  fastify.register(fastifyStatic, pluginOptions)
+
+  fastify.get('/custom', (_, reply) => {
+    return reply.type('text/html; charset=windows-1252').sendFile('foo.html')
+  })
+
+  t.teardown(fastify.close.bind(fastify))
+
+  fastify.listen({ port: 0 }, err => {
+    t.error(err)
+
+    fastify.server.unref()
+
+    const file = fs.readFileSync(path.join(__dirname, '/static/foo.html'))
+    const contentLength = Buffer.byteLength(file).toString()
+
+    simple.concat({
+      method: 'GET',
+      url: 'http://localhost:' + fastify.server.address().port + '/custom',
+      followRedirect: false
+    }, (err, response, body) => {
+      t.error(err)
+      t.equal(response.statusCode, 200)
+      t.equal(response.headers['content-type'], 'text/html; charset=windows-1252')
+      t.equal(response.headers['content-length'], contentLength)
+      t.equal(body.toString(), fooContent)
+    })
+  })
+})

package/types/index.d.ts

@@ -72,6 +72,7 @@ declare namespace fastifyStatic {
   // Passed on to `send`
   export interface SendOptions {
     acceptRanges?: boolean;
+    contentType?: boolean;
     cacheControl?: boolean;
     dotfiles?: 'allow' | 'deny' | 'ignore';
     etag?: boolean;
@@ -103,6 +104,7 @@ declare namespace fastifyStatic {
 
     // Passed on to `send`
     acceptRanges?: boolean;
+    contentType?: boolean;
     cacheControl?: boolean;
     dotfiles?: 'allow' | 'deny' | 'ignore';
     etag?: boolean;

package/types/index.test-d.ts

@@ -13,13 +13,13 @@ const fastifyStaticCjs = require('..')
 
 const app: FastifyInstance = fastify()
 
-app.register(fastifyStatic)
-app.register(fastifyStaticNamed)
-app.register(fastifyStaticCjs)
-app.register(fastifyStaticCjsImport.default)
-app.register(fastifyStaticCjsImport.fastifyStatic)
-app.register(fastifyStaticStar.default)
-app.register(fastifyStaticStar.fastifyStatic)
+app.register(fastifyStatic, { root: __dirname })
+app.register(fastifyStaticNamed, { root: __dirname })
+app.register(fastifyStaticCjs, { root: __dirname })
+app.register(fastifyStaticCjsImport.default, { root: __dirname })
+app.register(fastifyStaticCjsImport.fastifyStatic, { root: __dirname })
+app.register(fastifyStaticStar.default, { root: __dirname })
+app.register(fastifyStaticStar.fastifyStatic, { root: __dirname })
 
 expectType<FastifyPluginAsync<FastifyStaticOptions, Server>>(fastifyStatic)
 expectType<FastifyPluginAsync<FastifyStaticOptions, Server>>(fastifyStaticNamed)
@@ -34,6 +34,7 @@ expectType<any>(fastifyStaticCjs)
 const appWithImplicitHttp = fastify()
 const options: FastifyStaticOptions = {
   acceptRanges: true,
+  contentType: true,
   cacheControl: true,
   decorateReply: true,
   dotfiles: 'allow',
@@ -145,6 +146,10 @@ appWithHttp2
     appWithHttp2.get('/download/2', (request, reply) => {
       reply.download('some-file-name', 'some-filename', { cacheControl: false, acceptRanges: true })
     })
+
+    appWithHttp2.get('/download/3', (request, reply) => {
+      reply.download('some-file-name', 'some-filename', { contentType: false })
+    })
   })
 
 const multiRootAppWithImplicitHttp = fastify()
@@ -165,6 +170,10 @@ multiRootAppWithImplicitHttp
       reply.sendFile('some-file-name', 'some-root-name', { cacheControl: false, acceptRanges: true })
     })
 
+    multiRootAppWithImplicitHttp.get('/', (request, reply) => {
+      reply.sendFile('some-file-name', 'some-root-name-2', { contentType: false })
+    })
+
     multiRootAppWithImplicitHttp.get('/download', (request, reply) => {
       reply.download('some-file-name')
     })
@@ -176,6 +185,10 @@ multiRootAppWithImplicitHttp
     multiRootAppWithImplicitHttp.get('/download/2', (request, reply) => {
       reply.download('some-file-name', 'some-filename', { cacheControl: false, acceptRanges: true })
     })
+
+    multiRootAppWithImplicitHttp.get('/download/3', (request, reply) => {
+      reply.download('some-file-name', 'some-filename', { contentType: false })
+    })
   })
 
 const noIndexApp = fastify()