MobileExample-Microservice-CommandProcessor

This sample show how to create a command processor that adds a timestamp in response.

Definitions

Command

A Command represents an asynchronous unit of work.

Command Document

A command document is a JSON document with a ~status field and a type field with a command. The command document format is similar to an HTTP request, with a request and response section contained in the same document.

Command Processor

Any HTTP enabled microservice.

Command router

Microservice tasked with routing pending command documents to configured Command Processors.

How things work

The Command Router manages the state of a given command from the time the document arrives on the server until the router writes the result from an invoked Command Processor to the response section of the document. The Command Router translates a command document into an equivalent HTTP request to a Command Processor. The HTTP response from the Command Processor is serialized and placed in the response section of the originating command document.

Registering Command Processor
The PM CLI tool needs the following two parameters to register a Command Processor:
command route and a Command-Processor-endpoint-url.
For example: pm add-route '/cmdp_test/' 'my-command-processor.run.aws-usw02-pr.ice.predix.io' Note: You can use --debug option to see what it is doing behind the scene.

command-document example:

{
  "type": "command", //should be of type command  
  "~userid": usera_ge_com, // replace . & @ with _ from username (if email address is used)
  "channels": ["entity_" + usera_ge_com],
  "~status": "pending",
  // command router reads this and hit command processor based on parameters
  "request": {
    "uri": "/cmdp_test/",
    "method": "PUT",
    "headers": {},
    "body": { //whatever goes inside body will be passed to command processor
      "abc" : 1,
      "some key" : "some value"
    }
  }
}

Before You Begin:

It is assumed that you already have a running instances of Predix Mobile cloud services and have installed the Predix Mobile pm cli. To get started, follow this documentation:

[Get Started with the Mobile Service and Mobile SDK] (https://www.predix.io/docs#rae4EfJ6)
[Running the Predix Mobile Sample App] (https://www.predix.io/docs#EGUzWwcC)
[Creating a Mobile Hello World Web App] (https://www.predix.io/docs#DrBWuHkl)

Configuration

When running on a development system environment, use the configuration found in config/default.json. When pushing to CF, use manifest.yml.
You can change the logging level in js/bunyanLogger.js file. The default is trace and src is true.

Installation

Development system

Checkout this repository, open the folder in a terminal window, and execute:

npm install

CF