ECS: Add UI Logs for Listener Rules in TRAFFIC_ROUTING and ROLLBACK (pipe-cd#5842)

* ECS: Add UI Logs for Listener Rules in TRAFFIC_ROUTING and ROLLBACK

Signed-off-by: “niladrix719” <[email protected]>

* resolved conflicts

Signed-off-by: “niladrix719” <[email protected]>

* applied requested changes

Signed-off-by: “niladrix719” <[email protected]>

* fix: lint

Signed-off-by: “niladrix719” <[email protected]>

* added note for ModifyListeners method

Signed-off-by: “niladrix719” <[email protected]>

* Update pkg/app/piped/platformprovider/ecs/client.go

Co-authored-by: Shinnosuke Sawada-Dazai <[email protected]>
Signed-off-by: Niladri Adhikary <[email protected]>

---------

Signed-off-by: “niladrix719” <[email protected]>
Signed-off-by: Niladri Adhikary <[email protected]>
Co-authored-by: Shinnosuke Sawada-Dazai <[email protected]>
Signed-off-by: Arya Soni <[email protected]>

Author: 2 people

pkg/app/piped/executor/ecs/ecs.go

@@ -505,10 +505,34 @@ func routing(ctx context.Context, in *executor.Input, platformProviderName strin
 		return false
 	}
 
-	if err := client.ModifyListeners(ctx, currListenerArns, routingTrafficCfg); err != nil {
+	modifiedRules, err := client.ModifyListeners(ctx, currListenerArns, routingTrafficCfg)
+	if err != nil {
 		in.LogPersister.Errorf("Failed to routing traffic to PRIMARY/CANARY variants: %v", err)
+
+		if len(modifiedRules) > 0 {
+			logModifiedRules(in.LogPersister, modifiedRules)
+		}
 		return false
 	}
 
+	logModifiedRules(in.LogPersister, modifiedRules)
+
 	return true
 }
+
+// Logs information about modified ELB listener rules.
+func logModifiedRules(logPersister executor.LogPersister, modifiedRules []string) {
+	if len(modifiedRules) == 0 {
+		logPersister.Info("No ELB listener rules were modified")
+		return
+	}
+
+	if len(modifiedRules) == 1 {
+		logPersister.Infof("Modified ELB listener rule: %s", modifiedRules[0])
+	} else {
+		logPersister.Infof("Modified %d ELB listener rules:", len(modifiedRules))
+		for _, rule := range modifiedRules {
+			logPersister.Infof("  - %s", rule)
+		}
+	}
+}

pkg/app/piped/executor/ecs/rollback.go

@@ -194,11 +194,18 @@ func rollbackELB(ctx context.Context, in *executor.Input, client provider.Client
 		return false
 	}
 
-	if err := client.ModifyListeners(ctx, currListenerArns, routingTrafficCfg); err != nil {
+	modifiedRules, err := client.ModifyListeners(ctx, currListenerArns, routingTrafficCfg)
+	if err != nil {
 		in.LogPersister.Errorf("Failed to routing traffic to PRIMARY/CANARY variants: %v", err)
+
+		if len(modifiedRules) > 0 {
+			logModifiedRules(in.LogPersister, modifiedRules)
+		}
 		return false
 	}
 
+	logModifiedRules(in.LogPersister, modifiedRules)
+
 	in.LogPersister.Infof("Successfully rolled back ELB listeners of target groups %s (PRIMARY) and %s (CANARY)", *primaryTargetGroup.TargetGroupArn, canaryTargetGroupArn)
 	return true
 }

pkg/app/piped/platformprovider/ecs/client.go

@@ -472,17 +472,19 @@ func (c *client) getLoadBalancerArn(ctx context.Context, targetGroupArn string)
 	return output.TargetGroups[0].LoadBalancerArns[0], nil
 }
 
-func (c *client) ModifyListeners(ctx context.Context, listenerArns []string, routingTrafficCfg RoutingTrafficConfig) error {
+func (c *client) ModifyListeners(ctx context.Context, listenerArns []string, routingTrafficCfg RoutingTrafficConfig) ([]string, error) {
 	if len(routingTrafficCfg) != 2 {
-		return fmt.Errorf("invalid listener configuration: requires 2 target groups")
+		return nil, fmt.Errorf("invalid listener configuration: requires 2 target groups")
 	}
 
+	modifiedRuleArns := make([]string, 0)
+
 	for _, listenerArn := range listenerArns {
 		describeRulesOutput, err := c.elbClient.DescribeRules(ctx, &elasticloadbalancingv2.DescribeRulesInput{
 			ListenerArn: aws.String(listenerArn),
 		})
 		if err != nil {
-			return fmt.Errorf("failed to describe rules of listener %s: %w", listenerArn, err)
+			return modifiedRuleArns, fmt.Errorf("failed to describe rules of listener %s: %w", listenerArn, err)
 		}
 
 		for _, rule := range describeRulesOutput.Rules {
@@ -519,20 +521,22 @@ func (c *client) ModifyListeners(ctx context.Context, listenerArns []string, rou
 					DefaultActions: modifiedActions,
 				})
 				if err != nil {
-					return fmt.Errorf("failed to modify default rule %s: %w", *rule.RuleArn, err)
+					return modifiedRuleArns, fmt.Errorf("failed to modify default rule %s: %w", *rule.RuleArn, err)
 				}
+				modifiedRuleArns = append(modifiedRuleArns, fmt.Sprintf("default rule of listener %s", listenerArn))
 			} else {
 				_, err := c.elbClient.ModifyRule(ctx, &elasticloadbalancingv2.ModifyRuleInput{
 					RuleArn: rule.RuleArn,
 					Actions: modifiedActions,
 				})
 				if err != nil {
-					return fmt.Errorf("failed to modify rule %s: %w", *rule.RuleArn, err)
+					return modifiedRuleArns, fmt.Errorf("failed to modify rule %s: %w", *rule.RuleArn, err)
 				}
+				modifiedRuleArns = append(modifiedRuleArns, *rule.RuleArn)
 			}
 		}
 	}
-	return nil
+	return modifiedRuleArns, nil
 }
 
 func (c *client) TagResource(ctx context.Context, resourceArn string, tags []types.Tag) error {

pkg/app/piped/platformprovider/ecs/ecs.go

@@ -66,7 +66,8 @@ type ELB interface {
 	GetListenerArns(ctx context.Context, targetGroup types.LoadBalancer) ([]string, error)
 	// ModifyListeners modifies the actions of type ActionTypeEnumForward to perform routing traffic
 	// to the given target groups. Other actions won't be modified.
-	ModifyListeners(ctx context.Context, listenerArns []string, routingTrafficCfg RoutingTrafficConfig) error
+	// Note: This method will return any successfully modified rule ARNs even when returning an error.
+	ModifyListeners(ctx context.Context, listenerArns []string, routingTrafficCfg RoutingTrafficConfig) (modifiedRuleArns []string, err error)
 }
 
 // Registry holds a pool of aws client wrappers.