EQMX Dashboard Screenshot

OpenFunction 202

Node.js Async Function Quickstart

Press Space for next page

Haili Zhang

KubeSphere Ambassador, CNCF OpenFunction TOC Member.
Cloud Platform Director of UISEE© Technology.
Cloud Native focuses: Kubernetes, DevOps, Observability, Service Mesh, Serverless.

webup

zhanghaili0610

haili.zhang@uisee.com

ServiceUP · 语雀

Table of Content

Prerequsites

Use ofn ^[1] ^[2] CLI tool to deploy OpenFunction.

Install OpenFunction with Async Runtime only ^[3]

$ ofn install --async

Install OpenFunction with Async Runtime and function build framework

$ ofn install --async --shipwright

Add --region-cn option in case you have limited access to gcr.io or github.com ↩︎
Use --dry-run to peek the components and their versions to be installed by the current command ↩︎
Please refer this to learn how to build function image at local ↩︎

Your First Async Function

A brief walkthrough

Async 0.4.1+

function (ctx, data) {}

Parameters

ctx: OpenFunction context object
- ctx.send(payload, output?): Send payload to all or one specific output of Dapr Output Binding or Pub Broker
data: Data recieved from Dapr Input Binding or Sub Broker

Notice

ctx.send CAN be invoked where necessary, when you have certain outgoing data to send

(HTTP) Sync

function (req, res) {}

Parameters

req: Express standard request object
res: Express standard response object
- res.send(body): Use this method to send HTTP response in most common cases

NOTICE

Response process SHOULD be explictly ended with res.send(), res.json(), res.end() and alike methods

A sample function: `tryAsync`

index.mjs

// Async function
export const tryAsync = (ctx, data) => {
  console.log('Data received: %o', data);
  ctx.send(data);
};

// HTTP sync function
export const tryKnative = (req, res) => {
  res.send(`Hello, ${req.query.u || 'World'}!`);
};

package.json

{
  "main": "index.mjs",
  "scripts": {
    "start": "functions-framework --target=tryKnative"
  },
  "dependencies": {
    "@openfunction/functions-framework": "^0.4.1"
  }
}

Notice

Serveral async and sync functions CAN be placed in ONE SINGLE JavaScript file
- Target function CAN be assigned when applying Function CR manifest
In package.json, sciprts and dependencies sections could be omitted
- @openfucntion/openfunction-framework lib would be automatically added during build
- start script is highly recommeneded for local development

Build Function Image via Pack Optional

Local build is recommended if your Kubernetes nodes have limited access to GitHub or Docker Hub.

Install Cloud Native Buildpacks project’s Pack CLI tool

Use pack tool to build your function image at local ^[1]

pack build -B openfunction/builder-node:v2-16.13 \    # Builder image, `16` is the latest version   
           -e FUNC_NAME=tryKnative \                  # Default entry point function 
           -p src \                                   # Path of source files to be built
           <image-repo>/<image-name>:<tag>

Push function image to target container repository (e.g. Docker Hub)
```
docker push <image-repo>/<image-name>:<tag>
```

pack tool would download builder image during the build process ↩︎

Lab: MQTT Forwarder

Use async function to bridge MQTT messages among topic channels

Set up MQTT Broker Optional

In this lab, we will use EMQX as the broker infrastructure. Learn full steps.

Add EMQX Helm Chart repository

helm repo add emqx https://repos.emqx.io/charts
helm repo update

Search available charts of EMQX

helm search repo emqx

NAME               CHART VERSION APP VERSION DESCRIPTION
emqx/emqx          4.4.3         4.4.3       A Helm chart for EMQX
emqx/emqx-ee       4.4.3         4.4.3       A Helm chart for EMQ X

Deploy single replica of EMQX, and expose NodePort service

helm install emqx emqx/emqx --set replicaCount=1 --set service.type=NodePort

EQMX Dashboard Screenshot

apiVersion: core.openfunction.io/v1beta1
kind: Function
metadata:
  name: sample-node-async-bindings
