feat: allow TemplateAdmin to delete prebuilds via auth layer #18333
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
e05480d to
db80b4d
Compare
db80b4d to
2ba15c5
Compare
johnstcn
reviewed
Jun 12, 2025
johnstcn
reviewed
Jun 12, 2025
johnstcn
reviewed
Jun 18, 2025
Comment on lines
498
to
502
| runningWorkspaces, err := db.GetRunningPrebuiltWorkspaces(ctx) | ||
| require.NoError(t, err) | ||
|
|
||
| prebuiltWorkspace, err := db.GetWorkspaceByID(ctx, runningWorkspaces[0].ID) | ||
| require.NoError(t, err) |
There was a problem hiding this comment.
You should also require there to be at least one running workspace. This may need to be done in a testutil.Eventually(ctx) to avoid potential flakiness.
…resolve import cycle
Emyrk
reviewed
Jun 18, 2025
Comment on lines
+278
to
+281
| // PrebuiltWorkspaces are a subset of Workspaces. | ||
| // Explicitly setting PrebuiltWorkspace permissions for clarity. | ||
| // Note: even without PrebuiltWorkspace permissions, access is still granted via Workspace permissions. | ||
| ResourcePrebuiltWorkspace.Type: {policy.ActionUpdate, policy.ActionDelete}, |
Comment on lines
+232
to
+249
| // IsPrebuild returns true if the workspace is a prebuild workspace. | ||
| // A workspace is considered a prebuild if its owner is the prebuild system user. | ||
| func (w Workspace) IsPrebuild() bool { | ||
| return w.OwnerID == PrebuildsSystemUserID | ||
| } | ||
|
|
||
| // AsPrebuild returns the RBAC object corresponding to the workspace type. | ||
| // If the workspace is a prebuild, it returns a prebuilt_workspace RBAC object. | ||
| // Otherwise, it returns a normal workspace RBAC object. | ||
| func (w Workspace) AsPrebuild() rbac.Object { | ||
| if w.IsPrebuild() { | ||
| return rbac.ResourcePrebuiltWorkspace.WithID(w.ID). | ||
| InOrg(w.OrganizationID). | ||
| WithOwner(w.OwnerID.String()) | ||
| } | ||
| return w.RBACObject() | ||
| } | ||
|
|
There was a problem hiding this comment.
Helps to have it on the table type too.
Suggested change
| // IsPrebuild returns true if the workspace is a prebuild workspace. | |
| // A workspace is considered a prebuild if its owner is the prebuild system user. | |
| func (w Workspace) IsPrebuild() bool { | |
| return w.OwnerID == PrebuildsSystemUserID | |
| } | |
| // AsPrebuild returns the RBAC object corresponding to the workspace type. | |
| // If the workspace is a prebuild, it returns a prebuilt_workspace RBAC object. | |
| // Otherwise, it returns a normal workspace RBAC object. | |
| func (w Workspace) AsPrebuild() rbac.Object { | |
| if w.IsPrebuild() { | |
| return rbac.ResourcePrebuiltWorkspace.WithID(w.ID). | |
| InOrg(w.OrganizationID). | |
| WithOwner(w.OwnerID.String()) | |
| } | |
| return w.RBACObject() | |
| } | |
| // IsPrebuild returns true if the workspace is a prebuild workspace. | |
| // A workspace is considered a prebuild if its owner is the prebuild system user. | |
| func (w Workspace) IsPrebuild() bool { | |
| return w.OwnerID == PrebuildsSystemUserID | |
| } | |
| func (w WorkspaceTable) IsPrebuild() bool { | |
| return w.OwnerID == PrebuildsSystemUserID | |
| } | |
| // AsPrebuild returns the RBAC object corresponding to the workspace type. | |
| // If the workspace is a prebuild, it returns a prebuilt_workspace RBAC object. | |
| // Otherwise, it returns a normal workspace RBAC object. | |
| func (w Workspace) AsPrebuild() rbac.Object { | |
| return w.WorkspaceTable().AsPrebuild() | |
| } | |
| func (w WorkspaceTable) AsPrebuild() rbac.Object { | |
| if w.IsPrebuild() { | |
| return rbac.ResourcePrebuiltWorkspace.WithID(w.ID). | |
| InOrg(w.OrganizationID). | |
| WithOwner(w.OwnerID.String()) | |
| } | |
| return w.RBACObject() | |
| } |
| // authorization. | ||
| // Note: Delete operations of workspaces requires both update and delete | ||
| // permissions. | ||
| func (q *querier) authorizePrebuiltWorkspace(ctx context.Context, action policy.Action, workspace database.Workspace) error { |
There was a problem hiding this comment.
You can add this dbauthz_test to assert the delete on the prebuild is sufficient to run this workspace delete build
s.Run("PrebuildDelete/InsertWorkspaceBuild", s.Subtest(func(db database.Store, check *expects) {
u := dbgen.User(s.T(), db, database.User{})
o := dbgen.Organization(s.T(), db, database.Organization{})
tpl := dbgen.Template(s.T(), db, database.Template{
OrganizationID: o.ID,
CreatedBy: u.ID,
})
w := dbgen.Workspace(s.T(), db, database.WorkspaceTable{
TemplateID: tpl.ID,
OrganizationID: o.ID,
OwnerID: database.PrebuildsSystemUserID,
})
pj := dbgen.ProvisionerJob(s.T(), db, nil, database.ProvisionerJob{
OrganizationID: o.ID,
})
tv := dbgen.TemplateVersion(s.T(), db, database.TemplateVersion{
TemplateID: uuid.NullUUID{UUID: tpl.ID, Valid: true},
OrganizationID: o.ID,
CreatedBy: u.ID,
})
check.Args(database.InsertWorkspaceBuildParams{
WorkspaceID: w.ID,
Transition: database.WorkspaceTransitionDelete,
Reason: database.BuildReasonInitiator,
TemplateVersionID: tv.ID,
JobID: pj.ID,
}).Asserts(w.AsPrebuild(), policy.ActionDelete)
}))
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds support for deleting prebuilt workspaces via the authorization layer. It introduces special-case handling to ensure that
prebuilt_workspacepermissions are evaluated when attempting to delete a prebuilt workspace, falling back to the standardworkspaceresource as needed.Prebuilt workspaces are a subset of workspaces, identified by having
owner_idset toPREBUILD_SYSTEM_USER.This means:
prebuilt_workspace.deletepermission is allowed to delete only prebuilt workspaces.workspace.deletepermission can delete both normal and prebuilt workspaces.prebuilt_workspaceresource.To delete a workspace, users must have the following permissions:
workspace.read: to read the current workspace stateupdate: to modify workspace metadata and related resources during deletion (e.g., updating thedeletedfield in the database)delete: to perform the actual deletion of the workspaceChanges
authorizeWorkspace()helper to handle prebuilt workspace authorization logic.prebuilt_workspaceandworkspacepermissions are checked.SystemUserIDconstant from theprebuildspackage to thedatabasepackagePrebuildsSystemUserIDto resolve an import cycle (commit f24e4ab).