test(coderd): Fix TestWorkspaceAgent_Metadata flake

mafredri · mafredri · commit 295dbdddfaca · 2023-06-13T12:11:22.000Z
diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -1461,7 +1461,6 @@ func (api *API) watchWorkspaceAgentMetadata(rw http.ResponseWriter, r *http.Requ
 		case <-senderClosed:
 			return
 		case <-refreshTicker.C:
-			break
 		}
 
 		// Avoid spamming the DB with reads we know there are no updates. We want
diff --git a/coderd/workspaceagents_test.go b/coderd/workspaceagents_test.go
@@ -1268,11 +1268,6 @@ func TestWorkspaceAgent_Metadata(t *testing.T) {
 
 	var update []codersdk.WorkspaceAgentMetadata
 
-	check := func(want codersdk.WorkspaceAgentMetadataResult, got codersdk.WorkspaceAgentMetadata) {
-		require.Equal(t, want.Value, got.Result.Value)
-		require.Equal(t, want.Error, got.Result.Error)
-	}
-
 	wantMetadata1 := codersdk.WorkspaceAgentMetadataResult{
 		CollectedAt: time.Now(),
 		Value:       "bar",
@@ -1285,12 +1280,27 @@ func TestWorkspaceAgent_Metadata(t *testing.T) {
 
 	recvUpdate := func() []codersdk.WorkspaceAgentMetadata {
 		select {
+		case <-ctx.Done():
+			t.Fatalf("context done: %v", ctx.Err())
 		case err := <-errors:
 			t.Fatalf("error watching metadata: %v", err)
-			return nil
 		case update := <-updates:
 			return update
 		}
+		return nil
+	}
+
+	check := func(want codersdk.WorkspaceAgentMetadataResult, got codersdk.WorkspaceAgentMetadata) {
+		// 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++ {
+			recvUpdate()
+		}
+		ok1 := assert.Equal(t, want.Value, got.Result.Value)
+		ok2 := assert.Equal(t, want.Error, got.Result.Error)
+		if !ok1 || !ok2 {
+			require.FailNow(t, "check failed")
+		}
 	}
 
 	update = recvUpdate()

Original file line number	Diff line number	Diff line change
`@@ -1461,7 +1461,6 @@ func (api API) watchWorkspaceAgentMetadata(rw http.ResponseWriter, r http.Requ`
`1461`	`1461`	`case <-senderClosed:`
`1462`	`1462`	`return`
`1463`	`1463`	`case <-refreshTicker.C:`
`1464`		`- break`
`1465`	`1464`	`}`
`1466`	`1465`
`1467`	`1466`	`// Avoid spamming the DB with reads we know there are no updates. We want`