add delayed errors (#7)

gregoryduquesnoy · jfbus · commit f5f67393a01a · 2019-02-05T18:16:13.000+01:00
* Adding DelayedError

* minor fix

* langage optimization
diff --git a/README.md b/README.md
@@ -2,6 +2,27 @@
 
 `go get github.com/objenious/errorutil`
 
+## Delayed errors
+
+```go
+func foo() error {
+	err := bar()
+	timer := time.Hour
+	if err != nil {
+		// it should be delayed 1h later
+		return errorutil.WithDelay(err, timer) 
+	}
+	return bar() // will not be delayed
+}
+
+func main() {
+	err := foo()
+	time.AfterFunc(errorutil.Delay(err), func() {
+		...
+	})
+}
+```
+
 ## Retryable errors
 
 ```go
diff --git a/delayed.go b/delayed.go
@@ -0,0 +1,58 @@
+package errorutil
+
+import (
+	"github.com/pkg/errors"
+	"time"
+)
+
+// Delayer defines an error that
+type Delayer interface {
+	Delay() time.Duration
+}
+
+// Delay return the delay duration of a DelayedError (i.e. implements Delayer).
+// If the error is nil or does not implement Delayer or the delay is not a positive value, 0 is returned.
+func Delay(err error) time.Duration {
+	type causer interface {
+		Cause() error
+	}
+
+	for err != nil {
+		if delay, ok := err.(Delayer); ok {
+			return delay.Delay()
+		}
+		cause, ok := err.(causer)
+		if !ok {
+			break
+		}
+		err = cause.Cause()
+	}
+	return 0
+}
+
+// DelayedError set error delay duration.  returns nil if the error is nil.
+func WithDelay(err error, duration time.Duration) error {
+	if err == nil {
+		return nil
+	}
+	return &delayedError{error: err, duration: duration}
+}
+
+// NewDelayedError returns a delayed error that formats as the given text and duration.
+func NewDelayedError(text string, duration time.Duration) error {
+	return WithDelay(errors.New(text), duration)
+}
+
+type delayedError struct {
+	error
+	duration time.Duration
+}
+
+
+func (err *delayedError) Delay() time.Duration {
+	return err.duration
+}
+
+func (err *delayedError) Cause() error {
+	return err.error
+}
diff --git a/delayed_test.go b/delayed_test.go
@@ -0,0 +1,39 @@
+package errorutil
+
+import (
+	"github.com/pkg/errors"
+	"testing"
+	"time"
+)
+
+func TestDelay(t *testing.T) {
+
+	//	err := errorutil.NewRetryableError("Delayed Error Test")
+	tests := []struct {
+		err  error
+		want time.Duration
+	}{
+		{nil, 0},
+		{WithDelay(nil, 0), 0},
+		{WithDelay(nil, 10), 0},
+		{WithDelay(errors.New("foo"), 0), 0},
+		{WithDelay(errors.New("foo"), 10), 10},
+	}
+	err := WithDelay(errors.New("foobar"), 10)
+	if err.Error() != "foobar" {
+		t.Errorf("WithDelay(%q): got: %v, want %v", err, err.Error(), "foobar")
+	}
+	for _, tt := range tests {
+		got := Delay(tt.err)
+		if got != tt.want {
+			t.Errorf("WithDelay(%q): got: %v, want %v", tt.err, got, tt.want)
+		}
+	}
+}
+
+func TestNewDelayedError(t *testing.T) {
+	err := NewDelayedError("delayed Error", 10)
+	if err.Error() != "delayed Error" {
+		t.Errorf("NewDelayedError expected %s, got %s", "delayed Error", err.Error())
+	}
+}
