feat: description for apps and jobs

api/bean/AppView.go

@@ -29,6 +29,7 @@ type AppContainer struct {
 	ProjectId               int                        `json:"projectId"`
 	AppEnvironmentContainer []*AppEnvironmentContainer `json:"environments"`
 	DefaultEnv              AppEnvironmentContainer    `json:"-"`
+	Description             GenericNoteResponseBean    `json:"description"`
 }
 
 type AppContainerResponse struct {
@@ -58,11 +59,18 @@ type CiMaterialDTO struct {
 	SourceValue string `json:"value"`
 }
 
+type GenericNoteResponseBean struct {
+	Id          int       `json:"id" validate:"number"`
+	Description string    `json:"description"`
+	UpdatedBy   string    `json:"updatedBy"`
+	UpdatedOn   time.Time `json:"updatedOn"`
+}
+
 type JobContainer struct {
-	JobId          int             `json:"jobId"`
-	JobName        string          `json:"jobName""`
-	Description    string          `json:"description"`
-	JobCiPipelines []JobCIPipeline `json:"ciPipelines"'`
+	JobId          int                     `json:"jobId"`
+	JobName        string                  `json:"jobName""`
+	Description    GenericNoteResponseBean `json:"description"`
+	JobCiPipelines []JobCIPipeline         `json:"ciPipelines"'`
 }
 
 type JobCIPipeline struct {

api/cluster/ClusterRestHandler.go

@@ -21,6 +21,8 @@ import (
 	"context"
 	"encoding/json"
 	"errors"
+	"github.com/devtron-labs/devtron/pkg/genericNotes"
+	"github.com/devtron-labs/devtron/pkg/genericNotes/repository"
 	"net/http"
 	"strconv"
 	"strings"
@@ -59,7 +61,7 @@ type ClusterRestHandler interface {
 
 type ClusterRestHandlerImpl struct {
 	clusterService            cluster.ClusterService
-	clusterNoteService        cluster.ClusterNoteService
+	clusterNoteService        genericNotes.GenericNoteService
 	clusterDescriptionService cluster.ClusterDescriptionService
 	logger                    *zap.SugaredLogger
 	userService               user.UserService
@@ -71,7 +73,7 @@ type ClusterRestHandlerImpl struct {
 }
 
 func NewClusterRestHandlerImpl(clusterService cluster.ClusterService,
-	clusterNoteService cluster.ClusterNoteService,
+	clusterNoteService genericNotes.GenericNoteService,
 	clusterDescriptionService cluster.ClusterDescriptionService,
 	logger *zap.SugaredLogger,
 	userService user.UserService,
@@ -349,13 +351,13 @@ func (impl ClusterRestHandlerImpl) FindById(w http.ResponseWriter, r *http.Reque
 func (impl ClusterRestHandlerImpl) FindNoteByClusterId(w http.ResponseWriter, r *http.Request) {
 	vars := mux.Vars(r)
 	id := vars["id"]
-	i, err := strconv.Atoi(id)
+	clusterId, err := strconv.Atoi(id)
 	if err != nil {
 		impl.logger.Errorw("request err, FindById", "error", err, "clusterId", id)
 		common.WriteJsonResp(w, err, nil, http.StatusBadRequest)
 		return
 	}
-	bean, err := impl.clusterDescriptionService.FindByClusterIdWithClusterDetails(i)
+	bean, err := impl.clusterDescriptionService.FindByClusterIdWithClusterDetails(clusterId)
 	if err != nil {
 		if err == pg.ErrNoRows {
 			impl.logger.Errorw("cluster not found, FindById", "err", err, "clusterId", id)
@@ -452,7 +454,7 @@ func (impl ClusterRestHandlerImpl) UpdateClusterNote(w http.ResponseWriter, r *h
 		common.WriteJsonResp(w, err, "Unauthorized User", http.StatusUnauthorized)
 		return
 	}
-	var bean cluster.ClusterNoteBean
+	var bean repository.GenericNote
 	err = decoder.Decode(&bean)
 	if err != nil {
 		impl.logger.Errorw("request err, Update", "error", err, "payload", bean)
@@ -466,9 +468,9 @@ func (impl ClusterRestHandlerImpl) UpdateClusterNote(w http.ResponseWriter, r *h
 		common.WriteJsonResp(w, err, nil, http.StatusBadRequest)
 		return
 	}
-	clusterDescription, err := impl.clusterDescriptionService.FindByClusterIdWithClusterDetails(bean.ClusterId)
+	clusterDescription, err := impl.clusterDescriptionService.FindByClusterIdWithClusterDetails(bean.Identifier)
 	if err != nil {
-		impl.logger.Errorw("service err, FindById", "err", err, "clusterId", bean.ClusterId)
+		impl.logger.Errorw("service err, FindById", "err", err, "clusterId", bean.Identifier)
 		common.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
 		return
 	}
@@ -479,32 +481,9 @@ func (impl ClusterRestHandlerImpl) UpdateClusterNote(w http.ResponseWriter, r *h
 	}
 	// RBAC enforcer ends
 
-	_, err = impl.clusterNoteService.Update(&bean, userId)
-	if err == pg.ErrNoRows {
-		_, err = impl.clusterNoteService.Save(&bean, userId)
-		if err != nil {
-			impl.logger.Errorw("service err, Save", "error", err, "payload", bean)
-			common.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
-			return
-		}
-	}
-	if err != nil {
-		impl.logger.Errorw("service err, Update", "error", err, "payload", bean)
-		common.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
-		return
-	}
-	userInfo, err := impl.userService.GetById(bean.UpdatedBy)
-	if err != nil {
-		impl.logger.Errorw("user service err, FindById", "err", err, "userId", bean.UpdatedBy)
-		common.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
-		return
-	}
-	clusterNoteResponseBean := &cluster.ClusterNoteResponseBean{
-		Id:          bean.Id,
-		Description: bean.Description,
-		UpdatedOn:   bean.UpdatedOn,
-		UpdatedBy:   userInfo.EmailId,
-	}
+	bean.IdentifierType = repository.ClusterType
+	clusterNoteResponseBean, err := impl.clusterNoteService.Update(&bean, userId)
+
 	if err != nil {
 		impl.logger.Errorw("cluster note service err, Update", "error", err, "payload", bean)
 		common.WriteJsonResp(w, err, nil, http.StatusInternalServerError)

api/cluster/ClusterRouter.go

@@ -66,7 +66,7 @@ func (impl ClusterRouterImpl) InitClusterRouter(clusterRouter *mux.Router) {
 		Methods("PUT").
 		HandlerFunc(impl.clusterRestHandler.Update)
 
-	clusterRouter.Path("/description/note").
+	clusterRouter.Path("/description").
 		Methods("PUT").
 		HandlerFunc(impl.clusterRestHandler.UpdateClusterNote)
 

api/cluster/wire_cluster.go

@@ -3,6 +3,8 @@ package cluster
 import (
 	"github.com/devtron-labs/devtron/pkg/cluster"
 	"github.com/devtron-labs/devtron/pkg/cluster/repository"
+	"github.com/devtron-labs/devtron/pkg/genericNotes"
+	repository2 "github.com/devtron-labs/devtron/pkg/genericNotes/repository"
 	"github.com/google/wire"
 )
 
@@ -16,14 +18,14 @@ var ClusterWireSet = wire.NewSet(
 
 	repository.NewClusterDescriptionRepositoryImpl,
 	wire.Bind(new(repository.ClusterDescriptionRepository), new(*repository.ClusterDescriptionRepositoryImpl)),
-	repository.NewClusterNoteHistoryRepositoryImpl,
-	wire.Bind(new(repository.ClusterNoteHistoryRepository), new(*repository.ClusterNoteHistoryRepositoryImpl)),
-	repository.NewClusterNoteRepositoryImpl,
-	wire.Bind(new(repository.ClusterNoteRepository), new(*repository.ClusterNoteRepositoryImpl)),
-	cluster.NewClusterNoteHistoryServiceImpl,
-	wire.Bind(new(cluster.ClusterNoteHistoryService), new(*cluster.ClusterNoteHistoryServiceImpl)),
-	cluster.NewClusterNoteServiceImpl,
-	wire.Bind(new(cluster.ClusterNoteService), new(*cluster.ClusterNoteServiceImpl)),
+	repository2.NewGenericNoteHistoryRepositoryImpl,
+	wire.Bind(new(repository2.GenericNoteHistoryRepository), new(*repository2.GenericNoteHistoryRepositoryImpl)),
+	repository2.NewGenericNoteRepositoryImpl,
+	wire.Bind(new(repository2.GenericNoteRepository), new(*repository2.GenericNoteRepositoryImpl)),
+	genericNotes.NewGenericNoteHistoryServiceImpl,
+	wire.Bind(new(genericNotes.GenericNoteHistoryService), new(*genericNotes.GenericNoteHistoryServiceImpl)),
+	genericNotes.NewGenericNoteServiceImpl,
+	wire.Bind(new(genericNotes.GenericNoteService), new(*genericNotes.GenericNoteServiceImpl)),
 	cluster.NewClusterDescriptionServiceImpl,
 	wire.Bind(new(cluster.ClusterDescriptionService), new(*cluster.ClusterDescriptionServiceImpl)),
 
@@ -51,14 +53,14 @@ var ClusterWireSetEa = wire.NewSet(
 
 	repository.NewClusterDescriptionRepositoryImpl,
 	wire.Bind(new(repository.ClusterDescriptionRepository), new(*repository.ClusterDescriptionRepositoryImpl)),
-	repository.NewClusterNoteHistoryRepositoryImpl,
-	wire.Bind(new(repository.ClusterNoteHistoryRepository), new(*repository.ClusterNoteHistoryRepositoryImpl)),
-	repository.NewClusterNoteRepositoryImpl,
-	wire.Bind(new(repository.ClusterNoteRepository), new(*repository.ClusterNoteRepositoryImpl)),
-	cluster.NewClusterNoteHistoryServiceImpl,
-	wire.Bind(new(cluster.ClusterNoteHistoryService), new(*cluster.ClusterNoteHistoryServiceImpl)),
-	cluster.NewClusterNoteServiceImpl,
-	wire.Bind(new(cluster.ClusterNoteService), new(*cluster.ClusterNoteServiceImpl)),
+	repository2.NewGenericNoteHistoryRepositoryImpl,
+	wire.Bind(new(repository2.GenericNoteHistoryRepository), new(*repository2.GenericNoteHistoryRepositoryImpl)),
+	repository2.NewGenericNoteRepositoryImpl,
+	wire.Bind(new(repository2.GenericNoteRepository), new(*repository2.GenericNoteRepositoryImpl)),
+	genericNotes.NewGenericNoteHistoryServiceImpl,
+	wire.Bind(new(genericNotes.GenericNoteHistoryService), new(*genericNotes.GenericNoteHistoryServiceImpl)),
+	genericNotes.NewGenericNoteServiceImpl,
+	wire.Bind(new(genericNotes.GenericNoteService), new(*genericNotes.GenericNoteServiceImpl)),
 	cluster.NewClusterDescriptionServiceImpl,
 	wire.Bind(new(cluster.ClusterDescriptionService), new(*cluster.ClusterDescriptionServiceImpl)),
 

api/restHandler/AppListingRestHandler.go

@@ -42,6 +42,7 @@ import (
 	service1 "github.com/devtron-labs/devtron/pkg/appStore/deployment/service"
 	"github.com/devtron-labs/devtron/pkg/cluster"
 	"github.com/devtron-labs/devtron/pkg/deploymentGroup"
+	"github.com/devtron-labs/devtron/pkg/genericNotes"
 	"github.com/devtron-labs/devtron/pkg/k8s"
 	application3 "github.com/devtron-labs/devtron/pkg/k8s/application"
 	"github.com/devtron-labs/devtron/pkg/pipeline"
@@ -106,6 +107,7 @@ type AppListingRestHandlerImpl struct {
 	appStatusService                  appStatus.AppStatusService
 	installedAppRepository            repository.InstalledAppRepository
 	environmentClusterMappingsService cluster.EnvironmentService
+	genericNoteService                genericNotes.GenericNoteService
 	cfg                               *bean.Config
 	k8sApplicationService             application3.K8sApplicationService
 }
@@ -137,6 +139,7 @@ func NewAppListingRestHandlerImpl(application application.ServiceClient,
 	pipelineRepository pipelineConfig.PipelineRepository,
 	appStatusService appStatus.AppStatusService, installedAppRepository repository.InstalledAppRepository,
 	environmentClusterMappingsService cluster.EnvironmentService,
+	genericNoteService genericNotes.GenericNoteService,
 	k8sApplicationService application3.K8sApplicationService,
 ) *AppListingRestHandlerImpl {
 	cfg := &bean.Config{}
@@ -167,6 +170,7 @@ func NewAppListingRestHandlerImpl(application application.ServiceClient,
 		appStatusService:                  appStatusService,
 		installedAppRepository:            installedAppRepository,
 		environmentClusterMappingsService: environmentClusterMappingsService,
+		genericNoteService:                genericNoteService,
 		cfg:                               cfg,
 		k8sApplicationService:             k8sApplicationService,
 	}

api/restHandler/AppRestHandler.go

@@ -24,6 +24,8 @@ import (
 	"github.com/devtron-labs/devtron/api/restHandler/common"
 	"github.com/devtron-labs/devtron/pkg/app"
 	"github.com/devtron-labs/devtron/pkg/bean"
+	"github.com/devtron-labs/devtron/pkg/genericNotes"
+	"github.com/devtron-labs/devtron/pkg/genericNotes/repository"
 	"github.com/devtron-labs/devtron/pkg/user"
 	"github.com/devtron-labs/devtron/pkg/user/casbin"
 	"github.com/devtron-labs/devtron/util/rbac"
@@ -42,31 +44,35 @@ type AppRestHandler interface {
 	UpdateApp(w http.ResponseWriter, r *http.Request)
 	UpdateProjectForApps(w http.ResponseWriter, r *http.Request)
 	GetAppListByTeamIds(w http.ResponseWriter, r *http.Request)
+	UpdateAppDescription(w http.ResponseWriter, r *http.Request)
 }
 
 type AppRestHandlerImpl struct {
-	logger           *zap.SugaredLogger
-	appService       app.AppCrudOperationService
-	userAuthService  user.UserService
-	validator        *validator.Validate
-	enforcerUtil     rbac.EnforcerUtil
-	enforcer         casbin.Enforcer
-	helmAppService   client.HelmAppService
-	enforcerUtilHelm rbac.EnforcerUtilHelm
+	logger             *zap.SugaredLogger
+	appService         app.AppCrudOperationService
+	userAuthService    user.UserService
+	validator          *validator.Validate
+	enforcerUtil       rbac.EnforcerUtil
+	enforcer           casbin.Enforcer
+	helmAppService     client.HelmAppService
+	enforcerUtilHelm   rbac.EnforcerUtilHelm
+	genericNoteService genericNotes.GenericNoteService
 }
 
 func NewAppRestHandlerImpl(logger *zap.SugaredLogger, appService app.AppCrudOperationService,
 	userAuthService user.UserService, validator *validator.Validate, enforcerUtil rbac.EnforcerUtil,
-	enforcer casbin.Enforcer, helmAppService client.HelmAppService, enforcerUtilHelm rbac.EnforcerUtilHelm) *AppRestHandlerImpl {
+	enforcer casbin.Enforcer, helmAppService client.HelmAppService, enforcerUtilHelm rbac.EnforcerUtilHelm,
+	genericNoteService genericNotes.GenericNoteService) *AppRestHandlerImpl {
 	handler := &AppRestHandlerImpl{
-		logger:           logger,
-		appService:       appService,
-		userAuthService:  userAuthService,
-		validator:        validator,
-		enforcerUtil:     enforcerUtil,
-		enforcer:         enforcer,
-		helmAppService:   helmAppService,
-		enforcerUtilHelm: enforcerUtilHelm,
+		logger:             logger,
+		appService:         appService,
+		userAuthService:    userAuthService,
+		validator:          validator,
+		enforcerUtil:       enforcerUtil,
+		enforcer:           enforcer,
+		helmAppService:     helmAppService,
+		enforcerUtilHelm:   enforcerUtilHelm,
+		genericNoteService: genericNoteService,
 	}
 	return handler
 }
@@ -337,3 +343,48 @@ func (handler AppRestHandlerImpl) GetAppListByTeamIds(w http.ResponseWriter, r *
 	// RBAC
 	common.WriteJsonResp(w, err, projectWiseApps, http.StatusOK)
 }
+
+func (handler AppRestHandlerImpl) UpdateAppDescription(w http.ResponseWriter, r *http.Request) {
+	token := r.Header.Get("token")
+	decoder := json.NewDecoder(r.Body)
+	userId, err := handler.userAuthService.GetLoggedInUser(r)
+	if userId == 0 || err != nil {
+		handler.logger.Errorw("service err, Update", "error", err, "userId", userId)
+		common.WriteJsonResp(w, err, "Unauthorized User", http.StatusUnauthorized)
+		return
+	}
+	var bean repository.GenericNote
+	err = decoder.Decode(&bean)
+	if err != nil {
+		handler.logger.Errorw("request err, Update", "error", err, "payload", bean)
+		common.WriteJsonResp(w, err, nil, http.StatusBadRequest)
+		return
+	}
+	handler.logger.Debugw("request payload, Update", "payload", bean)
+	err = handler.validator.Struct(bean)
+	if err != nil {
+		handler.logger.Errorw("validate err, Update", "error", err, "payload", bean)
+		common.WriteJsonResp(w, err, nil, http.StatusBadRequest)
+		return
+	}
+	bean.IdentifierType = repository.AppType
+
+	//rbac implementation starts here
+
+	// check for existing project/app permission
+	object := handler.enforcerUtil.GetAppRBACNameByAppId(bean.Identifier)
+	if ok := handler.enforcer.Enforce(token, casbin.ResourceApplications, casbin.ActionUpdate, object); !ok {
+		common.WriteJsonResp(w, err, "Unauthorized User", http.StatusForbidden)
+		return
+	}
+
+	// RBAC enforcer ends
+
+	genericNoteResponseBean, err := handler.genericNoteService.Update(&bean, userId)
+	if err != nil {
+		handler.logger.Errorw("cluster note service err, Update", "error", err, "payload", bean)
+		common.WriteJsonResp(w, err, nil, http.StatusInternalServerError)
+		return
+	}
+	common.WriteJsonResp(w, err, genericNoteResponseBean, http.StatusOK)
+}

api/router/AppRouter.go

@@ -56,4 +56,7 @@ func (router AppRouterImpl) InitAppRouter(appRouter *mux.Router) {
 
 	appRouter.Path("/min").HandlerFunc(router.handler.GetAppListByTeamIds).Methods("GET")
 
+	appRouter.Path("/description").
+		Methods("PUT").
+		HandlerFunc(router.handler.UpdateAppDescription)
 }