defaultRouter option in microservice API

[katzIdo]

General description

add option to configurate default router in microservice API.

creating a template for scalecube with default values is a bit complicated when trying to have a default router for the dependencyHook.

a template can for sclaecube-microservice such browser or node can override the API.

but when passing a callback reference (dependency hook) then scalecube will provide the default createProxy behavior of sclaecube-microservice (without the default router)

this lead to confusing behavior:
when using createProxy from ms container is will have the deafult router.
when using creteProxy from dependencyHook it will use sclaecube-microservice (without the default router)

API

Design proposition

A clear and concise description of the design proposition.

• Is backward compatible

• Changes existing API

Pull Request

[Link]

Old API

Code snippet

New API

Code snippet

interface MicroserviceOptions {
  defaultRouter ?: Router
}

Behavior

in case there is no default router and we don't provide a default router, then an exception will occur.

Test cases

Given a microservice container without setting defaultRouter
When calling createProxy without providing a router
Then exception will occur

Given a microservice container without setting defaultRouter
When calling createProxy  from dependencyHook without providing a router
Then exception will occur

Ready for implementation

• API has been approved

• Test cases have been prepared

• Discussed with Technical lead

Definition of Done

• Developer review

• All tests are implemented

• Documentation