== Vert.x Circuit Breaker

Vert.x Circuit Breaker is an implementation of the Circuit Breaker _pattern_ for Vert.x.

It keeps track of the
number of failures and _open the circuit_ when a threshold is reached. Optionally, a fallback is executed.

Supported failures are:

* failures reported by your code in a `link:../../jsdoc/module-vertx-js_future-Future.html[Future]`
* exception thrown by your code
* uncompleted futures (timeout)

Operations guarded by a circuit breaker are intended to by non-blocking and asynchronous in order to benefits from
the Vert.x execution model.

== Using the vert.x circuit breaker

To use the Vert.x Circuit Breaker, add the following dependency to the _dependencies_ section of your build
descriptor:

* Maven (in your `pom.xml`):

[source,xml,subs="+attributes"]
----
<dependency>
  <groupId>io.vertx</groupId>
  <artifactId>vertx-circuit-breaker</artifactId>
  <version>3.3.0</version>
</dependency>
----

* Gradle (in your `build.gradle` file):

[source,groovy,subs="+attributes"]
----
compile 'io.vertx:vertx-circuit-breaker:3.3.0'
----

== Using the circuit breaker

To use the circuit breaker you need to:

1. Create a circuit breaker, with the configuration you want (timeout, number of failure before opening the circuit)
2. Execute some code using the breaker

Here is an example:

[source,js]
----
var CircuitBreaker = require("vertx-circuit-breaker-js/circuit_breaker");
var breaker = CircuitBreaker.create("my-circuit-breaker", vertx, {
  "maxFailures" : 5,
  "timeout" : 2000,
  "fallbackOnFailure" : true,
  "resetTimeout" : 10000
});

breaker.execute(function (future) {
  // some code executing with the breaker
  // the code reports failures or success on the given future.
  // if this future is marked as failed, the breaker increased the
  // number of failures
}).setHandler(function (ar, ar_err) {
  // Get the operation result.
});

----

The executed block receives a `link:../../jsdoc/module-vertx-js_future-Future.html[Future]` object as parameter, to denote the
success or failure of the operation as well as the result. For example in the following example, the result is the
output of a REST endpoint invocation:

[source,js]
----
var CircuitBreaker = require("vertx-circuit-breaker-js/circuit_breaker");
var breaker = CircuitBreaker.create("my-circuit-breaker", vertx, {
  "maxFailures" : 5,
  "timeout" : 2000
});

breaker.execute(function (future) {
  vertx.createHttpClient().getNow(8080, "localhost", "/", function (response) {
    if (response.statusCode() !== 200) {
      future.fail("HTTP error");
    } else {
      response.exceptionHandler(future.fail).bodyHandler(function (buffer) {
        future.complete(buffer.toString());
      });
    }
  });
}).setHandler(function (ar, ar_err) {
  // Do something with the result
});

----

The result of the operation is provided using the:

* returned `link:../../jsdoc/module-vertx-js_future-Future.html[Future]` when calling `execute` methods
* provided `link:../../jsdoc/module-vertx-js_future-Future.html[Future]` when calling the `executeAndReport` methods

Optionally, you can provide a fallback executed when the circuit is open:

[source,js]
----
var CircuitBreaker = require("vertx-circuit-breaker-js/circuit_breaker");
var breaker = CircuitBreaker.create("my-circuit-breaker", vertx, {
  "maxFailures" : 5,
  "timeout" : 2000
});

breaker.executeWithFallback(function (future) {
  vertx.createHttpClient().getNow(8080, "localhost", "/", function (response) {
    if (response.statusCode() !== 200) {
      future.fail("HTTP error");
    } else {
      response.exceptionHandler(future.fail).bodyHandler(function (buffer) {
        future.complete(buffer.toString());
      });
    }
  });
}, function (v) {
  // Executed when the circuit is opened
  return "Hello"
}).setHandler(function (ar, ar_err) {
  // Do something with the result
});

----

The fallback is called whenever the circuit is open, or if the
`link:../dataobjects.html#CircuitBreakerOptions#isFallbackOnFailure[isFallbackOnFailure]` is enabled. When a fallback is
set, the result is using the output of the fallback function. The fallback function takes as parameter a
`Throwable` object and returned an object of the expected type.

The fallback can also be set on the `link:../../jsdoc/module-vertx-circuit-breaker-js_circuit_breaker-CircuitBreaker.html[CircuitBreaker]` object directly:

[source,js]
----
var CircuitBreaker = require("vertx-circuit-breaker-js/circuit_breaker");
var breaker = CircuitBreaker.create("my-circuit-breaker", vertx, {
  "maxFailures" : 5,
  "timeout" : 2000
}).fallback(function (v) {
  // Executed when the circuit is opened.
  return "hello"
});

breaker.execute(function (future) {
  vertx.createHttpClient().getNow(8080, "localhost", "/", function (response) {
    if (response.statusCode() !== 200) {
      future.fail("HTTP error");
    } else {
      response.exceptionHandler(future.fail).bodyHandler(function (buffer) {
        future.complete(buffer.toString());
      });
    }
  });
});

----

== Callbacks

You can also configures callbacks invoked when the circuit is opened or closed:

[source,js]
----
var CircuitBreaker = require("vertx-circuit-breaker-js/circuit_breaker");
var breaker = CircuitBreaker.create("my-circuit-breaker", vertx, {
  "maxFailures" : 5,
  "timeout" : 2000
}).openHandler(function (v) {
  console.log("Circuit opened");
}).closeHandler(function (v) {
  console.log("Circuit closed");
});

breaker.execute(function (future) {
  vertx.createHttpClient().getNow(8080, "localhost", "/", function (response) {
    if (response.statusCode() !== 200) {
      future.fail("HTTP error");
    } else {
      // Do something with the response
      future.complete();
    }
  });
});

----

You can also be notified when the circuit breaker decide to attempt to reset (half-open state). You can register
such as callback with `link:../../jsdoc/module-vertx-circuit-breaker-js_circuit_breaker-CircuitBreaker.html#halfOpenHandler[halfOpenHandler]`.

== Event bus notification

Every time the circuit state changes, an event is published on the event bus. The address on which the event are
sent is configurable with
`link:../dataobjects.html#CircuitBreakerOptions#setNotificationAddress[notificationAddress]`. If `null` is
passed to this method, the notifications are disabled. By default, the used address is `vertx.circuit-breaker`.

Each event contains a Json Object with:

* `state` : the new circuit breaker state (`OPEN`, `CLOSED`, `HALF_OPEN`)
* `name` : the name of the circuit breaker
* `failures` : the number of failures
* `node` : the identifier of the node (`local` is Vert.x is not running in cluster mode)

== The half-open state

When the circuit is “open,” calls to the circuit breaker fail immediately, without any attempt to execute the real
operation. After a suitable amount of time (configured from
`link:../dataobjects.html#CircuitBreakerOptions#setResetTimeout[resetTimeout]`, the circuit breaker decides that the
operation has a chance of succeeding, so it goes into the `half-open` state. In this state, the next call to the
circuit breaker is allowed to execute the dangerous operation. Should the call succeed, the circuit breaker resets
and returns to the `closed` state, ready for more routine operation. If this trial call fails, however, the circuit
breaker returns to the `open` state until another timeout elapses.


