deps: import libtime the normal way
Previously we copied this library by hand to avoid vendor-ing a bunch of files related to minimock. Now that we no longer vendor, just import the library normally. Also we might use more of the library for handling `time.After` uses, for which this library provides a Context-based solution.
This commit is contained in:
Seth Hoenig
parent
ea69eda522
commit
04f84bcdfe
|
|
@ -18,10 +18,10 @@ import (
|
|||
"github.com/hashicorp/nomad/client/taskenv"
|
||||
agentconsul "github.com/hashicorp/nomad/command/agent/consul"
|
||||
"github.com/hashicorp/nomad/helper"
|
||||
"github.com/hashicorp/nomad/helper/exptime"
|
||||
"github.com/hashicorp/nomad/nomad/structs"
|
||||
"github.com/hashicorp/nomad/nomad/structs/config"
|
||||
"github.com/pkg/errors"
|
||||
"oss.indeed.com/go/libtime/decay"
|
||||
)
|
||||
|
||||
const envoyBootstrapHookName = "envoy_bootstrap"
|
||||
|
|
@ -277,7 +277,7 @@ func (h *envoyBootstrapHook) Prestart(ctx context.Context, req *ifs.TaskPrestart
|
|||
|
||||
// Since Consul services are registered asynchronously with this task
|
||||
// hook running, retry until timeout or success.
|
||||
if backoffErr := exptime.Backoff(func() (bool, error) {
|
||||
if backoffErr := decay.Backoff(func() (bool, error) {
|
||||
|
||||
// If hook is killed, just stop.
|
||||
select {
|
||||
|
|
@ -324,7 +324,7 @@ func (h *envoyBootstrapHook) Prestart(ctx context.Context, req *ifs.TaskPrestart
|
|||
_ = os.Remove(bootstrapFilePath)
|
||||
|
||||
return true, cmdErr
|
||||
}, exptime.BackoffOptions{
|
||||
}, decay.BackoffOptions{
|
||||
MaxSleepTime: h.envoyBootstrapWaitTime,
|
||||
InitialGapSize: h.envoyBoostrapInitialGap,
|
||||
MaxJitterSize: h.envoyBootstrapMaxJitter,
|
||||
|
|
|
|||
2
go.mod
2
go.mod
|
|
@ -122,6 +122,7 @@ require (
|
|||
google.golang.org/grpc v1.42.0
|
||||
gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7
|
||||
gopkg.in/tomb.v2 v2.0.0-20140626144623-14b3d72120e8
|
||||
oss.indeed.com/go/libtime v1.5.0
|
||||
)
|
||||
|
||||
require (
|
||||
|
|
@ -181,6 +182,7 @@ require (
|
|||
github.com/go-ole/go-ole v1.2.4 // indirect
|
||||
github.com/godbus/dbus/v5 v5.0.4 // indirect
|
||||
github.com/gogo/protobuf v1.3.2 // indirect
|
||||
github.com/gojuno/minimock/v3 v3.0.6 // indirect
|
||||
github.com/golang-jwt/jwt/v4 v4.0.0 // indirect
|
||||
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
|
||||
github.com/google/btree v1.0.0 // indirect
|
||||
|
|
|
|||
7
go.sum
7
go.sum
|
|
@ -522,6 +522,9 @@ github.com/gogo/protobuf v1.3.0/go.mod h1:SlYgWuQ5SjCEi6WLHjHCa1yvBfUnHcTbrrZtXP
|
|||
github.com/gogo/protobuf v1.3.1/go.mod h1:SlYgWuQ5SjCEi6WLHjHCa1yvBfUnHcTbrrZtXPKa29o=
|
||||
github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q=
|
||||
github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=
|
||||
github.com/gojuno/minimock/v3 v3.0.4/go.mod h1:HqeqnwV8mAABn3pO5hqF+RE7gjA0jsN8cbbSogoGrzI=
|
||||
github.com/gojuno/minimock/v3 v3.0.6 h1:YqHcVR10x2ZvswPK8Ix5yk+hMpspdQ3ckSpkOzyF85I=
|
||||
github.com/gojuno/minimock/v3 v3.0.6/go.mod h1:v61ZjAKHr+WnEkND63nQPCZ/DTfQgJdvbCi3IuoMblY=
|
||||
github.com/golang-jwt/jwt/v4 v4.0.0 h1:RAqyYixv1p7uEnocuy8P1nru5wprCh/MH2BIlW5z5/o=
|
||||
github.com/golang-jwt/jwt/v4 v4.0.0/go.mod h1:/xlHOz8bRuivTWchD4jCa+NbatV+wEUSzwAxVc6locg=
|
||||
github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=
|
||||
|
|
@ -788,6 +791,7 @@ github.com/hashicorp/vic v1.5.1-0.20190403131502-bbfe86ec9443/go.mod h1:bEpDU35n
|
|||
github.com/hashicorp/yamux v0.0.0-20180604194846-3520598351bb/go.mod h1:+NfK9FKeTrX5uv1uIXGdwYDTeHna2qgaIlx54MXqjAM=
|
||||
github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d h1:kJCB4vdITiW1eC1vq2e6IsrXKrZit1bv/TDYFGMp4BQ=
|
||||
github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d/go.mod h1:+NfK9FKeTrX5uv1uIXGdwYDTeHna2qgaIlx54MXqjAM=
|
||||
github.com/hexdigest/gowrap v1.1.7/go.mod h1:Z+nBFUDLa01iaNM+/jzoOA1JJ7sm51rnYFauKFUB5fs=
|
||||
github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
|
||||
github.com/hpcloud/tail v1.0.1-0.20170814160653-37f427138745 h1:8as8OQ+RF1QrsHvWWsKBtBKINhD9QaD1iozA1wrO4aA=
|
||||
github.com/hpcloud/tail v1.0.1-0.20170814160653-37f427138745/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
|
||||
|
|
@ -1026,6 +1030,7 @@ github.com/opencontainers/selinux v1.6.0/go.mod h1:VVGKuOLlE7v4PJyT6h7mNWvq1rzqi
|
|||
github.com/opencontainers/selinux v1.8.0/go.mod h1:RScLhm78qiWa2gbVCcGkC7tCGdgk3ogry1nUQF8Evvo=
|
||||
github.com/opencontainers/selinux v1.8.2 h1:c4ca10UMgRcvZ6h0K4HtS15UaVSBEaE+iln2LVpAuGc=
|
||||
github.com/opencontainers/selinux v1.8.2/go.mod h1:MUIHuUEvKB1wtJjQdOyYRgOnLD2xAPP8dBsCoU0KuF8=
|
||||
github.com/opentracing/opentracing-go v1.0.2/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o=
|
||||
github.com/opentracing/opentracing-go v1.1.0/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o=
|
||||
github.com/packethost/packngo v0.1.1-0.20180711074735-b9cb5096f54c h1:vwpFWvAO8DeIZfFeqASzZfsxuWPno9ncAebBEP0N3uE=
|
||||
github.com/packethost/packngo v0.1.1-0.20180711074735-b9cb5096f54c/go.mod h1:otzZQXgoO96RTzDB/Hycg0qZcXZsWJGJRSXbmEIJ+4M=
|
||||
|
|
@ -1862,6 +1867,8 @@ k8s.io/kube-openapi v0.0.0-20201113171705-d219536bb9fd/go.mod h1:WOJ3KddDSol4tAG
|
|||
k8s.io/kubernetes v1.13.0/go.mod h1:ocZa8+6APFNC2tX1DZASIbocyYT5jHzqFVsY5aoB7Jk=
|
||||
k8s.io/utils v0.0.0-20200324210504-a9aa75ae1b89/go.mod h1:sZAwmy6armz5eXlNoLmJcl4F1QuKu7sr+mFQ0byX7Ew=
|
||||
k8s.io/utils v0.0.0-20201110183641-67b214c5f920/go.mod h1:jPW/WVKK9YHAvNhRxK0md/EJ228hCsBRufyofKtW8HA=
|
||||
oss.indeed.com/go/libtime v1.5.0 h1:wulKS+oHhb3P2wFi1fcA+g8CXiC8+ygFECUQea5ZqLU=
|
||||
oss.indeed.com/go/libtime v1.5.0/go.mod h1:B2sdEcuzB0zhTKkAuHy4JInKRc7Al3tME4qWam6R7mA=
|
||||
rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8=
|
||||
rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0=
|
||||
rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA=
|
||||
|
|
|
|||
|
|
@ -1,11 +0,0 @@
|
|||
Copyright (c) 2019 The Indeed Engineering Authors. All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
|
@ -1,142 +0,0 @@
|
|||
// Package exptime provides a generalized exponential backoff retry implementation.
|
||||
//
|
||||
// This package was copied from oss.indeed.com/go/libtime/decay and modified.
|
||||
package exptime
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"math/rand"
|
||||
"time"
|
||||
)
|
||||
|
||||
var (
|
||||
// ErrMaximumTimeExceeded indicates the maximum wait time has been exceeded.
|
||||
ErrMaximumTimeExceeded = errors.New("maximum backoff time exceeded")
|
||||
)
|
||||
|
||||
// A TryFunc is what gets executed between retry wait periods during execution
|
||||
// of Backoff. The keepRetrying return value is used to control whether a retry
|
||||
// attempt should be made. This feature is useful in manipulating control flow
|
||||
// in cases where it is known a retry will not be successful.
|
||||
type TryFunc func() (keepRetrying bool, err error)
|
||||
|
||||
// BackoffOptions allow for fine-tuning backoff behavior.
|
||||
type BackoffOptions struct {
|
||||
// MaxSleepTime represents the maximum amount of time
|
||||
// the exponential backoff system will spend sleeping,
|
||||
// accumulating the amount of time spent asleep between
|
||||
// retries.
|
||||
//
|
||||
// The algorithm starts at an interval of InitialGapSize
|
||||
// and increases exponentially (x2 each iteration) from there.
|
||||
// With no jitter, a MaxSleepTime of 10 seconds and InitialGapSize
|
||||
// of 1 millisecond would suggest a total of 15 attempts
|
||||
// (since the very last retry truncates the sleep time to
|
||||
// align exactly with MaxSleepTime).
|
||||
MaxSleepTime time.Duration
|
||||
|
||||
// InitialGapSize sets the initial amount of time the algorithm
|
||||
// will sleep before the first retry (after the first attempt).
|
||||
// The actual amount of sleep time will include a random amount
|
||||
// of jitter, if MaxJitterSize is non-zero.
|
||||
InitialGapSize time.Duration
|
||||
|
||||
// MaxJitterSize limits how much randomness we may
|
||||
// introduce in the duration of each retry interval.
|
||||
// The purpose of introducing jitter is to mitigate the
|
||||
// effect of thundering herds
|
||||
MaxJitterSize time.Duration
|
||||
|
||||
// RandomSeed is used for generating a randomly computed
|
||||
// jitter size for each retry.
|
||||
RandomSeed int64
|
||||
|
||||
// Sleeper is used to cause the process to sleep for
|
||||
// a computed amount of time. If not set, a default
|
||||
// implementation based on time.Sleep will be used.
|
||||
Sleeper Sleeper
|
||||
}
|
||||
|
||||
// A Sleeper is a useful way for calling time.Sleep
|
||||
// in a mock-able way for tests.
|
||||
type Sleeper func(time.Duration)
|
||||
|
||||
// Backoff will attempt to execute function using a configurable
|
||||
// exponential backoff algorithm. function is a TryFunc which requires
|
||||
// two return parameters - a boolean for optimizing control flow, and
|
||||
// an error for reporting failure conditions. If the first parameter is
|
||||
// false, the backoff algorithm will abandon further retry attempts and
|
||||
// simply return an error. Otherwise, if the returned error is non-nil, the
|
||||
// backoff algorithm will sleep for an increasing amount of time, and
|
||||
// then retry again later, until the maximum amount of sleep time has
|
||||
// been consumed. Once function has executed successfully with no error,
|
||||
// the backoff algorithm returns a nil error.
|
||||
func Backoff(function TryFunc, options BackoffOptions) error {
|
||||
if options.MaxSleepTime <= 0 {
|
||||
panic("max sleep time must be > 0")
|
||||
}
|
||||
|
||||
if options.InitialGapSize <= 0 {
|
||||
panic("initial gap size must be > 0")
|
||||
}
|
||||
|
||||
if options.MaxJitterSize < 0 {
|
||||
panic("max jitter size must be >= 0")
|
||||
}
|
||||
|
||||
if options.MaxJitterSize > (options.MaxSleepTime / 2) {
|
||||
panic("max jitter size is way too large")
|
||||
}
|
||||
|
||||
if options.Sleeper == nil {
|
||||
options.Sleeper = time.Sleep
|
||||
}
|
||||
|
||||
consumed := time.Duration(0)
|
||||
gap := options.InitialGapSize
|
||||
random := rand.New(rand.NewSource(options.RandomSeed))
|
||||
|
||||
for consumed < options.MaxSleepTime {
|
||||
keepRetrying, err := function()
|
||||
if err != nil && !keepRetrying {
|
||||
return fmt.Errorf("exponential backoff instructed to stop retrying: %w", err)
|
||||
}
|
||||
|
||||
// we can ignore keepRetrying at this point, since we know
|
||||
// what to do based on err
|
||||
if err == nil {
|
||||
return nil // success
|
||||
}
|
||||
|
||||
// there was an error, and function wants to keep retrying
|
||||
// we will sleep, and then let the loop continue
|
||||
//
|
||||
// (random.Float64 returns a value [0.0, 1.0), which is used to
|
||||
// randomly scale the jitter from 0 to MaxJitterSize.
|
||||
jitter := nextJitter(random.Float64(), options.MaxJitterSize)
|
||||
duration := gap + jitter
|
||||
|
||||
if (duration + consumed) > options.MaxSleepTime {
|
||||
// this will be our last try, force the duration
|
||||
// to line up with the maximum sleep time
|
||||
duration = options.MaxSleepTime - consumed
|
||||
}
|
||||
|
||||
// sleep for the configured duration
|
||||
options.Sleeper(duration)
|
||||
|
||||
// account for how long we intended to sleep
|
||||
consumed += duration
|
||||
|
||||
// exponentially increase the gap
|
||||
gap *= 2
|
||||
}
|
||||
|
||||
return ErrMaximumTimeExceeded
|
||||
}
|
||||
|
||||
func nextJitter(fraction float64, maxSize time.Duration) time.Duration {
|
||||
scaled := fraction * float64(maxSize)
|
||||
return time.Duration(scaled)
|
||||
}
|
||||
Loading…
Reference in New Issue