Skip to content

chore: remove UpsertCustomRole in favor of Insert + Update #14217

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Aug 13, 2024
Merged

chore: remove UpsertCustomRole in favor of Insert + Update #14217

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
b1776c1
chore: remove UpsertCustomRole in favor of Insert + Update
Emyrk Aug 8, 2024
f4d504e
fixup tests and include migrations
Emyrk Aug 8, 2024
8b71ecf
update enterprise api endpoints
Emyrk Aug 8, 2024
e6282d0
fixup codersdk
Emyrk Aug 8, 2024
52e7ea5
fixup cli
Emyrk Aug 8, 2024
fb546df
make gen
Emyrk Aug 8, 2024
82ce462
make gen
Emyrk Aug 8, 2024
b49b713
fix tests
Emyrk Aug 8, 2024
e53fabd
make gen
Emyrk Aug 8, 2024
954f0d2
Test updates
Emyrk Aug 8, 2024
7e18088
fix: use insert and delete instead of upsert for custom roles (#14252)
jaaydenh Aug 13, 2024
2d81996
make gen
Emyrk Aug 13, 2024
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
Prev Previous commit
Next Next commit
update enterprise api endpoints
  • Loading branch information
@Emyrk
Emyrk committed Aug 13, 2024
commit 8b71ecf4ffcf5a951f79e3cdebb5019efbe81f05
4 changes: 2 additions & 2 deletions enterprise/coderd/coderd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,8 +269,8 @@ func New(ctx context.Context, options *Options) (_ *API, err error) {
httpmw.RequireExperiment(api.AGPL.Experiments, codersdk.ExperimentCustomRoles),
httpmw.ExtractOrganizationParam(api.Database),
)
r.Post("/organizations/{organization}/members/roles", api.patchOrgRoles)
r.Put("/organizations/{organization}/members/roles", api.patchOrgRoles)
r.Post("/organizations/{organization}/members/roles", api.postOrgRoles)
r.Put("/organizations/{organization}/members/roles", api.putOrgRoles)
r.Delete("/organizations/{organization}/members/roles/{roleName}", api.deleteOrgRole)
})

Expand Down
66 changes: 7 additions & 59 deletions enterprise/coderd/roles.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ func (api *API) postOrgRoles(rw http.ResponseWriter, r *http.Request) {
Audit: *auditor,
Log: api.Logger,
Request: r,
Action: database.AuditActionWrite,
Action: database.AuditActionCreate,
OrganizationID: organization.ID,
})
)
Expand All @@ -55,28 +55,7 @@ func (api *API) postOrgRoles(rw http.ResponseWriter, r *http.Request) {
return
}

originalRoles, err := db.CustomRoles(ctx, database.CustomRolesParams{
LookupRoles: []database.NameOrganizationPair{
{
Name: req.Name,
OrganizationID: organization.ID,
},
},
ExcludeOrgRoles: false,
// Linter requires all fields to be set. This field is not actually required.
OrganizationID: organization.ID,
})
// If it is a 404 (not found) error, ignore it.
if err != nil && !httpapi.Is404Error(err) {
httpapi.InternalServerError(rw, err)
return
}
if len(originalRoles) == 1 {
// For auditing changes to a role.
aReq.Old = originalRoles[0]
}

inserted, err := db.UpsertCustomRole(ctx, database.UpsertCustomRoleParams{
inserted, err := db.InsertCustomRole(ctx, database.InsertCustomRoleParams{
Name: req.Name,
DisplayName: req.DisplayName,
OrganizationID: uuid.NullUUID{
Expand Down Expand Up @@ -115,7 +94,7 @@ func (api *API) postOrgRoles(rw http.ResponseWriter, r *http.Request) {
// @Tags Members
// @Success 200 {array} codersdk.Role
// @Router /organizations/{organization}/members/roles [patch]
func (api *API) patchOrgRoles(rw http.ResponseWriter, r *http.Request) {
func (api *API) putOrgRoles(rw http.ResponseWriter, r *http.Request) {
var (
ctx = r.Context()
db = api.Database
Expand All @@ -136,38 +115,7 @@ func (api *API) patchOrgRoles(rw http.ResponseWriter, r *http.Request) {
return
}

// This check is not ideal, but we cannot enforce a unique role name in the db against
// the built-in role names.
if rbac.ReservedRoleName(req.Name) {
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
Message: "Reserved role name",
Detail: fmt.Sprintf("%q is a reserved role name, and not allowed to be used", req.Name),
})
return
}

if err := httpapi.NameValid(req.Name); err != nil {
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
Message: "Invalid role name",
Detail: err.Error(),
})
return
}

// Only organization permissions are allowed to be granted
if len(req.SitePermissions) > 0 {
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
Message: "Invalid request, not allowed to assign site wide permissions for an organization role.",
Detail: "organization scoped roles may not contain site wide permissions",
})
return
}

if len(req.UserPermissions) > 0 {
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
Message: "Invalid request, not allowed to assign user permissions for an organization role.",
Detail: "organization scoped roles may not contain user permissions",
})
if !validOrganizationRoleRequest(ctx, req, rw) {
return
}

Expand All @@ -192,7 +140,7 @@ func (api *API) patchOrgRoles(rw http.ResponseWriter, r *http.Request) {
aReq.Old = originalRoles[0]
}

inserted, err := db.UpsertCustomRole(ctx, database.UpsertCustomRoleParams{
updated, err := db.UpdateCustomRole(ctx, database.UpdateCustomRoleParams{
Name: req.Name,
DisplayName: req.DisplayName,
OrganizationID: uuid.NullUUID{
Expand All @@ -214,9 +162,9 @@ func (api *API) patchOrgRoles(rw http.ResponseWriter, r *http.Request) {
})
return
}
aReq.New = inserted
aReq.New = updated

httpapi.Write(ctx, rw, http.StatusOK, db2sdk.Role(inserted))
httpapi.Write(ctx, rw, http.StatusOK, db2sdk.Role(updated))
}

// deleteOrgRole will remove a custom role from an organization
Expand Down