trackntrace

README

Flogo Rules based Track and Trace

This example demonstrates the capability of rules to track and trace for a flogo app. In this example three tuples are used, tuples description is given below.

{
    "name": "package",
    "properties": [
        {
            "name": "id",
            "type": "string",
            "pk-index": 0
        },
        {
            "name": "state",
            "type": "string"
        }
    ]  
},
{
    "name": "moveevent",
    "ttl": 0,
    "properties": [
        {
            "name": "id",
            "type": "string",
            "pk-index": 0
        },
        {
            "name": "packageid",
            "type": "string"
        },
        {
            "name": "targetstate",
            "type": "string"
        }
    ]
},
{
    "name": "movetimeoutevent",
    "ttl": 0,
    "properties": [
        {
            "name": "id",
            "type": "string",
            "pk-index": 0
        },
        {
            "name": "packageid",
            "type": "string"
        },
        {
            "name": "timeoutinmillis",
            "type": "integer"
        }
    ]  
}

package tuple is always stored in network, while the other tuples moveevent and movetimeoutevent are removed after usage as ttl is given as 0. During startup PACKAGE1 is asserted into network.

Consider system having incoming packages. In order to move packages from source to destination we have steps like sitting,moving,dropped and delayed. When the first event sitting comes, package is scheduled to 10s timeout. Within 10s if we receive moving event then scheduled timeout event will get canceled. Otherwise package is marked as delayed and retracted from network.

Package State Info

In detail, above image represents state change for a given package. Consider insert package event this will insert a package into network with state as normal. This package now accepts only sitting event. When sitting event is triggered, a 10 seconds timer is created to trigger delayed event, within 10s only moving event can cancel the timer and state is changed to moving otherwise delayed event gets triggered. If dropped event occurs on a package with moving state, then package state is changed to dropped. Any package with state as dropped or delayed is retracted from network. You have to insert the package again to use.

Actions used here

aJoinMoveEventAndPackage : If targetstate value sitting then package is scheduled to movetimeoutevent by 10 seconds.
aPrintMoveEvent: Prints received moveevents and store packages into network based on targetstate.
aMoveTimeoutEvent: Prints received movetimeoutevent.
aJoinMoveTimeoutEventAndPackage: Package is modified to moveevent target state.
aPackageInSitting: Prints package as sitting.
aPackageInMoving: Prints package as moving.
aPackageInDropped: Prints package as dropped and retracts package tuple from network.
aPackageInDelayed: Prints package as delayed and retracts package tuple from network.

Usage

Get the repo and in this example main.go, functions.go both are available. We can directly build and run the app or create flogo rule app and run it.

Direct build and run

cd $GOPATH/src/github.com/project-flogo/rules/examples/flogo/trackntrace
go build
./trackntrace

Create app using flogo cli

cd $GOPATH/src/github.com/project-flogo/rules/examples/flogo/trackntrace
flogo create -f flogo.json trackNTraceApp
cp functions.go trackNTraceApp/src
cd trackNTraceApp
flogo build
./bin/trackNTraceApp

Moveevent test

Run below command to trigger moveevent action on PACKAGE1.

curl http://localhost:7777/moveevent?packageid=PACKAGE1\&targetstate=sitting

Above commands results in executing action aJoinMoveEventAndPackage. Action aJoinMoveEventAndPackage results in changing state of PACKAGE1 to sitting this will trigger another action aPackageInSitting. Also with 10 seconds timer aJoinMoveTimeoutEventAndPackage gets triggered. Action aJoinMoveTimeoutEventAndPackage results in changing state of PACKAGE1 to delayed this will trigger another action aPackageInDelayed. Action aPackageInDelayed retracts package from network. So chain of actions getting executed.

Expected output:

Received a 'moveevent' [01DDMW3RMDPKS5JR8JWAMY2VT2] target state [sitting]
Joining a 'moveevent' with packageid [PACKAGE1] to package [PACKAGE1], target state [sitting]
Starting a 10s timer.. [PACKAGE1]
PACKAGE [PACKAGE1] is Sitting
Received a 'movetimeoutevent' id [01DDMW3RMD03JAJGQ35VZB1QP8], packageid [PACKAGE1], timeoutinmillis [10000]
Joining a 'movetimeoutevent' [PACKAGE1] to package [PACKAGE1], timeout [10000]
PACKAGE [PACKAGE1] is Delayed

Above we can see PACKAGE1 is chnaged to delayed as moving event is not triggered in scheduled 10s interval. Restart the rules app and run the below command.

curl http://localhost:7777/moveevent?packageid=PACKAGE1\&targetstate=sitting
curl http://localhost:7777/moveevent?packageid=PACKAGE1\&targetstate=moving

Expected output:

Received a 'moveevent' [01DDMW5J161J3W9P9SN1GDH3DN] target state [sitting]
Joining a 'moveevent' with packageid [PACKAGE1] to package [PACKAGE1], target state [sitting]
Starting a 10s timer.. [PACKAGE1]
PACKAGE [PACKAGE1] is Sitting
Received a 'moveevent' [01DDMW5JXFMY4W0MC6NYRQDZ9H] target state [moving]
Joining a 'moveevent' with packageid [PACKAGE1] to package [PACKAGE1], target state [moving]
Cancelling timer attached to key [PACKAGE1]
PACKAGE [PACKAGE1] is Moving

Package Insert

Execute below command to store PACKAGE2

curl http://localhost:7777/moveevent?packageid=PACKAGE2\&targetstate=normal

Expected output:

Received a 'moveevent' [01DDMW6EK0Z9D4KJ0ZGXP6K0WM] target state [normal]
Tuple inserted successfully:  PACKAGE2
Received package [PACKAGE2]