mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-12 01:47:33 +00:00
feat(org): add org metadata functionality (#4234)
* feat(org): add org metadata functionality * fix(metadata): add unit tests and review for org metadata * fix(org-metadata): move endpoints to / Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>
This commit is contained in:
Stefan Benz
132
internal/query/projection/org_metadata.go
Normal file
132
internal/query/projection/org_metadata.go
Normal file
@@ -0,0 +1,132 @@
|
||||
package projection
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"github.com/zitadel/zitadel/internal/errors"
|
||||
"github.com/zitadel/zitadel/internal/eventstore"
|
||||
"github.com/zitadel/zitadel/internal/eventstore/handler"
|
||||
"github.com/zitadel/zitadel/internal/eventstore/handler/crdb"
|
||||
"github.com/zitadel/zitadel/internal/repository/org"
|
||||
)
|
||||
|
||||
const (
|
||||
OrgMetadataProjectionTable = "projections.org_metadata"
|
||||
|
||||
OrgMetadataColumnOrgID = "org_id"
|
||||
OrgMetadataColumnCreationDate = "creation_date"
|
||||
OrgMetadataColumnChangeDate = "change_date"
|
||||
OrgMetadataColumnSequence = "sequence"
|
||||
OrgMetadataColumnResourceOwner = "resource_owner"
|
||||
OrgMetadataColumnInstanceID = "instance_id"
|
||||
OrgMetadataColumnKey = "key"
|
||||
OrgMetadataColumnValue = "value"
|
||||
)
|
||||
|
||||
type orgMetadataProjection struct {
|
||||
crdb.StatementHandler
|
||||
}
|
||||
|
||||
func newOrgMetadataProjection(ctx context.Context, config crdb.StatementHandlerConfig) *orgMetadataProjection {
|
||||
p := new(orgMetadataProjection)
|
||||
config.ProjectionName = OrgMetadataProjectionTable
|
||||
config.Reducers = p.reducers()
|
||||
config.InitCheck = crdb.NewTableCheck(
|
||||
crdb.NewTable([]*crdb.Column{
|
||||
crdb.NewColumn(OrgMetadataColumnOrgID, crdb.ColumnTypeText),
|
||||
crdb.NewColumn(OrgMetadataColumnCreationDate, crdb.ColumnTypeTimestamp),
|
||||
crdb.NewColumn(OrgMetadataColumnChangeDate, crdb.ColumnTypeTimestamp),
|
||||
crdb.NewColumn(OrgMetadataColumnSequence, crdb.ColumnTypeInt64),
|
||||
crdb.NewColumn(OrgMetadataColumnResourceOwner, crdb.ColumnTypeText),
|
||||
crdb.NewColumn(OrgMetadataColumnInstanceID, crdb.ColumnTypeText),
|
||||
crdb.NewColumn(OrgMetadataColumnKey, crdb.ColumnTypeText),
|
||||
crdb.NewColumn(OrgMetadataColumnValue, crdb.ColumnTypeBytes, crdb.Nullable()),
|
||||
},
|
||||
crdb.NewPrimaryKey(OrgMetadataColumnInstanceID, OrgMetadataColumnOrgID, OrgMetadataColumnKey),
|
||||
),
|
||||
)
|
||||
|
||||
p.StatementHandler = crdb.NewStatementHandler(ctx, config)
|
||||
return p
|
||||
}
|
||||
|
||||
func (p *orgMetadataProjection) reducers() []handler.AggregateReducer {
|
||||
return []handler.AggregateReducer{
|
||||
{
|
||||
Aggregate: org.AggregateType,
|
||||
EventRedusers: []handler.EventReducer{
|
||||
{
|
||||
Event: org.MetadataSetType,
|
||||
Reduce: p.reduceMetadataSet,
|
||||
},
|
||||
{
|
||||
Event: org.MetadataRemovedType,
|
||||
Reduce: p.reduceMetadataRemoved,
|
||||
},
|
||||
{
|
||||
Event: org.MetadataRemovedAllType,
|
||||
Reduce: p.reduceMetadataRemovedAll,
|
||||
},
|
||||
{
|
||||
Event: org.OrgRemovedEventType,
|
||||
Reduce: p.reduceMetadataRemovedAll,
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func (p *orgMetadataProjection) reduceMetadataSet(event eventstore.Event) (*handler.Statement, error) {
|
||||
e, ok := event.(*org.MetadataSetEvent)
|
||||
if !ok {
|
||||
return nil, errors.ThrowInvalidArgumentf(nil, "HANDL-Ghn53", "reduce.wrong.event.type %s", org.MetadataSetType)
|
||||
}
|
||||
return crdb.NewUpsertStatement(
|
||||
e,
|
||||
[]handler.Column{
|
||||
handler.NewCol(OrgMetadataColumnInstanceID, nil),
|
||||
handler.NewCol(OrgMetadataColumnOrgID, nil),
|
||||
handler.NewCol(OrgMetadataColumnKey, e.Key),
|
||||
},
|
||||
[]handler.Column{
|
||||
handler.NewCol(OrgMetadataColumnInstanceID, e.Aggregate().InstanceID),
|
||||
handler.NewCol(OrgMetadataColumnOrgID, e.Aggregate().ID),
|
||||
handler.NewCol(OrgMetadataColumnKey, e.Key),
|
||||
handler.NewCol(OrgMetadataColumnResourceOwner, e.Aggregate().ResourceOwner),
|
||||
handler.NewCol(OrgMetadataColumnCreationDate, e.CreationDate()),
|
||||
handler.NewCol(OrgMetadataColumnChangeDate, e.CreationDate()),
|
||||
handler.NewCol(OrgMetadataColumnSequence, e.Sequence()),
|
||||
handler.NewCol(OrgMetadataColumnValue, e.Value),
|
||||
},
|
||||
), nil
|
||||
}
|
||||
|
||||
func (p *orgMetadataProjection) reduceMetadataRemoved(event eventstore.Event) (*handler.Statement, error) {
|
||||
e, ok := event.(*org.MetadataRemovedEvent)
|
||||
if !ok {
|
||||
return nil, errors.ThrowInvalidArgumentf(nil, "HANDL-Bm542", "reduce.wrong.event.type %s", org.MetadataRemovedType)
|
||||
}
|
||||
return crdb.NewDeleteStatement(
|
||||
e,
|
||||
[]handler.Condition{
|
||||
handler.NewCond(OrgMetadataColumnOrgID, e.Aggregate().ID),
|
||||
handler.NewCond(OrgMetadataColumnKey, e.Key),
|
||||
},
|
||||
), nil
|
||||
}
|
||||
|
||||
func (p *orgMetadataProjection) reduceMetadataRemovedAll(event eventstore.Event) (*handler.Statement, error) {
|
||||
switch event.(type) {
|
||||
case *org.MetadataRemovedAllEvent,
|
||||
*org.OrgRemovedEvent:
|
||||
//ok
|
||||
default:
|
||||
return nil, errors.ThrowInvalidArgumentf(nil, "HANDL-Bmnf3", "reduce.wrong.event.type %v", []eventstore.EventType{org.MetadataRemovedAllType, org.OrgRemovedEventType})
|
||||
}
|
||||
return crdb.NewDeleteStatement(
|
||||
event,
|
||||
[]handler.Condition{
|
||||
handler.NewCond(OrgMetadataColumnOrgID, event.Aggregate().ID),
|
||||
},
|
||||
), nil
|
||||
}
|
||||
158
internal/query/projection/org_metadata_test.go
Normal file
158
internal/query/projection/org_metadata_test.go
Normal file
@@ -0,0 +1,158 @@
|
||||
package projection
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/zitadel/zitadel/internal/errors"
|
||||
"github.com/zitadel/zitadel/internal/eventstore"
|
||||
"github.com/zitadel/zitadel/internal/eventstore/handler"
|
||||
"github.com/zitadel/zitadel/internal/eventstore/repository"
|
||||
"github.com/zitadel/zitadel/internal/repository/org"
|
||||
)
|
||||
|
||||
func TestOrgMetadataProjection_reduces(t *testing.T) {
|
||||
type args struct {
|
||||
event func(t *testing.T) eventstore.Event
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
args args
|
||||
reduce func(event eventstore.Event) (*handler.Statement, error)
|
||||
want wantReduce
|
||||
}{
|
||||
{
|
||||
name: "reduceMetadataSet",
|
||||
args: args{
|
||||
event: getEvent(testEvent(
|
||||
repository.EventType(org.MetadataSetType),
|
||||
org.AggregateType,
|
||||
[]byte(`{
|
||||
"key": "key",
|
||||
"value": "dmFsdWU="
|
||||
}`),
|
||||
), org.MetadataSetEventMapper),
|
||||
},
|
||||
reduce: (&orgMetadataProjection{}).reduceMetadataSet,
|
||||
want: wantReduce{
|
||||
aggregateType: org.AggregateType,
|
||||
sequence: 15,
|
||||
previousSequence: 10,
|
||||
projection: OrgMetadataProjectionTable,
|
||||
executer: &testExecuter{
|
||||
executions: []execution{
|
||||
{
|
||||
expectedStmt: "INSERT INTO projections.org_metadata (instance_id, org_id, key, resource_owner, creation_date, change_date, sequence, value) VALUES ($1, $2, $3, $4, $5, $6, $7, $8) ON CONFLICT (instance_id, org_id, key) DO UPDATE SET (resource_owner, creation_date, change_date, sequence, value) = (EXCLUDED.resource_owner, EXCLUDED.creation_date, EXCLUDED.change_date, EXCLUDED.sequence, EXCLUDED.value)",
|
||||
expectedArgs: []interface{}{
|
||||
"instance-id",
|
||||
"agg-id",
|
||||
"key",
|
||||
"ro-id",
|
||||
anyArg{},
|
||||
anyArg{},
|
||||
uint64(15),
|
||||
[]byte("value"),
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "reduceMetadataRemoved",
|
||||
args: args{
|
||||
event: getEvent(testEvent(
|
||||
repository.EventType(org.MetadataRemovedType),
|
||||
org.AggregateType,
|
||||
[]byte(`{
|
||||
"key": "key"
|
||||
}`),
|
||||
), org.MetadataRemovedEventMapper),
|
||||
},
|
||||
reduce: (&orgMetadataProjection{}).reduceMetadataRemoved,
|
||||
want: wantReduce{
|
||||
aggregateType: org.AggregateType,
|
||||
sequence: 15,
|
||||
previousSequence: 10,
|
||||
projection: OrgMetadataProjectionTable,
|
||||
executer: &testExecuter{
|
||||
executions: []execution{
|
||||
{
|
||||
expectedStmt: "DELETE FROM projections.org_metadata WHERE (org_id = $1) AND (key = $2)",
|
||||
expectedArgs: []interface{}{
|
||||
"agg-id",
|
||||
"key",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "reduceMetadataRemovedAll",
|
||||
args: args{
|
||||
event: getEvent(testEvent(
|
||||
repository.EventType(org.MetadataRemovedAllType),
|
||||
org.AggregateType,
|
||||
nil,
|
||||
), org.MetadataRemovedAllEventMapper),
|
||||
},
|
||||
reduce: (&orgMetadataProjection{}).reduceMetadataRemovedAll,
|
||||
want: wantReduce{
|
||||
aggregateType: org.AggregateType,
|
||||
sequence: 15,
|
||||
previousSequence: 10,
|
||||
projection: OrgMetadataProjectionTable,
|
||||
executer: &testExecuter{
|
||||
executions: []execution{
|
||||
{
|
||||
expectedStmt: "DELETE FROM projections.org_metadata WHERE (org_id = $1)",
|
||||
expectedArgs: []interface{}{
|
||||
"agg-id",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "reduceMetadataRemovedAll (org removed)",
|
||||
args: args{
|
||||
event: getEvent(testEvent(
|
||||
repository.EventType(org.OrgRemovedEventType),
|
||||
org.AggregateType,
|
||||
nil,
|
||||
), org.OrgRemovedEventMapper),
|
||||
},
|
||||
reduce: (&orgMetadataProjection{}).reduceMetadataRemovedAll,
|
||||
want: wantReduce{
|
||||
aggregateType: org.AggregateType,
|
||||
sequence: 15,
|
||||
previousSequence: 10,
|
||||
projection: OrgMetadataProjectionTable,
|
||||
executer: &testExecuter{
|
||||
executions: []execution{
|
||||
{
|
||||
expectedStmt: "DELETE FROM projections.org_metadata WHERE (org_id = $1)",
|
||||
expectedArgs: []interface{}{
|
||||
"agg-id",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
event := baseEvent(t)
|
||||
got, err := tt.reduce(event)
|
||||
if _, ok := err.(errors.InvalidArgument); !ok {
|
||||
t.Errorf("no wrong event mapping: %v, got: %v", err, got)
|
||||
}
|
||||
|
||||
event = tt.args.event(t)
|
||||
got, err = tt.reduce(event)
|
||||
assertReduce(t, got, err, tt.want)
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -20,6 +20,7 @@ const (
|
||||
var (
|
||||
projectionConfig crdb.StatementHandlerConfig
|
||||
OrgProjection *orgProjection
|
||||
OrgMetadataProjection *orgMetadataProjection
|
||||
ActionProjection *actionProjection
|
||||
FlowProjection *flowProjection
|
||||
ProjectProjection *projectProjection
|
||||
@@ -82,6 +83,7 @@ func Start(ctx context.Context, sqlClient *sql.DB, es *eventstore.Eventstore, co
|
||||
}
|
||||
|
||||
OrgProjection = newOrgProjection(ctx, applyCustomConfig(projectionConfig, config.Customizations["orgs"]))
|
||||
OrgMetadataProjection = newOrgMetadataProjection(ctx, applyCustomConfig(projectionConfig, config.Customizations["org_metadata"]))
|
||||
ActionProjection = newActionProjection(ctx, applyCustomConfig(projectionConfig, config.Customizations["actions"]))
|
||||
FlowProjection = newFlowProjection(ctx, applyCustomConfig(projectionConfig, config.Customizations["flows"]))
|
||||
ProjectProjection = newProjectProjection(ctx, applyCustomConfig(projectionConfig, config.Customizations["projects"]))
|
||||
|
||||
Reference in New Issue
Block a user