Add metadata in your flag configuration (#857)

thomaspoignant · Jun 9, 2023 · 2f9bccf · 2f9bccf
1 parent ed6cdf4
commit 2f9bccf
Show file tree

Hide file tree

Showing 24 changed files with 600 additions and 24 deletions.
diff --git a/cmd/relayproxy/docs/docs.go b/cmd/relayproxy/docs/docs.go
diff --git a/cmd/relayproxy/docs/swagger.json b/cmd/relayproxy/docs/swagger.json
@@ -406,6 +406,11 @@
                     "type": "boolean",
                     "example": false
                 },
+                "metadata": {
+                    "description": "Metadata is a field containing information about your flag such as an issue tracker link, a description, etc ...",
+                    "type": "object",
+                    "additionalProperties": true
+                },
                 "reason": {
                     "description": "reason why we have returned this value.",
                     "type": "string",

diff --git a/cmd/relayproxy/docs/swagger.yaml b/cmd/relayproxy/docs/swagger.yaml
@@ -150,6 +150,11 @@ definitions:
           not exists, ...) and we serve the defaultValue.'
         example: false
         type: boolean
+      metadata:
+        additionalProperties: true
+        description: Metadata is a field containing information about your flag such
+          as an issue tracker link, a description, etc ...
+        type: object
       reason:
         description: reason why we have returned this value.
         example: TARGETING_MATCH

diff --git a/cmd/relayproxy/main.go b/cmd/relayproxy/main.go
@@ -34,7 +34,6 @@ _____________________________________________`
 // @license.url https://github.com/thomaspoignant/go-feature-flag/blob/main/LICENSE
 // @x-logo {"url":"https://raw.githubusercontent.com/thomaspoignant/go-feature-flag/main/logo_128.png"}
 // @BasePath /
-
 // @securitydefinitions.apikey ApiKeyAuth
 // @in header
 // @name Authorization

diff --git a/cmd/relayproxy/modeldocs/eval_docs.go b/cmd/relayproxy/modeldocs/eval_docs.go
@@ -16,4 +16,6 @@ type EvalFlagDoc struct {
 	ErrorCode string `json:"errorCode" example:""`
 	// The flag value for this user.
 	Value interface{} `json:"value"`
+	// Metadata is a field containing information about your flag such as an issue tracker link, a description, etc ...
+	Metadata *map[string]interface{} `json:"metadata" yaml:"metadata,omitempty" toml:"metadata,omitempty"`
 }
diff --git a/internal/dto/convert_v1.go b/internal/dto/convert_v1.go
@@ -21,5 +21,6 @@ func ConvertV1DtoToInternalFlag(dto DTO) flag.InternalFlag {
 		Version:         dto.Version,
 		Scheduled:       dto.Scheduled,
 		Experimentation: experimentation,
+		Metadata:        dto.Metadata,
 	}
 }
diff --git a/internal/dto/dto.go b/internal/dto/dto.go
@@ -50,6 +50,9 @@ type DTOv1 struct {
 	// an end date for your flag.
 	// When the experimentation is not running, the flag will serve the default value.
 	Experimentation *ExperimentationDto `json:"experimentation,omitempty" yaml:"experimentation,omitempty" toml:"experimentation,omitempty"` // nolint: lll
+
+	// Metadata is a field containing information about your flag such as an issue tracker link, a description, etc ...
+	Metadata *map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty" toml:"metadata,omitempty"`
 }
 
 // DTOv0 describe the fields of a flag.

diff --git a/internal/flag/flag.go b/internal/flag/flag.go
@@ -22,4 +22,7 @@ type Flag interface {
 
 	// GetVariationValue return the value of variation from his name
 	GetVariationValue(name string) interface{}
+
+	// GetMetadata return the metadata associated to the flag
+	GetMetadata() map[string]interface{}
 }
diff --git a/internal/flag/internal_flag.go b/internal/flag/internal_flag.go
@@ -50,6 +50,9 @@ type InternalFlag struct {
 	// The version is manually managed when you configure your flags, and it is used to display the information
 	// in the notifications and data collection.
 	Version *string `json:"version,omitempty" yaml:"version,omitempty" toml:"version,omitempty"`
+
+	// Metadata is a field containing information about your flag such as an issue tracker link, a description, etc ...
+	Metadata *map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty" toml:"metadata,omitempty"`
 }
 
 // Value is returning the Value associate to the flag
@@ -69,6 +72,7 @@ func (f *InternalFlag) Value(
 			Variant:   VariationSDKDefault,
 			Reason:    ReasonDisabled,
 			Cacheable: f.isCacheable(),
+			Metadata:  f.GetMetadata(),
 		}
 	}
 
@@ -79,6 +83,7 @@ func (f *InternalFlag) Value(
 				Variant:   VariationSDKDefault,
 				Reason:    ReasonError,
 				ErrorCode: ErrorFlagConfiguration,
+				Metadata:  f.GetMetadata(),
 			}
 	}
 
@@ -88,6 +93,7 @@ func (f *InternalFlag) Value(
 		RuleIndex: variationSelection.ruleIndex,
 		RuleName:  variationSelection.ruleName,
 		Cacheable: variationSelection.cacheable,
+		Metadata:  f.GetMetadata(),
 	}
 }
 
@@ -332,3 +338,11 @@ func (f *InternalFlag) GetVariationValue(name string) interface{} {
 	}
 	return nil
 }
+
+// GetMetadata return the metadata associated to the flag
+func (f *InternalFlag) GetMetadata() map[string]interface{} {
+	if f.Metadata == nil {
+		return nil
+	}
+	return *f.Metadata
+}