MM-56083 Add PatchMultipleMembersNotifyProps plugin API (#25690)

* Add ChannelStore.UpdateMultipleMembersNotifyProps

* Make UpdateMultipleMembersNotifyProps return updated values from the DB

* Add UpdateChannelMembersNotifications plugin API

* Extract i18n

* Fix style

* Make layers

* Change to PatchMultipleMembersNotifyProps

* Add limit to PatchChannelMembersNotifyProps

* Add additional unit tests

* Address feedback

* Lowercase decodeJSON

* Have PatchMultipleMembersNotifyProps update LastUpdateAt

* Fix tests that relied on unreliable return order

* Fix i18n

server/public/model/channel_member.go

@@ -4,6 +4,7 @@
 package model
 
 import (
+	"fmt"
 	"net/http"
 	"strings"
 	"unicode/utf8"
@@ -116,38 +117,8 @@ func (o *ChannelMember) IsValid() *AppError {
 		return NewAppError("ChannelMember.IsValid", "model.channel_member.is_valid.user_id.app_error", nil, "", http.StatusBadRequest)
 	}
 
-	notifyLevel := o.NotifyProps[DesktopNotifyProp]
-	if len(notifyLevel) > 20 || !IsChannelNotifyLevelValid(notifyLevel) {
-		return NewAppError("ChannelMember.IsValid", "model.channel_member.is_valid.notify_level.app_error", nil, "notify_level="+notifyLevel, http.StatusBadRequest)
-	}
-
-	markUnreadLevel := o.NotifyProps[MarkUnreadNotifyProp]
-	if len(markUnreadLevel) > 20 || !IsChannelMarkUnreadLevelValid(markUnreadLevel) {
-		return NewAppError("ChannelMember.IsValid", "model.channel_member.is_valid.unread_level.app_error", nil, "mark_unread_level="+markUnreadLevel, http.StatusBadRequest)
-	}
-
-	if pushLevel, ok := o.NotifyProps[PushNotifyProp]; ok {
-		if len(pushLevel) > 20 || !IsChannelNotifyLevelValid(pushLevel) {
-			return NewAppError("ChannelMember.IsValid", "model.channel_member.is_valid.push_level.app_error", nil, "push_notification_level="+pushLevel, http.StatusBadRequest)
-		}
-	}
-
-	if sendEmail, ok := o.NotifyProps[EmailNotifyProp]; ok {
-		if len(sendEmail) > 20 || !IsSendEmailValid(sendEmail) {
-			return NewAppError("ChannelMember.IsValid", "model.channel_member.is_valid.email_value.app_error", nil, "push_notification_level="+sendEmail, http.StatusBadRequest)
-		}
-	}
-
-	if ignoreChannelMentions, ok := o.NotifyProps[IgnoreChannelMentionsNotifyProp]; ok {
-		if len(ignoreChannelMentions) > 40 || !IsIgnoreChannelMentionsValid(ignoreChannelMentions) {
-			return NewAppError("ChannelMember.IsValid", "model.channel_member.is_valid.ignore_channel_mentions_value.app_error", nil, "ignore_channel_mentions="+ignoreChannelMentions, http.StatusBadRequest)
-		}
-	}
-
-	if channelAutoFollowThreads, ok := o.NotifyProps[ChannelAutoFollowThreads]; ok {
-		if len(channelAutoFollowThreads) > 3 || !IsChannelAutoFollowThreadsValid(channelAutoFollowThreads) {
-			return NewAppError("ChannelMember.IsValid", "model.channel_member.is_valid.channel_auto_follow_threads_value.app_error", nil, "channel_auto_follow_threads="+channelAutoFollowThreads, http.StatusBadRequest)
-		}
+	if appErr := IsChannelMemberNotifyPropsValid(o.NotifyProps, false); appErr != nil {
+		return appErr
 	}
 
 	if len(o.Roles) > UserRolesMaxLength {
@@ -155,9 +126,49 @@ func (o *ChannelMember) IsValid() *AppError {
 			map[string]any{"Limit": UserRolesMaxLength}, "", http.StatusBadRequest)
 	}
 
-	jsonStringNotifyProps := string(ToJSON(o.NotifyProps))
+	return nil
+}
+
+func IsChannelMemberNotifyPropsValid(notifyProps map[string]string, allowMissingFields bool) *AppError {
+	if notifyLevel, ok := notifyProps[DesktopNotifyProp]; ok || !allowMissingFields {
+		if len(notifyLevel) > 20 || !IsChannelNotifyLevelValid(notifyLevel) {
+			return NewAppError("ChannelMember.IsValid", "model.channel_member.is_valid.notify_level.app_error", nil, "notify_level="+notifyLevel, http.StatusBadRequest)
+		}
+	}
+
+	if markUnreadLevel, ok := notifyProps[MarkUnreadNotifyProp]; ok || !allowMissingFields {
+		if len(markUnreadLevel) > 20 || !IsChannelMarkUnreadLevelValid(markUnreadLevel) {
+			return NewAppError("ChannelMember.IsValid", "model.channel_member.is_valid.unread_level.app_error", nil, "mark_unread_level="+markUnreadLevel, http.StatusBadRequest)
+		}
+	}
+
+	if pushLevel, ok := notifyProps[PushNotifyProp]; ok {
+		if len(pushLevel) > 20 || !IsChannelNotifyLevelValid(pushLevel) {
+			return NewAppError("ChannelMember.IsValid", "model.channel_member.is_valid.push_level.app_error", nil, "push_notification_level="+pushLevel, http.StatusBadRequest)
+		}
+	}
+
+	if sendEmail, ok := notifyProps[EmailNotifyProp]; ok {
+		if len(sendEmail) > 20 || !IsSendEmailValid(sendEmail) {
+			return NewAppError("ChannelMember.IsValid", "model.channel_member.is_valid.email_value.app_error", nil, "push_notification_level="+sendEmail, http.StatusBadRequest)
+		}
+	}
+
+	if ignoreChannelMentions, ok := notifyProps[IgnoreChannelMentionsNotifyProp]; ok {
+		if len(ignoreChannelMentions) > 40 || !IsIgnoreChannelMentionsValid(ignoreChannelMentions) {
+			return NewAppError("ChannelMember.IsValid", "model.channel_member.is_valid.ignore_channel_mentions_value.app_error", nil, "ignore_channel_mentions="+ignoreChannelMentions, http.StatusBadRequest)
+		}
+	}
+
+	if channelAutoFollowThreads, ok := notifyProps[ChannelAutoFollowThreads]; ok {
+		if len(channelAutoFollowThreads) > 3 || !IsChannelAutoFollowThreadsValid(channelAutoFollowThreads) {
+			return NewAppError("ChannelMember.IsValid", "model.channel_member.is_valid.channel_auto_follow_threads_value.app_error", nil, "channel_auto_follow_threads="+channelAutoFollowThreads, http.StatusBadRequest)
+		}
+	}
+
+	jsonStringNotifyProps := string(ToJSON(notifyProps))
 	if utf8.RuneCountInString(jsonStringNotifyProps) > ChannelMemberNotifyPropsMaxRunes {
-		return NewAppError("ChannelMember.IsValid", "model.channel_member.is_valid.notify_props.app_error", nil, "channel_id="+o.ChannelId+" user_id="+o.UserId, http.StatusBadRequest)
+		return NewAppError("ChannelMember.IsValid", "model.channel_member.is_valid.notify_props.app_error", nil, fmt.Sprint("length=", utf8.RuneCountInString(jsonStringNotifyProps)), http.StatusBadRequest)
 	}
 
 	return nil
@@ -220,3 +231,8 @@ func GetDefaultChannelNotifyProps() StringMap {
 		ChannelAutoFollowThreads:        ChannelAutoFollowThreadsOff,
 	}
 }
+
+type ChannelMemberIdentifier struct {
+	ChannelId string `json:"channel_id"`
+	UserId    string `json:"user_id"`
+}

server/public/model/channel_member_test.go

@@ -7,6 +7,7 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
@@ -18,8 +19,11 @@ func TestChannelMemberIsValid(t *testing.T) {
 	o.ChannelId = NewId()
 	require.NotNil(t, o.IsValid(), "should be invalid")
 
-	o.NotifyProps = GetDefaultChannelNotifyProps()
 	o.UserId = NewId()
+	require.NotNil(t, o.IsValid(), "should be invalid because of missing notify props")
+
+	o.NotifyProps = GetDefaultChannelNotifyProps()
+	require.Nil(t, o.IsValid(), "should be valid")
 
 	o.NotifyProps["desktop"] = "junk"
 	require.NotNil(t, o.IsValid(), "should be invalid")
@@ -42,3 +46,15 @@ func TestChannelMemberIsValid(t *testing.T) {
 	o.NotifyProps["property"] = strings.Repeat("Z", ChannelMemberNotifyPropsMaxRunes)
 	require.NotNil(t, o.IsValid(), "should be invalid")
 }
+
+func TestIsChannelMemberNotifyPropsValid(t *testing.T) {
+	t.Run("should require certain fields unless allowMissingFields is true", func(t *testing.T) {
+		notifyProps := map[string]string{}
+
+		err := IsChannelMemberNotifyPropsValid(notifyProps, false)
+		assert.NotNil(t, err)
+
+		err = IsChannelMemberNotifyPropsValid(notifyProps, true)
+		assert.Nil(t, err)
+	})
+}

server/public/plugin/api.go

@@ -600,6 +600,15 @@ type API interface {
 	// Minimum server version: 5.2
 	UpdateChannelMemberNotifications(channelId, userID string, notifications map[string]string) (*model.ChannelMember, *model.AppError)
 
+	// PatchChannelMembersNotifications updates the notification properties for multiple channel members.
+	// Other changes made to the channel memberships will be ignored. A maximum of 200 members can be
+	// updated at once.
+	//
+	// @tag Channel
+	// @tag User
+	// Minimum server version: 9.5
+	PatchChannelMembersNotifications(members []*model.ChannelMemberIdentifier, notifyProps map[string]string) *model.AppError
+
 	// GetGroup gets a group by ID.
 	//
 	// @tag Group

server/public/plugin/api_timer_layer_generated.go

@@ -657,6 +657,13 @@ func (api *apiTimerLayer) UpdateChannelMemberNotifications(channelId, userID str
 	return _returnsA, _returnsB
 }
 
+func (api *apiTimerLayer) PatchChannelMembersNotifications(members []*model.ChannelMemberIdentifier, notifyProps map[string]string) *model.AppError {
+	startTime := timePkg.Now()
+	_returnsA := api.apiImpl.PatchChannelMembersNotifications(members, notifyProps)
+	api.recordTime(startTime, "PatchChannelMembersNotifications", _returnsA == nil)
+	return _returnsA
+}
+
 func (api *apiTimerLayer) GetGroup(groupId string) (*model.Group, *model.AppError) {
 	startTime := timePkg.Now()
 	_returnsA, _returnsB := api.apiImpl.GetGroup(groupId)

server/public/plugin/client_rpc_generated.go

@@ -3663,6 +3663,35 @@ func (s *apiRPCServer) UpdateChannelMemberNotifications(args *Z_UpdateChannelMem
 	return nil
 }
 
+type Z_PatchChannelMembersNotificationsArgs struct {
+	A []*model.ChannelMemberIdentifier
+	B map[string]string
+}
+
+type Z_PatchChannelMembersNotificationsReturns struct {
+	A *model.AppError
+}
+
+func (g *apiRPCClient) PatchChannelMembersNotifications(members []*model.ChannelMemberIdentifier, notifyProps map[string]string) *model.AppError {
+	_args := &Z_PatchChannelMembersNotificationsArgs{members, notifyProps}
+	_returns := &Z_PatchChannelMembersNotificationsReturns{}
+	if err := g.client.Call("Plugin.PatchChannelMembersNotifications", _args, _returns); err != nil {
+		log.Printf("RPC call to PatchChannelMembersNotifications API failed: %s", err.Error())
+	}
+	return _returns.A
+}
+
+func (s *apiRPCServer) PatchChannelMembersNotifications(args *Z_PatchChannelMembersNotificationsArgs, returns *Z_PatchChannelMembersNotificationsReturns) error {
+	if hook, ok := s.impl.(interface {
+		PatchChannelMembersNotifications(members []*model.ChannelMemberIdentifier, notifyProps map[string]string) *model.AppError
+	}); ok {
+		returns.A = hook.PatchChannelMembersNotifications(args.A, args.B)
+	} else {
+		return encodableError(fmt.Errorf("API PatchChannelMembersNotifications called but not implemented."))
+	}
+	return nil
+}
+
 type Z_GetGroupArgs struct {
 	A string
 }

server/public/plugin/plugintest/api.go

@@ -3226,6 +3226,22 @@ func (_m *API) PatchBot(botUserId string, botPatch *model.BotPatch) (*model.Bot,
 	return r0, r1
 }
 
+// PatchChannelMembersNotifications provides a mock function with given fields: members, notifyProps
+func (_m *API) PatchChannelMembersNotifications(members []*model.ChannelMemberIdentifier, notifyProps map[string]string) *model.AppError {
+	ret := _m.Called(members, notifyProps)
+
+	var r0 *model.AppError
+	if rf, ok := ret.Get(0).(func([]*model.ChannelMemberIdentifier, map[string]string) *model.AppError); ok {
+		r0 = rf(members, notifyProps)
+	} else {
+		if ret.Get(0) != nil {
+			r0 = ret.Get(0).(*model.AppError)
+		}
+	}
+
+	return r0
+}
+
 // PermanentDeleteBot provides a mock function with given fields: botUserId
 func (_m *API) PermanentDeleteBot(botUserId string) *model.AppError {
 	ret := _m.Called(botUserId)