From 311a033523493db6dc5c7c5aed27a8f9e79f397f Mon Sep 17 00:00:00 2001 From: wizardchen Date: Tue, 26 May 2026 15:27:06 +0800 Subject: [PATCH] refactor(migrations): remove deprecated user system admin migration files and introduce new system settings migration - Deleted the old migration files for user system admin (000052) as they are no longer needed. - Added new migration files (000053) to implement system-level administrator flag and a new system settings table, consolidating related changes for improved management of platform-wide settings. - Ensured that the new migrations include proper rollback procedures for both the system admin flag and the system settings table. --- .../000052_user_system_admin.down.sql | 9 --- .../versioned/000052_user_system_admin.up.sql | 17 ------ .../000053_system_admin_and_settings.down.sql | 13 ++++ .../000053_system_admin_and_settings.up.sql | 61 +++++++++++++++++++ .../versioned/000053_system_settings.down.sql | 6 -- .../versioned/000053_system_settings.up.sql | 41 ------------- 6 files changed, 74 insertions(+), 73 deletions(-) delete mode 100644 migrations/versioned/000052_user_system_admin.down.sql delete mode 100644 migrations/versioned/000052_user_system_admin.up.sql create mode 100644 migrations/versioned/000053_system_admin_and_settings.down.sql create mode 100644 migrations/versioned/000053_system_admin_and_settings.up.sql delete mode 100644 migrations/versioned/000053_system_settings.down.sql delete mode 100644 migrations/versioned/000053_system_settings.up.sql diff --git a/migrations/versioned/000052_user_system_admin.down.sql b/migrations/versioned/000052_user_system_admin.down.sql deleted file mode 100644 index cb28949d..00000000 --- a/migrations/versioned/000052_user_system_admin.down.sql +++ /dev/null @@ -1,9 +0,0 @@ --- Rollback: drop users.is_system_admin column and its index - -DO $$ BEGIN RAISE NOTICE '[Migration 000052 DOWN] Dropping users.is_system_admin...'; END $$; - -DROP INDEX IF EXISTS idx_users_is_system_admin; - -ALTER TABLE users DROP COLUMN IF EXISTS is_system_admin; - -DO $$ BEGIN RAISE NOTICE '[Migration 000052 DOWN] Done.'; END $$; diff --git a/migrations/versioned/000052_user_system_admin.up.sql b/migrations/versioned/000052_user_system_admin.up.sql deleted file mode 100644 index 534d74b4..00000000 --- a/migrations/versioned/000052_user_system_admin.up.sql +++ /dev/null @@ -1,17 +0,0 @@ --- Migration: 000052_user_system_admin --- Adds system-level administrator flag to users table. System admins operate --- independently of tenant-scoped roles and have platform-wide privileges. --- This enables organization-level superuser management, separate from per-tenant --- admin/owner roles. The IsSystemAdmin flag is indexed for efficient queries --- on privilege checks and admin listing. - -DO $$ BEGIN RAISE NOTICE '[Migration 000052] Adding users.is_system_admin column...'; END $$; - -ALTER TABLE users - ADD COLUMN IF NOT EXISTS is_system_admin BOOLEAN NOT NULL DEFAULT FALSE; - -CREATE INDEX IF NOT EXISTS idx_users_is_system_admin ON users (is_system_admin); - -COMMENT ON COLUMN users.is_system_admin IS 'Whether the user is a system administrator (independent of tenant roles)'; - -DO $$ BEGIN RAISE NOTICE '[Migration 000052] Done.'; END $$; diff --git a/migrations/versioned/000053_system_admin_and_settings.down.sql b/migrations/versioned/000053_system_admin_and_settings.down.sql new file mode 100644 index 00000000..7adaa430 --- /dev/null +++ b/migrations/versioned/000053_system_admin_and_settings.down.sql @@ -0,0 +1,13 @@ +-- Rollback: drop system_settings table and users.is_system_admin column + +DO $$ BEGIN RAISE NOTICE '[Migration 000053 DOWN] Dropping table: system_settings'; END $$; + +DROP TABLE IF EXISTS system_settings CASCADE; + +DO $$ BEGIN RAISE NOTICE '[Migration 000053 DOWN] Dropping users.is_system_admin...'; END $$; + +DROP INDEX IF EXISTS idx_users_is_system_admin; + +ALTER TABLE users DROP COLUMN IF EXISTS is_system_admin; + +DO $$ BEGIN RAISE NOTICE '[Migration 000053 DOWN] Done.'; END $$; diff --git a/migrations/versioned/000053_system_admin_and_settings.up.sql b/migrations/versioned/000053_system_admin_and_settings.up.sql new file mode 100644 index 00000000..cab44dba --- /dev/null +++ b/migrations/versioned/000053_system_admin_and_settings.up.sql @@ -0,0 +1,61 @@ +-- Migration: 000053_system_admin_and_settings +-- Two related changes for the system-admin / platform-settings feature, merged +-- into a single migration since they ship together and have no intermediate +-- consumer: +-- +-- 1. users.is_system_admin +-- System-level administrator flag, independent of tenant-scoped roles. +-- System admins have platform-wide privileges (e.g. editing +-- system_settings below). Indexed for efficient privilege checks and +-- admin listing. +-- +-- 2. system_settings table +-- System-scoped (NOT tenant-scoped) settings for platform-wide runtime +-- tunables, gated by SystemAdmin. +-- +-- Deliberately do not seed values here. For migrated deployments, a DB +-- row has higher precedence than ENV, so inserting built-in defaults +-- would silently override existing operator configuration such as +-- DISABLE_REGISTRATION, SSRF_WHITELIST, and MAX_FILE_SIZE_MB. The +-- service exposes registry-backed virtual rows to the management UI +-- until an admin explicitly saves a value. +-- +-- Why JSONB for `value`? +-- We want to support int / string / bool / arrays / objects under one +-- schema without a separate table per type. The `value_type` column +-- tells the service layer how to parse the raw JSON. Booleans +-- roundtrip as `true`/`false`, ints as `42`, strings as `"foo"`. +-- +-- Indexes: +-- - UNIQUE on (key) — primary lookup pattern, every Get hits this +-- - (category) — for the management UI's grouped list view + +DO $$ BEGIN RAISE NOTICE '[Migration 000053] Adding users.is_system_admin column...'; END $$; + +ALTER TABLE users + ADD COLUMN IF NOT EXISTS is_system_admin BOOLEAN NOT NULL DEFAULT FALSE; + +CREATE INDEX IF NOT EXISTS idx_users_is_system_admin ON users (is_system_admin); + +COMMENT ON COLUMN users.is_system_admin IS 'Whether the user is a system administrator (independent of tenant roles)'; + +DO $$ BEGIN RAISE NOTICE '[Migration 000053] Creating table: system_settings'; END $$; + +CREATE TABLE IF NOT EXISTS system_settings ( + id BIGSERIAL PRIMARY KEY, + key VARCHAR(128) NOT NULL UNIQUE, + value JSONB NOT NULL, + value_type VARCHAR(16) NOT NULL, + category VARCHAR(32) NOT NULL, + description TEXT NOT NULL DEFAULT '', + is_secret BOOLEAN NOT NULL DEFAULT false, + requires_restart BOOLEAN NOT NULL DEFAULT false, + last_modified_by VARCHAR(36) NOT NULL DEFAULT '', + created_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP, + updated_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP +); + +CREATE INDEX IF NOT EXISTS idx_system_settings_category + ON system_settings (category); + +DO $$ BEGIN RAISE NOTICE '[Migration 000053] Done.'; END $$; diff --git a/migrations/versioned/000053_system_settings.down.sql b/migrations/versioned/000053_system_settings.down.sql deleted file mode 100644 index c644bb55..00000000 --- a/migrations/versioned/000053_system_settings.down.sql +++ /dev/null @@ -1,6 +0,0 @@ --- Rollback: drop system_settings table -DO $$ BEGIN RAISE NOTICE '[Migration 000053 DOWN] Dropping table: system_settings'; END $$; - -DROP TABLE IF EXISTS system_settings CASCADE; - -DO $$ BEGIN RAISE NOTICE '[Migration 000053 DOWN] Done.'; END $$; diff --git a/migrations/versioned/000053_system_settings.up.sql b/migrations/versioned/000053_system_settings.up.sql deleted file mode 100644 index ef2b6a29..00000000 --- a/migrations/versioned/000053_system_settings.up.sql +++ /dev/null @@ -1,41 +0,0 @@ --- Migration: 000053_system_settings --- Adds a system-scoped (NOT tenant-scoped) settings table for platform-wide --- runtime tunables, gated by SystemAdmin. --- --- Deliberately do not seed values here. For migrated deployments, a DB row --- has higher precedence than ENV, so inserting built-in defaults would --- silently override existing operator configuration such as --- DISABLE_REGISTRATION, SSRF_WHITELIST, and MAX_FILE_SIZE_MB. The service --- exposes registry-backed virtual rows to the management UI until an admin --- explicitly saves a value. --- --- Why JSONB for `value`? --- We want to support int / string / bool / arrays / objects under one --- schema without a separate table per type. The `value_type` column tells --- the service layer how to parse the raw JSON. Booleans roundtrip as --- `true`/`false`, ints as `42`, strings as `"foo"`. --- --- Indexes: --- - UNIQUE on (key) — primary lookup pattern, every Get hits this --- - (category) — for the management UI's grouped list view - -DO $$ BEGIN RAISE NOTICE '[Migration 000053] Creating table: system_settings'; END $$; - -CREATE TABLE IF NOT EXISTS system_settings ( - id BIGSERIAL PRIMARY KEY, - key VARCHAR(128) NOT NULL UNIQUE, - value JSONB NOT NULL, - value_type VARCHAR(16) NOT NULL, - category VARCHAR(32) NOT NULL, - description TEXT NOT NULL DEFAULT '', - is_secret BOOLEAN NOT NULL DEFAULT false, - requires_restart BOOLEAN NOT NULL DEFAULT false, - last_modified_by VARCHAR(36) NOT NULL DEFAULT '', - created_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP, - updated_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP -); - -CREATE INDEX IF NOT EXISTS idx_system_settings_category - ON system_settings (category); - -DO $$ BEGIN RAISE NOTICE '[Migration 000053] system_settings table ready'; END $$;