How to write JavaScript Actions for OpenWhisk on Bluemix

Update 02/15/17: Using Node.js to code OpenWhisk actions

In addition to Cloud Foundry, Docker and Virtual Maschines Bluemix provides a fourth compute option OpenWhisk (experimental at this point). OpenWhisk is an event-driven compute platform that executes code in response to events or direct invocations.

With OpenWhisk you can develop server side actions in JavaScript and Swift without having to maintain servers. The advantage is that you only have to pay for actual usage, not for peaked projections. This opens up several interesting use cases. For example you can perform processing of data like videos and processing of data from IoT devices triggered by events. You can also build backend services for mobile apps to move logic to the backend and reduce network traffic. OpenWhisk also supports decomposing applications into microservices.

Below is a simple example how to build a JavaScript action that leverages the Watson Language Translation service to translate text. This action can be invoked directly and also via events. For example in a help desk application you might want to translate tickets which have not been written in English to English so that support agents understand. Rather than doing this when tickets are stored or opened the OpenWhisk action could be triggered when new documents are stored in a Cloudant NoSQL database.

Here is the code of the JavaScript action (‘translate.js’). Parameters are passed in to the main function. In this case the action is asynchronous and returns data in the whisk.done function. The JavaScript code is executed via Node.js and you can use a number of available npm modules, in this case the Watson module watson-developer-cloud is used to access the Watson service.

function main(params) {
    var tobetranslated = "";
    if (params.hasOwnProperty("tobetranslated")) {
        tobetranslated = params.tobetranslated;
    }
    
    var watson = require('watson-developer-cloud');			  	 				   
    var language_translation = watson.language_translation({
        username: "xxx",
        password: "xxx",
        version: 'v2'
    });

    language_translation.translate({
        text: tobetranslated, source : 'en', target: 'es' },
        function (err, translation) {
            if (!err) {
                return whisk.done({tobetranslated:tobetranslated,
                                   result:translation});
            }
            else {
                return whisk.done({result: 'Error occured' });
            }
        });
				  	
    return whisk.async();
}

In order to deploy the action a CLI is used and the plan is to also support tooling via web browsers. Invoke the following commands to create and update actions.

wsk action create translate translate.js
wsk action update translate translate.js

For developing purposes probably the easiest way to test actions is the CLI at this point.

wsk action invoke --blocking --result translate --param tobetranslated 'Hello'

The CLI invokes internally REST APIs which means that you can also interact with OpenWhisk via curl or other programming languages. Authentication is done via name and password credentials provided by OpenWhisk.

curl -u "yourUserName":"yourPassword" -H "Content-Type: application/json" -X POST https://openwhisk.ng.bluemix.net/api/v1/namespaces/niklas_heidloff@de.ibm.com_BluemixInfo/actions/translate?blocking=true -d '{"tobetranslated":"Hello"}'

Here is the output of the curl command.

whisk-sample1

Via the OpenWhisk dashboard on Bluemix you can see activities and logs.

whisk-sample2

To find out more check out the documentation, the open source project OpenWhisk and the image tagging sample from Frederic Lavigne.

  • http://www.pveller.com Pavel Veller

    Great post, thank you! Quick question about the Watson JavaScript APIs if you don’t mind. It seems to be all callbacks-oriented. In your examples and also on github (https://github.com/watson-developer-cloud/node-sdk). Is there a Promise-based API? If I, for example, had to first identify the source language and then translate it’d be a lot cleaner to just chain promises than it is to nest callbacks. Has anybody “promisified” Watson JS APIs or maybe I just haven’t looked hard enough :) ?

    • Niklas Heidloff

      Pavel, sorry for the late response (vacation). I think I’ve seen some sample code using promises for Watson, but don’t remember from the top of my head where.