Mar 20, 2025 · Mar 18, 2025 · Mar 18, 2025 · Mar 18, 2025 · Mar 18, 2025 · Mar 18, 2025
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/coderd.go b/coderd/coderd.go
 r.Use(apiKeyMiddleware)
 r.Route("/inbox", func(r chi.Router) {
 r.Get("/", api.listInboxNotifications)
 r.Put("/mark-all-as-read", api.markAllInboxNotificationsAsRead)
 r.Get("/watch", api.watchInboxNotifications)
 r.Put("/{id}/read-status", api.updateInboxNotificationReadStatus)
 })
diff --git a/coderd/database/dbauthz/dbauthz.go b/coderd/database/dbauthz/dbauthz.go
 return q.db.ListWorkspaceAgentPortShares(ctx, workspaceID)
 }

 func (q *querier) MarkAllInboxNotificationsAsRead(ctx context.Context, arg database.MarkAllInboxNotificationsAsReadParams) error {
 resource := rbac.ResourceInboxNotification.WithOwner(arg.UserID.String())

 if err := q.authorizeContext(ctx, policy.ActionUpdate, resource); err != nil {
 return err
 }

 return q.db.MarkAllInboxNotificationsAsRead(ctx, arg)
 }

 func (q *querier) OIDCClaimFieldValues(ctx context.Context, args database.OIDCClaimFieldValuesParams) ([]string, error) {
 resource := rbac.ResourceIdpsyncSettings
 if args.OrganizationID != uuid.Nil {
diff --git a/coderd/database/dbauthz/dbauthz_test.go b/coderd/database/dbauthz/dbauthz_test.go
 ReadAt: sql.NullTime{Time: readAt, Valid: true},
 }).Asserts(rbac.ResourceInboxNotification.WithID(notifID).WithOwner(u.ID.String()), policy.ActionUpdate)
 }))

 s.Run("MarkAllInboxNotificationsAsRead", s.Subtest(func(db database.Store, check *expects) {
 u := dbgen.User(s.T(), db, database.User{})

 check.Args(database.MarkAllInboxNotificationsAsReadParams{
 UserID: u.ID,
 ReadAt: sql.NullTime{Time: dbtestutil.NowInDefaultTimezone(), Valid: true},
 }).Asserts(rbac.ResourceInboxNotification.WithOwner(u.ID.String()), policy.ActionUpdate)
 }))
 }

 func (s *MethodTestSuite) TestOAuth2ProviderApps() {
diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
 return shares, nil
 }

 func (q *FakeQuerier) MarkAllInboxNotificationsAsRead(_ context.Context, arg database.MarkAllInboxNotificationsAsReadParams) error {
 err := validateDatabaseType(arg)
 if err != nil {
 return err
 }

 for idx, notif := range q.inboxNotifications {
 if notif.UserID == arg.UserID && !notif.ReadAt.Valid {
 q.inboxNotifications[idx].ReadAt = arg.ReadAt
 }
 }

 return nil
 }

 // nolint:forcetypeassert
 func (q *FakeQuerier) OIDCClaimFieldValues(_ context.Context, args database.OIDCClaimFieldValuesParams) ([]string, error) {
 orgMembers := q.getOrganizationMemberNoLock(args.OrganizationID)
diff --git a/coderd/database/dbmetrics/querymetrics.go b/coderd/database/dbmetrics/querymetrics.go
diff --git a/coderd/database/dbmock/dbmock.go b/coderd/database/dbmock/dbmock.go
diff --git a/coderd/database/querier.go b/coderd/database/querier.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/notificationsinbox.sql b/coderd/database/queries/notificationsinbox.sql
    read_at = $1
 WHERE
    id = $2;

 -- name: MarkAllInboxNotificationsAsRead :exec
 UPDATE
 inbox_notifications
 SET
 read_at = $1
 WHERE
 user_id = $2 and read_at IS NULL;
diff --git a/coderd/inboxnotifications.go b/coderd/inboxnotifications.go
 UnreadCount:  int(unreadCount),
 })
 }

 // markAllInboxNotificationsAsRead marks as read all unread notifications for authenticated user.
 // @Summary Mark all unread notifications as read
 // @ID mark-all-unread-notifications-as-read
 // @Security CoderSessionToken
 // @Tags Notifications
 // @Success 204
 // @Router /notifications/inbox/mark-all-as-read [put]
 func (api *API) markAllInboxNotificationsAsRead(rw http.ResponseWriter, r *http.Request) {
 var (
 ctx    = r.Context()
 apikey = httpmw.APIKey(r)
 )

 err := api.Database.MarkAllInboxNotificationsAsRead(ctx, database.MarkAllInboxNotificationsAsReadParams{
 UserID: apikey.UserID,
 ReadAt: sql.NullTime{Time: dbtime.Now(), Valid: true},
 })
 if err != nil {
 api.Logger.Error(ctx, "failed to mark all unread notifications as read", slog.Error(err))
 httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
 Message: "Failed to mark all unread notifications as read.",
 })
 return
 }

 rw.WriteHeader(http.StatusNoContent)
 }
