Add rootPath overload parameter to sendFile function (#118)

fastify · Jan 26, 2020 · c590050 · c590050
1 parent 07b09b2
commit c590050
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,10 @@ fastify.get('/another/path', function (req, reply) {
   reply.sendFile('myHtml.html') // serving path.join(__dirname, 'public', 'myHtml.html') directly
 })
 
+fastify.get('/path/with/different/root', function (req, reply) {
+  reply.sendFile('myHtml.html', path.join(__dirname, 'build')) // serving a file from a different root location
+})
+
 ```
 
 ### Options

diff --git a/index.d.ts b/index.d.ts
@@ -13,7 +13,7 @@ type HttpResponse = ServerResponse | Http2ServerResponse;
 
 declare module "fastify" {
   interface FastifyReply<HttpResponse> {
-    sendFile(filename: string): FastifyReply<HttpResponse>;
+    sendFile(filename: string, rootPath?: string): FastifyReply<HttpResponse>;
   }
 }
 

diff --git a/index.js b/index.js
@@ -33,8 +33,14 @@ function fastifyStatic (fastify, opts, next) {
     maxAge: opts.maxAge
   }
 
-  function pumpSendToReply (request, reply, pathname) {
-    const stream = send(request.raw, pathname, sendOptions)
+  function pumpSendToReply (request, reply, pathname, rootPath) {
+    var options = Object.assign({}, sendOptions)
+
+    if (rootPath) {
+      options.root = rootPath
+    }
+
+    const stream = send(request.raw, pathname, options)
     var resolvedFilename
     stream.on('file', function (file) {
       resolvedFilename = file
@@ -106,8 +112,8 @@ function fastifyStatic (fastify, opts, next) {
   const schema = { schema: { hide: typeof opts.schemaHide !== 'undefined' ? opts.schemaHide : true } }
 
   if (opts.decorateReply !== false) {
-    fastify.decorateReply('sendFile', function (filePath) {
-      pumpSendToReply(this.request, this, filePath)
+    fastify.decorateReply('sendFile', function (filePath, rootPath) {
+      pumpSendToReply(this.request, this, filePath, rootPath)
     })
   }
 

diff --git a/test/static.test.js b/test/static.test.js
@@ -514,7 +514,7 @@ t.test('serving disabled', t => {
 })
 
 t.test('sendFile', t => {
-  t.plan(2)
+  t.plan(4)
 
   const pluginOptions = {
     root: path.join(__dirname, '/static'),
@@ -527,6 +527,10 @@ t.test('sendFile', t => {
     reply.sendFile('/index.html')
   })
 
+  fastify.get('/root/path/override/test', (request, reply) => {
+    reply.sendFile('/foo.html', path.join(__dirname, 'static', 'deep', 'path', 'for', 'test', 'purpose'))
+  })
+
   fastify.listen(0, err => {
     t.error(err)
 
@@ -545,6 +549,34 @@ t.test('sendFile', t => {
         genericResponseChecks(t, response)
       })
     })
+
+    t.test('reply.sendFile() with rootPath', t => {
+      t.plan(3 + GENERIC_RESPONSE_CHECK_COUNT)
+      simple.concat({
+        method: 'GET',
+        url: 'http://localhost:' + fastify.server.address().port + '/root/path/override/test',
+        followRedirect: false
+      }, (err, response, body) => {
+        t.error(err)
+        t.strictEqual(response.statusCode, 200)
+        t.strictEqual(body.toString(), deepContent)
+        genericResponseChecks(t, response)
+      })
+    })
+
+    t.test('reply.sendFile() again without root path', t => {
+      t.plan(3 + GENERIC_RESPONSE_CHECK_COUNT)
+      simple.concat({
+        method: 'GET',
+        url: 'http://localhost:' + fastify.server.address().port + '/foo/bar',
+        followRedirect: false
+      }, (err, response, body) => {
+        t.error(err)
+        t.strictEqual(response.statusCode, 200)
+        t.strictEqual(body.toString(), indexContent)
+        genericResponseChecks(t, response)
+      })
+    })
   })
 })