Files
zitadel/internal/repository/usergrant/user_grant.go
T
3ff4fbc7e4 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>&nbsp;<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>&nbsp;</div>

---------

Co-authored-by: Cursor Agent <[email protected]>
Co-authored-by: Silvan <[email protected]>
2026-09-18 15:08:42 +02:00

327 lines
9.3 KiB
Go

package usergrant
import (
"context"
"fmt"
"github.com/zitadel/zitadel/internal/eventstore"
"github.com/zitadel/zitadel/internal/zerrors"
)
const (
UniqueUserGrant = "user_grant"
userGrantEventTypePrefix = eventstore.EventType("user.grant.")
UserGrantAddedType = userGrantEventTypePrefix + "added"
UserGrantChangedType = userGrantEventTypePrefix + "changed"
UserGrantCascadeChangedType = userGrantEventTypePrefix + "cascade.changed"
UserGrantRemovedType = userGrantEventTypePrefix + "removed"
UserGrantCascadeRemovedType = userGrantEventTypePrefix + "cascade.removed"
UserGrantDeactivatedType = userGrantEventTypePrefix + "deactivated"
UserGrantReactivatedType = userGrantEventTypePrefix + "reactivated"
)
func NewAddUserGrantUniqueConstraint(resourceOwner, userID, projectID, projectGrantID string) *eventstore.UniqueConstraint {
return eventstore.NewAddEventUniqueConstraint(
UniqueUserGrant,
fmt.Sprintf("%s:%s:%s:%v", resourceOwner, userID, projectID, projectGrantID),
"Errors.UserGrant.AlreadyExists")
}
func NewRemoveUserGrantUniqueConstraint(resourceOwner, userID, projectID, projectGrantID string) *eventstore.UniqueConstraint {
return eventstore.NewRemoveUniqueConstraint(
UniqueUserGrant,
fmt.Sprintf("%s:%s:%s:%s", resourceOwner, userID, projectID, projectGrantID))
}
type UserGrantAddedEvent struct {
eventstore.BaseEvent `json:"-"`
UserID string `json:"userId,omitempty"`
ProjectID string `json:"projectId,omitempty"`
ProjectGrantID string `json:"grantId,omitempty"`
RoleKeys []string `json:"roleKeys,omitempty"`
// owner orgs are not persisted in the event payload.
userResourceOwner string
projectResourceOwner string
grantedOrg string
}
func (e *UserGrantAddedEvent) Payload() interface{} {
return e
}
func userGrantOwnerTags(agg *eventstore.Aggregate, userID, userResourceOwner, projectID, projectResourceOwner, grantID, grantedOrg string) []string {
return []string{
eventstore.OwnerTag(eventstore.UniqueConstraintOwnerOrg, agg.ResourceOwner),
eventstore.OwnerTag(eventstore.UniqueConstraintOwnerOrg, userResourceOwner),
eventstore.OwnerTag(eventstore.UniqueConstraintOwnerOrg, projectResourceOwner),
eventstore.OwnerTag(eventstore.UniqueConstraintOwnerOrg, grantedOrg),
eventstore.OwnerTag(eventstore.UniqueConstraintOwnerUser, userID),
eventstore.OwnerTag(eventstore.UniqueConstraintOwnerProject, projectID),
eventstore.OwnerTag(eventstore.UniqueConstraintOwnerGrant, grantID),
}
}
func (e *UserGrantAddedEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
return []*eventstore.UniqueConstraint{NewAddUserGrantUniqueConstraint(e.Aggregate().ResourceOwner, e.UserID, e.ProjectID, e.ProjectGrantID).WithOwners(userGrantOwnerTags(e.Aggregate(), e.UserID, e.userResourceOwner, e.ProjectID, e.projectResourceOwner, e.ProjectGrantID, e.grantedOrg)...)}
}
func (e *UserGrantAddedEvent) WithOwnerOrgs(userResourceOwner, projectResourceOwner, grantedOrg string) *UserGrantAddedEvent {
e.userResourceOwner = userResourceOwner
e.projectResourceOwner = projectResourceOwner
e.grantedOrg = grantedOrg
return e
}
func NewUserGrantAddedEvent(
ctx context.Context,
aggregate *eventstore.Aggregate,
userID,
projectID,
projectGrantID string,
roleKeys []string) *UserGrantAddedEvent {
return &UserGrantAddedEvent{
BaseEvent: *eventstore.NewBaseEventForPush(
ctx,
aggregate,
UserGrantAddedType,
),
UserID: userID,
ProjectID: projectID,
ProjectGrantID: projectGrantID,
RoleKeys: roleKeys,
}
}
func UserGrantAddedEventMapper(event eventstore.Event) (eventstore.Event, error) {
e := &UserGrantAddedEvent{
BaseEvent: *eventstore.BaseEventFromRepo(event),
}
err := event.Unmarshal(e)
if err != nil {
return nil, zerrors.ThrowInternal(err, "UGRANT-0p9ol", "unable to unmarshal user grant")
}
return e, nil
}
type UserGrantChangedEvent struct {
eventstore.BaseEvent `json:"-"`
UserID string `json:"userId"`
RoleKeys []string `json:"roleKeys"`
}
func (e *UserGrantChangedEvent) Payload() interface{} {
return e
}
func (e *UserGrantChangedEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
return nil
}
func NewUserGrantChangedEvent(
ctx context.Context,
aggregate *eventstore.Aggregate,
userID string,
roleKeys []string) *UserGrantChangedEvent {
return &UserGrantChangedEvent{
BaseEvent: *eventstore.NewBaseEventForPush(
ctx,
aggregate,
UserGrantChangedType,
),
UserID: userID,
RoleKeys: roleKeys,
}
}
func UserGrantChangedEventMapper(event eventstore.Event) (eventstore.Event, error) {
e := &UserGrantChangedEvent{
BaseEvent: *eventstore.BaseEventFromRepo(event),
}
err := event.Unmarshal(e)
if err != nil {
return nil, zerrors.ThrowInternal(err, "UGRANT-4M0sd", "unable to unmarshal user grant")
}
return e, nil
}
type UserGrantCascadeChangedEvent struct {
eventstore.BaseEvent `json:"-"`
RoleKeys []string `json:"roleKeys,omitempty"`
}
func (e *UserGrantCascadeChangedEvent) Payload() interface{} {
return e
}
func (e *UserGrantCascadeChangedEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
return nil
}
func NewUserGrantCascadeChangedEvent(
ctx context.Context,
aggregate *eventstore.Aggregate,
roleKeys []string) *UserGrantCascadeChangedEvent {
return &UserGrantCascadeChangedEvent{
BaseEvent: *eventstore.NewBaseEventForPush(
ctx,
aggregate,
UserGrantCascadeChangedType,
),
RoleKeys: roleKeys,
}
}
func UserGrantCascadeChangedEventMapper(event eventstore.Event) (eventstore.Event, error) {
e := &UserGrantChangedEvent{
BaseEvent: *eventstore.BaseEventFromRepo(event),
}
err := event.Unmarshal(e)
if err != nil {
return nil, zerrors.ThrowInternal(err, "UGRANT-Gs9df", "unable to unmarshal user grant")
}
return e, nil
}
type UserGrantRemovedEvent struct {
eventstore.BaseEvent `json:"-"`
UserID string `json:"userId,omitempty"`
ProjectID string `json:"projectId,omitempty"`
ProjectGrantID string `json:"grantId,omitempty"`
}
func (e *UserGrantRemovedEvent) Payload() interface{} {
return e
}
func (e *UserGrantRemovedEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
return []*eventstore.UniqueConstraint{NewRemoveUserGrantUniqueConstraint(e.Aggregate().ResourceOwner, e.UserID, e.ProjectID, e.ProjectGrantID)}
}
func NewUserGrantRemovedEvent(
ctx context.Context,
aggregate *eventstore.Aggregate,
userID,
projectID,
projectGrantID string,
) *UserGrantRemovedEvent {
return &UserGrantRemovedEvent{
BaseEvent: *eventstore.NewBaseEventForPush(
ctx,
aggregate,
UserGrantRemovedType,
),
UserID: userID,
ProjectID: projectID,
ProjectGrantID: projectGrantID,
}
}
func UserGrantRemovedEventMapper(event eventstore.Event) (eventstore.Event, error) {
return &UserGrantRemovedEvent{
BaseEvent: *eventstore.BaseEventFromRepo(event),
}, nil
}
type UserGrantCascadeRemovedEvent struct {
eventstore.BaseEvent `json:"-"`
userID string `json:"-"`
projectID string `json:"-"`
projectGrantID string `json:"-"`
}
func (e *UserGrantCascadeRemovedEvent) Payload() interface{} {
return nil
}
func (e *UserGrantCascadeRemovedEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
return []*eventstore.UniqueConstraint{NewRemoveUserGrantUniqueConstraint(e.Aggregate().ResourceOwner, e.userID, e.projectID, e.projectGrantID)}
}
func NewUserGrantCascadeRemovedEvent(
ctx context.Context,
aggregate *eventstore.Aggregate,
userID,
projectID,
projectGrantID string,
) *UserGrantCascadeRemovedEvent {
return &UserGrantCascadeRemovedEvent{
BaseEvent: *eventstore.NewBaseEventForPush(
ctx,
aggregate,
UserGrantCascadeRemovedType,
),
userID: userID,
projectID: projectID,
projectGrantID: projectGrantID,
}
}
func UserGrantCascadeRemovedEventMapper(event eventstore.Event) (eventstore.Event, error) {
return &UserGrantCascadeRemovedEvent{
BaseEvent: *eventstore.BaseEventFromRepo(event),
}, nil
}
type UserGrantDeactivatedEvent struct {
eventstore.BaseEvent `json:"-"`
}
func (e *UserGrantDeactivatedEvent) Payload() interface{} {
return nil
}
func (e *UserGrantDeactivatedEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
return nil
}
func NewUserGrantDeactivatedEvent(ctx context.Context, aggregate *eventstore.Aggregate) *UserGrantDeactivatedEvent {
return &UserGrantDeactivatedEvent{
BaseEvent: *eventstore.NewBaseEventForPush(
ctx,
aggregate,
UserGrantDeactivatedType,
),
}
}
func UserGrantDeactivatedEventMapper(event eventstore.Event) (eventstore.Event, error) {
return &UserGrantDeactivatedEvent{
BaseEvent: *eventstore.BaseEventFromRepo(event),
}, nil
}
type UserGrantReactivatedEvent struct {
eventstore.BaseEvent `json:"-"`
}
func (e *UserGrantReactivatedEvent) Payload() interface{} {
return nil
}
func (e *UserGrantReactivatedEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
return nil
}
func NewUserGrantReactivatedEvent(ctx context.Context, aggregate *eventstore.Aggregate) *UserGrantReactivatedEvent {
return &UserGrantReactivatedEvent{
BaseEvent: *eventstore.NewBaseEventForPush(
ctx,
aggregate,
UserGrantReactivatedType,
),
}
}
func UserGrantReactivatedEventMapper(event eventstore.Event) (eventstore.Event, error) {
return &UserGrantReactivatedEvent{
BaseEvent: *eventstore.BaseEventFromRepo(event),
}, nil
}