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]>
246 lines
7.3 KiB
Go
246 lines
7.3 KiB
Go
package command
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/zitadel/zitadel/internal/domain"
|
|
"github.com/zitadel/zitadel/internal/eventstore"
|
|
"github.com/zitadel/zitadel/internal/repository/org"
|
|
settings "github.com/zitadel/zitadel/internal/repository/organization_settings"
|
|
"github.com/zitadel/zitadel/internal/repository/user"
|
|
"github.com/zitadel/zitadel/internal/zerrors"
|
|
)
|
|
|
|
type OrganizationSettingsWriteModel struct {
|
|
eventstore.WriteModel
|
|
|
|
OrganizationScopedUsernames bool
|
|
|
|
OrganizationState domain.OrgState
|
|
|
|
State domain.OrganizationSettingsState
|
|
checkPermission domain.PermissionCheck
|
|
}
|
|
|
|
func (wm *OrganizationSettingsWriteModel) GetWriteModel() *eventstore.WriteModel {
|
|
return &wm.WriteModel
|
|
}
|
|
|
|
func (wm *OrganizationSettingsWriteModel) checkPermissionWrite(
|
|
ctx context.Context,
|
|
resourceOwner string,
|
|
aggregateID string,
|
|
) error {
|
|
if wm.checkPermission == nil {
|
|
return zerrors.ThrowPermissionDenied(nil, "COMMAND-8Dttuyj0B4", "Permission check not defined")
|
|
}
|
|
return wm.checkPermission(ctx, domain.PermissionIAMPolicyWrite, resourceOwner, aggregateID)
|
|
}
|
|
|
|
func (wm *OrganizationSettingsWriteModel) checkPermissionDelete(
|
|
ctx context.Context,
|
|
resourceOwner string,
|
|
aggregateID string,
|
|
) error {
|
|
if wm.checkPermission == nil {
|
|
return zerrors.ThrowPermissionDenied(nil, "COMMAND-6R54f4vWqv", "Permission check not defined")
|
|
}
|
|
return wm.checkPermission(ctx, domain.PermissionIAMPolicyDelete, resourceOwner, aggregateID)
|
|
}
|
|
|
|
func NewOrganizationSettingsWriteModel(id string, checkPermission domain.PermissionCheck) *OrganizationSettingsWriteModel {
|
|
return &OrganizationSettingsWriteModel{
|
|
WriteModel: eventstore.WriteModel{
|
|
AggregateID: id,
|
|
ResourceOwner: id,
|
|
},
|
|
checkPermission: checkPermission,
|
|
}
|
|
}
|
|
|
|
func (wm *OrganizationSettingsWriteModel) Reduce() error {
|
|
for _, event := range wm.Events {
|
|
switch e := event.(type) {
|
|
case *settings.OrganizationSettingsSetEvent:
|
|
wm.OrganizationScopedUsernames = e.OrganizationScopedUsernames
|
|
wm.State = domain.OrganizationSettingsStateActive
|
|
case *settings.OrganizationSettingsRemovedEvent:
|
|
wm.OrganizationScopedUsernames = false
|
|
wm.State = domain.OrganizationSettingsStateRemoved
|
|
case *org.OrgAddedEvent:
|
|
wm.OrganizationState = domain.OrgStateActive
|
|
wm.OrganizationScopedUsernames = false
|
|
case *org.OrgRemovedEvent:
|
|
wm.OrganizationState = domain.OrgStateRemoved
|
|
wm.OrganizationScopedUsernames = false
|
|
}
|
|
}
|
|
return wm.WriteModel.Reduce()
|
|
}
|
|
|
|
func (wm *OrganizationSettingsWriteModel) Query() *eventstore.SearchQueryBuilder {
|
|
return eventstore.NewSearchQueryBuilder(eventstore.ColumnsEvent).
|
|
ResourceOwner(wm.ResourceOwner).
|
|
AddQuery().
|
|
AggregateTypes(settings.AggregateType).
|
|
AggregateIDs(wm.AggregateID).
|
|
EventTypes(settings.OrganizationSettingsSetEventType,
|
|
settings.OrganizationSettingsRemovedEventType).
|
|
Or().
|
|
AggregateTypes(org.AggregateType).
|
|
AggregateIDs(wm.AggregateID).
|
|
EventTypes(org.OrgAddedEventType,
|
|
org.OrgRemovedEventType).
|
|
Builder()
|
|
}
|
|
|
|
func (wm *OrganizationSettingsWriteModel) NewSet(
|
|
ctx context.Context,
|
|
organizationScopedUsernames *bool,
|
|
userLoginMustBeDomain bool,
|
|
usernamesF func(ctx context.Context, orgID string) ([]user.UsernameChange, error),
|
|
) (_ []eventstore.Command, err error) {
|
|
if err := wm.checkPermissionWrite(ctx, wm.ResourceOwner, wm.AggregateID); err != nil {
|
|
return nil, err
|
|
}
|
|
// no changes
|
|
if organizationScopedUsernames == nil || *organizationScopedUsernames == wm.OrganizationScopedUsernames {
|
|
return nil, nil
|
|
}
|
|
|
|
var usernames []user.UsernameChange
|
|
if (wm.OrganizationScopedUsernames || userLoginMustBeDomain) != (*organizationScopedUsernames || userLoginMustBeDomain) {
|
|
usernames, err = usernamesF(ctx, wm.AggregateID)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
events := []eventstore.Command{
|
|
settings.NewOrganizationSettingsAddedEvent(ctx,
|
|
SettingsAggregateFromWriteModel(&wm.WriteModel),
|
|
usernames,
|
|
*organizationScopedUsernames || userLoginMustBeDomain,
|
|
wm.OrganizationScopedUsernames || userLoginMustBeDomain,
|
|
),
|
|
}
|
|
return events, nil
|
|
}
|
|
|
|
func (wm *OrganizationSettingsWriteModel) NewRemoved(
|
|
ctx context.Context,
|
|
userLoginMustBeDomain bool,
|
|
usernamesF func(ctx context.Context, orgID string) ([]user.UsernameChange, error),
|
|
) (_ []eventstore.Command, err error) {
|
|
if err := wm.checkPermissionDelete(ctx, wm.ResourceOwner, wm.AggregateID); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var usernames []user.UsernameChange
|
|
if userLoginMustBeDomain != wm.OrganizationScopedUsernames {
|
|
usernames, err = usernamesF(ctx, wm.AggregateID)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
events := []eventstore.Command{
|
|
settings.NewOrganizationSettingsRemovedEvent(ctx,
|
|
SettingsAggregateFromWriteModel(&wm.WriteModel),
|
|
usernames,
|
|
userLoginMustBeDomain,
|
|
wm.OrganizationScopedUsernames || userLoginMustBeDomain,
|
|
),
|
|
}
|
|
return events, nil
|
|
}
|
|
|
|
func SettingsAggregateFromWriteModel(wm *eventstore.WriteModel) *eventstore.Aggregate {
|
|
return &eventstore.Aggregate{
|
|
ID: wm.AggregateID,
|
|
Type: settings.AggregateType,
|
|
ResourceOwner: wm.ResourceOwner,
|
|
InstanceID: wm.InstanceID,
|
|
Version: settings.AggregateVersion,
|
|
}
|
|
}
|
|
|
|
type OrganizationScopedUsernamesWriteModel struct {
|
|
eventstore.WriteModel
|
|
|
|
Users []*organizationScopedUser
|
|
}
|
|
|
|
type organizationScopedUser struct {
|
|
id string
|
|
username string
|
|
}
|
|
|
|
func NewOrganizationScopedUsernamesWriteModel(orgID string) *OrganizationScopedUsernamesWriteModel {
|
|
return &OrganizationScopedUsernamesWriteModel{
|
|
WriteModel: eventstore.WriteModel{
|
|
ResourceOwner: orgID,
|
|
},
|
|
Users: make([]*organizationScopedUser, 0),
|
|
}
|
|
}
|
|
|
|
func (wm *OrganizationScopedUsernamesWriteModel) AppendEvents(events ...eventstore.Event) {
|
|
wm.WriteModel.AppendEvents(events...)
|
|
}
|
|
|
|
func (wm *OrganizationScopedUsernamesWriteModel) Reduce() error {
|
|
for _, event := range wm.Events {
|
|
switch e := event.(type) {
|
|
case *user.HumanAddedEvent:
|
|
wm.Users = append(wm.Users, &organizationScopedUser{id: e.Aggregate().ID, username: e.UserName})
|
|
case *user.HumanRegisteredEvent:
|
|
wm.Users = append(wm.Users, &organizationScopedUser{id: e.Aggregate().ID, username: e.UserName})
|
|
case *user.MachineAddedEvent:
|
|
wm.Users = append(wm.Users, &organizationScopedUser{id: e.Aggregate().ID, username: e.UserName})
|
|
case *user.UsernameChangedEvent:
|
|
for _, user := range wm.Users {
|
|
if user.id == e.Aggregate().ID {
|
|
user.username = e.UserName
|
|
break
|
|
}
|
|
}
|
|
case *user.DomainClaimedEvent:
|
|
for _, user := range wm.Users {
|
|
if user.id == e.Aggregate().ID {
|
|
user.username = e.UserName
|
|
break
|
|
}
|
|
}
|
|
case *user.UserRemovedEvent:
|
|
wm.removeUser(e.Aggregate().ID)
|
|
}
|
|
}
|
|
return wm.WriteModel.Reduce()
|
|
}
|
|
|
|
func (wm *OrganizationScopedUsernamesWriteModel) removeUser(userID string) {
|
|
for i, user := range wm.Users {
|
|
if user.id == userID {
|
|
wm.Users[i] = wm.Users[len(wm.Users)-1]
|
|
wm.Users[len(wm.Users)-1] = nil
|
|
wm.Users = wm.Users[:len(wm.Users)-1]
|
|
return
|
|
}
|
|
}
|
|
}
|
|
|
|
func (wm *OrganizationScopedUsernamesWriteModel) Query() *eventstore.SearchQueryBuilder {
|
|
return eventstore.NewSearchQueryBuilder(eventstore.ColumnsEvent).
|
|
ResourceOwner(wm.ResourceOwner).
|
|
AddQuery().
|
|
AggregateTypes(user.AggregateType).
|
|
EventTypes(
|
|
user.HumanAddedType,
|
|
user.HumanRegisteredType,
|
|
user.MachineAddedEventType,
|
|
user.UserUserNameChangedType,
|
|
user.UserDomainClaimedType,
|
|
user.UserRemovedType,
|
|
).
|
|
Builder()
|
|
}
|