Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
johnstcn merged 4 commits intomainfromcj/org-members-query-params
Sep 30, 2025
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletionscoderd/database/dbauthz/dbauthz.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand DownExpand Up@@ -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
Expand Down
14 changes: 13 additions & 1 deletioncoderd/database/queries.sql.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.

8 changes: 7 additions & 1 deletioncoderd/database/queries/organizationmembers.sql
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand Down
1 change: 1 addition & 0 deletionscoderd/dynamicparameters/render.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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)
Expand Down
1 change: 1 addition & 0 deletionscoderd/httpmw/organizationparam.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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)
Expand Down
1 change: 1 addition & 0 deletionscoderd/idpsync/role.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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)
Expand Down
16 changes: 11 additions & 5 deletionscoderd/members.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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"
)

Expand DownExpand Up@@ -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
Expand Down
61 changes: 54 additions & 7 deletionscoderd/members_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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"
)
Expand DownExpand Up@@ -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, owner.OrganizationID)
require.NoError(t, err)
require.Len(t, members, 3)
require.ElementsMatch(t,
[]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,first.OrganizationID)
members, err := client.OrganizationMembers(ctx,anotherOrg.ID, codersdk.OrganizationMembersQueryOptionGithubUserID(anotherUser.GithubComUserID.Int64))
require.NoError(t, err)
require.Len(t, members,2)
require.Len(t, members,1)
require.ElementsMatch(t,
[]uuid.UUID{first.UserID, user.ID},
[]uuid.UUID{anotherUser.ID},
db2sdk.List(members, onlyIDs))
})
}
Expand Down
44 changes: 44 additions & 0 deletionscoderd/searchquery/search.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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()),
Expand Down
1 change: 1 addition & 0 deletionscoderd/users.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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{
Expand Down
61 changes: 59 additions & 2 deletionscodersdk/users.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import (
"encoding/json"
"fmt"
"net/http"
"strconv"
"strings"
"time"

Expand DownExpand Up@@ -554,9 +555,65 @@ func (c *Client) DeleteOrganizationMember(ctx context.Context, organizationID uu
return nil
}

type OrganizationMembersQuery struct {
UserID uuid.UUID
IncludeSystem bool
GithubUserID int64
}

func (omq OrganizationMembersQuery) AsRequestOption() RequestOption {
return func(r *http.Request) {
q := r.URL.Query()
var sb strings.Builder
if omq.UserID != uuid.Nil {
_, _ = sb.WriteString("user_id:")
_, _ = sb.WriteString(omq.UserID.String())
_, _ = sb.WriteString(" ")
}
if omq.IncludeSystem {
_, _ = sb.WriteString("include_system:true")
}
if omq.GithubUserID != 0 {
_, _ = sb.WriteString("github_user_id:")
_, _ = sb.WriteString(strconv.FormatInt(omq.GithubUserID, 10))
_, _ = sb.WriteString(" ")
}
qs := strings.TrimSpace(sb.String())
if len(qs) == 0 {
return
}
q.Set("q", qs)
r.URL.RawQuery = q.Encode()
}
}

type OrganizationMembersQueryOption func(*OrganizationMembersQuery)

func OrganizationMembersQueryOptionUserID(userID uuid.UUID) OrganizationMembersQueryOption {
return func(query *OrganizationMembersQuery) {
query.UserID = userID
}
}

func OrganizationMembersQueryOptionIncludeSystem() OrganizationMembersQueryOption {
return func(query *OrganizationMembersQuery) {
query.IncludeSystem = true
}
}

func OrganizationMembersQueryOptionGithubUserID(githubUserID int64) OrganizationMembersQueryOption {
return func(query *OrganizationMembersQuery) {
query.GithubUserID = githubUserID
}
}

// OrganizationMembers lists all members in an organization
func (c *Client) OrganizationMembers(ctx context.Context, organizationID uuid.UUID) ([]OrganizationMemberWithUserData, error) {
res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/organizations/%s/members/", organizationID), nil)
func (c *Client) OrganizationMembers(ctx context.Context, organizationID uuid.UUID, opts ...OrganizationMembersQueryOption) ([]OrganizationMemberWithUserData, error) {
var query OrganizationMembersQuery
for _, opt := range opts {
opt(&query)
}
res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/organizations/%s/members/", organizationID), nil, query.AsRequestOption())
if err != nil {
return nil, err
}
Expand Down
1 change: 1 addition & 0 deletionsenterprise/coderd/groups.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,7 @@ func (api *API) patchGroup(rw http.ResponseWriter, r *http.Request) {
OrganizationID: group.OrganizationID,
UserID: uuid.MustParse(id),
IncludeSystem: false,
GithubUserID: 0,
}))
if errors.Is(err, sql.ErrNoRows) {
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
Expand Down
7 changes: 7 additions & 0 deletionssite/src/api/typesGenerated.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.

Loading
[8]ページ先頭
©2009-2025 Movatter.jp