opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(coderd): add ability to search org members by user_id, is_system, github_user_id (#20048)

Browse Source 
Adds the ability to search org members by query.
Supported fields: `user_id`, `is_system`, `github_user_id`.
This commit is contained in:
Cian Johnston
2025-09-30 23:54:21 +01:00
committed by GitHub
parent 4db5158aed
commit ff930ad4f3
13 changed files with 203 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
coderd/database/dbauthz/dbauthz.go
+2
View File
@@ -1691,6 +1691,7 @@ func (q *querier) DeleteOrganizationMember(ctx context.Context, arg database.Del
OrganizationID: arg.OrganizationID,
UserID: arg.UserID,
IncludeSystem: false,
GithubUserID: 0,
}))
if err != nil {
return database.OrganizationMember{}, err
@@ -4694,6 +4695,7 @@ func (q *querier) UpdateMemberRoles(ctx context.Context, arg database.UpdateMemb
OrganizationID: arg.OrgID,
UserID: arg.UserID,
IncludeSystem: false,
GithubUserID: 0,
}))
if err != nil {
return database.OrganizationMember{}, err
coderd/database/queries.sql.go
+13 -1
View File
@@ -7142,12 +7142,19 @@ WHERE
ELSE
is_system = false
END
-- Filter by github user ID. Note that this requires a join on the users table.
AND CASE
WHEN $4 :: bigint != 0 THEN
users.github_com_user_id = $4
ELSE true
END
`
type OrganizationMembersParams struct {
OrganizationID uuid.UUID `db:"organization_id" json:"organization_id"`
UserID uuid.UUID `db:"user_id" json:"user_id"`
IncludeSystem bool `db:"include_system" json:"include_system"`
GithubUserID int64 `db:"github_user_id" json:"github_user_id"`
}
type OrganizationMembersRow struct {
@@ -7164,7 +7171,12 @@ type OrganizationMembersRow struct {
// - Use just 'user_id' to get all orgs a user is a member of
// - Use both to get a specific org member row
func (q *sqlQuerier) OrganizationMembers(ctx context.Context, arg OrganizationMembersParams) ([]OrganizationMembersRow, error) {
rows, err := q.db.QueryContext(ctx, organizationMembers, arg.OrganizationID, arg.UserID, arg.IncludeSystem)
rows, err := q.db.QueryContext(ctx, organizationMembers,
arg.OrganizationID,
arg.UserID,
arg.IncludeSystem,
arg.GithubUserID,
)
if err != nil {
return nil, err
}
coderd/database/queries/organizationmembers.sql
+7 -1
View File
@@ -28,7 +28,13 @@ WHERE
WHEN @include_system::bool THEN TRUE
ELSE
is_system = false
END;
END
-- Filter by github user ID. Note that this requires a join on the users table.
AND CASE
WHEN @github_user_id :: bigint != 0 THEN
users.github_com_user_id = @github_user_id
ELSE true
END;
-- name: InsertOrganizationMember :one
INSERT INTO
coderd/dynamicparameters/render.go
+1
View File
@@ -300,6 +300,7 @@ func WorkspaceOwner(ctx context.Context, db database.Store, org uuid.UUID, owner
OrganizationID: org,
UserID: ownerID,
IncludeSystem: true,
GithubUserID: 0,
}))
if err != nil {
return nil, xerrors.Errorf("fetch user: %w", err)
coderd/httpmw/organizationparam.go
+1
View File
@@ -181,6 +181,7 @@ func ExtractOrganizationMember(ctx context.Context, auth func(r *http.Request, a
OrganizationID: orgID,
UserID: user.ID,
IncludeSystem: true,
GithubUserID: 0,
})
if httpapi.Is404Error(err) {
httpapi.ResourceNotFound(rw)
coderd/idpsync/role.go
+1
View File
@@ -93,6 +93,7 @@ func (s AGPLIDPSync) SyncRoles(ctx context.Context, db database.Store, user data
OrganizationID: uuid.Nil,
UserID: user.ID,
IncludeSystem: false,
GithubUserID: 0,
})
if err != nil {
return xerrors.Errorf("get organizations by user id: %w", err)
coderd/members.go
+11 -5
View File
@@ -16,6 +16,7 @@ import (
"github.com/coder/coder/v2/coderd/httpapi"
"github.com/coder/coder/v2/coderd/httpmw"
"github.com/coder/coder/v2/coderd/rbac"
"github.com/coder/coder/v2/coderd/searchquery"
"github.com/coder/coder/v2/codersdk"
)
@@ -158,11 +159,16 @@ func (api *API) listMembers(rw http.ResponseWriter, r *http.Request) {
organization = httpmw.OrganizationParam(r)
)
members, err := api.Database.OrganizationMembers(ctx, database.OrganizationMembersParams{
OrganizationID: organization.ID,
UserID: uuid.Nil,
IncludeSystem: false,
})
params, errors := searchquery.Members(r.URL.Query().Get("q"), organization.ID)
if len(errors) > 0 {
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
Message: "Invalid organization member search query.",
Validations: errors,
})
return
}
members, err := api.Database.OrganizationMembers(ctx, params)
if httpapi.Is404Error(err) {
httpapi.ResourceNotFound(rw)
return
coderd/members_test.go
+55 -8
View File
@@ -1,14 +1,16 @@
package coderd_test
import (
"database/sql"
"testing"
"github.com/google/uuid"
"github.com/stretchr/testify/require"
"github.com/coder/coder/v2/coderd/coderdtest"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/db2sdk"
"github.com/coder/coder/v2/coderd/rbac"
"github.com/coder/coder/v2/coderd/database/dbgen"
"github.com/coder/coder/v2/codersdk"
"github.com/coder/coder/v2/testutil"
)
@@ -52,19 +54,64 @@ func TestDeleteMember(t *testing.T) {
func TestListMembers(t *testing.T) {
t.Parallel()
client, db := coderdtest.NewWithDatabase(t, nil)
owner := coderdtest.CreateFirstUser(t, client)
_, orgMember := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID)
_, orgAdmin := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID)
anotherOrg := dbgen.Organization(t, db, database.Organization{})
anotherUser := dbgen.User(t, db, database.User{
GithubComUserID: sql.NullInt64{Valid: true, Int64: 12345},
})
_ = dbgen.OrganizationMember(t, db, database.OrganizationMember{
OrganizationID: anotherOrg.ID,
UserID: anotherUser.ID,
})
t.Run("OK", func(t *testing.T) {
t.Parallel()
owner := coderdtest.New(t, nil)
first := coderdtest.CreateFirstUser(t, owner)
client, user := coderdtest.CreateAnotherUser(t, owner, first.OrganizationID, rbac.ScopedRoleOrgAdmin(first.OrganizationID))
ctx := testutil.Context(t, testutil.WaitShort)
members, err := client.OrganizationMembers(ctx, first.OrganizationID)
members, err := client.OrganizationMembers(ctx, owner.OrganizationID)
require.NoError(t, err)
require.Len(t, members, 2)
require.Len(t, members, 3)
require.ElementsMatch(t,
[]uuid.UUID{first.UserID, user.ID},
[]uuid.UUID{owner.UserID, orgMember.ID, orgAdmin.ID},
db2sdk.List(members, onlyIDs))
})
t.Run("UserID", func(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
members, err := client.OrganizationMembers(ctx, owner.OrganizationID, codersdk.OrganizationMembersQueryOptionUserID(orgMember.ID))
require.NoError(t, err)
require.Len(t, members, 1)
require.ElementsMatch(t,
[]uuid.UUID{orgMember.ID},
db2sdk.List(members, onlyIDs))
})
t.Run("IncludeSystem", func(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
members, err := client.OrganizationMembers(ctx, owner.OrganizationID, codersdk.OrganizationMembersQueryOptionIncludeSystem())
require.NoError(t, err)
require.Len(t, members, 4)
require.ElementsMatch(t,
[]uuid.UUID{owner.UserID, orgMember.ID, orgAdmin.ID, database.PrebuildsSystemUserID},
db2sdk.List(members, onlyIDs))
})
t.Run("GithubUserID", func(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
members, err := client.OrganizationMembers(ctx, anotherOrg.ID, codersdk.OrganizationMembersQueryOptionGithubUserID(anotherUser.GithubComUserID.Int64))
require.NoError(t, err)
require.Len(t, members, 1)
require.ElementsMatch(t,
[]uuid.UUID{anotherUser.ID},
db2sdk.List(members, onlyIDs))
})
}
coderd/searchquery/search.go
+44
View File
@@ -170,6 +170,50 @@ func Users(query string) (database.GetUsersParams, []codersdk.ValidationError) {
return filter, parser.Errors
}
func Members(query string, organizationID uuid.UUID) (database.OrganizationMembersParams, []codersdk.ValidationError) {
query = strings.TrimSpace(query)
if query == "" {
return database.OrganizationMembersParams{
OrganizationID: organizationID,
UserID: uuid.Nil,
IncludeSystem: false,
GithubUserID: 0,
}, nil
}
values, errors := searchTerms(query, func(term string, values url.Values) error {
switch term {
case "user_id":
values.Set("user_id", "")
case "github_user_id":
values.Set("github_user_id", "")
case "include_system":
values.Set("include_system", "")
default:
return xerrors.Errorf("invalid search term: %s", term)
}
return nil
})
if len(errors) > 0 {
return database.OrganizationMembersParams{
OrganizationID: organizationID,
UserID: uuid.Nil,
IncludeSystem: false,
GithubUserID: 0,
}, errors
}
parser := httpapi.NewQueryParamParser()
params := database.OrganizationMembersParams{
OrganizationID: organizationID,
UserID: parser.UUID(values, uuid.Nil, "user_id"),
IncludeSystem: parser.Boolean(values, false, "include_system"),
GithubUserID: parser.Int64(values, 0, "github_user_id"),
}
parser.ErrorExcessParams(values)
return params, parser.Errors
}
func Workspaces(ctx context.Context, db database.Store, query string, page codersdk.Pagination, agentInactiveDisconnectTimeout time.Duration) (database.GetWorkspacesParams, []codersdk.ValidationError) {
filter := database.GetWorkspacesParams{
AgentInactiveDisconnectTimeoutSeconds: int64(agentInactiveDisconnectTimeout.Seconds()),
coderd/users.go
+1
View File
@@ -1236,6 +1236,7 @@ func (api *API) userRoles(rw http.ResponseWriter, r *http.Request) {
UserID: user.ID,
OrganizationID: uuid.Nil,
IncludeSystem: false,
GithubUserID: 0,
})
if err != nil {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{