@fastify/static 6.9.0 → 6.10.1

package/README.md

@@ -26,6 +26,7 @@ const path = require('path')
 fastify.register(require('@fastify/static'), {
   root: path.join(__dirname, 'public'),
   prefix: '/public/', // optional: default '/'
+  constraints: { host: 'example.com' } // optional: default {}
 })
 
 fastify.get('/another/path', function (req, reply) {
@@ -118,6 +119,13 @@ Default: `'/'`
 
 A URL path prefix used to create a virtual mount path for the static directory.
 
+#### `constraints`
+
+Default: `{}`
+
+Constraints that will be added to registered routes. See Fastify's documentation for
+[route constraints](https://www.fastify.io/docs/latest/Reference/Routes/#constraints).
+
 #### `prefixAvoidTrailingSlash`
 
 Default: `false`
@@ -201,7 +209,7 @@ 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`
+#### `serveDotFiles`
 
 Default: `false`
 

package/index.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const path = require('path')
+const url = require('url')
 const statSync = require('fs').statSync
 const { PassThrough } = require('readable-stream')
 const glob = require('glob')
@@ -14,6 +15,7 @@ const encodingNegotiator = require('@fastify/accept-negotiator')
 const dirList = require('./lib/dirList')
 
 async function fastifyStatic (fastify, opts) {
+  opts.root = normalizeRoot(opts.root)
   checkRootPathForErrors(fastify, opts.root)
 
   const setHeaders = opts.setHeaders
@@ -278,6 +280,7 @@ async function fastifyStatic (fastify, opts) {
 
   // Set the schema hide property if defined in opts or true by default
   const routeOpts = {
+    constraints: opts.constraints,
     schema: {
       hide: typeof opts.schemaHide !== 'undefined' ? opts.schemaHide : true
     },
@@ -393,6 +396,29 @@ async function fastifyStatic (fastify, opts) {
     pumpSendToReply(req, reply, file, rootPath)
   }
 }
+function normalizeRoot (root) {
+  if (root === undefined) {
+    return root
+  }
+  if (root instanceof URL && root.protocol === 'file:') {
+    return url.fileURLToPath(root)
+  }
+  if (Array.isArray(root)) {
+    const result = []
+    for (let i = 0, il = root.length; i < il; ++i) {
+      if (root[i] instanceof URL && root[i].protocol === 'file:') {
+        result.push(url.fileURLToPath(root[i]))
+      } else {
+        result.push(root[i])
+      }
+    }
+
+    return result
+  }
+
+  return root
+}
+
 function checkRootPathForErrors (fastify, rootPath) {
   if (rootPath === undefined) {
     throw new Error('"root" option is required')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastify/static",
-  "version": "6.9.0",
+  "version": "6.10.1",
   "description": "Plugin for serving static files as fast as possible.",
   "main": "index.js",
   "types": "types/index.d.ts",
@@ -54,7 +54,7 @@
     "snazzy": "^9.0.0",
     "standard": "^17.0.0",
     "tap": "^16.0.0",
-    "tsd": "^0.25.0"
+    "tsd": "^0.28.0"
   },
   "tsd": {
     "directory": "test/types"

package/test/static.test.js

@@ -625,6 +625,59 @@ t.test('register /static and /static2', (t) => {
   })
 })
 
+t.test('register /static with constraints', (t) => {
+  t.plan(3)
+
+  const pluginOptions = {
+    root: path.join(__dirname, '/static'),
+    prefix: '/static',
+    constraints: {
+      host: 'example.com'
+    }
+  }
+  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('example.com/static/index.html', (t) => {
+      t.plan(3 + GENERIC_RESPONSE_CHECK_COUNT)
+      simple.concat({
+        method: 'GET',
+        url: 'http://localhost:' + fastify.server.address().port + '/static/index.html',
+        headers: {
+          host: 'example.com'
+        }
+      }, (err, response, body) => {
+        t.error(err)
+        t.equal(response.statusCode, 200)
+        t.equal(body.toString(), indexContent)
+        genericResponseChecks(t, response)
+      })
+    })
+
+    t.test('not-example.com/static/index.html', (t) => {
+      t.plan(2 + GENERIC_ERROR_RESPONSE_CHECK_COUNT)
+      simple.concat({
+        method: 'GET',
+        url: 'http://localhost:' + fastify.server.address().port + '/static/index.html',
+        headers: {
+          host: 'not-example.com'
+        }
+      }, (err, response, body) => {
+        t.error(err)
+        t.equal(response.statusCode, 404)
+        genericErrorResponseChecks(t, response)
+      })
+    })
+  })
+})
+
 t.test('payload.filename is set', (t) => {
   t.plan(3)
 
@@ -3703,3 +3756,50 @@ t.test(
     t.end()
   }
 )
+t.test(
+  'converts URL to path',
+  async (t) => {
+    t.plan(2 + GENERIC_RESPONSE_CHECK_COUNT)
+    const pluginOptions = {
+      root: url.pathToFileURL(path.join(__dirname, '/static'))
+    }
+
+    const fastify = Fastify()
+
+    fastify.register(fastifyStatic, pluginOptions)
+    const response = await fastify.inject({
+      method: 'GET',
+      url: 'foobar.html',
+      headers: {
+        'accept-encoding': '*, *'
+      }
+    })
+    genericResponseChecks(t, response)
+    t.equal(response.statusCode, 200)
+    t.same(response.body, foobarContent)
+  }
+)
+
+t.test(
+  'converts array of URLs to path, contains string path',
+  async (t) => {
+    t.plan(2 + GENERIC_RESPONSE_CHECK_COUNT)
+    const pluginOptions = {
+      root: [url.pathToFileURL(path.join(__dirname, '/static')), path.join(__dirname, 'static-dotfiles'), url.pathToFileURL(path.join(__dirname, '/static-pre-compressed'))]
+    }
+
+    const fastify = Fastify()
+
+    fastify.register(fastifyStatic, pluginOptions)
+    const response = await fastify.inject({
+      method: 'GET',
+      url: 'foobar.html',
+      headers: {
+        'accept-encoding': '*, *'
+      }
+    })
+    genericResponseChecks(t, response)
+    t.equal(response.statusCode, 200)
+    t.same(response.body, foobarContent)
+  }
+)

package/types/index.d.ts

@@ -2,7 +2,7 @@
 //                 Leo <https://github.com/leomelzer>
 /// <reference types="node" />
 
-import { FastifyPluginAsync, FastifyRequest } from 'fastify';
+import {FastifyPluginAsync, FastifyRequest, RouteOptions} from 'fastify';
 import { Stats } from 'fs';
 
 declare module "fastify" {
@@ -104,6 +104,7 @@ declare namespace fastifyStatic {
     index?: string[] | string | false;
     lastModified?: boolean;
     maxAge?: string | number;
+    constraints?: RouteOptions['constraints'];
   }
 
   export const fastifyStatic: FastifyStaticPlugin;

package/types/index.test-d.ts

@@ -3,7 +3,7 @@ import { Server } from 'http';
 import { expectAssignable, expectError, expectType } from 'tsd'
 import * as fastifyStaticStar from '..';
 import fastifyStatic, {
-  FastifyStaticOptions, 
+  FastifyStaticOptions,
   fastifyStatic as fastifyStaticNamed,
 } from '..'
 
@@ -55,6 +55,10 @@ const options: FastifyStaticOptions = {
   preCompressed: false,
   allowedPath: (pathName: string, root: string, request: FastifyRequest) => {
     return true;
+  },
+  constraints: {
+    host: /.*\.example\.com/,
+    version: '1.0.2'
   }
 }