Implement flag metadata

DEVELOPMENT.md

@@ -44,7 +44,7 @@ Then you need to enable CGO.
 
 1. Clone this repo: `git clone https://github.com/flipt-io/flipt`.
 1. Run `mage bootstrap` to install required development tools. See [#bootstrap](#bootstrap) below.
-1. Run `mage go:test` to execute the Go test suite.
+1. Run `mage go:test` to execute the Go test suite. For more information on tests, see also [here](build/README.md)
 1. Run `mage` to build the binary with embedded assets.
 1. Run `mage -l` to see a full list of possible commands.
 

build/testing/integration/api/api.go

@@ -17,6 +17,7 @@ import (
 	"go.flipt.io/flipt/rpc/flipt"
 	"go.flipt.io/flipt/rpc/flipt/evaluation"
 	"google.golang.org/protobuf/testing/protocmp"
+	"google.golang.org/protobuf/types/known/structpb"
 )
 
 func API(t *testing.T, ctx context.Context, opts integration.TestOpts) {
@@ -105,12 +106,16 @@ func API(t *testing.T, ctx context.Context, opts integration.TestOpts) {
 			t.Run("Flags and Variants", func(t *testing.T) {
 				t.Log("Create a new enabled flag with key \"test\".")
 
+				metadata, err := structpb.NewStruct(nil)
+				assert.NoError(t, err)
+
 				enabled, err := client.Flipt().CreateFlag(ctx, &flipt.CreateFlagRequest{
 					NamespaceKey: namespace.Key,
 					Key:          "test",
 					Name:         "Test",
 					Description:  "This is a test flag",
 					Enabled:      true,
+					Metadata:     metadata,
 				})
 				require.NoError(t, err)
 

config/migrations/cockroachdb/10_flag_metadata.up.sql

@@ -0,0 +1 @@
+ALTER TABLE flags ADD COLUMN metadata JSON;

config/migrations/mysql/12_flag_metadata.up.sql

@@ -0,0 +1 @@
+ALTER TABLE flags ADD COLUMN metadata JSON AFTER enabled;

config/migrations/postgres/13_flag_metadata.up.sql

@@ -0,0 +1 @@
+ALTER TABLE flags ADD COLUMN metadata JSON;

config/migrations/sqlite3/12_flag_metadata.up.sql

@@ -0,0 +1 @@
+ALTER TABLE flags ADD COLUMN metadata JSON;

internal/ext/common.go

@@ -3,6 +3,8 @@ package ext
 import (
 	"encoding/json"
 	"errors"
+
+	"google.golang.org/protobuf/types/known/structpb"
 )
 
 type Document struct {
@@ -13,14 +15,15 @@ type Document struct {
 }
 
 type Flag struct {
-	Key         string     `yaml:"key,omitempty" json:"key,omitempty"`
-	Name        string     `yaml:"name,omitempty" json:"name,omitempty"`
-	Type        string     `yaml:"type,omitempty" json:"type,omitempty"`
-	Description string     `yaml:"description,omitempty" json:"description,omitempty"`
-	Enabled     bool       `yaml:"enabled" json:"enabled"`
-	Variants    []*Variant `yaml:"variants,omitempty" json:"variants,omitempty"`
-	Rules       []*Rule    `yaml:"rules,omitempty" json:"rules,omitempty"`
-	Rollouts    []*Rollout `yaml:"rollouts,omitempty" json:"rollouts,omitempty"`
+	Key         string           `yaml:"key,omitempty" json:"key,omitempty"`
+	Name        string           `yaml:"name,omitempty" json:"name,omitempty"`
+	Type        string           `yaml:"type,omitempty" json:"type,omitempty"`
+	Description string           `yaml:"description,omitempty" json:"description,omitempty"`
+	Enabled     bool             `yaml:"enabled" json:"enabled"`
+	Metadata    *structpb.Struct `yaml:"metadata,omitempty" json:"metadata,omitempty"`
+	Variants    []*Variant       `yaml:"variants,omitempty" json:"variants,omitempty"`
+	Rules       []*Rule          `yaml:"rules,omitempty" json:"rules,omitempty"`
+	Rollouts    []*Rollout       `yaml:"rollouts,omitempty" json:"rollouts,omitempty"`
 }
 
 type Variant struct {

internal/ext/exporter.go

@@ -132,6 +132,7 @@ func (e *Exporter) Export(ctx context.Context, encoding Encoding, w io.Writer) e
 					Type:        f.Type.String(),
 					Description: f.Description,
 					Enabled:     f.Enabled,
+					Metadata:    f.Metadata,
 				}
 
 				// map variant id => variant key

internal/ext/exporter_test.go

@@ -12,6 +12,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"go.flipt.io/flipt/rpc/flipt"
+	"google.golang.org/protobuf/types/known/structpb"
 )
 
 type mockLister struct {
@@ -88,6 +89,7 @@ func TestExport(t *testing.T) {
 							Type:        flipt.FlagType_VARIANT_FLAG_TYPE,
 							Description: "description",
 							Enabled:     true,
+							Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 							Variants: []*flipt.Variant{
 								{
 									Id:   "1",
@@ -227,6 +229,7 @@ func TestExport(t *testing.T) {
 							Type:        flipt.FlagType_VARIANT_FLAG_TYPE,
 							Description: "description",
 							Enabled:     true,
+							Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 							Variants: []*flipt.Variant{
 								{
 									Id:   "1",
@@ -259,6 +262,7 @@ func TestExport(t *testing.T) {
 							Type:        flipt.FlagType_BOOLEAN_FLAG_TYPE,
 							Description: "a boolean flag",
 							Enabled:     false,
+							Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 						},
 					},
 					"foo": {
@@ -268,6 +272,7 @@ func TestExport(t *testing.T) {
 							Type:        flipt.FlagType_VARIANT_FLAG_TYPE,
 							Description: "description",
 							Enabled:     true,
+							Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 							Variants: []*flipt.Variant{
 								{
 									Id:   "1",
@@ -300,6 +305,7 @@ func TestExport(t *testing.T) {
 							Type:        flipt.FlagType_BOOLEAN_FLAG_TYPE,
 							Description: "a boolean flag",
 							Enabled:     false,
+							Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 						},
 					},
 				},
@@ -499,6 +505,7 @@ func TestExport(t *testing.T) {
 							Type:        flipt.FlagType_VARIANT_FLAG_TYPE,
 							Description: "description",
 							Enabled:     true,
+							Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 							Variants: []*flipt.Variant{
 								{
 									Id:   "1",
@@ -530,6 +537,7 @@ func TestExport(t *testing.T) {
 							Name:        "flag2",
 							Type:        flipt.FlagType_BOOLEAN_FLAG_TYPE,
 							Description: "a boolean flag",
+							Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 							Enabled:     false,
 						},
 					},
@@ -540,6 +548,7 @@ func TestExport(t *testing.T) {
 							Type:        flipt.FlagType_VARIANT_FLAG_TYPE,
 							Description: "description",
 							Enabled:     true,
+							Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 							Variants: []*flipt.Variant{
 								{
 									Id:   "1",
@@ -571,6 +580,7 @@ func TestExport(t *testing.T) {
 							Name:        "flag2",
 							Type:        flipt.FlagType_BOOLEAN_FLAG_TYPE,
 							Description: "a boolean flag",
+							Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 							Enabled:     false,
 						},
 					},

internal/ext/importer.go

@@ -125,6 +125,7 @@ func (i *Importer) Import(ctx context.Context, enc Encoding, r io.Reader) (err e
 				Name:         f.Name,
 				Description:  f.Description,
 				Enabled:      f.Enabled,
+				Metadata:     f.Metadata,
 				NamespaceKey: namespace,
 			}
 

internal/ext/importer_test.go

@@ -11,6 +11,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"go.flipt.io/flipt/rpc/flipt"
+	"google.golang.org/protobuf/types/known/structpb"
 )
 
 var extensions = []Encoding{EncodingYML, EncodingJSON}
@@ -65,6 +66,7 @@ func (m *mockCreator) CreateFlag(ctx context.Context, r *flipt.CreateFlagRequest
 		Description: r.Description,
 		Type:        r.Type,
 		Enabled:     r.Enabled,
+		Metadata:    r.Metadata,
 	}, nil
 }
 
@@ -199,13 +201,15 @@ func TestImport(t *testing.T) {
 						Description: "description",
 						Type:        flipt.FlagType_VARIANT_FLAG_TYPE,
 						Enabled:     true,
+						Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 					},
 					{
 						Key:         "flag2",
 						Name:        "flag2",
 						Description: "a boolean flag",
 						Type:        flipt.FlagType_BOOLEAN_FLAG_TYPE,
 						Enabled:     false,
+						Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 					},
 				},
 				variantReqs: []*flipt.CreateVariantRequest{
@@ -286,13 +290,15 @@ func TestImport(t *testing.T) {
 						Description: "description",
 						Type:        flipt.FlagType_VARIANT_FLAG_TYPE,
 						Enabled:     true,
+						Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 					},
 					{
 						Key:         "flag2",
 						Name:        "flag2",
 						Description: "a boolean flag",
 						Type:        flipt.FlagType_BOOLEAN_FLAG_TYPE,
 						Enabled:     false,
+						Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 					},
 				},
 				variantReqs: []*flipt.CreateVariantRequest{
@@ -372,13 +378,15 @@ func TestImport(t *testing.T) {
 						Description: "description",
 						Type:        flipt.FlagType_VARIANT_FLAG_TYPE,
 						Enabled:     true,
+						Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 					},
 					{
 						Key:         "flag2",
 						Name:        "flag2",
 						Description: "a boolean flag",
 						Type:        flipt.FlagType_BOOLEAN_FLAG_TYPE,
 						Enabled:     false,
+						Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 					},
 				},
 				variantReqs: []*flipt.CreateVariantRequest{
@@ -459,13 +467,15 @@ func TestImport(t *testing.T) {
 						Description: "description",
 						Type:        flipt.FlagType_VARIANT_FLAG_TYPE,
 						Enabled:     true,
+						Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 					},
 					{
 						Key:         "flag2",
 						Name:        "flag2",
 						Description: "a boolean flag",
 						Type:        flipt.FlagType_BOOLEAN_FLAG_TYPE,
 						Enabled:     false,
+						Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 					},
 				},
 				variantReqs: []*flipt.CreateVariantRequest{
@@ -545,6 +555,7 @@ func TestImport(t *testing.T) {
 						Name:        "flag1",
 						Description: "description",
 						Type:        flipt.FlagType_VARIANT_FLAG_TYPE,
+						Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 						Enabled:     true,
 					},
 				},
@@ -602,13 +613,15 @@ func TestImport(t *testing.T) {
 						Description: "description",
 						Type:        flipt.FlagType_VARIANT_FLAG_TYPE,
 						Enabled:     true,
+						Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 					},
 					{
 						Key:         "flag2",
 						Name:        "flag2",
 						Description: "a boolean flag",
 						Type:        flipt.FlagType_BOOLEAN_FLAG_TYPE,
 						Enabled:     false,
+						Metadata:    structpb.NewStringValue("foobar").GetStructValue(),
 					},
 				},
 				variantReqs: []*flipt.CreateVariantRequest{

internal/storage/sql/common/flag.go

@@ -11,6 +11,7 @@ import (
 
 	sq "github.com/Masterminds/squirrel"
 	"github.com/gofrs/uuid"
+	"google.golang.org/protobuf/types/known/structpb"
 
 	errs "go.flipt.io/flipt/errors"
 	"go.flipt.io/flipt/internal/storage"
@@ -36,12 +37,13 @@ func emptyAsNil(str string) *string {
 // GetFlag gets a flag with variants by key
 func (s *Store) GetFlag(ctx context.Context, p storage.ResourceRequest) (*flipt.Flag, error) {
 	var (
+		metadata  fliptsql.JSONField[map[string]any]
 		createdAt fliptsql.Timestamp
 		updatedAt fliptsql.Timestamp
 
 		flag = &flipt.Flag{}
 
-		err = s.builder.Select("namespace_key, \"key\", \"type\", name, description, enabled, created_at, updated_at").
+		err = s.builder.Select("namespace_key, \"key\", \"type\", name, description, enabled, metadata, created_at, updated_at").
 			From("flags").
 			Where(sq.Eq{"namespace_key": p.Namespace(), "\"key\"": p.Key}).
 			QueryRowContext(ctx).
@@ -52,8 +54,10 @@ func (s *Store) GetFlag(ctx context.Context, p storage.ResourceRequest) (*flipt.
 				&flag.Name,
 				&flag.Description,
 				&flag.Enabled,
+				&metadata,
 				&createdAt,
-				&updatedAt)
+				&updatedAt,
+			)
 	)
 
 	if err != nil {
@@ -66,6 +70,7 @@ func (s *Store) GetFlag(ctx context.Context, p storage.ResourceRequest) (*flipt.
 
 	flag.CreatedAt = createdAt.Timestamp
 	flag.UpdatedAt = updatedAt.Timestamp
+	flag.Metadata, _ = structpb.NewStruct(metadata.T)
 
 	query := s.builder.Select("id, namespace_key, flag_key, \"key\", name, description, attachment, created_at, updated_at").
 		From("variants").
@@ -137,7 +142,7 @@ func (s *Store) ListFlags(ctx context.Context, req *storage.ListRequest[storage.
 		flags   []*flipt.Flag
 		results = storage.ResultSet[*flipt.Flag]{}
 
-		query = s.builder.Select("namespace_key, \"key\", \"type\", name, description, enabled, created_at, updated_at").
+		query = s.builder.Select("namespace_key, \"key\", \"type\", name, description, enabled, metadata, created_at, updated_at").
 			From("flags").
 			Where(sq.Eq{"namespace_key": req.Predicate.Namespace()}).
 			OrderBy(fmt.Sprintf("created_at %s", req.QueryParams.Order))
@@ -179,6 +184,7 @@ func (s *Store) ListFlags(ctx context.Context, req *storage.ListRequest[storage.
 		var (
 			flag = &flipt.Flag{}
 
+			fMetadata  fliptsql.JSONField[map[string]any]
 			fCreatedAt fliptsql.Timestamp
 			fUpdatedAt fliptsql.Timestamp
 		)
@@ -190,13 +196,15 @@ func (s *Store) ListFlags(ctx context.Context, req *storage.ListRequest[storage.
 			&flag.Name,
 			&flag.Description,
 			&flag.Enabled,
+			&fMetadata,
 			&fCreatedAt,
 			&fUpdatedAt); err != nil {
 			return results, err
 		}
 
 		flag.CreatedAt = fCreatedAt.Timestamp
 		flag.UpdatedAt = fUpdatedAt.Timestamp
+		flag.Metadata, _ = structpb.NewStruct(fMetadata.T)
 
 		flags = append(flags, flag)
 		flagsByKey[flag.Key] = flag
@@ -328,20 +336,22 @@ func (s *Store) CreateFlag(ctx context.Context, r *flipt.CreateFlagRequest) (*fl
 			Name:         r.Name,
 			Description:  r.Description,
 			Enabled:      r.Enabled,
+			Metadata:     r.Metadata,
 			CreatedAt:    now,
 			UpdatedAt:    now,
 		}
 	)
 
 	if _, err := s.builder.Insert("flags").
-		Columns("namespace_key", "\"key\"", "\"type\"", "name", "description", "enabled", "created_at", "updated_at").
+		Columns("namespace_key", "\"key\"", "\"type\"", "name", "description", "enabled", "metadata", "created_at", "updated_at").
 		Values(
 			flag.NamespaceKey,
 			flag.Key,
 			flag.Type,
 			flag.Name,
 			flag.Description,
 			flag.Enabled,
+			&fliptsql.JSONField[map[string]any]{T: flag.Metadata.AsMap()},
 			&fliptsql.Timestamp{Timestamp: flag.CreatedAt},
 			&fliptsql.Timestamp{Timestamp: flag.UpdatedAt},
 		).
@@ -362,6 +372,7 @@ func (s *Store) UpdateFlag(ctx context.Context, r *flipt.UpdateFlagRequest) (*fl
 		Set("name", r.Name).
 		Set("description", r.Description).
 		Set("enabled", r.Enabled).
+		Set("metadata", &fliptsql.JSONField[map[string]any]{T: r.Metadata.AsMap()}).
 		Set("updated_at", &fliptsql.Timestamp{Timestamp: flipt.Now()}).
 		Where(sq.And{sq.Eq{"namespace_key": r.NamespaceKey}, sq.Eq{"\"key\"": r.Key}})