[MI-3650] Added the metric for MS Graph client method time

go.mod

@@ -14,6 +14,7 @@ require (
 	github.com/mattermost/mattermost-server/v6 v6.0.0-20230901142735-ccceee77061a
 	github.com/mattn/godown v0.0.1
 	github.com/microsoft/kiota-abstractions-go v1.2.2
+	github.com/microsoft/kiota-http-go v1.1.0
 	github.com/microsoftgraph/msgraph-sdk-go v1.20.0
 	github.com/microsoftgraph/msgraph-sdk-go-core v1.0.0
 	github.com/pborman/uuid v1.2.1
@@ -81,7 +82,6 @@ require (
 	github.com/mattn/go-runewidth v0.0.14 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
 	github.com/microsoft/kiota-authentication-azure-go v1.0.0 // indirect
-	github.com/microsoft/kiota-http-go v1.1.0 // indirect
 	github.com/microsoft/kiota-serialization-form-go v1.0.0 // indirect
 	github.com/microsoft/kiota-serialization-json-go v1.0.4 // indirect
 	github.com/microsoft/kiota-serialization-multipart-go v1.0.0 // indirect

server/api.go

@@ -355,7 +355,7 @@ func (a *API) oauthRedirectHandler(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	client := msteams.NewTokenClient(a.p.GetURL()+"/oauth-redirect", a.p.configuration.TenantID, a.p.configuration.ClientID, a.p.configuration.ClientSecret, token, &a.p.apiClient.Log)
+	client := msteams.NewTokenClient(a.p.GetURL()+"/oauth-redirect", a.p.configuration.TenantID, a.p.configuration.ClientID, a.p.configuration.ClientSecret, token, &a.p.apiClient.Log, a.p.metricsService)
 	if err = client.Connect(); err != nil {
 		a.p.API.LogError("Unable to connect to the client", "error", err.Error())
 		http.Error(w, "failed to connect to the client", http.StatusInternalServerError)

server/command.go

@@ -202,6 +202,7 @@ func (p *Plugin) executeLinkCommand(args *model.CommandArgs, parameters []string
 		return p.cmdError(args.UserId, args.ChannelId, "Unable to subscribe to the channel")
 	}
 
+	p.metricsService.ObserveSubscriptionsCount(subscriptionConnected)
 	if err = p.store.StoreChannelLink(&channelLink); err != nil {
 		p.API.LogDebug("Unable to create the new link", "error", err.Error())
 		return p.cmdError(args.UserId, args.ChannelId, "Unable to create new link.")

server/command_test.go

@@ -5,7 +5,8 @@ import (
 	"testing"
 	"time"
 
-	"github.com/mattermost/mattermost-plugin-msteams-sync/server/msteams"
+	mockMetrics "github.com/mattermost/mattermost-plugin-msteams-sync/server/metrics/mocks"
+	"github.com/mattermost/mattermost-plugin-msteams-sync/server/msteams/clientmodels"
 	mockClient "github.com/mattermost/mattermost-plugin-msteams-sync/server/msteams/mocks"
 	mockStore "github.com/mattermost/mattermost-plugin-msteams-sync/server/store/mocks"
 	"github.com/mattermost/mattermost-plugin-msteams-sync/server/store/storemodels"
@@ -232,8 +233,8 @@ func TestExecuteShowCommand(t *testing.T) {
 				}, nil).Times(1)
 			},
 			setupClient: func(c *mockClient.Client) {
-				c.On("GetTeam", "Valid-MSTeamsTeam").Return(&msteams.Team{}, nil).Times(1)
-				c.On("GetChannelInTeam", mock.AnythingOfType("string"), mock.AnythingOfType("string")).Return(&msteams.Channel{}, nil).Times(1)
+				c.On("GetTeam", "Valid-MSTeamsTeam").Return(&clientmodels.Team{}, nil).Times(1)
+				c.On("GetChannelInTeam", mock.AnythingOfType("string"), mock.AnythingOfType("string")).Return(&clientmodels.Channel{}, nil).Times(1)
 			},
 		},
 		{
@@ -304,8 +305,8 @@ func TestExecuteShowLinksCommand(t *testing.T) {
 				s.On("ListChannelLinksWithNames").Return(testutils.GetChannelLinks(1), nil).Times(1)
 			},
 			setupClient: func(c *mockClient.Client) {
-				c.On("GetTeams", mock.AnythingOfType("string")).Return([]*msteams.Team{{ID: testutils.GetTeamsTeamID(), DisplayName: "Test MS team"}}, nil).Times(1)
-				c.On("GetChannelsInTeam", testutils.GetTeamsTeamID(), mock.AnythingOfType("string")).Return([]*msteams.Channel{{ID: testutils.GetTeamsChannelID(), DisplayName: "Test MS channel"}}, nil).Times(1)
+				c.On("GetTeams", mock.AnythingOfType("string")).Return([]*clientmodels.Team{{ID: testutils.GetTeamsTeamID(), DisplayName: "Test MS team"}}, nil).Times(1)
+				c.On("GetChannelsInTeam", testutils.GetTeamsTeamID(), mock.AnythingOfType("string")).Return([]*clientmodels.Channel{{ID: testutils.GetTeamsChannelID(), DisplayName: "Test MS channel"}}, nil).Times(1)
 			},
 		},
 		{
@@ -544,12 +545,13 @@ func TestExecuteLinkCommand(t *testing.T) {
 	mockAPI := &plugintest.API{}
 
 	for _, testCase := range []struct {
-		description string
-		parameters  []string
-		args        *model.CommandArgs
-		setupAPI    func(*plugintest.API)
-		setupStore  func(*mockStore.Store)
-		setupClient func(*mockClient.Client, *mockClient.Client)
+		description  string
+		parameters   []string
+		args         *model.CommandArgs
+		setupAPI     func(*plugintest.API)
+		setupStore   func(*mockStore.Store)
+		setupClient  func(*mockClient.Client, *mockClient.Client)
+		setupMetrics func(metrics *mockMetrics.Metrics)
 	}{
 		{
 			description: "Successfully executed link command",
@@ -583,7 +585,11 @@ func TestExecuteLinkCommand(t *testing.T) {
 				s.On("CommitTx", &sql.Tx{}).Return(nil).Times(1)
 			},
 			setupClient: func(c *mockClient.Client, uc *mockClient.Client) {
-				uc.On("GetChannelInTeam", testutils.GetTeamsUserID(), testutils.GetChannelID()).Return(&msteams.Channel{}, nil)
+				uc.On("GetChannelInTeam", testutils.GetTeamsUserID(), testutils.GetChannelID()).Return(&clientmodels.Channel{}, nil)
+			},
+			setupMetrics: func(metrics *mockMetrics.Metrics) {
+				metrics.On("ObserveSubscriptionsCount", subscriptionConnected).Times(1)
+				metrics.On("ObserveMSGraphClientMethodDuration", "Client.GetChannelInTeam", "true", mock.AnythingOfType("float64")).Once()
 			},
 		},
 		{
@@ -617,7 +623,11 @@ func TestExecuteLinkCommand(t *testing.T) {
 				s.On("BeginTx").Return(nil, errors.New("error in beginning the database transaction")).Times(1)
 			},
 			setupClient: func(c *mockClient.Client, uc *mockClient.Client) {
-				uc.On("GetChannelInTeam", testutils.GetTeamsUserID(), testutils.GetChannelID()).Return(&msteams.Channel{}, nil)
+				uc.On("GetChannelInTeam", testutils.GetTeamsUserID(), testutils.GetChannelID()).Return(&clientmodels.Channel{}, nil)
+			},
+			setupMetrics: func(metrics *mockMetrics.Metrics) {
+				metrics.On("ObserveSubscriptionsCount", subscriptionConnected).Times(1)
+				metrics.On("ObserveMSGraphClientMethodDuration", "Client.GetChannelInTeam", "true", mock.AnythingOfType("float64")).Once()
 			},
 		},
 		{
@@ -653,7 +663,11 @@ func TestExecuteLinkCommand(t *testing.T) {
 				s.On("CommitTx", &sql.Tx{}).Return(errors.New("error in committing transaction")).Times(1)
 			},
 			setupClient: func(c *mockClient.Client, uc *mockClient.Client) {
-				uc.On("GetChannelInTeam", testutils.GetTeamsUserID(), testutils.GetChannelID()).Return(&msteams.Channel{}, nil)
+				uc.On("GetChannelInTeam", testutils.GetTeamsUserID(), testutils.GetChannelID()).Return(&clientmodels.Channel{}, nil)
+			},
+			setupMetrics: func(metrics *mockMetrics.Metrics) {
+				metrics.On("ObserveSubscriptionsCount", subscriptionConnected).Times(1)
+				metrics.On("ObserveMSGraphClientMethodDuration", "Client.GetChannelInTeam", "true", mock.AnythingOfType("float64")).Once()
 			},
 		},
 		{
@@ -679,7 +693,10 @@ func TestExecuteLinkCommand(t *testing.T) {
 				s.On("StoreChannelLink", mock.Anything).Return(nil).Times(1)
 			},
 			setupClient: func(c *mockClient.Client, uc *mockClient.Client) {
-				uc.On("GetChannelInTeam", testutils.GetTeamsUserID(), testutils.GetChannelID()).Return(&msteams.Channel{}, nil)
+				uc.On("GetChannelInTeam", testutils.GetTeamsUserID(), testutils.GetChannelID()).Return(&clientmodels.Channel{}, nil)
+			},
+			setupMetrics: func(metrics *mockMetrics.Metrics) {
+				metrics.On("ObserveMSGraphClientMethodDuration", "Client.GetChannelInTeam", "true", mock.AnythingOfType("float64")).Once()
 			},
 		},
 		{
@@ -696,8 +713,9 @@ func TestExecuteLinkCommand(t *testing.T) {
 				api.On("HasPermissionToChannel", testutils.GetUserID(), testutils.GetChannelID(), model.PermissionManageChannelRoles).Return(true).Times(1)
 				api.On("SendEphemeralPost", testutils.GetUserID(), testutils.GetEphemeralPost("bot-user-id", testutils.GetChannelID(), "Invalid link command, please pass the MS Teams team id and channel id as parameters.")).Return(testutils.GetPost(testutils.GetChannelID(), testutils.GetUserID(), time.Now().UnixMicro())).Times(1)
 			},
-			setupStore:  func(s *mockStore.Store) {},
-			setupClient: func(c *mockClient.Client, uc *mockClient.Client) {},
+			setupStore:   func(s *mockStore.Store) {},
+			setupClient:  func(c *mockClient.Client, uc *mockClient.Client) {},
+			setupMetrics: func(metrics *mockMetrics.Metrics) {},
 		},
 		{
 			description: "Team is not enabled for MS Teams sync",
@@ -713,7 +731,8 @@ func TestExecuteLinkCommand(t *testing.T) {
 			setupStore: func(s *mockStore.Store) {
 				s.On("CheckEnabledTeamByTeamID", "").Return(false).Times(1)
 			},
-			setupClient: func(c *mockClient.Client, uc *mockClient.Client) {},
+			setupClient:  func(c *mockClient.Client, uc *mockClient.Client) {},
+			setupMetrics: func(metrics *mockMetrics.Metrics) {},
 		},
 		{
 			description: "Unable to get the current channel information",
@@ -728,7 +747,8 @@ func TestExecuteLinkCommand(t *testing.T) {
 			setupStore: func(s *mockStore.Store) {
 				s.On("CheckEnabledTeamByTeamID", testutils.GetTeamsUserID()).Return(true).Times(1)
 			},
-			setupClient: func(c *mockClient.Client, uc *mockClient.Client) {},
+			setupClient:  func(c *mockClient.Client, uc *mockClient.Client) {},
+			setupMetrics: func(metrics *mockMetrics.Metrics) {},
 		},
 		{
 			description: "Unable to link the channel as only channel admin can link it",
@@ -747,7 +767,8 @@ func TestExecuteLinkCommand(t *testing.T) {
 			setupStore: func(s *mockStore.Store) {
 				s.On("CheckEnabledTeamByTeamID", testutils.GetTeamsUserID()).Return(true).Times(1)
 			},
-			setupClient: func(c *mockClient.Client, uc *mockClient.Client) {},
+			setupClient:  func(c *mockClient.Client, uc *mockClient.Client) {},
+			setupMetrics: func(metrics *mockMetrics.Metrics) {},
 		},
 		{
 			description: "Unable to link channel as channel is either a direct or group message",
@@ -765,7 +786,8 @@ func TestExecuteLinkCommand(t *testing.T) {
 			setupStore: func(s *mockStore.Store) {
 				s.On("CheckEnabledTeamByTeamID", testutils.GetTeamsUserID()).Return(true).Times(1)
 			},
-			setupClient: func(c *mockClient.Client, uc *mockClient.Client) {},
+			setupClient:  func(c *mockClient.Client, uc *mockClient.Client) {},
+			setupMetrics: func(metrics *mockMetrics.Metrics) {},
 		},
 		{
 			description: "Unable to find MS Teams channel as user don't have the permissions to access it",
@@ -796,14 +818,18 @@ func TestExecuteLinkCommand(t *testing.T) {
 			setupClient: func(c *mockClient.Client, uc *mockClient.Client) {
 				uc.On("GetChannelInTeam", testutils.GetTeamsUserID(), "").Return(nil, errors.New("Error while getting the channel"))
 			},
+			setupMetrics: func(metrics *mockMetrics.Metrics) {
+				metrics.On("ObserveMSGraphClientMethodDuration", "Client.GetChannelInTeam", "false", mock.AnythingOfType("float64")).Once()
+			},
 		},
 	} {
 		t.Run(testCase.description, func(t *testing.T) {
 			p.SetAPI(mockAPI)
 			testCase.setupAPI(mockAPI)
 
 			testCase.setupStore(p.store.(*mockStore.Store))
-			testCase.setupClient(p.msteamsAppClient.(*mockClient.Client), p.clientBuilderWithToken("", "", "", "", nil, nil).(*mockClient.Client))
+			testCase.setupClient(p.msteamsAppClient.(*mockClient.Client), p.clientBuilderWithToken("", "", "", "", nil, nil, nil).(*mockClient.Client))
+			testCase.setupMetrics(p.metricsService.(*mockMetrics.Metrics))
 			_, _ = p.executeLinkCommand(testCase.args, testCase.parameters)
 		})
 	}

server/handlers/attachments.go

@@ -12,11 +12,12 @@ import (
 	"time"
 
 	"github.com/mattermost/mattermost-plugin-msteams-sync/server/msteams"
+	"github.com/mattermost/mattermost-plugin-msteams-sync/server/msteams/clientmodels"
 	"github.com/mattermost/mattermost-server/v6/app/imaging"
 	"github.com/mattermost/mattermost-server/v6/model"
 )
 
-func GetResourceIDsFromURL(weburl string) (*msteams.ActivityIds, error) {
+func GetResourceIDsFromURL(weburl string) (*clientmodels.ActivityIds, error) {
 	parsedURL, err := url.Parse(weburl)
 	if err != nil {
 		return nil, err
@@ -25,7 +26,7 @@ func GetResourceIDsFromURL(weburl string) (*msteams.ActivityIds, error) {
 	path := strings.TrimPrefix(parsedURL.Path, "/beta/")
 	path = strings.TrimPrefix(path, "/v1.0/")
 	urlParts := strings.Split(path, "/")
-	activityIDs := &msteams.ActivityIds{}
+	activityIDs := &clientmodels.ActivityIds{}
 	if urlParts[0] == "chats" && len(urlParts) >= 6 {
 		activityIDs.ChatID = urlParts[1]
 		activityIDs.MessageID = urlParts[3]
@@ -91,11 +92,12 @@ func (ah *ActivityHandler) ProcessAndUploadFileToMM(attachmentData []byte, attac
 	return fileInfo.Id, false
 }
 
-func (ah *ActivityHandler) handleAttachments(channelID, userID, text string, msg *msteams.Message, chat *msteams.Chat, isUpdatedActivity bool) (string, model.StringArray, string, bool) {
+func (ah *ActivityHandler) handleAttachments(channelID, userID, text string, msg *clientmodels.Message, chat *clientmodels.Chat, isUpdatedActivity bool) (string, model.StringArray, string, bool) {
 	attachments := []string{}
 	newText := text
 	parentID := ""
 	countAttachments := 0
+	countFileAttachments := 0
 	var client msteams.Client
 	if chat == nil {
 		client = ah.plugin.GetClientForApp()
@@ -114,19 +116,26 @@ func (ah *ActivityHandler) handleAttachments(channelID, userID, text string, msg
 		return "", nil, "", errorFound
 	}
 
+	isDirect := isNotDirectMessage
+	if chat != nil {
+		isDirect = isDirectMessage
+	}
+
 	for _, a := range msg.Attachments {
 		// remove the attachment tags from the text
 		newText = attachRE.ReplaceAllString(newText, "")
 
 		// handle a code snippet (code block)
 		if a.ContentType == "application/vnd.microsoft.card.codesnippet" {
 			newText = ah.handleCodeSnippet(client, a, newText)
+			countAttachments++
 			continue
 		}
 
 		// handle a message reference (reply)
 		if a.ContentType == "messageReference" {
 			parentID, newText = ah.handleMessageReference(a, msg.ChatID+msg.ChannelID, newText)
+			countAttachments++
 			continue
 		}
 
@@ -143,19 +152,22 @@ func (ah *ActivityHandler) handleAttachments(channelID, userID, text string, msg
 			attachmentData, err = ah.handleDownloadFile(a.ContentURL, client)
 			if err != nil {
 				ah.plugin.GetAPI().LogError("failed to download the file", "filename", a.Name, "error", err.Error())
+				ah.plugin.GetMetrics().ObserveFilesCount(actionCreated, actionSourceMSTeams, isDirect, discardedReasonUnableToGetTeamsData, 1)
 				continue
 			}
 		} else {
 			fileSize, downloadURL, err = client.GetFileSizeAndDownloadURL(a.ContentURL)
 			if err != nil {
 				ah.plugin.GetAPI().LogError("failed to get file size and download URL", "error", err.Error())
+				ah.plugin.GetMetrics().ObserveFilesCount(actionCreated, actionSourceMSTeams, isDirect, discardedReasonUnableToGetTeamsData, 1)
 				continue
 			}
 
 			fileSizeAllowed := *ah.plugin.GetAPI().GetConfig().FileSettings.MaxFileSize
 			if fileSize > fileSizeAllowed {
 				ah.plugin.GetAPI().LogError("skipping file download from MS Teams because the file size is greater than the allowed size")
 				errorFound = true
+				ah.plugin.GetMetrics().ObserveFilesCount(actionCreated, actionSourceMSTeams, isDirect, discardedReasonMaxFileSizeExceeded, 1)
 				continue
 			}
 
@@ -164,6 +176,7 @@ func (ah *ActivityHandler) handleAttachments(channelID, userID, text string, msg
 				attachmentData, err = client.GetFileContent(downloadURL)
 				if err != nil {
 					ah.plugin.GetAPI().LogError("failed to get file content", "error", err.Error())
+					ah.plugin.GetMetrics().ObserveFilesCount(actionCreated, actionSourceMSTeams, isDirect, discardedReasonUnableToGetTeamsData, 1)
 					continue
 				}
 			}
@@ -184,12 +197,15 @@ func (ah *ActivityHandler) handleAttachments(channelID, userID, text string, msg
 		}
 
 		if fileInfoID == "" {
+			ah.plugin.GetMetrics().ObserveFilesCount(actionCreated, actionSourceMSTeams, isDirect, discardedReasonEmptyFileID, 1)
 			continue
 		}
 		attachments = append(attachments, fileInfoID)
-		countAttachments++
-		if countAttachments == 10 {
+		ah.plugin.GetMetrics().ObserveFilesCount(actionCreated, actionSourceMSTeams, isDirect, "", 1)
+		countFileAttachments++
+		if countFileAttachments == 10 {
 			ah.plugin.GetAPI().LogDebug("discarding the rest of the attachments as Mattermost supports only 10 attachments per post")
+			ah.plugin.GetMetrics().ObserveFilesCount(actionCreated, actionSourceMSTeams, isDirect, discardedReasonFileLimitReached, len(msg.Attachments)-countAttachments-countFileAttachments)
 			break
 		}
 	}
@@ -215,7 +231,7 @@ func (ah *ActivityHandler) GetFileFromTeamsAndUploadToMM(downloadURL string, cli
 	return fileInfo.Id
 }
 
-func (ah *ActivityHandler) handleCodeSnippet(client msteams.Client, attach msteams.Attachment, text string) string {
+func (ah *ActivityHandler) handleCodeSnippet(client msteams.Client, attach clientmodels.Attachment, text string) string {
 	var content struct {
 		Language       string `json:"language"`
 		CodeSnippetURL string `json:"codeSnippetUrl"`
@@ -245,7 +261,7 @@ func (ah *ActivityHandler) handleCodeSnippet(client msteams.Client, attach mstea
 	return newText
 }
 
-func (ah *ActivityHandler) handleMessageReference(attach msteams.Attachment, chatOrChannelID string, text string) (string, string) {
+func (ah *ActivityHandler) handleMessageReference(attach clientmodels.Attachment, chatOrChannelID string, text string) (string, string) {
 	var content struct {
 		MessageID string `json:"messageId"`
 	}