mirror of
https://github.com/zitadel/zitadel.git
synced 2024-12-13 03:24:26 +00:00
5fd2061770
# Which Problems Are Solved Currently the OIDC API of ZITADEL only prints parent errors to the logs. Where 4xx status are typically warn level and 5xx error level. This makes it hard to debug certain errors for client in multi-instance environments like ZITADEL cloud, where there is no direct access to logs. In case of support requests we often can't correlate past log-lines to the error that was reported. This change adds the possibility to return the parent error in the response to the OIDC client. For the moment this only applies to JSON body responses, not error redirects to the RP. # How the Problems Are Solved - New instance-level feature flag: `debug_oidc_parent_error` - Use the new `WithReturnParentToClient()` function from the oidc lib introduced in https://github.com/zitadel/oidc/pull/629 for all cases where `WithParent` was already used and the request context is available. # Additional Changes none # Additional Context - Depends on: https://github.com/zitadel/oidc/pull/629 - Related to: https://github.com/zitadel/zitadel/issues/8362 --------- Co-authored-by: Livio Spring <livio.a@gmail.com>
143 lines
5.0 KiB
Go
143 lines
5.0 KiB
Go
package feature_v2
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"strings"
|
|
|
|
"github.com/zitadel/zitadel/internal/eventstore"
|
|
"github.com/zitadel/zitadel/internal/feature"
|
|
"github.com/zitadel/zitadel/internal/zerrors"
|
|
)
|
|
|
|
var (
|
|
SystemResetEventType = resetEventTypeFromFeature(feature.LevelSystem)
|
|
SystemLoginDefaultOrgEventType = setEventTypeFromFeature(feature.LevelSystem, feature.KeyLoginDefaultOrg)
|
|
SystemTriggerIntrospectionProjectionsEventType = setEventTypeFromFeature(feature.LevelSystem, feature.KeyTriggerIntrospectionProjections)
|
|
SystemLegacyIntrospectionEventType = setEventTypeFromFeature(feature.LevelSystem, feature.KeyLegacyIntrospection)
|
|
SystemUserSchemaEventType = setEventTypeFromFeature(feature.LevelSystem, feature.KeyUserSchema)
|
|
SystemTokenExchangeEventType = setEventTypeFromFeature(feature.LevelSystem, feature.KeyTokenExchange)
|
|
SystemActionsEventType = setEventTypeFromFeature(feature.LevelSystem, feature.KeyActions)
|
|
SystemImprovedPerformanceEventType = setEventTypeFromFeature(feature.LevelSystem, feature.KeyImprovedPerformance)
|
|
|
|
InstanceResetEventType = resetEventTypeFromFeature(feature.LevelInstance)
|
|
InstanceLoginDefaultOrgEventType = setEventTypeFromFeature(feature.LevelInstance, feature.KeyLoginDefaultOrg)
|
|
InstanceTriggerIntrospectionProjectionsEventType = setEventTypeFromFeature(feature.LevelInstance, feature.KeyTriggerIntrospectionProjections)
|
|
InstanceLegacyIntrospectionEventType = setEventTypeFromFeature(feature.LevelInstance, feature.KeyLegacyIntrospection)
|
|
InstanceUserSchemaEventType = setEventTypeFromFeature(feature.LevelInstance, feature.KeyUserSchema)
|
|
InstanceTokenExchangeEventType = setEventTypeFromFeature(feature.LevelInstance, feature.KeyTokenExchange)
|
|
InstanceActionsEventType = setEventTypeFromFeature(feature.LevelInstance, feature.KeyActions)
|
|
InstanceImprovedPerformanceEventType = setEventTypeFromFeature(feature.LevelInstance, feature.KeyImprovedPerformance)
|
|
InstanceWebKeyEventType = setEventTypeFromFeature(feature.LevelInstance, feature.KeyWebKey)
|
|
InstanceDebugOIDCParentErrorEventType = setEventTypeFromFeature(feature.LevelInstance, feature.KeyDebugOIDCParentError)
|
|
)
|
|
|
|
const (
|
|
resetSuffix = "reset"
|
|
setSuffix = "set"
|
|
)
|
|
|
|
func resetEventTypeFromFeature(level feature.Level) eventstore.EventType {
|
|
return eventstore.EventType(strings.Join([]string{AggregateType, level.String(), resetSuffix}, "."))
|
|
}
|
|
|
|
func setEventTypeFromFeature(level feature.Level, key feature.Key) eventstore.EventType {
|
|
return eventstore.EventType(strings.Join([]string{AggregateType, level.String(), key.String(), setSuffix}, "."))
|
|
}
|
|
|
|
type ResetEvent struct {
|
|
*eventstore.BaseEvent `json:"-"`
|
|
}
|
|
|
|
func (e *ResetEvent) SetBaseEvent(b *eventstore.BaseEvent) {
|
|
e.BaseEvent = b
|
|
}
|
|
|
|
func (e *ResetEvent) Payload() interface{} {
|
|
return e
|
|
}
|
|
|
|
func (e *ResetEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
|
|
return nil
|
|
}
|
|
|
|
func NewResetEvent(
|
|
ctx context.Context,
|
|
aggregate *Aggregate,
|
|
eventType eventstore.EventType,
|
|
) *ResetEvent {
|
|
return &ResetEvent{
|
|
eventstore.NewBaseEventForPush(
|
|
ctx, &aggregate.Aggregate, eventType),
|
|
}
|
|
}
|
|
|
|
type SetEvent[T any] struct {
|
|
*eventstore.BaseEvent `json:"-"`
|
|
|
|
Value T
|
|
}
|
|
|
|
func (e *SetEvent[T]) SetBaseEvent(b *eventstore.BaseEvent) {
|
|
e.BaseEvent = b
|
|
}
|
|
|
|
func (e *SetEvent[T]) Payload() interface{} {
|
|
return e
|
|
}
|
|
|
|
func (e *SetEvent[T]) UniqueConstraints() []*eventstore.UniqueConstraint {
|
|
return nil
|
|
}
|
|
|
|
type FeatureJSON struct {
|
|
Key feature.Key
|
|
Value []byte
|
|
}
|
|
|
|
// FeatureJSON prepares converts the event to a key-value pair with a JSON value payload.
|
|
func (e *SetEvent[T]) FeatureJSON() (*FeatureJSON, error) {
|
|
_, key, err := e.FeatureInfo()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
jsonValue, err := json.Marshal(e.Value)
|
|
if err != nil {
|
|
return nil, zerrors.ThrowInternalf(err, "FEAT-go9Ji", "reduce.wrong.event.type %s", e.EventType)
|
|
}
|
|
return &FeatureJSON{
|
|
Key: key,
|
|
Value: jsonValue,
|
|
}, nil
|
|
}
|
|
|
|
// FeatureInfo extracts a feature's level and key from the event.
|
|
func (e *SetEvent[T]) FeatureInfo() (feature.Level, feature.Key, error) {
|
|
ss := strings.Split(string(e.EventType), ".")
|
|
if len(ss) != 4 {
|
|
return 0, 0, zerrors.ThrowInternalf(nil, "FEAT-Ahs4m", "reduce.wrong.event.type %s", e.EventType)
|
|
}
|
|
level, err := feature.LevelString(ss[1])
|
|
if err != nil {
|
|
return 0, 0, zerrors.ThrowInternalf(err, "FEAT-Boo2i", "reduce.wrong.event.type %s", e.EventType)
|
|
}
|
|
key, err := feature.KeyString(ss[2])
|
|
if err != nil {
|
|
return 0, 0, zerrors.ThrowInternalf(err, "FEAT-eir0M", "reduce.wrong.event.type %s", e.EventType)
|
|
}
|
|
return level, key, nil
|
|
}
|
|
|
|
func NewSetEvent[T any](
|
|
ctx context.Context,
|
|
aggregate *Aggregate,
|
|
eventType eventstore.EventType,
|
|
value T,
|
|
) *SetEvent[T] {
|
|
return &SetEvent[T]{
|
|
eventstore.NewBaseEventForPush(
|
|
ctx, &aggregate.Aggregate, eventType),
|
|
value,
|
|
}
|
|
}
|