mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
<!-- CURSOR_AGENT_PR_BODY_BEGIN -->
# Which Problems Are Solved
Bulk unique-constraint deletes (org, IDP with many links, user, project)
reconstruct every uniqueness key in Go and emit N `DELETE`s. That can
OOM on large tenants.
A one-shot owner backfill is also not enough: during a rolling deploy,
older binaries still insert `owners = '{}'`, so a later owner-only
delete would miss those rows.
Owner-only org/user/grant delete only matches rows whose `owners` bag
contains that tag. Several grant and member types stamped the aggregate
resource owner, which is not always the user’s home org or the granted
org. Username-scope rewrites also dropped `user:` tags, so owner-only
user delete could miss rewritten username rows.
Command must not switch to owner-only delete on the first 79 of a
version, because leftover `'{}'` rows from rolling-update overlap are
only backfilled on a later 79. A failed 79 must not turn owner-delete
on, and backfill joins must not stamp the wrong org (unverified domains,
org-scoped usernames colliding with instance-scoped ones).
# How the Problems Are Solved
Uniqueness stays the existing primary key `(instance_id, unique_type,
unique_field)`. `owners` is only a lifecycle bag of tags (`org:<id>`,
`user:<id>`, `idp:<id>`, `project:<id>`, `grant:<id>`).
- Add `owners TEXT[] NOT NULL DEFAULT '{}'` on
`eventstore.unique_constraints` (init SQL for greenfield, setup 78 for
existing clusters).
- Create `unique_constraints_owners_gin` with `CREATE INDEX
CONCURRENTLY` **outside a transaction** (same pattern as step 76).
Built-in `GIN (owners)` only; no `btree_gin`.
- Stamp `WithOwners` on **add** events. Field-level removes ignore
owners. `RemoveByOwner` stores the tag in `Owners` and both v1/v3 and v2
pushers run `DELETE … WHERE instance_id = $1 AND owners @>
ARRAY[$tag]::text[]`.
- Setup 79 backfills `owners` from projections via numbered
`cmd/setup/79/*.sql` files. Table names are interpolated from
`internal/query/projection` constants. Matches use `unique_field IN (x,
lower(x))` so the primary key can be used. Missing projection tables
(`42P01`) are skipped.
- Org domains are tagged only when `is_verified`. Instance-scoped
usernames join only users that are not org-scoped (organization settings
or domain policy `user_login_must_be_domain`). Every username row still
gets `org:` + `user:` of that user.
- 79 is a **repeatable** migration. `Check` re-runs when
`lastRun["version"]` changed or when setup-only `ForceFinalize` is set
and `lastRun["finalized"]` is still false. `Finalized` is written only
after Execute succeeds.
- Failed setup events keep the last successful `lastRun`. Command reads
`finalized` only from `system.migration.repeatable.done`.
- Org / user / project remove skip N-key event replay **when that
`finalized` bit is true**. Otherwise they keep today’s N-key lists
**and** still emit `RemoveByOwner`. The “ready” result is cached in
memory once true.
Setup writes `finalized` on the 79 repeatable.done payload:
- First 79 of a version: backfill only, `finalized=false` (unless
`ForceFinalize` is already set).
- Later 79: version change or
`BackfillUniqueConstraintOwners.ForceFinalize` /
`ZITADEL_BACKFILLUNIQUECONSTRAINTOWNERS_FORCEFINALIZE` after the rolling
update is done. That run backfills leftovers and writes
`finalized=true`.
Member and grant owner bags now include every org that should delete the
row:
- Instance, org, and project members also stamp
`org:<user_resource_owner>`.
- User grants stamp grant, user, project, and granted orgs.
- Project grant members stamp the project org, user org, and granted
org.
- Project grants stamp both orgs plus `grant:<id>`. Grant remove emits
`RemoveByOwner(grant)`.
- Username-scope rewrites keep `user:<id>` as well as `org:`.
- User/grant orgs are carried as unexported add-event fields (not
persisted JSON). `WithOwners` skips empty and duplicate tags.
# Additional Changes
- Table-driven owner-tag tests, including project grant (two `org:` tags
plus `grant:`), cross-org members, user grants, and username-scope
rewrite `user:` tags.
- Table-driven 79 `Check` + `finalizeAfterSuccess` tests for version
change, sequential version bumps, ForceFinalize restart, and
already-finalized skip.
- Command tests: a failed 79 event with `finalized=true` does not enable
owner-delete.
- Integration fixtures (verified vs unverified org domain;
instance-scoped `bob` vs org-scoped `bob`).
- Instance-only and global unique types stay untagged (`'{}'`). Instance
wipe still uses `UniqueConstraintInstanceRemove`.
- Pusher owner cases live in `eventstore_pusher_owners_test.go` so
`eventstore_pusher_test.go` stays under 1k lines.
# Additional Context
A later cleanup can delete the N-key replay helpers once a release that
ran 79 a second time (or an operator who set `ForceFinalize`) is in
production. That is not required for correctness.
<!-- CURSOR_AGENT_PR_BODY_END -->
<div><a
href="https://cursor.com/agents/bc-44f9bc9b-9a93-4cd9-8dd1-663a7b9aad2a?cursor_ref=pr_footer&cursor_cta=open_in_web"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-web-light.png"><img
alt="Open in Web" width="114" height="28"
src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a> <a
href="https://cursor.com/background-agent?bcId=bc-44f9bc9b-9a93-4cd9-8dd1-663a7b9aad2a&cursor_ref=pr_footer&cursor_cta=open_in_cursor"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-cursor-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-cursor-light.png"><img
alt="Open in Cursor" width="131" height="28"
src="https://cursor.com/assets/images/open-in-cursor-dark.png"></picture></a> </div>
---------
Co-authored-by: Cursor Agent <[email protected]>
Co-authored-by: Silvan <[email protected]>
108 lines
4.2 KiB
Go
108 lines
4.2 KiB
Go
//go:build integration
|
|
|
|
package setup_test
|
|
|
|
import (
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/zitadel/zitadel/cmd/setup"
|
|
"github.com/zitadel/zitadel/internal/query/projection"
|
|
)
|
|
|
|
func TestBackfillUniqueConstraintOwners_OrgDomainVerifiedOnly(t *testing.T) {
|
|
instanceID := "uc-owners-domain-" + time.Now().Format("150405.000")
|
|
defer cleanupInstance(t, instanceID)
|
|
|
|
_, err := dbPool.Exec(CTX, `
|
|
INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field, owners)
|
|
VALUES ($1, 'org_domain', 'example.com', '{}')`, instanceID)
|
|
require.NoError(t, err)
|
|
|
|
now := time.Now()
|
|
_, err = dbPool.Exec(CTX, `
|
|
INSERT INTO `+projection.OrgDomainTable+` (
|
|
creation_date, change_date, sequence, domain, org_id, instance_id, is_verified, is_primary, validation_type
|
|
) VALUES
|
|
($2, $2, 1, 'example.com', 'org-a', $1, true, true, 0),
|
|
($2, $2, 1, 'example.com', 'org-b', $1, false, false, 0)`, instanceID, now)
|
|
require.NoError(t, err)
|
|
|
|
query, err := setup.BackfillUniqueConstraintOwnersQuery("05_org_domain.sql")
|
|
require.NoError(t, err)
|
|
_, err = dbPool.Exec(CTX, query)
|
|
require.NoError(t, err)
|
|
|
|
var owners []string
|
|
err = dbPool.QueryRow(CTX, `
|
|
SELECT owners FROM eventstore.unique_constraints
|
|
WHERE instance_id = $1 AND unique_type = 'org_domain' AND unique_field = 'example.com'`, instanceID).Scan(&owners)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, []string{"org:org-a"}, owners)
|
|
}
|
|
|
|
func TestBackfillUniqueConstraintOwners_UsernameInstanceScopedOrg(t *testing.T) {
|
|
instanceID := "uc-owners-user-" + time.Now().Format("150405.000")
|
|
defer cleanupInstance(t, instanceID)
|
|
|
|
now := time.Now()
|
|
_, err := dbPool.Exec(CTX, `
|
|
INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field, owners)
|
|
VALUES
|
|
($1, 'usernames', 'bob', '{}'),
|
|
($1, 'usernames', 'boborg-y', '{}')`, instanceID)
|
|
require.NoError(t, err)
|
|
|
|
_, err = dbPool.Exec(CTX, `
|
|
INSERT INTO `+projection.UserTable+` (
|
|
id, creation_date, change_date, resource_owner, instance_id, state, sequence, username, type
|
|
) VALUES
|
|
('user-x', $2, $2, 'org-x', $1, 1, 1, 'bob', 1),
|
|
('user-y', $2, $2, 'org-y', $1, 1, 1, 'bob', 1)`, instanceID, now)
|
|
require.NoError(t, err)
|
|
|
|
_, err = dbPool.Exec(CTX, `
|
|
INSERT INTO `+projection.DomainPolicyTable+` (
|
|
creation_date, change_date, sequence, id, state, user_login_must_be_domain,
|
|
validate_org_domains, smtp_sender_address_matches_instance_domain, is_default, resource_owner, instance_id
|
|
) VALUES ($2, $2, 1, $1, 1, false, false, false, true, $1, $1)`, instanceID, now)
|
|
require.NoError(t, err)
|
|
|
|
_, err = dbPool.Exec(CTX, `
|
|
INSERT INTO `+projection.OrganizationSettingsTable+` (
|
|
id, creation_date, change_date, resource_owner, instance_id, sequence, organization_scoped_usernames
|
|
) VALUES ('org-y', $2, $2, 'org-y', $1, 1, true)`, instanceID, now)
|
|
require.NoError(t, err)
|
|
|
|
query, err := setup.BackfillUniqueConstraintOwnersQuery("02_usernames.sql")
|
|
require.NoError(t, err)
|
|
_, err = dbPool.Exec(CTX, query)
|
|
require.NoError(t, err)
|
|
|
|
var instanceOwners []string
|
|
err = dbPool.QueryRow(CTX, `
|
|
SELECT owners FROM eventstore.unique_constraints
|
|
WHERE instance_id = $1 AND unique_type = 'usernames' AND unique_field = 'bob'`, instanceID).Scan(&instanceOwners)
|
|
require.NoError(t, err)
|
|
assert.ElementsMatch(t, []string{"org:org-x", "user:user-x"}, instanceOwners)
|
|
|
|
var orgScopedOwners []string
|
|
err = dbPool.QueryRow(CTX, `
|
|
SELECT owners FROM eventstore.unique_constraints
|
|
WHERE instance_id = $1 AND unique_type = 'usernames' AND unique_field = 'boborg-y'`, instanceID).Scan(&orgScopedOwners)
|
|
require.NoError(t, err)
|
|
assert.Empty(t, orgScopedOwners)
|
|
}
|
|
|
|
func cleanupInstance(t *testing.T, instanceID string) {
|
|
t.Helper()
|
|
_, _ = dbPool.Exec(CTX, `DELETE FROM eventstore.unique_constraints WHERE instance_id = $1`, instanceID)
|
|
_, _ = dbPool.Exec(CTX, `DELETE FROM `+projection.OrgDomainTable+` WHERE instance_id = $1`, instanceID)
|
|
_, _ = dbPool.Exec(CTX, `DELETE FROM `+projection.UserTable+` WHERE instance_id = $1`, instanceID)
|
|
_, _ = dbPool.Exec(CTX, `DELETE FROM `+projection.DomainPolicyTable+` WHERE instance_id = $1`, instanceID)
|
|
_, _ = dbPool.Exec(CTX, `DELETE FROM `+projection.OrganizationSettingsTable+` WHERE instance_id = $1`, instanceID)
|
|
}
|