feat(notifications): add golden file for custom appearance

coder · defelmnq · Oct 22, 2024 · Oct 2, 2024 · Oct 3, 2024 · Oct 3, 2024
commit bf558cbeb492b97fc467df924bc9007188d9afc4
diff --git a/coderd/notifications/dispatch/utils_test.go b/coderd/notifications/dispatch/utils_test.go
@@ -1,10 +1,8 @@
 package dispatch_test
 
-var (
-	helpers = map[string]any{
-		"base_url":     func() string { return "http://test.com" },
-		"current_year": func() string { return "2024" },
-		"logo_url":     func() string { return "https://coder.com/coder-logo-horizontal.png" },
-		"app_name":     func() string { return "Coder" },
-	}
-)
+var helpers = map[string]any{
+	"base_url":     func() string { return "http://test.com" },
+	"current_year": func() string { return "2024" },
+	"logo_url":     func() string { return "https://coder.com/coder-logo-horizontal.png" },
+	"app_name":     func() string { return "Coder" },
+}
diff --git a/coderd/notifications/dispatch/webhook.go b/coderd/notifications/dispatch/webhook.go
@@ -42,7 +42,7 @@ func NewWebhookHandler(cfg codersdk.NotificationsWebhookConfig, log slog.Logger)
 	return &WebhookHandler{cfg: cfg, log: log, cl: &http.Client{}}
 }
 
