Skip to content

[MM-147] Updated log statements #444

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

Open
raghavaggarwal2308 wants to merge 7 commits into
base: master
Choose a base branch
from
+304 −22
Open

[MM-147] Updated log statements #444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
442c34c
add verbose logging for lhs data code path
mickmister Dec 14, 2023
6f7fe3f
more logging
mickmister Dec 15, 2023
fd40b9a
Merge branch 'master' of github.com:mattermost/mattermost-plugin-gitl…
avas27JTG Jan 17, 2024
f10c8fb
[MM-147] Updated log statements
Jan 18, 2024
666fae4
[MM-147] Removed few extra logs
Jan 18, 2024
9afee46
[MM-147] Fix the log value of expiry_minutes
Jan 18, 2024
ad68089
Merge branch 'master' into MM-147
Mar 28, 2024
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
46 changes: 45 additions & 1 deletion server/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,29 @@
func (p *Plugin) ServeHTTP(c *plugin.Context, w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")

if r.URL.Path == "/set-expiry" {
expiry := r.URL.Query().Get("expiry")
userID := r.Header.Get("Mattermost-User-Id")
token, err := p.getGitlabUserTokenByMattermostID(userID)
oldExpiry := token.Expiry
if err != nil {
http.Error(w, err.Error(), 500)
return
}

Check warning on line 45 in server/api.go

View check run for this annotation

Codecov / codecov/patch

server/api.go#L38-L45 

Added lines #L38 - L45 were not covered by tests

expiryMinutes, _ := strconv.ParseInt(expiry, 10, 32)
newExpiry := time.Now().Add(time.Duration(expiryMinutes) * time.Minute)
token.Expiry = newExpiry
_ = p.storeGitlabUserToken(userID, token)

_ = json.NewEncoder(w).Encode(map[string]string{
"old_expiry": oldExpiry.String(),
"new_expiry": newExpiry.String(),
})

return

Check warning on line 57 in server/api.go

View check run for this annotation

Codecov / codecov/patch

server/api.go#L47-L57 

Added lines #L47 - L57 were not covered by tests
}

p.router.ServeHTTP(w, r)
}

Expand Down Expand Up @@ -554,12 +577,31 @@
}

func (p *Plugin) getLHSData(c *UserContext, w http.ResponseWriter, r *http.Request) {
log := c.Log.With(logger.LogContext{
"token": nil,
"func": "getLHSData",
})

Check warning on line 584 in server/api.go

View check run for this annotation

Codecov / codecov/patch

server/api.go#L580-L584 

Added lines #L580 - L584 were not covered by tests
var result *gitlab.LHSContent
err := p.useGitlabClient(c.GitlabInfo, func(info *gitlab.UserInfo, token *oauth2.Token) error {
resp, err := p.GitlabClient.GetLHSData(c.Ctx, info, token)
log = log.With(logger.LogContext{"token": gitlab.MakeSanitizedTokenLogContext(token)})

localLog := log.With(logger.LogContext{"func": "getLHSData/useGitlabClient callback"})

localLog.Debugf("calling p.GitlabClient.GetLHSData")
resp, err := p.GitlabClient.GetLHSData(c.Ctx, info, token, log)

// update outer-scope log variable with potentially new token
log = log.With(logger.LogContext{"token": gitlab.MakeSanitizedTokenLogContext(token)})
localLog = log.With(logger.LogContext{"func": "getLHSData/useGitlabClient callback"})

Check warning on line 597 in server/api.go

View check run for this annotation

Codecov / codecov/patch

server/api.go#L587-L597 

Added lines #L587 - L597 were not covered by tests
if err != nil {
localLog.WithError(err).Debugf("error calling p.GitlabClient.GetLHSData")

Check warning on line 599 in server/api.go

View check run for this annotation

Codecov / codecov/patch

server/api.go#L599 

Added line #L599 was not covered by tests
return err
}

localLog.Debugf("called p.GitlabClient.GetLHSData")

Check warning on line 604 in server/api.go

View check run for this annotation

Codecov / codecov/patch

server/api.go#L603-L604 

Added lines #L603 - L604 were not covered by tests
result = resp
return nil
})
Expand All @@ -570,6 +612,8 @@
return
}

log.Debugf("end of getLHSData")

Check warning on line 616 in server/api.go

View check run for this annotation

Codecov / codecov/patch

server/api.go#L615-L616 

Added lines #L615 - L616 were not covered by tests
p.writeAPIResponse(w, result)
}

