Add Circuit Breaker docs (ThreeDotsLabs#390)

m110 · web-flow · commit 8a6ed54502ad · 2023-09-12T16:04:05.000+02:00
diff --git a/message/router/middleware/circuit_breaker.go b/message/router/middleware/circuit_breaker.go
@@ -5,16 +5,22 @@ import (
 	"github.com/sony/gobreaker"
 )
 
+// CircuitBreaker is a middleware that wraps the handler in a circuit breaker.
+// Based on the configuration, the circuit breaker will fail fast if the handler keeps returning errors.
+// This is useful for preventing cascading failures.
 type CircuitBreaker struct {
 	cb *gobreaker.CircuitBreaker
 }
 
+// NewCircuitBreaker returns a new CircuitBreaker middleware.
+// Refer to the gobreaker documentation for the available settings.
 func NewCircuitBreaker(settings gobreaker.Settings) CircuitBreaker {
 	return CircuitBreaker{
 		cb: gobreaker.NewCircuitBreaker(settings),
 	}
 }
 
+// Middleware returns the CircuitBreaker middleware.
 func (c CircuitBreaker) Middleware(h message.HandlerFunc) message.HandlerFunc {
 	return func(msg *message.Message) ([]*message.Message, error) {
 		out, err := c.cb.Execute(func() (interface{}, error) {

Original file line number	Diff line number	Diff line change
`@@ -5,16 +5,22 @@ import (`
`5`	`5`	`"github.com/sony/gobreaker"`
`6`	`6`	`)`
`7`	`7`
	`8`	`+// CircuitBreaker is a middleware that wraps the handler in a circuit breaker.`
	`9`	`+// Based on the configuration, the circuit breaker will fail fast if the handler keeps returning errors.`
	`10`	`+// This is useful for preventing cascading failures.`
`8`	`11`	`type CircuitBreaker struct {`
`9`	`12`	`cb *gobreaker.CircuitBreaker`
`10`	`13`	`}`
`11`	`14`
	`15`	`+// NewCircuitBreaker returns a new CircuitBreaker middleware.`
	`16`	`+// Refer to the gobreaker documentation for the available settings.`
`12`	`17`	`func NewCircuitBreaker(settings gobreaker.Settings) CircuitBreaker {`
`13`	`18`	`return CircuitBreaker{`
`14`	`19`	`cb: gobreaker.NewCircuitBreaker(settings),`
`15`	`20`	`}`
`16`	`21`	`}`
`17`	`22`
	`23`	`+// Middleware returns the CircuitBreaker middleware.`
`18`	`24`	`func (c CircuitBreaker) Middleware(h message.HandlerFunc) message.HandlerFunc {`
`19`	`25`	`return func(msg message.Message) ([]message.Message, error) {`
`20`	`26`	`out, err := c.cb.Execute(func() (interface{}, error) {`