feat: implement mark all notification as read API (#2762)

Author: hvn2k1

pkg/notification/api/api.go

@@ -302,7 +302,21 @@ func (s *NotificationService) MarkAllNotificationsAsRead(
 	ctx context.Context,
 	req *proto.MarkAllNotificationsAsReadRequest,
 ) (*proto.MarkAllNotificationsAsReadResponse, error) {
-	return nil, statusNotImplemented
+	t, err := s.checkAuthenticated(ctx)
+	if err != nil {
+		return nil, err
+	}
+	err = s.dbClient.RunInTransactionV2(ctx, func(ctxWithTx context.Context) error {
+		return s.notificationStorage.MarkAllNotificationsAsRead(ctxWithTx, t.Email, time.Now().Unix())
+	})
+	if err != nil {
+		s.logger.Error(
+			"Failed to mark all notifications as read",
+			log.FieldsFromIncomingContext(ctx).AddFields(zap.Error(err))...,
+		)
+		return nil, api.NewGRPCStatus(err).Err()
+	}
+	return &proto.MarkAllNotificationsAsReadResponse{}, nil
 }
 
 func (s *NotificationService) ListDraftAdminNotifications(

pkg/notification/api/api_test.go

@@ -1329,3 +1329,65 @@ func TestNotificationService_GetNotificationUnreadCount(t *testing.T) {
 		})
 	}
 }
+
+func TestNotificationService_MarkAllNotificationsAsRead(t *testing.T) {
+	t.Parallel()
+	mockController := gomock.NewController(t)
+	defer mockController.Finish()
+
+	viewerCtx := metadata.NewIncomingContext(
+		createContextWithToken(t, false),
+		metadata.MD{"accept-language": []string{"en"}},
+	)
+
+	patterns := []struct {
+		desc        string
+		ctx         context.Context
+		setup       func(*NotificationService)
+		expectedErr error
+	}{
+		{
+			desc:        "err: unauthenticated",
+			ctx:         context.TODO(),
+			expectedErr: statusUnauthenticated.Err(),
+		},
+		{
+			desc: "err: internal",
+			ctx:  viewerCtx,
+			setup: func(s *NotificationService) {
+				s.dbClient.(*databasemock.MockClient).EXPECT().RunInTransactionV2(
+					gomock.Any(), gomock.Any(),
+				).Return(errors.New("error"))
+			},
+			expectedErr: api.NewGRPCStatus(errors.New("error")).Err(),
+		},
+		{
+			desc: "success",
+			ctx:  viewerCtx,
+			setup: func(s *NotificationService) {
+				s.dbClient.(*databasemock.MockClient).EXPECT().RunInTransactionV2(
+					gomock.Any(), gomock.Any(),
+				).DoAndReturn(func(ctx context.Context, fn func(ctx context.Context) error) error {
+					return fn(ctx)
+				})
+				s.notificationStorage.(*notificationstoragemock.MockNotificationStorage).EXPECT().MarkAllNotificationsAsRead(
+					gomock.Any(), "email", gomock.Any(),
+				).Return(nil)
+			},
+			expectedErr: nil,
+		},
+	}
+	for _, p := range patterns {
+		t.Run(p.desc, func(t *testing.T) {
+			s := createNotificationService(mockController)
+			if p.setup != nil {
+				p.setup(s)
+			}
+			resp, err := s.MarkAllNotificationsAsRead(p.ctx, &proto.MarkAllNotificationsAsReadRequest{})
+			assert.Equal(t, p.expectedErr, err)
+			if p.expectedErr == nil {
+				assert.NotNil(t, resp)
+			}
+		})
+	}
+}

pkg/notification/api/error.go

@@ -15,15 +15,10 @@
 package api
 
 import (
-	"google.golang.org/grpc/codes"
-	gstatus "google.golang.org/grpc/status"
-
 	"github.com/bucketeer-io/bucketeer/v2/pkg/api/api"
 	bkterr "github.com/bucketeer-io/bucketeer/v2/pkg/error"
 )
 
-var statusNotImplemented = gstatus.Error(codes.Unimplemented, "notification: not implemented")
-
 var (
 	statusUnauthenticated = api.NewGRPCStatus(
 		bkterr.NewErrorUnauthenticated(bkterr.NotificationPackageName, "unauthenticated"))

pkg/notification/storage/mock/notification.go

@@ -59,6 +59,8 @@ var (
 	insertNotificationReadSQL string
 	//go:embed sql/count_unread_notifications.sql
 	countUnreadNotificationsSQL string
+	//go:embed sql/insert_all_notification_reads.sql
+	insertAllNotificationReadsSQL string
 )
 
 // readNotificationExistsSubquery correlates a viewer's read marker with the
@@ -560,6 +562,23 @@ func (s *notificationStorage) MarkNotificationsAsRead(
 	return nil
 }
 
+// MarkAllNotificationsAsRead upserts read markers for every published
+// notification for the viewer.
+func (s *notificationStorage) MarkAllNotificationsAsRead(
+	ctx context.Context,
+	email string,
+	readAt int64,
+) error {
+	_, err := s.qe.ExecContext(
+		ctx,
+		insertAllNotificationReadsSQL,
+		email,
+		readAt,
+		int32(proto.Notification_PUBLISHED),
+	)
+	return err
+}
+
 // GetNotificationUnreadCount counts the published notifications the viewer
 // has not read, limited to notifications published after the viewer's
 // account was created.

pkg/notification/storage/mysql/notification.go

@@ -1144,3 +1144,48 @@ func TestGetNotificationUnreadCount(t *testing.T) {
 		})
 	}
 }
