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.

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

[MM-62579] Fix panic in handleBotGetProfileForSession #942

Merged
merged 2 commits into from
Jan 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,4 @@ e2e/plugin.json

# server bundled translations
server/assets/i18n
.aider*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

necessary for the repo?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was added automatically to avoid committing aider files I suppose.

4 changes: 2 additions & 2 deletions server/bot_api.go
Original file line number Diff line number Diff line change
Expand Up @@ -596,8 +596,8 @@ func (p *Plugin) handleBotGetProfileForSession(w http.ResponseWriter, r *http.Re
return
}

ust := state.sessions[sessionID]
if ust.UserID == "" {
ust, ok := state.sessions[sessionID]
if !ok {
Comment on lines +599 to +600
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wow, all that for this.
Sometimes I want Go to be more strict, sometimes I don't...
Would Rust have forced you to handle all returns all the time? I guess so, because it would have been a Result or an Option, forcing you to unwrap it...

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In Rust you could try to unwrap the returned value which can panic as well. Otherwise you'd have to do an if let or a match. Here a good lint/vet check should have flagged it.

res.Code = http.StatusNotFound
res.Err = "not found"
return
Expand Down
218 changes: 218 additions & 0 deletions server/bot_api_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
// Copyright (c) 2022-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

package main

import (
"encoding/json"
"fmt"
"net/http"
"net/http/httptest"
"testing"

"github.com/mattermost/mattermost-plugin-calls/server/cluster"
"github.com/mattermost/mattermost-plugin-calls/server/enterprise"
"github.com/mattermost/mattermost-plugin-calls/server/public"
"github.com/mattermost/mattermost/server/public/model"
"github.com/mattermost/mattermost/server/public/plugin"

serverMocks "github.com/mattermost/mattermost-plugin-calls/server/mocks/github.com/mattermost/mattermost-plugin-calls/server/interfaces"
pluginMocks "github.com/mattermost/mattermost-plugin-calls/server/mocks/github.com/mattermost/mattermost/server/public/plugin"

"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
)

func TestHandleBotGetProfileForSession(t *testing.T) {
mockAPI := &pluginMocks.MockAPI{}
mockMetrics := &serverMocks.MockMetrics{}

botUserID := model.NewId()

p := Plugin{
MattermostPlugin: plugin.MattermostPlugin{
API: mockAPI,
},
metrics: mockMetrics,
botSession: &model.Session{
UserId: botUserID,
},
callsClusterLocks: map[string]*cluster.Mutex{},
}

p.licenseChecker = enterprise.NewLicenseChecker(p.API)

store, tearDown := NewTestStore(t)
t.Cleanup(tearDown)
p.store = store

mockAPI.On("KVSetWithOptions", mock.Anything, mock.Anything, mock.Anything).Return(true, nil)
mockMetrics.On("ObserveClusterMutexGrabTime", "mutex_call", mock.AnythingOfType("float64"))
mockMetrics.On("ObserveAppHandlersTime", mock.AnythingOfType("string"), mock.AnythingOfType("float64"))
mockMetrics.On("ObserveClusterMutexLockedTime", "mutex_call", mock.AnythingOfType("float64"))
mockMetrics.On("Handler").Return(nil).Once()

mockAPI.On("GetConfig").Return(&model.Config{}, nil)
mockAPI.On("GetLicense").Return(&model.License{
SkuShortName: "enterprise",
}, nil)

apiRouter := p.newAPIRouter()

t.Run("no call ongoing", func(t *testing.T) {
defer mockAPI.AssertExpectations(t)
defer mockMetrics.AssertExpectations(t)

channelID := model.NewId()
sessionID := model.NewId()

mockAPI.On("LogDebug", "creating cluster mutex for call",
"origin", mock.AnythingOfType("string"), "channelID", channelID).Once()
mockAPI.On("KVDelete", "mutex_call_"+channelID).Return(nil).Once()

w := httptest.NewRecorder()
r := httptest.NewRequest("GET", fmt.Sprintf("/bot/calls/%s/sessions/%s/profile", channelID, sessionID), nil)
r.Header.Set("Mattermost-User-Id", botUserID)

apiRouter.ServeHTTP(w, r)

resp := w.Result()
require.Equal(t, http.StatusBadRequest, resp.StatusCode)
var res httpResponse
err := json.NewDecoder(resp.Body).Decode(&res)
require.NoError(t, err)
require.Equal(t, "no call ongoing", res.Msg)
require.Equal(t, 400, res.Code)
})

t.Run("session not found", func(t *testing.T) {
defer mockAPI.AssertExpectations(t)
defer mockMetrics.AssertExpectations(t)

channelID := model.NewId()
sessionID := model.NewId()
call := &public.Call{
ID: model.NewId(),
ChannelID: channelID,
CreateAt: 45,
StartAt: 45,
OwnerID: botUserID,
}
err := store.CreateCall(call)
require.NoError(t, err)

w := httptest.NewRecorder()
r := httptest.NewRequest("GET", fmt.Sprintf("/bot/calls/%s/sessions/%s/profile", channelID, sessionID), nil)

mockAPI.On("LogDebug", "creating cluster mutex for call",
"origin", mock.AnythingOfType("string"), "channelID", channelID).Once()
mockAPI.On("KVDelete", "mutex_call_"+channelID).Return(nil).Once()

r.Header.Set("Mattermost-User-Id", botUserID)
apiRouter.ServeHTTP(w, r)

resp := w.Result()
require.Equal(t, http.StatusNotFound, resp.StatusCode)
var res httpResponse
err = json.NewDecoder(resp.Body).Decode(&res)
require.NoError(t, err)
require.Equal(t, "not found", res.Msg)
require.Equal(t, 404, res.Code)
})

t.Run("get user error", func(t *testing.T) {
channelID := model.NewId()
userID := model.NewId()
sessionID := model.NewId()
call := &public.Call{
ID: model.NewId(),
ChannelID: channelID,
CreateAt: 45,
StartAt: 45,
OwnerID: userID,
}
err := store.CreateCall(call)
require.NoError(t, err)

err = store.CreateCallSession(&public.CallSession{
ID: sessionID,
CallID: call.ID,
UserID: userID,
JoinAt: 45,
})
require.NoError(t, err)

mockAPI.On("GetUser", userID).Return(nil, &model.AppError{
Message: "failed to get user",
}).Once()

w := httptest.NewRecorder()
r := httptest.NewRequest("GET", "/bot/calls/"+channelID+"/sessions/"+sessionID+"/profile", nil)

mockAPI.On("LogDebug", "creating cluster mutex for call",
"origin", mock.AnythingOfType("string"), "channelID", channelID).Once()
mockAPI.On("KVDelete", "mutex_call_"+channelID).Return(nil).Once()

r.Header.Set("Mattermost-User-Id", botUserID)
apiRouter.ServeHTTP(w, r)

resp := w.Result()
require.Equal(t, http.StatusInternalServerError, resp.StatusCode)

var res httpResponse
err = json.NewDecoder(resp.Body).Decode(&res)
require.NoError(t, err)
require.Equal(t, "failed to get user", res.Msg)
require.Equal(t, 500, res.Code)
})

t.Run("success", func(t *testing.T) {
channelID := model.NewId()
userID := model.NewId()
sessionID := model.NewId()
call := &public.Call{
ID: model.NewId(),
ChannelID: channelID,
CreateAt: 45,
StartAt: 45,
OwnerID: userID,
}
err := store.CreateCall(call)
require.NoError(t, err)

err = store.CreateCallSession(&public.CallSession{
ID: sessionID,
CallID: call.ID,
UserID: userID,
JoinAt: 45,
})
require.NoError(t, err)

user := &model.User{
Id: userID,
Username: "testuser",
Email: "[email protected]",
}
mockAPI.On("GetUser", userID).Return(user, nil).Once()

w := httptest.NewRecorder()
r := httptest.NewRequest("GET", "/bot/calls/"+channelID+"/sessions/"+sessionID+"/profile", nil)

mockAPI.On("LogDebug", "creating cluster mutex for call",
"origin", mock.AnythingOfType("string"), "channelID", channelID).Once()
mockAPI.On("KVDelete", "mutex_call_"+channelID).Return(nil).Once()

r.Header.Set("Mattermost-User-Id", botUserID)
apiRouter.ServeHTTP(w, r)

resp := w.Result()
require.Equal(t, http.StatusOK, resp.StatusCode)

var respUser model.User
err = json.NewDecoder(resp.Body).Decode(&respUser)
require.NoError(t, err)
require.Equal(t, userID, respUser.Id)
require.Equal(t, user.Username, respUser.Username)
require.Equal(t, user.Email, respUser.Email)
})
}
Loading