Extend variant to support attachment

* Extend flipt.proto to support attachment in variant
* Extend DB with the new column
* Extend UI to support the new field

Co-authored-by: Kevin Ip <kevin.ip@paradigm.co>

cmd/flipt/export.go

@@ -35,6 +35,7 @@ type Variant struct {
 	Key         string `yaml:"key,omitempty"`
 	Name        string `yaml:"name,omitempty"`
 	Description string `yaml:"description,omitempty"`
+	Attachment  []byte `yaml:"attachment,omitempty"`
 }
 
 type Rule struct {
@@ -149,6 +150,7 @@ func runExport(_ []string) error {
 					Key:         v.Key,
 					Name:        v.Name,
 					Description: v.Description,
+					Attachment:  v.Attachment,
 				})
 
 				variantKeys[v.Id] = v.Key

cmd/flipt/import.go

@@ -139,6 +139,7 @@ func runImport(args []string) error {
 				Key:         v.Key,
 				Name:        v.Name,
 				Description: v.Description,
+				Attachment:  v.Attachment,
 			})
 
 			if err != nil {

config/migrations/mysql/1_variants_attachment.down.sql

@@ -0,0 +1 @@
+ALTER TABLE variants DROP COLUMN attachment;

config/migrations/mysql/1_variants_attachment.up.sql

@@ -0,0 +1 @@
+ALTER TABLE variants ADD COLUMN attachment MEDIUMBLOB AFTER description;

config/migrations/postgres/3_variants_attachment.down.sql

@@ -0,0 +1 @@
+ALTER TABLE variants DROP COLUMN attachment;

config/migrations/postgres/3_variants_attachment.up.sql

@@ -0,0 +1 @@
+ALTER TABLE variants ADD attachment BYTEA;

config/migrations/sqlite3/3_variants_attachment.down.sql

@@ -0,0 +1 @@
+ALTER TABLE variants DROP COLUMN attachment;

config/migrations/sqlite3/3_variants_attachment.up.sql

@@ -0,0 +1 @@
+ALTER TABLE variants ADD COLUMN attachment BLOB AFTER description;

rpc/flipt/flipt.proto

@@ -143,6 +143,7 @@ message Variant {
   string description = 5;
   google.protobuf.Timestamp created_at = 6;
   google.protobuf.Timestamp updated_at = 7;
+  bytes attachment = 8;
 }
 
 message CreateVariantRequest {
@@ -156,6 +157,7 @@ message CreateVariantRequest {
   string key = 2;
   string name = 3;
   string description = 4;
+  bytes attachment = 5;
 }
 
 message UpdateVariantRequest {
@@ -170,6 +172,7 @@ message UpdateVariantRequest {
   string key = 3;
   string name = 4;
   string description = 5;
+  bytes attachment = 6;
 }
 
 message DeleteVariantRequest {

rpc/flipt/validation_test.go

@@ -229,6 +229,7 @@ func TestValidate_CreateVariantRequest(t *testing.T) {
 				Key:         "key",
 				Name:        "name",
 				Description: "desc",
+				Attachment:  []byte("attachment"),
 			},
 			wantErr: errors.EmptyFieldError("flagKey"),
 		},
@@ -239,6 +240,7 @@ func TestValidate_CreateVariantRequest(t *testing.T) {
 				Key:         "",
 				Name:        "name",
 				Description: "desc",
+				Attachment:  []byte("attachment"),
 			},
 			wantErr: errors.EmptyFieldError("key"),
 		},
@@ -251,6 +253,16 @@ func TestValidate_CreateVariantRequest(t *testing.T) {
 				Description: "desc",
 			},
 		},
+		{
+			name: "validWithAttachment",
+			req: &CreateVariantRequest{
+				FlagKey:     "flagKey",
+				Key:         "key",
+				Name:        "name",
+				Description: "desc",
+				Attachment:  []byte("attachment"),
+			},
+		},
 	}
 
 	for _, tt := range tests {
@@ -280,6 +292,7 @@ func TestValidate_UpdateVariantRequest(t *testing.T) {
 				Key:         "key",
 				Name:        "name",
 				Description: "desc",
+				Attachment:  []byte("attachment"),
 			},
 			wantErr: errors.EmptyFieldError("id"),
 		},
@@ -291,6 +304,7 @@ func TestValidate_UpdateVariantRequest(t *testing.T) {
 				Key:         "key",
 				Name:        "name",
 				Description: "desc",
+				Attachment:  []byte("attachment"),
 			},
 			wantErr: errors.EmptyFieldError("flagKey"),
 		},
@@ -302,6 +316,7 @@ func TestValidate_UpdateVariantRequest(t *testing.T) {
 				Key:         "",
 				Name:        "name",
 				Description: "desc",
+				Attachment:  []byte("attachment"),
 			},
 			wantErr: errors.EmptyFieldError("key"),
 		},
