synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-09 11:45:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: prevent password reset notifications ending up in coder inbox (#17109)

Browse Source 
We do not want password reset notifications to end up in Coder Inbox as
this doesn't make much sense. This implements the logic to ensure they
are not delivered if the method is Coder Inbox.

In the future we might want to investigate a better solution but for now
this works.
This commit is contained in:
Danielle Maywood
2025-03-26 11:08:31 +00:00
committed by GitHub
parent 1bbbae8d57
commit c8f3b35e13
2 changed files with 84 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
coderd/notifications/enqueuer.go
View File

@ -116,6 +116,13 @@ func (s *StoreEnqueuer) EnqueueWithData(ctx context.Context, userID, templateID
uuids := make([]uuid.UUID, 0, 2)
for _, method := range methods {
// TODO(DanielleMaywood):
// We should have a more permanent solution in the future, but for now this will work.
// We do not want password reset notifications to end up in Coder Inbox.
if method == database.NotificationMethodInbox && templateID == TemplateUserRequestedOneTimePasscode {
continue
}
id := uuid.New()
err = s.store.EnqueueNotificationMessage(ctx, database.EnqueueNotificationMessageParams{
ID: id,

77
coderd/notifications/notifications_test.go
View File

@ -1952,6 +1952,83 @@ func TestNotificationTargetMatrix(t *testing.T) {
}
}
func TestNotificationOneTimePasswordDeliveryTargets(t *testing.T) {
t.Parallel()
t.Run("Inbox", func(t *testing.T) {
t.Parallel()
// nolint:gocritic // Unit test.
ctx := dbauthz.AsNotifier(testutil.Context(t, testutil.WaitSuperLong))
store, _ := dbtestutil.NewDB(t)
logger := testutil.Logger(t)
// Given: Coder Inbox is enabled and SMTP/Webhook are disabled.
cfg := defaultNotificationsConfig(database.NotificationMethodSmtp)
cfg.Inbox.Enabled = true
cfg.SMTP = codersdk.NotificationsEmailConfig{}
cfg.Webhook = codersdk.NotificationsWebhookConfig{}
enq, err := notifications.NewStoreEnqueuer(cfg, store, defaultHelpers(), logger.Named("enqueuer"), quartz.NewMock(t))
require.NoError(t, err)
user := createSampleUser(t, store)
// When: A one-time-passcode notification is sent, it does not enqueue a notification.
enqueued, err := enq.Enqueue(ctx, user.ID, notifications.TemplateUserRequestedOneTimePasscode,
map[string]string{"one_time_passcode": "1234"}, "test", user.ID)
require.NoError(t, err)
require.Len(t, enqueued, 0)
})
t.Run("SMTP", func(t *testing.T) {
t.Parallel()
// nolint:gocritic // Unit test.
ctx := dbauthz.AsNotifier(testutil.Context(t, testutil.WaitSuperLong))
store, _ := dbtestutil.NewDB(t)
logger := testutil.Logger(t)
// Given: Coder Inbox/Webhook are disabled and SMTP is enabled.
cfg := defaultNotificationsConfig(database.NotificationMethodSmtp)
cfg.Inbox.Enabled = false
cfg.Webhook = codersdk.NotificationsWebhookConfig{}
enq, err := notifications.NewStoreEnqueuer(cfg, store, defaultHelpers(), logger.Named("enqueuer"), quartz.NewMock(t))
require.NoError(t, err)
user := createSampleUser(t, store)
// When: A one-time-passcode notification is sent, it does enqueue a notification.
enqueued, err := enq.Enqueue(ctx, user.ID, notifications.TemplateUserRequestedOneTimePasscode,
map[string]string{"one_time_passcode": "1234"}, "test", user.ID)
require.NoError(t, err)
require.Len(t, enqueued, 1)
})
t.Run("Webhook", func(t *testing.T) {
t.Parallel()
// nolint:gocritic // Unit test.
ctx := dbauthz.AsNotifier(testutil.Context(t, testutil.WaitSuperLong))
store, _ := dbtestutil.NewDB(t)
logger := testutil.Logger(t)
// Given: Coder Inbox/SMTP are disabled and Webhook is enabled.
cfg := defaultNotificationsConfig(database.NotificationMethodWebhook)
cfg.Inbox.Enabled = false
cfg.SMTP = codersdk.NotificationsEmailConfig{}
enq, err := notifications.NewStoreEnqueuer(cfg, store, defaultHelpers(), logger.Named("enqueuer"), quartz.NewMock(t))
require.NoError(t, err)
user := createSampleUser(t, store)
// When: A one-time-passcode notification is sent, it does enqueue a notification.
enqueued, err := enq.Enqueue(ctx, user.ID, notifications.TemplateUserRequestedOneTimePasscode,
map[string]string{"one_time_passcode": "1234"}, "test", user.ID)
require.NoError(t, err)
require.Len(t, enqueued, 1)
})
}
type fakeHandler struct {
mu sync.RWMutex
succeeded, failed []string