diff --git a/coderd/inboxnotifications_test.go b/coderd/inboxnotifications_test.go
 // I skip these tests specifically on windows as for now they are flaky - only on Windows.
 // For now the idea is that the runner takes too long to insert the entries, could be worth
 // investigating a manual Tx.
 // see: https://github.com/coder/internal/issues/503
 if runtime.GOOS == "windows" {
 t.Skip("our runners are randomly taking too long to insert entries")
 }
 // I skip these tests specifically on windows as for now they are flaky - only on Windows.
 // For now the idea is that the runner takes too long to insert the entries, could be worth
 // investigating a manual Tx.
 // see: https://github.com/coder/internal/issues/503
 if runtime.GOOS == "windows" {
 t.Skip("our runners are randomly taking too long to insert entries")
 }
 // I skip these tests specifically on windows as for now they are flaky - only on Windows.
 // For now the idea is that the runner takes too long to insert the entries, could be worth
 // investigating a manual Tx.
 // see: https://github.com/coder/internal/issues/503
 if runtime.GOOS == "windows" {
 t.Skip("our runners are randomly taking too long to insert entries")
 }
 require.Empty(t, updatedNotif.Notification)
 })
 }

 func TestInboxNotifications_MarkAllAsRead(t *testing.T) {
 t.Parallel()

 // I skip these tests specifically on windows as for now they are flaky - only on Windows.
 // For now the idea is that the runner takes too long to insert the entries, could be worth
 // investigating a manual Tx.
 // see: https://github.com/coder/internal/issues/503
 if runtime.GOOS == "windows" {
 t.Skip("our runners are randomly taking too long to insert entries")
 }

 t.Run("ok", func(t *testing.T) {
 t.Parallel()
 client, _, api := coderdtest.NewWithAPI(t, &coderdtest.Options{})
 firstUser := coderdtest.CreateFirstUser(t, client)
 client, member := coderdtest.CreateAnotherUser(t, client, firstUser.OrganizationID)

 ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
 defer cancel()

 notifs, err := client.ListInboxNotifications(ctx, codersdk.ListInboxNotificationsRequest{})
 require.NoError(t, err)
 require.NotNil(t, notifs)
 require.Equal(t, 0, notifs.UnreadCount)
 require.Empty(t, notifs.Notifications)

 for i := range 20 {
 dbgen.NotificationInbox(t, api.Database, database.InsertInboxNotificationParams{
 ID:         uuid.New(),
 UserID:     member.ID,
 TemplateID: notifications.TemplateWorkspaceOutOfMemory,
 Title:      fmt.Sprintf("Notification %d", i),
 Actions:    json.RawMessage("[]"),
 Content:    fmt.Sprintf("Content of the notif %d", i),
 CreatedAt:  dbtime.Now(),
 })
 }

 notifs, err = client.ListInboxNotifications(ctx, codersdk.ListInboxNotificationsRequest{})
 require.NoError(t, err)
 require.NotNil(t, notifs)
 require.Equal(t, 20, notifs.UnreadCount)
 require.Len(t, notifs.Notifications, 20)

 err = client.MarkAllInboxNotificationsAsRead(ctx)
 require.NoError(t, err)

 notifs, err = client.ListInboxNotifications(ctx, codersdk.ListInboxNotificationsRequest{})
 require.NoError(t, err)
 require.NotNil(t, notifs)
 require.Equal(t, 0, notifs.UnreadCount)
 require.Len(t, notifs.Notifications, 20)

 for i := range 10 {
 dbgen.NotificationInbox(t, api.Database, database.InsertInboxNotificationParams{
 ID:         uuid.New(),
 UserID:     member.ID,
 TemplateID: notifications.TemplateWorkspaceOutOfMemory,
 Title:      fmt.Sprintf("Notification %d", i),
 Actions:    json.RawMessage("[]"),
 Content:    fmt.Sprintf("Content of the notif %d", i),
 CreatedAt:  dbtime.Now(),
 })
 }

 notifs, err = client.ListInboxNotifications(ctx, codersdk.ListInboxNotificationsRequest{})
 require.NoError(t, err)
 require.NotNil(t, notifs)
 require.Equal(t, 10, notifs.UnreadCount)
 require.Len(t, notifs.Notifications, 25)
 })
 }
