8000 feat: enable soft delete for organizations by jaaydenh · Pull Request #16584 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

feat: enable soft delete for organizations #16584

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 33 commits into from
Feb 24, 2025
Merged

feat: enable soft delete for organizations #16584

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
606a5fa
feat: orgs soft delete
jaaydenh Feb 11, 2025
609890f
chore: rename migration
jaaydenh Feb 15, 2025
31e5eb2
chore: add deleted to audit table
jaaydenh Feb 15, 2025
608661b
chore: update audit table
jaaydenh Feb 15, 2025
54039cf
chore: code generated from db migration
jaaydenh Feb 15, 2025
9516695
feat: updates for soft delete
jaaydenh Feb 15, 2025
9a26df6
chore: updates to sql.go
jaaydenh Feb 16, 2025
f1f25e1
fix: update indexes and unique constraint
jaaydenh Feb 16, 2025
b202254
fix: update migration number
jaaydenh Feb 18, 2025
1bf3742
fix: fix TestEnterpriseAuditLogs
jaaydenh Feb 18, 2025
41e943b
fix: revert test
jaaydenh Feb 18, 2025
9fe8da1
fix: updates for pr review
jaaydenh Feb 19, 2025
6929988
feat: add trigger to check for resources on soft delete
jaaydenh Feb 20, 2025
eb88091
chore: update trigger function
jaaydenh Feb 20, 2025
10d1564
fix: drop index add members check to trigger
jaaydenh Feb 21, 2025
56260b0
fix: fix frontend display of error messages
jaaydenh Feb 21, 2025
5968da1
fix: fix tests
jaaydenh Feb 21, 2025
70bf5e3
fix: fix test
jaaydenh Feb 21, 2025
50074d1
fix fix e2e test
jaaydenh Feb 21, 2025
eed03fe
fix: fix format
jaaydenh Feb 21, 2025
891cbae
fix: update trigger
jaaydenh Feb 21, 2025
22d27f8
chore: implement unit test to test trigger with >0 workspaces
Emyrk Feb 21, 2025
dc5fc46
use dbfake
Emyrk Feb 21, 2025
9466ff7
fix: trigger
jaaydenh Feb 21, 2025
ae2bf08
Merge branch 'jaaydenh/orgs-soft-delete' of https://github.com/coder/…
jaaydenh Feb 21, 2025
041630c
chore: update delete org trigger name
jaaydenh Feb 21, 2025
607311f
chore: add additional org delete trigger tests
jaaydenh Feb 21, 2025
7291c02
chore: change name
jaaydenh Feb 21, 2025
b9b7a14
fix: update trigger name
jaaydenh Feb 21, 2025
9af7cb5
fix: fix tests
jaaydenh Feb 21, 2025
aee6834
fix: fix test
jaaydenh Feb 21, 2025
74ef3de
fix: update e2e test
jaaydenh Feb 21, 2025
4c70aaa
Update coderd/database/querier_test.go
jaaydenh Feb 24, 2025
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
feat: add trigger to check for resources on soft delete
  • Loading branch information
@jaaydenh
< 8000 /div> jaaydenh committed Feb 21, 2025
commit 692998800fb43c612aa4fd3b6d1c2c6553d9cf7e
36 changes: 36 additions & 0 deletions coderd/database/dump.sql
View file
Open in desktop

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

3 changes: 3 additions & 0 deletions coderd/database/migrations/000296_organization_soft_delete.down.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,6 @@ CREATE UNIQUE INDEX IF NOT EXISTS idx_organization_name_lower ON organizations U

ALTER TABLE ONLY organizations
ADD CONSTRAINT organizations_name UNIQUE (name);

DROP TRIGGER IF EXISTS protect_provisioned_organizations ON organizations;
DROP FUNCTION IF EXISTS protect_provisioned_organizations;
41 changes: 41 additions & 0 deletions coderd/database/migrations/000296_organization_soft_delete.up.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,44 @@ CREATE UNIQUE INDEX IF NOT EXISTS idx_organization_name_lower ON organizations U

ALTER TABLE ONLY organizations
DROP CONSTRAINT IF EXISTS organizations_name;

CREATE FUNCTION protect_provisioned_organizations()
RETURNS TRIGGER AS
$$
DECLARE
workspace_count int;
template_count int;
BEGIN
workspace_count := (
SELECT count(*) as count FROM workspaces
WHERE
workspaces.organization_id = OLD.id
AND workspaces.deleted = false
);

