@fastify/static 6.10.2 → 6.11.0

package/.eslintrc.json

@@ -0,0 +1,51 @@
+{
+    "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:@typescript-eslint/recommended",
+      "standard"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "plugins": ["@typescript-eslint"],
+    "env": { "node": true },
+    "parserOptions": {
+      "ecmaVersion": 6,
+      "sourceType": "module",
+      "project": "./tsconfig.eslint.json",
+      "createDefaultProgram": true
+    },
+    "rules": {
+      "no-console": "off",
+      "@typescript-eslint/indent": ["error", 2],
+      "semi": ["error", "never"],
+      "import/export": "off" // this errors on multiple exports (overload interfaces)
+    },
+    "overrides": [
+      {
+        "files": ["*.d.ts","*.test-d.ts"],
+        "rules": {
+          "no-use-before-define": "off",
+          "no-redeclare": "off",
+          "@typescript-eslint/no-explicit-any": "off"
+        }
+      },
+      {
+        "files": ["*.test-d.ts"],
+        "rules": {
+          "@typescript-eslint/no-var-requires": "off",
+          "no-unused-vars": "off",
+          "n/handle-callback-err": "off",
+          "@typescript-eslint/no-empty-function": "off",
+          "@typescript-eslint/explicit-function-return-type": "off",
+          "@typescript-eslint/no-unused-vars": "off",
+          "@typescript-eslint/no-non-null-assertion": "off",
+          "@typescript-eslint/no-misused-promises": ["error", {
+            "checksVoidReturn": false
+          }]
+        },
+        "globals": {
+          "NodeJS": "readonly"
+        }
+      }
+    ]
+  }

package/.taprc

@@ -0,0 +1,2 @@
+files:
+  - test/**/*.test.js

package/README.md

@@ -452,6 +452,25 @@ 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://www.fastify.io/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:
+
+```js
+const app = require('fastify')();
+
+app.register((childContext, _, done) => {
+    childContext.register(require('@fastify/static'), {
+        root: path.join(__dirname, 'docs'), // docs is a folder that contains `index.html` and `404.html`
+        wildcard: false
+    });
+    childContext.setNotFoundHandler((_, reply) => {
+        return reply.code(404).type('text/html').sendFile('404.html');
+    });
+    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`. 
+
 ### Handling Errors
 
 If an error occurs while trying to send a file, the error will be passed

package/index.js

@@ -358,7 +358,7 @@ async function fastifyStatic (fastify, opts) {
           }
           routes.add(route)
 
-          setUpHeadAndGet(fastify, routeOpts, route, '/' + file, rootPath)
+          setUpHeadAndGet(routeOpts, route, '/' + file, rootPath)
 
           const key = path.posix.basename(route)
           if (indexes.includes(key) && !indexDirs.has(key)) {
@@ -370,16 +370,16 @@ async function fastifyStatic (fastify, opts) {
       for (const [dirname, rootPath] of indexDirs.entries()) {
         const pathname = dirname + (dirname.endsWith('/') ? '' : '/')
         const file = '/' + pathname.replace(prefix, '')
-        setUpHeadAndGet(fastify, routeOpts, pathname, file, rootPath)
+        setUpHeadAndGet(routeOpts, pathname, file, rootPath)
 
         if (opts.redirect === true) {
-          setUpHeadAndGet(fastify, routeOpts, pathname.replace(/\/$/, ''), file.replace(/\/$/, ''), rootPath)
+          setUpHeadAndGet(routeOpts, pathname.replace(/\/$/, ''), file.replace(/\/$/, ''), rootPath)
         }
       }
     }
   }
 
