_debug should allow for valid streams if they exist.

Author: keithwhor

lib/gateway.js

@@ -1102,12 +1102,14 @@ class Gateway extends EventEmitter {
 
   }
 
-  __validateDebug__ (debugObject) {
+  __validateDebug__ (debugObject, streams) {
+    streams = streams || [];
     debugObject = typeof debugObject === 'object'
       ? Array.isArray(debugObject) || Buffer.isBuffer(debugObject)
         ? {}
         : debugObject || {}
       : {};
+    let streamObject = {};
     Object.keys(debugObject).forEach(key => {
       if (
         key === '*' ||
@@ -1118,7 +1120,12 @@ class Gateway extends EventEmitter {
       ) {
         return;
       } else {
-        throw new Error(`Invalid debug listener: "${key}"`);
+        let stream = streams.find(stream => stream.name === key);
+        if (!stream) {
+          throw new Error(`Invalid debug listener: "${key}"`);
+        } else {
+          return;
+        }
       }
     });
     return true;
@@ -1348,7 +1355,7 @@ class Gateway extends EventEmitter {
             return this.__debugError__(req, res, 'Can not debug with "background" mode set', headers);
           } else {
             try {
-              this.__validateDebug__(validated.params._debug);
+              this.__validateDebug__(validated.params._debug, definition.streams);
             } catch (e) {
               this.log(req, `Debug Error`, 'error');
               return this.__debugError__(req, res, e.message, headers);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "functionscript",
-  "version": "2.9.0",
+  "version": "2.9.1",
   "description": "An API gateway and framework for turning functions into web services",
   "author": "Keith Horwood <keithwhor@gmail.com>",
   "main": "index.js",

tests/gateway/tests.js

@@ -5141,6 +5141,53 @@ module.exports = (expect) => {
     });
   });
 
+  it('Streaming endpoints should succeed if contains a valid stream in _debug', done => {
+    request('POST', {}, '/stream/basic/', {alpha: 'hello', _stream: {}, _debug: {hello: true}}, (err, res, result) => {
+
+      expect(err).to.not.exist;
+      expect(res.statusCode).to.equal(200);
+      expect(res.headers['content-type']).to.equal('text/event-stream');
+      expect(res.headers['x-debug']).to.equal('true');
+      expect(result).to.exist;
+
+      let events = parseServerSentEvents(result);
+      expect(Object.keys(events).length).to.equal(3);
+
+      expect(events['@begin']).to.exist;
+      expect(events['@begin'].length).to.equal(1);
+      expect(events['@begin'][0]).to.be.a.string;
+
+      expect(events['hello']).to.exist;
+      expect(events['hello'].length).to.equal(1);
+      expect(events['hello'][0]).to.equal('true');
+
+      expect(events['@response']).to.exist;
+      let response = JSON.parse(events['@response'][0]);
+      expect(response.headers['Content-Type']).to.equal('application/json');
+      expect(response.body).to.equal('true');
+
+      done();
+
+    });
+  });
+
+  it('Streaming endpoints should fail if contains an invalid stream in _debug', done => {
+    request('POST', {}, '/stream/basic/', {alpha: 'hello', _stream: {}, _debug: {test: true}}, (err, res, result) => {
+
+      expect(err).to.not.exist;
+      expect(res.statusCode).to.equal(403);
+      expect(res.headers['content-type']).to.equal('application/json');
+      expect(res.headers['x-debug']).to.equal('true');
+      expect(result).to.exist;
+      expect(result.error).to.exist;
+      expect(result.error.type).to.equal('DebugError');
+      expect(result.error.message).to.contain('"test"');
+
+      done();
+      
+    });
+  });
+
   it('Streaming endpoints should fail with StreamError if contains an invalid stream when _debug', done => {
     request('POST', {}, '/stream/basic/', {alpha: 'hello', _stream: {test: true}, _debug: true}, (err, res, result) => {