@fastify/static 7.0.0 → 7.0.2

package/index.js

@@ -13,7 +13,6 @@ const contentDisposition = require('content-disposition')
 const dirList = require('./lib/dirList')
 
 const endForwardSlashRegex = /\/$/u
-const doubleForwardSlashRegex = /\/\//gu
 const asteriskRegex = /\*/gu
 
 const supportedEncodings = ['br', 'gzip', 'deflate']
@@ -112,14 +111,11 @@ async function fastifyStatic (fastify, opts) {
       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) {
+      fastify.get(prefix + '*', { ...routeOpts, exposeHeadRoute: true }, (req, reply) => {
         pumpSendToReply(req, reply, '/' + req.params['*'], sendOptions.root)
       })
       if (opts.redirect === true && prefix !== opts.prefix) {
-        fastify.get(opts.prefix, routeOpts, function (req, reply) {
+        fastify.get(opts.prefix, routeOpts, (req, reply) => {
           reply.redirect(301, getRedirectUrl(req.raw.url))
         })
       }
@@ -127,18 +123,18 @@ async function fastifyStatic (fastify, opts) {
       const indexes = opts.index === undefined ? ['index.html'] : [].concat(opts.index)
       const indexDirs = new Map()
       const routes = new Set()
-      const globPattern = '**/**'
 
       const roots = Array.isArray(sendOptions.root) ? sendOptions.root : [sendOptions.root]
-      for (let i = 0; i < roots.length; ++i) {
-        const rootPath = roots[i]
-        const posixRootPath = rootPath.split(path.win32.sep).join(path.posix.sep)
-        const files = await glob(`${posixRootPath}/${globPattern}`, { follow: true, nodir: true, dot: opts.serveDotFiles })
+      for (let rootPath of roots) {
+        rootPath = rootPath.split(path.win32.sep).join(path.posix.sep)
+        !rootPath.endsWith('/') && (rootPath += '/')
+        const files = await glob('**/**', {
+          cwd: rootPath, absolute: false, follow: true, nodir: true, dot: opts.serveDotFiles
+        })
 
-        for (let i = 0; i < files.length; ++i) {
-          const file = files[i].split(path.win32.sep).join(path.posix.sep)
-            .replace(`${posixRootPath}/`, '')
-          const route = (prefix + file).replace(doubleForwardSlashRegex, '/')
+        for (let file of files) {
+          file = file.split(path.win32.sep).join(path.posix.sep)
+          const route = prefix + file
 
           if (routes.has(route)) {
             continue
@@ -175,9 +171,10 @@ async function fastifyStatic (fastify, opts) {
     pathname,
     rootPath,
     rootPathOffset = 0,
-    pumpOptions = {},
+    pumpOptions,
     checkedEncodings
   ) {
+    const pathnameOrig = pathname
     const options = Object.assign({}, sendOptions, pumpOptions)
 
     if (rootPath) {
@@ -350,7 +347,7 @@ async function fastifyStatic (fastify, opts) {
           return pumpSendToReply(
             request,
             reply,
-            pathname,
+            pathnameOrig,
             rootPath,
             rootPathOffset,
             undefined,

package/lib/dirList.js

@@ -1,10 +1,60 @@
 'use strict'
 
+const os = require('node:os')
 const path = require('node:path')
 const fs = require('node:fs/promises')
-const pLimit = require('p-limit')
+const fastq = require('fastq')
+const fastqConcurrency = Math.max(1, os.cpus().length - 1)
 
 const dirList = {
+  _getExtendedInfo: async function (dir, info) {
+    const depth = dir.split(path.sep).length
+    const files = await fs.readdir(dir)
+
+    const worker = async (filename) => {
+      const filePath = path.join(dir, filename)
+      let stats
+      try {
+        stats = await fs.stat(filePath)
+      } catch {
+        return
+      }
+
+      if (stats.isDirectory()) {
+        info.totalFolderCount++
+        filePath.split(path.sep).length === depth + 1 && info.folderCount++
+        await dirList._getExtendedInfo(filePath, info)
+      } else {
+        info.totalSize += stats.size
+        info.totalFileCount++
+        filePath.split(path.sep).length === depth + 1 && info.fileCount++
+        info.lastModified = Math.max(info.lastModified, stats.mtimeMs)
+      }
+    }
+    const queue = fastq.promise(worker, fastqConcurrency)
+    await Promise.all(files.map(filename => queue.push(filename)))
+  },
+
+  /**
+   * get extended info about a folder
+   * @param {string} folderPath full path fs dir
+   * @return {Promise<ExtendedInfo>}
+   */
+  getExtendedInfo: async function (folderPath) {
+    const info = {
+      totalSize: 0,
+      fileCount: 0,
+      totalFileCount: 0,
+      folderCount: 0,
+      totalFolderCount: 0,
+      lastModified: 0
+    }
+
+    await dirList._getExtendedInfo(folderPath, info)
+
+    return info
+  },
+
   /**
    * get files and dirs from dir, or error
    * @param {string} dir full path fs dir
@@ -22,8 +72,7 @@ const dirList = {
       return entries
     }
 
-    const limit = pLimit(4)
-    await Promise.all(files.map(filename => limit(async () => {
+    const worker = async (filename) => {
       let stats
       try {
         stats = await fs.stat(path.join(dir, filename))
@@ -33,62 +82,15 @@ const dirList = {
       const entry = { name: filename, stats }
       if (stats.isDirectory()) {
         if (options.extendedFolderInfo) {
-          entry.extendedInfo = await getExtendedInfo(path.join(dir, filename))
+          entry.extendedInfo = await dirList.getExtendedInfo(path.join(dir, filename))
         }
         entries.dirs.push(entry)
       } else {
         entries.files.push(entry)
       }
-    })))
-
-    async function getExtendedInfo (folderPath) {
-      const depth = folderPath.split(path.sep).length
-      let totalSize = 0
-      let fileCount = 0
-      let totalFileCount = 0
-      let folderCount = 0
-      let totalFolderCount = 0
-      let lastModified = 0
-
-      async function walk (dir) {
-        const files = await fs.readdir(dir)
-        const limit = pLimit(4)
-        await Promise.all(files.map(filename => limit(async () => {
-          const filePath = path.join(dir, filename)
-          let stats
-          try {
-            stats = await fs.stat(filePath)
-          } catch {
-            return
-          }
-
-          if (stats.isDirectory()) {
-            totalFolderCount++
-            if (filePath.split(path.sep).length === depth + 1) {
-              folderCount++
-            }
-            await walk(filePath)
-          } else {
-            totalSize += stats.size
-            totalFileCount++
-            if (filePath.split(path.sep).length === depth + 1) {
-              fileCount++
-            }
-            lastModified = Math.max(lastModified, stats.mtimeMs)
-          }
-        })))
-      }
-
-      await walk(folderPath)
-      return {
-        totalSize,
-        fileCount,
-        totalFileCount,
-        folderCount,
-        totalFolderCount,
-        lastModified
-      }
     }
+    const queue = fastq.promise(worker, fastqConcurrency)
+    await Promise.all(files.map(filename => queue.push(filename)))
 
     entries.dirs.sort((a, b) => a.name.localeCompare(b.name))
     entries.files.sort((a, b) => a.name.localeCompare(b.name))
@@ -115,6 +117,7 @@ const dirList = {
     } catch {
       return reply.callNotFound()
     }
+
     const format = reply.request.query.format || options.format
     if (format !== 'html') {
       if (options.jsonFormat !== 'extended') {
@@ -203,7 +206,6 @@ const dirList = {
       return new TypeError('The `list.render` option must be a function and is required with html format')
     }
   }
-
 }
 
 module.exports = dirList

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastify/static",
-  "version": "7.0.0",
+  "version": "7.0.2",
   "description": "Plugin for serving static files as fast as possible.",
   "main": "index.js",
   "type": "commonjs",
@@ -35,15 +35,15 @@
     "@fastify/send": "^2.0.0",
     "content-disposition": "^0.5.3",
     "fastify-plugin": "^4.0.0",
-    "glob": "^10.3.4",
-    "p-limit": "^3.1.0"
+    "fastq": "^1.17.0",
+    "glob": "^10.3.4"
   },
   "devDependencies": {
-    "@fastify/compress": "^6.0.0",
+    "@fastify/compress": "^7.0.0",
     "@fastify/pre-commit": "^2.0.2",
     "@types/node": "^20.1.0",
-    "@typescript-eslint/eslint-plugin": "^6.3.0",
-    "@typescript-eslint/parser": "^6.3.0",
+    "@typescript-eslint/eslint-plugin": "^7.1.0",
+    "@typescript-eslint/parser": "^7.1.0",
     "concat-stream": "^2.0.0",
     "coveralls": "^3.0.4",
     "eslint-plugin-typescript": "^0.14.0",

package/test/static-pre-compressed/dir-gz/index.html

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    dir-gz index
+  </body>
+</html>

package/test/static.test.js

@@ -46,6 +46,9 @@ const indexBr = fs.readFileSync(
 const dirIndexBr = fs.readFileSync(
   './test/static-pre-compressed/dir/index.html.br'
 )
+const dirIndexGz = fs.readFileSync(
+  './test/static-pre-compressed/dir-gz/index.html.gz'
+)
 const uncompressedStatic = fs
   .readFileSync('./test/static-pre-compressed/uncompressed.html')
   .toString('utf8')
@@ -2012,6 +2015,96 @@ t.test('register with wildcard false', t => {
   })
 })
 
+t.test('register with wildcard false (trailing slash in the root)', t => {
+  t.plan(6)
+
+  const pluginOptions = {
+    root: path.join(__dirname, '/static/'),
+    prefix: '/assets/',
+    index: false,
+    wildcard: false
+  }
+  const fastify = Fastify({
+    ignoreTrailingSlash: true
+  })
+  fastify.register(fastifyStatic, pluginOptions)
+
+  fastify.get('/*', (request, reply) => {
+    reply.send({ hello: 'world' })
+  })
+
+  t.teardown(fastify.close.bind(fastify))
+
+  fastify.listen({ port: 0 }, (err) => {
+    t.error(err)
+
+    fastify.server.unref()
+
+    t.test('/index.css', (t) => {
+      t.plan(2 + GENERIC_RESPONSE_CHECK_COUNT)
+      simple.concat({
+        method: 'GET',
+        url: 'http://localhost:' + fastify.server.address().port + '/assets/index.css'
+      }, (err, response, body) => {
+        t.error(err)
+        t.equal(response.statusCode, 200)
+        genericResponseChecks(t, response)
+      })
+    })
+
+    t.test('/not-defined', (t) => {
+      t.plan(3)
+      simple.concat({
+        method: 'GET',
+        url: 'http://localhost:' + fastify.server.address().port + '/assets/not-defined'
+      }, (err, response, body) => {
+        t.error(err)
+        t.equal(response.statusCode, 200)
+        t.same(JSON.parse(body), { hello: 'world' })
+      })
+    })
+
+    t.test('/deep/path/for/test/purpose/foo.html', (t) => {
+      t.plan(3 + GENERIC_RESPONSE_CHECK_COUNT)
+      simple.concat({
+        method: 'GET',
+        url: 'http://localhost:' + fastify.server.address().port + '/assets/deep/path/for/test/purpose/foo.html'
+      }, (err, response, body) => {
+        t.error(err)
+        t.equal(response.statusCode, 200)
+        t.equal(body.toString(), deepContent)
+        genericResponseChecks(t, response)
+      })
+    })
+
+    t.test('/../index.js', (t) => {
+      t.plan(3)
+      simple.concat({
+        method: 'GET',
+        url: 'http://localhost:' + fastify.server.address().port + '/assets/../index.js',
+        followRedirect: false
+      }, (err, response, body) => {
+        t.error(err)
+        t.equal(response.statusCode, 200)
+        t.same(JSON.parse(body), { hello: 'world' })
+      })
+    })
+
+    t.test('/index.css', t => {
+      t.plan(3 + GENERIC_RESPONSE_CHECK_COUNT)
+      simple.concat({
+        method: 'HEAD',
+        url: 'http://localhost:' + fastify.server.address().port + '/assets/index.css'
+      }, (err, response, body) => {
+        t.error(err)
+        t.equal(response.statusCode, 200)
+        t.equal(body.toString(), '')
+        genericResponseChecks(t, response)
+      })
+    })
+  })
+})
+
 t.test('register with wildcard string', (t) => {
   t.plan(1)
 
@@ -3406,6 +3499,35 @@ t.test(
   }
 )
 
+t.test(
+  'will serve precompressed gzip index in subdir',
+  async (t) => {
+    const pluginOptions = {
+      root: path.join(__dirname, '/static-pre-compressed'),
+      preCompressed: true
+    }
+
+    const fastify = Fastify()
+
+    fastify.register(fastifyStatic, pluginOptions)
+    t.teardown(fastify.close.bind(fastify))
+
+    const response = await fastify.inject({
+      method: 'GET',
+      url: '/dir-gz',
+      headers: {
+        'accept-encoding': 'gzip, deflate, br'
+      }
+    })
+
+    genericResponseChecks(t, response)
+    t.equal(response.headers['content-encoding'], 'gzip')
+    t.equal(response.statusCode, 200)
+    t.same(response.rawPayload, dirIndexGz)
+    t.end()
+  }
+)
+
 t.test(
   'will serve precompressed index with alternative index option',
   async (t) => {