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 19:07:30 +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/instance_features_model.go
+++ b/internal/query/instance_features_model.go
@@ -0,0 +1,109 @@
+package query
+
+import (
+	"context"
+
+	"github.com/zitadel/zitadel/internal/api/authz"
+	"github.com/zitadel/zitadel/internal/eventstore"
+	"github.com/zitadel/zitadel/internal/feature"
+	feature_v1 "github.com/zitadel/zitadel/internal/repository/feature"
+	"github.com/zitadel/zitadel/internal/repository/feature/feature_v2"
+)
+
+type InstanceFeaturesReadModel struct {
+	*eventstore.ReadModel
+	system   *SystemFeatures
+	instance *InstanceFeatures
+}
+
+func NewInstanceFeaturesReadModel(ctx context.Context, system *SystemFeatures) *InstanceFeaturesReadModel {
+	instanceID := authz.GetInstance(ctx).InstanceID()
+	m := &InstanceFeaturesReadModel{
+		ReadModel: &eventstore.ReadModel{
+			AggregateID:   instanceID,
+			ResourceOwner: instanceID,
+		},
+		instance: new(InstanceFeatures),
+		system:   system,
+	}
+	m.populateFromSystem()
+	return m
+}
+
+func (m *InstanceFeaturesReadModel) Reduce() (err error) {
+	for _, event := range m.Events {
+		switch e := event.(type) {
+		case *feature_v2.ResetEvent:
+			m.reduceReset()
+		case *feature_v1.SetEvent[feature_v1.Boolean]:
+			err = m.reduceBoolFeature(
+				feature_v1.DefaultLoginInstanceEventToV2(e),
+			)
+		case *feature_v2.SetEvent[bool]:
+			err = m.reduceBoolFeature(e)
+		}
+		if err != nil {
+			return err
+		}
+	}
+	return m.ReadModel.Reduce()
+}
+
+func (m *InstanceFeaturesReadModel) Query() *eventstore.SearchQueryBuilder {
+	return eventstore.NewSearchQueryBuilder(eventstore.ColumnsEvent).
+		AwaitOpenTransactions().
+		AddQuery().
+		AggregateTypes(feature_v2.AggregateType).
+		AggregateIDs(m.AggregateID).
+		EventTypes(
+			feature_v1.DefaultLoginInstanceEventType,
+			feature_v2.InstanceResetEventType,
+			feature_v2.InstanceLoginDefaultOrgEventType,
+			feature_v2.InstanceTriggerIntrospectionProjectionsEventType,
+			feature_v2.InstanceLegacyIntrospectionEventType,
+		).
+		Builder().ResourceOwner(m.ResourceOwner)
+}
+
+func (m *InstanceFeaturesReadModel) reduceReset() {
+	if m.populateFromSystem() {
+		return
+	}
+	m.instance.LoginDefaultOrg = FeatureSource[bool]{}
+	m.instance.TriggerIntrospectionProjections = FeatureSource[bool]{}
+	m.instance.LegacyIntrospection = FeatureSource[bool]{}
+}
+
+func (m *InstanceFeaturesReadModel) populateFromSystem() bool {
+	if m.system == nil {
+		return false
+	}
+	m.instance.LoginDefaultOrg = m.system.LoginDefaultOrg
+	m.instance.TriggerIntrospectionProjections = m.system.TriggerIntrospectionProjections
+	m.instance.LegacyIntrospection = m.system.LegacyIntrospection
+	return true
+}
+
+func (m *InstanceFeaturesReadModel) reduceBoolFeature(event *feature_v2.SetEvent[bool]) error {
+	level, key, err := event.FeatureInfo()
+	if err != nil {
+		return err
+	}
+	var dst *FeatureSource[bool]
+
+	switch key {
+	case feature.KeyUnspecified:
+		return nil
+	case feature.KeyLoginDefaultOrg:
+		dst = &m.instance.LoginDefaultOrg
+	case feature.KeyTriggerIntrospectionProjections:
+		dst = &m.instance.TriggerIntrospectionProjections
+	case feature.KeyLegacyIntrospection:
+		dst = &m.instance.LegacyIntrospection
+	}
+	*dst = FeatureSource[bool]{
+		Level: level,
+		Value: event.Value,
+	}
+	return nil
+}