npm - @fastify/static - Versions diffs - 5.0.1 → 5.0.2 - Mend

@fastify/static 5.0.1 → 5.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/README.md +1 -1
package/index.d.ts +2 -2
package/index.js +13 -10
package/package.json +1 -1
package/test/static-symbolic-link/origin/subdir/subdir/index.html +3 -0
package/test/static.test.js +74 -0
package/test/types/index.ts +13 -1

package/README.md CHANGED Viewed

@@ -159,7 +159,7 @@ Default: `true`
 If set to `true`, `@fastify/static` adds a wildcard route to serve files.
 If set to `false`, `@fastify/static` globs the filesystem for all defined
-files in the served folder (`${root}/**/*`), and just creates the routes needed for
+files in the served folder (`${root}/**/**`), and just creates the routes needed for
 those and it will not serve the newly added file on the filesystem.
 The default options of https://www.npmjs.com/package/glob are applied

package/index.d.ts CHANGED Viewed

@@ -58,7 +58,7 @@ interface SendOptions {
   etag?: boolean;
   extensions?: string[];
   immutable?: boolean;
-  index?: string[] | false;
+  index?: string[] | string | false;
   lastModified?: boolean;
   maxAge?: string | number;
 }
@@ -88,7 +88,7 @@ export interface FastifyStaticOptions extends SendOptions {
   etag?: boolean;
   extensions?: string[];
   immutable?: boolean;
-  index?: string[] | false;
+  index?: string[] | string | false;
   lastModified?: boolean;
   maxAge?: string | number;
 }

package/index.js CHANGED Viewed

@@ -326,7 +326,7 @@ async function fastifyStatic (fastify, opts) {
         })
       }
     } else {
-      const globPattern = '**/*'
+      const globPattern = '**/**'
       const indexDirs = new Map()
       const routes = new Set()
@@ -449,15 +449,18 @@ function getContentType (path) {
 }
 function findIndexFile (pathname, root, indexFiles = ['index.html']) {
-  return indexFiles.find(filename => {
-    const p = path.join(root, pathname, filename)
-    try {
-      const stats = statSync(p)
-      return !stats.isDirectory()
-    } catch (e) {
-      return false
-    }
-  })
+  if (Array.isArray(indexFiles)) {
+    return indexFiles.find(filename => {
+      const p = path.join(root, pathname, filename)
+      try {
+        const stats = statSync(p)
+        return !stats.isDirectory()
+      } catch (e) {
+        return false
+      }
+    })
+  }
+  return false
 }
 // Adapted from https://github.com/fastify/fastify-compress/blob/665e132fa63d3bf05ad37df3c20346660b71a857/index.js#L451

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@fastify/static",
-  "version": "5.0.1",
+  "version": "5.0.2",
   "description": "Plugin for serving static files as fast as possible.",
   "main": "index.js",
   "types": "index.d.ts",

package/test/static-symbolic-link/origin/subdir/subdir/index.html ADDED Viewed

@@ -0,0 +1,3 @@
+<html>
+  <body>index</body>
+</html>

package/test/static.test.js CHANGED Viewed

@@ -3480,3 +3480,77 @@ t.test('should not redirect to protocol-relative locations', (t) => {
     })
   })
 })
+t.test('should not serve index if option is `false`', (t) => {
+  t.plan(3)
+  const pluginOptions = {
+    root: path.join(__dirname, '/static'),
+    prefix: '/static',
+    index: false
+  }
+  const fastify = Fastify()
+  fastify.register(fastifyStatic, pluginOptions)
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen(0, (err) => {
+    t.error(err)
+    fastify.server.unref()
+    t.test('/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'
+      }, (err, response, body) => {
+        t.error(err)
+        t.equal(response.statusCode, 200)
+        t.equal(body.toString(), indexContent)
+        genericResponseChecks(t, response)
+      })
+    })
+    t.test('/static', (t) => {
+      t.plan(2 + GENERIC_ERROR_RESPONSE_CHECK_COUNT)
+      simple.concat({
+        method: 'GET',
+        url: 'http://localhost:' + fastify.server.address().port + '/static'
+      }, (err, response, body) => {
+        t.error(err)
+        t.equal(response.statusCode, 404)
+        genericErrorResponseChecks(t, response)
+      })
+    })
+  })
+})
+t.test('should follow symbolic link without wildcard', (t) => {
+  t.plan(5)
+  const fastify = Fastify()
+  fastify.register(fastifyStatic, {
+    root: path.join(__dirname, '/static-symbolic-link'),
+    wildcard: false
+  })
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen(0, (err) => {
+    t.error(err)
+    simple.concat({
+      method: 'GET',
+      url: 'http://localhost:' + fastify.server.address().port + '/origin/subdir/subdir/index.html'
+    }, (err, response) => {
+      t.error(err)
+      t.equal(response.statusCode, 200)
+    })
+    simple.concat({
+      method: 'GET',
+      url: 'http://localhost:' + fastify.server.address().port + '/dir/symlink/subdir/subdir/index.html'
+    }, (err, response) => {
+      t.error(err)
+      t.equal(response.statusCode, 200)
+    })
+  })
+})

package/test/types/index.ts CHANGED Viewed

@@ -28,7 +28,8 @@ const options: FastifyStaticOptions = {
 }
 expectError<FastifyStaticOptions>({
-  wlidcard: '**/*'
+  root: '',
+  wildcard: '**/**'
 })
 appWithImplicitHttp
@@ -103,3 +104,14 @@ noIndexApp
       reply.send('<h1>fastify-static</h1>')
     })
 })
+const defaultIndexApp = fastify()
+options.index = 'index.html'
+defaultIndexApp
+  .register(fastifyStatic, options)
+  .after(() => {
+    defaultIndexApp.get('/', (request, reply) => {
+      reply.send('<h1>fastify-static</h1>')
+    })
+  })