+
+func TestMarkAllNotificationsAsRead(t *testing.T) {
+	t.Parallel()
+	mockController := gomock.NewController(t)
+	defer mockController.Finish()
+
+	patterns := []struct {
+		desc        string
+		setup       func(*notificationStorage)
+		expectedErr error
+	}{
+		{
+			desc: "Error",
+			setup: func(s *notificationStorage) {
+				s.qe.(*mock.MockQueryExecer).EXPECT().ExecContext(
+					gomock.Any(), gomock.Any(), gomock.Any(),
+				).Return(nil, errors.New("error"))
+			},
+			expectedErr: errors.New("error"),
+		},
+		{
+			desc: "Success",
+			setup: func(s *notificationStorage) {
+				s.qe.(*mock.MockQueryExecer).EXPECT().ExecContext(
+					gomock.Any(),
+					insertAllNotificationReadsSQL,
+					"viewer@example.com",
+					int64(5),
+					int32(proto.Notification_PUBLISHED),
+				).Return(nil, nil)
+			},
+			expectedErr: nil,
+		},
+	}
+	for _, p := range patterns {
+		t.Run(p.desc, func(t *testing.T) {
+			storage := &notificationStorage{qe: mock.NewMockQueryExecer(mockController)}
+			if p.setup != nil {
+				p.setup(storage)
+			}
+			err := storage.MarkAllNotificationsAsRead(context.Background(), "viewer@example.com", 5)
+			assert.Equal(t, p.expectedErr, err)
+		})
+	}
+}

pkg/notification/storage/mysql/notification_test.go

@@ -0,0 +1,14 @@
+INSERT IGNORE INTO notification_read (
+    notification_id,
+    email,
+    read_at
+)
+SELECT
+    id,
+    ?,
+    ?
+FROM
+    notification
+WHERE
+    status = ? AND
+    deleted = false

pkg/notification/storage/mysql/sql/insert_all_notification_reads.sql

@@ -83,6 +83,10 @@ type NotificationStorage interface {
 	// viewer has not read, limited to notifications published after the
 	// viewer's account was created.
 	GetNotificationUnreadCount(ctx context.Context, email string) (int64, error)
+	// MarkAllNotificationsAsRead upserts read markers for every published
+	// notification for the viewer. Idempotent: already-read notifications
+	// keep their original read_at.
+	MarkAllNotificationsAsRead(ctx context.Context, email string, readAt int64) error
 }
 
 type ListDraftAdminNotificationsParams struct {

pkg/notification/storage/notification.go

@@ -60,6 +60,8 @@ var (
 	insertNotificationReadSQL string
 	//go:embed sql/count_unread_notifications.sql
 	countUnreadNotificationsSQL string
+	//go:embed sql/insert_all_notification_reads.sql
+	insertAllNotificationReadsSQL string
 )
 
 // readNotificationExistsSubquery correlates a viewer's read marker with the
@@ -565,6 +567,23 @@ func (s *notificationStorage) MarkNotificationsAsRead(
 	return nil
 }
 
+// MarkAllNotificationsAsRead upserts read markers for every published
+// notification for the viewer.
+func (s *notificationStorage) MarkAllNotificationsAsRead(
+	ctx context.Context,
+	email string,
+	readAt int64,
+) error {
+	_, err := s.qe.ExecContext(
+		ctx,
+		insertAllNotificationReadsSQL,
+		email,
+		readAt,
+		int32(proto.Notification_PUBLISHED),
+	)
+	return err
+}
+
 // GetNotificationUnreadCount counts the published notifications the viewer
 // has not read, limited to notifications published after the viewer's
 // account was created.

pkg/notification/storage/postgres/notification.go

@@ -1174,3 +1174,48 @@ func TestGetNotificationUnreadCount(t *testing.T) {
 		})
 	}
 }
+
+func TestMarkAllNotificationsAsRead(t *testing.T) {
+	t.Parallel()
+	mockController := gomock.NewController(t)
+	defer mockController.Finish()
+
+	patterns := []struct {
+		desc        string
+		setup       func(*notificationStorage)
+		expectedErr error
+	}{
+		{
+			desc: "Error",
+			setup: func(s *notificationStorage) {
+				s.qe.(*mock.MockQueryExecer).EXPECT().ExecContext(
+					gomock.Any(), gomock.Any(), gomock.Any(),
+				).Return(nil, errors.New("error"))
+			},
+			expectedErr: errors.New("error"),
+		},
+		{
+			desc: "Success",
+			setup: func(s *notificationStorage) {
+				s.qe.(*mock.MockQueryExecer).EXPECT().ExecContext(
+					gomock.Any(),
+					insertAllNotificationReadsSQL,
+					"viewer@example.com",
+					int64(5),
+					int32(proto.Notification_PUBLISHED),
+				).Return(nil, nil)
+			},
+			expectedErr: nil,
+		},
+	}
+	for _, p := range patterns {
+		t.Run(p.desc, func(t *testing.T) {
+			storage := &notificationStorage{qe: mock.NewMockQueryExecer(mockController)}
+			if p.setup != nil {
+				p.setup(storage)
+			}
+			err := storage.MarkAllNotificationsAsRead(context.Background(), "viewer@example.com", 5)
+			assert.Equal(t, p.expectedErr, err)
+		})
+	}
+}