feat: introduce CloudEvent data as first parameter for event functions (#172)

The 0.4.0 version of faas-js-runtime extracts the CloudEvent data from
an incoming event and provides that as the first parameter when invoking
a function which receives a CloudEvent. This commit bumps to that version
as well as improves the overall readability and code documentation for the
Node.js CloudEvent function.

Signed-off-by: Lance Ball <lball@redhat.com>

Author: lance

go.sum

@@ -1940,8 +1940,6 @@ knative.dev/caching v0.0.0-20190719140829-2032732871ff/go.mod h1:dHXFU6CGlLlbzaW
 knative.dev/caching v0.0.0-20200116200605-67bca2c83dfa/go.mod h1:dHXFU6CGlLlbzaWc32g80cR92iuBSpsslDNBWI8C7eg=
 knative.dev/caching v0.0.0-20200811171106-48c335fed9c8/go.mod h1:XonDcFC2DLSWP71f2y7oYnXUko5d5HsJRnZtkp0wY7g=
 knative.dev/caching v0.0.0-20200831163411-f6154e7455e2/go.mod h1:jG64HWkBQmFlY8dk1CH884oHtaT/savnqxcZC8vBnvk=
-knative.dev/client v0.17.0 h1:RR+eYVYGy6+LQ44wZcoNuUC6j2Ril7v954ffyK76On8=
-knative.dev/client v0.17.0/go.mod h1:62s+OqEJ8mBSkP6c3ZmPB3jl1jmOyiKtTPwJUBXJQqY=
 knative.dev/client v0.17.2 h1:1aRHQgw0D+FGqZ6Rhpq2nUntBjgc2B2s/HOFoVqoOw4=
 knative.dev/client v0.17.2/go.mod h1:62s+OqEJ8mBSkP6c3ZmPB3jl1jmOyiKtTPwJUBXJQqY=
 knative.dev/eventing v0.17.0 h1:yGJuwN+jWQPCf4XuL44vAjlemLHnbLTBKyhvRBmikpQ=

pkged.go

@@ -15,7 +15,7 @@ The runtime will expose three endpoints.
 The health checks can be accessed in your browser at [http://localhost:8080/health/readiness]() and [http://localhost:8080/health/liveness](). You can use `curl` to `POST` an event to the function endpoint:
 
 ```console
-curl -X POST -d '{"hello": "world"}' \
+curl -X POST -d '{"name": "Tiger", "customerId": "0123456789"}' \
   -H'Content-type: application/json' \
   -H'Ce-id: 1' \
   -H'Ce-source: cloud-event-example' \

templates/node/events/README.md

@@ -1,11 +1,34 @@
 'use strict';
 
-module.exports = async function (context) {
+/**
+ * An example function that responds to incoming CloudEvents over HTTP. For example,
+ * from the Knative event Broker. Try invoking with a request such as this.
+ *
+ * curl -X POST -d '{"name": "Tiger", "customerId": "0123456789"}' \
+ *  -H'Content-type: application/json' \
+ *  -H'Ce-id: 1' \
+ *  -H'Ce-source: cloud-event-example' \
+ *  -H'Ce-type: dev.knative.example' \
+ *  -H'Ce-specversion: 1.0' \
+ *  http://localhost:8080
+ *
+ * The event data is extracted from the incoming event and provided as the first
+ * parameter to the function. The CloudEvent object itself may be accessed via the
+ * context parameter, For example:
+ *
+ * const incomingEvent = context.cloudevent;
+ *
+ * @param {Object} customer the CloudEvent data. If the data content type is application/json
+ * this will be converted to an Object via JSON.parse()
+ * @param {Context} context the invocation context
+ */
+function processCustomer(customer, context) {
+  console.log(customer, context)
   if (!context.cloudevent) {
-    return Promise.reject(new Error('No cloud event received'));
+    return 'No cloud event received';
   }
-  context.log.info(`Cloud event received: ${JSON.stringify(context.cloudevent)}`);
-  return new Promise((resolve, reject) => {
-    setTimeout(_ => resolve({ data: context.cloudevent.data }), 500);
-  });
+  context.log.info('Processing customer', customer);
+  context.log.info(`CloudEvent received: ${context.cloudevent.toString()}`);
+  return { customer };
 };
+module.exports = processCustomer;