MM-54123 Add group slash command (#24553)

* adding group members to channel initial commit * adding group to channel functionality along with add new team members * fixing circular dependency * fixing e2e and other optimizations * adding e2e tests for adding group members to channels * cypress lint * fixing comments * adding count to button * improvements * adjusting some stuff from PR comments * remove ability to add user to team, update message for non-team members * remove adding to team from add groups functionality * update misspelled variable * lint and unit test fixes * add tests, cleanup * lint fix * revert package-lock.json * fixes for cypress tests * rename TeamInviteBanner to TeamWarningBanner, since invites are no longer allowed * update for warning * lint fixes * cleanup * fix failing e2e tests * update slash command for user groups * revert package-lock * remove unused function * update based on feedback * update tests for last change * i18n-extract, reorder * retrieve and display user name --------- Co-authored-by: Benjamin Cooke <benkcooke@gmail.com> Co-authored-by: Mattermost Build <build@mattermost.com>
2023-09-15 11:00:41 -06:00
--- a/server/channels/app/slashcommands/command_invite.go
+++ b/server/channels/app/slashcommands/command_invite.go
@@ -8,6 +8,7 @@ import (

 	"github.com/mattermost/mattermost/server/public/model"
 	"github.com/mattermost/mattermost/server/public/shared/i18n"
+	"github.com/mattermost/mattermost/server/public/shared/mlog"
 	"github.com/mattermost/mattermost/server/public/shared/request"
 	"github.com/mattermost/mattermost/server/v8/channels/app"
 )
@@ -19,6 +20,16 @@ const (
 	CmdInvite = "invite"
 )

+type UserError int64
+
+const (
+	NoError UserError = iota
+	UserInChannel
+	UserNotInTeam
+	IsConstrained
+	Unknown
+)
+
 func init() {
 	app.RegisterCommandProvider(&InviteProvider{})
 }
@@ -59,28 +70,138 @@ func (i *InviteProvider) doCommand(a *app.App, c request.CTX, args *model.Comman
 	// Verify that the inviter has permissions to invite users to the every channel.
 	targetChannels = i.checkPermissions(a, c, args, resps, targetUsers[0], targetChannels)

-	for _, targetUser := range targetUsers {
-		for _, targetChannel := range targetChannels {
-			if resp = i.addUserToChannel(a, c, args, targetUser, targetChannel); resp != "" {
-				*resps = append(*resps, resp)
-				continue
-			}
-			if args.ChannelId != targetChannel.Id {
-				*resps = append(*resps, args.T("api.command_invite.success", map[string]any{
-					"User":    targetUser.Username,
-					"Channel": targetChannel.Name,
-				}))
+	// track errors returned for various users.
+	differentChannels := make([]string, 0, 1)
+	nonTeamUsers := make(map[string][]string)
+	channelConstrained := make([]string, 0, 1)
+	usersInChannel := make([]string, 0, 1)
+	errorUsers := make([]string, 0, 1)
+
+	for _, targetChannel := range targetChannels {
+		var targetTeamDisplay string
+		for _, targetUser := range targetUsers {
+			userError := i.addUserToChannel(a, c, args, targetUser, targetChannel)
+			if userError == NoError {
+				if args.ChannelId != targetChannel.Id {
+					differentChannels = append(differentChannels, targetUser.Username)
+				}
+			} else if userError == UserNotInTeam {
+				if targetTeamDisplay == "" {
+					targetTeam, err := a.GetTeam(targetChannel.TeamId)
+					if err != nil {
+						targetTeamDisplay = "unknown"
+					} else {
+						targetTeamDisplay = targetTeam.DisplayName
+					}
+				}
+				nonTeamUsers[targetTeamDisplay] = append(nonTeamUsers[targetTeamDisplay], targetUser.Username)
+			} else if userError == IsConstrained {
+				channelConstrained = append(channelConstrained, targetUser.Username)
+			} else if userError == UserInChannel {
+				usersInChannel = append(usersInChannel, targetUser.Username)
+			} else {
+				errorUsers = append(errorUsers, targetUser.Username)
 			}
 		}
 	}

+	if len(usersInChannel) > 0 {
+		if len(usersInChannel) > 10 {
+			*resps = append(*resps,
+				args.T("api.command_invite.user_already_in_channel.overflow", map[string]any{
+					"FirstUser": "@" + usersInChannel[0],
+					"Others":    len(usersInChannel) - 1,
+				}),
+			)
+		} else {
+			usersString := map[string]any{
+				"User": "@" + strings.Join(usersInChannel, ", @"),
+			}
+			*resps = append(*resps,
+				args.T("api.command_invite.user_already_in_channel.app_error", len(usersInChannel), usersString),
+			)
+		}
+	}
+
+	if len(differentChannels) > 0 {
+		if len(differentChannels) > 10 {
+			*resps = append(*resps,
+				args.T("api.command_invite.successOverflow", map[string]any{
+					"FirstUser": "@" + differentChannels[0],
+					"Others":    len(differentChannels) - 1,
+					"Channel":   "",
+				}),
+			)
+		} else {
+			usersString := map[string]any{
+				"Users":   "@" + strings.Join(differentChannels, ", @"),
+				"Channel": "test",
+			}
+			*resps = append(*resps,
+				args.T("api.command_invite.success", usersString),
+			)
+		}
+	}
+
+	if len(nonTeamUsers) > 0 {
+		for k, v := range nonTeamUsers {
+			if len(v) > 10 {
+				*resps = append(*resps,
+					args.T("api.command_invite.user_not_in_team.messageOverflow", map[string]any{
+						"FirstUser": "@" + v[0],
+						"Others":    len(v) - 1,
+						"Team":      k,
+					}),
+				)
+			} else {
+				usersString := map[string]any{
+					"Users": "@" + strings.Join(v, ", @"),
+					"Team":  k,
+				}
+				*resps = append(*resps,
+					args.T("api.command_invite.user_not_in_team.app_error", usersString),
+				)
+			}
+		}
+	}
+
+	if len(channelConstrained) > 0 {
+		*resps = append(*resps,
+			args.T("api.command_invite.channel_constrained_user_denied"),
+		)
+	}
+
+	if len(errorUsers) > 0 {
+		*resps = append(*resps,
+			args.T("api.command_invite.fail.app_error"),
+		)
+	}
+
 	if len(*resps) > 0 {
 		return strings.Join(*resps, "\n")
 	}
-
 	return ""
 }

+func (i *InviteProvider) getUsersFromMentionName(a *app.App, mentionName string) []*model.User {
+	userProfile, err := a.Srv().Store().User().GetByUsername(mentionName)
+	if err == nil && userProfile.DeleteAt == 0 {
+		return []*model.User{userProfile}
+	}
+
+	group, appErr := a.GetGroupByName(mentionName, model.GroupSearchOpts{FilterAllowReference: true})
+	if appErr != nil || group == nil {
+		return nil
+	}
+
+	members, appErr := a.GetGroupMemberUsers(group.Id)
+	if appErr != nil {
+		return nil
+	}
+
+	return members
+}
+
 func (i *InviteProvider) parseMessage(a *app.App, c request.CTX, args *model.CommandArgs, resps *[]string, message string) ([]*model.User, []*model.Channel, string) {
 	splitMessage := strings.Split(message, " ")

@@ -93,15 +214,15 @@ func (i *InviteProvider) parseMessage(a *app.App, c request.CTX, args *model.Com
 		}

 		if msg[0] == '@' || (msg[0] != '~' && j == 0) {
-			targetUsername := strings.TrimPrefix(msg, "@")
-			userProfile := i.getUserProfile(a, targetUsername)
-			if userProfile == nil {
+			targetMentionName := strings.TrimPrefix(msg, "@")
+			users := i.getUsersFromMentionName(a, targetMentionName)
+			if len(users) == 0 {
 				*resps = append(*resps, args.T("api.command_invite.missing_user.app_error", map[string]any{
-					"User": targetUsername,
+					"User": targetMentionName,
 				}))
 				continue
 			}
-			targetUsers = append(targetUsers, userProfile)
+			targetUsers = append(targetUsers, users...)
 		} else {
 			targetChannelName := strings.TrimPrefix(msg, "~")
 			channelToJoin, err := a.GetChannelByName(c, targetChannelName, args.TeamId, false)
@@ -137,19 +258,6 @@ func (i *InviteProvider) parseMessage(a *app.App, c request.CTX, args *model.Com
 	return targetUsers, targetChannels, ""
 }

-func (i *InviteProvider) getUserProfile(a *app.App, username string) *model.User {
-	userProfile, nErr := a.Srv().Store().User().GetByUsername(username)
-	if nErr != nil {
-		return nil
-	}
-
-	if userProfile.DeleteAt != 0 {
-		return nil
-	}
-
-	return userProfile
-}
-
 func (i *InviteProvider) checkPermissions(a *app.App, c request.CTX, args *model.CommandArgs, resps *[]string, targetUser *model.User, targetChannels []*model.Channel) []*model.Channel {
 	var err *model.AppError
 	validChannels := make([]*model.Channel, 0, len(targetChannels))
@@ -188,26 +296,23 @@ func (i *InviteProvider) checkPermissions(a *app.App, c request.CTX, args *model
 	return validChannels
 }

-func (i *InviteProvider) addUserToChannel(a *app.App, c request.CTX, args *model.CommandArgs, userProfile *model.User, channelToJoin *model.Channel) string {
+func (i *InviteProvider) addUserToChannel(a *app.App, c request.CTX, args *model.CommandArgs, userProfile *model.User, channelToJoin *model.Channel) UserError {
 	// Check if user is already in the channel
 	_, err := a.GetChannelMember(c, channelToJoin.Id, userProfile.Id)
 	if err == nil {
-		return args.T("api.command_invite.user_already_in_channel.app_error", map[string]any{
-			"User": userProfile.Username,
-		})
+		return UserInChannel
 	}

 	if _, err = a.AddChannelMember(c, userProfile.Id, channelToJoin, app.ChannelMemberOpts{UserRequestorID: args.UserId}); err != nil {
 		if err.Id == "api.channel.add_members.user_denied" {
-			return args.T("api.command_invite.group_constrained_user_denied")
+			return IsConstrained
 		} else if err.Id == "app.team.get_member.missing.app_error" ||
 			err.Id == "api.channel.add_user.to.channel.failed.deleted.app_error" {
-			return args.T("api.command_invite.user_not_in_team.app_error", map[string]any{
-				"Username": userProfile.Username,
-			})
+			return UserNotInTeam
 		}
-		return args.T("api.command_invite.fail.app_error")
+		mlog.Warn("addUserToChannel had unexpected error.", mlog.String("UserId", userProfile.Id), mlog.Err(err))
+		return Unknown
 	}

-	return ""
+	return NoError
 }
--- a/server/channels/app/slashcommands/command_invite_test.go
+++ b/server/channels/app/slashcommands/command_invite_test.go
@@ -74,7 +74,7 @@ func TestInviteProvider(t *testing.T) {
 		channel2 := th.createChannel(th.BasicTeam, model.ChannelTypeOpen)

 		msg := "@" + th.BasicUser2.Username + " @" + anotherUser.Username + " ~" + channel1.Name + " ~" + channel2.Name
-		expected := "api.command_invite.success\napi.command_invite.success\napi.command_invite.success\napi.command_invite.success"
+		expected := "api.command_invite.success"
 		runCmd(msg, expected)
 		checkIsMember(channel1.Id, th.BasicUser2.Id)
 		checkIsMember(channel2.Id, th.BasicUser2.Id)
@@ -149,7 +149,7 @@ func TestInviteProvider(t *testing.T) {
 		groupChannel, _ = th.App.UpdateChannel(th.Context, groupChannel)

 		msg := "@" + th.BasicUser2.Username + " ~" + groupChannel.Name
-		runCmd(msg, "api.command_invite.group_constrained_user_denied")
+		runCmd(msg, "api.command_invite.channel_constrained_user_denied")
 		checkIsNotMember(groupChannel.Id, th.BasicUser2.Id)
 	})

@@ -264,3 +264,81 @@ func TestInviteGroup(t *testing.T) {
 		})
 	}
 }
+
+func TestUserGroups(t *testing.T) {
+	th := setup(t).initBasic()
+	defer th.tearDown()
+
+	privateChannel := th.createChannel(th.BasicTeam, model.ChannelTypePrivate)
+
+	id := model.NewId()
+	teamGroup, err := th.App.CreateGroup(&model.Group{
+		DisplayName:    "dn_" + id,
+		Name:           model.NewString("name" + id),
+		Source:         model.GroupSourceCustom,
+		Description:    "description_" + id,
+		AllowReference: true,
+		// MemberIDs:   []string{th.BasicUser2.Id},
+	})
+	assert.Nil(t, err)
+	teamGroupCommand := "@" + *teamGroup.Name + " ~" + privateChannel.Name
+
+	// th.App.Srv().SetLicense(model.NewTestLicenseSKU(model.LicenseShortSkuProfessional))
+	groupMembers, upsertErr := th.App.UpsertGroupMembers(teamGroup.Id, []string{th.BasicUser2.Id})
+	require.Nil(t, upsertErr)
+	assert.Len(t, groupMembers, 1)
+
+	basicUser3 := th.createUser()
+	basicUser4 := th.createUser()
+	id2 := model.NewId()
+	nonTeamGroup, err := th.App.CreateGroup(&model.Group{
+		DisplayName:    "dn_" + id2,
+		Name:           model.NewString("name" + id2),
+		Source:         model.GroupSourceCustom,
+		Description:    "description_" + id2,
+		AllowReference: true,
+		// MemberIDs:   []string{basicUser3.Id, basicUser4.Id},
+	})
+	assert.Nil(t, err)
+	nonTeamGroupCommand := "@" + *nonTeamGroup.Name + " ~" + privateChannel.Name
+	nonTeamGroupMembers, upsertErr := th.App.UpsertGroupMembers(nonTeamGroup.Id, []string{basicUser3.Id, basicUser4.Id})
+	require.Nil(t, upsertErr)
+	assert.Len(t, nonTeamGroupMembers, 2)
+
+	InviteP := InviteProvider{}
+	args := &model.CommandArgs{
+		T:         func(s string, args ...any) string { return s },
+		ChannelId: th.BasicChannel.Id,
+		TeamId:    th.BasicTeam.Id,
+		UserId:    th.BasicUser.Id,
+	}
+
+	tests := []struct {
+		desc     string
+		expected string
+		msg      string
+	}{
+		{
+			desc:     "try to add an new group of users ",
+			expected: "api.command_invite.success",
+			msg:      teamGroupCommand,
+		},
+		{
+			desc:     "try to add existing users",
+			expected: "api.command_invite.user_already_in_channel.app_error",
+			msg:      teamGroupCommand,
+		},
+		{
+			desc:     "try to add a user NOT part of the team",
+			expected: "api.command_invite.user_not_in_team.app_error",
+			msg:      nonTeamGroupCommand,
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.desc, func(t *testing.T) {
+			actual := InviteP.DoCommand(th.App, th.Context, args, test.msg).Text
+			assert.Equal(t, test.expected, actual)
+		})
+	}
+}
--- a/server/i18n/en.json
+++ b/server/i18n/en.json
@@ -918,6 +918,10 @@
    "id": "api.command_invite.channel.error",
    "translation": "Could not find the channel {{.Channel}}. Please use the [channel handle](https://docs.mattermost.com/messaging/managing-channels.html#naming-a-channel) to identify channels."
  },
+  {
+    "id": "api.command_invite.channel_constrained_user_denied",
+    "translation": "This channel is managed by groups.  This user is not part of a group that is synced to this channel."
+  },
  {
    "id": "api.command_invite.desc",
    "translation": "Invite a user to a channel"
@@ -930,10 +934,6 @@
    "id": "api.command_invite.fail.app_error",
    "translation": "An error occurred while joining the channel."
  },
-  {
-    "id": "api.command_invite.group_constrained_user_denied",
-    "translation": "This channel is managed by groups.  This user is not part of a group that is synced to this channel."
-  },
  {
    "id": "api.command_invite.hint",
    "translation": "@[username]... ~[channel]..."
@@ -962,13 +962,28 @@
    "id": "api.command_invite.success",
    "translation": "{{.User}} added to {{.Channel}} channel."
  },
+  {
+    "id": "api.command_invite.successOverflow",
+    "translation": "{{.FirstUser}} and {{.Others}} added to {{.Channel}} channel."
+  },
  {
    "id": "api.command_invite.user_already_in_channel.app_error",
-    "translation": "{{.User}} is already in the channel."
+    "translation": {
+      "one": "{{.User}} is already in the channel.",
+      "other": "{{.User}} are already in the channel."
+    }
+  },
+  {
+    "id": "api.command_invite.user_already_in_channel.overflow",
+    "translation": "{{.FirstUser}} and {{.Others}} others are already in the channel."
  },
  {
    "id": "api.command_invite.user_not_in_team.app_error",
-    "translation": "@{{.Username}} is not a member of the team."
+    "translation": "You can add {{.Users}} to this channel once they are members of the **{{.Team}}** team."
+  },
+  {
+    "id": "api.command_invite.user_not_in_team.messageOverflow",
+    "translation": "You can add {{.FirstUser}} and {{.Others}} others to this channel once they are members of the **{{.Team}}** team."
  },
  {
    "id": "api.command_invite_people.permission.app_error",