feat: be able to group slack notifications by feature flag tag (#1472)

Signed-off-by: Alessandro Yuichi Okimoto <[email protected]>

api-description/web-api.swagger.yaml

@@ -7893,6 +7893,10 @@ definitions:
         $ref: '#/definitions/notificationRecipient'
       name:
         type: string
+      featureFlagTags:
+        type: array
+        items:
+          type: string
   notificationCreateSubscriptionRequest:
     type: object
     properties:
@@ -7908,6 +7912,10 @@ definitions:
           $ref: '#/definitions/SubscriptionSourceType'
       recipient:
         $ref: '#/definitions/notificationRecipient'
+      featureFlagTags:
+        type: array
+        items:
+          type: string
     required:
       - environmentId
       - name
@@ -8096,8 +8104,19 @@ definitions:
         type: string
       environmentName:
         type: string
+      featureFlagTags:
+        type: array
+        items:
+          type: string
   notificationUpdateAdminSubscriptionResponse:
     type: object
+  notificationUpdateSubscriptionFeatureFlagTagsCommand:
+    type: object
+    properties:
+      featureFlagTags:
+        type: array
+        items:
+          type: string
   notificationUpdateSubscriptionRequest:
     type: object
     properties:
@@ -8124,6 +8143,13 @@ definitions:
         type: boolean
         description: if true, the subscription is disabled, otherwise enabled.
         title: disabled
+      featureFlagTags:
+        type: array
+        items:
+          type: string
+      updateSubscriptionFeatureTagsCommand:
+        $ref: '#/definitions/notificationUpdateSubscriptionFeatureFlagTagsCommand'
+        description: Deprecated. Use feature_flag_tags instead.
     required:
       - id
       - environmentId

migration/mysql/20250122261736_update_subscription_table.sql

@@ -0,0 +1,4 @@
+ALTER TABLE `subscription` ADD COLUMN `feature_flag_tags` JSON NOT NULL AFTER `name`;
+
+-- Populate feature_flag_tags with an empty array
+UPDATE `subscription` SET `feature_flag_tags` = '[]';

migration/mysql/atlas.sum

@@ -1,4 +1,4 @@
-h1:VXTmzqYh41HnDCRZyYb9OvaSQx2m1+GLavQcpqgGCjQ=
+h1:w7fx0uljXF2/NlqThOynR/9BbVayje1TcjST6rEkRoI=
 20240626022133_initialization.sql h1:u9qmPkwWX7PN92qEcDDfR92lrMpwadQSMxUJgv6LjQ0=
 20240708065726_update_audit_log_table.sql h1:k7gK8Njv1yHMsYXAQtSgMaSbXy4lxyZ9MPzbJyMyyoM=
 20240815043128_update_auto_ops_rule_table.sql h1:6ib+XfS1uu9AUO3qESvkpUfOu3qUsLwHm9KHcrGEz0E=
@@ -24,3 +24,4 @@ h1:VXTmzqYh41HnDCRZyYb9OvaSQx2m1+GLavQcpqgGCjQ=
 20250116054703_remove_environment_namespace_column.sql h1:UNiN/syYAs8nUQOkMw3RRvDQBQU/kKYv7B3XBhL6qPM=
 20250116060049_update_goal_table.sql h1:zEhXMf2hntdk2Im9klR76vx6PEAh+cJwk3fKgm2gGPs=
 20250122261735_add_code_ref_table.sql h1:ZqE6Ekn3PnhBFdpuczJYo5KjwTvcgeqSnkuLCNeHoCA=
+20250122261736_update_subscription_table.sql h1:+TyXXsVb1NxYHBNQsnBENojIxV5AFORw48dcG9D0gxQ=

pkg/domainevent/domain/message.go

@@ -1114,6 +1114,14 @@ func LocalizedMessage(eventType proto.Event_Type, localizer locale.Localizer) *p
 				localizer.MustLocalizeWithTemplate(locale.Notification),
 			),
 		}
