add format logic into watch endpoint

defelmnq · defelmnq · commit 63ffa9b1c6a5 · 2025-03-21T14:21:03.000Z
diff --git a/coderd/inboxnotifications.go b/coderd/inboxnotifications.go
@@ -17,11 +17,17 @@ import (
 	"github.com/coder/coder/v2/coderd/httpapi"
 	"github.com/coder/coder/v2/coderd/httpmw"
 	"github.com/coder/coder/v2/coderd/pubsub"
+	markdown "github.com/coder/coder/v2/coderd/render"
 	"github.com/coder/coder/v2/codersdk"
 	"github.com/coder/coder/v2/codersdk/wsjson"
 	"github.com/coder/websocket"
 )
 
+const (
+	notificationFormatMarkdown  = "markdown"
+	notificationFormatPlaintext = "plaintext"
+)
+
 // convertInboxNotificationResponse works as a util function to transform a database.InboxNotification to codersdk.InboxNotification
 func convertInboxNotificationResponse(ctx context.Context, logger slog.Logger, notif database.InboxNotification) codersdk.InboxNotification {
 	return codersdk.InboxNotification{
@@ -60,6 +66,7 @@ func convertInboxNotificationResponse(ctx context.Context, logger slog.Logger, n
 // @Param targets query string false "Comma-separated list of target IDs to filter notifications"
 // @Param templates query string false "Comma-separated list of template IDs to filter notifications"
 // @Param read_status query string false "Filter notifications by read status. Possible values: read, unread, all"
+// @Param format query string false "Define the output format for notifications title and body. Possible values: plaintext, markdown"
 // @Success 200 {object} codersdk.GetInboxNotificationResponse
 // @Router /notifications/inbox/watch [get]
 func (api *API) watchInboxNotifications(rw http.ResponseWriter, r *http.Request) {
@@ -73,6 +80,7 @@ func (api *API) watchInboxNotifications(rw http.ResponseWriter, r *http.Request)
 		targets    = p.UUIDs(vals, []uuid.UUID{}, "targets")
 		templates  = p.UUIDs(vals, []uuid.UUID{}, "templates")
 		readStatus = p.String(vals, "all", "read_status")
+		format     = p.String(vals, notificationFormatMarkdown, "format")
 	)
 	p.ErrorExcessParams(vals)
 	if len(p.Errors) > 0 {
@@ -176,6 +184,23 @@ func (api *API) watchInboxNotifications(rw http.ResponseWriter, r *http.Request)
 				api.Logger.Error(ctx, "failed to count unread inbox notifications", slog.Error(err))
 				return
 			}
+
+			// By default, notifications are stored as markdown
+			// We can change the format based on parameter if required
+			if format == notificationFormatPlaintext {
+				notif.Title, err = markdown.PlaintextFromMarkdown(notif.Title)
+				if err != nil {
+					api.Logger.Error(ctx, "failed to convert notification title to plain text", slog.Error(err))
+					return
+				}
+
+				notif.Content, err = markdown.PlaintextFromMarkdown(notif.Content)
+				if err != nil {
+					api.Logger.Error(ctx, "failed to convert notification content to plain text", slog.Error(err))
+					return
+				}
+			}
+
 			if err := encoder.Encode(codersdk.GetInboxNotificationResponse{
 				Notification: notif,
 				UnreadCount:  int(unreadCount),
diff --git a/coderd/inboxnotifications_test.go b/coderd/inboxnotifications_test.go
@@ -137,6 +137,62 @@ func TestInboxNotification_Watch(t *testing.T) {
 		require.Equal(t, memberClient.ID, notif.Notification.UserID)
 	})
 
+	t.Run("OK - change format", func(t *testing.T) {
+		t.Parallel()
+
+		ctx := testutil.Context(t, testutil.WaitLong)
+		logger := testutil.Logger(t)
+
+		db, ps := dbtestutil.NewDB(t)
+
+		firstClient, _, _ := coderdtest.NewWithAPI(t, &coderdtest.Options{
+			Pubsub:   ps,
+			Database: db,
+		})
+		firstUser := coderdtest.CreateFirstUser(t, firstClient)
+		member, memberClient := coderdtest.CreateAnotherUser(t, firstClient, firstUser.OrganizationID, rbac.RoleTemplateAdmin())
+
+		u, err := member.URL.Parse("/api/v2/notifications/inbox/watch?format=plaintext")
+		require.NoError(t, err)
+
+		// nolint:bodyclose
+		wsConn, resp, err := websocket.Dial(ctx, u.String(), &websocket.DialOptions{
+			HTTPHeader: http.Header{
+				"Coder-Session-Token": []string{member.SessionToken()},
+			},
+		})
+		if err != nil {
+			if resp.StatusCode != http.StatusSwitchingProtocols {
+				err = codersdk.ReadBodyAsError(resp)
+			}
+			require.NoError(t, err)
+		}
+		defer wsConn.Close(websocket.StatusNormalClosure, "done")
+
+		inboxHandler := dispatch.NewInboxHandler(logger, db, ps)
+		dispatchFunc, err := inboxHandler.Dispatcher(types.MessagePayload{
+			UserID:                 memberClient.ID.String(),
+			NotificationTemplateID: notifications.TemplateWorkspaceOutOfMemory.String(),
+		}, "# Notification Title", "This is the __content__.", nil)
+		require.NoError(t, err)
+
+		_, err = dispatchFunc(ctx, uuid.New())
+		require.NoError(t, err)
+
+		_, message, err := wsConn.Read(ctx)
+		require.NoError(t, err)
+
+		var notif codersdk.GetInboxNotificationResponse
+		err = json.Unmarshal(message, &notif)
+		require.NoError(t, err)
+
+		require.Equal(t, 1, notif.UnreadCount)
+		require.Equal(t, memberClient.ID, notif.Notification.UserID)
+
+		require.Equal(t, "Notification Title", notif.Notification.Title)
+		require.Equal(t, "This is the content.", notif.Notification.Content)
+	})
+
 	t.Run("OK - filters on templates", func(t *testing.T) {
 		t.Parallel()
 