diff --git a/codersdk/inboxnotification.go b/codersdk/inboxnotification.go
 var resp UpdateInboxNotificationReadStatusResponse
 return resp, json.NewDecoder(res.Body).Decode(&resp)
 }

 func (c *Client) MarkAllInboxNotificationsAsRead(ctx context.Context) error {
 res, err := c.Request(
 ctx, http.MethodPut,
 "/api/v2/notifications/inbox/mark-all-as-read",
 nil,
 )
 if err != nil {
 return err
 }
 defer res.Body.Close()

 if res.StatusCode != http.StatusNoContent {
 return ReadBodyAsError(res)
 }

 return nil
 }
diff --git a/docs/reference/api/notifications.md b/docs/reference/api/notifications.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1389,6 +1389,7 @@ func New(options Options) API {
		r.Use(apiKeyMiddleware)
		r.Route("/inbox", func(r chi.Router) {
		r.Get("/", api.listInboxNotifications)
		r.Put("/mark-all-as-read", api.markAllInboxNotificationsAsRead)
defelmnq marked this conversation as resolved. Show resolvedHide resolved
		r.Get("/watch", api.watchInboxNotifications)
		r.Put("/{id}/read-status", api.updateInboxNotificationReadStatus)
		})
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3554,6 +3554,16 @@ func (q *querier) ListWorkspaceAgentPortShares(ctx context.Context, workspaceID
		return q.db.ListWorkspaceAgentPortShares(ctx, workspaceID)
		}

		func (q *querier) MarkAllInboxNotificationsAsRead(ctx context.Context, arg database.MarkAllInboxNotificationsAsReadParams) error {
		resource := rbac.ResourceInboxNotification.WithOwner(arg.UserID.String())

		if err := q.authorizeContext(ctx, policy.ActionUpdate, resource); err != nil {
		return err
		}

		return q.db.MarkAllInboxNotificationsAsRead(ctx, arg)
		}

		func (q *querier) OIDCClaimFieldValues(ctx context.Context, args database.OIDCClaimFieldValuesParams) ([]string, error) {
		resource := rbac.ResourceIdpsyncSettings
		if args.OrganizationID != uuid.Nil {
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4640,6 +4640,15 @@ func (s *MethodTestSuite) TestNotifications() {
		ReadAt: sql.NullTime{Time: readAt, Valid: true},
		}).Asserts(rbac.ResourceInboxNotification.WithID(notifID).WithOwner(u.ID.String()), policy.ActionUpdate)
		}))

		s.Run("MarkAllInboxNotificationsAsRead", s.Subtest(func(db database.Store, check *expects) {
		u := dbgen.User(s.T(), db, database.User{})

		check.Args(database.MarkAllInboxNotificationsAsReadParams{
		UserID: u.ID,
		ReadAt: sql.NullTime{Time: dbtestutil.NowInDefaultTimezone(), Valid: true},
		}).Asserts(rbac.ResourceInboxNotification.WithOwner(u.ID.String()), policy.ActionUpdate)
		}))
		}

		func (s *MethodTestSuite) TestOAuth2ProviderApps() {
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9498,6 +9498,21 @@ func (q *FakeQuerier) ListWorkspaceAgentPortShares(_ context.Context, workspaceI
		return shares, nil
		}

		func (q *FakeQuerier) MarkAllInboxNotificationsAsRead(_ context.Context, arg database.MarkAllInboxNotificationsAsReadParams) error {
defelmnq marked this conversation as resolved. Show resolvedHide resolved
		err := validateDatabaseType(arg)
		if err != nil {
		return err
		}

		for idx, notif := range q.inboxNotifications {
		if notif.UserID == arg.UserID && !notif.ReadAt.Valid {
		q.inboxNotifications[idx].ReadAt = arg.ReadAt
		}
		}

		return nil
		}

		// nolint:forcetypeassert
		func (q *FakeQuerier) OIDCClaimFieldValues(_ context.Context, args database.OIDCClaimFieldValuesParams) ([]string, error) {
		orgMembers := q.getOrganizationMemberNoLock(args.OrganizationID)
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -57,3 +57,11 @@ SET
		read_at = $1
		WHERE
		id = $2;

		-- name: MarkAllInboxNotificationsAsRead :exec
		UPDATE
		inbox_notifications
		SET
		read_at = $1
		WHERE
		user_id = $2 and read_at IS NULL;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -345,3 +345,31 @@ func (api API) updateInboxNotificationReadStatus(rw http.ResponseWriter, r htt
		UnreadCount: int(unreadCount),
		})
		}

		// markAllInboxNotificationsAsRead marks as read all unread notifications for authenticated user.
		// @Summary Mark all unread notifications as read
		// @ID mark-all-unread-notifications-as-read
		// @Security CoderSessionToken
		// @Tags Notifications
		// @Success 204
		// @Router /notifications/inbox/mark-all-as-read [put]
		func (api API) markAllInboxNotificationsAsRead(rw http.ResponseWriter, r http.Request) {
		var (
		ctx = r.Context()
		apikey = httpmw.APIKey(r)
		)

		err := api.Database.MarkAllInboxNotificationsAsRead(ctx, database.MarkAllInboxNotificationsAsReadParams{
		UserID: apikey.UserID,
		ReadAt: sql.NullTime{Time: dbtime.Now(), Valid: true},
		})
		if err != nil {
		api.Logger.Error(ctx, "failed to mark all unread notifications as read", slog.Error(err))
		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
		Message: "Failed to mark all unread notifications as read.",
		})
		return
		}

		rw.WriteHeader(http.StatusNoContent)
		}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -37,6 +37,7 @@ func TestInboxNotification_Watch(t *testing.T) {
		// I skip these tests specifically on windows as for now they are flaky - only on Windows.
		// For now the idea is that the runner takes too long to insert the entries, could be worth
		// investigating a manual Tx.
		// see: https://github.com/coder/internal/issues/503
		if runtime.GOOS == "windows" {
		t.Skip("our runners are randomly taking too long to insert entries")
		}
Expand DownExpand Up		@@ -305,6 +306,7 @@ func TestInboxNotifications_List(t *testing.T) {
		// I skip these tests specifically on windows as for now they are flaky - only on Windows.
		// For now the idea is that the runner takes too long to insert the entries, could be worth
		// investigating a manual Tx.
		// see: https://github.com/coder/internal/issues/503
		if runtime.GOOS == "windows" {
		t.Skip("our runners are randomly taking too long to insert entries")
		}
Expand DownExpand Up		@@ -588,6 +590,7 @@ func TestInboxNotifications_ReadStatus(t *testing.T) {
		// I skip these tests specifically on windows as for now they are flaky - only on Windows.
		// For now the idea is that the runner takes too long to insert the entries, could be worth
		// investigating a manual Tx.
		// see: https://github.com/coder/internal/issues/503
		if runtime.GOOS == "windows" {
		t.Skip("our runners are randomly taking too long to insert entries")
		}
Expand DownExpand Up		@@ -723,3 +726,76 @@ func TestInboxNotifications_ReadStatus(t *testing.T) {
		require.Empty(t, updatedNotif.Notification)
		})
		}

		func TestInboxNotifications_MarkAllAsRead(t *testing.T) {
		t.Parallel()

		// I skip these tests specifically on windows as for now they are flaky - only on Windows.
		// For now the idea is that the runner takes too long to insert the entries, could be worth
		// investigating a manual Tx.
		// see: https://github.com/coder/internal/issues/503
		if runtime.GOOS == "windows" {
		t.Skip("our runners are randomly taking too long to insert entries")
		}

		t.Run("ok", func(t *testing.T) {
defelmnq marked this conversation as resolved. Show resolvedHide resolved
		t.Parallel()
		client, _, api := coderdtest.NewWithAPI(t, &coderdtest.Options{})
		firstUser := coderdtest.CreateFirstUser(t, client)
		client, member := coderdtest.CreateAnotherUser(t, client, firstUser.OrganizationID)

		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
		defer cancel()

		notifs, err := client.ListInboxNotifications(ctx, codersdk.ListInboxNotificationsRequest{})
		require.NoError(t, err)
		require.NotNil(t, notifs)
		require.Equal(t, 0, notifs.UnreadCount)
		require.Empty(t, notifs.Notifications)

		for i := range 20 {
		dbgen.NotificationInbox(t, api.Database, database.InsertInboxNotificationParams{
		ID: uuid.New(),
		UserID: member.ID,
		TemplateID: notifications.TemplateWorkspaceOutOfMemory,
		Title: fmt.Sprintf("Notification %d", i),
		Actions: json.RawMessage("[]"),
		Content: fmt.Sprintf("Content of the notif %d", i),
		CreatedAt: dbtime.Now(),
		})
		}

		notifs, err = client.ListInboxNotifications(ctx, codersdk.ListInboxNotificationsRequest{})
		require.NoError(t, err)
		require.NotNil(t, notifs)
		require.Equal(t, 20, notifs.UnreadCount)
		require.Len(t, notifs.Notifications, 20)

		err = client.MarkAllInboxNotificationsAsRead(ctx)
		require.NoError(t, err)

		notifs, err = client.ListInboxNotifications(ctx, codersdk.ListInboxNotificationsRequest{})
		require.NoError(t, err)
		require.NotNil(t, notifs)
		require.Equal(t, 0, notifs.UnreadCount)
		require.Len(t, notifs.Notifications, 20)

		for i := range 10 {
		dbgen.NotificationInbox(t, api.Database, database.InsertInboxNotificationParams{
		ID: uuid.New(),
		UserID: member.ID,
		TemplateID: notifications.TemplateWorkspaceOutOfMemory,
		Title: fmt.Sprintf("Notification %d", i),
		Actions: json.RawMessage("[]"),
		Content: fmt.Sprintf("Content of the notif %d", i),
		CreatedAt: dbtime.Now(),
		})
		}

		notifs, err = client.ListInboxNotifications(ctx, codersdk.ListInboxNotificationsRequest{})
		require.NoError(t, err)
		require.NotNil(t, notifs)
		require.Equal(t, 10, notifs.UnreadCount)
		require.Len(t, notifs.Notifications, 25)
		})
		}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -109,3 +109,21 @@ func (c *Client) UpdateInboxNotificationReadStatus(ctx context.Context, notifID
		var resp UpdateInboxNotificationReadStatusResponse
		return resp, json.NewDecoder(res.Body).Decode(&resp)
		}

		func (c *Client) MarkAllInboxNotificationsAsRead(ctx context.Context) error {
		res, err := c.Request(
		ctx, http.MethodPut,
		"/api/v2/notifications/inbox/mark-all-as-read",
		nil,
		)
		if err != nil {
		return err
		}
		defer res.Body.Close()

		if res.StatusCode != http.StatusNoContent {
		return ReadBodyAsError(res)
		}

		return nil
		}