Implement flag metadata

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

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

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 AFTER enabled;

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

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

internal/storage/sql/common/flag.go

@@ -36,12 +36,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  sql.NullString
 		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 +53,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 {
@@ -67,6 +70,15 @@ func (s *Store) GetFlag(ctx context.Context, p storage.ResourceRequest) (*flipt.
 	flag.CreatedAt = createdAt.Timestamp
 	flag.UpdatedAt = updatedAt.Timestamp
 
+	if metadata.Valid {
+		compactedMetadata, err := compactJSONString(metadata.String)
+		if err != nil {
+			return flag, err
+		}
+
+		flag.Metadata = compactedMetadata
+	}
+
 	query := s.builder.Select("id, namespace_key, flag_key, \"key\", name, description, attachment, created_at, updated_at").
 		From("variants").
 		Where(sq.Eq{"namespace_key": flag.NamespaceKey, "flag_key": flag.Key}).
@@ -137,7 +149,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 +191,7 @@ func (s *Store) ListFlags(ctx context.Context, req *storage.ListRequest[storage.
 		var (
 			flag = &flipt.Flag{}
 
+			fMetadata  sql.NullString
 			fCreatedAt fliptsql.Timestamp
 			fUpdatedAt fliptsql.Timestamp
 		)
@@ -190,6 +203,7 @@ 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
@@ -198,6 +212,15 @@ func (s *Store) ListFlags(ctx context.Context, req *storage.ListRequest[storage.
 		flag.CreatedAt = fCreatedAt.Timestamp
 		flag.UpdatedAt = fUpdatedAt.Timestamp
 
+		if fMetadata.Valid {
+			compactedMetadata, err := compactJSONString(fMetadata.String)
+			if err != nil {
+				return results, err
+			}
+
+			flag.Metadata = compactedMetadata
+		}
+
 		flags = append(flags, flag)
 		flagsByKey[flag.Key] = flag
 	}
@@ -328,27 +351,38 @@ 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,
 		}
 	)
 
+	metadata := emptyAsNil(r.Metadata)
 	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,
+			metadata,
 			&fliptsql.Timestamp{Timestamp: flag.CreatedAt},
 			&fliptsql.Timestamp{Timestamp: flag.UpdatedAt},
 		).
 		ExecContext(ctx); err != nil {
 		return nil, err
 	}
 
+	if metadata != nil {
+		compactedMetadata, err := compactJSONString(*metadata)
+		if err != nil {
+			return nil, err
+		}
+		flag.Metadata = compactedMetadata
+	}
+
 	return flag, nil
 }
 
@@ -362,6 +396,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", emptyAsNil(r.Metadata)).
 		Set("updated_at", &fliptsql.Timestamp{Timestamp: flipt.Now()}).
 		Where(sq.And{sq.Eq{"namespace_key": r.NamespaceKey}, sq.Eq{"\"key\"": r.Key}})
 

internal/storage/sql/flag_test.go

@@ -26,6 +26,7 @@ func (s *DBTestSuite) TestGetFlag() {
 		Name:        "foo",
 		Description: "bar",
 		Enabled:     true,
+		Metadata:    `{"key":"value"}`,
 	})
 
 	require.NoError(t, err)
@@ -41,6 +42,7 @@ func (s *DBTestSuite) TestGetFlag() {
 	assert.Equal(t, flag.Name, got.Name)
 	assert.Equal(t, flag.Description, got.Description)
 	assert.Equal(t, flag.Enabled, got.Enabled)
+	assert.Equal(t, `{"key":"value"}`, flag.Metadata)
 	assert.NotZero(t, flag.CreatedAt)
 	assert.NotZero(t, flag.UpdatedAt)
 }
@@ -458,6 +460,7 @@ func (s *DBTestSuite) TestCreateFlag() {
 		Name:        "foo",
 		Description: "bar",
 		Enabled:     true,
+		Metadata:    `{"key":"value"}`,
 	})
 
 	require.NoError(t, err)
@@ -467,6 +470,7 @@ func (s *DBTestSuite) TestCreateFlag() {
 	assert.Equal(t, "foo", flag.Name)
 	assert.Equal(t, "bar", flag.Description)
 	assert.True(t, flag.Enabled)
+	assert.Equal(t, `{"key":"value"}`, flag.Metadata)
 	assert.NotZero(t, flag.CreatedAt)
 	assert.Equal(t, flag.CreatedAt.Seconds, flag.UpdatedAt.Seconds)
 }
@@ -547,6 +551,7 @@ func (s *DBTestSuite) TestUpdateFlag() {
 		Name:        "foo",
 		Description: "bar",
 		Enabled:     true,
+		Metadata:    `{"key":"value"}`,
 	})
 
 	require.NoError(t, err)
@@ -556,6 +561,7 @@ func (s *DBTestSuite) TestUpdateFlag() {
 	assert.Equal(t, "foo", flag.Name)
 	assert.Equal(t, "bar", flag.Description)
 	assert.True(t, flag.Enabled)
+	assert.Equal(t, `{"key":"value"}`, flag.Metadata)
 	assert.NotZero(t, flag.CreatedAt)
 	assert.Equal(t, flag.CreatedAt.Seconds, flag.UpdatedAt.Seconds)
 
@@ -564,6 +570,7 @@ func (s *DBTestSuite) TestUpdateFlag() {
 		Name:        flag.Name,
 		Description: "foobar",
 		Enabled:     true,
+		Metadata:    `{"key":"value", "foo": "bar"}`,
 	})
 
 	require.NoError(t, err)
@@ -573,6 +580,7 @@ func (s *DBTestSuite) TestUpdateFlag() {
 	assert.Equal(t, flag.Name, updated.Name)
 	assert.Equal(t, "foobar", updated.Description)
 	assert.True(t, flag.Enabled)
+	assert.Equal(t, `{"key":"value","foo":"bar"}`, updated.Metadata)
 	assert.NotZero(t, updated.CreatedAt)
 	assert.NotZero(t, updated.UpdatedAt)
 }

internal/storage/sql/migrator.go

@@ -19,11 +19,11 @@ import (
 )
 
 var expectedVersions = map[Driver]uint{
-	SQLite:      11,
-	LibSQL:      11, // libsql driver uses the same migrations as sqlite3
-	Postgres:    12,
-	MySQL:       11,
-	CockroachDB: 9,
+	SQLite:      12,
+	LibSQL:      12, // libsql driver uses the same migrations as sqlite3
+	Postgres:    13,
+	MySQL:       12,
+	CockroachDB: 10,
 	Clickhouse:  3,
 }