mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-30 02:52:16 +00:00
fix(eventstore): add owners to unique constraints (#12740)
<!-- 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]>
This commit is contained in:
Silvan
co-authored by
Cursor Agent
Silvan
Cursor Agent
Silvan
parent
9e1b85fa91
commit
3ff4fbc7e4
@@ -216,9 +216,15 @@ func uniqueConstraints(ctx context.Context, tx *sql.Tx, commands []*command) (er
|
||||
}
|
||||
switch constraint.Action {
|
||||
case eventstore.UniqueConstraintAdd:
|
||||
stmt.WriteString(`INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field) VALUES (`)
|
||||
stmt.WriteArgs(instance, constraint.UniqueType, constraint.UniqueField)
|
||||
stmt.WriteRune(')')
|
||||
stmt.WriteString(`INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field, owners) VALUES (`)
|
||||
stmt.WriteArg(instance)
|
||||
stmt.WriteString(`, `)
|
||||
stmt.WriteArg(constraint.UniqueType)
|
||||
stmt.WriteString(`, `)
|
||||
stmt.WriteArg(constraint.UniqueField)
|
||||
stmt.WriteString(`, `)
|
||||
stmt.WriteArg(constraint.Owners)
|
||||
stmt.WriteString(`)`)
|
||||
case eventstore.UniqueConstraintInstanceRemove:
|
||||
stmt.WriteString(`DELETE FROM eventstore.unique_constraints WHERE instance_id = `)
|
||||
stmt.WriteArgs(instance)
|
||||
@@ -230,6 +236,15 @@ func uniqueConstraints(ctx context.Context, tx *sql.Tx, commands []*command) (er
|
||||
constraint.UniqueType,
|
||||
constraint.UniqueField,
|
||||
)
|
||||
case eventstore.UniqueConstraintRemoveByOwner:
|
||||
if len(constraint.Owners) == 0 {
|
||||
continue
|
||||
}
|
||||
stmt.WriteString(`DELETE FROM eventstore.unique_constraints WHERE instance_id = `)
|
||||
stmt.WriteArgs(instance)
|
||||
stmt.WriteString(` AND owners @> ARRAY[`)
|
||||
stmt.WriteArgs(constraint.Owners[0])
|
||||
stmt.WriteString(`]::text[]`)
|
||||
}
|
||||
_, err := tx.ExecContext(ctx, stmt.String(), stmt.Args()...)
|
||||
if err != nil {
|
||||
|
||||
@@ -66,8 +66,8 @@ func Test_uniqueConstraints(t *testing.T) {
|
||||
},
|
||||
expectations: []mock.Expectation{
|
||||
mock.ExpectExec(
|
||||
"INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field) VALUES ($1, $2, $3)",
|
||||
mock.WithExecArgs("instance", "test", "id"),
|
||||
"INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field, owners) VALUES ($1, $2, $3, $4)",
|
||||
mock.WithExecArgs("instance", "test", "id", []string{}),
|
||||
mock.WithExecRowsAffected(1),
|
||||
),
|
||||
},
|
||||
@@ -94,8 +94,8 @@ func Test_uniqueConstraints(t *testing.T) {
|
||||
},
|
||||
expectations: []mock.Expectation{
|
||||
mock.ExpectExec(
|
||||
"INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field) VALUES ($1, $2, $3)",
|
||||
mock.WithExecArgs("", "test", "id"),
|
||||
"INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field, owners) VALUES ($1, $2, $3, $4)",
|
||||
mock.WithExecArgs("", "test", "id", []string{}),
|
||||
mock.WithExecRowsAffected(1),
|
||||
),
|
||||
},
|
||||
@@ -123,13 +123,13 @@ func Test_uniqueConstraints(t *testing.T) {
|
||||
},
|
||||
expectations: []mock.Expectation{
|
||||
mock.ExpectExec(
|
||||
"INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field) VALUES ($1, $2, $3)",
|
||||
mock.WithExecArgs("instance", "test", "id"),
|
||||
"INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field, owners) VALUES ($1, $2, $3, $4)",
|
||||
mock.WithExecArgs("instance", "test", "id", []string{}),
|
||||
mock.WithExecRowsAffected(1),
|
||||
),
|
||||
mock.ExpectExec(
|
||||
"INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field) VALUES ($1, $2, $3)",
|
||||
mock.WithExecArgs("instance", "test", "id2"),
|
||||
"INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field, owners) VALUES ($1, $2, $3, $4)",
|
||||
mock.WithExecArgs("instance", "test", "id2", []string{}),
|
||||
mock.WithExecRowsAffected(1),
|
||||
),
|
||||
},
|
||||
@@ -169,13 +169,13 @@ func Test_uniqueConstraints(t *testing.T) {
|
||||
},
|
||||
expectations: []mock.Expectation{
|
||||
mock.ExpectExec(
|
||||
"INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field) VALUES ($1, $2, $3)",
|
||||
mock.WithExecArgs("instance", "test", "id"),
|
||||
"INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field, owners) VALUES ($1, $2, $3, $4)",
|
||||
mock.WithExecArgs("instance", "test", "id", []string{}),
|
||||
mock.WithExecRowsAffected(1),
|
||||
),
|
||||
mock.ExpectExec(
|
||||
"INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field) VALUES ($1, $2, $3)",
|
||||
mock.WithExecArgs("instance", "test", "id2"),
|
||||
"INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field, owners) VALUES ($1, $2, $3, $4)",
|
||||
mock.WithExecArgs("instance", "test", "id2", []string{}),
|
||||
mock.WithExecRowsAffected(1),
|
||||
),
|
||||
},
|
||||
@@ -392,6 +392,34 @@ func Test_uniqueConstraints(t *testing.T) {
|
||||
},
|
||||
assertErr: expectNoErr,
|
||||
},
|
||||
{
|
||||
name: "remove by owner 1 command",
|
||||
args: args{
|
||||
commands: []*command{
|
||||
{
|
||||
intent: &intent{
|
||||
PushAggregate: eventstore.NewPushIntent(
|
||||
"instance",
|
||||
eventstore.AppendAggregate("", "", ""),
|
||||
).Aggregates()[0],
|
||||
},
|
||||
Command: &eventstore.Command{
|
||||
UniqueConstraints: []*eventstore.UniqueConstraint{
|
||||
eventstore.NewRemoveUniqueConstraintsByOwner(eventstore.UniqueConstraintOwnerOrg, "org-1"),
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
expectations: []mock.Expectation{
|
||||
mock.ExpectExec(
|
||||
`DELETE FROM eventstore.unique_constraints WHERE instance_id = $1 AND owners @> ARRAY[$2]::text[]`,
|
||||
mock.WithExecArgs("instance", "org:org-1"),
|
||||
mock.WithExecRowsAffected(3),
|
||||
),
|
||||
},
|
||||
},
|
||||
assertErr: expectNoErr,
|
||||
},
|
||||
{
|
||||
name: "exec fails no error specified",
|
||||
args: args{
|
||||
@@ -412,8 +440,8 @@ func Test_uniqueConstraints(t *testing.T) {
|
||||
},
|
||||
expectations: []mock.Expectation{
|
||||
mock.ExpectExec(
|
||||
"INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field) VALUES ($1, $2, $3)",
|
||||
mock.WithExecArgs("instance", "test", "id"),
|
||||
"INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field, owners) VALUES ($1, $2, $3, $4)",
|
||||
mock.WithExecArgs("instance", "test", "id", []string{}),
|
||||
mock.WithExecErr(execErr),
|
||||
),
|
||||
},
|
||||
@@ -446,8 +474,8 @@ func Test_uniqueConstraints(t *testing.T) {
|
||||
},
|
||||
expectations: []mock.Expectation{
|
||||
mock.ExpectExec(
|
||||
"INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field) VALUES ($1, $2, $3)",
|
||||
mock.WithExecArgs("instance", "test", "id"),
|
||||
"INSERT INTO eventstore.unique_constraints (instance_id, unique_type, unique_field, owners) VALUES ($1, $2, $3, $4)",
|
||||
mock.WithExecArgs("instance", "test", "id", []string{}),
|
||||
mock.WithExecErr(execErr),
|
||||
),
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user