feat: Add redirect option (#93)

* feat: Add redirect option

This adds an option to redirect requests for directories when the
tailing slash is missing.

Fixes #92

* feat: Fix `wildcard: false` handling of other options

* Support `redirect: true` for folders which provide an index file.
* Support the `index` option.

* Fix handling of query string in root redirect with wildcard

* Document incompatibility with server option ignoreTrailingSlash.

Author: coreyfarrell

README.md

@@ -73,6 +73,15 @@ 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)
 
+#### `redirect`
+
+Default: `false`
+
+If set to `true`, `fastify-static` redirects to the directory with a trailing slash.
+
+This option cannot be set to `true` with `wildcard` set to `false` on a server
+with `ignoreTrailingSlash` set to `true`.
+
 #### `wildcard`
 
 Default: `true`
@@ -85,6 +94,9 @@ those.
 The default options of https://www.npmjs.com/package/glob are applied
 for getting the file list.
 
+This option cannot be set to `false` with `redirect` set to `true` on a server
+with `ignoreTrailingSlash` set to `true`.
+
 #### 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.d.ts

@@ -18,6 +18,7 @@ declare const fastifyStatic: fastify.Plugin<Server, IncomingMessage, ServerRespo
     decorateReply?: boolean;
     schemaHide?: boolean;
     setHeaders?: (...args: any[]) => void;
+    redirect?: boolean;
 
     // Passed on to `send`
     acceptRanges?: boolean;
@@ -31,4 +32,4 @@ declare const fastifyStatic: fastify.Plugin<Server, IncomingMessage, ServerRespo
     maxAge?: string | number;
 }>;
 
-export = fastifyStatic;
+export = fastifyStatic;

index.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const path = require('path')
+const url = require('url')
 const statSync = require('fs').statSync
 const { PassThrough } = require('readable-stream')
 const glob = require('glob')
@@ -76,6 +77,13 @@ function fastifyStatic (fastify, opts, next) {
       stream.on('headers', setHeaders)
     }
 
+    if (opts.redirect === true) {
+      stream.on('directory', function (res, path) {
+        const parsed = url.parse(request.raw.url)
+        reply.redirect(301, parsed.pathname + '/' + (parsed.search || ''))
+      })
+    }
+
     stream.on('error', function (err) {
       if (err) {
         if (err.code === 'ENOENT') {
@@ -106,25 +114,44 @@ function fastifyStatic (fastify, opts, next) {
       fastify.get(prefix + '*', schema, function (req, reply) {
         pumpSendToReply(req, reply, '/' + req.params['*'])
       })
+      if (opts.redirect === true && prefix !== opts.prefix) {
+        fastify.get(opts.prefix, schema, function (req, reply) {
+          const parsed = url.parse(req.raw.url)
+          reply.redirect(301, parsed.pathname + '/' + (parsed.search || ''))
+        })
+      }
     } else {
-      glob(path.join(sendOptions.root, '**/*'), function (err, files) {
+      glob(path.join(sendOptions.root, '**/*'), { nodir: true }, function (err, files) {
         if (err) {
           return next(err)
         }
+        const indexDirs = new Set()
+        const indexes = typeof opts.index === 'undefined' ? ['index.html'] : [].concat(opts.index || [])
         for (let file of files) {
-          file = file.replace(sendOptions.root.replace(/\\/g, '/'), '')
-          const route = (prefix + file).replace(/^\/\//, '/')
+          file = file.replace(sendOptions.root.replace(/\\/g, '/'), '').replace(/^\//, '')
+          const route = (prefix + file).replace(/\/\//g, '/')
           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)
-            })
+          if (indexes.includes(path.posix.basename(route))) {
+            indexDirs.add(path.posix.dirname(route))
           }
         }
+        indexDirs.forEach(function (dirname) {
+          const pathname = dirname + (dirname.endsWith('/') ? '' : '/')
+          const file = '/' + pathname.replace(prefix, '')
+
+          fastify.get(pathname, schema, function (req, reply) {
+            pumpSendToReply(req, reply, file)
+          })
+
+          if (opts.redirect === true) {
+            fastify.get(pathname.replace(/\/$/, ''), schema, function (req, reply) {
+              pumpSendToReply(req, reply, file.replace(/\/$/, ''))
+            })
+          }
+        })
         next()
       })