Merge pull request #43 from OpenFunction/feature/async-error-ouput

refactor: polish http error response

Author: benjaminhuo

src/function_wrappers.ts

@@ -138,7 +138,7 @@ const wrapOpenFunction = (
 
     Promise.resolve()
       .then(() => userFunction(ctx, req.body))
-      .then(() => res.end())
+      .then(result => callback(null, result))
       .catch(err => callback(err, undefined));
   };
 

src/types.ts

@@ -14,7 +14,7 @@
 
 // HTTP header field that is added to Worker response to signalize problems with
 // executing the client function.
-export const FUNCTION_STATUS_HEADER_FIELD = 'X-Google-Status';
+export const FUNCTION_STATUS_HEADER_FIELD = 'X-OpenFunction-Status';
 
 /**
  * List of function signature types that are supported by the framework.

test/integration/cloud_event.ts

@@ -13,10 +13,13 @@
 // limitations under the License.
 
 import * as assert from 'assert';
-import * as functions from '../../src/index';
+
+import * as supertest from 'supertest';
 import * as sinon from 'sinon';
+
+import * as functions from '../../src/index';
 import {getTestServer} from '../../src/testing';
-import * as supertest from 'supertest';
+import {FUNCTION_STATUS_HEADER_FIELD} from '../../src/types';
 
 // A structured CloudEvent
 const TEST_CLOUD_EVENT = {
@@ -316,7 +319,10 @@ describe('CloudEvent Function', () => {
       .post('/')
       .send(TEST_CLOUD_EVENT)
       .expect(res => {
-        assert.deepStrictEqual(res.headers['x-google-status'], 'error');
+        assert.deepStrictEqual(
+          res.headers[FUNCTION_STATUS_HEADER_FIELD.toLowerCase()],
+          'error'
+        );
         assert.deepStrictEqual(res.body, {});
       })
       .expect(500);

test/integration/http.ts

@@ -18,6 +18,7 @@ import * as supertest from 'supertest';
 
 import * as functions from '../../src/index';
 import {getTestServer} from '../../src/testing';
+import {FUNCTION_STATUS_HEADER_FIELD} from '../../src/types';
 
 describe('HTTP Function', () => {
   let callCount = 0;
@@ -99,13 +100,19 @@ describe('HTTP Function', () => {
   testData.forEach(test => {
     it(test.name, async () => {
       const st = supertest(getTestServer('testHttpFunction'));
-      await (test.httpVerb === 'GET'
-        ? st.get(test.path)
-        : st.post(test.path).send({text: 'hello'})
-      )
-        .set('Content-Type', 'application/json')
-        .expect(test.expectedBody)
-        .expect(test.expectedStatus);
+      try {
+        await (test.httpVerb === 'GET'
+          ? st.get(test.path)
+          : st.post(test.path).send({text: 'hello'})
+        )
+          .set('Content-Type', 'application/json')
+          .expect(test.expectedBody)
+          .expect(test.expectedStatus)
+          .expect(FUNCTION_STATUS_HEADER_FIELD, 'crash');
+      } catch (err) {
+        test.expectedStatus === 500 && assert(err);
+      }
+
       assert.strictEqual(callCount, test.expectedCallCount);
     });
   });

test/integration/http_binding.ts

@@ -9,6 +9,7 @@ import {OpenFunctionContext} from '../../src/openfunction/function_context';
 
 import {OpenFunctionRuntime} from '../../src/functions';
 import {getServer} from '../../src/server';
+import {FUNCTION_STATUS_HEADER_FIELD} from '../../src/types';
 
 const TEST_CONTEXT: OpenFunctionContext = {
   name: 'test-context',
@@ -72,6 +73,7 @@ describe('OpenFunction - HTTP Binding', () => {
     {name: 'Save data', operation: 'create', listable: true},
     {name: 'Get data', operation: 'get', listable: true},
     {name: 'Delete data', operation: 'delete', listable: false},
+    {name: 'Error data', operation: '', listable: false},
   ];
 
   testData.forEach(test => {
@@ -83,6 +85,8 @@ describe('OpenFunction - HTTP Binding', () => {
 
       const server = getServer(
         async (ctx: OpenFunctionRuntime, data: {}) => {
+          if (!test.operation) throw new Error('I crashed');
+
           await ctx.send(data);
           ctx.res?.send(data);
         },
@@ -93,9 +97,14 @@ describe('OpenFunction - HTTP Binding', () => {
       await supertest(server)
         .post('/')
         .send(TEST_PAYLOAD)
-        .expect(200)
+        .expect(test.operation ? 200 : 500)
         .expect(res => {
-          deepStrictEqual(res.body, TEST_PAYLOAD);
+          !test.operation
+            ? deepStrictEqual(
+                res.headers[FUNCTION_STATUS_HEADER_FIELD.toLowerCase()],
+                'error'
+              )
+            : deepStrictEqual(res.body, TEST_PAYLOAD);
         });
 
       forEach(context.outputs, output => {

test/integration/legacy_event.ts

@@ -13,10 +13,13 @@
 // limitations under the License.
 
 import * as assert from 'assert';
-import * as functions from '../../src/functions';
+
+import * as supertest from 'supertest';
 import * as sinon from 'sinon';
+
+import * as functions from '../../src/index';
 import {getServer} from '../../src/server';
-import * as supertest from 'supertest';
+import {FUNCTION_STATUS_HEADER_FIELD} from '../../src/types';
 
 const TEST_CLOUD_EVENT = {
   specversion: '1.0',
@@ -214,7 +217,10 @@ describe('Event Function', () => {
       })
       .set({'Content-Type': 'application/json'})
       .expect(res => {
-        assert.deepStrictEqual(res.headers['x-google-status'], 'error');
+        assert.deepStrictEqual(
+          res.headers[FUNCTION_STATUS_HEADER_FIELD.toLowerCase()],
+          'error'
+        );
         assert.deepStrictEqual(res.body, {});
       })
       .expect(500);