+	case proto.Event_SUBSCRIPTION_FEATURE_FLAG_TAGS_UPDATED:
+		return &proto.LocalizedMessage{
+			Locale: localizer.GetLocale(),
+			Message: localizer.MustLocalizeWithTemplate(
+				locale.FeatureFlagTagsUpdatedTemplate,
+				localizer.MustLocalizeWithTemplate(locale.Notification),
+			),
+		}
 	case proto.Event_SUBSCRIPTION_UPDATED:
 		return &proto.LocalizedMessage{
 			Locale: localizer.GetLocale(),

pkg/locale/localizedata/en.yaml

@@ -126,6 +126,7 @@ MultipleUpdated: "{{ .Field_1 }} have been updated"
 DescriptionUpdated: "{{ .Field_1 }} description has been updated"
 Incremented: "{{ .Field_1 }} has been incremented"
 NameUpdated: "{{ .Field_1 }} name has been updated"
+FeatureFlagTagsUpdated: "{{ .Field_1 }} feature flag tags have been updated"
 Started: "{{ .Field_1 }} has been started"
 Stopped: "{{ .Field_1 }} has been stopped"
 Finished: "{{ .Field_1 }} has been finished"

pkg/locale/localizedata/ja.yaml

@@ -128,6 +128,7 @@ Changed: "{{ .Field_1 }}が変更されました"
 DescriptionUpdated: "{{ .Field_1 }}の説明文が更新されました"
 Incremented: "{{ .Field_1 }}が増加されました"
 NameUpdated: "{{ .Field_1 }}の名前が更新されました"
+FeatureFlagTagsUpdated: "{{ .Field_1 }} フィチャーフラグのタグが更新されました"
 Updated: "{{ .Field_1 }}が更新されました"
 MultipleUpdated: "{{ .Field_1 }}が更新されました"
 Started: "{{ .Field_1 }}が開始されました"

pkg/locale/localizer.go

@@ -135,33 +135,34 @@ const (
 
 // domain events
 const (
-	UnknownOperation           = "UnknownOperation"
-	CreatedTemplate            = "Created"
-	EnabledTemplate            = "Enabled"
-	DisabledTemplate           = "Disabled"
-	ArchivedTemplate           = "Archived"
-	UnarchivedTemplate         = "Unarchived"
-	DeletedTemplate            = "Deleted"
-	AddedTemplate              = "Added"
-	ConditionAddedTemplate     = "ConditionAdded"
-	ConditionDeletedTemplate   = "ConditionDeleted"
-	ChangedTemplate            = "Changed"
-	DescriptionUpdatedTemplate = "DescriptionUpdated"
-	IncrementedTemplate        = "Incremented"
-	NameUpdatedTemplate        = "NameUpdated"
-	UpdatedTemplate            = "Updated"
-	MultipleUpdatedTemplate    = "MultipleUpdated"
-	StartedTemplate            = "Started"
-	StoppedTemplate            = "Stopped"
-	FinishedTemplate           = "Finished"
-	ExecutedTemplate           = "Executed"
-	UploadedTemplate           = "Uploaded"
-	ResetTemplate              = "Reset"
-	ClonedTemplate             = "Cloned"
-	TrialConverted             = "TrialConverted"
-	ValueAddedTemplate         = "ValueAdded"
-	ValueUpdatedTemplate       = "ValueUpdated"
-	ValueDeletedTemplate       = "ValueDeleted"
+	UnknownOperation               = "UnknownOperation"
+	CreatedTemplate                = "Created"
+	EnabledTemplate                = "Enabled"
+	DisabledTemplate               = "Disabled"
+	ArchivedTemplate               = "Archived"
+	UnarchivedTemplate             = "Unarchived"
+	DeletedTemplate                = "Deleted"
+	AddedTemplate                  = "Added"
+	ConditionAddedTemplate         = "ConditionAdded"
+	ConditionDeletedTemplate       = "ConditionDeleted"
+	ChangedTemplate                = "Changed"
+	DescriptionUpdatedTemplate     = "DescriptionUpdated"
+	IncrementedTemplate            = "Incremented"
+	NameUpdatedTemplate            = "NameUpdated"
+	FeatureFlagTagsUpdatedTemplate = "FeatureFlagTagsUpdated"
+	UpdatedTemplate                = "Updated"
+	MultipleUpdatedTemplate        = "MultipleUpdated"
+	StartedTemplate                = "Started"
+	StoppedTemplate                = "Stopped"
+	FinishedTemplate               = "Finished"
+	ExecutedTemplate               = "Executed"
+	UploadedTemplate               = "Uploaded"
+	ResetTemplate                  = "Reset"
+	ClonedTemplate                 = "Cloned"
+	TrialConverted                 = "TrialConverted"
+	ValueAddedTemplate             = "ValueAdded"
+	ValueUpdatedTemplate           = "ValueUpdated"
+	ValueDeletedTemplate           = "ValueDeleted"
 )
 
 func init() {

pkg/notification/api/admin_subscription.go

@@ -45,7 +45,7 @@ func (s *NotificationService) CreateAdminSubscription(
 	if err := s.validateCreateAdminSubscriptionRequest(req, localizer); err != nil {
 		return nil, err
 	}
-	subscription, err := domain.NewSubscription(req.Command.Name, req.Command.SourceTypes, req.Command.Recipient)
+	subscription, err := domain.NewSubscription(req.Command.Name, req.Command.SourceTypes, req.Command.Recipient, nil)
 	if err != nil {
 		s.logger.Error(
 			"Failed to create a new admin subscription",

pkg/notification/api/api_test.go

@@ -166,7 +166,7 @@ func putSubscription(t *testing.T, s storage.Client, kind, namespace string, dis
 		Type:                  proto.Recipient_SlackChannel,
 		SlackChannelRecipient: &proto.SlackChannelRecipient{WebhookUrl: "url"},
 	}
-	subscription, err := domain.NewSubscription("sname", sourceTypes, recipient)
+	subscription, err := domain.NewSubscription("sname", sourceTypes, recipient, []string{"tag"})
 	subscription.Disabled = disabled
 	require.NoError(t, err)
 	err = s.Put(context.Background(), key, subscription.Subscription)

pkg/notification/api/subscription.go

@@ -58,7 +58,12 @@ func (s *NotificationService) CreateSubscription(
 	if err := s.validateCreateSubscriptionRequest(req, localizer); err != nil {
 		return nil, err
 	}
-	subscription, err := domain.NewSubscription(req.Command.Name, req.Command.SourceTypes, req.Command.Recipient)
+	subscription, err := domain.NewSubscription(
+		req.Command.Name,
+		req.Command.SourceTypes,
+		req.Command.Recipient,
+		req.Command.FeatureFlagTags,
+	)
 	if err != nil {
 		s.logger.Error(
 			"Failed to create a new subscription",
@@ -165,7 +170,12 @@ func (s *NotificationService) createSubscriptionNoCommand(
 	if err := s.validateCreateSubscriptionNoCommandRequest(req, localizer); err != nil {
 		return nil, err
 	}
-	subscription, err := domain.NewSubscription(req.Name, req.SourceTypes, req.Recipient)
+	subscription, err := domain.NewSubscription(
+		req.Name,
+		req.SourceTypes,
+		req.Recipient,
+		req.FeatureFlagTags,
+	)
 	if err != nil {
 		s.logger.Error(
 			"Failed to create a new subscription",
@@ -241,9 +251,10 @@ func (s *NotificationService) createSubscriptionNoCommand(
 		subscription.Id,
 		eventproto.Event_SUBSCRIPTION_CREATED,
 		&eventproto.SubscriptionCreatedEvent{
-			SourceTypes: subscription.SourceTypes,
-			Recipient:   subscription.Recipient,
-			Name:        subscription.Name,
+			SourceTypes:     subscription.SourceTypes,
+			Recipient:       subscription.Recipient,
+			Name:            subscription.Name,
+			FeatureFlagTags: subscription.FeatureFlagTags,
 		},
 		req.EnvironmentId,
 		subscription.Subscription,
@@ -330,6 +341,7 @@ func (s *NotificationService) updateSubscriptionNoCommand(
 		req.Name,
 		req.SourceTypes,
 		req.Disabled,
+		req.FeatureFlagTags,
 		editor,
 		localizer,
 	)
@@ -515,6 +527,7 @@ func (s *NotificationService) updateSubscriptionMySQLNoCommand(
 	name *wrapperspb.StringValue,
 	sourceTypes []notificationproto.Subscription_SourceType,
 	disabled *wrapperspb.BoolValue,
+	featureFlagTags []string,
 	editor *eventproto.Editor,
 	localizer locale.Localizer,
 ) (*notificationproto.Subscription, error) {
@@ -545,7 +558,7 @@ func (s *NotificationService) updateSubscriptionMySQLNoCommand(
 		if err != nil {
 			return err
 		}
-		updated, err := subscription.UpdateSubscription(name, sourceTypes, disabled)
+		updated, err := subscription.UpdateSubscription(name, sourceTypes, disabled, featureFlagTags)
 		if err != nil {
 			return err
 		}
@@ -556,10 +569,11 @@ func (s *NotificationService) updateSubscriptionMySQLNoCommand(
 			subscription.Id,
 			eventproto.Event_SUBSCRIPTION_UPDATED,
 			&eventproto.SubscriptionUpdatedEvent{
-				Id:          ID,
-				SourceTypes: sourceTypes,
-				Name:        name,
-				Disabled:    disabled,
+				Id:              ID,
+				SourceTypes:     sourceTypes,
+				Name:            name,
+				Disabled:        disabled,
+				FeatureFlagTags: featureFlagTags,
 			},
 			ID,
 			updatedSubscription,
@@ -617,7 +631,8 @@ func (s *NotificationService) updateSubscriptionMySQLNoCommand(
 func (s *NotificationService) isNoUpdateSubscriptionCommand(req *notificationproto.UpdateSubscriptionRequest) bool {
 	return req.AddSourceTypesCommand == nil &&
 		req.DeleteSourceTypesCommand == nil &&
-		req.RenameSubscriptionCommand == nil
+		req.RenameSubscriptionCommand == nil &&
+		req.UpdateSubscriptionFeatureTagsCommand == nil
 }
 
 func (s *NotificationService) DeleteSubscription(
@@ -736,6 +751,9 @@ func (s *NotificationService) createUpdateSubscriptionCommands(
 	if req.RenameSubscriptionCommand != nil {
 		commands = append(commands, req.RenameSubscriptionCommand)
 	}
+	if req.UpdateSubscriptionFeatureTagsCommand != nil {
+		commands = append(commands, req.UpdateSubscriptionFeatureTagsCommand)
+	}
 	return commands
 }
 

pkg/notification/api/validation.go

@@ -45,6 +45,26 @@ func (s *NotificationService) validateCreateSubscriptionRequest(
 		}
 		return dt.Err()
 	}
+	// We should only save the tags if the Feature source type is in the list
+	if req.Command.FeatureFlagTags != nil {
+		var found bool
+		for _, sourceType := range req.Command.SourceTypes {
+			if sourceType == notificationproto.Subscription_DOMAIN_EVENT_FEATURE {
+				found = true
+				break
+			}
+		}
+		if !found {
+			dt, err := statusSourceTypesRequired.WithDetails(&errdetails.LocalizedMessage{
+				Locale:  localizer.GetLocale(),
+				Message: localizer.MustLocalizeWithTemplate(locale.InvalidArgumentError, "SourceTypes"),
+			})
+			if err != nil {
+				return statusInternal.Err()
+			}
+			return dt.Err()
+		}
+	}
 	if err := s.validateRecipient(req.Command.Recipient, localizer); err != nil {
 		return err
 	}
@@ -75,6 +95,26 @@ func (s *NotificationService) validateCreateSubscriptionNoCommandRequest(
 		}
 		return dt.Err()
 	}
+	// We should only save the tags if the Feature source type is in the list
+	if req.FeatureFlagTags != nil {
+		var found bool
+		for _, sourceType := range req.SourceTypes {
+			if sourceType == notificationproto.Subscription_DOMAIN_EVENT_FEATURE {
+				found = true
+				break
+			}
+		}
+		if !found {
+			dt, err := statusSourceTypesRequired.WithDetails(&errdetails.LocalizedMessage{
+				Locale:  localizer.GetLocale(),
+				Message: localizer.MustLocalizeWithTemplate(locale.InvalidArgumentError, "SourceTypes"),
+			})
+			if err != nil {
+				return statusInternal.Err()
+			}
+			return dt.Err()
+		}
+	}
 	if err := s.validateRecipient(req.Recipient, localizer); err != nil {
 		return err
 	}
@@ -234,6 +274,22 @@ func (s *NotificationService) validateUpdateSubscriptionRequest(
 		}
 		return dt.Err()
 	}
+	if req.UpdateSubscriptionFeatureTagsCommand != nil {
+		if req.DeleteSourceTypesCommand != nil {
+			for _, st := range req.DeleteSourceTypesCommand.SourceTypes {
+				if st == notificationproto.Subscription_DOMAIN_EVENT_FEATURE {
+					dt, err := statusNameRequired.WithDetails(&errdetails.LocalizedMessage{
+						Locale:  localizer.GetLocale(),
+						Message: localizer.MustLocalizeWithTemplate(locale.InvalidArgumentError, "feature_flag_tags"),
+					})
+					if err != nil {
+						return statusInternal.Err()
+					}
+					return dt.Err()
+				}
+			}
+		}
+	}
 	return nil
 }
 

pkg/notification/command/subscription.go

@@ -73,6 +73,8 @@ func (h *subscriptionCommandHandler) Handle(ctx context.Context, cmd Command) er
 		return h.disable(ctx, c)
 	case *proto.RenameSubscriptionCommand:
 		return h.rename(ctx, c)
+	case *proto.UpdateSubscriptionFeatureFlagTagsCommand:
+		return h.updateFeatureFlagTags(ctx, c)
 	}
 	return errUnknownCommand
 }
@@ -140,6 +142,21 @@ func (h *subscriptionCommandHandler) rename(ctx context.Context, cmd *proto.Rena
 	return h.createEvent(ctx, eventproto.Event_SUBSCRIPTION_RENAMED, &eventproto.SubscriptionRenamedEvent{Name: cmd.Name})
 }
 
+func (h *subscriptionCommandHandler) updateFeatureFlagTags(
+	ctx context.Context,
+	cmd *proto.UpdateSubscriptionFeatureFlagTagsCommand,
+) error {
+	err := h.subscription.UpdateFeatureFlagTags(cmd.FeatureFlagTags)
+	if err != nil {
+		return err
+	}
+	return h.createEvent(
+		ctx,
+		eventproto.Event_SUBSCRIPTION_FEATURE_FLAG_TAGS_UPDATED,
+		&eventproto.SubscriptionFeatureFlagTagsUpdatedEvent{FeatureFlagTags: cmd.FeatureFlagTags},
+	)
+}
+
 func (h *subscriptionCommandHandler) createEvent(
 	ctx context.Context,
 	eventType eventproto.Event_Type,