mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-27 17:52:14 +00:00
feat: delete metadata on SetOrganizationMetadata api (#11790)
# Which Problems Are Solved Currently, to delete an Organization metadata key, callers must use a separate [DeleteMetadata](https://zitadel.com/docs/reference/api/org/zitadel.org.v2.OrganizationService.DeleteOrganizationMetadata) API. This increases the complexity on client-side for operations where metadata need to be synchronized. # How the Problems Are Solved Introduce deletion behavior to [SetOrganizationMetadata](https://zitadel.com/docs/reference/api/org/zitadel.org.v2.OrganizationService.SetOrganizationMetadata): When a metadata entry is passed with an empty value ("" / empty bytes): - If the key exists → delete the key - If the key does not exist → no-op (idempotent, no error) # Additional Changes n/a # Additional Context Relates to #11776 --------- Co-authored-by: Gayathri Vijayan <[email protected]> Co-authored-by: Gayathri Vijayan <[email protected]>
This commit is contained in:
co-authored by
Gayathri Vijayan
Gayathri Vijayan
parent
8b90ddb0b5
commit
62cb5bbb83
@@ -1,6 +1,7 @@
|
||||
package command
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
|
||||
"github.com/zitadel/zitadel/internal/domain"
|
||||
@@ -46,15 +47,42 @@ func (c *Commands) BulkSetOrgMetadata(ctx context.Context, orgID string, permiss
|
||||
return nil, err
|
||||
}
|
||||
|
||||
events := make([]eventstore.Command, len(metadatas))
|
||||
setMetadata := NewOrgMetadataListWriteModel(orgID)
|
||||
events := make([]eventstore.Command, 0)
|
||||
setMetadata, err := c.getOrgMetadataListModelByID(ctx, orgID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
orgAgg := OrgAggregateFromWriteModel(&setMetadata.WriteModel)
|
||||
for i, data := range metadatas {
|
||||
for _, data := range metadatas {
|
||||
existingValue, keyExists := setMetadata.metadataList[data.Key]
|
||||
|
||||
// if value is empty, a metadata remove event has to be pushed
|
||||
if len(data.Value) == 0 {
|
||||
// Ignore deletion if key does not exist
|
||||
if !keyExists {
|
||||
continue
|
||||
}
|
||||
|
||||
event := org.NewMetadataRemovedEvent(ctx, orgAgg, data.Key)
|
||||
events = append(events, event)
|
||||
continue
|
||||
}
|
||||
|
||||
// if no change to metadata no event has to be pushed
|
||||
if keyExists && bytes.Equal(existingValue, data.Value) {
|
||||
continue
|
||||
}
|
||||
|
||||
event, err := c.setOrgMetadata(ctx, orgAgg, data)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
events[i] = event
|
||||
events = append(events, event)
|
||||
}
|
||||
|
||||
// no changes for the metadata
|
||||
if len(events) == 0 {
|
||||
return writeModelToObjectDetails(&setMetadata.WriteModel), nil
|
||||
}
|
||||
|
||||
pushedEvents, err := c.eventstore.Push(ctx, events...)
|
||||
|
||||
@@ -196,32 +196,6 @@ func TestCommandSide_BulkSetOrgMetadata(t *testing.T) {
|
||||
err: zerrors.IsPreconditionFailed,
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "invalid metadata, pre condition error",
|
||||
fields: fields{
|
||||
eventstore: expectEventstore(
|
||||
expectFilter(
|
||||
eventFromEventPusher(
|
||||
org.NewOrgAddedEvent(context.Background(),
|
||||
&org.NewAggregate("org1").Aggregate,
|
||||
"ZITADEL",
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
},
|
||||
args: args{
|
||||
ctx: context.Background(),
|
||||
orgID: "org1",
|
||||
metadataList: []*domain.Metadata{
|
||||
{Key: "key"},
|
||||
{Key: "key1"},
|
||||
},
|
||||
},
|
||||
res: res{
|
||||
err: zerrors.IsErrorInvalidArgument,
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "add metadata, ok",
|
||||
fields: fields{
|
||||
@@ -234,6 +208,7 @@ func TestCommandSide_BulkSetOrgMetadata(t *testing.T) {
|
||||
),
|
||||
),
|
||||
),
|
||||
expectFilter(),
|
||||
expectPush(
|
||||
org.NewMetadataSetEvent(context.Background(),
|
||||
&org.NewAggregate("org1").Aggregate,
|
||||
@@ -274,6 +249,7 @@ func TestCommandSide_BulkSetOrgMetadata(t *testing.T) {
|
||||
),
|
||||
),
|
||||
),
|
||||
expectFilter(),
|
||||
expectPush(
|
||||
org.NewMetadataSetEvent(context.Background(),
|
||||
&org.NewAggregate("org1").Aggregate,
|
||||
@@ -303,6 +279,75 @@ func TestCommandSide_BulkSetOrgMetadata(t *testing.T) {
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "update and delete metadata, ok",
|
||||
fields: fields{
|
||||
eventstore: expectEventstore(
|
||||
expectFilter(
|
||||
eventFromEventPusher(
|
||||
org.NewOrgAddedEvent(context.Background(),
|
||||
&org.NewAggregate("org1").Aggregate,
|
||||
"ZITADEL",
|
||||
),
|
||||
),
|
||||
),
|
||||
expectFilter(
|
||||
eventFromEventPusher(
|
||||
org.NewMetadataSetEvent(context.Background(),
|
||||
&org.NewAggregate("org1").Aggregate,
|
||||
"key",
|
||||
[]byte("value"),
|
||||
),
|
||||
),
|
||||
eventFromEventPusher(
|
||||
org.NewMetadataSetEvent(context.Background(),
|
||||
&org.NewAggregate("org1").Aggregate,
|
||||
"key1",
|
||||
[]byte("value1"),
|
||||
),
|
||||
),
|
||||
eventFromEventPusher(
|
||||
org.NewMetadataSetEvent(context.Background(),
|
||||
&org.NewAggregate("org1").Aggregate,
|
||||
"key2",
|
||||
[]byte("value2"),
|
||||
),
|
||||
)),
|
||||
expectPush(
|
||||
org.NewMetadataSetEvent(context.Background(),
|
||||
&org.NewAggregate("org1").Aggregate,
|
||||
"key",
|
||||
[]byte("updated_value"),
|
||||
),
|
||||
org.NewMetadataRemovedEvent(context.Background(),
|
||||
&org.NewAggregate("org1").Aggregate,
|
||||
"key1",
|
||||
),
|
||||
org.NewMetadataSetEvent(context.Background(),
|
||||
&org.NewAggregate("org1").Aggregate,
|
||||
"key3",
|
||||
[]byte("value3"),
|
||||
),
|
||||
),
|
||||
),
|
||||
},
|
||||
args: args{
|
||||
ctx: context.Background(),
|
||||
orgID: "org1",
|
||||
metadataList: []*domain.Metadata{
|
||||
{Key: "key", Value: []byte("updated_value")}, // update an existing key
|
||||
{Key: "key1"}, // delete an existing key
|
||||
{Key: "key2", Value: []byte("value2")}, // unchanged value
|
||||
{Key: "key3", Value: []byte("value3")}, // add a new key
|
||||
{Key: "key4"}, // delete a non-existing key
|
||||
},
|
||||
},
|
||||
res: res{
|
||||
want: &domain.ObjectDetails{
|
||||
ResourceOwner: "org1",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "add metadata (no permission), error",
|
||||
fields: fields{
|
||||
|
||||
@@ -76,6 +76,7 @@ func (c *Commands) BulkSetUserMetadata(ctx context.Context, userID, resourceOwne
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// no changes for the metadata
|
||||
if len(events) == 0 {
|
||||
return writeModelToObjectDetails(&setMetadata.WriteModel), nil
|
||||
|
||||
Reference in New Issue
Block a user