Use UUID for notifier IDs

dannykopping · dannykopping · commit 8b7fa1877034 · 2024-06-27T11:46:46.000+02:00
Fix test which uses coalesced fullname/username and was failing

Signed-off-by: Danny Kopping &lt;danny@coder.com&gt;
diff --git a/coderd/notifications/manager.go b/coderd/notifications/manager.go
@@ -146,7 +146,7 @@ func (m *Manager) loop(ctx context.Context, notifiers int) error {
 	for i := 0; i < notifiers; i++ {
 		eg.Go(func() error {
 			m.notifierMu.Lock()
-			n := newNotifier(ctx, m.cfg, i+1, m.log, m.store, m.handlers)
+			n := newNotifier(ctx, m.cfg, uuid.New(), m.log, m.store, m.handlers)
 			m.notifiers = append(m.notifiers, n)
 			m.notifierMu.Unlock()
 			return n.run(ctx, success, failure)
@@ -424,22 +424,22 @@ func (m *Manager) Stop(ctx context.Context) error {
 }
 
 type dispatchResult struct {
-	notifier  int
+	notifier  uuid.UUID
 	msg       uuid.UUID
 	ts        time.Time
 	err       error
 	retryable bool
 }
 
-func newSuccessfulDispatch(notifier int, msg uuid.UUID) dispatchResult {
+func newSuccessfulDispatch(notifier, msg uuid.UUID) dispatchResult {
 	return dispatchResult{
 		notifier: notifier,
 		msg:      msg,
 		ts:       time.Now(),
 	}
 }
 
-func newFailedDispatch(notifier int, msg uuid.UUID, err error, retryable bool) dispatchResult {
+func newFailedDispatch(notifier, msg uuid.UUID, err error, retryable bool) dispatchResult {
 	return dispatchResult{
 		notifier:  notifier,
 		msg:       msg,
diff --git a/coderd/notifications/notifications_test.go b/coderd/notifications/notifications_test.go
@@ -172,7 +172,8 @@ func TestWebhookDispatch(t *testing.T) {
 		require.Equal(t, *msgID, payload.MsgID)
 		require.Equal(t, payload.Payload.Labels, input)
 		require.Equal(t, payload.Payload.UserEmail, "bob@coder.com")
-		require.Equal(t, payload.Payload.UserName, "bob")
+		// UserName is coalesced from `name` and `username`; in this case `name` wins.
+		require.Equal(t, payload.Payload.UserName, "Robert McBobbington")
 		require.Equal(t, payload.Payload.NotificationName, "Workspace Deleted")
 
 		w.WriteHeader(http.StatusOK)
@@ -203,6 +204,7 @@ func TestWebhookDispatch(t *testing.T) {
 	_, user := coderdtest.CreateAnotherUserMutators(t, client, first.OrganizationID, nil, func(r *codersdk.CreateUserRequest) {
 		r.Email = "bob@coder.com"
 		r.Username = "bob"
+		r.Name = "Robert McBobbington"
 	})
 
 	// when
diff --git a/coderd/notifications/notifier.go b/coderd/notifications/notifier.go
@@ -6,6 +6,7 @@ import (
 	"sync"
 	"time"
 
+	"github.com/google/uuid"
 	"golang.org/x/sync/errgroup"
 	"golang.org/x/xerrors"
 
@@ -21,7 +22,7 @@ import (
 // notifier is a consumer of the notifications_messages queue. It dequeues messages from that table and processes them
 // through a pipeline of fetch -> prepare -> render -> acquire handler -> deliver.
 type notifier struct {
-	id    int
+	id    uuid.UUID
 	cfg   codersdk.NotificationsConfig
 	ctx   context.Context
 	log   slog.Logger
@@ -35,7 +36,7 @@ type notifier struct {
 	handlers *HandlerRegistry
 }
 
-func newNotifier(ctx context.Context, cfg codersdk.NotificationsConfig, id int, log slog.Logger, db Store, hr *HandlerRegistry) *notifier {
+func newNotifier(ctx context.Context, cfg codersdk.NotificationsConfig, id uuid.UUID, log slog.Logger, db Store, hr *HandlerRegistry) *notifier {
 	return &notifier{
 		id:       id,
 		ctx:      ctx,
@@ -63,7 +64,7 @@ func (n *notifier) run(ctx context.Context, success chan<- dispatchResult, failu
 	for {
 		select {
 		case <-ctx.Done():
-			return xerrors.Errorf("notifier %d context canceled: %w", n.id, ctx.Err())
+			return xerrors.Errorf("notifier %q context canceled: %w", n.id, ctx.Err())
 		case <-n.quit:
 			return nil
 		default:
@@ -78,7 +79,7 @@ func (n *notifier) run(ctx context.Context, success chan<- dispatchResult, failu
 		// Shortcut to bail out quickly if stop() has been called or the context canceled.
 		select {
 		case <-ctx.Done():
-			return xerrors.Errorf("notifier %d context canceled: %w", n.id, ctx.Err())
+			return xerrors.Errorf("notifier %q context canceled: %w", n.id, ctx.Err())
 		case <-n.quit:
 			return nil
 		case <-n.tick.C:
@@ -137,7 +138,7 @@ func (n *notifier) fetch(ctx context.Context) ([]database.AcquireNotificationMes
 	msgs, err := n.store.AcquireNotificationMessages(ctx, database.AcquireNotificationMessagesParams{
 		Count:           int32(n.cfg.LeaseCount),
 		MaxAttemptCount: int32(n.cfg.MaxSendAttempts),
-		NotifierID:      int32(n.id),
+		NotifierID:      n.id,
 		LeaseSeconds:    int32(n.cfg.LeasePeriod.Value().Seconds()),
 	})
 	if err != nil {
