Validate event context key (#5339)

Author: ffjlabo

pkg/app/pipectl/cmd/event/register.go

@@ -17,6 +17,7 @@ package event
 import (
 	"context"
 	"fmt"
+	"regexp"
 
 	"github.com/spf13/cobra"
 	"go.uber.org/zap"
@@ -25,6 +26,8 @@ import (
 	"github.com/pipe-cd/pipecd/pkg/cli"
 )
 
+var eventKeyFormatRegex = regexp.MustCompile(`^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$`)
+
 type register struct {
 	root *command
 
@@ -47,7 +50,7 @@ func newRegisterCommand(root *command) *cobra.Command {
 	cmd.Flags().StringVar(&r.name, "name", r.name, "The name of event.")
 	cmd.Flags().StringVar(&r.data, "data", r.data, "The string value of event data.")
 	cmd.Flags().StringToStringVar(&r.labels, "labels", r.labels, "The list of labels for event. Format: key=value,key2=value2")
-	cmd.Flags().StringToStringVar(&r.contexts, "contexts", r.contexts, "The list of the values for the event context. Format: key=value,key2=value2")
+	cmd.Flags().StringToStringVar(&r.contexts, "contexts", r.contexts, "The list of the values for the event context. Format: key=value,key2=value2. The Key Format is [a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$")
 
 	cmd.MarkFlagRequired("name")
 	cmd.MarkFlagRequired("data")
@@ -56,6 +59,10 @@ func newRegisterCommand(root *command) *cobra.Command {
 }
 
 func (r *register) run(ctx context.Context, input cli.Input) error {
+	if err := r.validateEventContexts(); err != nil {
+		return fmt.Errorf("failed to validate event context: %w", err)
+	}
+
 	cli, err := r.root.clientOptions.NewClient(ctx)
 	if err != nil {
 		return fmt.Errorf("failed to initialize client: %w", err)
@@ -79,3 +86,13 @@ func (r *register) run(ctx context.Context, input cli.Input) error {
 	)
 	return nil
 }
+
+func (r *register) validateEventContexts() error {
+	for key := range r.contexts {
+		if !eventKeyFormatRegex.MatchString(key) {
+			return fmt.Errorf("invalid format key '%s', should be ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$", key)
+		}
+	}
+
+	return nil
+}

pkg/app/server/service/apiservice/service.pb.go

@@ -229,7 +229,7 @@ message RegisterEventRequest {
     string name = 1 [(validate.rules).string.min_len = 1];
     string data = 2 [(validate.rules).string.min_len = 1];
     map<string,string> labels = 3 [(validate.rules).map.keys.string.min_len = 1, (validate.rules).map.values.string.min_len = 1];
-    map<string,string> contexts = 4;
+    map<string,string> contexts = 4 [(validate.rules).map.keys.string.min_len = 1, (validate.rules).map.keys.string.pattern = "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$", (validate.rules).map.values.string.min_len = 1];
 }
 
 message RegisterEventResponse {

pkg/app/server/service/apiservice/service.pb.validate.go

@@ -101,7 +101,7 @@ func (s *eventStore) Add(ctx context.Context, e model.Event) error {
 		e.UpdatedAt = now
 	}
 	if err := e.Validate(); err != nil {
-		return err
+		return fmt.Errorf("failed to validate event: %w: %w", ErrInvalidArgument, err)
 	}
 	return s.ds.Create(ctx, s.col, e.Id, &e)
 }

pkg/app/server/service/apiservice/service.proto

@@ -46,9 +46,10 @@ message Event {
     EventStatus status = 8 [(validate.rules).enum.defined_only = true];
     string status_description = 9;
     // The key/value pairs that are attached to event.
+    // The key is like 'test-hoge-fuga'
     // This is intended to add more information from event trigger side.
     // E.g. send the app code commit hash to Deployment.
-    map<string,string> contexts = 10;
+    map<string,string> contexts = 10 [(validate.rules).map.keys.string.pattern = "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$"];
 
     // Unix time when the event was handled.
     int64 handled_at = 13;