Skip to content

fix(coderd/provisionerdserver): fix test flake in TestHeartbeat #11808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 25, 2024
Merged

fix(coderd/provisionerdserver): fix test flake in TestHeartbeat #11808

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bb32c58
fix(coderd/provisionerdserver): fix test flake in TestHeartbeat
johnstcn Jan 24, 2024
6449c93
Revert "fix(coderd/provisionerdserver): fix test flake in TestHeartbeat"
johnstcn Jan 25, 2024
334a4a6
use testutil.RequireRecvCtx, rely on goleak for checking heartbeat go…
johnstcn Jan 25, 2024
7f42388
testutil ctx with timeout
johnstcn Jan 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Revert "fix(coderd/provisionerdserver): fix test flake in TestHeartbeat" 
This reverts commit bb32c58.
  • Loading branch information
@johnstcn
johnstcn committed Jan 25, 2024
commit 6449c93eb8e95a66324f3c09b5d84a76e11faa98
18 changes: 4 additions & 14 deletions coderd/provisionerdserver/provisionerdserver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,6 @@ type Options struct {
// The default function just calls UpdateProvisionerDaemonLastSeenAt.
// This is mainly used for testing.
HeartbeatFn func(context.Context) error

// HeartbeatDone is used for testing.
HeartbeatDone chan struct{}
}

type server struct {
Expand Down Expand Up @@ -186,9 +183,6 @@ func NewServer(
if options.HeartbeatInterval == 0 {
options.HeartbeatInterval = DefaultHeartbeatInterval
}
if options.HeartbeatDone == nil {
options.HeartbeatDone = make(chan struct{})
}

s := &server{
lifecycleCtx: lifecycleCtx,
Expand Down Expand Up @@ -219,7 +213,7 @@ func NewServer(
s.heartbeatFn = s.defaultHeartbeat
}

go s.heartbeatLoop(options.HeartbeatDone)
go s.heartbeatLoop()
return s, nil
}

Expand All @@ -233,21 +227,17 @@ func (s *server) timeNow() time.Time {
}

// heartbeatLoop runs heartbeatOnce at the interval specified by HeartbeatInterval
// until the lifecycle context is canceled. Done is closed on exit.
func (s *server) heartbeatLoop(hbDone chan<- struct{}) {
// until the lifecycle context is canceled.
func (s *server) heartbeatLoop() {
tick := time.NewTicker(time.Nanosecond)
defer func() {
close(hbDone)
}()
defer tick.Stop()
for {
select {
case <-s.lifecycleCtx.Done():
s.Logger.Debug(s.lifecycleCtx, "heartbeat loop canceled")
tick.Stop()
return
case <-tick.C:
if s.lifecycleCtx.Err() != nil {
tick.Stop()
return
}
start := s.timeNow()
Expand Down
19 changes: 10 additions & 9 deletions coderd/provisionerdserver/provisionerdserver_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,6 @@ func TestHeartbeat(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
t.Cleanup(cancel)
heartbeatChan := make(chan struct{})
heartbeatDone := make(chan struct{})
heartbeatFn := func(hbCtx context.Context) error {
t.Logf("heartbeat")
select {
Expand All @@ -118,7 +117,6 @@ func TestHeartbeat(t *testing.T) {
//nolint:dogsled // ｡:ﾟ૮ ˶ˆ ﻌ ˆ˶ ა ﾟ:｡
_, _, _, _ = setup(t, false, &overrides{
ctx: ctx,
heartbeatDone: heartbeatDone,
heartbeatFn: heartbeatFn,
heartbeatInterval: testutil.IntervalFast,
})
Expand All @@ -127,9 +125,17 @@ func TestHeartbeat(t *testing.T) {
require.True(t, ok, "first heartbeat not received")
_, ok = <-heartbeatChan
require.True(t, ok, "second heartbeat not received")
// Cancel the context. This should cause heartbeatDone to be closed.
cancel()
<-heartbeatDone
// Close the channel to ensure we don't receive any more heartbeats.
// The test will fail if we do.
defer func() {
if r := recover(); r != nil {
t.Fatalf("heartbeat received after cancel: %v", r)
}
}()

close(heartbeatChan)
<-time.After(testutil.IntervalMedium)
}

func TestAcquireJob(t *testing.T) {
Expand Down Expand Up @@ -1721,7 +1727,6 @@ type overrides struct {
acquireJobLongPollDuration time.Duration
heartbeatFn func(ctx context.Context) error
heartbeatInterval time.Duration
heartbeatDone chan struct{}
}

func setup(t *testing.T, ignoreLogErrors bool, ov *overrides) (proto.DRPCProvisionerDaemonServer, database.Store, pubsub.Pubsub, database.ProvisionerDaemon) {
Expand All @@ -1746,9 +1751,6 @@ func setup(t *testing.T, ignoreLogErrors bool, ov *overrides) (proto.DRPCProvisi
if ov.heartbeatInterval == 0 {
ov.heartbeatInterval = testutil.IntervalMedium
}
if ov.heartbeatDone == nil {
ov.heartbeatDone = make(chan struct{})
}
if ov.deploymentValues != nil {
deploymentValues = ov.deploymentValues
}
Expand Down Expand Up @@ -1813,7 +1815,6 @@ func setup(t *testing.T, ignoreLogErrors bool, ov *overrides) (proto.DRPCProvisi
AcquireJobLongPollDur: pollDur,
HeartbeatInterval: ov.heartbeatInterval,
HeartbeatFn: ov.heartbeatFn,
HeartbeatDone: ov.heartbeatDone,
},
)
require.NoError(t, err)
Expand Down