fix: avoid logging range errors to console; fixes #185 ; fixes #212

Author: brettz9

CHANGES.md

@@ -26,6 +26,7 @@
 - Fix: Ensure package `version` stays up to date
 - Fix: path should be more generous in unescaping anything valid in a
     path (such as a hash)
+- Fix: Avoid logging range errors to console
 - Fix: change `fs.createReadStream()` mode to integer (@pixcai)
 - Enhancement: TypeScript support
 - Enhancement: Allow access with local ip (@flyingsky)

README.md

@@ -225,6 +225,16 @@ A request to '/myFile' would check for a `myFile` folder (first) then a
 
 example: `{ defaultExtension: "html" }`
 
+### Listening for emitted warnings
+
+Certain warnings are not logged to console but instead may be listened for.
+
+```js
+fileServer.on('warn', (msg) => {
+    console.log(msg);
+});
+```
+
 ## Command Line Interface
 
 `node-static` also provides a CLI.

lib/node-static.js

@@ -56,12 +56,13 @@ function tryStat(p, callback) {
  * }} ServerOptions
  */
 
-class Server {
+class Server extends events.EventEmitter {
     /**
      * @param {string|ServerOptions|null} [root]
      * @param {ServerOptions} [options]
      */
     constructor (root, options) {
+        super();
         if (root && typeof root === 'object') { options = root; root = null }
 
         // resolve() doesn't normalize (to lowercase) drive letters on Windows
@@ -422,10 +423,10 @@ class Server {
                 if (!isNaN(byteRange.from) && !isNaN(byteRange.to) && 0 <= byteRange.from && byteRange.from <= byteRange.to) {
                     byteRange.valid = true;
                 } else {
-                    console.warn('Request contains invalid range header: ', rangeHeaderArr);
+                    this.emit('warn', 'Request contains invalid range header: ' + rangeHeaderArr.join(', '));
                 }
             } else {
-                console.warn('Request contains unsupported range header: ', rangeHeader);
+                this.emit('warn', 'Request contains unsupported range header: ' + rangeHeader);
             }
         }
         return byteRange;
@@ -468,13 +469,13 @@ class Server {
 
             } else {
                 byteRange.valid = false;
-                console.warn('Range request exceeds file boundaries, goes until byte no', byteRange.to, 'against file size of', length, 'bytes');
+                this.emit('warn', 'Range request exceeds file boundaries, goes until byte no ' + byteRange.to + ' against file size of ' + length + ' bytes');
             }
         }
 
         /* In any case, check for unhandled byte range headers */
         if (!byteRange.valid && req.headers['range']) {
-            console.error(new Error('Range request present but invalid, might serve whole file instead'));
+            this.emit('warn', 'Range request present but invalid, might serve whole file instead');
         }
 
         // Copy default headers

test/integration/node-static-test.js

@@ -432,12 +432,11 @@ describe('node-static', function () {
 
         it('serving full bytes of hello.txt with bad range', async function () {
             fileServer = new statik.Server(__dirname + '/../fixtures');
-            const _consoleError = console.error;
-            /** @type {Error} */
-            let loggedErr;
-            console.error = (err) => {
-                loggedErr = err;
-            };
+            let emittedWarning;
+            fileServer.on('warn', (warning) => {
+                emittedWarning = warning;
+            });
+
             const options = {
                 headers: {
                     'Range': 'bytes=1000-1004'
@@ -451,20 +450,15 @@ describe('node-static', function () {
 
             assert.equal(response.headers.get('content-range'), null);
             assert.equal(await response.text(), 'hello world', 'should respond with hello world');
-            // @ts-expect-error Ok
-            assert.equal(loggedErr?.message, 'Range request present but invalid, might serve whole file instead')
-            console.error = _consoleError;
+            assert.equal(emittedWarning, 'Range request present but invalid, might serve whole file instead')
         });
 
         it('serving full bytes of hello.txt with unsupported range flavor', async function () {
             fileServer = new statik.Server(__dirname + '/../fixtures');
-            const _consoleWarn = console.warn;
-            let loggedWarning;
-            let loggedHeader;
-            console.warn = (warning, warning2) => {
-                loggedWarning = warning;
-                loggedHeader = warning2;
-            };
+            let emittedWarning;
+            fileServer.once('warn', (warning) => {
+                emittedWarning = warning;
+            });
             const options = {
                 headers: {
                     'Range': 'qubits=1-5'
@@ -478,20 +472,15 @@ describe('node-static', function () {
 
             assert.equal(response.headers.get('content-range'), null);
             assert.equal(await response.text(), 'hello world', 'should respond with hello world');
-            assert.equal(loggedWarning, 'Request contains unsupported range header: ')
-            assert.equal(loggedHeader, 'qubits=1-5');
-            console.warn = _consoleWarn;
+            assert.equal(emittedWarning, 'Request contains unsupported range header: qubits=1-5');
         });
 
         it('serving full bytes of hello.txt with invalid range header', async function () {
             fileServer = new statik.Server(__dirname + '/../fixtures');
-            const _consoleWarn = console.warn;
-            let loggedWarning;
-            let loggedHeader;
-            console.warn = (warning, warning2) => {
-                loggedWarning = warning;
-                loggedHeader = warning2;
-            };
+            let emittedWarning;
+            fileServer.once('warn', (warning) => {
+                emittedWarning = warning;
+            });
             const options = {
                 headers: {
                     'Range': 'bytes=a-b'
@@ -505,9 +494,7 @@ describe('node-static', function () {
 
             assert.equal(response.headers.get('content-range'), null);
             assert.equal(await response.text(), 'hello world', 'should respond with hello world');
-            assert.equal(loggedWarning, 'Request contains invalid range header: ')
-            assert.deepEqual(loggedHeader, ['a', 'b']);
-            console.warn = _consoleWarn;
+            assert.equal(emittedWarning, "Request contains invalid range header: a, b")
         });
 
         it('serving directory index', async function (){