telefonicaid / rush

Http - Relayer

Rush

• Would you like to make effortless Async HTTP request?
• Do yo want to track the state of your relayed requests?
• Add automatic retransmissions/retries of your request?
• Do you need callbacks when your request is finished?
• Keep an historic record of custom information related to the request?

Rush implements an scalable mechanism to provide such functionality, with minor client impact (Header stamping HTTP API).

Rush has been developed using:

Ask us for your OpenSource License

Still interested?, visit our WIKI and DOCS section.

rush's Issues

Documentation review

Add a guide for deploying rush services

Multipolicy mechanism

Try to keep policies as independent as possible and able to be combined.

Provide Topic/UserSecret Support

Propagates an end user field to empower search and usage

Add Async/http-callback policie

Add persistence policie

Add flow control to consumer

Avoid run too fast at consumer (max_num_jobs)

Producer - Consumer Infrastructure

Enable GRE-Tunneling

Rush should be configured with a list of avaliable tunnels, and a dispatching mechanism based on TOPIC Header F(topic)->tunnel

Support Proxying for outgoing connections

State Proxy at Config file

May be interesting to provide Proxy also as a Header Policy

Provide Custom ID

Reuse end user id for transactions (normal behaviour as default)

Rethink and refactor URL PATH, PORT, PARAMS

Performance tests

Performance tests for each policy

Implement "last retry".onError behaviour

Last Alpha Refactoring + Master Merge Version Alpha closed

Improve reliability

Automate performance Testing

Simple performance test

Think about Asinc Service Comunication

For M2M scenario

Isolate Database

Create "DAO" infrastructure to decouple DB dependency

Test for Alpha (Integration and performance)

Include 'x-relayer-encoding' in the log output

Implement Retrieve Policy

Javascript coding style guide

to honour internal guidelines

Odd behaviour when MongoDB is not running

When MongoDB is not running if a listener and a consumer are launched, they don't die but request are not processed. Request are only processed when MongoDB is up when the consumer and the listener are being launched even though MongoDB dies later.

add file header

//
// Copyright (c) Telefonica I+D. All rights reserved.
//
//

at least

Documentation about how to install&deploy Rush

User manual for Alpha

Inconsistent 'resultOk'

When a petition is completed, the type of "resultOk" is different depending on the policy specified. resultOk is a "string" ("true" or "false") when a persistence policy is specified. resultOk is a boolean (true or false) when a callback policy is specified.
Exactly the same happens with the field "statusCode". It's a number when a callback policy is specified but a string when a persistence policy is specified.

Error must be thrown on invalid host

curl -v -H "X-Relayer-Host:http://" -H "X-relayer-persistence: BODY" http://localhost:3001/ and
curl -v -H "X-Relayer-Host:https://" -H "X-relayer-persistence: BODY" http://localhost:3001/ return a valid id but they must retun an error because host is not specified.

Config file

First approach

config.js

Tech Review Documentation

Index, Slides or Graphs

Think about Reliability

Option: Reliable Worker

Implement binary friendly behaviour

It would be a good idea to allow Rush to manage binary files in the response bodies (e.g: images)

Transfer to TelefonicaID repository

Add licensing (AGPL) and Refactor

Demo for TechReview

Think about some demo:

Command line demo || UseCase Demo || Performance Demo

We must show "software"

Add Relay (one way) policie

Infinite loop

curl -v --header "X-Relay-Host:http://RushHost:3001" http://RushHost:3001/ causes infinite loop.

Deployment tools: first steps

Create scripts and frontend for deployment task.

More file types as text in .gitattributes

Some addtional extensions could be treated as text

• *.json
• *.yml
• README.md

--

Foo

Improve immutability for Event Data at AddOns

Inconsistent header field

The header field has a different type depending on the applied policy. If HTTPCallback policy is applied, the header field is an object while if persistence policy is applied, the header field is a string. Example:
HTTPCallBack: "headers":{"content-type":"application/json","personal-header-1":"TEST1","personal-header-2":"TEST2","host":"localhost:8014","connection":"keep-alive","transfer-encoding":"chunked"}
Persistence: {"headers":"{"content-type":"application/json","personal-header-1":"TEST1","personal-header-2":"TEST2","host":"localhost:8014","connection":"keep-alive","transfer-encoding":"chunked"}

Throw error on invalid persistence type

An invalid type of persistence such as this: "X-relayer-persistence : FAKE" , doesn`t throw any kind of error, just an identificator.

Add retry policy support

RETRY a Relay

Options

X-Relayer-retry=4 (consecutives retries)
X-Relayer-retry=[2,10,5000,5002](retry in ms)

Multicast policy

Basic Flavour

Extended Multicast may require a new worker type

Develop test suite for Rush

A test suite is going to be developed for testing Rush features using Mocha.js framework

Decouple/Warp POLICIE-Callback from transport

In order to allow new transports if needed (function warp at least)

Add Historic DB support

An empty listener module makes consumer stop working

exports.consumer.evModules = [
X, ,Y
]

No error reported, no exception, no crash. Consumer does not work

(Review Listener, PopBox also)

Callback policy fails (no error) if not Persistence Defined

Add a logging system