Feature Toggles: Create API for updating feature toggle state from the feature toggle admin page (#73022)

* create roles for writing feature toggles * create update endpoint / handler * api changes * add feature toggle validations * hide toggles based on their state * make FlagFeatureToggle read only * add username log * add username string * refactor for better readability * refactor unit tests so we can do more validations * some skeletoning for the set tests * write unit tests for updater * break helper functions out * update sample ini to match defaults * add more logic to ReadOnly label * add user documentation * fix lint issue * Update docs/sources/setup-grafana/configure-grafana/_index.md Co-authored-by: J Stickler <julie.stickler@grafana.com> * Update docs/sources/setup-grafana/configure-grafana/_index.md Co-authored-by: J Stickler <julie.stickler@grafana.com> * Update docs/sources/setup-grafana/configure-grafana/_index.md Co-authored-by: J Stickler <julie.stickler@grafana.com> * Update docs/sources/setup-grafana/configure-grafana/_index.md Co-authored-by: J Stickler <julie.stickler@grafana.com> * Update docs/sources/setup-grafana/configure-grafana/_index.md Co-authored-by: J Stickler <julie.stickler@grafana.com> * Update docs/sources/setup-grafana/configure-grafana/_index.md Co-authored-by: J Stickler <julie.stickler@grafana.com> --------- Co-authored-by: IbrahimCSAE <ibrahim.mdev@gmail.com> Co-authored-by: J Stickler <julie.stickler@grafana.com>
2025-02-25 18:55:37 -06:00 · 2023-08-09 11:32:28 -04:00
parent d9695eb507
commit 779e0fe311
11 changed files with 629 additions and 92 deletions
--- a/pkg/services/featuremgmt/models.go
+++ b/pkg/services/featuremgmt/models.go
@@ -0,0 +1,129 @@
+package featuremgmt
+
+import (
+	"bytes"
+	"encoding/json"
+)
+
+type FeatureToggles interface {
+	IsEnabled(flag string) bool
+}
+
+// FeatureFlagStage indicates the quality level
+type FeatureFlagStage int
+
+const (
+	// FeatureStageUnknown indicates that no state is specified
+	FeatureStageUnknown FeatureFlagStage = iota
+
+	// FeatureStageExperimental -- Does this work for Grafana Labs?
+	FeatureStageExperimental
+
+	// FeatureStagePrivatePreview -- Does this work for a limited number of customers?
+	FeatureStagePrivatePreview
+
+	// FeatureStagePublicPreview -- Does this work for most customers?
+	FeatureStagePublicPreview
+
+	// FeatureStageGeneralAvailability -- Feature is available to all applicable customers
+	FeatureStageGeneralAvailability
+
+	// FeatureStageDeprecated the feature will be removed in the future
+	FeatureStageDeprecated
+)
+
+func (s FeatureFlagStage) String() string {
+	switch s {
+	case FeatureStageExperimental:
+		return "experimental"
+	case FeatureStagePrivatePreview:
+		return "privatePreview"
+	case FeatureStagePublicPreview:
+		return "preview"
+	case FeatureStageGeneralAvailability:
+		return "GA"
+	case FeatureStageDeprecated:
+		return "deprecated"
+	case FeatureStageUnknown:
+	}
+	return "unknown"
+}
+
+// MarshalJSON marshals the enum as a quoted json string
+func (s FeatureFlagStage) MarshalJSON() ([]byte, error) {
+	buffer := bytes.NewBufferString(`"`)
+	buffer.WriteString(s.String())
+	buffer.WriteString(`"`)
+	return buffer.Bytes(), nil
+}
+
+// UnmarshalJSON unmarshals a quoted json string to the enum value
+func (s *FeatureFlagStage) UnmarshalJSON(b []byte) error {
+	var j string
+	err := json.Unmarshal(b, &j)
+	if err != nil {
+		return err
+	}
+
+	switch j {
+	case "alpha":
+		fallthrough
+	case "experimental":
+		*s = FeatureStageExperimental
+
+	case "privatePreview":
+		*s = FeatureStagePrivatePreview
+
+	case "beta":
+		fallthrough
+	case "preview":
+		*s = FeatureStagePublicPreview
+
+	case "stable":
+		fallthrough
+	case "ga":
+		fallthrough
+	case "GA":
+		*s = FeatureStageGeneralAvailability
+
+	case "deprecated":
+		*s = FeatureStageDeprecated
+
+	default:
+		*s = FeatureStageUnknown
+	}
+	return nil
+}
+
+type FeatureFlag struct {
+	Name        string           `json:"name" yaml:"name"` // Unique name
+	Description string           `json:"description"`
+	Stage       FeatureFlagStage `json:"stage,omitempty"`
+	DocsURL     string           `json:"docsURL,omitempty"`
+
+	// Owner person or team that owns this feature flag
+	Owner codeowner `json:"-"`
+
+	// CEL-GO expression.  Using the value "true" will mean this is on by default
+	Expression string `json:"expression,omitempty"`
+
+	// Special behavior flags
+	RequiresDevMode bool `json:"requiresDevMode,omitempty"` // can not be enabled in production
+	RequiresRestart bool `json:"requiresRestart,omitempty"` // The server must be initialized with the value
+	RequiresLicense bool `json:"requiresLicense,omitempty"` // Must be enabled in the license
+	FrontendOnly    bool `json:"frontend,omitempty"`        // change is only seen in the frontend
+	HideFromDocs    bool `json:"hideFromDocs,omitempty"`    // don't add the values to docs
+
+	Enabled bool `json:"enabled,omitempty"`
+}
+
+type UpdateFeatureTogglesCommand struct {
+	FeatureToggles []FeatureToggleDTO `json:"featureToggles"`
+}
+
+type FeatureToggleDTO struct {
+	Name        string `json:"name" binding:"Required"`
+	Description string `json:"description"`
+	Enabled     bool   `json:"enabled"`
+	ReadOnly    bool   `json:"readOnly,omitempty"`
+}