Use glob to avoid setting a wildcard route (#83)

* Use glob to avoid setting a wildcard route

* removed spurious log

* README update

* remove useless replace for windows

Author: mcollina

README.md

@@ -71,6 +71,18 @@ The following options are also supported and will be passed directly to the
 - [`lastModified`](https://www.npmjs.com/package/send#lastmodified)
 - [`maxAge`](https://www.npmjs.com/package/send#maxage)
 
+#### `wildcard`
+
+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, and just creates the routes needed for
+those.
+
+The default options of https://www.npmjs.com/package/glob are applied
+for getting the file list.
+
 #### Disable serving
 
 If you'd just like to use the reply decorator and not serve whole directories automatically, you can simply pass the option `{ serve: false }`. This will prevent the plugin from serving everything under `root`.

index.js

@@ -3,6 +3,7 @@
 const path = require('path')
 const statSync = require('fs').statSync
 const { PassThrough } = require('readable-stream')
+const glob = require('glob')
 
 const send = require('send')
 
@@ -91,18 +92,44 @@ function fastifyStatic (fastify, opts, next) {
   // Set the schema hide property if defined in opts or true by default
   const schema = { schema: { hide: typeof opts.schemaHide !== 'undefined' ? opts.schemaHide : true } }
 
-  if (opts.serve !== false) {
-    fastify.get(prefix + '*', schema, function (req, reply) {
-      pumpSendToReply(req, reply, '/' + req.params['*'])
-    })
-  }
-
   if (opts.decorateReply !== false) {
     fastify.decorateReply('sendFile', function (filePath) {
       pumpSendToReply(this.request, this, filePath)
     })
   }
 
+  if (opts.serve !== false) {
+    if (opts.wildcard === undefined || opts.wildcard === true) {
+      fastify.get(prefix + '*', schema, function (req, reply) {
+        pumpSendToReply(req, reply, '/' + req.params['*'])
+      })
+    } else {
+      glob(path.join(sendOptions.root, '**/*'), function (err, files) {
+        if (err) {
+          return next(err)
+        }
+        for (let file of files) {
+          file = file.replace(sendOptions.root, '')
+          const route = (prefix + file).replace(/^\/\//, '/')
+          fastify.get(route, schema, function (req, reply) {
+            pumpSendToReply(req, reply, '/' + file)
+          })
+
+          if (file.match(/index\.html$/)) {
+            const route2 = route.replace(/index\.html$/, '')
+            fastify.get(route2, schema, function (req, reply) {
+              pumpSendToReply(req, reply, '/' + file)
+            })
+          }
+        }
+        next()
+      })
+
+      // return early to avoid calling next afterwards
+      return
+    }
+  }
+
   next()
 }
 

package.json

@@ -27,6 +27,7 @@
   "homepage": "https://github.com/fastify/fastify-static",
   "dependencies": {
     "fastify-plugin": "^1.2.0",
+    "glob": "^7.1.3",
     "readable-stream": "^3.0.2",
     "send": "^0.16.0"
   },

test/static.test.js

@@ -974,3 +974,115 @@ t.test('register /static/ without schemaHide', t => {
     })
   })
 })
+
+t.test('register with wildcard false', t => {
+  t.plan(8)
+
+  const pluginOptions = {
+    root: path.join(__dirname, '/static'),
+    wildcard: false
+  }
+  const fastify = Fastify()
+  fastify.register(fastifyStatic, pluginOptions)
+
+  fastify.get('/*', (request, reply) => {
+    reply.send({ hello: 'world' })
+  })
+
+  t.tearDown(fastify.close.bind(fastify))
+
+  fastify.listen(0, err => {
+    t.error(err)
+
+    fastify.server.unref()
+
+    t.test('/index.html', t => {
+      t.plan(3 + GENERIC_RESPONSE_CHECK_COUNT)
+      simple.concat({
+        method: 'GET',
+        url: 'http://localhost:' + fastify.server.address().port + '/index.html'
+      }, (err, response, body) => {
+        t.error(err)
+        t.strictEqual(response.statusCode, 200)
+        t.strictEqual(body.toString(), indexContent)
+        genericResponseChecks(t, response)
+      })
+    })
+
+    t.test('/index.css', t => {
+      t.plan(2 + GENERIC_RESPONSE_CHECK_COUNT)
+      simple.concat({
+        method: 'GET',
+        url: 'http://localhost:' + fastify.server.address().port + '/index.css'
+      }, (err, response, body) => {
+        t.error(err)
+        t.strictEqual(response.statusCode, 200)
+        genericResponseChecks(t, response)
+      })
+    })
+
+    t.test('/', t => {
+      t.plan(3 + GENERIC_RESPONSE_CHECK_COUNT)
+      simple.concat({
+        method: 'GET',
+        url: 'http://localhost:' + fastify.server.address().port
+      }, (err, response, body) => {
+        t.error(err)
+        t.strictEqual(response.statusCode, 200)
+        t.strictEqual(body.toString(), indexContent)
+        genericResponseChecks(t, response)
+      })
+    })
+
+    t.test('/not-defined', t => {
+      t.plan(3)
+      simple.concat({
+        method: 'GET',
+        url: 'http://localhost:' + fastify.server.address().port + '/not-defined'
+      }, (err, response, body) => {
+        t.error(err)
+        t.strictEqual(response.statusCode, 200)
+        t.deepEqual(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 + '/deep/path/for/test/purpose/foo.html'
+      }, (err, response, body) => {
+        t.error(err)
+        t.strictEqual(response.statusCode, 200)
+        t.strictEqual(body.toString(), deepContent)
+        genericResponseChecks(t, response)
+      })
+    })
+
+    t.test('/deep/path/for/test/', t => {
+      t.plan(3 + GENERIC_RESPONSE_CHECK_COUNT)
+      simple.concat({
+        method: 'GET',
+        url: 'http://localhost:' + fastify.server.address().port + '/deep/path/for/test/'
+      }, (err, response, body) => {
+        t.error(err)
+        t.strictEqual(response.statusCode, 200)
+        t.strictEqual(body.toString(), innerIndex)
+        genericResponseChecks(t, response)
+      })
+    })
+
+    t.test('/../index.js', t => {
+      t.plan(3)
+      simple.concat({
+        method: 'GET',
+        url: 'http://localhost:' + fastify.server.address().port + '/../index.js',
+        followRedirect: false
+      }, (err, response, body) => {
+        t.error(err)
+        t.strictEqual(response.statusCode, 200)
+        t.deepEqual(JSON.parse(body), { hello: 'world' })
+      })
+    })
+  })
+})