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]>
235 lines
9.1 KiB
Go
235 lines
9.1 KiB
Go
package repository_test
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/zitadel/zitadel/internal/eventstore"
|
|
"github.com/zitadel/zitadel/internal/repository/action"
|
|
"github.com/zitadel/zitadel/internal/repository/group"
|
|
"github.com/zitadel/zitadel/internal/repository/idpconfig"
|
|
"github.com/zitadel/zitadel/internal/repository/instance"
|
|
"github.com/zitadel/zitadel/internal/repository/member"
|
|
"github.com/zitadel/zitadel/internal/repository/org"
|
|
"github.com/zitadel/zitadel/internal/repository/policy"
|
|
"github.com/zitadel/zitadel/internal/repository/project"
|
|
"github.com/zitadel/zitadel/internal/repository/target"
|
|
"github.com/zitadel/zitadel/internal/repository/user"
|
|
"github.com/zitadel/zitadel/internal/repository/usergrant"
|
|
)
|
|
|
|
func TestUniqueConstraintOwners(t *testing.T) {
|
|
ctx := t.Context()
|
|
|
|
tests := []struct {
|
|
name string
|
|
cmd eventstore.Command
|
|
want [][]string
|
|
}{
|
|
{
|
|
name: "username",
|
|
cmd: &user.HumanAddedEvent{
|
|
BaseEvent: eventstore.BaseEvent{Agg: agg(user.AggregateType, "user-1", "org-1")},
|
|
UserName: "alice",
|
|
},
|
|
want: [][]string{{"org:org-1", "user:user-1"}},
|
|
},
|
|
{
|
|
name: "external idp link",
|
|
cmd: user.NewUserIDPLinkAddedEvent(ctx, agg(user.AggregateType, "user-1", "org-1"), "idp-1", "display", "ext-1"),
|
|
want: [][]string{{"org:org-1", "idp:idp-1", "user:user-1"}},
|
|
},
|
|
{
|
|
name: "org name",
|
|
cmd: org.NewOrgAddedEvent(ctx, agg(org.AggregateType, "org-1", "org-1"), "acme"),
|
|
want: [][]string{{"org:org-1"}},
|
|
},
|
|
{
|
|
name: "org domain",
|
|
cmd: org.NewDomainVerifiedEvent(ctx, agg(org.AggregateType, "org-1", "org-1"), "acme.example"),
|
|
want: [][]string{{"org:org-1"}},
|
|
},
|
|
{
|
|
name: "app name",
|
|
cmd: project.NewApplicationAddedEvent(ctx, agg(project.AggregateType, "project-1", "org-1"), "app-1", "console"),
|
|
want: [][]string{{"org:org-1", "project:project-1"}},
|
|
},
|
|
{
|
|
name: "project role",
|
|
cmd: project.NewRoleAddedEvent(ctx, agg(project.AggregateType, "project-1", "org-1"), "role.key", "Role", "group"),
|
|
want: [][]string{{"org:org-1", "project:project-1"}},
|
|
},
|
|
{
|
|
name: "saml entity id",
|
|
cmd: project.NewSAMLConfigAddedEvent(ctx, agg(project.AggregateType, "project-1", "org-1"), "app-1", "https://sp.example", nil, "", 0, ""),
|
|
want: [][]string{{"org:org-1", "project:project-1"}},
|
|
},
|
|
{
|
|
name: "project name",
|
|
cmd: &project.ProjectAddedEvent{
|
|
BaseEvent: eventstore.BaseEvent{Agg: agg(project.AggregateType, "project-1", "org-1")},
|
|
Name: "docs",
|
|
},
|
|
want: [][]string{{"org:org-1", "project:project-1"}},
|
|
},
|
|
{
|
|
name: "project grant two orgs",
|
|
cmd: project.NewGrantAddedEvent(ctx, agg(project.AggregateType, "project-1", "granting-org"), "grant-1", "granted-org", nil),
|
|
want: [][]string{{"org:granting-org", "org:granted-org", "project:project-1", "grant:grant-1"}},
|
|
},
|
|
{
|
|
name: "project grant member",
|
|
cmd: project.NewProjectGrantMemberAddedEvent(ctx, agg(project.AggregateType, "project-1", "org-1"), "user-1", "grant-1", "ROLE").
|
|
WithOwnerOrgs("user-org", "granted-org"),
|
|
want: [][]string{{"org:org-1", "org:user-org", "org:granted-org", "user:user-1", "project:project-1", "grant:grant-1"}},
|
|
},
|
|
{
|
|
name: "user grant",
|
|
cmd: usergrant.NewUserGrantAddedEvent(ctx, agg(user.AggregateType, "grant-row", "org-1"), "user-1", "project-1", "grant-1", nil).
|
|
WithOwnerOrgs("user-org", "project-org", "granted-org"),
|
|
want: [][]string{{"org:org-1", "org:user-org", "org:project-org", "org:granted-org", "user:user-1", "project:project-1", "grant:grant-1"}},
|
|
},
|
|
{
|
|
name: "org member",
|
|
cmd: member.NewMemberAddedEvent(
|
|
&eventstore.BaseEvent{Agg: agg(org.AggregateType, "org-1", "org-1")},
|
|
"user-1",
|
|
).WithUserResourceOwner("org-1"),
|
|
want: [][]string{{"user:user-1", "org:org-1"}},
|
|
},
|
|
{
|
|
name: "org member cross-org user",
|
|
cmd: member.NewMemberAddedEvent(
|
|
&eventstore.BaseEvent{Agg: agg(org.AggregateType, "org-1", "org-1")},
|
|
"user-1",
|
|
).WithUserResourceOwner("user-org"),
|
|
want: [][]string{{"user:user-1", "org:user-org", "org:org-1"}},
|
|
},
|
|
{
|
|
name: "project member",
|
|
cmd: member.NewMemberAddedEvent(
|
|
&eventstore.BaseEvent{Agg: agg(project.AggregateType, "project-1", "org-1")},
|
|
"user-1",
|
|
).WithUserResourceOwner("org-1"),
|
|
want: [][]string{{"user:user-1", "org:org-1", "project:project-1"}},
|
|
},
|
|
{
|
|
name: "project member cross-org user",
|
|
cmd: member.NewMemberAddedEvent(
|
|
&eventstore.BaseEvent{Agg: agg(project.AggregateType, "project-1", "org-1")},
|
|
"user-1",
|
|
).WithUserResourceOwner("user-org"),
|
|
want: [][]string{{"user:user-1", "org:user-org", "org:org-1", "project:project-1"}},
|
|
},
|
|
{
|
|
name: "instance member",
|
|
cmd: member.NewMemberAddedEvent(
|
|
&eventstore.BaseEvent{Agg: agg(instance.AggregateType, "instance-1", "instance-1")},
|
|
"user-1",
|
|
).WithUserResourceOwner("user-org"),
|
|
want: [][]string{{"user:user-1", "org:user-org"}},
|
|
},
|
|
{
|
|
name: "group name",
|
|
cmd: group.NewGroupAddedEvent(ctx, agg(group.AggregateType, "group-1", "org-1"), "engineering", ""),
|
|
want: [][]string{{"org:org-1"}},
|
|
},
|
|
{
|
|
name: "action name",
|
|
cmd: action.NewAddedEvent(ctx, agg(action.AggregateType, "action-1", "org-1"), "notify", "", 0, false),
|
|
want: [][]string{{"org:org-1"}},
|
|
},
|
|
{
|
|
name: "idp config name",
|
|
cmd: idpconfig.NewIDPConfigAddedEvent(&eventstore.BaseEvent{Agg: agg(org.AggregateType, "org-1", "org-1")}, "idp-1", "Google", 0, 0, false),
|
|
want: [][]string{{"org:org-1", "idp:idp-1"}},
|
|
},
|
|
{
|
|
name: "mail text org",
|
|
cmd: policy.NewMailTextAddedEvent(&eventstore.BaseEvent{Agg: agg(org.AggregateType, "org-1", "org-1")}, "InitCode", "en", "", "", "", "", "", ""),
|
|
want: [][]string{{"org:org-1"}},
|
|
},
|
|
{
|
|
name: "mail text instance empty owners",
|
|
cmd: policy.NewMailTextAddedEvent(&eventstore.BaseEvent{Agg: agg(instance.AggregateType, "instance-1", "instance-1")}, "InitCode", "en", "", "", "", "", "", ""),
|
|
want: [][]string{nil},
|
|
},
|
|
{
|
|
name: "instance domain global empty owners",
|
|
cmd: instance.NewDomainAddedEvent(ctx, agg(instance.AggregateType, "instance-1", "instance-1"), "acme.example", true),
|
|
want: [][]string{nil},
|
|
},
|
|
{
|
|
name: "target instance only empty owners",
|
|
cmd: target.NewAddedEvent(ctx, agg(target.AggregateType, "target-1", "instance-1"), "hook", 0, "", 0, false, nil, 0),
|
|
want: [][]string{nil},
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
constraints := tt.cmd.UniqueConstraints()
|
|
require.Len(t, constraints, len(tt.want))
|
|
for i, constraint := range constraints {
|
|
assert.Equal(t, eventstore.UniqueConstraintAdd, constraint.Action)
|
|
assert.ElementsMatch(t, tt.want[i], constraint.Owners)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestBulkRemoveAlsoEmitsRemoveByOwner(t *testing.T) {
|
|
ctx := t.Context()
|
|
orgAgg := agg(org.AggregateType, "org-1", "org-1")
|
|
orgConstraints := org.NewOrgRemovedEvent(ctx, orgAgg, "acme", nil, false, nil, nil, nil).UniqueConstraints()
|
|
require.GreaterOrEqual(t, len(orgConstraints), 2)
|
|
assert.Equal(t, eventstore.UniqueConstraintRemoveByOwner, orgConstraints[1].Action)
|
|
assert.Equal(t, []string{"org:org-1"}, orgConstraints[1].Owners)
|
|
|
|
userAgg := agg(user.AggregateType, "user-1", "org-1")
|
|
userConstraints := user.NewUserRemovedEvent(ctx, userAgg, "alice", nil, false).UniqueConstraints()
|
|
last := userConstraints[len(userConstraints)-1]
|
|
assert.Equal(t, eventstore.UniqueConstraintRemoveByOwner, last.Action)
|
|
assert.Equal(t, []string{"user:user-1"}, last.Owners)
|
|
|
|
idpConstraints := idpconfig.NewIDPConfigRemovedEvent(&eventstore.BaseEvent{Agg: orgAgg}, "idp-1", "Google").UniqueConstraints()
|
|
assert.Equal(t, eventstore.UniqueConstraintRemoveByOwner, idpConstraints[1].Action)
|
|
assert.Equal(t, []string{"idp:idp-1"}, idpConstraints[1].Owners)
|
|
|
|
projectAgg := agg(project.AggregateType, "project-1", "org-1")
|
|
projectConstraints := project.NewProjectRemovedEvent(ctx, projectAgg, "docs", nil).UniqueConstraints()
|
|
assert.Equal(t, eventstore.UniqueConstraintRemoveByOwner, projectConstraints[1].Action)
|
|
assert.Equal(t, []string{"project:project-1"}, projectConstraints[1].Owners)
|
|
|
|
grantConstraints := project.NewGrantRemovedEvent(ctx, projectAgg, "grant-1", "granted-org").UniqueConstraints()
|
|
require.Len(t, grantConstraints, 2)
|
|
assert.Equal(t, eventstore.UniqueConstraintRemove, grantConstraints[0].Action)
|
|
assert.Equal(t, eventstore.UniqueConstraintRemoveByOwner, grantConstraints[1].Action)
|
|
assert.Equal(t, []string{"grant:grant-1"}, grantConstraints[1].Owners)
|
|
}
|
|
|
|
func TestUsernameScopeRewriteKeepsUserTag(t *testing.T) {
|
|
constraints := user.NewUsernameUniqueConstraints(
|
|
[]user.UsernameChange{{Username: "alice", UserID: "user-1"}},
|
|
"org-1",
|
|
true,
|
|
false,
|
|
)
|
|
require.Len(t, constraints, 2)
|
|
assert.Equal(t, eventstore.UniqueConstraintRemove, constraints[0].Action)
|
|
assert.Equal(t, eventstore.UniqueConstraintAdd, constraints[1].Action)
|
|
assert.ElementsMatch(t, []string{"org:org-1", "user:user-1"}, constraints[1].Owners)
|
|
}
|
|
|
|
func agg(typ eventstore.AggregateType, id, resourceOwner string) *eventstore.Aggregate {
|
|
return &eventstore.Aggregate{
|
|
ID: id,
|
|
Type: typ,
|
|
ResourceOwner: resourceOwner,
|
|
InstanceID: "instance-1",
|
|
Version: "v1",
|
|
}
|
|
}
|