[MM-26574] Add role filters to get users, users search and add getFilteredUserStats endpoint (#14998)

* MM-26574 Add role filters to user search and get

* Add ability to get filtered user stats

Add support for include bots

* Add tests for user count with filters

Add tests

* Apply changes from code review

* Fix guest filtering

* Fix up tests related to guests

* Clean role names

* Trigger CI

* Trigger CI

model/role.go

@@ -364,6 +364,23 @@ func (r *Role) IsValidWithoutId() bool {
 	return true
 }
 
+func CleanRoleNames(roleNames []string) ([]string, bool) {
+	var cleanedRoleNames []string
+	for _, roleName := range roleNames {
+		if strings.TrimSpace(roleName) == "" {
+			continue
+		}
+
+		if !IsValidRoleName(roleName) {
+			return roleNames, false
+		}
+
+		cleanedRoleNames = append(cleanedRoleNames, roleName)
+	}
+
+	return cleanedRoleNames, true
+}
+
 func IsValidRoleName(roleName string) bool {
 	if len(roleName) <= 0 || len(roleName) > ROLE_NAME_MAX_LENGTH {
 		return false

model/user_count.go

@@ -13,6 +13,14 @@ type UserCountOptions struct {
 	ExcludeRegularUsers bool
 	// Only include users on a specific team. "" for any team.
 	TeamId string
+	// Only include users on a specific channel. "" for any channel.
+	ChannelId string
 	// Restrict to search in a list of teams and channels
 	ViewRestrictions *ViewUsersRestrictions
+	// Only include users matching any of the given system wide roles.
+	Roles []string
+	// Only include users matching any of the given channel roles, must be used with ChannelId.
+	ChannelRoles []string
+	// Only include users matching any of the given team roles, must be used with TeamId.
+	TeamRoles []string
 }

model/user_get.go

@@ -24,6 +24,12 @@ type UserGetOptions struct {
 	Active bool
 	// Filters for the given role
 	Role string
+	// Filters for users matching any of the given system wide roles
+	Roles []string
+	// Filters for users matching any of the given channel roles, must be used with InChannelId
+	ChannelRoles []string
+	// Filters for users matching any of the given team roles, must be used with InTeamId
+	TeamRoles []string
 	// Sorting option
 	Sort string
 	// Restrict to search in a list of teams and channels

model/user_search.go

@@ -13,17 +13,20 @@ const USER_SEARCH_DEFAULT_LIMIT = 100
 
 // UserSearch captures the parameters provided by a client for initiating a user search.
 type UserSearch struct {
-	Term             string `json:"term"`
-	TeamId           string `json:"team_id"`
-	NotInTeamId      string `json:"not_in_team_id"`
-	InChannelId      string `json:"in_channel_id"`
-	NotInChannelId   string `json:"not_in_channel_id"`
-	InGroupId        string `json:"in_group_id"`
-	GroupConstrained bool   `json:"group_constrained"`
-	AllowInactive    bool   `json:"allow_inactive"`
-	WithoutTeam      bool   `json:"without_team"`
-	Limit            int    `json:"limit"`
-	Role             string `json:"role"`
+	Term             string   `json:"term"`
+	TeamId           string   `json:"team_id"`
+	NotInTeamId      string   `json:"not_in_team_id"`
+	InChannelId      string   `json:"in_channel_id"`
+	NotInChannelId   string   `json:"not_in_channel_id"`
+	InGroupId        string   `json:"in_group_id"`
+	GroupConstrained bool     `json:"group_constrained"`
+	AllowInactive    bool     `json:"allow_inactive"`
+	WithoutTeam      bool     `json:"without_team"`
+	Limit            int      `json:"limit"`
+	Role             string   `json:"role"`
+	Roles            []string `json:"roles"`
+	ChannelRoles     []string `json:"channel_roles"`
+	TeamRoles        []string `json:"team_roles"`
 }
 
 // ToJson convert a User to a json string
@@ -61,6 +64,12 @@ type UserSearchOptions struct {
 	Limit int
 	// Filters for the given role
 	Role string
+	// Filters for users that have any of the given system roles
+	Roles []string
+	// Filters for users that have the given channel roles to be used when searching in a channel
+	ChannelRoles []string
+	// Filters for users that have the given team roles to be used when searching in a team
+	TeamRoles []string
 	// Restrict to search in a list of teams and channels
 	ViewRestrictions *ViewUsersRestrictions
 	// List of allowed channels