update ci (#4)

Author: Dean Karn

.github/workflows/go.yml

@@ -1,35 +1,43 @@
 name: Lint & Test
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, edited, reopened, synchronize]
 jobs:
   test:
     strategy:
       matrix:
-        go-version: [1.17.x]
+        go-version: [1.20.x,1.19.x,1.18.x,1.17.x]
         platform: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
       - name: Install Go
-        uses: actions/setup-go@v1
+        uses: actions/setup-go@v3
         with:
           go-version: ${{ matrix.go-version }}
 
-      - name: Priming Cache
-        uses: actions/cache@v1
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Restore Cache
+        uses: actions/cache@v3
         with:
           path: ~/go/pkg/mod
-          key: ${{ runner.os }}-v2-go-${{ hashFiles('**/go.sum') }}
+          key: ${{ runner.os }}-v3-go-${{ hashFiles('**/go.sum') }}
           restore-keys: |
-            ${{ runner.os }}-v2-go-
-
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Lint
-        if: matrix.platform == 'ubuntu-latest' && matrix.go-version == '1.17.x'
-        run: |
-          export PATH=$PATH:$(go env GOPATH)/bin # temporary fix. See https://github.com/actions/setup-go/issues/14
-          go get -u golang.org/x/lint/golint
-          golint -set_exit_status ./...
+            ${{ runner.os }}-v3-go-
 
       - name: Test
-        run: go test ./...
+        run: go test -race -cover ./...
+
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: latest

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.2.0] - 2023-05-07
+### Added
+- Added MaxAttempts(..) to configuration and ErrorMaxAttemptsReached to be returned by the Sleep(...) function when configured. 
+
+[Unreleased]: https://github.com/go-playground/backoff-sys/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/go-playground/backoff-sys/commit/v1.2.0

Makefile

@@ -0,0 +1,12 @@
+GOCMD=GO111MODULE=on go
+
+test:
+	$(GOCMD) test -cover -race ./...
+
+bench:
+	$(GOCMD) test -run=NONE -bench=. -benchmem  ./...
+
+lint:
+	golangci-lint run
+
+.PHONY: lint test bench

README.md

@@ -1,6 +1,6 @@
 ## Package backoff-sys
 
-<img align="right" src="https://raw.githubusercontent.com/go-playground/backoff-sys/master/logo.jpg">![Project status](https://img.shields.io/badge/version-1.1.1-green.svg)
+<img align="right" src="https://raw.githubusercontent.com/go-playground/backoff-sys/master/logo.jpg">![Project status](https://img.shields.io/badge/version-1.2.0-green.svg)
 [![Actions Status](https://github.com/go-playground/backoff-sys/workflows/Lint%20%26%20Test/badge.svg)](https://github.com/go-playground/backoff-sys/actions)
 [![GoDoc](https://godoc.org/github.com/go-playground/backoff-sys?status.svg)](https://pkg.go.dev/github.com/go-playground/backoff-sys)
 ![License](https://img.shields.io/dub/l/vibe-d.svg)

exponential.go

@@ -2,17 +2,23 @@ package backoff
 
 import (
 	"context"
+	"errors"
 	"math"
 	"math/rand"
 	"time"
 )
 
+var (
+	ErrMaxAttemptsReached = errors.New("max attempts reached")
+)
+
 // ExponentialBuilder helps to build the final exponential backoff entity
 type ExponentialBuilder struct {
-	factor   float64
-	interval time.Duration
-	jitter   time.Duration
-	max      time.Duration
+	factor      float64
+	interval    time.Duration
+	jitter      time.Duration
+	max         time.Duration
+	maxAttempts int
 }
 
 // NewExponential create a new exponential backoff builder with sane defaults.
@@ -49,22 +55,31 @@ func (e ExponentialBuilder) Max(max time.Duration) ExponentialBuilder {
 	return e
 }
 
+// MaxAttempts sets the maximum number of attempts before the Sleep(...) function begins returning
+// ErrMaxAttemptsReached, by default is unlimited.
+func (e ExponentialBuilder) MaxAttempts(max int) ExponentialBuilder {
+	e.maxAttempts = max
+	return e
+}
+
 // Init returns a read-only(thread safe) Exponential backoff entity for use.
 func (e ExponentialBuilder) Init() Exponential {
 	return Exponential{
-		factor:   e.factor,
-		interval: float64(e.interval),
-		jitter:   int64(e.jitter),
-		max:      int64(e.max),
+		factor:      e.factor,
+		interval:    float64(e.interval),
+		jitter:      int64(e.jitter),
+		max:         int64(e.max),
+		maxAttempts: e.maxAttempts,
 	}
 }
 
 // Exponential is the final read-only(thread safe) backoff entity
 type Exponential struct {
-	factor   float64
-	interval float64
-	jitter   int64
-	max      int64
+	factor      float64
+	interval    float64
+	jitter      int64
+	max         int64
+	maxAttempts int
 }
 
 // Duration accepts attempt and returns the backoff duration o sleep for.
@@ -81,7 +96,12 @@ func (e Exponential) Duration(attempt int) time.Duration {
 }
 
 // Sleep is a convenience function wrapping Duration and allowing the sleep time to be cancelled via the Context.
+//
+// This function can also return ErrMaxAttemptsReached if the max attempts have been reached.
 func (e Exponential) Sleep(ctx context.Context, attempt int) error {
+	if e.maxAttempts > 0 && attempt >= e.maxAttempts {
+		return ErrMaxAttemptsReached
+	}
 	t := time.NewTimer(e.Duration(attempt))
 	defer t.Stop()
 	select {

exponential_test.go

@@ -0,0 +1,23 @@
+package backoff
+
+import (
+	. "github.com/go-playground/assert/v2"
+
+	"context"
+	"testing"
+	"time"
+)
+
+func TestExponentialBackoff(t *testing.T) {
+	ctx, cancel := context.WithCancel(context.Background())
+	bo := NewExponential().Max(time.Millisecond * 50).Interval(time.Millisecond * 25).Jitter(time.Millisecond * 10).MaxAttempts(5).Init()
+	Equal(t, bo.Sleep(ctx, 0), nil)
+	Equal(t, bo.Sleep(ctx, 1), nil)
+	Equal(t, bo.Sleep(ctx, 2), nil)
+	Equal(t, bo.Sleep(ctx, 3), nil)
+	Equal(t, bo.Sleep(ctx, 4), nil)
+	Equal(t, bo.Sleep(ctx, 5), ErrMaxAttemptsReached)
+
+	cancel()
+	Equal(t, bo.Sleep(ctx, 0), context.Canceled)
+}

go.mod

@@ -1,3 +1,5 @@
 module github.com/go-playground/backoff-sys
 
 go 1.14
+
+require github.com/go-playground/assert/v2 v2.2.0

go.sum

@@ -0,0 +1,2 @@
+github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s=
+github.com/go-playground/assert/v2 v2.2.0/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4=