Merge pull request #126125 from mprahl/stop-idempotent

Allow calling Stop multiple times on RetryWatcher
This commit is contained in:
Kubernetes Prow Robot
2024-07-23 08:16:24 -07:00
committed by GitHub
2 changed files with 13 additions and 1 deletions

View File

@@ -22,6 +22,7 @@ import (
"fmt"
"io"
"net/http"
"sync"
"time"
apierrors "k8s.io/apimachinery/pkg/api/errors"
@@ -53,6 +54,7 @@ type RetryWatcher struct {
stopChan chan struct{}
doneChan chan struct{}
minRestartDelay time.Duration
stopChanLock sync.Mutex
}
// NewRetryWatcher creates a new RetryWatcher.
@@ -286,7 +288,15 @@ func (rw *RetryWatcher) ResultChan() <-chan watch.Event {
// Stop implements Interface.
func (rw *RetryWatcher) Stop() {
close(rw.stopChan)
rw.stopChanLock.Lock()
defer rw.stopChanLock.Unlock()
// Prevent closing an already closed channel to prevent a panic
select {
case <-rw.stopChan:
default:
close(rw.stopChan)
}
}
// Done allows the caller to be notified when Retry watcher stops.

View File

@@ -585,6 +585,8 @@ func TestRetryWatcherToFinishWithUnreadEvents(t *testing.T) {
// Give the watcher a chance to get to sending events (blocking)
time.Sleep(10 * time.Millisecond)
watcher.Stop()
// Verify a second stop does not cause a panic
watcher.Stop()
maxTime := time.Second