Giter VIP home page Giter VIP logo

repeater's Introduction

Repeater Build Status Go Report Card Coverage Status

Repeater calls a function until it returns no error, up to some number of iterations and delays defined by strategy. It terminates immediately on err from the provided (optional) list of critical errors.

Install and update

go get -u github.com/go-pkgz/repeater

How to use

New Repeater created by New(strtg strategy.Interface) or shortcut for default - NewDefault(repeats int, delay time.Duration) *Repeater.

To activate invoke Do method. Do repeats func until no error returned. Predefined (optional) errors terminate the loop immediately.

func (r Repeater) Do(ctx context.Context, fun func() error, errors ...error) (err error)

Repeating strategy

User can provide his own strategy implementing the interface:

type Interface interface {
	Start(ctx context.Context) chan struct{}
}

Returned channels used as "ticks," i.e., for each repeat or initial operation one read from this channel needed. Closing the channel indicates "done with retries." It is pretty much the same idea as time.Timer or time.Tick implements. Note - the first (technically not-repeated-yet) call won't happen until something sent to the channel. For this reason, the typical strategy sends the first "tick" before the first wait/sleep.

Three strategies provided byt the package:

  1. Fixed delay, up to max number of attempts. It is the default strategy used by repeater.NewDefault constructor.
  2. BackOff with jitter provides an exponential backoff. It starts from Duration interval and goes in steps with last * math.Pow(factor, attempt). Optional jitter randomizes intervals a little. Factor = 1 effectively makes this strategy fixed with Duration delay.
  3. Once strategy does not do any repeats and mainly used for tests/mocks`.

repeater's People

Contributors

paskal avatar umputun avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

repeater's Issues

memory leak

I seems to find memory leak in Fixed Delay strategy but it may be in others.

if use shorted delay that repeats fun execution time then publisher routine will have locked on sending to signals channel.

maybe should use select for send.

select {
case <-ctx.Done():
	return
case ch <- struct{}{}:
	sleep(ctx, s.Delay)
}

instead

select {
case <-ctx.Done():
return
default:
ch <- struct{}{}
sleep(ctx, s.Delay)
}

func TestRepeaterMemoryLeak(t *testing.T) {
	unit := func(amout int) time.Duration {
		return time.Duration(amout) * 10 * time.Millisecond
	}

	leak := func() error {
		ctx, cancel := context.WithTimeout(context.Background(), unit(3))
		defer cancel()
		err := NewDefault(3, unit(1)).Do(ctx, func() error {
			time.Sleep(unit(2))

			select {
			case <-ctx.Done():
				return nil
			default:
				return fmt.Errorf("some err")
			}
		})
		return err
	}

	before := runtime.NumGoroutine()
	num := []int{}
	for i := 0; i <= 25; i++ {
		leak()
		num = append(num, runtime.NumGoroutine())
	}
	after := runtime.NumGoroutine()
	require.False(t, after > before, "looks like you have goroutines leak: %+v", num)
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.