chore: add group_ids filter to /groups endpoint

Allow filtering groups by IDs.
coder · Emyrk · Sep 16, 2024 · Sep 16, 2024 · Sep 16, 2024 · 49c7997b7fc9a1651362063911ad074aa48ac8e1
commit 49c7997b7fc9a1651362063911ad074aa48ac8e1
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
@@ -2714,6 +2714,12 @@ func (q *FakeQuerier) GetGroups(_ context.Context, arg database.GetGroupsParams)
 	orgDetailsCache := make(map[uuid.UUID]struct{ name, displayName string })
 	filtered := make([]database.GetGroupsRow, 0)
 	for _, group := range q.groups {
+		if len(arg.GroupIds) > 0 {
+			if !slices.Contains(arg.GroupIds, group.ID) {
+				continue
+			}
+		}
+
 		if arg.OrganizationID != uuid.Nil && group.OrganizationID != arg.OrganizationID {
 			continue
 		}

diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/groups.sql b/coderd/database/queries/groups.sql
@@ -56,6 +56,10 @@ WHERE
 				groups.name = ANY(@group_names)
 			ELSE true
 		END
+		AND CASE WHEN array_length(@group_ids :: uuid[], 1) > 0  THEN
+				groups.id = ANY(@group_ids)
+			ELSE true
+		END
 ;
 
 -- name: InsertGroup :one

diff --git a/codersdk/groups.go b/codersdk/groups.go
@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"net/http"
 	"net/url"
+	"strings"
 
 	"github.com/google/uuid"
 	"golang.org/x/xerrors"
@@ -74,6 +75,9 @@ type GroupArguments struct {
 	Organization string
 	// HasMember can be a user uuid or username
 	HasMember string
+	// GroupIDs is a list of group UUIDs to filter by.
+	// If not set, all groups will be returned.
+	GroupIDs []uuid.UUID
 }
 
 func (c *Client) Groups(ctx context.Context, args GroupArguments) ([]Group, error) {
@@ -84,6 +88,13 @@ func (c *Client) Groups(ctx context.Context, args GroupArguments) ([]Group, erro
 	if args.HasMember != "" {
 		qp.Set("has_member", args.HasMember)
 	}
+	if len(args.GroupIDs) > 0 {
+		idStrs := make([]string, 0, len(args.GroupIDs))
+		for _, id := range args.GroupIDs {
+			idStrs = append(idStrs, id.String())
+		}
+		qp.Set("group_ids", strings.Join(idStrs, ","))
+	}
 
 	res, err := c.Request(ctx, http.MethodGet,
 		fmt.Sprintf("/api/v2/groups?%s", qp.Encode()),

diff --git a/docs/reference/api/enterprise.md b/docs/reference/api/enterprise.md
diff --git a/enterprise/coderd/groups.go b/enterprise/coderd/groups.go
@@ -430,6 +430,7 @@ func (api *API) groupsByOrganization(rw http.ResponseWriter, r *http.Request) {
 // @Tags Enterprise
 // @Param organization query string true "Organization ID or name"
 // @Param has_member query string true "User ID or name"
+// @Param group_ids query string true "Comma separated list of group IDs"
 // @Success 200 {array} codersdk.Group
 // @Router /groups [get]
 func (api *API) groups(rw http.ResponseWriter, r *http.Request) {
@@ -457,6 +458,9 @@ func (api *API) groups(rw http.ResponseWriter, r *http.Request) {
 		}
 		return user.ID, nil
 	})
+
+	filter.GroupIds = parser.UUIDs(r.URL.Query(), []uuid.UUID{}, "group_ids")
+
 	parser.ErrorExcessParams(r.URL.Query())
 	if len(parser.Errors) > 0 {
 		httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{

diff --git a/enterprise/coderd/groups_test.go b/enterprise/coderd/groups_test.go
@@ -779,6 +779,45 @@ func TestGroup(t *testing.T) {
 		require.Contains(t, group.Members, user2.ReducedUser)
 	})
 
+	t.Run("ByIDs", func(t *testing.T) {
+		t.Parallel()
+
+		client, user := coderdenttest.New(t, &coderdenttest.Options{LicenseOptions: &coderdenttest.LicenseOptions{
+			Features: license.Features{
+				codersdk.FeatureTemplateRBAC: 1,
+			},
+		}})
+		userAdminClient, _ := coderdtest.CreateAnotherUser(t, client, user.OrganizationID, rbac.RoleUserAdmin())
+
+		ctx := testutil.Context(t, testutil.WaitLong)
+		groupA, err := userAdminClient.CreateGroup(ctx, user.OrganizationID, codersdk.CreateGroupRequest{
+			Name: "group-a",
+		})
+		require.NoError(t, err)
+
+		groupB, err := userAdminClient.CreateGroup(ctx, user.OrganizationID, codersdk.CreateGroupRequest{
+			Name: "group-b",
+		})
+		require.NoError(t, err)
+
+		// group-c should be omitted from the filter
+		_, err = userAdminClient.CreateGroup(ctx, user.OrganizationID, codersdk.CreateGroupRequest{
+			Name: "group-c",
+		})
+		require.NoError(t, err)
+
+		found, err := userAdminClient.Groups(ctx, codersdk.GroupArguments{
+			GroupIDs: []uuid.UUID{groupA.ID, groupB.ID},
+		})
+		require.NoError(t, err)
+
+		foundIDs := db2sdk.List(found, func(g codersdk.Group) uuid.UUID {
+			return g.ID
+		})
+
+		require.ElementsMatch(t, []uuid.UUID{groupA.ID, groupB.ID}, foundIDs)
+	})
+
 	t.Run("everyoneGroupReturnsEmpty", func(t *testing.T) {
 		t.Parallel()
 

diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts