[MI-3115] Added logging in the APIs for autocomplete MS Teams teams a…

…nd channels (#142) * [MI-3115] Added logging in the APIs for autocomplete MS Teams teams and channels * [MI-3115] Fixed failing unit tests
mattermost · May 24, 2023 · b84d5d1 · b84d5d1
1 parent 50ed736
commit b84d5d1
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 3 deletions.
diff --git a/server/api.go b/server/api.go
@@ -160,18 +160,21 @@ func (a *API) autocompleteTeams(w http.ResponseWriter, r *http.Request) {
 
 	client, err := a.p.GetClientForUser(userID)
 	if err != nil {
+		a.p.API.LogError("Unable to get the client for user", "Error", err.Error())
 		data, _ := json.Marshal(out)
 		_, _ = w.Write(data)
 		return
 	}
 
 	teams, err := client.ListTeams()
 	if err != nil {
+		a.p.API.LogError("Unable to get the MS Teams teams", "Error", err.Error())
 		data, _ := json.Marshal(out)
 		_, _ = w.Write(data)
 		return
 	}
 
+	a.p.API.LogDebug("Successfully fetched the list of teams", "Count", len(teams))
 	for _, t := range teams {
 		s := model.AutocompleteListItem{
 			Item:     t.ID,
@@ -181,6 +184,7 @@ func (a *API) autocompleteTeams(w http.ResponseWriter, r *http.Request) {
 
 		out = append(out, s)
 	}
+
 	data, _ := json.Marshal(out)
 	_, _ = w.Write(data)
 }
@@ -197,6 +201,7 @@ func (a *API) autocompleteChannels(w http.ResponseWriter, r *http.Request) {
 
 	client, err := a.p.GetClientForUser(userID)
 	if err != nil {
+		a.p.API.LogError("Unable to get the client for user", "Error", err.Error())
 		data, _ := json.Marshal(out)
 		_, _ = w.Write(data)
 		return
@@ -205,11 +210,13 @@ func (a *API) autocompleteChannels(w http.ResponseWriter, r *http.Request) {
 	teamID := args[2]
 	channels, err := client.ListChannels(teamID)
 	if err != nil {
+		a.p.API.LogError("Unable to get the channels for MS Teams team", "TeamID", teamID, "Error", err.Error())
 		data, _ := json.Marshal(out)
 		_, _ = w.Write(data)
 		return
 	}
 
+	a.p.API.LogDebug("Successfully fetched the list of channels for MS Teams team", "TeamID", teamID, "Count", len(channels))
 	for _, c := range channels {
 		s := model.AutocompleteListItem{
 			Item:     c.ID,

diff --git a/server/api_test.go b/server/api_test.go
@@ -468,12 +468,16 @@ func TestProcessLifecycle(t *testing.T) {
 func TestAutocompleteTeams(t *testing.T) {
 	for _, test := range []struct {
 		Name           string
+		SetupAPI       func(*plugintest.API)
 		SetupStore     func(*storemocks.Store)
 		SetupClient    func(*clientmocks.Client, *clientmocks.Client)
 		ExpectedResult []model.AutocompleteListItem
 	}{
 		{
 			Name: "AutocompleteTeams: Unable to get client for the user",
+			SetupAPI: func(api *plugintest.API) {
+				api.On("LogError", "Unable to get the client for user", "Error", "not connected user").Once()
+			},
 			SetupStore: func(store *storemocks.Store) {
 				store.On("GetTokenForMattermostUser", testutils.GetID()).Return(nil, nil).Times(1)
 			},
@@ -482,6 +486,9 @@ func TestAutocompleteTeams(t *testing.T) {
 		},
 		{
 			Name: "AutocompleteTeams: Unable to get the teams list",
+			SetupAPI: func(api *plugintest.API) {
+				api.On("LogError", "Unable to get the MS Teams teams", "Error", "unable to get the teams list").Once()
+			},
 			SetupStore: func(store *storemocks.Store) {
 				store.On("GetTokenForMattermostUser", testutils.GetID()).Return(&oauth2.Token{}, nil).Times(1)
 			},
@@ -492,6 +499,9 @@ func TestAutocompleteTeams(t *testing.T) {
 		},
 		{
 			Name: "AutocompleteTeams: Valid",
+			SetupAPI: func(api *plugintest.API) {
+				api.On("LogDebug", "Successfully fetched the list of teams", "Count", 2).Once()
+			},
 			SetupStore: func(store *storemocks.Store) {
 				store.On("GetTokenForMattermostUser", testutils.GetID()).Return(&oauth2.Token{}, nil).Times(1)
 			},
@@ -526,6 +536,7 @@ func TestAutocompleteTeams(t *testing.T) {
 		t.Run(test.Name, func(t *testing.T) {
 			assert := assert.New(t)
 			plugin := newTestPlugin(t)
+			test.SetupAPI(plugin.API.(*plugintest.API))
 			test.SetupStore(plugin.store.(*storemocks.Store))
 			test.SetupClient(plugin.msteamsAppClient.(*clientmocks.Client), plugin.clientBuilderWithToken("", "", "", "", nil, nil).(*clientmocks.Client))
 			w := httptest.NewRecorder()
@@ -548,18 +559,23 @@ func TestAutocompleteChannels(t *testing.T) {
 	for _, test := range []struct {
 		Name           string
 		QueryParams    string
+		SetupAPI       func(*plugintest.API)
 		SetupStore     func(*storemocks.Store)
 		SetupClient    func(*clientmocks.Client, *clientmocks.Client)
 		ExpectedResult []model.AutocompleteListItem
 	}{
 		{
 			Name:           "AutocompleteChannels: Query params not present",
+			SetupAPI:       func(a *plugintest.API) {},
 			SetupStore:     func(store *storemocks.Store) {},
 			SetupClient:    func(client *clientmocks.Client, uclient *clientmocks.Client) {},
 			ExpectedResult: []model.AutocompleteListItem{},
 		},
 		{
-			Name:        "AutocompleteChannels: Unable to get client for the user",
+			Name: "AutocompleteChannels: Unable to get client for the user",
+			SetupAPI: func(api *plugintest.API) {
+				api.On("LogError", "Unable to get the client for user", "Error", "not connected user").Once()
+			},
 			QueryParams: "mockData-1 mockData-2 mockData-3",
 			SetupStore: func(store *storemocks.Store) {
 				store.On("GetTokenForMattermostUser", testutils.GetID()).Return(nil, nil).Times(1)
@@ -568,7 +584,10 @@ func TestAutocompleteChannels(t *testing.T) {
 			ExpectedResult: []model.AutocompleteListItem{},
 		},
 		{
-			Name:        "AutocompleteChannels: Unable to get the channels list",
+			Name: "AutocompleteChannels: Unable to get the channels list",
+			SetupAPI: func(api *plugintest.API) {
+				api.On("LogError", "Unable to get the channels for MS Teams team", "TeamID", "mockData-3", "Error", "unable to get the channels list").Once()
+			},
 			QueryParams: "mockData-1 mockData-2 mockData-3",
 			SetupStore: func(store *storemocks.Store) {
 				store.On("GetTokenForMattermostUser", testutils.GetID()).Return(&oauth2.Token{}, nil).Times(1)
@@ -579,7 +598,10 @@ func TestAutocompleteChannels(t *testing.T) {
 			ExpectedResult: []model.AutocompleteListItem{},
 		},
 		{
-			Name:        "AutocompleteChannels: Valid",
+			Name: "AutocompleteChannels: Valid",
+			SetupAPI: func(api *plugintest.API) {
+				api.On("LogDebug", "Successfully fetched the list of channels for MS Teams team", "TeamID", "mockData-3", "Count", 2).Once()
+			},
 			QueryParams: "mockData-1 mockData-2 mockData-3",
 			SetupStore: func(store *storemocks.Store) {
 				store.On("GetTokenForMattermostUser", testutils.GetID()).Return(&oauth2.Token{}, nil).Times(1)
@@ -615,6 +637,7 @@ func TestAutocompleteChannels(t *testing.T) {
 		t.Run(test.Name, func(t *testing.T) {
 			assert := assert.New(t)
 			plugin := newTestPlugin(t)
+			test.SetupAPI(plugin.API.(*plugintest.API))
 			test.SetupStore(plugin.store.(*storemocks.Store))
 			test.SetupClient(plugin.msteamsAppClient.(*clientmocks.Client), plugin.clientBuilderWithToken("", "", "", "", nil, nil).(*clientmocks.Client))
 			w := httptest.NewRecorder()