implement GET /teams/{team_id}/commands/autocomplete (#5951)

api4/command.go

@@ -18,6 +18,8 @@ func InitCommand() {
 
 	BaseRoutes.Commands.Handle("", ApiSessionRequired(createCommand)).Methods("POST")
 	BaseRoutes.Commands.Handle("", ApiSessionRequired(listCommands)).Methods("GET")
+
+	BaseRoutes.Team.Handle("/commands/autocomplete", ApiSessionRequired(listAutocompleteCommands)).Methods("GET")
 }
 
 func createCommand(c *Context, w http.ResponseWriter, r *http.Request) {
@@ -91,3 +93,23 @@ func listCommands(c *Context, w http.ResponseWriter, r *http.Request) {
 
 	w.Write([]byte(model.CommandListToJson(commands)))
 }
+
+func listAutocompleteCommands(c *Context, w http.ResponseWriter, r *http.Request) {
+	c.RequireTeamId()
+	if c.Err != nil {
+		return
+	}
+
+	if !app.SessionHasPermissionToTeam(c.Session, c.Params.TeamId, model.PERMISSION_VIEW_TEAM) {
+		c.SetPermissionError(model.PERMISSION_VIEW_TEAM)
+		return
+	}
+
+	commands, err := app.ListAutocompleteCommands(c.Params.TeamId, c.T)
+	if err != nil {
+		c.Err = err
+		return
+	}
+
+	w.Write([]byte(model.CommandListToJson(commands)))
+}

api4/command_test.go

@@ -136,3 +136,63 @@ func TestListCommands(t *testing.T) {
 		}
 	})
 }
+
+func TestListAutocompleteCommands(t *testing.T) {
+	th := Setup().InitBasic().InitSystemAdmin()
+	defer TearDown()
+	Client := th.Client
+
+	newCmd := &model.Command{
+		CreatorId: th.BasicUser.Id,
+		TeamId:    th.BasicTeam.Id,
+		URL:       "http://nowhere.com",
+		Method:    model.COMMAND_METHOD_POST,
+		Trigger:   "custom_command"}
+
+	_, resp := th.SystemAdminClient.CreateCommand(newCmd)
+	CheckNoError(t, resp)
+
+	t.Run("ListAutocompleteCommandsOnly", func(t *testing.T) {
+		listCommands, resp := th.SystemAdminClient.ListAutocompleteCommands(th.BasicTeam.Id)
+		CheckNoError(t, resp)
+
+		foundEcho := false
+		foundCustom := false
+		for _, command := range listCommands {
+			if command.Trigger == "echo" {
+				foundEcho = true
+			}
+			if command.Trigger == "custom_command" {
+				foundCustom = true
+			}
+		}
+		if !foundEcho {
+			t.Fatal("Couldn't find echo command")
+		}
+		if foundCustom {
+			t.Fatal("Should not list the custom command")
+		}
+	})
+
+	t.Run("RegularUserCanListOnlySystemCommands", func(t *testing.T) {
+		listCommands, resp := Client.ListAutocompleteCommands(th.BasicTeam.Id)
+		CheckNoError(t, resp)
+
+		foundEcho := false
+		foundCustom := false
+		for _, command := range listCommands {
+			if command.Trigger == "echo" {
+				foundEcho = true
+			}
+			if command.Trigger == "custom_command" {
+				foundCustom = true
+			}
+		}
+		if !foundEcho {
+			t.Fatal("Couldn't find echo command")
+		}
+		if foundCustom {
+			t.Fatal("Should not list the custom command")
+		}
+	})
+}