damianopetrungaro/circuit-breaker

A Circuit breaker written in PHP

v1.0.1 2019-08-10 14:21 UTC

Requires

• myclabs/php-enum: ^1.7

Requires (Dev)

• behat/behat: ^3.5
• damianopetrungaro/php-commitizen: ^0.1.2
• friendsofphp/php-cs-fixer: ^2.15
• jangregor/phpstan-prophecy: ^0.4.2
• phpstan/phpstan: ^0.11.12
• phpunit/phpunit: ^8.3

MIT

• Damiano Petrungaro

README

This is a circuit breaker implementation for PHP applications.

The library is tested with integration and functional tests in order to make you feel more comfortable about it.

Later unit tests will be added too.

Installation

php composer.phar require damianopetrungaro/circuit-breaker

How does it work?

This circuit breaker implementation wrap the function that you want to execute inside a callable (a function or an invokable object).

The function is then passed across the different middleware stages that an be used.

It's really easy to add your own custom middleware (such as a delay or even logging). Take a look to the Retry middleware as an example.

Example

This is a basic example using an in memory adapter with a retry middleware.

<?php

use DamianoPetrungaro\CircuitBreaker\DefaultCircuitBreaker;
use DamianoPetrungaro\CircuitBreaker\Middleware\Base;
use DamianoPetrungaro\CircuitBreaker\Middleware\Retries;
use DamianoPetrungaro\CircuitBreaker\State\DetermineState;
use DamianoPetrungaro\CircuitBreaker\State\Persistence\InMemory;

$determineState = new DetermineState();
$resetTimeout = new DateInterval('PT10S');
$persistence = new InMemory($determineState,$maxFailure = 5,$resetTimeout);
$circuitBreaker = new DefaultCircuitBreaker($persistence, new Retries($persistence, new Base()));
$circuitBreaker->execute(static function (): string {
    // Retrieve the username from the db...
    // Log possible failure...
    return 'username';
});

You can find more examples in the examples directory.