zitadel/internal/eventstore/repository/event.go

123 lines
3.2 KiB
Go
Raw Normal View History

2020-09-30 08:00:05 +00:00
package repository
2020-09-24 06:52:10 +00:00
2020-09-30 08:00:05 +00:00
import (
"database/sql"
"encoding/json"
2020-09-30 08:00:05 +00:00
"time"
"github.com/zitadel/zitadel/internal/eventstore"
2020-09-30 08:00:05 +00:00
)
2020-09-24 06:52:10 +00:00
var _ eventstore.Event = (*Event)(nil)
// Event represents all information about a manipulation of an aggregate
2020-09-24 06:52:10 +00:00
type Event struct {
//ID is a generated uuid for this event
ID string
// Seq is the sequence of the event
Seq uint64
// Pos is the global sequence of the event multiple events can have the same sequence
Pos float64
2020-09-24 06:52:10 +00:00
//CreationDate is the time the event is created
// it's used for human readability.
// Don't use it for event ordering,
// time drifts in different services could cause integrity problems
CreationDate time.Time
// Typ describes the cause of the event (e.g. user.added)
2020-09-24 06:52:10 +00:00
// it should always be in past-form
Typ eventstore.EventType
2020-09-24 06:52:10 +00:00
//Data describe the changed fields (e.g. userName = "hodor")
// data must always a pointer to a struct, a struct or a byte array containing json bytes
Data []byte
2020-09-24 06:52:10 +00:00
//EditorUser should be a unique identifier for the user which created the event
// it's meant for maintainability.
// It's recommend to use the aggregate id of the user
EditorUser string
//Version describes the definition of the aggregate at a certain point in time
// it's used in read models to reduce the events in the correct definition
Version eventstore.Version
2020-09-24 06:52:10 +00:00
//AggregateID id is the unique identifier of the aggregate
// the client must generate it by it's own
AggregateID string
//AggregateType describes the meaning of the aggregate for this event
// it could an object like user
AggregateType eventstore.AggregateType
2020-09-24 06:52:10 +00:00
//ResourceOwner is the organisation which owns this aggregate
// an aggregate can only be managed by one organisation
// use the ID of the org
ResourceOwner sql.NullString
//InstanceID is the instance where this event belongs to
// use the ID of the instance
InstanceID string
Constraints []*eventstore.UniqueConstraint
2020-09-24 06:52:10 +00:00
}
// Aggregate implements [eventstore.Event]
func (e *Event) Aggregate() *eventstore.Aggregate {
return &eventstore.Aggregate{
ID: e.AggregateID,
Type: e.AggregateType,
ResourceOwner: e.ResourceOwner.String,
InstanceID: e.InstanceID,
Version: e.Version,
}
}
2020-10-05 17:09:26 +00:00
// Creator implements [eventstore.Event]
func (e *Event) Creator() string {
return e.EditorUser
}
// Type implements [eventstore.Event]
func (e *Event) Type() eventstore.EventType {
return e.Typ
}
// Revision implements [eventstore.Event]
func (e *Event) Revision() uint16 {
return 0
}
// Sequence implements [eventstore.Event]
func (e *Event) Sequence() uint64 {
return e.Seq
}
// Position implements [eventstore.Event]
func (e *Event) Position() float64 {
return e.Pos
}
// CreatedAt implements [eventstore.Event]
func (e *Event) CreatedAt() time.Time {
return e.CreationDate
}
// Unmarshal implements [eventstore.Event]
func (e *Event) Unmarshal(ptr any) error {
if len(e.Data) == 0 {
return nil
}
return json.Unmarshal(e.Data, ptr)
}
// DataAsBytes implements [eventstore.Event]
func (e *Event) DataAsBytes() []byte {
return e.Data
}
func (e *Event) Payload() any {
return e.Data
}
func (e *Event) UniqueConstraints() []*eventstore.UniqueConstraint {
return e.Constraints
}