Files
zitadel/internal/command/user_metadata_model.go
6082e59d47 fix(eventstore): allow overwriting resource owner of events (#12261)
# Which Problems Are Solved

- The eventstore did not support intentionally overwriting the resource
owner when creating events for aggregates that may be reused across
owners.
- Resource owner handling was implicit and could not be controlled per
command/event type.
- We needed a safe way to distinguish between:
  - keeping the existing aggregate owner, and
  - explicitly setting a new owner for specific create-like events.

# How the Problems Are Solved

- Introduced a new eventstore command type with an explicit
enforce_owner flag.
- Updated eventstore.commands_to_events and eventstore.push so owner
assignment is now explicit:
  - if enforce_owner is true, the command owner is written
- if enforce_owner is false, the existing aggregate owner is retained
when present
- Added EnforceResourceOwnerCommand and wiring so command types can opt
in to enforced owner behavior.
- Wired the new behavior through the v3 eventstore push path, including
compatibility fallback for older command type mapping.
- Added migration/setup changes to register and use the new command type
and SQL functions.
- Added and updated tests for owner overwrite and aggregate ID reuse
scenarios.

# Additional Changes

- Added small migration/setup robustness improvements related to
eventstore setup ordering and helper reuse.
- Added focused test coverage for enforced owner behavior and
sequencing.
- Events that currently allow owner changes (implement
EnforceResourceOwner) are:
  - AddedEvent (action)
  - GroupAddedEvent
  - StartedEvent (idp intent)
  - ProjectAddedEvent
  - HumanAddedEvent
  - HumanRegisteredEvent
  - MachineAddedEvent
  - CreatedEvent (schema user)

# Additional Context

- Follow-up for eventstore owner-handling correctness in create flows
and aggregate ID reuse cases.
- No additional issue link was attached for this change.

---------

Co-authored-by: abhishek kumar gupta <abhishek818t@gmail.com>
2026-06-15 11:24:37 +02:00

175 lines
4.8 KiB
Go

package command
import (
"github.com/zitadel/zitadel/internal/eventstore"
"github.com/zitadel/zitadel/internal/repository/metadata"
"github.com/zitadel/zitadel/internal/repository/user"
)
type UserMetadataWriteModel struct {
MetadataWriteModel
}
func NewUserMetadataWriteModel(userID, resourceOwner, key string) *UserMetadataWriteModel {
return &UserMetadataWriteModel{
MetadataWriteModel{
WriteModel: eventstore.WriteModel{
AggregateID: userID,
ResourceOwner: resourceOwner,
},
Key: key,
},
}
}
func (wm *UserMetadataWriteModel) AppendEvents(events ...eventstore.Event) {
for _, event := range events {
switch e := event.(type) {
case *user.MetadataSetEvent:
wm.MetadataWriteModel.AppendEvents(&e.SetEvent)
case *user.MetadataRemovedEvent:
wm.MetadataWriteModel.AppendEvents(&e.RemovedEvent)
case *user.MetadataRemovedAllEvent:
wm.MetadataWriteModel.AppendEvents(&e.RemovedAllEvent)
default:
wm.MetadataWriteModel.AppendEvents(e)
}
}
}
func (wm *UserMetadataWriteModel) Query() *eventstore.SearchQueryBuilder {
return eventstore.NewSearchQueryBuilder(eventstore.ColumnsEvent).
ResourceOwner(wm.ResourceOwner).
AddQuery().
AggregateIDs(wm.MetadataWriteModel.AggregateID).
AggregateTypes(user.AggregateType).
EventTypes(
user.HumanAddedType,
user.HumanRegisteredType,
user.MachineAddedEventType,
user.UserRemovedType,
user.MetadataSetType,
user.MetadataRemovedType,
user.MetadataRemovedAllType).
Builder()
}
type UserMetadataListWriteModel struct {
MetadataListWriteModel
}
func NewUserMetadataListWriteModel(userID, resourceOwner string) *UserMetadataListWriteModel {
return &UserMetadataListWriteModel{
MetadataListWriteModel{
WriteModel: eventstore.WriteModel{
AggregateID: userID,
ResourceOwner: resourceOwner,
},
metadataList: make(map[string][]byte),
},
}
}
func (wm *UserMetadataListWriteModel) AppendEvents(events ...eventstore.Event) {
for _, event := range events {
switch e := event.(type) {
case *user.MetadataSetEvent:
wm.MetadataListWriteModel.AppendEvents(&e.SetEvent)
case *user.MetadataRemovedEvent:
wm.MetadataListWriteModel.AppendEvents(&e.RemovedEvent)
case *user.MetadataRemovedAllEvent:
wm.MetadataListWriteModel.AppendEvents(&e.RemovedAllEvent)
default:
wm.MetadataListWriteModel.AppendEvents(e)
}
}
}
func (wm *UserMetadataListWriteModel) Reduce() error {
return wm.MetadataListWriteModel.Reduce()
}
func (wm *UserMetadataListWriteModel) Query() *eventstore.SearchQueryBuilder {
return eventstore.NewSearchQueryBuilder(eventstore.ColumnsEvent).
ResourceOwner(wm.ResourceOwner).
AddQuery().
AggregateIDs(wm.MetadataListWriteModel.AggregateID).
AggregateTypes(user.AggregateType).
EventTypes(
user.HumanAddedType,
user.HumanRegisteredType,
user.MachineAddedEventType,
user.UserRemovedType,
user.MetadataSetType,
user.MetadataRemovedType,
user.MetadataRemovedAllType).
Builder()
}
type UserMetadataByOrgListWriteModel struct {
eventstore.WriteModel
UserMetadata map[string]map[string][]byte
}
func NewUserMetadataByOrgListWriteModel(resourceOwner string) *UserMetadataByOrgListWriteModel {
return &UserMetadataByOrgListWriteModel{
WriteModel: eventstore.WriteModel{
ResourceOwner: resourceOwner,
},
UserMetadata: make(map[string]map[string][]byte),
}
}
func (wm *UserMetadataByOrgListWriteModel) AppendEvents(events ...eventstore.Event) {
for _, event := range events {
switch e := event.(type) {
case *user.MetadataSetEvent:
wm.WriteModel.AppendEvents(&e.SetEvent)
case *user.MetadataRemovedEvent:
wm.WriteModel.AppendEvents(&e.RemovedEvent)
case *user.MetadataRemovedAllEvent:
wm.WriteModel.AppendEvents(&e.RemovedAllEvent)
default:
wm.WriteModel.AppendEvents(e)
}
}
}
func (wm *UserMetadataByOrgListWriteModel) Reduce() error {
for _, event := range wm.Events {
switch e := event.(type) {
case *metadata.SetEvent:
if val, ok := wm.UserMetadata[e.Aggregate().ID]; ok {
val[e.Key] = e.Value
} else {
wm.UserMetadata[e.Aggregate().ID] = map[string][]byte{
e.Key: e.Value,
}
}
case *metadata.RemovedEvent:
if val, ok := wm.UserMetadata[e.Aggregate().ID]; ok {
delete(val, e.Key)
}
case *metadata.RemovedAllEvent, *user.HumanAddedEvent, *user.HumanRegisteredEvent, *user.MachineAddedEvent, *user.UserRemovedEvent:
delete(wm.UserMetadata, e.Aggregate().ID)
}
}
return wm.WriteModel.Reduce()
}
func (wm *UserMetadataByOrgListWriteModel) Query() *eventstore.SearchQueryBuilder {
return eventstore.NewSearchQueryBuilder(eventstore.ColumnsEvent).
ResourceOwner(wm.ResourceOwner).
AddQuery().
AggregateTypes(user.AggregateType).
EventTypes(
user.HumanAddedType,
user.HumanRegisteredType,
user.MachineAddedEventType,
user.UserRemovedType,
user.MetadataSetType,
user.MetadataRemovedType,
user.MetadataRemovedAllType).
Builder()
}