chore: implement filters for the organizations query

Emyrk · Emyrk · commit ba492b206635 · 2024-08-28T11:12:28.000-05:00
diff --git a/cli/server_createadminuser.go b/cli/server_createadminuser.go
@@ -176,7 +176,7 @@ func (r *RootCmd) newCreateAdminUserCommand() *serpent.Command {
 			// Create the user.
 			var newUser database.User
 			err = db.InTx(func(tx database.Store) error {
-				orgs, err := tx.GetOrganizations(ctx)
+				orgs, err := tx.GetOrganizations(ctx, database.GetOrganizationsParams{})
 				if err != nil {
 					return xerrors.Errorf("get organizations: %w", err)
 				}
diff --git a/cli/server_createadminuser_test.go b/cli/server_createadminuser_test.go
@@ -60,7 +60,7 @@ func TestServerCreateAdminUser(t *testing.T) {
 		require.EqualValues(t, []string{codersdk.RoleOwner}, user.RBACRoles, "user does not have owner role")
 
 		// Check that user is admin in every org.
-		orgs, err := db.GetOrganizations(ctx)
+		orgs, err := db.GetOrganizations(ctx, database.GetOrganizationsParams{})
 		require.NoError(t, err)
 		orgIDs := make(map[uuid.UUID]struct{}, len(orgs))
 		for _, org := range orgs {
diff --git a/coderd/database/dbauthz/dbauthz.go b/coderd/database/dbauthz/dbauthz.go
@@ -1700,9 +1700,9 @@ func (q *querier) GetOrganizationIDsByMemberIDs(ctx context.Context, ids []uuid.
 	return fetchWithPostFilter(q.auth, policy.ActionRead, q.db.GetOrganizationIDsByMemberIDs)(ctx, ids)
 }
 
-func (q *querier) GetOrganizations(ctx context.Context) ([]database.Organization, error) {
+func (q *querier) GetOrganizations(ctx context.Context, args database.GetOrganizationsParams) ([]database.Organization, error) {
 	fetch := func(ctx context.Context, _ interface{}) ([]database.Organization, error) {
-		return q.db.GetOrganizations(ctx)
+		return q.db.GetOrganizations(ctx, args)
 	}
 	return fetchWithPostFilter(q.auth, policy.ActionRead, fetch)(ctx, nil)
 }
diff --git a/coderd/database/dbauthz/dbauthz_test.go b/coderd/database/dbauthz/dbauthz_test.go
@@ -635,7 +635,7 @@ func (s *MethodTestSuite) TestOrganization() {
 		def, _ := db.GetDefaultOrganization(context.Background())
 		a := dbgen.Organization(s.T(), db, database.Organization{})
 		b := dbgen.Organization(s.T(), db, database.Organization{})
-		check.Args().Asserts(def, policy.ActionRead, a, policy.ActionRead, b, policy.ActionRead).Returns(slice.New(def, a, b))
+		check.Args(database.GetOrganizationsParams{}).Asserts(def, policy.ActionRead, a, policy.ActionRead, b, policy.ActionRead).Returns(slice.New(def, a, b))
 	}))
 	s.Run("GetOrganizationsByUserID", s.Subtest(func(db database.Store, check *expects) {
 		u := dbgen.User(s.T(), db, database.User{})
diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
@@ -3034,14 +3034,24 @@ func (q *FakeQuerier) GetOrganizationIDsByMemberIDs(_ context.Context, ids []uui
 	return getOrganizationIDsByMemberIDRows, nil
 }
 
-func (q *FakeQuerier) GetOrganizations(_ context.Context) ([]database.Organization, error) {
+func (q *FakeQuerier) GetOrganizations(_ context.Context, args database.GetOrganizationsParams) ([]database.Organization, error) {
 	q.mutex.RLock()
 	defer q.mutex.RUnlock()
 
-	if len(q.organizations) == 0 {
-		return nil, sql.ErrNoRows
+	tmp := make([]database.Organization, 0)
+	for _, org := range q.organizations {
+		if len(args.IDs) > 0 {
+			if !slices.Contains(args.IDs, org.ID) {
+				continue
+			}
+		}
+		if args.Name != "" && !strings.EqualFold(org.Name, args.Name) {
+			continue
+		}
+		tmp = append(tmp, org)
 	}
-	return q.organizations, nil
+
+	return tmp, nil
 }
 
 func (q *FakeQuerier) GetOrganizationsByUserID(_ context.Context, userID uuid.UUID) ([]database.Organization, error) {
@@ -3060,9 +3070,7 @@ func (q *FakeQuerier) GetOrganizationsByUserID(_ context.Context, userID uuid.UU
 			organizations = append(organizations, organization)
 		}
 	}
-	if len(organizations) == 0 {
-		return nil, sql.ErrNoRows
-	}
+
 	return organizations, nil
 }
 
diff --git a/coderd/database/dbmem/dbmem_test.go b/coderd/database/dbmem/dbmem_test.go
@@ -46,7 +46,7 @@ func TestInTx(t *testing.T) {
 	go func() {
 		<-inTx
 		for i := 0; i < 20; i++ {
-			orgs, err := uut.GetOrganizations(context.Background())
+			orgs, err := uut.GetOrganizations(context.Background(), database.GetOrganizationsParams{})
 			if err != nil {
 				assert.ErrorIs(t, err, sql.ErrNoRows)
 			}
diff --git a/coderd/database/dbmetrics/dbmetrics.go b/coderd/database/dbmetrics/dbmetrics.go
diff --git a/coderd/database/dbmock/dbmock.go b/coderd/database/dbmock/dbmock.go
diff --git a/coderd/database/querier.go b/coderd/database/querier.go
diff --git a/coderd/database/querier_test.go b/coderd/database/querier_test.go
@@ -516,7 +516,7 @@ func TestDefaultOrg(t *testing.T) {
 	ctx := context.Background()
 
 	// Should start with the default org
-	all, err := db.GetOrganizations(ctx)
+	all, err := db.GetOrganizations(ctx, database.GetOrganizationsParams{})
 	require.NoError(t, err)
 	require.Len(t, all, 1)
 	require.True(t, all[0].IsDefault, "first org should always be default")
@@ -1211,7 +1211,7 @@ func TestExpectOne(t *testing.T) {
 		dbgen.Organization(t, db, database.Organization{})
 
 		// Organizations is an easy table without foreign key dependencies
-		_, err = database.ExpectOne(db.GetOrganizations(ctx))
+		_, err = database.ExpectOne(db.GetOrganizations(ctx, database.GetOrganizationsParams{}))
 		require.ErrorContains(t, err, "too many rows returned")
 	})
 }
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/organizations.sql b/coderd/database/queries/organizations.sql
@@ -12,7 +12,21 @@ LIMIT
 SELECT
 	*
 FROM
-	organizations;
+	organizations
+WHERE
+	true
+	  -- Filter by ids
+	AND CASE
+		WHEN array_length(@ids :: uuid[], 1) > 0 THEN
+			id = ANY(@ids)
+		ELSE true
+	END
+  	AND CASE
+		  WHEN @name::text != '' THEN
+			  LOWER("name") = LOWER(@name)
+		  ELSE true
+	END
+;
 
 -- name: GetOrganizationByID :one
 SELECT
diff --git a/coderd/organizations.go b/coderd/organizations.go
@@ -3,6 +3,7 @@ package coderd
 import (
 	"net/http"
 
+	"github.com/coder/coder/v2/coderd/database"
 	"github.com/coder/coder/v2/coderd/database/db2sdk"
 	"github.com/coder/coder/v2/coderd/httpapi"
 	"github.com/coder/coder/v2/coderd/httpmw"
@@ -18,7 +19,7 @@ import (
 // @Router /organizations [get]
 func (api *API) organizations(rw http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
-	organizations, err := api.Database.GetOrganizations(ctx)
+	organizations, err := api.Database.GetOrganizations(ctx, database.GetOrganizationsParams{})
 	if httpapi.Is404Error(err) {
 		httpapi.ResourceNotFound(rw)
 		return

Original file line number	Diff line number	Diff line change
`@@ -176,7 +176,7 @@ func (r RootCmd) newCreateAdminUserCommand() serpent.Command {`
`176`	`176`	`// Create the user.`
`177`	`177`	`var newUser database.User`
`178`	`178`	`err = db.InTx(func(tx database.Store) error {`
`179`		`- orgs, err := tx.GetOrganizations(ctx)`
	`179`	`+ orgs, err := tx.GetOrganizations(ctx, database.GetOrganizationsParams{})`
`180`	`180`	`if err != nil {`
`181`	`181`	`return xerrors.Errorf("get organizations: %w", err)`
`182`	`182`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1700,9 +1700,9 @@ func (q *querier) GetOrganizationIDsByMemberIDs(ctx context.Context, ids []uuid.`
`1700`	`1700`	`return fetchWithPostFilter(q.auth, policy.ActionRead, q.db.GetOrganizationIDsByMemberIDs)(ctx, ids)`
`1701`	`1701`	`}`
`1702`	`1702`
`1703`		`-func (q *querier) GetOrganizations(ctx context.Context) ([]database.Organization, error) {`
	`1703`	`+func (q *querier) GetOrganizations(ctx context.Context, args database.GetOrganizationsParams) ([]database.Organization, error) {`
`1704`	`1704`	`fetch := func(ctx context.Context, _ interface{}) ([]database.Organization, error) {`
`1705`		`- return q.db.GetOrganizations(ctx)`
	`1705`	`+ return q.db.GetOrganizations(ctx, args)`
`1706`	`1706`	`}`
`1707`	`1707`	`return fetchWithPostFilter(q.auth, policy.ActionRead, fetch)(ctx, nil)`
`1708`	`1708`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ func TestInTx(t *testing.T) {`
`46`	`46`	`go func() {`
`47`	`47`	`<-inTx`
`48`	`48`	`for i := 0; i < 20; i++ {`
`49`		`- orgs, err := uut.GetOrganizations(context.Background())`
	`49`	`+ orgs, err := uut.GetOrganizations(context.Background(), database.GetOrganizationsParams{})`
`50`	`50`	`if err != nil {`
`51`	`51`	`assert.ErrorIs(t, err, sql.ErrNoRows)`
`52`	`52`	`}`