spec:
  version: v2.0.0
  image: '<image-repo>/<image-name>:<tag>'
  serving:
    # default to knative
    runtime: async
    annotations:
      # default to "grpc"
      dapr.io/app-protocol: http
    template:
      containers:
        - name: function
    params:
      # default to FUNC_NAME value
      FUNCTION_TARGET: tryAsync
    inputs:
      - name: mqtt-input
        component: mqtt-in
    outputs:
      - name: mqtt-output
        component: mqtt-out
        operation: create

    bindings:
      mqtt-in:
        type: bindings.mqtt
        version: v1
        metadata:
          - name: consumerID
            value: '{uuid}'
          - name: url
            value: tcp://admin:public@emqx:1883
          - name: topic
            value: in
      mqtt-out:
        type: bindings.mqtt
        version: v1
        metadata:
          - name: consumerID
            value: '{uuid}'
          - name: url
            value: tcp://admin:public@emqx:1883
          - name: topic
            value: out

Dapr Component - Bindings - MQTT
OpenFunction - Function CRD - DaprIO
Check full sample codes

Lab 1: MQTT Input and Output Binding

Apply function manifest, and check running states

$ kubectl apply -f async-bindings.yaml
function.core.openfunction.io/sample-node-async-bindings created

$ kubectl get fn
NAME                         BUILDSTATE   SERVINGSTATE   BUILDER   SERVING         URL      AGE
sample-node-async-bindings   Skipped      Running                  serving-8f7xc            140m

$ kubectl get po
NAME                                                   READY   STATUS    RESTARTS   AGE
serving-8f7xc-deployment-v200-l78xc-564c6b5bf7-vksg7   2/2     Running   0          141m

Furthermore, check whether function container output correct logs

$ kubectl logs -c function serving-8f7xc-deployment-v200-l78xc-564c6b5bf7-vksg7
...
[Dapr-JS] Listening on 8080
[Dapr-JS] Letting Dapr pick-up the server (Maximum 60s wait time)
[Dapr-JS] - Waiting till Dapr Started (#0)
[Dapr-JS] Server Started

Lab 1: Trigger Event

Lab 2: MQTT Pub and Sub

Apply function manifest, and check running states

$ kubectl apply -f async-pubsub.yaml
function.core.openfunction.io/sample-node-async-pubsub created

$ kubectl get fn
NAME                         BUILDSTATE   SERVINGSTATE   BUILDER   SERVING         URL      AGE
sample-node-async-pubsub     Skipped      Running                  serving-2qfkl            140m

$ kubectl get po
NAME                                                   READY   STATUS    RESTARTS   AGE
serving-2qfkl-deployment-v200-6cshf-57c8b5b8dd-ztmbf   2/2     Running   0          141m

Furthermore, check whether function container output correct logs

$ kubectl logs -c function serving-2qfkl-deployment-v200-6cshf-57c8b5b8dd-ztmbf
...
[Dapr-JS] Listening on 8080
[Dapr-JS] Letting Dapr pick-up the server (Maximum 60s wait time)
[Dapr-JS] - Waiting till Dapr Started (#0)
[Dapr API][PubSub] Registered 1 PubSub Subscriptions
[Dapr-JS] Server Started

Lab 2: Trigger Event

Connect EQMX server via NodePort mapped to tcp:1883
Publish a CloudEvents event to pub topic
- CloudEvents payload got in sub 👉
- Pure data recieved in async function 👇

Check the function container log

$ kubectl logs -c function serving-2qfkl-deployment-v200-6cshf-57c8b5b8dd-ztmbf
...
[Dapr-JS] Listening on 8080
[Dapr-JS] Letting Dapr pick-up the server (Maximum 60s wait time)
[Dapr-JS] - Waiting till Dapr Started (#0)
[Dapr API][PubSub] Registered 1 PubSub Subscriptions
[Dapr-JS] Server Started
Data received: { orderId: '100' }

Learn More

Discord · Slack

OpenFunction · Node.js Functions Framework

EQMX Dashboard Screenshot

OpenFunction 202

Haili Zhang

Table of Content

Prerequsites

Your First Async Function

Async 0.4.1+

Parameters

Notice

(HTTP) Sync

Parameters

NOTICE

A sample function: tryAsync

index.mjs

package.json

Notice

Build Function Image via Pack Optional

Lab: MQTT Forwarder

Set up MQTT Broker Optional

EQMX Dashboard Screenshot

Lab 1: MQTT Input and Output Binding

Lab 1: Trigger Event

Lab 2: MQTT Pub and Sub

Lab 2: Trigger Event

Learn More

A sample function: `tryAsync`