Test metric collection when dispatching with custom methods

dannykopping · dannykopping · commit f2926a3b429a · 2024-08-05T13:43:06.000+02:00
Signed-off-by: Danny Kopping &lt;danny@coder.com&gt;
diff --git a/coderd/notifications/metrics_test.go b/coderd/notifications/metrics_test.go
@@ -339,6 +339,81 @@ func TestInflightDispatchesMetric(t *testing.T) {
 	}, testutil.WaitShort, testutil.IntervalFast)
 }
 
+func TestCustomMethodMetricCollection(t *testing.T) {
+	t.Parallel()
+
+	// SETUP
+	if !dbtestutil.WillUsePostgres() {
+		// UpdateNotificationTemplateMethodByID only makes sense with a real database.
+		t.Skip("This test requires postgres; it relies on business-logic only implemented in the database")
+	}
+	ctx, logger, store := setup(t)
+
+	var (
+		reg             = prometheus.NewRegistry()
+		metrics         = notifications.NewMetrics(reg)
+		template        = notifications.TemplateWorkspaceDeleted
+		anotherTemplate = notifications.TemplateWorkspaceDormant
+	)
+
+	const (
+		customMethod  = database.NotificationMethodWebhook
+		defaultMethod = database.NotificationMethodSmtp
+	)
+
+	// GIVEN: a template whose notification method differs from the default.
+	out, err := store.UpdateNotificationTemplateMethodByID(ctx, database.UpdateNotificationTemplateMethodByIDParams{
+		ID:     template,
+		Method: database.NullNotificationMethod{NotificationMethod: customMethod, Valid: true},
+	})
+	require.NoError(t, err)
+	require.Equal(t, customMethod, out.Method.NotificationMethod)
+
+	// WHEN: two notifications (each with different templates) are enqueued.
+	cfg := defaultNotificationsConfig(defaultMethod)
+	mgr, err := notifications.NewManager(cfg, store, metrics, logger.Named("manager"))
+	require.NoError(t, err)
+	t.Cleanup(func() {
+		assert.NoError(t, mgr.Stop(ctx))
+	})
+
+	smtpHandler := &fakeHandler{}
+	webhookHandler := &fakeHandler{}
+	mgr.WithHandlers(map[database.NotificationMethod]notifications.Handler{
+		defaultMethod: smtpHandler,
+		customMethod:  webhookHandler,
+	})
+
+	enq, err := notifications.NewStoreEnqueuer(cfg, store, defaultHelpers(), logger.Named("enqueuer"))
+	require.NoError(t, err)
+
+	user := createSampleUser(t, store)
+
+	_, err = enq.Enqueue(ctx, user.ID, template, map[string]string{"type": "success"}, "test")
+	require.NoError(t, err)
+	_, err = enq.Enqueue(ctx, user.ID, anotherTemplate, map[string]string{"type": "success"}, "test")
+	require.NoError(t, err)
+
+	mgr.Run(ctx)
+
+	// THEN: the fake handlers to "dispatch" the notifications.
+	require.Eventually(t, func() bool {
+		smtpHandler.mu.RLock()
+		webhookHandler.mu.RLock()
+		defer smtpHandler.mu.RUnlock()
+		defer webhookHandler.mu.RUnlock()
+
+		return len(smtpHandler.succeeded) == 1 && len(smtpHandler.failed) == 0 &&
+			len(webhookHandler.succeeded) == 1 && len(webhookHandler.failed) == 0
+	}, testutil.WaitShort, testutil.IntervalFast)
+
+	// THEN: we should have metric series for both the default and custom notification methods.
+	require.Eventually(t, func() bool {
+		return promtest.ToFloat64(metrics.DispatchAttempts.WithLabelValues(string(defaultMethod), anotherTemplate.String(), notifications.ResultSuccess)) > 0 &&
+			promtest.ToFloat64(metrics.DispatchAttempts.WithLabelValues(string(customMethod), template.String(), notifications.ResultSuccess)) > 0
+	}, testutil.WaitShort, testutil.IntervalFast)
+}
+
 // hasMatchingFingerprint checks if the given metric's series fingerprint matches the reference fingerprint.
 func hasMatchingFingerprint(metric *dto.Metric, fp model.Fingerprint) bool {
 	return fingerprintLabelPairs(metric.Label) == fp
