@fastify/static 6.11.0 → 6.11.2

package/README.md

@@ -21,7 +21,7 @@ Plugin for serving static files as fast as possible. Supports Fastify version `4
 
 ```js
 const fastify = require('fastify')({logger: true})
-const path = require('path')
+const path = require('node:path')
 
 fastify.register(require('@fastify/static'), {
   root: path.join(__dirname, 'public'),
@@ -57,7 +57,7 @@ fastify.listen({ port: 3000 }, (err, address) => {
 ```js
 const fastify = require('fastify')()
 const fastifyStatic = require('@fastify/static')
-const path = require('path')
+const path = require('node:path')
 // first plugin
 fastify.register(fastifyStatic, {
   root: path.join(__dirname, 'public')
@@ -76,7 +76,7 @@ fastify.register(fastifyStatic, {
 
 ```js
 const fastify = require('fastify')()
-const path = require('path')
+const path = require('node:path')
 
 fastify.register(require('@fastify/static'), {
   root: path.join(__dirname, 'public'),

package/example/server-compress.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const path = require('path')
+const path = require('node:path')
 const fastify = require('fastify')({ logger: { level: 'trace' } })
 
 fastify

package/example/server-dir-list.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const path = require('path')
+const path = require('node:path')
 const Handlebars = require('handlebars')
 
 const fastify = require('fastify')({ logger: { level: 'trace' } })

package/example/server-hidden-file.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const path = require('path')
+const path = require('node:path')
 const fastify = require('fastify')({ logger: { level: 'trace' } })
 
 fastify

package/example/server.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const path = require('path')
+const path = require('node:path')
 const fastify = require('fastify')({ logger: { level: 'trace' } })
 
 fastify

package/index.js

@@ -1,27 +1,34 @@
 'use strict'
 
-const path = require('path')
-const url = require('url')
-const statSync = require('fs').statSync
-const { PassThrough } = require('readable-stream')
+const { PassThrough } = require('node:stream')
+const path = require('node:path')
+const { fileURLToPath } = require('node:url')
+const { statSync } = require('node:fs')
+const { promisify } = require('node:util')
 const glob = require('glob')
-const send = require('@fastify/send')
-const contentDisposition = require('content-disposition')
+const globPromise = promisify(glob)
 const fp = require('fastify-plugin')
-const util = require('util')
-const globPromise = util.promisify(glob)
+const send = require('@fastify/send')
 const encodingNegotiator = require('@fastify/accept-negotiator')
-
-send.mime.default_type = 'application/octet-stream'
+const contentDisposition = require('content-disposition')
 
 const dirList = require('./lib/dirList')
 
+const winSeparatorRegex = new RegExp(`\\${path.win32.sep}`, 'g')
+const backslashRegex = /\\/g
+const startForwardSlashRegex = /^\//
+const endForwardSlashRegex = /\/$/
+const doubleForwardSlashRegex = /\/\//g
+const asteriskRegex = /\*/g
+
+const supportedEncodings = ['br', 'gzip', 'deflate']
+send.mime.default_type = 'application/octet-stream'
+
 async function fastifyStatic (fastify, opts) {
   opts.root = normalizeRoot(opts.root)
   checkRootPathForErrors(fastify, opts.root)
 
   const setHeaders = opts.setHeaders
-
   if (setHeaders !== undefined && typeof setHeaders !== 'function') {
     throw new TypeError('The `setHeaders` option must be a function')
   }
@@ -48,19 +55,124 @@ async function fastifyStatic (fastify, opts) {
     maxAge: opts.maxAge
   }
 
-  const allowedPath = opts.allowedPath
-
-  if (opts.prefix === undefined) opts.prefix = '/'
-
-  let prefix = opts.prefix
+  let prefix = opts.prefix ?? (opts.prefix = '/')
 
   if (!opts.prefixAvoidTrailingSlash) {
     prefix =
-      opts.prefix[opts.prefix.length - 1] === '/'
-        ? opts.prefix
-        : opts.prefix + '/'
+      prefix[prefix.length - 1] === '/'
+        ? prefix
+        : prefix + '/'
+  }
+
+  // Set the schema hide property if defined in opts or true by default
+  const routeOpts = {
+    constraints: opts.constraints,
+    schema: {
+      hide: opts.schemaHide !== undefined ? opts.schemaHide : true
+    },
+    errorHandler (error, request, reply) {
+      if (error?.code === 'ERR_STREAM_PREMATURE_CLOSE') {
+        reply.request.raw.destroy()
+        return
+      }
+
+      fastify.errorHandler(error, request, reply)
+    }
+  }
+
+  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
+      pumpSendToReply(
+        this.request,
+        this,
+        filePath,
+        root || sendOptions.root,
+        0,
+        opts
+      )
+      return this
+    })
+
+    fastify.decorateReply(
+      'download',
+      function (filePath, fileName, options = {}) {
+        const { root, ...opts } =
+          typeof fileName === 'object' ? fileName : options
+        fileName = typeof fileName === 'string' ? fileName : filePath
+
+        // Set content disposition header
+        this.header('content-disposition', contentDisposition(fileName))
+
+        pumpSendToReply(this.request, this, filePath, root, 0, opts)
+
+        return this
+      }
+    )
+  }
+
+  if (opts.serve !== false) {
+    if (opts.wildcard && typeof opts.wildcard !== 'boolean') {
+      throw new Error('"wildcard" option must be a boolean')
+    }
+    if (opts.wildcard === undefined || opts.wildcard === true) {
+      fastify.head(prefix + '*', routeOpts, function (req, reply) {
+        pumpSendToReply(req, reply, '/' + req.params['*'], sendOptions.root)
+      })
+      fastify.get(prefix + '*', routeOpts, function (req, reply) {
+        pumpSendToReply(req, reply, '/' + req.params['*'], sendOptions.root)
+      })
+      if (opts.redirect === true && prefix !== opts.prefix) {
+        fastify.get(opts.prefix, routeOpts, function (req, reply) {
+          reply.redirect(301, getRedirectUrl(req.raw.url))
+        })
+      }
+    } else {
+      const globPattern = '**/**'
+      const indexDirs = new Map()
+      const routes = new Set()
+
+      const roots = Array.isArray(sendOptions.root) ? sendOptions.root : [sendOptions.root]
+      for (let i = 0; i < roots.length; ++i) {
+        const rootPath = roots[i]
+        const files = await globPromise(path.join(rootPath, globPattern).replace(winSeparatorRegex, path.posix.sep), { nodir: true, dot: opts.serveDotFiles })
+        const indexes = opts.index === undefined ? ['index.html'] : [].concat(opts.index)
+
+        for (let i = 0; i < files.length; ++i) {
+          const file = files[i].replace(rootPath.replace(backslashRegex, '/'), '')
+            .replace(startForwardSlashRegex, '')
+          const route = (prefix + file).replace(doubleForwardSlashRegex, '/')
+
+          if (routes.has(route)) {
+            continue
+          }
+
+          routes.add(route)
+
+          setUpHeadAndGet(routeOpts, route, '/' + file, rootPath)
+
+          const key = path.posix.basename(route)
+          if (indexes.includes(key) && !indexDirs.has(key)) {
+            indexDirs.set(path.posix.dirname(route), rootPath)
+          }
+        }
+      }
+
+      for (const [dirname, rootPath] of indexDirs.entries()) {
+        const pathname = dirname + (dirname.endsWith('/') ? '' : '/')
+        const file = '/' + pathname.replace(prefix, '')
+        setUpHeadAndGet(routeOpts, pathname, file, rootPath)
+
+        if (opts.redirect === true) {
+          setUpHeadAndGet(routeOpts, pathname.replace(endForwardSlashRegex, ''), file.replace(endForwardSlashRegex, ''), rootPath)
+        }
+      }
+    }
   }
 
+  const allowedPath = opts.allowedPath
+
   function pumpSendToReply (
     request,
     reply,
@@ -271,121 +383,12 @@ async function fastifyStatic (fastify, opts) {
     stream.pipe(wrap)
   }
 
-  const errorHandler = (error, request, reply) => {
-    if (error && error.code === 'ERR_STREAM_PREMATURE_CLOSE') {
-      reply.request.raw.destroy()
-      return
-    }
-
-    fastify.errorHandler(error, request, reply)
-  }
-
-  // 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
-    },
-    errorHandler
-  }
-
-  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
-      pumpSendToReply(
-        this.request,
-        this,
-        filePath,
-        root || sendOptions.root,
-        0,
-        opts
-      )
-      return this
-    })
-
-    fastify.decorateReply(
-      'download',
-      function (filePath, fileName, options = {}) {
-        const { root, ...opts } =
-          typeof fileName === 'object' ? fileName : options
-        fileName = typeof fileName === 'string' ? fileName : filePath
-
-        // Set content disposition header
-        this.header('content-disposition', contentDisposition(fileName))
-
-        pumpSendToReply(this.request, this, filePath, root, 0, opts)
-
-        return this
-      }
-    )
-  }
-
-  if (opts.serve !== false) {
-    if (opts.wildcard && typeof opts.wildcard !== 'boolean') {
-      throw new Error('"wildcard" option must be a boolean')
-    }
-    if (opts.wildcard === undefined || opts.wildcard === true) {
-      fastify.head(prefix + '*', routeOpts, function (req, reply) {
-        pumpSendToReply(req, reply, '/' + req.params['*'], sendOptions.root)
-      })
-      fastify.get(prefix + '*', routeOpts, function (req, reply) {
-        pumpSendToReply(req, reply, '/' + req.params['*'], sendOptions.root)
-      })
-      if (opts.redirect === true && prefix !== opts.prefix) {
-        fastify.get(opts.prefix, routeOpts, function (req, reply) {
-          reply.redirect(301, getRedirectUrl(req.raw.url))
-        })
-      }
-    } else {
-      const globPattern = '**/**'
-      const indexDirs = new Map()
-      const routes = new Set()
-
-      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, dot: opts.serveDotFiles })
-        const indexes = typeof opts.index === 'undefined' ? ['index.html'] : [].concat(opts.index)
-
-        for (let file of files) {
-          file = file
-            .replace(rootPath.replace(/\\/g, '/'), '')
-            .replace(/^\//, '')
-          const route = (prefix + file).replace(/\/\//g, '/')
-          if (routes.has(route)) {
-            continue
-          }
-          routes.add(route)
-
-          setUpHeadAndGet(routeOpts, route, '/' + file, rootPath)
-
-          const key = path.posix.basename(route)
-          if (indexes.includes(key) && !indexDirs.has(key)) {
-            indexDirs.set(path.posix.dirname(route), rootPath)
-          }
-        }
-      }
-
-      for (const [dirname, rootPath] of indexDirs.entries()) {
-        const pathname = dirname + (dirname.endsWith('/') ? '' : '/')
-        const file = '/' + pathname.replace(prefix, '')
-        setUpHeadAndGet(routeOpts, pathname, file, rootPath)
-
-        if (opts.redirect === true) {
-          setUpHeadAndGet(routeOpts, pathname.replace(/\/$/, ''), file.replace(/\/$/, ''), rootPath)
-        }
-      }
-    }
-  }
-
   function setUpHeadAndGet (routeOpts, route, file, rootPath) {
-    const toSetUp = {
-      ...routeOpts,
+    const toSetUp = Object.assign({}, routeOpts, {
       method: ['HEAD', 'GET'],
       url: route,
       handler: serveFileHandler
-    }
+    })
     toSetUp.config = toSetUp.config || {}
     toSetUp.config.file = file
     toSetUp.config.rootPath = rootPath
@@ -393,9 +396,10 @@ async function fastifyStatic (fastify, opts) {
   }
 
   function serveFileHandler (req, reply) {
-    const file = req.routeConfig.file
-    const rootPath = req.routeConfig.rootPath
-    pumpSendToReply(req, reply, file, rootPath)
+    // TODO: remove the fallback branch when bump major
+    /* istanbul ignore next */
+    const routeConfig = req.routeOptions?.config || req.routeConfig
+    pumpSendToReply(req, reply, routeConfig.file, routeConfig.rootPath)
   }
 }
 
