feat: allow headers to be set before being served; fixes #169 ; closes #184

Author: brettz9

lib/node-static.js

@@ -11,15 +11,15 @@ import {mstat} from './node-static/util.js';
 /**
  * @typedef {{
  *   status: number,
- *   headers: Record<string, string>,
+ *   headers: http.OutgoingHttpHeaders,
  *   message?: string
  * }} ResultInfo
  */
 
 /**
  * @typedef {(
  *   status: number,
- *   headers: Record<string, string>,
+ *   headers: http.OutgoingHttpHeaders,
  *   streaming?: boolean
  * ) => void} Finish
  */
@@ -49,7 +49,7 @@ function tryStat(p, callback) {
  * @typedef {{
  *   indexFile?: string,
  *   gzip?: boolean|RegExp,
- *   headers?: Record<string, string>
+ *   headers?: http.OutgoingHttpHeaders
  *   serverInfo?: string|null,
  *   cache?: boolean|number|Record<string, number>,
  *   defaultExtension?: string
@@ -76,7 +76,7 @@ class Server extends events.EventEmitter {
         /** @type {Record<string, number>} */
         this.cache   = {'**': 3600};
 
-        /** @type {Record<string, string>} */
+        /** @type {http.OutgoingHttpHeaders} */
         this.defaultHeaders  = {};
         this.options.headers = this.options.headers || {};
 
@@ -118,16 +118,16 @@ class Server extends events.EventEmitter {
      * @param {http.ServerResponse<http.IncomingMessage> & {
      *   req: http.IncomingMessage;
      * }} res
-     * @param {(status: number, headers: Record<string, string>) => void} finish
+     * @param {(status: number, headers: http.OutgoingHttpHeaders) => void} finish
      */
     serveDir (pathname, req, res, finish) {
         const htmlIndex = path.join(pathname, this.options.indexFile);
 
         tryStat(htmlIndex, (e, stat) => {
             if (!e && stat) {
                 const status = 200;
-                /** @type {Record<string, string>} */
-                const headers = {};
+                /** @type {http.OutgoingHttpHeaders} */
+                const headers = res.getHeaders();
                 const originalPathname = decodeURIComponent(new URL(
                     /* c8 ignore next -- TS */
                     req.url ?? '',
@@ -154,15 +154,15 @@ class Server extends events.EventEmitter {
         const streamFiles = (files) => {
             mstat(pathname, files, (e, stat) => {
                 if (e || !stat) { return finish(404, {}) }
-                this.respond(pathname, 200, {}, files, stat, req, res, finish);
+                this.respond(pathname, 200, res.getHeaders(), files, stat, req, res, finish);
             });
         };
     }
 
     /**
      * @param {string} pathname
      * @param {number} status
-     * @param {Record<string, string>} headers
+     * @param {http.OutgoingHttpHeaders} headers
      * @param {http.IncomingMessage} req
      * @param {http.ServerResponse<http.IncomingMessage> & {
      *   req: http.IncomingMessage;
@@ -186,7 +186,7 @@ class Server extends events.EventEmitter {
 
     /**
      * @param {number} status
-     * @param {Record<string, string>} headers
+     * @param {http.OutgoingHttpHeaders} headers
      * @param {http.IncomingMessage} req
      * @param {http.ServerResponse<http.IncomingMessage> & {
      *   req: http.IncomingMessage;
@@ -233,7 +233,7 @@ class Server extends events.EventEmitter {
     /**
      * @param {string} pathname
      * @param {number} status
-     * @param {Record<string, string>} headers
+     * @param {http.OutgoingHttpHeaders} headers
      * @param {http.IncomingMessage} req
      * @param {http.ServerResponse<http.IncomingMessage> & {
      *   req: http.IncomingMessage;
@@ -303,7 +303,7 @@ class Server extends events.EventEmitter {
 
         /**
          * @param {number} status
-         * @param {Record<string, string>} headers
+         * @param {http.OutgoingHttpHeaders} headers
          * @param {boolean} [streaming]
          */
         const finish = (status, headers, streaming) => {
@@ -326,7 +326,7 @@ class Server extends events.EventEmitter {
         }
 
         process.nextTick(() => {
-            this.servePath(pathname, 200, {}, req, res, finish).on('success', function (result) {
+            this.servePath(pathname, 200, res.getHeaders(), req, res, finish).on('success', function (result) {
                 /* c8 ignore next -- How to cover? */
                 promise.emit('success', result);
             }).on('error', function (err) {
@@ -362,7 +362,7 @@ class Server extends events.EventEmitter {
      * @param {string|null} pathname
      * @param {number} status
      * @param {string} contentType
-     * @param {Record<string, string>} _headers
+     * @param {http.OutgoingHttpHeaders} _headers
      * @param {string[]} files
      * @param {import('./node-static/util.js').StatInfo} stat
      * @param {http.IncomingMessage} req
@@ -436,7 +436,7 @@ class Server extends events.EventEmitter {
      * @param {string|null} pathname
      * @param {number} status
      * @param {string} contentType
-     * @param {Record<string, string>} _headers
+     * @param {http.OutgoingHttpHeaders} _headers
      * @param {string[]} files
      * @param {import('./node-static/util.js').StatInfo} stat
      * @param {http.IncomingMessage} req
@@ -448,7 +448,7 @@ class Server extends events.EventEmitter {
     respondNoGzip (pathname, status, contentType, _headers, files, stat, req, res, finish) {
         const mtime           = Date.parse(stat.mtime.toString()),
             key             = pathname || files[0],
-            headers         = /** @type {Record<string, string>} */ ({}),
+            headers         = /** @type {http.OutgoingHttpHeaders} */ ({}),
             clientETag      = req.headers['if-none-match'],
             clientMTime     = Date.parse(req.headers['if-modified-since'] ?? ''),
             byteRange       = this.parseByteRange(req, stat);
@@ -523,7 +523,7 @@ class Server extends events.EventEmitter {
     /**
      * @param {string|null} pathname
      * @param {number} status
-     * @param {Record<string, string>} _headers
+     * @param {http.OutgoingHttpHeaders} _headers
      * @param {string[]} files
      * @param {import('./node-static/util.js').StatInfo} stat
      * @param {http.IncomingMessage} req
@@ -539,9 +539,9 @@ class Server extends events.EventEmitter {
         _headers = this.setCacheHeaders(_headers, req);
 
         if(this.options.gzip) {
-            this.respondGzip(pathname, status, contentType, _headers, files, stat, req, res, finish);
+            this.respondGzip(pathname, status, /** @type {string} */ (contentType), _headers, files, stat, req, res, finish);
         } else {
-            this.respondNoGzip(pathname, status, contentType, _headers, files, stat, req, res, finish);
+            this.respondNoGzip(pathname, status, /** @type {string} */ (contentType), _headers, files, stat, req, res, finish);
         }
     }
 
@@ -589,7 +589,7 @@ class Server extends events.EventEmitter {
     }
 
     /**
-     * @param {Record<string, string>} _headers
+     * @param {http.OutgoingHttpHeaders} _headers
      * @param {http.IncomingMessage} req
      */
     setCacheHeaders (_headers, req) {

test/integration/node-static-test.js

@@ -17,10 +17,16 @@ let testPort = 8151;
  *     req: http.IncomingMessage;
  *   }
  * ) => void} [cb]
+ * @param {(
+ *   request: http.IncomingMessage,
+ *   response: http.ServerResponse<http.IncomingMessage> & {
+ *     req: http.IncomingMessage;
+ *   }
+ * ) => void} [preprocessCb]
  */
-async function setupStaticServer (obj, cb) {
+async function setupStaticServer (obj, cb, preprocessCb) {
     obj.port = ++testPort;
-    obj.server = await startStaticServer(obj.port, cb);
+    obj.server = await startStaticServer(obj.port, cb, preprocessCb);
     obj.getTestServer = () => {
         return 'http://localhost:' + obj.port;
     };
@@ -38,10 +44,19 @@ let fileServer = new statik.Server(__dirname + '/../fixtures');
  *     req: http.IncomingMessage;
  *   }
  * ) => void} [callback]
+ * @param {(
+ *   request: http.IncomingMessage,
+ *   response: http.ServerResponse<http.IncomingMessage> & {
+ *     req: http.IncomingMessage;
+ *   }
+ * ) => void} [preprocessCallback]
  */
-function startStaticServer (port, callback) {
+function startStaticServer (port, callback, preprocessCallback) {
     return new Promise((resolve, reject) => {
         const server = http.createServer(function (request, response) {
+            if (preprocessCallback) {
+                preprocessCallback(request, response);
+            }
             const serveProm = fileServer.serve(request, response);
             if (callback) {
                 callback(serveProm, request, response);
@@ -616,6 +631,25 @@ describe('node-static', function () {
             assert.equal(response.status, 404, 'should respond with 404');
         });
     });
+
+    describe('once an http server is listening with a custom header', function () {
+        beforeEach(async function () {
+            await setupStaticServer(this, undefined, (_req, res) => {
+                res.setHeader('Content-Type', 'text/html');
+            });
+        });
+        afterEach(async function () {
+            this.server.close();
+        });
+        it('requesting a text file as HTML', async function () {
+            fileServer = new statik.Server(__dirname+'/../fixtures');
+            const response = await fetch(this.getTestServer() + '/hello.txt');
+
+            assert.equal(response.headers.get('content-type'), 'text/html', 'should respond with text/html');
+            assert.equal(response.status, 200, 'should respond with 200');
+        });
+    });
+
     describe('once an http server is listening with custom index configuration', function () {
         before(function () {
             fileServer = new statik.Server(__dirname + '/../fixtures', { indexFile: "hello.txt" });