feat(api): feature flags (#7356)

* feat(api): feature API proto definitions * update proto based on discussion with @livio-a * cleanup old feature flag stuff * authz instance queries * align defaults * projection definitions * define commands and event reducers * implement system and instance setter APIs * api getter implementation * unit test repository package * command unit tests * unit test Get queries * grpc converter unit tests * migrate the V1 features * migrate oidc to dynamic features * projection unit test * fix instance by host * fix instance by id data type in sql * fix linting errors * add system projection test * fix behavior inversion * resolve proto file comments * rename SystemDefaultLoginInstanceEventType to SystemLoginDefaultOrgEventType so it's consistent with the instance level event * use write models and conditional set events * system features integration tests * instance features integration tests * error on empty request * documentation entry * typo in feature.proto * fix start unit tests * solve linting error on key case switch * remove system defaults after discussion with @eliobischof * fix system feature projection * resolve comments in defaults.yaml --------- Co-authored-by: Livio Spring <livio.a@gmail.com>
2025-08-11 21:07:31 +00:00 · 2024-02-28 10:55:54 +02:00
parent 2801167668
commit 26d1563643
79 changed files with 4580 additions and 868 deletions
--- a/internal/query/projection/instance_features.go
+++ b/internal/query/projection/instance_features.go
@@ -0,0 +1,120 @@
+package projection
+
+import (
+	"context"
+
+	"github.com/zitadel/zitadel/internal/eventstore"
+	old_handler "github.com/zitadel/zitadel/internal/eventstore/handler"
+	"github.com/zitadel/zitadel/internal/eventstore/handler/v2"
+	feature_v1 "github.com/zitadel/zitadel/internal/repository/feature"
+	"github.com/zitadel/zitadel/internal/repository/feature/feature_v2"
+	"github.com/zitadel/zitadel/internal/repository/instance"
+	"github.com/zitadel/zitadel/internal/zerrors"
+)
+
+const (
+	InstanceFeatureTable = "projections.instance_features"
+
+	InstanceFeatureInstanceIDCol   = "instance_id"
+	InstanceFeatureKeyCol          = "key"
+	InstanceFeatureCreationDateCol = "creation_date"
+	InstanceFeatureChangeDateCol   = "change_date"
+	InstanceFeatureSequenceCol     = "sequence"
+	InstanceFeatureValueCol        = "value"
+)
+
+type instanceFeatureProjection struct{}
+
+func newInstanceFeatureProjection(ctx context.Context, config handler.Config) *handler.Handler {
+	return handler.NewHandler(ctx, &config, new(instanceFeatureProjection))
+}
+
+func (*instanceFeatureProjection) Name() string {
+	return InstanceFeatureTable
+}
+
+func (*instanceFeatureProjection) Init() *old_handler.Check {
+	return handler.NewTableCheck(handler.NewTable(
+		[]*handler.InitColumn{
+			handler.NewColumn(InstanceFeatureInstanceIDCol, handler.ColumnTypeText),
+			handler.NewColumn(InstanceFeatureKeyCol, handler.ColumnTypeText),
+			handler.NewColumn(InstanceFeatureCreationDateCol, handler.ColumnTypeTimestamp),
+			handler.NewColumn(InstanceFeatureChangeDateCol, handler.ColumnTypeTimestamp),
+			handler.NewColumn(InstanceFeatureSequenceCol, handler.ColumnTypeInt64),
+			handler.NewColumn(InstanceFeatureValueCol, handler.ColumnTypeJSONB),
+		},
+		handler.NewPrimaryKey(InstanceFeatureInstanceIDCol, InstanceFeatureKeyCol),
+	))
+}
+
+func (*instanceFeatureProjection) Reducers() []handler.AggregateReducer {
+	return []handler.AggregateReducer{{
+		Aggregate: feature_v2.AggregateType,
+		EventReducers: []handler.EventReducer{
+			{
+				Event:  feature_v1.DefaultLoginInstanceEventType,
+				Reduce: reduceSetDefaultLoginInstance_v1,
+			},
+			{
+				Event:  feature_v2.InstanceResetEventType,
+				Reduce: reduceInstanceResetFeatures,
+			},
+			{
+				Event:  feature_v2.InstanceLoginDefaultOrgEventType,
+				Reduce: reduceInstanceSetFeature[bool],
+			},
+			{
+				Event:  feature_v2.InstanceTriggerIntrospectionProjectionsEventType,
+				Reduce: reduceInstanceSetFeature[bool],
+			},
+			{
+				Event:  feature_v2.InstanceLegacyIntrospectionEventType,
+				Reduce: reduceInstanceSetFeature[bool],
+			},
+			{
+				Event:  instance.InstanceRemovedEventType,
+				Reduce: reduceInstanceRemovedHelper(InstanceDomainInstanceIDCol),
+			},
+		},
+	}}
+}
+
+func reduceSetDefaultLoginInstance_v1(event eventstore.Event) (*handler.Statement, error) {
+	e, ok := event.(*feature_v1.SetEvent[feature_v1.Boolean])
+	if !ok {
+		return nil, zerrors.ThrowInvalidArgumentf(nil, "PROJE-in2Xo", "reduce.wrong.event.type %T", event)
+	}
+	return reduceInstanceSetFeature[bool](
+		feature_v1.DefaultLoginInstanceEventToV2(e),
+	)
+}
+
+func reduceInstanceSetFeature[T any](event eventstore.Event) (*handler.Statement, error) {
+	e, ok := event.(*feature_v2.SetEvent[T])
+	if !ok {
+		return nil, zerrors.ThrowInvalidArgumentf(nil, "PROJE-uPh8O", "reduce.wrong.event.type %T", event)
+	}
+	f, err := e.FeatureJSON()
+	if err != nil {
+		return nil, err
+	}
+	columns := []handler.Column{
+		handler.NewCol(InstanceFeatureInstanceIDCol, e.Aggregate().ID),
+		handler.NewCol(InstanceFeatureKeyCol, f.Key.String()),
+		handler.NewCol(InstanceFeatureCreationDateCol, handler.OnlySetValueOnInsert(InstanceFeatureTable, e.CreationDate())),
+		handler.NewCol(InstanceFeatureChangeDateCol, e.CreationDate()),
+		handler.NewCol(InstanceFeatureSequenceCol, e.Sequence()),
+		handler.NewCol(InstanceFeatureValueCol, f.Value),
+	}
+	return handler.NewUpsertStatement(e, columns[0:2], columns), nil
+}
+
+func reduceInstanceResetFeatures(event eventstore.Event) (*handler.Statement, error) {
+	e, ok := event.(*feature_v2.ResetEvent)
+	if !ok {
+		return nil, zerrors.ThrowInvalidArgumentf(nil, "PROJE-roo6A", "reduce.wrong.event.type %T", event)
+	}
+	return handler.NewDeleteStatement(e, []handler.Condition{
+		handler.NewCond(InstanceFeatureInstanceIDCol, e.Aggregate().ID),
+	}), nil
+}