remove createProxies

[katzIdo]

General description

remove createProxies from the API

createProxies has 2 benefits.

1. it allows creating multi proxies in 1 function
2. it has isAsync flag which resolves a proxy after it registered in the registry

both operations are not needed.

1. the configuration is almost the same so it does not save code.
2. async router solves the problem of requesting a service before it is available in the registry in a better way.

API

Design proposition

A clear and concise description of the design proposition.

• Changes existing API

• Removes existing API

Pull Request

[Link]

Old API

Code snippet

/**
 * @interface Microservice
 * Provides the functionality of a microservice container
 */
export interface Microservice {
  /**
   * @method destroy
   * The method is used to delete a microservice and close all the subscriptions related with it
   */
  destroy: () => Promise<any>;

  /**
   * @method createProxies
   * Create a map of proxies or Promises to proxy. (deepened on configuration)
   */
  createProxies: CreateProxies;

  /**
   * @method createProxy
   * Creates a proxy to a method and provides extra logic when is invoked
   */
  createProxy: CreateProxy;

  /**
   * @method createServiceCall
   * Exposes serviceCall to a user (not via Proxy)
   */
  createServiceCall: CreateServiceCall;
}

New API

Code snippet

/**
 * @interface Microservice
 * Provides the functionality of a microservice container
 */
export interface Microservice {
  /**
   * @method destroy
   * The method is used to delete a microservice and close all the subscriptions related with it
   */
  destroy: () => Promise<any>;

  /**
   * @method createProxy
   * Creates a proxy to a method and provides extra logic when is invoked
   */
  createProxy: CreateProxy;

  /**
   * @method createServiceCall
   * Exposes serviceCall to a user (not via Proxy)
   */
  createServiceCall: CreateServiceCall;
}

Behavior

Consideration

1. remove/modify tests that use createProxies
2. remove createProxies from documentation

Ready for implementation

• API has been approved

• Discussed with Technical lead

Definition of Done

• Developer review

• QA review

• Documentation