template_count := (
SELECT count(*) as count FROM templates
WHERE
templates.organization_id = OLD.id
AND templates.deleted = false
);

-- Fail the deletion if one of the following:
-- * the organization has 1 or more workspaces
-- * the organization has 1 or more templates
IF (workspace_count + template_count) > 0 THEN
Copy link
Contributor Author
@jaaydenh jaaydenh Feb 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it feels like such a long error message if this is combined into one exception. In the future the FE should let the user know what resources exist before deleting

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can improve the error handling in golang up front in the future and improve the UX on failures.

RAISE EXCEPTION 'cannot delete organization: organization has % workspaces and % templates that must be deleted first', workspace_count, template_count;
END IF;

-- add more cases to fail a delete

RETURN OLD;
END;
$$ LANGUAGE plpgsql;

-- Trigger to protect organizations from being soft deleted with existing resources
CREATE TRIGGER protect_provisioned_organizations
BEFORE UPDATE ON organizations
FOR EACH ROW
WHEN (NEW.deleted = true AND OLD.deleted = false)
EXECUTE FUNCTION protect_provisioned_organizations();
2 changes: 1 addition & 1 deletion docs/admin/security/audit-logs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ We track the following resources:
| NotificationsSettings<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>id</td><td>false</td></tr><tr><td>notifier_paused</td><td>true</td></tr></tbody></table> |
| OAuth2ProviderApp<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>callback_url</td><td>true</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>icon</td><td>true</td></tr><tr><td>id</td><td>false</td></tr><tr><td>name</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr></tbody></table> |
| OAuth2ProviderAppSecret<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>app_id</td><td>false</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>display_secret</td><td>false</td></tr><tr><td>hashed_secret</td><td>false</td></tr><tr><td>id</td><td>false</td></tr><tr><td>last_used_at</td><td>false</td></tr><tr><td>secret_prefix</td><td>false</td></tr></tbody></table> |
| Organization<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>created_at</td><td>false</td></tr><tr><td>deleted</td><td>false</td></tr><tr><td>description</td><td>true</td></tr><tr><td>display_name</td><td>true</td></tr><tr><td>icon</td><td>true</td></tr><tr><td>id</td><td>false</td></tr><tr><td>is_default</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>updated_at</td><td>true</td></tr></tbody></table> 70AB |
| Organization<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>created_at</td><td>false</td></tr><tr><td>deleted</td><td>true</td></tr><tr><td>description</td><td>true</td></tr><tr><td>display_name</td><td>true</td></tr><tr><td>icon</td><td>true</td></tr><tr><td>id</td><td>false</td></tr><tr><td>is_default</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>updated_at</td><td>true</td></tr></tbody></table> |
| OrganizationSyncSettings<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>assign_default</td><td>true</td></tr><tr><td>field</td><td>true</td></tr><tr><td>mapping</td><td>true</td></tr></tbody></table> |
| RoleSyncSettings<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>field</td><td>true</td></tr><tr><td>mapping</td><td>true</td></tr></tbody></table> |
| Template<br><i>write, delete</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>active_version_id</td><td>true</td></tr><tr><td>activity_bump</td><td>true</td></tr><tr><td>allow_user_autostart</td><td>true</td></tr><tr><td>allow_user_autostop</td><td>true</td></tr><tr><td>allow_user_cancel_workspace_jobs</td><td>true</td></tr><tr><td>autostart_block_days_of_week</td><td>true</td></tr><tr><td>autostop_requirement_days_of_week</td><td>true</td></tr><tr><td>autostop_requirement_weeks</td><td>true</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>created_by</td><td>true</td></tr><tr><td>created_by_avatar_url</td><td>false</td></tr><tr><td>created_by_username</td><td>false</td></tr><tr><td>default_ttl</td><td>true</td></tr><tr><td>deleted</td><td>false</td></tr><tr><td>deprecated</td><td>true</td></tr><tr><td>description</td><td>true</td></tr><tr><td>display_name</td><td>true</td></tr><tr><td>failure_ttl</td><td>true</td></tr><tr><td>group_acl</td><td>true</td></tr><tr><td>icon</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>max_port_sharing_level</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>organization_display_name</td><td>false</td></tr><tr><td>organization_icon</td><td>false</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>organization_name</td><td>false</td></tr><tr><td>provisioner</td><td>true</td></tr><tr><td>require_active_version</td><td>true</td></tr><tr><td>time_til_dormant</td><td>true</td></tr><tr><td>time_til_dormant_autodelete</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>user_acl</td><td>true</td></tr></tbody></table> |
Expand Down
0