Add in support for @begin stream for functions

Author: keithwhor

lib/gateway.js

@@ -1109,7 +1109,12 @@ class Gateway extends EventEmitter {
         : debugObject || {}
       : {};
     Object.keys(debugObject).forEach(key => {
-      if (key === '*' || key === '@stdout' || key === '@stderr') {
+      if (
+        key === '*' ||
+        key === '@begin' ||
+        key === '@stdout' ||
+        key === '@stderr'
+      ) {
         return;
       } else {
         throw new Error(`Invalid debug listener: "${key}"`);
@@ -1738,9 +1743,16 @@ class Gateway extends EventEmitter {
   }
 
   __stream__ (streams, executionUuid, logId, eventName, value) {
+    value = value === void 0
+      ? null
+      : value;
     let stream = (streams || []).find(param => param.name === eventName);
     if (!stream) {
-      if (eventName === '@stdout' || eventName === '@stderr') {
+      if (
+        eventName === '@begin' ||
+        eventName === '@stdout' ||
+        eventName === '@stderr'
+      ) {
         this.createServerSentEvent(
           executionUuid,
           logId,
@@ -2051,6 +2063,7 @@ class Gateway extends EventEmitter {
         global.console = console;
         callbackWrapper(err, null, headers, executionUuid);
       });
+      data.context.stream('@begin', new Date().toISOString());
       if (definition.format.async) {
         fn.apply(null, functionArgs)
           .then(result => {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "functionscript",
-  "version": "2.8.9",
+  "version": "2.8.10",
   "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

@@ -5025,7 +5025,7 @@ module.exports = (expect) => {
       expect(result).to.exist;
 
       let events = parseServerSentEvents(result);
-      expect(Object.keys(events).length).to.equal(3);
+      expect(Object.keys(events).length).to.equal(4);
 
       expect(events['hello']).to.exist;
       expect(events['hello'].length).to.equal(3);
@@ -5037,6 +5037,10 @@ module.exports = (expect) => {
       expect(events['goodbye'].length).to.equal(1);
       expect(events['goodbye'][0]).to.equal('"Nice to see ya"');
 
+      expect(events['@begin']).to.exist;
+      expect(events['@begin'].length).to.equal(1);
+      expect(events['@begin'][0]).to.be.a.string;
+
       expect(events['@response']).to.exist;
       let response = JSON.parse(events['@response'][0]);
       expect(response.headers['Content-Type']).to.equal('application/json');
@@ -5057,7 +5061,7 @@ module.exports = (expect) => {
       expect(result).to.exist;
 
       let events = parseServerSentEvents(result);
-      expect(Object.keys(events).length).to.equal(5);
+      expect(Object.keys(events).length).to.equal(6);
 
       expect(events['hello']).to.exist;
       expect(events['hello'].length).to.equal(3);
@@ -5069,6 +5073,10 @@ module.exports = (expect) => {
       expect(events['goodbye'].length).to.equal(1);
       expect(events['goodbye'][0]).to.equal('"Nice to see ya"');
 
+      expect(events['@begin']).to.exist;
+      expect(events['@begin'].length).to.equal(1);
+      expect(events['@begin'][0]).to.be.a.string;
+
       expect(events['@stdout']).to.exist;
       expect(events['@stdout'].length).to.equal(2);
       expect(events['@stdout'][0]).to.equal('"what? who?"');
@@ -5089,7 +5097,7 @@ module.exports = (expect) => {
   });
 
   it('Should support POST with streaming with _debug set to valid channels without _stream set', done => {
-    request('POST', {}, '/stream/debug/', {alpha: 'hello', _debug: {'*': true, '@stdout': true, '@stderr': true}}, (err, res, result) => {
+    request('POST', {}, '/stream/debug/', {alpha: 'hello', _debug: {'*': true, '@begin': true, '@stdout': true, '@stderr': true}}, (err, res, result) => {
 
       expect(err).to.not.exist;
       expect(res.statusCode).to.equal(200);
@@ -5098,7 +5106,7 @@ module.exports = (expect) => {
       expect(result).to.exist;
 
       let events = parseServerSentEvents(result);
-      expect(Object.keys(events).length).to.equal(5);
+      expect(Object.keys(events).length).to.equal(6);
 
       expect(events['hello']).to.exist;
       expect(events['hello'].length).to.equal(3);
@@ -5110,6 +5118,10 @@ module.exports = (expect) => {
       expect(events['goodbye'].length).to.equal(1);
       expect(events['goodbye'][0]).to.equal('"Nice to see ya"');
 
+      expect(events['@begin']).to.exist;
+      expect(events['@begin'].length).to.equal(1);
+      expect(events['@begin'][0]).to.be.a.string;
+
       expect(events['@stdout']).to.exist;
       expect(events['@stdout'].length).to.equal(2);
       expect(events['@stdout'][0]).to.equal('"what? who?"');
@@ -5156,7 +5168,11 @@ module.exports = (expect) => {
       expect(result).to.exist;
 
       let events = parseServerSentEvents(result);
-      expect(Object.keys(events).length).to.equal(3);
+      expect(Object.keys(events).length).to.equal(4);
+
+      expect(events['@begin']).to.exist;
+      expect(events['@begin'].length).to.equal(1);
+      expect(events['@begin'][0]).to.be.a.string;
 
       expect(events['@stdout']).to.exist;
       expect(events['@stdout'].length).to.equal(2);