@@ -404,13 +408,13 @@ function normalizeRoot (root) {
     return root
   }
   if (root instanceof URL && root.protocol === 'file:') {
-    return url.fileURLToPath(root)
+    return 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]))
+        result.push(fileURLToPath(root[i]))
       } else {
         result.push(root[i])
       }
@@ -503,13 +507,13 @@ 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
 
-  const header = headers['accept-encoding'].toLowerCase().replace(/\*/g, 'gzip')
+  // consider the no-preference token as gzip for downstream compat
+  const header = headers['accept-encoding'].toLowerCase().replace(asteriskRegex, 'gzip')
+
   return encodingNegotiator.negotiate(
     header,
     supportedEncodings.filter((enc) => !checked.has(enc))
@@ -529,14 +533,15 @@ function getEncodingExtension (encoding) {
 function getRedirectUrl (url) {
   let i = 0
   // we detect how many slash before a valid path
-  for (i; i < url.length; i++) {
+  for (; i < url.length; ++i) {
     if (url[i] !== '/' && url[i] !== '\\') break
   }
   // turns all leading / or \ into a single /
   url = '/' + url.substr(i)
   try {
     const parsed = new URL(url, 'http://localhost.com/')
-    return parsed.pathname + (parsed.pathname[parsed.pathname.length - 1] !== '/' ? '/' : '') + (parsed.search || '')
+    const parsedPathname = parsed.pathname
+    return parsedPathname + (parsedPathname[parsedPathname.length - 1] !== '/' ? '/' : '') + (parsed.search || '')
   } catch (error) {
     // the try-catch here is actually unreachable, but we keep it for safety and prevent DoS attack
     /* istanbul ignore next */

package/lib/dirList.js

@@ -1,7 +1,7 @@
 'use strict'
 
-const path = require('path')
-const fs = require('fs').promises
+const path = require('node:path')
+const fs = require('node:fs/promises')
 const pLimit = require('p-limit')
 
 const dirList = {
@@ -16,7 +16,7 @@ const dirList = {
     const entries = { dirs: [], files: [] }
     let files = await fs.readdir(dir)
     if (dotfiles === 'deny' || dotfiles === 'ignore') {
-      files = files.filter(f => f.charAt(0) !== '.')
+      files = files.filter(file => file.charAt(0) !== '.')
     }
     if (files.length < 1) {
       return entries
@@ -92,6 +92,7 @@ const dirList = {
 
     entries.dirs.sort((a, b) => a.name.localeCompare(b.name))
     entries.files.sort((a, b) => a.name.localeCompare(b.name))
+
     return entries
   },
 
@@ -141,7 +142,7 @@ const dirList = {
    * @return {ListFile}
    */
   htmlInfo: function (entry, route, prefix, options) {
-    if (options.names && options.names.includes(path.basename(route))) {
+    if (options.names?.includes(path.basename(route))) {
       route = path.normalize(path.join(route, '..'))
     }
     return {
@@ -159,12 +160,9 @@ const dirList = {
    * @return {boolean}
    */
   handle: function (route, options) {
-    if (!options.names) {
-      return false
-    }
-    return options.names.includes(path.basename(route)) ||
+    return options.names?.includes(path.basename(route)) ||
       // match trailing slash
-      (options.names.includes('/') && route[route.length - 1] === '/')
+      ((options.names?.includes('/') && route[route.length - 1] === '/') ?? false)
   },
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastify/static",
-  "version": "6.11.0",
+  "version": "6.11.2",
   "description": "Plugin for serving static files as fast as possible.",
   "main": "index.js",
   "types": "types/index.d.ts",
@@ -35,8 +35,7 @@
     "content-disposition": "^0.5.3",
     "fastify-plugin": "^4.0.0",
     "glob": "^8.0.1",
-    "p-limit": "^3.1.0",
-    "readable-stream": "^4.0.0"
+    "p-limit": "^3.1.0"
   },
   "devDependencies": {
     "@fastify/compress": "^6.0.0",
@@ -55,7 +54,7 @@
     "snazzy": "^9.0.0",
     "standard": "^17.0.0",
     "tap": "^16.0.0",
-    "tsd": "^0.28.0",
+    "tsd": "^0.29.0",
     "typescript": "^5.1.6"
   },
   "tsd": {

package/test/content-type.test.js

@@ -2,7 +2,7 @@
 
 /* eslint n/no-deprecated-api: "off" */
 
-const path = require('path')
+const path = require('node:path')
 const { test } = require('tap')
 const simple = require('simple-get')
 const Fastify = require('fastify')

package/test/dir-list.test.js

@@ -2,8 +2,8 @@
 
 /* eslint n/no-deprecated-api: "off" */
 
-const fs = require('fs')
-const path = require('path')
+const fs = require('node:fs')
+const path = require('node:path')
 const t = require('tap')
 const simple = require('simple-get')
 const Fastify = require('fastify')

package/test/static.test.js

@@ -2,10 +2,10 @@
 
 /* eslint n/no-deprecated-api: "off" */
 
-const path = require('path')
-const fs = require('fs')
-const url = require('url')
-const http = require('http')
+const path = require('node:path')
+const fs = require('node:fs')
+const url = require('node:url')
+const http = require('node:http')
 const t = require('tap')
 const simple = require('simple-get')
 const Fastify = require('fastify')
@@ -2823,7 +2823,7 @@ t.test(
   'register with rootpath that causes statSync to fail with non-ENOENT code',
   (t) => {
     const fastifyStatic = proxyquire('../', {
-      fs: {
+      'node:fs': {
         statSync: function statSyncStub (path) {
           throw new Error({ code: 'MOCK' })
         }