-  function setUpHeadAndGet (fastify, routeOpts, route, file, rootPath) {
+  function setUpHeadAndGet (routeOpts, route, file, rootPath) {
     const toSetUp = {
       ...routeOpts,
       method: ['HEAD', 'GET'],
@@ -398,6 +398,7 @@ async function fastifyStatic (fastify, opts) {
     pumpSendToReply(req, reply, file, rootPath)
   }
 }
+
 function normalizeRoot (root) {
   if (root === undefined) {
     return root
@@ -475,8 +476,6 @@ function checkPath (fastify, rootPath) {
   }
 }
 
-const supportedEncodings = ['br', 'gzip', 'deflate']
-
 function getContentType (path) {
   const type = send.mime.getType(path) || send.mime.default_type
 
@@ -504,6 +503,8 @@ function findIndexFile (pathname, root, indexFiles = ['index.html']) {
   return false
 }
 
+const supportedEncodings = ['br', 'gzip', 'deflate']
+
 // Adapted from https://github.com/fastify/fastify-compress/blob/665e132fa63d3bf05ad37df3c20346660b71a857/index.js#L451
 function getEncodingHeader (headers, checked) {
   if (!('accept-encoding' in headers)) return

package/package.json

@@ -1,18 +1,19 @@
 {
   "name": "@fastify/static",
-  "version": "6.10.2",
+  "version": "6.11.0",
   "description": "Plugin for serving static files as fast as possible.",
   "main": "index.js",
   "types": "types/index.d.ts",
   "scripts": {
-    "lint": "standard | snazzy",
-    "lint:fix": "standard --fix",
-    "unit": "tap test/*.test.js",
-    "typescript": "tsd",
-    "test": "npm run lint && npm run unit && npm run typescript",
-    "example": "node example/server.js",
-    "coverage": "tap --cov --coverage-report=html test",
-    "coveralls": "tap test/*test.js  test/*/*.test.js --cov"
+    "coverage": "npm run test:unit -- --coverage-report=html",
+    "lint": "npm run lint:javascript && npm run lint:typescript",
+    "lint:javascript": "standard | snazzy",
+    "lint:fix": "standard --fix && npm run lint:typescript -- --fix",
+    "lint:typescript": "eslint -c .eslintrc.json types/**/*.d.ts types/**/*.test-d.ts",
+    "test": "npm run test:unit && npm run test:typescript",
+    "test:typescript": "tsd",
+    "test:unit": "tap",
+    "example": "node example/server.js"
   },
   "repository": {
     "type": "git",
@@ -29,20 +30,20 @@
   },
   "homepage": "https://github.com/fastify/fastify-static",
   "dependencies": {
-    "content-disposition": "^0.5.3",
     "@fastify/accept-negotiator": "^1.0.0",
+    "@fastify/send": "^2.0.0",
+    "content-disposition": "^0.5.3",
     "fastify-plugin": "^4.0.0",
     "glob": "^8.0.1",
     "p-limit": "^3.1.0",
-    "readable-stream": "^4.0.0",
-    "@fastify/send": "^2.0.0"
+    "readable-stream": "^4.0.0"
   },
   "devDependencies": {
     "@fastify/compress": "^6.0.0",
     "@fastify/pre-commit": "^2.0.2",
     "@types/node": "^20.1.0",
-    "@typescript-eslint/eslint-plugin": "^2.29.0",
-    "@typescript-eslint/parser": "^2.29.0",
+    "@typescript-eslint/eslint-plugin": "^6.3.0",
+    "@typescript-eslint/parser": "^6.3.0",
     "concat-stream": "^2.0.0",
     "coveralls": "^3.0.4",
     "eslint-plugin-typescript": "^0.14.0",
@@ -54,7 +55,8 @@
     "snazzy": "^9.0.0",
     "standard": "^17.0.0",
     "tap": "^16.0.0",
-    "tsd": "^0.28.0"
+    "tsd": "^0.28.0",
+    "typescript": "^5.1.6"
   },
   "tsd": {
     "directory": "test/types"

package/test/static-encode/[...]/a .md

@@ -0,0 +1 @@
+example

package/test/static.test.js

@@ -3756,6 +3756,7 @@ t.test(
     t.end()
   }
 )
+
 t.test(
   'converts URL to path',
   async (t) => {
@@ -3803,3 +3804,39 @@ t.test(
     t.same(response.body, foobarContent)
   }
 )
+
+t.test(
+  'serves files with paths that have characters modified by encodeUri when wildcard is false',
+  async (t) => {
+    const aContent = fs.readFileSync(path.join(__dirname, 'static-encode/[...]', 'a .md'), 'utf-8')
+
+    t.plan(4)
+    const pluginOptions = {
+      root: url.pathToFileURL(path.join(__dirname, '/static-encode')),
+      wildcard: false
+    }
+
+    const fastify = Fastify()
+
+    fastify.register(fastifyStatic, pluginOptions)
+    const response = await fastify.inject({
+      method: 'GET',
+      url: '[...]/a .md',
+      headers: {
+        'accept-encoding': '*, *'
+      }
+    })
+    t.equal(response.statusCode, 200)
+    t.same(response.body, aContent)
+
+    const response2 = await fastify.inject({
+      method: 'GET',
+      url: '%5B...%5D/a%20.md',
+      headers: {
+        'accept-encoding': '*, *'
+      }
+    })
+    t.equal(response2.statusCode, 200)
+    t.same(response2.body, aContent)
+  }
+)

package/tsconfig.eslint.json

@@ -0,0 +1,13 @@
+{
+    "compilerOptions": {
+      "target": "es6",
+      "lib": [ "es2015" ],
+      "module": "commonjs",
+      "noEmit": true,
+      "strict": true
+    },
+    "include": [
+      "types/*.test-d.ts",
+      "types/*.d.ts"
+    ]
+  }

package/types/index.d.ts

@@ -2,10 +2,10 @@
 //                 Leo <https://github.com/leomelzer>
 /// <reference types="node" />
 
-import {FastifyPluginAsync, FastifyRequest, RouteOptions} from 'fastify';
-import { Stats } from 'fs';
+import { FastifyPluginAsync, FastifyRequest, RouteOptions } from 'fastify'
+import { Stats } from 'fs'
 
-declare module "fastify" {
+declare module 'fastify' {
   interface FastifyReply {
     sendFile(filename: string, rootPath?: string): FastifyReply;
     sendFile(filename: string, options?: fastifyStatic.SendOptions): FastifyReply;
@@ -77,7 +77,7 @@ declare namespace fastifyStatic {
   }
 
   export interface FastifyStaticOptions extends SendOptions {
-    root: string | string[];
+    root: string | string[] | URL | URL[];
     prefix?: string;
     prefixAvoidTrailingSlash?: boolean;
     serve?: boolean;
@@ -107,9 +107,9 @@ declare namespace fastifyStatic {
     constraints?: RouteOptions['constraints'];
   }
 
-  export const fastifyStatic: FastifyStaticPlugin;
+  export const fastifyStatic: FastifyStaticPlugin
 
-  export { fastifyStatic as default };
+  export { fastifyStatic as default }
 }
 
 declare function fastifyStatic(...params: Parameters<FastifyStaticPlugin>): ReturnType<FastifyStaticPlugin>;

package/types/index.test-d.ts

@@ -1,34 +1,34 @@
 import fastify, { FastifyInstance, FastifyPluginAsync, FastifyRequest } from 'fastify'
-import { Server } from 'http';
+import { Server } from 'http'
 import { expectAssignable, expectError, expectType } from 'tsd'
-import * as fastifyStaticStar from '..';
+import * as fastifyStaticStar from '..'
 import fastifyStatic, {
   FastifyStaticOptions,
-  fastifyStatic as fastifyStaticNamed,
+  fastifyStatic as fastifyStaticNamed
 } from '..'
 
 import fastifyStaticCjsImport = require('..');
-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);
-
-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);
+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)
+
+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);
+  fastifyStaticStar.fastifyStatic
+)
+expectType<any>(fastifyStaticCjs)
 
 const appWithImplicitHttp = fastify()
 const options: FastifyStaticOptions = {
@@ -54,7 +54,7 @@ const options: FastifyStaticOptions = {
   },
   preCompressed: false,
   allowedPath: (pathName: string, root: string, request: FastifyRequest) => {
-    return true;
+    return true
   },
   constraints: {
     host: /.*\.example\.com/,
@@ -70,7 +70,7 @@ expectError<FastifyStaticOptions>({
 expectAssignable<FastifyStaticOptions>({
   root: '',
   list: {
-    format: 'json',
+    format: 'json'
   }
 })
 
@@ -93,10 +93,22 @@ expectAssignable<FastifyStaticOptions>({
 expectError<FastifyStaticOptions>({
   root: '',
   list: {
-    format: 'html',
+    format: 'html'
   }
 })
 
+expectAssignable<FastifyStaticOptions>({
+  root: ['']
+})
+
+expectAssignable<FastifyStaticOptions>({
+  root: new URL('')
+})
+
+expectAssignable<FastifyStaticOptions>({
+  root: [new URL('')]
+})
+
 appWithImplicitHttp
   .register(fastifyStatic, options)
   .after(() => {
@@ -123,7 +135,7 @@ appWithHttp2
     })
 
     appWithHttp2.get('/download/2', (request, reply) => {
-      reply.download('some-file-name', 'some-filename' ,{ cacheControl: false, acceptRanges: true })
+      reply.download('some-file-name', 'some-filename', { cacheControl: false, acceptRanges: true })
     })
   })
 
@@ -168,7 +180,17 @@ noIndexApp
     noIndexApp.get('/', (request, reply) => {
       reply.send('<h1>fastify-static</h1>')
     })
-})
+  })
+
+options.root = new URL('')
+
+const URLRootApp = fastify()
+URLRootApp.register(fastifyStatic, options)
+  .after(() => {
+    URLRootApp.get('/', (request, reply) => {
+      reply.send('<h1>fastify-static</h1>')
+    })
+  })
 
 const defaultIndexApp = fastify()
 options.index = 'index.html'