Commitb539ddc

committed

chore: adding clarity around soft-deletion constraints

Signed-off-by: Danny Kopping <dannykopping@gmail.com>

1 parent9e8bf7e commitb539ddcCopy full SHA for b539ddc

File tree

+10

-1

lines changed

+10

-1

lines changed

Lines changed: 2 additions & 0 deletions

Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,7 @@ FROM templates t`
`41`	`41`	`INNER JOIN template_version_presets tvpONtvp.template_version_id=tv.id`
`42`	`42`	`INNER JOIN organizations oONo.id=t.organization_id`
`43`	`43`	`WHEREtvp.desired_instancesIS NOT NULL-- Consider only presets that have a prebuild configuration.`
	`44`	`+-- AND NOT t.deleted -- We don't exclude deleted templates because there's no constraint in the DB preventing a soft deletion on a template while workspaces are running.`
`44`	`45`	`AND (t.id=sqlc.narg('template_id')::uuidORsqlc.narg('template_id') ISNULL);`
`45`	`46`
`46`	`47`	`-- name: GetRunningPrebuiltWorkspaces :many`
`@@ -71,6 +72,7 @@ FROM workspace_latest_builds wlb`
`71`	`72`	`-- prebuilds that are still building.`
`72`	`73`	`INNER JOIN templates tONt.active_version_id=wlb.template_version_id`
`73`	`74`	`WHEREwlb.job_statusIN ('pending'::provisioner_job_status,'running'::provisioner_job_status)`
	`75`	`+-- AND NOT t.deleted -- We don't exclude deleted templates because there's no constraint in the DB preventing a soft deletion on a template while workspaces are running.`
`74`	`76`	`GROUP BYt.id,wpb.template_version_id,wpb.transition,wlb.template_version_preset_id;`
`75`	`77`
`76`	`78`	`-- GetPresetsBackoff groups workspace builds by preset ID.`

Lines changed: 6 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -294,10 +294,15 @@ func TestPrebuildReconciliation(t *testing.T) {`
`294`	`294`	`templateDeleted: []bool{false},`
`295`	`295`	`},`
`296`	`296`	`{`
`297`		`-name:"delete prebuilds for deleted templates",`
	`297`	+// Templates can be soft-deleted (`deleted=true`) or hard-deleted (row is removed).
	`298`	`+// On the former there is no DB constraint to prevent soft deletion, so we have to ensure that if somehow`
	`299`	`+// the template was soft-deleted any running prebuilds will be removed.`
	`300`	`+// On the latter there is a DB constraint to prevent row deletion if any workspaces reference the deleting template.`
	`301`	`+name:"soft-deleted templates MAY have prebuilds",`
`298`	`302`	`prebuildLatestTransitions: []database.WorkspaceTransition{database.WorkspaceTransitionStart},`
`299`	`303`	`prebuildJobStatuses: []database.ProvisionerJobStatus{database.ProvisionerJobStatusSucceeded},`
`300`	`304`	`templateVersionActive: []bool{true,false},`
	`305`	`+shouldCreateNewPrebuild:ptr.To(false),`
`301`	`306`	`shouldDeleteOldPrebuild:ptr.To(true),`
`302`	`307`	`templateDeleted: []bool{true},`
`303`	`308`	`},`

Comments

(0)