feat: cache: false now sets no-cache (as do 0 or negative values). null avoids setting any; fixes #117

BREAKING CHANGE:

Set to `null` instead to reproduce old behavior

Author: brettz9

CHANGES.md

@@ -8,6 +8,8 @@
 - **Breaking change**: Add `type: 'module'` and `exports` to `package.json`;
     change internal CJS path
 - **Breaking change**: avoid serving hidden files by default (reenable with `--serve-hidden`/`serveHidden`)
+- **Breaking change**: `cache: false` now sets `no-cache` (as do 0 or
+    negative values). Set to `null` instead to reproduce old behavior
 - Security: Fix dependency vulnerabilities by switching from `optimist` to
     `command-line-basics` (@brettz9)
 - Security: Update `mime` and `colors` (@fidian) and pin `colors`

lib/node-static.js

@@ -62,7 +62,7 @@ function tryStat(p, callback) {
  *   gzip?: boolean|RegExp,
  *   headers?: http.OutgoingHttpHeaders,
  *   serverInfo?: string|null,
- *   cache?: boolean|number|Record<string, number>,
+ *   cache?: null|boolean|number|Record<string, number>,
  *   serveHidden?: boolean,
  *   defaultExtension?: string,
  *   transform?: TransformCallback
@@ -96,10 +96,14 @@ class Server extends events.EventEmitter {
         if ('cache' in this.options) {
             if (typeof(this.options.cache) === 'number') {
                 this.cache = {'**': this.options.cache};
+            } else if (this.options.cache === null) {
+                this.cache = {};
             } else if (typeof(this.options.cache) === 'object') {
                 this.cache = this.options.cache;
             } else if (!this.options.cache) {
-                this.cache = {};
+                this.cache = {
+                    '**': 0
+                };
             }
         }
 
@@ -721,8 +725,12 @@ class Server extends events.EventEmitter {
             return _headers;
         }
         const maxAge = this.getMaxAge(req.url);
-        if (typeof(maxAge) === 'number') {
-            _headers['cache-control'] = 'max-age=' + maxAge;
+        if (typeof maxAge === 'number') {
+            if (maxAge > 0) {
+                _headers['cache-control'] = 'max-age=' + maxAge;
+            } else {
+                _headers['cache-control'] = 'no-cache';
+            }
         }
         return _headers;
     }
@@ -731,14 +739,11 @@ class Server extends events.EventEmitter {
      * @param {string} requestUrl
      */
     getMaxAge (requestUrl) {
-        if (this.cache) {
-            for (const pattern in this.cache) {
-                if (minimatch(requestUrl, pattern)) {
-                    return this.cache[pattern];
-                }
+        for (const pattern in this.cache) {
+            if (minimatch(requestUrl, pattern)) {
+                return this.cache[pattern];
             }
         }
-        return false;
     }
 }
 

test/integration/node-static-test.js

@@ -869,11 +869,11 @@ describe('node-static', function () {
         });
     });
 
-    describe('once an http server is listening with false custom cache configuration', function () {
+    describe('once an http server is listening with null custom cache configuration', function () {
         beforeEach(async function () {
             await setupStaticServer(this);
             fileServer  = new statik.Server(__dirname + '/../fixtures', {
-                cache: false
+                cache: null
             });
         });
         afterEach(async function () {
@@ -897,4 +897,33 @@ describe('node-static', function () {
             assert.equal(response.headers.get('cache-control'), null, 'should not respond with cache-control');
         });
     });
+
+    describe('once an http server is listening with false custom cache configuration', function () {
+        beforeEach(async function () {
+            await setupStaticServer(this);
+            fileServer  = new statik.Server(__dirname + '/../fixtures', {
+                cache: false
+            });
+        });
+        afterEach(async function () {
+            this.server.close();
+        });
+
+        it('requesting custom cache index file', async function () {
+            const response = await fetch(this.getTestServer() + '/');
+            assert.equal(response.status, 200, 'should respond with 200');
+            assert.equal(response.headers.get('cache-control'), 'no-cache', 'should respond with cache-control');
+        });
+        it('requesting custom cache text file', async function () {
+            const response = await fetch(this.getTestServer() + '/hello.txt');
+
+            assert.equal(response.status, 200, 'should respond with 200');
+            assert.equal(response.headers.get('cache-control'), 'no-cache', 'should respond with cache-control');
+        });
+        it('requesting custom cache un-cached file', async function () {
+            const response = await fetch(this.getTestServer() + '/empty.css');
+            assert.equal(response.status, 200, 'should respond with 200');
+            assert.equal(response.headers.get('cache-control'), 'no-cache', 'should respond with cache-control');
+        });
+    });
 });