enqueue with data

mtojek · mtojek · commit 102a2456c894 · 2024-09-16T13:16:11.000+02:00
diff --git a/coderd/notifications/enqueuer.go b/coderd/notifications/enqueuer.go
@@ -54,12 +54,12 @@ func NewStoreEnqueuer(cfg codersdk.NotificationsConfig, store Store, helpers tem
 
 // Enqueue queues a notification message for later delivery, assumes no structured input data.
 func (s *StoreEnqueuer) Enqueue(ctx context.Context, userID, templateID uuid.UUID, labels map[string]string, createdBy string, targets ...uuid.UUID) (*uuid.UUID, error) {
-	return s.EnqueueData(ctx, userID, templateID, labels, nil, createdBy, targets...)
+	return s.EnqueueWithData(ctx, userID, templateID, labels, nil, createdBy, targets...)
 }
 
 // Enqueue queues a notification message for later delivery.
 // Messages will be dequeued by a notifier later and dispatched.
-func (s *StoreEnqueuer) EnqueueData(ctx context.Context, userID, templateID uuid.UUID, labels map[string]string, data map[string]any, createdBy string, targets ...uuid.UUID) (*uuid.UUID, error) {
+func (s *StoreEnqueuer) EnqueueWithData(ctx context.Context, userID, templateID uuid.UUID, labels map[string]string, data map[string]any, createdBy string, targets ...uuid.UUID) (*uuid.UUID, error) {
 	metadata, err := s.store.FetchNewMessageMetadata(ctx, database.FetchNewMessageMetadataParams{
 		UserID:                 userID,
 		NotificationTemplateID: templateID,
@@ -170,7 +170,7 @@ func (*NoopEnqueuer) Enqueue(context.Context, uuid.UUID, uuid.UUID, map[string]s
 	return nil, nil
 }
 
-func (*NoopEnqueuer) EnqueueData(context.Context, uuid.UUID, uuid.UUID, map[string]string, map[string]any, string, ...uuid.UUID) (*uuid.UUID, error) {
+func (*NoopEnqueuer) EnqueueWithData(context.Context, uuid.UUID, uuid.UUID, map[string]string, map[string]any, string, ...uuid.UUID) (*uuid.UUID, error) {
 	// nolint:nilnil // irrelevant.
 	return nil, nil
 }
diff --git a/coderd/notifications/reports/generator.go b/coderd/notifications/reports/generator.go
@@ -166,7 +166,7 @@ func reportFailedWorkspaceBuilds(ctx context.Context, logger slog.Logger, db dat
 				templateDisplayName = stats.TemplateName
 			}
 
-			if _, err := enqueuer.EnqueueData(ctx, templateAdmin.ID, notifications.TemplateWorkspaceBuildsFailedReport,
+			if _, err := enqueuer.EnqueueWithData(ctx, templateAdmin.ID, notifications.TemplateWorkspaceBuildsFailedReport,
 				map[string]string{
 					"template_name":         stats.TemplateName,
 					"template_display_name": templateDisplayName,
diff --git a/coderd/notifications/spec.go b/coderd/notifications/spec.go
@@ -33,5 +33,5 @@ type Handler interface {
 // Enqueuer enqueues a new notification message in the store and returns its ID, should it enqueue without failure.
 type Enqueuer interface {
 	Enqueue(ctx context.Context, userID, templateID uuid.UUID, labels map[string]string, createdBy string, targets ...uuid.UUID) (*uuid.UUID, error)
-	EnqueueData(ctx context.Context, userID, templateID uuid.UUID, labels map[string]string, data map[string]any, createdBy string, targets ...uuid.UUID) (*uuid.UUID, error)
+	EnqueueWithData(ctx context.Context, userID, templateID uuid.UUID, labels map[string]string, data map[string]any, createdBy string, targets ...uuid.UUID) (*uuid.UUID, error)
 }
diff --git a/testutil/notifications.go b/testutil/notifications.go
@@ -21,10 +21,10 @@ type Notification struct {
 }
 
 func (f *FakeNotificationsEnqueuer) Enqueue(ctx context.Context, userID, templateID uuid.UUID, labels map[string]string, createdBy string, targets ...uuid.UUID) (*uuid.UUID, error) {
-	return f.EnqueueData(ctx, userID, templateID, labels, nil, createdBy, targets...)
+	return f.EnqueueWithData(ctx, userID, templateID, labels, nil, createdBy, targets...)
 }
 
-func (f *FakeNotificationsEnqueuer) EnqueueData(_ context.Context, userID, templateID uuid.UUID, labels map[string]string, data map[string]any, createdBy string, targets ...uuid.UUID) (*uuid.UUID, error) {
+func (f *FakeNotificationsEnqueuer) EnqueueWithData(_ context.Context, userID, templateID uuid.UUID, labels map[string]string, data map[string]any, createdBy string, targets ...uuid.UUID) (*uuid.UUID, error) {
 	f.mu.Lock()
 	defer f.mu.Unlock()
 

Original file line number	Diff line number	Diff line change
`@@ -166,7 +166,7 @@ func reportFailedWorkspaceBuilds(ctx context.Context, logger slog.Logger, db dat`
`166`	`166`	`templateDisplayName = stats.TemplateName`
`167`	`167`	`}`
`168`	`168`
`169`		`- if _, err := enqueuer.EnqueueData(ctx, templateAdmin.ID, notifications.TemplateWorkspaceBuildsFailedReport,`
	`169`	`+ if _, err := enqueuer.EnqueueWithData(ctx, templateAdmin.ID, notifications.TemplateWorkspaceBuildsFailedReport,`
`170`	`170`	`map[string]string{`
`171`	`171`	`"template_name": stats.TemplateName,`
`172`	`172`	`"template_display_name": templateDisplayName,`
Original file line number	Diff line number	Diff line change
`@@ -33,5 +33,5 @@ type Handler interface {`
`33`	`33`	`// Enqueuer enqueues a new notification message in the store and returns its ID, should it enqueue without failure.`
`34`	`34`	`type Enqueuer interface {`
`35`	`35`	`Enqueue(ctx context.Context, userID, templateID uuid.UUID, labels map[string]string, createdBy string, targets ...uuid.UUID) (*uuid.UUID, error)`
`36`		`- EnqueueData(ctx context.Context, userID, templateID uuid.UUID, labels map[string]string, data map[string]any, createdBy string, targets ...uuid.UUID) (*uuid.UUID, error)`
	`36`	`+ EnqueueWithData(ctx context.Context, userID, templateID uuid.UUID, labels map[string]string, data map[string]any, createdBy string, targets ...uuid.UUID) (*uuid.UUID, error)`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,10 +21,10 @@ type Notification struct {`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`func (f FakeNotificationsEnqueuer) Enqueue(ctx context.Context, userID, templateID uuid.UUID, labels map[string]string, createdBy string, targets ...uuid.UUID) (uuid.UUID, error) {`
`24`		`- return f.EnqueueData(ctx, userID, templateID, labels, nil, createdBy, targets...)`
	`24`	`+ return f.EnqueueWithData(ctx, userID, templateID, labels, nil, createdBy, targets...)`
`25`	`25`	`}`
`26`	`26`
`27`		`-func (f FakeNotificationsEnqueuer) EnqueueData(_ context.Context, userID, templateID uuid.UUID, labels map[string]string, data map[string]any, createdBy string, targets ...uuid.UUID) (uuid.UUID, error) {`
	`27`	`+func (f FakeNotificationsEnqueuer) EnqueueWithData(_ context.Context, userID, templateID uuid.UUID, labels map[string]string, data map[string]any, createdBy string, targets ...uuid.UUID) (uuid.UUID, error) {`
`28`	`28`	`f.mu.Lock()`
`29`	`29`	`defer f.mu.Unlock()`
`30`	`30`