Skip to content

feat(coderd/database/dbpurge): retain most recent agent build logs #14460

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 9 commits into from
Aug 30, 2024
+349 −126
Merged

feat(coderd/database/dbpurge): retain most recent agent build logs #14460

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9451962
chore: improve coverage of dbpurge tests for DeleteOldWorkspaceAgentLogs
johnstcn Aug 29, 2024
0c14a3e
feat(dbpurge): update DeleteOldWorkspaceAgentLogs query to keep lates…
johnstcn Aug 29, 2024
0af051e
remove unnecessary columns from CTE
johnstcn Aug 29, 2024
dd97358
fix test
johnstcn Aug 29, 2024
2017434
implement dbmem
johnstcn Aug 29, 2024
725eeb0
ensure that ticks from quartz are dbtimey
johnstcn Aug 29, 2024
591dd91
extract awaitDoTick() test helper
johnstcn Aug 30, 2024
0f8ab25
address race condition in initial tick
johnstcn Aug 30, 2024
5c77b5e
fix double-tick startup race
johnstcn Aug 30, 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
extract awaitDoTick() test helper
  • Loading branch information
@johnstcn
johnstcn committed Aug 30, 2024
commit 591dd9106bb444021339a5ed7a23c5a9710d38b4
56 changes: 33 additions & 23 deletions coderd/database/dbpurge/dbpurge_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,20 +43,11 @@ func TestPurge(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
defer cancel()

clk := quartz.NewMock(t)

// We want to make sure dbpurge is actually started so that this test is meaningful.
trapStop := clk.Trap().TickerStop()

clk := quartz.NewMock(t)
done := awaitDoTick(ctx, t, clk)
purger := dbpurge.New(context.Background(), slogtest.Make(t, nil), dbmem.New(), clk)

// Wait for the initial nanosecond tick.
clk.Advance(time.Nanosecond).MustWait(ctx)
// Wait for ticker.Stop call that happens in the goroutine.
trapStop.MustWait(ctx).Release()
// Stop the trap now to avoid blocking further.
trapStop.Close()

<-done // wait for doTick() to run.
require.NoError(t, purger.Close())
}

Expand Down Expand Up @@ -247,20 +238,11 @@ func TestDeleteOldWorkspaceAgentLogs(t *testing.T) {
// when dbpurge runs

// After dbpurge completes, the ticker is reset. Trap this call.
trapReset := clk.Trap().TickerReset()
defer trapReset.Close()

done := awaitDoTick(ctx, t, clk)
closer := dbpurge.New(ctx, logger, db, clk)
defer closer.Close()
// Wait for the initial nanosecond tick.
clk.Advance(time.Nanosecond).MustWait(ctx)

trapReset.MustWait(ctx).Release() // Wait for ticker.Reset()
d, w := clk.AdvanceNext()
require.Equal(t, 10*time.Minute, d)

closer.Close() // doTick() has now run.
w.MustWait(ctx)
<-done // doTick() has now run.

// then logs related to the following agents should be deleted:
// Agent A1 never connected, was created before the threshold, and is not the
Expand All @@ -284,6 +266,34 @@ func TestDeleteOldWorkspaceAgentLogs(t *testing.T) {
assertWorkspaceAgentLogs(ctx, t, db, agentE1.ID, "agent e1 logs should be retained")
}

func awaitDoTick(ctx context.Context, t *testing.T, clk *quartz.Mock) chan struct{} {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addresses #14480 (comment)

t.Helper()
ch := make(chan struct{})
trapStop := clk.Trap().TickerStop()
trapReset := clk.Trap().TickerReset()
go func() {
defer close(ch)
defer trapStop.Close()
defer trapReset.Close()
// Wait for the initial nanosecond tick.
trapReset.MustWait(ctx).Release()
clk.Advance(time.Nanosecond).MustWait(ctx)
// Wait for the ticker stop event.
trapStop.MustWait(ctx).Release()
// doTick runs here. Wait for the next
// ticker reset event that signifies it's completed.
trapReset.MustWait(ctx).Release()
// Ensure that the duration is reset to the original delay.
d, w := clk.AdvanceNext()
assert.Equal(t, 10*time.Minute, d)
if !assert.NoError(t, w.Wait(ctx)) {
return
}
}()

return ch
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice 👍🏻


func assertNoWorkspaceAgentLogs(ctx context.Context, t *testing.T, db database.Store, agentID uuid.UUID) {
t.Helper()
agentLogs, err := db.GetWorkspaceAgentLogsAfter(ctx, database.GetWorkspaceAgentLogsAfterParams{
Expand Down