-func (w *WebhookHandler) Dispatcher(helpers template.FuncMap, payload types.MessagePayload, titleMarkdown, bodyMarkdown string) (DeliveryFunc, error) {
+func (w *WebhookHandler) Dispatcher(_ template.FuncMap, payload types.MessagePayload, titleMarkdown, bodyMarkdown string) (DeliveryFunc, error) {
 	if w.cfg.Endpoint.String() == "" {
 		return nil, xerrors.New("webhook endpoint not defined")
 	}

diff --git a/coderd/notifications/manager_test.go b/coderd/notifications/manager_test.go
@@ -206,8 +206,8 @@ type santaHandler struct {
 	nice    atomic.Int32
 }
 
-func (s *santaHandler) Dispatcher(helpers template.FuncMap, payload types.MessagePayload, _, _ string) (dispatch.DeliveryFunc, error) {
-	return func(ctx context.Context, msgID uuid.UUID) (retryable bool, err error) {
+func (s *santaHandler) Dispatcher(_ template.FuncMap, payload types.MessagePayload, _, _ string) (dispatch.DeliveryFunc, error) {
+	return func(_ context.Context, _ uuid.UUID) (retryable bool, err error) {
 		if payload.Labels["nice"] != "true" {
 			s.naughty.Add(1)
 			return false, xerrors.New("be nice")

diff --git a/coderd/notifications/metrics_test.go b/coderd/notifications/metrics_test.go
@@ -44,7 +44,7 @@ func TestMetrics(t *testing.T) {
 
 	reg := prometheus.NewRegistry()
 	metrics := notifications.NewMetrics(reg)
-	template := notifications.TemplateWorkspaceDeleted
+	tmplate := notifications.TemplateWorkspaceDeleted
 
 	const (
 		method      = database.NotificationMethodSmtp
@@ -76,7 +76,7 @@ func TestMetrics(t *testing.T) {
 	user := createSampleUser(t, api.Database)
 
 	// Build fingerprints for the two different series we expect.
-	methodTemplateFP := fingerprintLabels(notifications.LabelMethod, string(method), notifications.LabelTemplateID, template.String())
+	methodTemplateFP := fingerprintLabels(notifications.LabelMethod, string(method), notifications.LabelTemplateID, tmplate.String())
 	methodFP := fingerprintLabels(notifications.LabelMethod, string(method))
 
 	expected := map[string]func(metric *dto.Metric, series string) bool{
@@ -90,7 +90,7 @@ func TestMetrics(t *testing.T) {
 
 			var match string
 			for result, val := range results {
-				seriesFP := fingerprintLabels(notifications.LabelMethod, string(method), notifications.LabelTemplateID, template.String(), notifications.LabelResult, result)
+				seriesFP := fingerprintLabels(notifications.LabelMethod, string(method), notifications.LabelTemplateID, tmplate.String(), notifications.LabelResult, result)
 				if !hasMatchingFingerprint(metric, seriesFP) {
 					continue
 				}
@@ -165,9 +165,9 @@ func TestMetrics(t *testing.T) {
 	}
 
 	// WHEN: 2 notifications are enqueued, 1 of which will fail until its retries are exhausted, and another which will succeed
-	_, err = enq.Enqueue(ctx, user.ID, template, map[string]string{"type": "success"}, "test") // this will succeed
+	_, err = enq.Enqueue(ctx, user.ID, tmplate, map[string]string{"type": "success"}, "test") // this will succeed
 	require.NoError(t, err)
-	_, err = enq.Enqueue(ctx, user.ID, template, map[string]string{"type": "failure"}, "test2") // this will fail and retry (maxAttempts - 1) times
+	_, err = enq.Enqueue(ctx, user.ID, tmplate, map[string]string{"type": "failure"}, "test2") // this will fail and retry (maxAttempts - 1) times
 	require.NoError(t, err)
 
 	mgr.Run(ctx)
@@ -217,7 +217,7 @@ func TestPendingUpdatesMetric(t *testing.T) {
 
 	reg := prometheus.NewRegistry()
 	metrics := notifications.NewMetrics(reg)
-	template := notifications.TemplateWorkspaceDeleted
+	tmplate := notifications.TemplateWorkspaceDeleted
 
 	const method = database.NotificationMethodSmtp
 
@@ -248,9 +248,9 @@ func TestPendingUpdatesMetric(t *testing.T) {
 	user := createSampleUser(t, api.Database)
 
 	// WHEN: 2 notifications are enqueued, one of which will fail and one which will succeed
-	_, err = enq.Enqueue(ctx, user.ID, template, map[string]string{"type": "success"}, "test") // this will succeed
+	_, err = enq.Enqueue(ctx, user.ID, tmplate, map[string]string{"type": "success"}, "test") // this will succeed
 	require.NoError(t, err)
-	_, err = enq.Enqueue(ctx, user.ID, template, map[string]string{"type": "failure"}, "test2") // this will fail and retry (maxAttempts - 1) times
+	_, err = enq.Enqueue(ctx, user.ID, tmplate, map[string]string{"type": "failure"}, "test2") // this will fail and retry (maxAttempts - 1) times
 	require.NoError(t, err)
 
 	mgr.Run(ctx)
@@ -301,7 +301,7 @@ func TestInflightDispatchesMetric(t *testing.T) {
 
 	reg := prometheus.NewRegistry()
 	metrics := notifications.NewMetrics(reg)
-	template := notifications.TemplateWorkspaceDeleted
+	tmplate := notifications.TemplateWorkspaceDeleted
 
 	const method = database.NotificationMethodSmtp
 
@@ -334,7 +334,7 @@ func TestInflightDispatchesMetric(t *testing.T) {
 
 	// WHEN: notifications are enqueued which will succeed (and be delayed during dispatch)
 	for i := 0; i < msgCount; i++ {
-		_, err = enq.Enqueue(ctx, user.ID, template, map[string]string{"type": "success", "i": strconv.Itoa(i)}, "test")
+		_, err = enq.Enqueue(ctx, user.ID, tmplate, map[string]string{"type": "success", "i": strconv.Itoa(i)}, "test")
 		require.NoError(t, err)
 	}
 
@@ -343,7 +343,7 @@ func TestInflightDispatchesMetric(t *testing.T) {
 	// THEN:
 	// Ensure we see the dispatches of the messages inflight.
 	require.Eventually(t, func() bool {
-		return promtest.ToFloat64(metrics.InflightDispatches.WithLabelValues(string(method), template.String())) == msgCount
+		return promtest.ToFloat64(metrics.InflightDispatches.WithLabelValues(string(method), tmplate.String())) == msgCount
 	}, testutil.WaitShort, testutil.IntervalFast)
 
 	for i := 0; i < msgCount; i++ {
@@ -380,7 +380,7 @@ func TestCustomMethodMetricCollection(t *testing.T) {
 	var (
 		reg             = prometheus.NewRegistry()
 		metrics         = notifications.NewMetrics(reg)
-		template        = notifications.TemplateWorkspaceDeleted
+		tmplate         = notifications.TemplateWorkspaceDeleted
 		anotherTemplate = notifications.TemplateWorkspaceDormant
 	)
 
@@ -391,7 +391,7 @@ func TestCustomMethodMetricCollection(t *testing.T) {
 
 	// GIVEN: a template whose notification method differs from the default.
 	out, err := api.Database.UpdateNotificationTemplateMethodByID(ctx, database.UpdateNotificationTemplateMethodByIDParams{
-		ID:     template,
+		ID:     tmplate,
 		Method: database.NullNotificationMethod{NotificationMethod: customMethod, Valid: true},
 	})
 	require.NoError(t, err)
@@ -417,7 +417,7 @@ func TestCustomMethodMetricCollection(t *testing.T) {
 
 	user := createSampleUser(t, api.Database)
 
-	_, err = enq.Enqueue(ctx, user.ID, template, map[string]string{"type": "success"}, "test")
+	_, err = enq.Enqueue(ctx, user.ID, tmplate, 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)
@@ -438,7 +438,7 @@ func TestCustomMethodMetricCollection(t *testing.T) {
 	// 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
+			promtest.ToFloat64(metrics.DispatchAttempts.WithLabelValues(string(customMethod), tmplate.String(), notifications.ResultSuccess)) > 0
 	}, testutil.WaitShort, testutil.IntervalFast)
 }
 

diff --git a/coderd/notifications/notifications_test.go b/coderd/notifications/notifications_test.go
@@ -1414,12 +1414,12 @@ func TestCustomNotificationMethod(t *testing.T) {
 
 	// GIVEN: a notification template which has a method explicitly set
 	var (
-		template      = notifications.TemplateWorkspaceDormant
+		tmplate       = notifications.TemplateWorkspaceDormant
 		defaultMethod = database.NotificationMethodSmtp
 		customMethod  = database.NotificationMethodWebhook
 	)
 	out, err := api.Database.UpdateNotificationTemplateMethodByID(ctx, database.UpdateNotificationTemplateMethodByIDParams{
-		ID:     template,
+		ID:     tmplate,
 		Method: database.NullNotificationMethod{NotificationMethod: customMethod, Valid: true},
 	})
 	require.NoError(t, err)
@@ -1447,7 +1447,7 @@ func TestCustomNotificationMethod(t *testing.T) {
 
 	// WHEN: a notification of that template is enqueued, it should be delivered with the configured method - not the default.
 	user := createSampleUser(t, api.Database)
-	msgID, err := enq.Enqueue(ctx, user.ID, template, map[string]string{}, "test")
+	msgID, err := enq.Enqueue(ctx, user.ID, tmplate, map[string]string{}, "test")
 	require.NoError(t, err)
 
 	// THEN: the notification should be received by the custom dispatch method
@@ -1562,7 +1562,7 @@ type fakeHandler struct {
 	succeeded, failed []string
 }
 
-func (f *fakeHandler) Dispatcher(helpers template.FuncMap, payload types.MessagePayload, _, _ string) (dispatch.DeliveryFunc, error) {
+func (f *fakeHandler) Dispatcher(_ template.FuncMap, payload types.MessagePayload, _, _ string) (dispatch.DeliveryFunc, error) {
 	return func(_ context.Context, msgID uuid.UUID) (retryable bool, err error) {
 		f.mu.Lock()
 		defer f.mu.Unlock()
@@ -1629,15 +1629,13 @@ func TestNotificationTemplates_GoldenWithCustomAppearance(t *testing.T) {
 		hint = "run \"DB=ci make update-golden-files\" and commit the changes"
 	)
 
-	var (
-		payload = types.MessagePayload{
-			Labels: map[string]string{
-				"name":      "bobby-workspace",
-				"reason":    "autodeleted due to dormancy",
-				"initiator": "autobuild",
-			},
-		}
-	)
+	payload := types.MessagePayload{
+		Labels: map[string]string{
+			"name":      "bobby-workspace",
+			"reason":    "autodeleted due to dormancy",
+			"initiator": "autobuild",
+		},
+	}
 
 	// Spin up the DB
 	db, logger, user := func() (database.Store, *slog.Logger, *codersdk.User) {

diff --git a/coderd/notifications/utils_test.go b/coderd/notifications/utils_test.go
@@ -70,7 +70,7 @@ func newDispatchInterceptor(h notifications.Handler) *dispatchInterceptor {
 	return &dispatchInterceptor{handler: h}
 }
 
-func (i *dispatchInterceptor) Dispatcher(helpers template.FuncMap, payload types.MessagePayload, title, body string) (dispatch.DeliveryFunc, error) {
+func (i *dispatchInterceptor) Dispatcher(_ template.FuncMap, payload types.MessagePayload, title, body string) (dispatch.DeliveryFunc, error) {
 	return func(ctx context.Context, msgID uuid.UUID) (retryable bool, err error) {
 		deliveryFn, err := i.handler.Dispatcher(defaultHelpers(), payload, title, body)
 		if err != nil {