diff --git a/coderd/database/dbauthz/dbauthz_test.go b/coderd/database/dbauthz/dbauthz_test.go index d85192877f87a..e615fd3054d6e 100644 --- a/coderd/database/dbauthz/dbauthz_test.go +++ b/coderd/database/dbauthz/dbauthz_test.go @@ -2493,7 +2493,8 @@ func (s *MethodTestSuite) TestSystemFunctions() { })) s.Run("FetchNewMessageMetadata", s.Subtest(func(db database.Store, check *expects) { // TODO: update this test once we have a specific role for notifications - check.Args(database.FetchNewMessageMetadataParams{}).Asserts(rbac.ResourceSystem, policy.ActionRead) + u := dbgen.User(s.T(), db, database.User{}) + check.Args(database.FetchNewMessageMetadataParams{UserID: u.ID}).Asserts(rbac.ResourceSystem, policy.ActionRead) })) s.Run("GetNotificationMessagesByStatus", s.Subtest(func(db database.Store, check *expects) { // TODO: update this test once we have a specific role for notifications diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go index 3db958cb9a307..3954e47f43846 100644 --- a/coderd/database/dbmem/dbmem.go +++ b/coderd/database/dbmem/dbmem.go @@ -1229,7 +1229,7 @@ func (*FakeQuerier) BulkMarkNotificationMessagesFailed(_ context.Context, arg da if err != nil { return 0, err } - return -1, nil + return int64(len(arg.IDs)), nil } func (*FakeQuerier) BulkMarkNotificationMessagesSent(_ context.Context, arg database.BulkMarkNotificationMessagesSentParams) (int64, error) { @@ -1237,7 +1237,7 @@ func (*FakeQuerier) BulkMarkNotificationMessagesSent(_ context.Context, arg data if err != nil { return 0, err } - return -1, nil + return int64(len(arg.IDs)), nil } func (*FakeQuerier) CleanTailnetCoordinators(_ context.Context) error { @@ -1864,20 +1864,31 @@ func (q *FakeQuerier) FavoriteWorkspace(_ context.Context, arg uuid.UUID) error return nil } -func (*FakeQuerier) FetchNewMessageMetadata(_ context.Context, arg database.FetchNewMessageMetadataParams) (database.FetchNewMessageMetadataRow, error) { +func (q *FakeQuerier) FetchNewMessageMetadata(_ context.Context, arg database.FetchNewMessageMetadataParams) (database.FetchNewMessageMetadataRow, error) { err := validateDatabaseType(arg) if err != nil { return database.FetchNewMessageMetadataRow{}, err } + user, err := q.getUserByIDNoLock(arg.UserID) + if err != nil { + return database.FetchNewMessageMetadataRow{}, xerrors.Errorf("fetch user: %w", err) + } + + // Mimic COALESCE in query + userName := user.Name + if userName == "" { + userName = user.Username + } + actions, err := json.Marshal([]types.TemplateAction{{URL: "http://xyz.com", Label: "XYZ"}}) if err != nil { return database.FetchNewMessageMetadataRow{}, err } return database.FetchNewMessageMetadataRow{ - UserEmail: "test@test.com", - UserName: "Testy McTester", + UserEmail: user.Email, + UserName: userName, NotificationName: "Some notification", Actions: actions, UserID: arg.UserID, diff --git a/coderd/notifications/manager_test.go b/coderd/notifications/manager_test.go index 30a736488ed24..ee07913c5dc87 100644 --- a/coderd/notifications/manager_test.go +++ b/coderd/notifications/manager_test.go @@ -12,12 +12,8 @@ import ( "github.com/stretchr/testify/require" "golang.org/x/xerrors" - "cdr.dev/slog" - "cdr.dev/slog/sloggers/slogtest" "github.com/coder/coder/v2/coderd/database" "github.com/coder/coder/v2/coderd/database/dbgen" - "github.com/coder/coder/v2/coderd/database/dbmem" - "github.com/coder/coder/v2/coderd/database/dbtestutil" "github.com/coder/coder/v2/coderd/notifications" "github.com/coder/coder/v2/coderd/notifications/dispatch" "github.com/coder/coder/v2/coderd/notifications/types" @@ -29,17 +25,15 @@ func TestBufferedUpdates(t *testing.T) { t.Parallel() // setup - if !dbtestutil.WillUsePostgres() { - t.Skip("This test requires postgres") - } + ctx, logger, db := setupInMemory(t) - ctx, logger, db := setup(t) interceptor := &bulkUpdateInterceptor{Store: db} santa := &santaHandler{} cfg := defaultNotificationsConfig(database.NotificationMethodSmtp) cfg.StoreSyncInterval = serpent.Duration(time.Hour) // Ensure we don't sync the store automatically. + // GIVEN: a manager which will pass or fail notifications based on their "nice" labels mgr, err := notifications.NewManager(cfg, interceptor, logger.Named("notifications-manager")) require.NoError(t, err) mgr.WithHandlers(map[database.NotificationMethod]notifications.Handler{ @@ -50,7 +44,7 @@ func TestBufferedUpdates(t *testing.T) { user := dbgen.User(t, db, database.User{}) - // given + // WHEN: notifications are enqueued which should succeed and fail _, err = enq.Enqueue(ctx, user.ID, notifications.TemplateWorkspaceDeleted, map[string]string{"nice": "true"}, "") // Will succeed. require.NoError(t, err) _, err = enq.Enqueue(ctx, user.ID, notifications.TemplateWorkspaceDeleted, map[string]string{"nice": "true"}, "") // Will succeed. @@ -58,10 +52,9 @@ func TestBufferedUpdates(t *testing.T) { _, err = enq.Enqueue(ctx, user.ID, notifications.TemplateWorkspaceDeleted, map[string]string{"nice": "false"}, "") // Will fail. require.NoError(t, err) - // when mgr.Run(ctx) - // then + // THEN: const ( expectedSuccess = 2 @@ -99,7 +92,10 @@ func TestBufferedUpdates(t *testing.T) { func TestBuildPayload(t *testing.T) { t.Parallel() - // given + // SETUP + ctx, logger, db := setupInMemory(t) + + // GIVEN: a set of helpers to be injected into the templates const label = "Click here!" const url = "http://xyz.com/" helpers := map[string]any{ @@ -107,7 +103,7 @@ func TestBuildPayload(t *testing.T) { "my_url": func() string { return url }, } - db := dbmem.New() + // GIVEN: an enqueue interceptor which returns mock metadata interceptor := newEnqueueInterceptor(db, // Inject custom message metadata to influence the payload construction. func() database.FetchNewMessageMetadataRow { @@ -130,17 +126,14 @@ func TestBuildPayload(t *testing.T) { } }) - logger := slogtest.Make(t, &slogtest.Options{IgnoreErrors: true, IgnoredErrorIs: []error{}}).Leveled(slog.LevelDebug) enq, err := notifications.NewStoreEnqueuer(defaultNotificationsConfig(database.NotificationMethodSmtp), interceptor, helpers, logger.Named("notifications-enqueuer")) require.NoError(t, err) - ctx := testutil.Context(t, testutil.WaitShort) - - // when + // WHEN: a notification is enqueued _, err = enq.Enqueue(ctx, uuid.New(), notifications.TemplateWorkspaceDeleted, nil, "test") require.NoError(t, err) - // then + // THEN: expect that a payload will be constructed and have the expected values payload := testutil.RequireRecvCtx(ctx, t, interceptor.payload) require.Len(t, payload.Actions, 1) require.Equal(t, label, payload.Actions[0].Label) @@ -150,12 +143,14 @@ func TestBuildPayload(t *testing.T) { func TestStopBeforeRun(t *testing.T) { t.Parallel() - ctx := context.Background() - logger := slogtest.Make(t, &slogtest.Options{IgnoreErrors: true, IgnoredErrorIs: []error{}}).Leveled(slog.LevelDebug) - mgr, err := notifications.NewManager(defaultNotificationsConfig(database.NotificationMethodSmtp), dbmem.New(), logger.Named("notifications-manager")) + // SETUP + ctx, logger, db := setupInMemory(t) + + // GIVEN: a standard manager + mgr, err := notifications.NewManager(defaultNotificationsConfig(database.NotificationMethodSmtp), db, logger.Named("notifications-manager")) require.NoError(t, err) - // Call stop before notifier is started with Run(). + // THEN: validate that the manager can be stopped safely without Run() having been called yet require.Eventually(t, func() bool { assert.NoError(t, mgr.Stop(ctx)) return true diff --git a/coderd/notifications/notifications_test.go b/coderd/notifications/notifications_test.go index 6c2cf430fe460..a8cdf4c96e8a9 100644 --- a/coderd/notifications/notifications_test.go +++ b/coderd/notifications/notifications_test.go @@ -13,19 +13,19 @@ import ( "testing" "time" + "golang.org/x/exp/slices" + "golang.org/x/xerrors" + "github.com/google/uuid" smtpmock "github.com/mocktools/go-smtp-mock/v2" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "go.uber.org/goleak" - "cdr.dev/slog" - "cdr.dev/slog/sloggers/slogtest" "github.com/coder/serpent" "github.com/coder/coder/v2/coderd/database" "github.com/coder/coder/v2/coderd/database/dbgen" - "github.com/coder/coder/v2/coderd/database/dbmem" "github.com/coder/coder/v2/coderd/database/dbtestutil" "github.com/coder/coder/v2/coderd/notifications" "github.com/coder/coder/v2/coderd/notifications/dispatch" @@ -40,23 +40,24 @@ func TestMain(m *testing.M) { } // TestBasicNotificationRoundtrip enqueues a message to the store, waits for it to be acquired by a notifier, -// and passes it off to a fake handler. -// TODO: split this test up into table tests or separate tests. +// passes it off to a fake handler, and ensures the results are synchronized to the store. func TestBasicNotificationRoundtrip(t *testing.T) { t.Parallel() - // setup + // SETUP if !dbtestutil.WillUsePostgres() { - t.Skip("This test requires postgres") + t.Skip("This test requires postgres; it relies on business-logic only implemented in the database") } + ctx, logger, db := setup(t) method := database.NotificationMethodSmtp - // given + // GIVEN: a manager with standard config but a faked dispatch handler handler := &fakeHandler{} - + interceptor := &bulkUpdateInterceptor{Store: db} cfg := defaultNotificationsConfig(method) - mgr, err := notifications.NewManager(cfg, db, logger.Named("manager")) + cfg.RetryInterval = serpent.Duration(time.Hour) // Ensure retries don't interfere with the test + mgr, err := notifications.NewManager(cfg, interceptor, logger.Named("manager")) require.NoError(t, err) mgr.WithHandlers(map[database.NotificationMethod]notifications.Handler{method: handler}) t.Cleanup(func() { @@ -67,7 +68,7 @@ func TestBasicNotificationRoundtrip(t *testing.T) { user := createSampleUser(t, db) - // when + // WHEN: 2 messages are enqueued sid, err := enq.Enqueue(ctx, user.ID, notifications.TemplateWorkspaceDeleted, map[string]string{"type": "success"}, "test") require.NoError(t, err) fid, err := enq.Enqueue(ctx, user.ID, notifications.TemplateWorkspaceDeleted, map[string]string{"type": "failure"}, "test") @@ -75,27 +76,40 @@ func TestBasicNotificationRoundtrip(t *testing.T) { mgr.Run(ctx) - // then + // THEN: we expect that the handler will have received the notifications for dispatch require.Eventually(t, func() bool { handler.mu.RLock() defer handler.mu.RUnlock() - return handler.succeeded == sid.String() - }, testutil.WaitLong, testutil.IntervalMedium) + return slices.Contains(handler.succeeded, sid.String()) && + slices.Contains(handler.failed, fid.String()) + }, testutil.WaitLong, testutil.IntervalFast) + + // THEN: we expect the store to be called with the updates of the earlier dispatches require.Eventually(t, func() bool { - handler.mu.RLock() - defer handler.mu.RUnlock() - return handler.failed == fid.String() - }, testutil.WaitLong, testutil.IntervalMedium) + return interceptor.sent.Load() == 1 && + interceptor.failed.Load() == 1 + }, testutil.WaitShort, testutil.IntervalFast) + + // THEN: we verify that the store contains notifications in their expected state + success, err := db.GetNotificationMessagesByStatus(ctx, database.GetNotificationMessagesByStatusParams{ + Status: database.NotificationMessageStatusSent, + Limit: 10, + }) + require.NoError(t, err) + require.Len(t, success, 1) + failed, err := db.GetNotificationMessagesByStatus(ctx, database.GetNotificationMessagesByStatusParams{ + Status: database.NotificationMessageStatusTemporaryFailure, + Limit: 10, + }) + require.NoError(t, err) + require.Len(t, failed, 1) } func TestSMTPDispatch(t *testing.T) { t.Parallel() - // setup - if !dbtestutil.WillUsePostgres() { - t.Skip("This test requires postgres") - } - ctx, logger, db := setup(t) + // SETUP + ctx, logger, db := setupInMemory(t) // start mock SMTP server mockSMTPSrv := smtpmock.New(smtpmock.ConfigurationAttr{ @@ -107,7 +121,7 @@ func TestSMTPDispatch(t *testing.T) { assert.NoError(t, mockSMTPSrv.Stop()) }) - // given + // GIVEN: an SMTP setup referencing a mock SMTP server const from = "danny@coder.com" method := database.NotificationMethodSmtp cfg := defaultNotificationsConfig(method) @@ -128,19 +142,20 @@ func TestSMTPDispatch(t *testing.T) { user := createSampleUser(t, db) - // when + // WHEN: a message is enqueued msgID, err := enq.Enqueue(ctx, user.ID, notifications.TemplateWorkspaceDeleted, map[string]string{}, "test") require.NoError(t, err) mgr.Run(ctx) - // then + // THEN: wait until the dispatch interceptor validates that the messages were dispatched require.Eventually(t, func() bool { assert.Nil(t, handler.lastErr.Load()) assert.True(t, handler.retryable.Load() == 0) return handler.sent.Load() == 1 }, testutil.WaitLong, testutil.IntervalMedium) + // THEN: we verify that the expected message was received by the mock SMTP server msgs := mockSMTPSrv.MessagesAndPurge() require.Len(t, msgs, 1) require.Contains(t, msgs[0].MsgRequest(), fmt.Sprintf("From: %s", from)) @@ -151,11 +166,8 @@ func TestSMTPDispatch(t *testing.T) { func TestWebhookDispatch(t *testing.T) { t.Parallel() - // setup - if !dbtestutil.WillUsePostgres() { - t.Skip("This test requires postgres") - } - ctx, logger, db := setup(t) + // SETUP + ctx, logger, db := setupInMemory(t) sent := make(chan dispatch.WebhookPayload, 1) // Mock server to simulate webhook endpoint. @@ -175,7 +187,7 @@ func TestWebhookDispatch(t *testing.T) { endpoint, err := url.Parse(server.URL) require.NoError(t, err) - // given + // GIVEN: a webhook setup referencing a mock HTTP server to receive the webhook cfg := defaultNotificationsConfig(database.NotificationMethodWebhook) cfg.Webhook = codersdk.NotificationsWebhookConfig{ Endpoint: *serpent.URLOf(endpoint), @@ -188,13 +200,17 @@ func TestWebhookDispatch(t *testing.T) { enq, err := notifications.NewStoreEnqueuer(cfg, db, defaultHelpers(), logger.Named("enqueuer")) require.NoError(t, err) + const ( + email = "bob@coder.com" + name = "Robert McBobbington" + ) user := dbgen.User(t, db, database.User{ - Email: "bob@coder.com", + Email: email, Username: "bob", - Name: "Robert McBobbington", + Name: name, }) - // when + // WHEN: a notification is enqueued (including arbitrary labels) input := map[string]string{ "a": "b", "c": "d", @@ -204,15 +220,18 @@ func TestWebhookDispatch(t *testing.T) { mgr.Run(ctx) - // then + // THEN: the webhook is received by the mock server and has the expected contents payload := testutil.RequireRecvCtx(testutil.Context(t, testutil.WaitShort), t, sent) require.EqualValues(t, "1.0", payload.Version) 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.UserEmail, email) // 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") + // This is not strictly necessary for this test, but it's testing some side logic which is too small for its own test. + require.Equal(t, payload.Payload.UserName, name) + // Right now we don't have a way to query notification templates by ID in dbmem, and it's not necessary to add this + // just to satisfy this test. We can safely assume that as long as this value is not empty that the given value was delivered. + require.NotEmpty(t, payload.Payload.NotificationName) } // TestBackpressure validates that delays in processing the buffered updates will result in slowed dequeue rates. @@ -220,9 +239,9 @@ func TestWebhookDispatch(t *testing.T) { func TestBackpressure(t *testing.T) { t.Parallel() - // setup + // SETUP if !dbtestutil.WillUsePostgres() { - t.Skip("This test requires postgres") + t.Skip("This test requires postgres; it relies on business-logic only implemented in the database") } ctx, logger, db := setup(t) @@ -268,7 +287,7 @@ func TestBackpressure(t *testing.T) { // Intercept calls to submit the buffered updates to the store. storeInterceptor := &bulkUpdateInterceptor{Store: db} - // given + // GIVEN: a notification manager whose updates will be intercepted mgr, err := notifications.NewManager(cfg, storeInterceptor, logger.Named("manager")) require.NoError(t, err) mgr.WithHandlers(map[database.NotificationMethod]notifications.Handler{method: handler}) @@ -277,7 +296,7 @@ func TestBackpressure(t *testing.T) { user := createSampleUser(t, db) - // when + // WHEN: a set of notifications are enqueued, which causes backpressure due to the batchSize which can be processed per fetch const totalMessages = 30 for i := 0; i < totalMessages; i++ { _, err = enq.Enqueue(ctx, user.ID, notifications.TemplateWorkspaceDeleted, map[string]string{"i": fmt.Sprintf("%d", i)}, "test") @@ -287,7 +306,7 @@ func TestBackpressure(t *testing.T) { // Start the notifier. mgr.Run(ctx) - // then + // THEN: // Wait for 3 fetch intervals, then check progress. time.Sleep(fetchInterval * 3) @@ -308,15 +327,15 @@ func TestBackpressure(t *testing.T) { func TestRetries(t *testing.T) { t.Parallel() - // setup + // SETUP if !dbtestutil.WillUsePostgres() { - t.Skip("This test requires postgres") + t.Skip("This test requires postgres; it relies on business-logic only implemented in the database") } const maxAttempts = 3 ctx, logger, db := setup(t) - // given + // GIVEN: a mock HTTP server which will receive webhooksand a map to track the dispatch attempts receivedMap := syncmap.New[uuid.UUID, int]() // Mock server to simulate webhook endpoint. @@ -375,7 +394,7 @@ func TestRetries(t *testing.T) { user := createSampleUser(t, db) - // when + // WHEN: a few notifications are enqueued, which will all fail until their final retry (determined by the mock server) const msgCount = 5 for i := 0; i < msgCount; i++ { _, err = enq.Enqueue(ctx, user.ID, notifications.TemplateWorkspaceDeleted, map[string]string{"i": fmt.Sprintf("%d", i)}, "test") @@ -384,7 +403,7 @@ func TestRetries(t *testing.T) { mgr.Run(ctx) - // then + // THEN: we expect to see all but the final attempts failing require.Eventually(t, func() bool { // We expect all messages to fail all attempts but the final; return storeInterceptor.failed.Load() == msgCount*(maxAttempts-1) && @@ -400,14 +419,14 @@ func TestRetries(t *testing.T) { func TestExpiredLeaseIsRequeued(t *testing.T) { t.Parallel() - // setup + // SETUP if !dbtestutil.WillUsePostgres() { - t.Skip("This test requires postgres") + t.Skip("This test requires postgres; it relies on business-logic only implemented in the database") } ctx, logger, db := setup(t) - // given + // GIVEN: a manager which has its updates intercepted and paused until measurements can be taken const ( leasePeriod = time.Second @@ -432,7 +451,7 @@ func TestExpiredLeaseIsRequeued(t *testing.T) { user := createSampleUser(t, db) - // when + // WHEN: a few notifications are enqueued which will all succeed var msgs []string for i := 0; i < msgCount; i++ { id, err := enq.Enqueue(ctx, user.ID, notifications.TemplateWorkspaceDeleted, map[string]string{"type": "success"}, "test") @@ -442,6 +461,8 @@ func TestExpiredLeaseIsRequeued(t *testing.T) { mgr.Run(mgrCtx) + // THEN: + // Wait for the messages to be acquired <-noopInterceptor.acquiredChan // Then cancel the context, forcing the notification manager to shutdown ungracefully (simulating a crash); leaving messages in "leased" status. @@ -499,29 +520,29 @@ func TestExpiredLeaseIsRequeued(t *testing.T) { func TestInvalidConfig(t *testing.T) { t.Parallel() - db := dbmem.New() - logger := slogtest.Make(t, &slogtest.Options{IgnoreErrors: true, IgnoredErrorIs: []error{}}).Leveled(slog.LevelDebug) - - // given + _, logger, db := setupInMemory(t) + // GIVEN: invalid config with dispatch period <= lease period const ( leasePeriod = time.Second method = database.NotificationMethodSmtp ) - cfg := defaultNotificationsConfig(method) cfg.LeasePeriod = serpent.Duration(leasePeriod) cfg.DispatchTimeout = serpent.Duration(leasePeriod) + // WHEN: the manager is created with invalid config _, err := notifications.NewManager(cfg, db, logger.Named("manager")) + + // THEN: the manager will fail to be created, citing invalid config as error require.ErrorIs(t, err, notifications.ErrInvalidDispatchTimeout) } type fakeHandler struct { mu sync.RWMutex - succeeded string - failed string + succeeded []string + failed []string } func (f *fakeHandler) Dispatcher(payload types.MessagePayload, _, _ string) (dispatch.DeliveryFunc, error) { @@ -530,11 +551,12 @@ func (f *fakeHandler) Dispatcher(payload types.MessagePayload, _, _ string) (dis defer f.mu.Unlock() if payload.Labels["type"] == "success" { - f.succeeded = msgID.String() - } else { - f.failed = msgID.String() + f.succeeded = append(f.succeeded, msgID.String()) + return false, nil } - return false, nil + + f.failed = append(f.failed, msgID.String()) + return true, xerrors.New("oops") }, nil } diff --git a/coderd/notifications/utils_test.go b/coderd/notifications/utils_test.go index 12db76f5e48aa..74432f9c2617e 100644 --- a/coderd/notifications/utils_test.go +++ b/coderd/notifications/utils_test.go @@ -15,6 +15,7 @@ import ( "github.com/coder/coder/v2/coderd/database" "github.com/coder/coder/v2/coderd/database/dbauthz" "github.com/coder/coder/v2/coderd/database/dbgen" + "github.com/coder/coder/v2/coderd/database/dbmem" "github.com/coder/coder/v2/coderd/database/dbtestutil" "github.com/coder/coder/v2/codersdk" "github.com/coder/coder/v2/testutil" @@ -41,6 +42,17 @@ func setup(t *testing.T) (context.Context, slog.Logger, database.Store) { return dbauthz.AsSystemRestricted(ctx), logger, database.New(sqlDB) } +func setupInMemory(t *testing.T) (context.Context, slog.Logger, database.Store) { + t.Helper() + + ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort) + t.Cleanup(cancel) + logger := slogtest.Make(t, &slogtest.Options{IgnoreErrors: true, IgnoredErrorIs: []error{}}).Leveled(slog.LevelDebug) + + // nolint:gocritic // unit tests. + return dbauthz.AsSystemRestricted(ctx), logger, dbmem.New() +} + func defaultNotificationsConfig(method database.NotificationMethod) codersdk.NotificationsConfig { return codersdk.NotificationsConfig{ Method: serpent.String(method), pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy