synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-18 14:17:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: avoid race in TestPGPubsub_Metrics by using Eventually (#11973)

Browse Source 
Annoyingly, prometheus Registry collects metrics async, which is causing our test to be racy.  They also don't export enough from the Metric interface for us to replicate a synchronous collect, so we have to use Eventually to test.
This commit is contained in:
Spike Curtis
2024-02-01 12:10:19 +04:00
committed by GitHub
parent 5a359d50dd
commit d5a98cc6d7
1 changed files with 33 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
coderd/database/pubsub/pubsub_test.go
View File

@ -43,8 +43,8 @@ func TestPGPubsub_Metrics(t *testing.T) {
metrics, err := registry.Gather() metrics, err := registry.Gather()
require.NoError(t, err) require.NoError(t, err)
requireGaugeValue(t, metrics, 0, "coder_pubsub_current_events") require.True(t, gaugeHasValue(t, metrics, 0, "coder_pubsub_current_events"))
requireGaugeValue(t, metrics, 0, "coder_pubsub_current_subscribers") require.True(t, gaugeHasValue(t, metrics, 0, "coder_pubsub_current_subscribers"))
event := "test" event := "test"
data := "testing" data := "testing"
@ -60,16 +60,18 @@ func TestPGPubsub_Metrics(t *testing.T) {
}() }()
_ = testutil.RequireRecvCtx(ctx, t, messageChannel) _ = testutil.RequireRecvCtx(ctx, t, messageChannel)
require.Eventually(t, func() bool {
metrics, err = registry.Gather() metrics, err = registry.Gather()
require.NoError(t, err) assert.NoError(t, err)
requireGaugeValue(t, metrics, 1, "coder_pubsub_current_events") return gaugeHasValue(t, metrics, 1, "coder_pubsub_current_events") &&
requireGaugeValue(t, metrics, 1, "coder_pubsub_current_subscribers") gaugeHasValue(t, metrics, 1, "coder_pubsub_current_subscribers") &&
requireGaugeValue(t, metrics, 1, "coder_pubsub_connected") gaugeHasValue(t, metrics, 1, "coder_pubsub_connected") &&
requireCounterValue(t, metrics, 1, "coder_pubsub_publishes_total", "true") counterHasValue(t, metrics, 1, "coder_pubsub_publishes_total", "true") &&
requireCounterValue(t, metrics, 1, "coder_pubsub_subscribes_total", "true") counterHasValue(t, metrics, 1, "coder_pubsub_subscribes_total", "true") &&
requireCounterValue(t, metrics, 1, "coder_pubsub_messages_total", "normal") counterHasValue(t, metrics, 1, "coder_pubsub_messages_total", "normal") &&
requireCounterValue(t, metrics, 7, "coder_pubsub_received_bytes_total") counterHasValue(t, metrics, 7, "coder_pubsub_received_bytes_total") &&
requireCounterValue(t, metrics, 7, "coder_pubsub_published_bytes_total") counterHasValue(t, metrics, 7, "coder_pubsub_published_bytes_total")
}, testutil.WaitShort, testutil.IntervalFast)
colossalData := make([]byte, 7600) colossalData := make([]byte, 7600)
for i := range colossalData { for i := range colossalData {
@ -88,20 +90,22 @@ func TestPGPubsub_Metrics(t *testing.T) {
_ = testutil.RequireRecvCtx(ctx, t, messageChannel) _ = testutil.RequireRecvCtx(ctx, t, messageChannel)
_ = testutil.RequireRecvCtx(ctx, t, messageChannel) _ = testutil.RequireRecvCtx(ctx, t, messageChannel)
require.Eventually(t, func() bool {
metrics, err = registry.Gather() metrics, err = registry.Gather()
require.NoError(t, err) assert.NoError(t, err)
requireGaugeValue(t, metrics, 1, "coder_pubsub_current_events") return gaugeHasValue(t, metrics, 1, "coder_pubsub_current_events") &&
requireGaugeValue(t, metrics, 2, "coder_pubsub_current_subscribers") gaugeHasValue(t, metrics, 2, "coder_pubsub_current_subscribers") &&
requireGaugeValue(t, metrics, 1, "coder_pubsub_connected") gaugeHasValue(t, metrics, 1, "coder_pubsub_connected") &&
requireCounterValue(t, metrics, 2, "coder_pubsub_publishes_total", "true") counterHasValue(t, metrics, 2, "coder_pubsub_publishes_total", "true") &&
requireCounterValue(t, metrics, 2, "coder_pubsub_subscribes_total", "true") counterHasValue(t, metrics, 2, "coder_pubsub_subscribes_total", "true") &&
requireCounterValue(t, metrics, 1, "coder_pubsub_messages_total", "normal") counterHasValue(t, metrics, 1, "coder_pubsub_messages_total", "normal") &&
requireCounterValue(t, metrics, 1, "coder_pubsub_messages_total", "colossal") counterHasValue(t, metrics, 1, "coder_pubsub_messages_total", "colossal") &&
requireCounterValue(t, metrics, 7607, "coder_pubsub_received_bytes_total") counterHasValue(t, metrics, 7607, "coder_pubsub_received_bytes_total") &&
requireCounterValue(t, metrics, 7607, "coder_pubsub_published_bytes_total") counterHasValue(t, metrics, 7607, "coder_pubsub_published_bytes_total")
}, testutil.WaitShort, testutil.IntervalFast)
} }
func requireGaugeValue(t testing.TB, metrics []*dto.MetricFamily, value float64, name string, label ...string) { func gaugeHasValue(t testing.TB, metrics []*dto.MetricFamily, value float64, name string, label ...string) bool {
t.Helper() t.Helper()
for _, family := range metrics { for _, family := range metrics {
if family.GetName() != name { if family.GetName() != name {
@ -115,14 +119,13 @@ func requireGaugeValue(t testing.TB, metrics []*dto.MetricFamily, value float64,
continue continue
} }
} }
require.Equal(t, value, m.GetGauge().GetValue()) return value == m.GetGauge().GetValue()
return
} }
} }
t.Fatal("didn't find metric") return false
} }
func requireCounterValue(t testing.TB, metrics []*dto.MetricFamily, value float64, name string, label ...string) { func counterHasValue(t testing.TB, metrics []*dto.MetricFamily, value float64, name string, label ...string) bool {
t.Helper() t.Helper()
for _, family := range metrics { for _, family := range metrics {
if family.GetName() != name { if family.GetName() != name {
@ -136,9 +139,8 @@ func requireCounterValue(t testing.TB, metrics []*dto.MetricFamily, value float6
continue continue
} }
} }
require.Equal(t, value, m.GetCounter().GetValue()) return value == m.GetCounter().GetValue()
return
} }
} }
t.Fatal("didn't find metric") return false
} }