story(configDiffView) : code refactored

internal/sql/repository/chartConfig/ConfigMapRepository.go

@@ -40,7 +40,7 @@ type ConfigMapRepository interface {
  GetByAppIdAppLevel(appId int) (*ConfigMapAppModel, error)
  GetByAppIdAndEnvIdEnvLevel(appId int, envId int) (*ConfigMapEnvModel, error)
  GetEnvLevelByAppId(appId int) ([]*ConfigMapEnvModel, error)
- GetConfigNamesForAppAndEnvLevel(appId int, envId int) ([]bean.CMCSNames, error)
+ GetConfigNamesForAppAndEnvLevel(appId int, envId int) ([]bean.ConfigNameAndType, error)
 }
 
 type ConfigMapRepositoryImpl struct {
@@ -65,9 +65,13 @@ type ConfigMapAppModel struct {
  SecretData string `sql:"secret_data"`
  sql.AuditLog
 }
+type cMCSNames struct {
+ CMName string `json:"cm_name"`
+ CSName string `json:"cs_name"`
+}
 
-func (impl ConfigMapRepositoryImpl) GetConfigNamesForAppAndEnvLevel(appId int, envId int) ([]bean.CMCSNames, error) {
- var cMCSNames []bean.CMCSNames
+func (impl ConfigMapRepositoryImpl) GetConfigNamesForAppAndEnvLevel(appId int, envId int) ([]bean.ConfigNameAndType, error) {
+ var cMCSNames []cMCSNames
  tableName := ConfigMapEnvLevel
  if envId == -1 {
  tableName = ConfigMapAppLevel
@@ -85,10 +89,25 @@ func (impl ConfigMapRepositoryImpl) GetConfigNamesForAppAndEnvLevel(appId int, e
  if err := query.Select(&cMCSNames); err != nil {
  if err != pg.ErrNoRows {
  impl.Logger.Errorw("error occurred while fetching CM/CS names", "appId", appId, "err", err)
+ return nil, err
+ }
+ }
+ var configNameAndType []bean.ConfigNameAndType
+ for _, name := range cMCSNames {
+ if name.CMName != "" {
+ configNameAndType = append(configNameAndType, bean.ConfigNameAndType{
+ Name: name.CMName,
+ Type: bean.CM,
+ })
+ }
+ if name.CSName != "" {
+ configNameAndType = append(configNameAndType, bean.ConfigNameAndType{
+ Name: name.CSName,
+ Type: bean.CS,
+ })
  }
- return cMCSNames, err
  }
- return cMCSNames, nil
+ return configNameAndType, nil
 }
 
 func (impl ConfigMapRepositoryImpl) CreateAppLevel(model *ConfigMapAppModel) (*ConfigMapAppModel, error) {

pkg/config/DeploymentConfigurationService.go

@@ -29,7 +29,7 @@ func NewDeploymentConfigurationServiceImpl(logger *zap.SugaredLogger,
 func (impl *DeploymentConfigurationServiceImpl) ConfigAutoComplete(appId int, envId int) (*ConfigDataResponse, error) {
  cMCSNamesAppLevel, cMCSNamesEnvLevel, err := impl.configMapService.FetchCmCsNamesAppAndEnvLevel(appId, envId)
  if err != nil {
- impl.logger.Errorw("error in fetching CM and CS names at app or env level", "appId", appId, "envId", envId)
+ impl.logger.Errorw("error in fetching CM and CS names at app or env level", "appId", appId, "envId", envId, "err", err)
  return nil, err
  }
  combinedProperties := make([]*ConfigProperty, 0)
@@ -38,33 +38,30 @@ func (impl *DeploymentConfigurationServiceImpl) ConfigAutoComplete(appId int, en
  combinedProperties = append(combinedProperties,
  getUniqueConfigPropertyList(cMCSNamesEnvLevel, combinedProperties)...)
  combinedProperties = append(combinedProperties,
- getConfigProperty("", DeploymentTemplate, PublishedConfigState))
+ getConfigProperty("", bean.DeploymentTemplate, PublishedConfigState))
  return &ConfigDataResponse{ResourceConfig: combinedProperties}, nil
 }
 
-func getUniqueConfigPropertyList(cMCSNames []bean.CMCSNames, combinedProperties []*ConfigProperty) []*ConfigProperty {
+func getUniqueConfigPropertyList(cMCSNames []bean.ConfigNameAndType, combinedProperties []*ConfigProperty) []*ConfigProperty {
  properties := make([]*ConfigProperty, 0)
  if len(cMCSNames) == 0 {
  return properties
  }
  combinedNames := make(map[string]bool)
  for _, config := range combinedProperties {
- combinedNames[config.Name] = true
+ combinedNames[config.getKey()] = true
  }
- for _, name := range cMCSNames {
- // Fill in CM property if the CMName is not empty
- if name.CMName != "" && !combinedNames[name.CMName] {
- properties = append(properties, getConfigProperty(name.CMName, CM, PublishedConfigState))
- }
- // Fill in CS property if the CSName is not empty
- if name.CSName != "" && !combinedNames[name.CSName] {
- properties = append(properties, getConfigProperty(name.CSName, CS, PublishedConfigState))
+ for _, config := range cMCSNames {
+ // Fill in CM and CS property
+ property := getConfigProperty(config.Name, config.Type, PublishedConfigState)
+ if !combinedNames[property.getKey()] {
+ properties = append(properties, property)
  }
  }
  return properties
 }
 
-func getConfigProperty(name string, configType ResourceType, State ConfigState) *ConfigProperty {
+func getConfigProperty(name string, configType bean.ResourceType, State ConfigState) *ConfigProperty {
  return &ConfigProperty{
  Name: name,
  Type: configType,

pkg/config/bean.go

@@ -1,24 +1,22 @@
 package config
 
+import "github.com/devtron-labs/devtron/pkg/pipeline/bean"
+
 type ConfigState int
 
 const (
  PublishedConfigState ConfigState = 3
 )
 
-type ResourceType string
-
-const (
- CM ResourceType = "ConfigMap"
- CS ResourceType = "Secret"
- DeploymentTemplate ResourceType = "Deployment Template"
-)
-
 type ConfigProperty struct {
- Name string `json:"name"`
- ConfigState ConfigState `json:"configState"`
- Type ResourceType `json:"type"`
+ Name string  `json:"name"`
+ ConfigState ConfigState  `json:"configState"`
+ Type bean.ResourceType `json:"type"`
 }
 type ConfigDataResponse struct {
  ResourceConfig []*ConfigProperty `json:"resourceConfig"`
 }
+
+func (config ConfigProperty) getKey() string {
+ return string(config.Type) + config.Name
+}

pkg/pipeline/ConfigMapService.go

@@ -83,7 +83,7 @@ type ConfigMapService interface {
  ConfigSecretEnvironmentGet(appId int) ([]bean.JobEnvOverrideResponse, error)
  ConfigSecretEnvironmentClone(appId int, cloneAppId int, userId int32) ([]chartConfig.ConfigMapEnvModel, error)
 
- FetchCmCsNamesAppAndEnvLevel(appId int, envId int) ([]bean.CMCSNames, []bean.CMCSNames, error)
+ FetchCmCsNamesAppAndEnvLevel(appId int, envId int) ([]bean.ConfigNameAndType, []bean.ConfigNameAndType, error)
 }
 
 type ConfigMapServiceImpl struct {
@@ -1994,8 +1994,8 @@ func (impl ConfigMapServiceImpl) ConfigSecretEnvironmentClone(appId int, cloneAp
 
  return jobEnvOverrideResponse, nil
 }
-func (impl ConfigMapServiceImpl) FetchCmCsNamesAppAndEnvLevel(appId int, envId int) ([]bean.CMCSNames, []bean.CMCSNames, error) {
- var cMCSNamesEnvLevel []bean.CMCSNames
+func (impl ConfigMapServiceImpl) FetchCmCsNamesAppAndEnvLevel(appId int, envId int) ([]bean.ConfigNameAndType, []bean.ConfigNameAndType, error) {
+ var cMCSNamesEnvLevel []bean.ConfigNameAndType
 
  cMCSNamesAppLevel, err := impl.configMapRepository.GetConfigNamesForAppAndEnvLevel(appId, -1)
  if err != nil {

pkg/pipeline/bean/ConfigMapBean.go

@@ -91,7 +91,16 @@ type CreateJobEnvOverridePayload struct {
 type SecretsList struct {
  ConfigData []*ConfigData `json:"secrets"`
 }
-type CMCSNames struct {
- CMName string `json:"cm_name"`
- CSName string `json:"cs_name"`
+
+type ConfigNameAndType struct {
+ Name string
+ Type ResourceType
 }
+
+type ResourceType string
+
+const (
+ CM ResourceType = "ConfigMap"
+ CS ResourceType = "Secret"
+ DeploymentTemplate ResourceType = "Deployment Template"
+)

specs/configDiffView.yaml

@@ -62,9 +62,9 @@ components:
  $ref: '#/components/schemas/ResourceTypeEnum'
 
  ConfigStateEnum:
-  type: integer
-  enum: [ 3 ]
-  description: State of config (3 represents published state)
+ type: integer
+ enum: [ 1, 2, 3 ]
+ description: State of config (1 represents draft state , 2 represents approval pending state,3 represents published state)
 
  ResourceTypeEnum:
  type: string