Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reduce calls to Mattermost server by caching replies #513

Merged
merged 2 commits into from
Dec 14, 2022
Merged

Reduce calls to Mattermost server by caching replies #513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0776e7
Reduce calls to Mattermost server by caching replies
hloeung Nov 22, 2022
1d7f1f5
Switch to hashicorp/golang-lru removing complexity introduced per review
hloeung Dec 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 57 additions & 22 deletions bridge/mattermost/mattermost.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (

"github.com/42wim/matterircd/bridge"
"github.com/davecgh/go-spew/spew"
lru "github.com/hashicorp/golang-lru"
"github.com/matterbridge/matterclient"
"github.com/mattermost/mattermost-server/v6/model"
"github.com/mitchellh/mapstructure"
Expand All @@ -24,6 +25,8 @@ type Mattermost struct {
eventChan chan *bridge.Event
v *viper.Viper
connected bool

msglruCache *lru.Cache
}

func New(v *viper.Viper, cred bridge.Credentials, eventChan chan *bridge.Event, onWsConnect func()) (bridge.Bridger, *matterclient.Client, error) {
Expand All @@ -32,6 +35,8 @@ func New(v *viper.Viper, cred bridge.Credentials, eventChan chan *bridge.Event,
eventChan: eventChan,
v: v,
}
cache, _ := lru.New(300)
m.msglruCache = cache

logger.SetFormatter(&logger.TextFormatter{FullTimestamp: true})
if v.GetBool("debug") {
Expand Down Expand Up @@ -756,6 +761,34 @@ func maybeShorten(msg string, newLen int, uncounted string, unicode bool) string
return fmt.Sprintf("%s %s", newMsg, ellipsis)
}

func (m *Mattermost) addParentMsg(parentID string, msg string, newLen int, uncounted string, unicode bool) (string, error) {
var replyMessage string

// Search and use cached reply if it exists.
// None found, so we'll need to create one and save it for future uses.
if v, ok := m.msglruCache.Get(parentID); !ok {
parentPost, _, err := m.mc.Client.GetPost(parentID, "")
// Retry once on failure.
if err != nil {
parentPost, _, err = m.mc.Client.GetPost(parentID, "")
}
if err != nil {
return msg, err
}

parentUser := m.GetUser(parentPost.UserId)
parentMessage := maybeShorten(parentPost.Message, newLen, uncounted, unicode)
replyMessage = fmt.Sprintf(" (re @%s: %s)", parentUser.Nick, parentMessage)
logger.Debugf("Created reply for parent post %s:%s", parentID, replyMessage)

m.msglruCache.Add(parentID, replyMessage)
} else if replyMessage, ok = v.(string); ok {
logger.Debugf("Found saved reply for parent post %s, using:%s", parentID, replyMessage)
}

return strings.TrimRight(msg, "\n") + replyMessage, nil
}

//nolint:funlen,gocognit,gocyclo,cyclop,forcetypeassert
func (m *Mattermost) handleWsActionPost(rmsg *model.WebSocketEvent) {
var data model.Post
Expand All @@ -771,19 +804,12 @@ func (m *Mattermost) handleWsActionPost(rmsg *model.WebSocketEvent) {
return
}

if data.RootId != "" {
parentPost, _, err := m.mc.Client.GetPost(data.RootId, "")
if !m.v.GetBool("mattermost.hidereplies") && data.RootId != "" {
message, err := m.addParentMsg(data.RootId, data.Message, m.v.GetInt("mattermost.ShortenRepliesTo"), "@", m.v.GetBool("mattermost.unicode"))
if err != nil {
logger.Errorf("Unable to get parent post for %#v", data) //nolint:govet
} else {
parentGhost := m.GetUser(parentPost.UserId)

if !m.v.GetBool("mattermost.hidereplies") {
parentMessage := maybeShorten(parentPost.Message, m.v.GetInt("mattermost.ShortenRepliesTo"), "@", m.v.GetBool("mattermost.unicode"))
replyMessage := fmt.Sprintf(" (re @%s: %s)", parentGhost.Nick, parentMessage)
data.Message = strings.TrimRight(data.Message, "\n") + replyMessage
}
}
data.Message = message
}

// create new "ghost" user
Expand Down Expand Up @@ -1214,50 +1240,59 @@ func (m *Mattermost) handleReactionEvent(rmsg *model.WebSocketEvent) {
return
}

userID := m.GetUser(reaction.UserId)

// No need to show added/removed reaction messages for our own.
if userID.Me {
logger.Debugf("Not showing own reaction: %s: %s", rmsg.EventType(), reaction.EmojiName)
return
}

var event *bridge.Event

channelType := ""
channelID := rmsg.GetBroadcast().ChannelId

name := m.GetChannelName(rmsg.GetBroadcast().ChannelId)
name := m.GetChannelName(channelID)
if strings.Contains(name, "__") {
channelType = "D"
}

var parentUser *bridge.UserInfo
message := ""
rMessage := ""
if !m.v.GetBool("mattermost.hidereplies") {
parentPost, _, err := m.mc.Client.GetPost(reaction.PostId, "")
if err == nil {
parentUser = m.GetUser(parentPost.UserId)
message = maybeShorten(parentPost.Message, m.v.GetInt("mattermost.shortenrepliesto"), "@", m.v.GetBool("mattermost.unicode"))
message, err := m.addParentMsg(reaction.PostId, "", m.v.GetInt("mattermost.ShortenRepliesTo"), "@", m.v.GetBool("mattermost.unicode"))
if err != nil {
logger.Errorf("Unable to get parent post for %#v", reaction)
}
rMessage = message
}

switch rmsg.EventType() {
case model.WebsocketEventReactionAdded:
event = &bridge.Event{
Type: "reaction_add",
Data: &bridge.ReactionAddEvent{
ChannelID: rmsg.GetBroadcast().ChannelId,
ChannelID: channelID,
MessageID: reaction.PostId,
Sender: m.GetUser(reaction.UserId),
Sender: userID,
Reaction: reaction.EmojiName,
ChannelType: channelType,
ParentUser: parentUser,
Message: message,
Message: rMessage,
},
}
case model.WebsocketEventReactionRemoved:
event = &bridge.Event{
Type: "reaction_remove",
Data: &bridge.ReactionRemoveEvent{
ChannelID: rmsg.GetBroadcast().ChannelId,
ChannelID: channelID,
MessageID: reaction.PostId,
Sender: m.GetUser(reaction.UserId),
Sender: userID,
Reaction: reaction.EmojiName,
ChannelType: channelType,
ParentUser: parentUser,
Message: message,
Message: rMessage,
},
}
}
Expand Down
22 changes: 2 additions & 20 deletions mm-go-irckit/userbridge.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,27 +400,15 @@ func (u *User) handleReactionEvent(event interface{}) {

switch e := event.(type) {
case *bridge.ReactionAddEvent:
if !u.v.GetBool(u.br.Protocol() + ".hidereplies") {
nick := "(none)"
if e.ParentUser != nil {
nick = sanitizeNick(e.ParentUser.Nick)
}
message = fmt.Sprintf(" (re @%s: %s)", nick, e.Message)
}
message = e.Message
text = "added reaction: "
channelID = e.ChannelID
messageID = e.MessageID
sender = e.Sender
channelType = e.ChannelType
reaction = e.Reaction
case *bridge.ReactionRemoveEvent:
if !u.v.GetBool(u.br.Protocol() + ".hidereplies") {
nick := "(none)"
if e.ParentUser != nil {
nick = sanitizeNick(e.ParentUser.Nick)
}
message = fmt.Sprintf(" (re @%s: %s)", nick, e.Message)
}
message = e.Message
text = "removed reaction: "
channelID = e.ChannelID
messageID = e.MessageID
Expand All @@ -436,12 +424,6 @@ func (u *User) handleReactionEvent(event interface{}) {
return
}

// No need to show added/removed reaction messages for our own.
if sender.Me {
logger.Debug("Not showing own reaction: " + text + reaction)
return
}

if channelType == "D" {
e := &bridge.DirectMessageEvent{
Text: text + reaction + message,
Expand Down