mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-01 11:52:15 +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]>
350 lines
9.4 KiB
Go
350 lines
9.4 KiB
Go
package org
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/zitadel/zitadel/internal/crypto"
|
|
"github.com/zitadel/zitadel/internal/domain"
|
|
"github.com/zitadel/zitadel/internal/eventstore"
|
|
"github.com/zitadel/zitadel/internal/zerrors"
|
|
)
|
|
|
|
const (
|
|
UniqueOrgDomain = "org_domain"
|
|
domainEventPrefix = orgEventTypePrefix + "domain."
|
|
OrgDomainAddedEventType = domainEventPrefix + "added"
|
|
OrgDomainVerificationAddedEventType = domainEventPrefix + "verification.added"
|
|
OrgDomainVerificationFailedEventType = domainEventPrefix + "verification.failed"
|
|
OrgDomainVerifiedEventType = domainEventPrefix + "verified"
|
|
OrgDomainPrimarySetEventType = domainEventPrefix + "primary.set"
|
|
OrgDomainRemovedEventType = domainEventPrefix + "removed"
|
|
|
|
OrgDomainSearchType = "org_domain"
|
|
OrgDomainVerifiedSearchField = "verified"
|
|
OrgDomainObjectRevision = uint8(1)
|
|
)
|
|
|
|
func NewAddOrgDomainUniqueConstraint(orgDomain string) *eventstore.UniqueConstraint {
|
|
return eventstore.NewAddEventUniqueConstraint(
|
|
UniqueOrgDomain,
|
|
orgDomain,
|
|
"Errors.Org.Domain.AlreadyExists")
|
|
}
|
|
|
|
func NewRemoveOrgDomainUniqueConstraint(orgDomain string) *eventstore.UniqueConstraint {
|
|
return eventstore.NewRemoveUniqueConstraint(
|
|
UniqueOrgDomain,
|
|
orgDomain)
|
|
}
|
|
|
|
type DomainAddedEvent struct {
|
|
eventstore.BaseEvent `json:"-"`
|
|
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
func (e *DomainAddedEvent) Payload() interface{} {
|
|
return e
|
|
}
|
|
|
|
func (e *DomainAddedEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
|
|
return nil
|
|
}
|
|
|
|
func (e *DomainAddedEvent) Fields() []*eventstore.FieldOperation {
|
|
return []*eventstore.FieldOperation{
|
|
eventstore.SetField(
|
|
e.Aggregate(),
|
|
domainSearchObject(e.Domain),
|
|
OrgDomainVerifiedSearchField,
|
|
&eventstore.Value{
|
|
Value: false,
|
|
ShouldIndex: false,
|
|
},
|
|
|
|
eventstore.FieldTypeInstanceID,
|
|
eventstore.FieldTypeResourceOwner,
|
|
eventstore.FieldTypeAggregateType,
|
|
eventstore.FieldTypeAggregateID,
|
|
eventstore.FieldTypeObjectType,
|
|
eventstore.FieldTypeObjectID,
|
|
eventstore.FieldTypeFieldName,
|
|
),
|
|
}
|
|
}
|
|
|
|
func NewDomainAddedEvent(ctx context.Context, aggregate *eventstore.Aggregate, domain string) *DomainAddedEvent {
|
|
return &DomainAddedEvent{
|
|
BaseEvent: *eventstore.NewBaseEventForPush(
|
|
ctx,
|
|
aggregate,
|
|
OrgDomainAddedEventType,
|
|
),
|
|
Domain: domain,
|
|
}
|
|
}
|
|
|
|
func DomainAddedEventMapper(event eventstore.Event) (eventstore.Event, error) {
|
|
orgDomainAdded := &DomainAddedEvent{
|
|
BaseEvent: *eventstore.BaseEventFromRepo(event),
|
|
}
|
|
err := event.Unmarshal(orgDomainAdded)
|
|
if err != nil {
|
|
return nil, zerrors.ThrowInternal(err, "ORG-GBr52", "unable to unmarshal org domain added")
|
|
}
|
|
|
|
return orgDomainAdded, nil
|
|
}
|
|
|
|
type DomainVerificationAddedEvent struct {
|
|
eventstore.BaseEvent `json:"-"`
|
|
|
|
Domain string `json:"domain,omitempty"`
|
|
ValidationType domain.OrgDomainValidationType `json:"validationType,omitempty"`
|
|
ValidationCode *crypto.CryptoValue `json:"validationCode,omitempty"`
|
|
}
|
|
|
|
func (e *DomainVerificationAddedEvent) Payload() interface{} {
|
|
return e
|
|
}
|
|
|
|
func (e *DomainVerificationAddedEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
|
|
return nil
|
|
}
|
|
|
|
func NewDomainVerificationAddedEvent(
|
|
ctx context.Context,
|
|
aggregate *eventstore.Aggregate,
|
|
domain string,
|
|
validationType domain.OrgDomainValidationType,
|
|
validationCode *crypto.CryptoValue,
|
|
) *DomainVerificationAddedEvent {
|
|
return &DomainVerificationAddedEvent{
|
|
BaseEvent: *eventstore.NewBaseEventForPush(
|
|
ctx,
|
|
aggregate,
|
|
OrgDomainVerificationAddedEventType,
|
|
),
|
|
Domain: domain,
|
|
ValidationType: validationType,
|
|
ValidationCode: validationCode,
|
|
}
|
|
}
|
|
|
|
func DomainVerificationAddedEventMapper(event eventstore.Event) (eventstore.Event, error) {
|
|
orgDomainVerificationAdded := &DomainVerificationAddedEvent{
|
|
BaseEvent: *eventstore.BaseEventFromRepo(event),
|
|
}
|
|
err := event.Unmarshal(orgDomainVerificationAdded)
|
|
if err != nil {
|
|
return nil, zerrors.ThrowInternal(err, "ORG-NRN32", "unable to unmarshal org domain verification added")
|
|
}
|
|
|
|
return orgDomainVerificationAdded, nil
|
|
}
|
|
|
|
type DomainVerificationFailedEvent struct {
|
|
eventstore.BaseEvent `json:"-"`
|
|
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
func (e *DomainVerificationFailedEvent) Payload() interface{} {
|
|
return e
|
|
}
|
|
|
|
func (e *DomainVerificationFailedEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
|
|
return nil
|
|
}
|
|
|
|
func NewDomainVerificationFailedEvent(ctx context.Context, aggregate *eventstore.Aggregate, domain string) *DomainVerificationFailedEvent {
|
|
return &DomainVerificationFailedEvent{
|
|
BaseEvent: *eventstore.NewBaseEventForPush(
|
|
ctx,
|
|
aggregate,
|
|
OrgDomainVerificationFailedEventType,
|
|
),
|
|
Domain: domain,
|
|
}
|
|
}
|
|
|
|
func DomainVerificationFailedEventMapper(event eventstore.Event) (eventstore.Event, error) {
|
|
orgDomainVerificationFailed := &DomainVerificationFailedEvent{
|
|
BaseEvent: *eventstore.BaseEventFromRepo(event),
|
|
}
|
|
err := event.Unmarshal(orgDomainVerificationFailed)
|
|
if err != nil {
|
|
return nil, zerrors.ThrowInternal(err, "ORG-Bhm37", "unable to unmarshal org domain verification failed")
|
|
}
|
|
|
|
return orgDomainVerificationFailed, nil
|
|
}
|
|
|
|
type DomainVerifiedEvent struct {
|
|
eventstore.BaseEvent `json:"-"`
|
|
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
func (e *DomainVerifiedEvent) Payload() interface{} {
|
|
return e
|
|
}
|
|
|
|
func (e *DomainVerifiedEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
|
|
return []*eventstore.UniqueConstraint{NewAddOrgDomainUniqueConstraint(e.Domain).WithOwners(eventstore.OwnerTag(eventstore.UniqueConstraintOwnerOrg, e.Aggregate().ID))}
|
|
}
|
|
|
|
func (e *DomainVerifiedEvent) Fields() []*eventstore.FieldOperation {
|
|
return []*eventstore.FieldOperation{
|
|
eventstore.SetField(
|
|
e.Aggregate(),
|
|
domainSearchObject(e.Domain),
|
|
OrgDomainVerifiedSearchField,
|
|
&eventstore.Value{
|
|
Value: true,
|
|
ShouldIndex: false,
|
|
},
|
|
|
|
eventstore.FieldTypeInstanceID,
|
|
eventstore.FieldTypeResourceOwner,
|
|
eventstore.FieldTypeAggregateType,
|
|
eventstore.FieldTypeAggregateID,
|
|
eventstore.FieldTypeObjectType,
|
|
eventstore.FieldTypeObjectID,
|
|
eventstore.FieldTypeFieldName,
|
|
),
|
|
}
|
|
}
|
|
|
|
func NewDomainVerifiedEvent(ctx context.Context, aggregate *eventstore.Aggregate, domain string) *DomainVerifiedEvent {
|
|
return &DomainVerifiedEvent{
|
|
BaseEvent: *eventstore.NewBaseEventForPush(
|
|
ctx,
|
|
aggregate,
|
|
OrgDomainVerifiedEventType,
|
|
),
|
|
Domain: domain,
|
|
}
|
|
}
|
|
|
|
func DomainVerifiedEventMapper(event eventstore.Event) (eventstore.Event, error) {
|
|
orgDomainVerified := &DomainVerifiedEvent{
|
|
BaseEvent: *eventstore.BaseEventFromRepo(event),
|
|
}
|
|
err := event.Unmarshal(orgDomainVerified)
|
|
if err != nil {
|
|
return nil, zerrors.ThrowInternal(err, "ORG-BFSwt", "unable to unmarshal org domain verified")
|
|
}
|
|
|
|
return orgDomainVerified, nil
|
|
}
|
|
|
|
type DomainPrimarySetEvent struct {
|
|
eventstore.BaseEvent `json:"-"`
|
|
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
func (e *DomainPrimarySetEvent) Payload() interface{} {
|
|
return e
|
|
}
|
|
|
|
func (e *DomainPrimarySetEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
|
|
return nil
|
|
}
|
|
|
|
func NewDomainPrimarySetEvent(ctx context.Context, aggregate *eventstore.Aggregate, domain string) *DomainPrimarySetEvent {
|
|
return &DomainPrimarySetEvent{
|
|
BaseEvent: *eventstore.NewBaseEventForPush(
|
|
ctx,
|
|
aggregate,
|
|
OrgDomainPrimarySetEventType,
|
|
),
|
|
Domain: domain,
|
|
}
|
|
}
|
|
|
|
func DomainPrimarySetEventMapper(event eventstore.Event) (eventstore.Event, error) {
|
|
orgDomainPrimarySet := &DomainPrimarySetEvent{
|
|
BaseEvent: *eventstore.BaseEventFromRepo(event),
|
|
}
|
|
err := event.Unmarshal(orgDomainPrimarySet)
|
|
if err != nil {
|
|
return nil, zerrors.ThrowInternal(err, "ORG-N5787", "unable to unmarshal org domain primary set")
|
|
}
|
|
|
|
return orgDomainPrimarySet, nil
|
|
}
|
|
|
|
type DomainRemovedEvent struct {
|
|
eventstore.BaseEvent `json:"-"`
|
|
|
|
Domain string `json:"domain,omitempty"`
|
|
isVerified bool
|
|
}
|
|
|
|
func (e *DomainRemovedEvent) Payload() interface{} {
|
|
return e
|
|
}
|
|
|
|
func (e *DomainRemovedEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
|
|
if !e.isVerified {
|
|
return nil
|
|
}
|
|
return []*eventstore.UniqueConstraint{NewRemoveOrgDomainUniqueConstraint(e.Domain)}
|
|
}
|
|
|
|
func (e *DomainRemovedEvent) Fields() []*eventstore.FieldOperation {
|
|
return []*eventstore.FieldOperation{
|
|
eventstore.SetField(
|
|
e.Aggregate(),
|
|
domainSearchObject(e.Domain),
|
|
OrgDomainVerifiedSearchField,
|
|
&eventstore.Value{
|
|
Value: false,
|
|
ShouldIndex: false,
|
|
},
|
|
|
|
eventstore.FieldTypeInstanceID,
|
|
eventstore.FieldTypeResourceOwner,
|
|
eventstore.FieldTypeAggregateType,
|
|
eventstore.FieldTypeAggregateID,
|
|
eventstore.FieldTypeObjectType,
|
|
eventstore.FieldTypeObjectID,
|
|
eventstore.FieldTypeFieldName,
|
|
),
|
|
}
|
|
}
|
|
|
|
func NewDomainRemovedEvent(ctx context.Context, aggregate *eventstore.Aggregate, domain string, verified bool) *DomainRemovedEvent {
|
|
return &DomainRemovedEvent{
|
|
BaseEvent: *eventstore.NewBaseEventForPush(
|
|
ctx,
|
|
aggregate,
|
|
OrgDomainRemovedEventType,
|
|
),
|
|
Domain: domain,
|
|
isVerified: verified,
|
|
}
|
|
}
|
|
|
|
func DomainRemovedEventMapper(event eventstore.Event) (eventstore.Event, error) {
|
|
orgDomainRemoved := &DomainRemovedEvent{
|
|
BaseEvent: *eventstore.BaseEventFromRepo(event),
|
|
}
|
|
err := event.Unmarshal(orgDomainRemoved)
|
|
if err != nil {
|
|
return nil, zerrors.ThrowInternal(err, "ORG-BngB2", "unable to unmarshal org domain removed")
|
|
}
|
|
|
|
return orgDomainRemoved, nil
|
|
}
|
|
|
|
func domainSearchObject(domain string) eventstore.Object {
|
|
return eventstore.Object{
|
|
Type: OrgDomainSearchType,
|
|
ID: domain,
|
|
Revision: OrgDomainObjectRevision,
|
|
}
|
|
}
|