Skip to content

fix(coderd): prevent lost messages in watchWorkspaceAgentMetadata #7934

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
Jun 13, 2023
+51 −17
Merged

fix(coderd): prevent lost messages in watchWorkspaceAgentMetadata #7934

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
295dbdd
test(coderd): Fix TestWorkspaceAgent_Metadata flake
mafredri Jun 9, 2023
3e908d7
Fix update of got
mafredri Jun 9, 2023
89f3db5
fix(codersdk): Wait for subscription in WatchWorkspaceAgentMetadata
mafredri Jun 12, 2023
2a53d6a
fix(coderd): Subscribe before sending initial metadata event
mafredri Jun 12, 2023
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
fix(coderd): Subscribe before sending initial metadata event
  • Loading branch information
@mafredri
mafredri committed Jun 13, 2023
commit 2a53d6ac63a2ee222bcc1e38e4988e1a4b6cd0a4
9 changes: 5 additions & 4 deletions coderd/workspaceagents.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1434,17 +1434,15 @@ func (api *API) watchWorkspaceAgentMetadata(rw http.ResponseWriter, r *http.Requ
})
}

// Send initial metadata.
sendMetadata(true)

// We debounce metadata updates to avoid overloading the frontend when
// an agent is sending a lot of updates.
pubsubDebounce := debounce.New(time.Second)
if flag.Lookup("test.v") != nil {
pubsubDebounce = debounce.New(time.Millisecond * 100)
}

// Send metadata on updates.
// Send metadata on updates, we must ensure subscription before sending
// initial metadata to guarantee that events in-between are not missed.
cancelSub, err := api.Pubsub.Subscribe(watchWorkspaceAgentMetadataChannel(workspaceAgent.ID), func(_ context.Context, _ []byte) {
pubsubDebounce(func() {
sendMetadata(true)
Expand All @@ -1456,6 +1454,9 @@ func (api *API) watchWorkspaceAgentMetadata(rw http.ResponseWriter, r *http.Requ
}
defer cancelSub()

// Send initial metadata.
sendMetadata(true)

for {
select {
case <-senderClosed:
Expand Down
16 changes: 8 additions & 8 deletions coderd/workspaceagents_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1290,10 +1290,10 @@ func TestWorkspaceAgent_Metadata(t *testing.T) {
return nil
}

check := func(want codersdk.WorkspaceAgentMetadataResult, got codersdk.WorkspaceAgentMetadata) {
check := func(want codersdk.WorkspaceAgentMetadataResult, got codersdk.WorkspaceAgentMetadata, retry bool) {
// We can't trust the order of the updates due to timers and debounces,
// so let's check a few times once more.
for i := 0; i < 2 && (want.Value != got.Result.Value || want.Error != got.Result.Error); i++ {
// so let's check a few times more.
for i := 0; retry && i < 2 && (want.Value != got.Result.Value || want.Error != got.Result.Error); i++ {
update = recvUpdate()
for _, m := range update {
if m.Description.Key == got.Description.Key {
Expand All @@ -1311,22 +1311,22 @@ func TestWorkspaceAgent_Metadata(t *testing.T) {

update = recvUpdate()
require.Len(t, update, 3)
check(wantMetadata1, update[0])
check(wantMetadata1, update[0], false)
// The second metadata result is not yet posted.
require.Zero(t, update[1].Result.CollectedAt)

wantMetadata2 := wantMetadata1
post("foo2", wantMetadata2)
update = recvUpdate()
require.Len(t, update, 3)
check(wantMetadata1, update[0])
check(wantMetadata2, update[1])
check(wantMetadata1, update[0], true)
check(wantMetadata2, update[1], true)

wantMetadata1.Error = "error"
post("foo1", wantMetadata1)
update = recvUpdate()
require.Len(t, update, 3)
check(wantMetadata1, update[0])
check(wantMetadata1, update[0], true)

const maxValueLen = 32 << 10
tooLongValueMetadata := wantMetadata1
Expand All @@ -1335,7 +1335,7 @@ func TestWorkspaceAgent_Metadata(t *testing.T) {
tooLongValueMetadata.CollectedAt = time.Now()
post("foo3", tooLongValueMetadata)
got := recvUpdate()[2]
for len(got.Result.Value) != maxValueLen {
for i := 0; i < 2 && len(got.Result.Value) != maxValueLen; i++ {
got = recvUpdate()[2]
}
require.Len(t, got.Result.Value, maxValueLen)
Expand Down