Expand Down
58 changes: 58 additions & 0 deletions server/command_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ func TestSubscribeCommand(t *testing.T) {
for _, test := range subscribeCommandTests {
t.Run(test.testName, func(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()

channelID := "12345"
userInfo := &gitlab.UserInfo{
Expand Down Expand Up @@ -220,6 +221,8 @@ func TestListWebhookCommand(t *testing.T) {
p := new(Plugin)

mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()

mockedClient := mocks.NewMockGitlab(mockCtrl)

encryptedToken, _ := encrypt([]byte(testEncryptionKey), testGitlabToken)
Expand All @@ -230,6 +233,24 @@ func TestListWebhookCommand(t *testing.T) {

api := &plugintest.API{}
api.On("KVGet", "_usertoken").Return([]byte(encryptedToken), nil)
api.On("LogDebug",
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
).Maybe().Return(nil)

p.SetAPI(api)
p.client = pluginapi.NewClient(api, p.Driver)

Expand Down Expand Up @@ -311,6 +332,23 @@ func getTestPlugin(t *testing.T, mockCtrl *gomock.Controller, hooks []*gitlab.We
api.On("KVSet", mock.Anything, mock.Anything).Return(nil)
api.On("KVSetWithOptions", mock.AnythingOfType("string"), mock.Anything, mock.AnythingOfType("model.PluginKVSetOptions")).Return(true, nil)
api.On("PublishWebSocketEvent", mock.Anything, mock.Anything, mock.Anything).Return(nil)
api.On("LogDebug",
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
).Maybe().Return(nil)
api.On("LogWarn",
mock.AnythingOfTypeArgument("string"),
mock.AnythingOfTypeArgument("string"),
Expand Down Expand Up @@ -427,6 +465,8 @@ func TestAddWebhookCommand(t *testing.T) {
p := new(Plugin)

mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()

mockedClient := mocks.NewMockGitlab(mockCtrl)

if test.scope == "group" {
Expand All @@ -452,6 +492,24 @@ func TestAddWebhookCommand(t *testing.T) {
api := &plugintest.API{}
api.On("GetConfig", mock.Anything).Return(conf)
api.On("KVGet", "_usertoken").Return([]byte(encryptedToken), nil)
api.On("LogDebug",
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
mock.Anything,
).Maybe().Return(nil)

p.SetAPI(api)
p.client = pluginapi.NewClient(api, p.Driver)

Expand Down
54 changes: 52 additions & 2 deletions server/gitlab/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"net/http"
"strings"
"sync"
"time"

"github.com/mattermost/mattermost/server/public/pluginapi/experimental/bot/logger"

Expand Down Expand Up @@ -289,35 +290,84 @@ func (g *gitlab) GetProject(ctx context.Context, user *UserInfo, token *oauth2.T
return project, nil
}

func (g *gitlab) GetLHSData(ctx context.Context, user *UserInfo, token *oauth2.Token) (*LHSContent, error) {
func sanitizeTokenString(token string) string {
suffixLength := 8
endIndex := len(token) - suffixLength
return token[endIndex:]
}

func MakeSanitizedTokenLogContext(token *oauth2.Token) logger.LogContext {
if token == nil {
return nil
}

return logger.LogContext{
"access_token": sanitizeTokenString(token.AccessToken),
"refresh_token": sanitizeTokenString(token.RefreshToken),
"expiry": token.Expiry,
"expiry_minutes": time.Until(token.Expiry).Minutes(),
}
}

func (g *gitlab) GetLHSData(ctx context.Context, user *UserInfo, token *oauth2.Token, log logger.Logger) (*LHSContent, error) {
log = log.With(logger.LogContext{
"func": "gitlab.GetLHSData",
"token": MakeSanitizedTokenLogContext(token),
})

log.Debugf("calling g.GitlabConnect")
client, err := g.GitlabConnect(*token)
log = log.With(logger.LogContext{"token": MakeSanitizedTokenLogContext(token)})

if err != nil {
log.WithError(err).Debugf("error calling g.GitlabConnect")
return nil, err
}

grp, ctx := errgroup.WithContext(ctx)

var reviews []*MergeRequest
grp.Go(func() error {
log.Debugf("calling g.GetReviews")
reviews, err = g.GetReviews(ctx, user, client)
if err != nil {
log.WithError(err).Debugf("error calling g.GetReviews")
return err
}
return err
})

var issues []*Issue
grp.Go(func() error {
log.Debugf("calling g.GetYourAssignedIssues")
issues, err = g.GetYourAssignedIssues(ctx, user, client)
if err != nil {
log.WithError(err).Debugf("error calling g.GetYourAssignedIssues")
return err
}
return err
})

var mergeRequests []*MergeRequest
grp.Go(func() error {
log.Debugf("calling g.GetYourAssignedPrs")
mergeRequests, err = g.GetYourAssignedPrs(ctx, user, client)
if err != nil {
log.WithError(err).Debugf("error calling g.GetYourAssignedPrs")
return err
}
return err
})

var todos []*internGitlab.Todo
grp.Go(func() error {
log.Debugf("calling g.GetToDoList")

todos, err = g.GetToDoList(ctx, user, client)
if err != nil {
log.WithError(err).Debugf("error calling g.GetToDoList")
return err
}
return err
})

Expand Down Expand Up @@ -590,7 +640,7 @@ func (g *gitlab) GetYourAssignedIssues(ctx context.Context, user *UserInfo, clie
}
}

var result []*Issue
result := []*Issue{}
for _, issue := range issues {
if issue.Labels != nil {
labelsWithDetails, err := g.GetLabelDetails(client, issue.ProjectID, issue.Labels)
Expand Down
2 changes: 1 addition & 1 deletion server/gitlab/gitlab.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ type Gitlab interface {
GetYourPrDetails(ctx context.Context, log logger.Logger, user *UserInfo, token *oauth2.Token, prList []*PRDetails) ([]*PRDetails, error)
GetReviews(ctx context.Context, user *UserInfo, client *internGitlab.Client) ([]*MergeRequest, error)
GetYourAssignedPrs(ctx context.Context, user *UserInfo, client *internGitlab.Client) ([]*MergeRequest, error)
GetLHSData(ctx context.Context, user *UserInfo, token *oauth2.Token) (*LHSContent, error)
GetLHSData(ctx context.Context, user *UserInfo, token *oauth2.Token, log logger.Logger) (*LHSContent, error)
GetYourAssignedIssues(ctx context.Context, user *UserInfo, client *internGitlab.Client) ([]*Issue, error)
GetToDoList(ctx context.Context, user *UserInfo, client *internGitlab.Client) ([]*internGitlab.Todo, error)
GetProjectHooks(ctx context.Context, user *UserInfo, token *oauth2.Token, owner string, repo string) ([]*WebhookInfo, error)
Expand Down
8 changes: 4 additions & 4 deletions server/gitlab/mocks/mock_gitlab.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions server/mocks/mock_gitlab.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading