capsulajs / capsulajs

3 stars 0 forks source link

Environment Adaptor (prev. Invoker) for mp-reactive-services #20

Open dmitriyslaym opened 5 years ago

dmitriyslaym commented 5 years ago

General description

EnvAdaptor service is responsible for connecting to environment, send request to methods of this environment and expose logs. This service is specific to mp-reactive-services. We will probably define other adaptors in the future for other projects. The contract and the test cases of the service will be in capsula, the implementation should be in mp-reactive-services.

Prerequisites

None.

API

// DRAFT
interface EnvAdaptor {
  connect(connectRequest: ConnectRequest) : Promise<ConnectResponse>;
  disconnect(disconnectRequest: DisconnectRequest) : Promise<DisconnectResponse>;
  send(sendRequest: SendRequest): Promise<void>;
  logs(logsRequest: LogsRequest): Observable<LogEvent>;
}

Design description

A clear and concise description of the design proposition.

Behavior

TODO

Test cases

TODO

Ready for implementation

Definition of Done

idanilt commented 5 years ago

@dmitriyslaym @stephanebenayoun I suggest that as long it's just a one line maybe issue, do all of them in backlog general issue or if it's related to a project board like "MVP" put it in txt in the board