@@ -315,6 +330,17 @@ func TestValidate_UpdateVariantRequest(t *testing.T) {
 				Description: "desc",
 			},
 		},
+		{
+			name: "validWithAttachment",
+			req: &UpdateVariantRequest{
+				Id:          "id",
+				FlagKey:     "flagKey",
+				Key:         "key",
+				Name:        "name",
+				Description: "desc",
+				Attachment:  []byte("attachment"),
+			},
+		},
 	}
 
 	for _, tt := range tests {

server/flag_test.go

@@ -140,6 +140,7 @@ func TestCreateVariant(t *testing.T) {
 			Key:         "key",
 			Name:        "name",
 			Description: "desc",
+			Attachment:  []byte("attachment"),
 		}
 	)
 
@@ -149,6 +150,7 @@ func TestCreateVariant(t *testing.T) {
 		Key:         req.Key,
 		Name:        req.Name,
 		Description: req.Description,
+		Attachment:  req.Attachment,
 	}, nil)
 
 	got, err := s.CreateVariant(context.TODO(), req)
@@ -170,6 +172,7 @@ func TestUpdateVariant(t *testing.T) {
 			Key:         "key",
 			Name:        "name",
 			Description: "desc",
+			Attachment:  []byte("attachment"),
 		}
 	)
 
@@ -179,6 +182,7 @@ func TestUpdateVariant(t *testing.T) {
 		Key:         req.Key,
 		Name:        req.Name,
 		Description: req.Description,
+		Attachment:  req.Attachment,
 	}, nil)
 
 	got, err := s.UpdateVariant(context.TODO(), req)

storage/sql/common/flag.go

@@ -187,14 +187,15 @@ func (s *Store) CreateVariant(ctx context.Context, r *flipt.CreateVariantRequest
 			Key:         r.Key,
 			Name:        r.Name,
 			Description: r.Description,
+			Attachment:  r.Attachment,
 			CreatedAt:   now,
 			UpdatedAt:   now,
 		}
 	)
 
 	if _, err := s.builder.Insert("variants").
-		Columns("id", "flag_key", "\"key\"", "name", "description", "created_at", "updated_at").
-		Values(v.Id, v.FlagKey, v.Key, v.Name, v.Description, &timestamp{v.CreatedAt}, &timestamp{v.UpdatedAt}).
+		Columns("id", "flag_key", "\"key\"", "name", "description", "attachment", "created_at", "updated_at").
+		Values(v.Id, v.FlagKey, v.Key, v.Name, v.Description, v.Attachment, &timestamp{v.CreatedAt}, &timestamp{v.UpdatedAt}).
 		ExecContext(ctx); err != nil {
 		return nil, err
 	}
@@ -208,6 +209,7 @@ func (s *Store) UpdateVariant(ctx context.Context, r *flipt.UpdateVariantRequest
 		Set("\"key\"", r.Key).
 		Set("name", r.Name).
 		Set("description", r.Description).
+		Set("attachment", r.Attachment).
 		Set("updated_at", &timestamp{timestamppb.Now()}).
 		Where(sq.And{sq.Eq{"id": r.Id}, sq.Eq{"flag_key": r.FlagKey}})
 
@@ -232,11 +234,11 @@ func (s *Store) UpdateVariant(ctx context.Context, r *flipt.UpdateVariantRequest
 		v = &flipt.Variant{}
 	)
 
-	if err := s.builder.Select("id, \"key\", flag_key, name, description, created_at, updated_at").
+	if err := s.builder.Select("id, \"key\", flag_key, name, description, attachment, created_at, updated_at").
 		From("variants").
 		Where(sq.And{sq.Eq{"id": r.Id}, sq.Eq{"flag_key": r.FlagKey}}).
 		QueryRowContext(ctx).
-		Scan(&v.Id, &v.Key, &v.FlagKey, &v.Name, &v.Description, &createdAt, &updatedAt); err != nil {
+		Scan(&v.Id, &v.Key, &v.FlagKey, &v.Name, &v.Description, &v.Attachment, &createdAt, &updatedAt); err != nil {
 		return nil, err
 	}
 
@@ -256,7 +258,7 @@ func (s *Store) DeleteVariant(ctx context.Context, r *flipt.DeleteVariantRequest
 }
 
 func (s *Store) variants(ctx context.Context, flag *flipt.Flag) (err error) {
-	query := s.builder.Select("id, flag_key, \"key\", name, description, created_at, updated_at").
+	query := s.builder.Select("id, flag_key, \"key\", name, description, attachment, created_at, updated_at").
 		From("variants").
 		Where(sq.Eq{"flag_key": flag.Key}).
 		OrderBy("created_at ASC")
@@ -284,6 +286,7 @@ func (s *Store) variants(ctx context.Context, flag *flipt.Flag) (err error) {
 			&variant.Key,
 			&variant.Name,
 			&variant.Description,
+			&variant.Attachment,
 			&createdAt,
 			&updatedAt); err != nil {
 			return err