feat: propagate labels such as envName and projectName (#5063)

* new deployment chart version wit hupdated label in image_descriptor_template and changes in ReleaseAttributes obj to support diff labels such as appName, envName etc..

* correcting format of image descriptor tempalte for deployment template v1.20

* correcting template files of 1.20 deployment version

* removing new chart after testing

* propagate extra labels via leveraging appLabels

* refactoring

* refactoring

* making MergeChildMapToParentMap generic

* making MergeChildMapToParentMap generic

* making MergeChildMapToParentMap generic with comparable

* added comment for better understanding

* removed ManagedByK8sLabel after disc with product and devops

Author: prakash100198

pkg/app/AppCrudOperationService.go

@@ -20,6 +20,7 @@ package app
 import (
 	"encoding/json"
 	"fmt"
+	bean3 "github.com/devtron-labs/devtron/pkg/deployment/manifest/bean"
 	"regexp"
 	"strconv"
 	"strings"
@@ -48,7 +49,7 @@ type AppCrudOperationService interface {
 	FindAll() ([]*bean.AppLabelDto, error)
 	GetAppMetaInfo(appId int, installedAppId int, envId int) (*bean.AppMetaInfoDto, error)
 	GetHelmAppMetaInfo(appId string) (*bean.AppMetaInfoDto, error)
-	GetLabelsByAppIdForDeployment(appId int) ([]byte, error)
+	GetAppLabelsForDeployment(appId int, appName, envName string) ([]byte, error)
 	GetLabelsByAppId(appId int) (map[string]string, error)
 	UpdateApp(request *bean.CreateAppDTO) (*bean.CreateAppDTO, error)
 	UpdateProjectForApps(request *bean.UpdateProjectBulkAppsRequest) (*bean.UpdateProjectBulkAppsRequest, error)
@@ -491,14 +492,13 @@ func (impl AppCrudOperationServiceImpl) GetHelmAppMetaInfo(appId string) (*bean.
 	return info, nil
 }
 
-func (impl AppCrudOperationServiceImpl) GetLabelsByAppIdForDeployment(appId int) ([]byte, error) {
-	appLabelJson := &bean.AppLabelsJsonForDeployment{}
+func (impl AppCrudOperationServiceImpl) getLabelsByAppIdForDeployment(appId int) (map[string]string, error) {
+	labelsDto := make(map[string]string)
 	labels, err := impl.appLabelRepository.FindAllByAppId(appId)
 	if err != nil && err != pg.ErrNoRows {
 		impl.logger.Errorw("error in getting app labels by appId", "err", err, "appId", appId)
-		return nil, err
+		return labelsDto, err
 	}
-	labelsDto := make(map[string]string)
 	for _, label := range labels {
 		labelKey := strings.TrimSpace(label.Key)
 		labelValue := strings.TrimSpace(label.Value)
@@ -524,14 +524,47 @@ func (impl AppCrudOperationServiceImpl) GetLabelsByAppIdForDeployment(appId int)
 
 		labelsDto[labelKey] = labelValue
 	}
-	appLabelJson.Labels = labelsDto
+	return labelsDto, nil
+}
+
+func (impl AppCrudOperationServiceImpl) getExtraAppLabelsToPropagate(appId int, appName, envName string) (map[string]string, error) {
+	appMetaInfo, err := impl.appRepository.FindAppAndProjectByAppId(appId)
+	if err != nil {
+		impl.logger.Errorw("error in finding app and project by appId", "appId", appId, "err", err)
+		return nil, err
+	}
+	return map[string]string{
+		bean3.AppNameDevtronLabel:     appName,
+		bean3.EnvNameDevtronLabel:     envName,
+		bean3.ProjectNameDevtronLabel: appMetaInfo.Team.Name,
+	}, nil
+}
+
+func (impl AppCrudOperationServiceImpl) GetAppLabelsForDeployment(appId int, appName, envName string) ([]byte, error) {
+	appLabelJson := &bean.AppLabelsJsonForDeployment{}
+	appLabelsMapFromDb, err := impl.getLabelsByAppIdForDeployment(appId)
+	if err != nil {
+		impl.logger.Errorw("error in getting app labels from db using appId", "appId", appId, "err", err)
+		return nil, err
+	}
+	extraAppLabelsToPropagate, err := impl.getExtraAppLabelsToPropagate(appId, appName, envName)
+	if err != nil {
+		impl.logger.Errorw("error in getting extra app labels to propagate", "appName", appName, "envName", envName, "err", err)
+		return nil, err
+	}
+	//when app labels are provided by the user and share the same label key names as those in the extraAppLabelsToPropagate map,
+	//priority will be given to the user-provided label keys.
+	mergedAppLabels := MergeChildMapToParentMap(appLabelsMapFromDb, extraAppLabelsToPropagate)
+
+	appLabelJson.Labels = mergedAppLabels
 	appLabelByte, err := json.Marshal(appLabelJson)
 	if err != nil {
 		impl.logger.Errorw("error in marshaling appLabels json", "err", err, "appLabelJson", appLabelJson)
 		return nil, err
 	}
 	return appLabelByte, nil
 }
+
 func (impl AppCrudOperationServiceImpl) GetLabelsByAppId(appId int) (map[string]string, error) {
 	labels, err := impl.appLabelRepository.FindAllByAppId(appId)
 	if err != nil {

pkg/app/AppService.go

@@ -1060,8 +1060,8 @@ type ReleaseAttributes struct {
 	PipelineName   string
 	ReleaseVersion string
 	DeploymentType string
-	App            string
-	Env            string
+	App            string // App here corresponds to appId
+	Env            string // Env here corresponds to envId
 	AppMetrics     *bool
 }
 

pkg/app/helper.go

@@ -0,0 +1,15 @@
+package app
+
+// MergeChildMapToParentMap merges child map of generic type map into parent map of generic type
+// and returns merged mapping, if parentMap is nil then nil is returned.
+func MergeChildMapToParentMap[T comparable, R any](parentMap map[T]R, toMergeMap map[T]R) map[T]R {
+	if parentMap == nil {
+		return nil
+	}
+	for key, value := range toMergeMap {
+		if _, ok := parentMap[key]; !ok {
+			parentMap[key] = value
+		}
+	}
+	return parentMap
+}

pkg/deployment/manifest/ManifestCreationService.go

@@ -38,6 +38,7 @@ import (
 	"go.opentelemetry.io/otel"
 	"go.uber.org/zap"
 	"k8s.io/apimachinery/pkg/runtime/schema"
+	"net/http"
 	"strconv"
 	"strings"
 	"time"
@@ -226,13 +227,12 @@ func (impl *ManifestCreationServiceImpl) GetValuesOverrideForTrigger(overrideReq
 			configMapJson = nil
 		}
 		_, span = otel.Tracer("orchestrator").Start(ctx, "appCrudOperationService.GetLabelsByAppIdForDeployment")
-		appLabelJsonByte, err = impl.appCrudOperationService.GetLabelsByAppIdForDeployment(overrideRequest.AppId)
+		appLabelJsonByte, err = impl.appCrudOperationService.GetAppLabelsForDeployment(overrideRequest.AppId, overrideRequest.AppName, overrideRequest.EnvName)
 		span.End()
 		if err != nil {
 			impl.logger.Errorw("error in fetching app labels for gitOps commit", "err", err)
 			appLabelJsonByte = nil
 		}
-
 		mergedValues, err := impl.mergeOverrideValues(envOverride, releaseOverrideJson, configMapJson, appLabelJsonByte, strategy)
 		appName := fmt.Sprintf("%s-%s", overrideRequest.AppName, envOverride.Environment.Name)
 		mergedValues = impl.autoscalingCheckBeforeTrigger(ctx, appName, envOverride.Namespace, mergedValues, overrideRequest)
@@ -676,7 +676,6 @@ func (impl *ManifestCreationServiceImpl) getReleaseOverride(envOverride *chartCo
 	if digestPolicyConfigurations.UseDigestForTrigger() {
 		imageTag[imageTagLen-1] = fmt.Sprintf("%s@%s", imageTag[imageTagLen-1], artifact.ImageDigest)
 	}
-
 	releaseAttribute := app.ReleaseAttributes{
 		Name:           imageName,
 		Tag:            imageTag[imageTagLen-1],
@@ -687,9 +686,10 @@ func (impl *ManifestCreationServiceImpl) getReleaseOverride(envOverride *chartCo
 		Env:            envId,
 		AppMetrics:     appMetrics,
 	}
+
 	override, err := util4.Tprintf(envOverride.Chart.ImageDescriptorTemplate, releaseAttribute)
 	if err != nil {
-		return "", &util.ApiError{InternalMessage: "unable to render ImageDescriptorTemplate"}
+		return "", &util.ApiError{HttpStatusCode: http.StatusUnprocessableEntity, InternalMessage: "unable to render ImageDescriptorTemplate"}
 	}
 	if overrideRequest.AdditionalOverride != nil {
 		userOverride, err := overrideRequest.AdditionalOverride.MarshalJSON()

pkg/deployment/manifest/bean/bean.go

@@ -12,6 +12,9 @@ const (
 	HorizontalPodAutoscaler = "HorizontalPodAutoscaler"
 	Enabled                 = "enabled"
 	ReplicaCount            = "replicaCount"
+	AppNameDevtronLabel     = "api.devtron.ai/appName"
+	EnvNameDevtronLabel     = "api.devtron.ai/envName"
+	ProjectNameDevtronLabel = "api.devtron.ai/project"
 )
 
 type ConfigMapAndSecretJsonV2 struct {