Skip to content

Commit

Permalink
Review fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@raghavaggarwal2308
raghavaggarwal2308 committed Aug 6, 2024
1 parent 87b4165 commit 7d22f27
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 82 deletions.
80 changes: 38 additions & 42 deletions server/command.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ const (
commandTriggerDeleteTeamWelcome = "delete_team_welcome"

// Error Message Constants
unsetMessageError = "welcome message has not been set"
unsetMessageError = "Welcome message has not been set for the team"
pluginPermissionError = "`/welcomebot %s` commands can only be executed by the user with a system admin role, team admin role, or channel admin role"
)

Expand Down Expand Up @@ -134,32 +134,31 @@ func (p *Plugin) validateCommand(action string, parameters []string) string {
func (p *Plugin) validatePreviewPrivileges(teamID string, args *model.CommandArgs) (bool, error) {
if _, err := p.API.GetTeamMember(teamID, args.UserId); err != nil {
if err.StatusCode == http.StatusNotFound {
p.postCommandResponse(args, "You are not a member of that team.")
p.postCommandResponse(args, "You are not a member of the team.")
p.client.Log.Info("The user is not a member of the team.", "UserID", args.UserId, "TeamID", teamID)
return false, err
}
p.postCommandResponse(args, "error occurred while getting the Team Admin Role. Team: `%s` Error: `%s`", teamID, err.Error())
p.client.Log.Error("Error occurred while getting the Team Admin Role.", "TeamID", teamID, "Error", err.Error())
p.postCommandResponse(args, "Error occurred while getting the Team member")
p.client.Log.Error("Error occurred while getting the Team member.", "TeamID", teamID, "Error", err.Error())
return false, err
}
doesUserHavePrivileges := p.isSystemOrTeamAdmin(args, args.UserId, teamID)

return doesUserHavePrivileges, nil
return p.isSystemOrTeamAdmin(args, args.UserId, teamID), nil
}

// checks if the user has System or Team Admin access to the given team
func (p *Plugin) isSystemOrTeamAdmin(args *model.CommandArgs, userID string, teamID string) bool {
func (p *Plugin) isSystemOrTeamAdmin(args *model.CommandArgs, userID, teamID string) bool {
isSysadmin, err := p.hasSysadminRole(userID)
if err != nil {
p.postCommandResponse(args, "error occurred while getting the System Admin Role: `%s`", err.Error())
p.client.Log.Error("Error occurred while getting the System Admin Role.", "Error", err.Error())
p.postCommandResponse(args, "Error occurred while checking the System Admin Role.")
p.client.Log.Error("Error occurred while checking the System Admin Role.", "UserID", userID, "Error", err.Error())
return false
}

isTeamAdmin, err := p.hasTeamAdminRole(userID, teamID)
if err != nil {
p.postCommandResponse(args, "error occurred while getting the Team Admin Role `%s`: `%s`", teamID, err.Error())
p.client.Log.Error("Error occurred while getting the Team Admin Role.", "TeamID", teamID, "Error", err.Error())
p.postCommandResponse(args, "Error occurred while checking the Team Admin Role for the user.")
p.client.Log.Error("Error occurred while checking the Team Admin Role for the user.", "UserID", userID, "TeamID", teamID, "Error", err.Error())
return false
}

Expand All @@ -172,7 +171,7 @@ func (p *Plugin) isSystemOrTeamAdmin(args *model.CommandArgs, userID string, tea
return true
}

// This retrieves a map of team Ids with their respective welcome message
// This retrieves a map of team IDs with their respective welcome message from the KV store
func (p *Plugin) getTeamKVWelcomeMessagesMap(args *model.CommandArgs) map[string]string {
teamsList, err := p.client.Team.List()
if err != nil {
Expand All @@ -187,7 +186,7 @@ func (p *Plugin) getTeamKVWelcomeMessagesMap(args *model.CommandArgs) map[string
key := fmt.Sprintf("%s%s", welcomebotTeamWelcomeKey, team.Id)
var teamMessage string
if err := p.client.KV.Get(key, teamMessage); err != nil {
p.postCommandResponse(args, "Error occurred while retrieving the welcome messages: %s", err)
p.postCommandResponse(args, "Error occurred while retrieving the welcome messages: %s", err.Error())
p.client.Log.Error("Error occurred while retrieving the welcome messages from KV store.", "Error", err.Error())
return make(map[string]string)
}
Expand Down Expand Up @@ -309,7 +308,7 @@ func (p *Plugin) executeCommandGetWelcome(args *model.CommandArgs) {
key := fmt.Sprintf("%s%s", welcomebotChannelWelcomeKey, args.ChannelId)
data, appErr := p.API.KVGet(key)
if appErr != nil {
p.postCommandResponse(args, "Error occurred while retrieving the welcome message for the chanel: `%s`", appErr)
p.postCommandResponse(args, "Error occurred while retrieving the welcome message for the chanel: `%s`", appErr.Message)
return
}

Expand All @@ -326,7 +325,7 @@ func (p *Plugin) executeCommandDeleteWelcome(args *model.CommandArgs) {
data, appErr := p.API.KVGet(key)

if appErr != nil {
p.postCommandResponse(args, "Error occurred while retrieving the welcome message for the chanel: `%s`", appErr)
p.postCommandResponse(args, "Error occurred while retrieving the welcome message for the chanel: `%s`", appErr.Message)
return
}

Expand Down Expand Up @@ -356,11 +355,12 @@ func (p *Plugin) executeCommandSetTeamWelcome(args *model.CommandArgs) {
p.postCommandResponse(args, "Error occurred while extracting the welcome message from the command")
return
}

message := strings.TrimSpace(subCommands[1])

key := makeTeamWelcomeMessageKey(args.TeamId)
if isValueSet, appErr := p.client.KV.Set(key, []byte(message), nil); !isValueSet {
p.postCommandResponse(args, "Error occurred while storing the welcome message for the team: `%s`", appErr)
if isValueSet, err := p.client.KV.Set(key, &message); err != nil || !isValueSet {
p.postCommandResponse(args, "Error occurred while storing the welcome message for the team: `%s`", err.Error())
return
}

Expand All @@ -373,15 +373,14 @@ func (p *Plugin) executeCommandDeleteTeamWelcome(args *model.CommandArgs) {
return
}

key := makeTeamWelcomeMessageKey(args.TeamId)
_, appErr := p.GetTeamWelcomeMessageFromKV(args.TeamId)
if appErr != nil {
p.postCommandResponse(args, "Error occurred while retrieving the welcome message for the team: `%s`", appErr)
if _, err := p.GetTeamWelcomeMessageFromKV(args.TeamId); err != nil {
p.postCommandResponse(args, "Error occurred while retrieving the welcome message for the team: `%s`", err.Error())
return
}

key := makeTeamWelcomeMessageKey(args.TeamId)
if err := p.client.KV.Delete(key); err != nil {
p.postCommandResponse(args, "Error occurred while deleting the welcome message for the team: `%s`", err)
p.postCommandResponse(args, "Error occurred while deleting the welcome message for the team: `%s`", err.Error())
return
}

Expand All @@ -394,21 +393,21 @@ func (p *Plugin) executeCommandGetTeamWelcome(args *model.CommandArgs) {
return
}

data, appErr := p.GetTeamWelcomeMessageFromKV(args.TeamId)
if appErr != nil {
p.postCommandResponse(args, "Error occurred while retrieving the welcome message for the team: `%s`", appErr)
data, err := p.GetTeamWelcomeMessageFromKV(args.TeamId)
if err != nil {
p.postCommandResponse(args, "Error occurred while retrieving the welcome message for the team: `%s`", err.Error())
return
}

// retrieve team name through the teamid
team, err := p.client.Team.Get(args.TeamId)
if err != nil {
p.postCommandResponse(args, err.Error())
p.postCommandResponse(args, "Error occurred while retrieving the team: `%s`", err.Error())
return
}

if data != nil {
p.postCommandResponse(args, string(data))
if data != "" {
p.postCommandResponse(args, data)
return
}

Expand All @@ -421,14 +420,15 @@ func (p *Plugin) executeCommandGetTeamWelcome(args *model.CommandArgs) {
return
}
}
// if KV do not have message, and Config.json does not have message, then there is no message. Display Error case.

// Show unset error message if no message is stored in KV and config.json file
p.postCommandResponse(args, unsetMessageError)
}

func (p *Plugin) checkCommandPermission(args *model.CommandArgs, action string) (bool, error) {
isSysadmin, err := p.hasSysadminRole(args.UserId)
if err != nil {
p.postCommandResponse(args, "Authorization failed: %s", err.Error())
p.postCommandResponse(args, "System admin authorization failed: %s", err.Error())
return true, err
}

Expand Down Expand Up @@ -536,27 +536,25 @@ func (p *Plugin) getUniqueTeamsWithWelcomeMsgSlice(teamsWithConfigWelcomeMsg map
allTeamNames = append(allTeamNames, teamsWithKVWelcomeKeys...)

// Leverage the unique priniciple of keys in a map to store unique values as they are encountered
teamNameMap := make(map[string]int)
teamNameMap := make(map[string]bool)
for _, teamName := range allTeamNames {
teamNameMap[teamName] = 0
if !teamNameMap[teamName] {
uniqueTeams = append(uniqueTeams, teamName)
}
teamNameMap[teamName] = true
}

// Iterate through each pair in the checkMap to create a list of all unique pairs.
for teamName := range teamNameMap {
uniqueTeams = append(uniqueTeams, teamName)
}
return uniqueTeams
}

// Takes maps whose keys are strings, and whose values are anything.
func convertStringMapIntoKeySlice(mapInput interface{}) []string {
// need to check that input is a map or a slice before continuing
reflectValue := reflect.ValueOf(mapInput)
switch reflectValue.Kind() {
case reflect.Map:
default:
if reflectValue.Kind() != reflect.Map {
return nil
}

// Grabs all keys and makes a list of the keys.
keys := make([]string, 0, len(reflectValue.MapKeys()))
for _, keyReflectValue := range reflectValue.MapKeys() {
Expand Down Expand Up @@ -591,15 +589,13 @@ func getAutocompleteData() *model.AutocompleteData {
welcomebot.AddCommand(deleteChannelWelcome)

setTeamWelcome := model.NewAutocompleteData(commandTriggerSetTeamWelcome, "[welcome-message]", "Set the welcome message for the team")
setChannelWelcome.AddTextArgument("Welcome message for the current team", "[welcome-message]", "")
setTeamWelcome.AddTextArgument("Welcome message for the current team", "[welcome-message]", "")
welcomebot.AddCommand(setTeamWelcome)

getTeamWelcome := model.NewAutocompleteData(commandTriggerGetTeamWelcome, "", "Print the welcome message for the team")
getTeamWelcome.AddTextArgument("Team name to get the welcome message", "[team-name]", "")
welcomebot.AddCommand(getTeamWelcome)

deleteTeamWelcome := model.NewAutocompleteData(commandTriggerDeleteTeamWelcome, "", "Delete the welcome message for the team. Configuration based messages are not affected by this.")
deleteTeamWelcome.AddTextArgument("Team name to delete the welcome message", "[team-name]", "")
welcomebot.AddCommand(deleteTeamWelcome)

return welcomebot
Expand Down
11 changes: 7 additions & 4 deletions server/configuration.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@ package main

import (
"fmt"

"github.com/mattermost/mattermost/server/public/model"
)

const (
Expand Down Expand Up @@ -75,9 +73,14 @@ func (p *Plugin) OnConfigurationChange() error {
}

// Takes a teamID to construct the correct key, and then retrieve the necessary value from the pair stored in the DB
func (p *Plugin) GetTeamWelcomeMessageFromKV(teamID string) ([]byte, *model.AppError) {
func (p *Plugin) GetTeamWelcomeMessageFromKV(teamID string) (string, error) {
key := makeTeamWelcomeMessageKey(teamID)
return p.API.KVGet(key)
var message string
if err := p.client.KV.Get(key, &message); err != nil {
return "", err
}

return message, nil
}

func makeTeamWelcomeMessageKey(teamID string) string {
Expand Down
52 changes: 16 additions & 36 deletions server/hooks.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import (

"github.com/mattermost/mattermost/server/public/model"
"github.com/mattermost/mattermost/server/public/plugin"
"github.com/mattermost/mattermost/server/public/shared/mlog"
)

// UserHasJoinedTeam is invoked after the membership has been committed to the database. If
Expand All @@ -17,19 +16,18 @@ func (p *Plugin) UserHasJoinedTeam(c *plugin.Context, teamMember *model.TeamMemb
return
}

teamMessage, appErr := p.GetTeamWelcomeMessageFromKV(teamMember.TeamId)
if appErr != nil {
mlog.Error(
"error occurred while retrieving the welcome message",
mlog.String("teamId", teamMember.TeamId),
mlog.Err(appErr),
)
teamMessage, err := p.GetTeamWelcomeMessageFromKV(teamMember.TeamId)
if err != nil {
p.client.Log.Error("Error occurred while retrieving the welcome message", "TeamID", teamMember.TeamId, "Error", err.Error())
return
}

if teamMessage == nil {
if teamMessage == "" {
// No dynamic welcome message for the given team, so we check if one has been set in the config.json
for _, message := range p.getWelcomeMessages() {
if data.User.IsGuest() && !message.IncludeGuests {
continue
}
if message.TeamName == data.Team.Name {
go p.processWelcomeMessage(*data, *message)
}
Expand All @@ -43,13 +41,10 @@ func (p *Plugin) UserHasJoinedTeam(c *plugin.Context, teamMember *model.TeamMemb
postDM := &model.Post{
UserId: p.botUserID,
ChannelId: data.DirectMessage.Id,
Message: string(teamMessage),
Message: teamMessage,
}
if err := p.client.Post.CreatePost(postDM); err != nil {
mlog.Error("failed to post welcome message to the channel",
mlog.String("channelId", data.DirectMessage.Id),
mlog.Err(err),
)
p.client.Log.Error("failed to post welcome message to the channel", "ChannelID", data.DirectMessage.Id, "Error", err.Error())
}
}

Expand All @@ -59,11 +54,7 @@ func (p *Plugin) UserHasJoinedTeam(c *plugin.Context, teamMember *model.TeamMemb
func (p *Plugin) UserHasJoinedChannel(c *plugin.Context, channelMember *model.ChannelMember, actor *model.User) {
channelInfo, err := p.client.Channel.Get(channelMember.ChannelId)
if err != nil {
mlog.Error(
"error occurred while checking the type of the chanel",
mlog.String("channelId", channelMember.ChannelId),
mlog.Err(err),
)
p.client.Log.Error("Error occurred while checking the type of the chanel", "ChannelID", channelMember.ChannelId, "Error", err.Error())
return
} else if channelInfo.Type == model.ChannelTypePrivate {
return
Expand All @@ -72,11 +63,7 @@ func (p *Plugin) UserHasJoinedChannel(c *plugin.Context, channelMember *model.Ch
key := fmt.Sprintf("%s%s", welcomebotChannelWelcomeKey, channelMember.ChannelId)
data, appErr := p.API.KVGet(key)
if appErr != nil {
mlog.Error(
"error occurred while retrieving the welcome message",
mlog.String("channelId", channelMember.ChannelId),
mlog.Err(appErr),
)
p.client.Log.Error("Error occurred while retrieving the welcome message", "ChannelID", channelMember.ChannelId, "Error", appErr.Message)
return
}

Expand All @@ -85,13 +72,9 @@ func (p *Plugin) UserHasJoinedChannel(c *plugin.Context, channelMember *model.Ch
return
}

dmChannel, appErr := p.API.GetDirectChannel(channelMember.UserId, p.botUserID)
if appErr != nil {
mlog.Error(
"error occurred while creating direct channel to the user",
mlog.String("UserId", channelMember.UserId),
mlog.Err(appErr),
)
dmChannel, err := p.client.Channel.GetDirect(channelMember.UserId, p.botUserID)
if err != nil {
p.client.Log.Error("Error occurred while creating direct channel to the user", "UserID", channelMember.UserId, "Error", err.Error())
return
}

Expand All @@ -103,11 +86,8 @@ func (p *Plugin) UserHasJoinedChannel(c *plugin.Context, channelMember *model.Ch
ChannelId: dmChannel.Id,
Message: string(data),
}
if _, appErr := p.API.CreatePost(postDM); appErr != nil {
mlog.Error("failed to post welcome message to the channel",
mlog.String("channelId", dmChannel.Id),
mlog.Err(appErr),
)
if err := p.client.Post.CreatePost(postDM); err != nil {
p.client.Log.Error("failed to post welcome message to the channel", "ChannelID", dmChannel.Id, "Error", err.Error())
}

postChannel := &model.Post{
Expand Down

0 comments on commit 7d22f27

Please sign in to comment.