chore: refactoring ci pipeline reader service (#6062)

Ash-exp · web-flow · commit 2895460a049b · 2024-11-15T19:08:44.000+05:30
* chore: read service for CiPipelineRepository

* moved into pkg/build/pipeline
diff --git a/Wire.go b/Wire.go
@@ -203,7 +203,7 @@ func InitializeApp() (*App, error) {
 		apiToken.ApiTokenWireSet,
 		webhookHelm.WebhookHelmWireSet,
 		terminal.TerminalWireSet,
-		build.BuildWireSet,
+		build.WireSet,
 		deployment2.DeploymentWireSet,
 		argoApplication.ArgoApplicationWireSetFull,
 		fluxApplication.FluxApplicationWireSet,
diff --git a/client/telemetry/TelemetryEventClientExtended.go b/client/telemetry/TelemetryEventClientExtended.go
@@ -22,6 +22,7 @@ import (
 	client "github.com/devtron-labs/devtron/api/helm-app/gRPC"
 	repository3 "github.com/devtron-labs/devtron/pkg/build/git/gitProvider/repository"
 	"github.com/devtron-labs/devtron/pkg/build/pipeline/bean"
+	ciConfig "github.com/devtron-labs/devtron/pkg/build/pipeline/read"
 	"github.com/devtron-labs/devtron/pkg/deployment/gitOps/config"
 	cron3 "github.com/devtron-labs/devtron/util/cron"
 	"net/http"
@@ -52,7 +53,7 @@ const AppsCount int = 50
 type TelemetryEventClientImplExtended struct {
 	environmentService            cluster.EnvironmentService
 	appListingRepository          repository.AppListingRepository
-	ciPipelineRepository          pipelineConfig.CiPipelineRepository
+	ciPipelineConfigReadService   ciConfig.CiPipelineConfigReadService
 	pipelineRepository            pipelineConfig.PipelineRepository
 	gitProviderRepository         repository3.GitProviderRepository
 	dockerArtifactStoreRepository dockerRegistryRepository.DockerArtifactStoreRepository
@@ -71,7 +72,7 @@ func NewTelemetryEventClientImplExtended(logger *zap.SugaredLogger, client *http
 	K8sUtil *util2.K8sServiceImpl, aCDAuthConfig *util3.ACDAuthConfig,
 	environmentService cluster.EnvironmentService, userService user2.UserService,
 	appListingRepository repository.AppListingRepository, PosthogClient *PosthogClient,
-	ciPipelineRepository pipelineConfig.CiPipelineRepository, pipelineRepository pipelineConfig.PipelineRepository,
+	ciPipelineConfigReadService ciConfig.CiPipelineConfigReadService, pipelineRepository pipelineConfig.PipelineRepository,
 	gitProviderRepository repository3.GitProviderRepository, attributeRepo repository.AttributesRepository,
 	ssoLoginService sso.SSOLoginService, appRepository app.AppRepository,
 	ciWorkflowRepository pipelineConfig.CiWorkflowRepository, cdWorkflowRepository pipelineConfig.CdWorkflowRepository,
@@ -89,7 +90,7 @@ func NewTelemetryEventClientImplExtended(logger *zap.SugaredLogger, client *http
 	watcher := &TelemetryEventClientImplExtended{
 		environmentService:            environmentService,
 		appListingRepository:          appListingRepository,
-		ciPipelineRepository:          ciPipelineRepository,
+		ciPipelineConfigReadService:   ciPipelineConfigReadService,
 		pipelineRepository:            pipelineRepository,
 		gitProviderRepository:         gitProviderRepository,
 		dockerArtifactStoreRepository: dockerArtifactStoreRepository,
@@ -239,12 +240,12 @@ func (impl *TelemetryEventClientImplExtended) SendSummaryEvent(eventType string)
 		nonProdApps = -1
 	}
 
-	ciPipelineCount, err := impl.ciPipelineRepository.FindAllPipelineCreatedCountInLast24Hour()
+	ciPipelineCount, err := impl.ciPipelineConfigReadService.FindAllPipelineCreatedCountInLast24Hour()
 	if err != nil && err != pg.ErrNoRows {
 		impl.logger.Errorw("exception caught inside telemetry summary event, while retrieving ciPipelineCount, setting its value to -1", "err", err)
 		ciPipelineCount = -1
 	}
-	ciPipelineDeletedCount, err := impl.ciPipelineRepository.FindAllDeletedPipelineCountInLast24Hour()
+	ciPipelineDeletedCount, err := impl.ciPipelineConfigReadService.FindAllDeletedPipelineCountInLast24Hour()
 	if err != nil && err != pg.ErrNoRows {
 		impl.logger.Errorw("exception caught inside telemetry summary event, while retrieving ciPipelineDeletedCount, setting its value to -1", "err", err)
 		ciPipelineDeletedCount = -1
@@ -314,7 +315,7 @@ func (impl *TelemetryEventClientImplExtended) SendSummaryEvent(eventType string)
 		if err != nil {
 			impl.logger.Errorw("exception caught inside telemetry summary event,while retrieving AppsWithDeploymentTemplateConfigured", "err", err)
 		}
-		payload.AppsWithCiPipelineConfigured, err = impl.ciPipelineRepository.FindNumberOfAppsWithCiPipeline(appIds)
+		payload.AppsWithCiPipelineConfigured, err = impl.ciPipelineConfigReadService.FindNumberOfAppsWithCiPipeline(appIds)
 		if err != nil {
 			impl.logger.Errorw("exception caught inside telemetry summary event,while retrieving AppsWithCiPipelineConfigured", "err", err)
 		}
diff --git a/internal/sql/repository/pipelineConfig/CiPipelineRepository.go b/internal/sql/repository/pipelineConfig/CiPipelineRepository.go
@@ -88,6 +88,8 @@ type CiPipelineScript struct {
 	sql.AuditLog
 }
 
+// CiPipelineRepository :
+// use config.CiPipelineConfigReadService instead of directly using CiPipelineRepository
 type CiPipelineRepository interface {
 	sql.TransactionWrapper
 	Save(pipeline *CiPipeline, tx *pg.Tx) error
@@ -121,7 +123,7 @@ type CiPipelineRepository interface {
 	PipelineExistsByName(names []string) (found []string, err error)
 	FindByName(pipelineName string) (pipeline *CiPipeline, err error)
 	CheckIfPipelineExistsByNameAndAppId(pipelineName string, appId int) (bool, error)
-	FindByLinkedCiCount(parentCiPipelineId int) (int, error)
+	GetChildrenCiCount(parentCiPipelineId int) (int, error)
 	FindByParentCiPipelineId(parentCiPipelineId int) ([]*CiPipeline, error)
 	FindByParentIdAndType(parentCiPipelineId int, pipelineType string) ([]*CiPipeline, error)
 
@@ -158,7 +160,7 @@ func NewCiPipelineRepositoryImpl(dbConnection *pg.DB, logger *zap.SugaredLogger,
 	}
 }
 
-func (impl *CiPipelineRepositoryImpl) FindByLinkedCiCount(parentCiPipelineId int) (int, error) {
+func (impl *CiPipelineRepositoryImpl) GetChildrenCiCount(parentCiPipelineId int) (int, error) {
 	return impl.dbConnection.Model((*CiPipeline)(nil)).
 		Where("parent_ci_pipeline = ?", parentCiPipelineId).
 		Where("active = ?", true).
diff --git a/pkg/build/artifacts/wire_artifacts.go b/pkg/build/artifacts/wire_artifacts.go
@@ -18,7 +18,7 @@ package artifacts
 
 import "github.com/google/wire"
 
-var ArtifactsWireSet = wire.NewSet(
+var WireSet = wire.NewSet(
 	NewCommonArtifactServiceImpl,
 	wire.Bind(new(CommonArtifactService), new(*CommonArtifactServiceImpl)),
 )
diff --git a/pkg/build/pipeline/read/CiPipelineReadService.go b/pkg/build/pipeline/read/CiPipelineReadService.go
@@ -0,0 +1,75 @@
+/*
+ * Copyright (c) 2024. Devtron Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package read
+
+import (
+	"errors"
+	"github.com/devtron-labs/devtron/internal/sql/repository/pipelineConfig"
+	"github.com/go-pg/pg"
+	"go.uber.org/zap"
+)
+
+type CiPipelineConfigReadService interface {
+	FindLinkedCiCount(ciPipelineId int) (int, error)
+	FindNumberOfAppsWithCiPipeline(appIds []int) (count int, err error)
+	FindAllPipelineCreatedCountInLast24Hour() (pipelineCount int, err error)
+	FindAllDeletedPipelineCountInLast24Hour() (pipelineCount int, err error)
+	GetChildrenCiCount(parentCiPipelineId int) (int, error)
+}
+
+type CiPipelineConfigReadServiceImpl struct {
+	logger               *zap.SugaredLogger
+	ciPipelineRepository pipelineConfig.CiPipelineRepository
+}
+
+func NewCiPipelineConfigReadServiceImpl(
+	logger *zap.SugaredLogger,
+	ciPipelineRepository pipelineConfig.CiPipelineRepository,
+) *CiPipelineConfigReadServiceImpl {
+	return &CiPipelineConfigReadServiceImpl{
+		logger:               logger,
+		ciPipelineRepository: ciPipelineRepository,
+	}
+}
+
+func (impl *CiPipelineConfigReadServiceImpl) FindLinkedCiCount(ciPipelineId int) (int, error) {
+	return impl.ciPipelineRepository.FindLinkedCiCount(ciPipelineId)
+}
+
+func (impl *CiPipelineConfigReadServiceImpl) FindNumberOfAppsWithCiPipeline(appIds []int) (count int, err error) {
+	return impl.ciPipelineRepository.FindNumberOfAppsWithCiPipeline(appIds)
+}
+
+func (impl *CiPipelineConfigReadServiceImpl) FindAllPipelineCreatedCountInLast24Hour() (pipelineCount int, err error) {
+	return impl.ciPipelineRepository.FindAllPipelineCreatedCountInLast24Hour()
+}
+
+func (impl *CiPipelineConfigReadServiceImpl) FindAllDeletedPipelineCountInLast24Hour() (pipelineCount int, err error) {
+	return impl.ciPipelineRepository.FindAllDeletedPipelineCountInLast24Hour()
+}
+
+func (impl *CiPipelineConfigReadServiceImpl) GetChildrenCiCount(parentCiPipelineId int) (int, error) {
+	count, err := impl.ciPipelineRepository.GetChildrenCiCount(parentCiPipelineId)
+	if err != nil && !errors.Is(err, pg.ErrNoRows) {
+		impl.logger.Errorw("failed to get children ci count", "parentCiPipelineId", parentCiPipelineId, "error", err)
+		return 0, err
+	} else if errors.Is(err, pg.ErrNoRows) {
+		impl.logger.Debugw("no children ci found", "parentCiPipelineId", parentCiPipelineId)
+		return 0, nil
+	}
+	return count, nil
+}
diff --git a/pkg/build/pipeline/wire_pipeline.go b/pkg/build/pipeline/wire_pipeline.go
@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2024. Devtron Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package pipeline
+
+import (
+	"github.com/devtron-labs/devtron/pkg/build/pipeline/read"
+	"github.com/google/wire"
+)
+
+var WireSet = wire.NewSet(
+	read.NewCiPipelineConfigReadServiceImpl,
+	wire.Bind(new(read.CiPipelineConfigReadService), new(*read.CiPipelineConfigReadServiceImpl)),
+)
diff --git a/pkg/build/wire_build.go b/pkg/build/wire_build.go
@@ -19,10 +19,12 @@ package build
 import (
 	"github.com/devtron-labs/devtron/pkg/build/artifacts"
 	"github.com/devtron-labs/devtron/pkg/build/git"
+	"github.com/devtron-labs/devtron/pkg/build/pipeline"
 	"github.com/google/wire"
 )
 
-var BuildWireSet = wire.NewSet(
-	artifacts.ArtifactsWireSet,
+var WireSet = wire.NewSet(
+	artifacts.WireSet,
+	pipeline.WireSet,
 	git.GitWireSet,
 )
diff --git a/pkg/pipeline/BuildPipelineConfigService.go b/pkg/pipeline/BuildPipelineConfigService.go
@@ -32,6 +32,7 @@ import (
 	"github.com/devtron-labs/devtron/pkg/bean"
 	"github.com/devtron-labs/devtron/pkg/build/pipeline"
 	bean3 "github.com/devtron-labs/devtron/pkg/build/pipeline/bean"
+	"github.com/devtron-labs/devtron/pkg/build/pipeline/read"
 	pipelineConfigBean "github.com/devtron-labs/devtron/pkg/pipeline/bean"
 	"github.com/devtron-labs/devtron/pkg/pipeline/history"
 	"github.com/devtron-labs/devtron/pkg/pipeline/repository"
@@ -117,6 +118,7 @@ type CiPipelineConfigServiceImpl struct {
 	ciTemplateService             CiTemplateService
 	ciTemplateReadService         pipeline.CiTemplateReadService
 	materialRepo                  pipelineConfig.MaterialRepository
+	ciPipelineConfigReadService   read.CiPipelineConfigReadService
 	ciPipelineRepository          pipelineConfig.CiPipelineRepository
 	ciConfig                      *types.CiCdConfig
 	attributesService             attributes.AttributesService
@@ -147,6 +149,7 @@ func NewCiPipelineConfigServiceImpl(logger *zap.SugaredLogger,
 	materialRepo pipelineConfig.MaterialRepository,
 	pipelineGroupRepo app2.AppRepository,
 	pipelineRepository pipelineConfig.PipelineRepository,
+	ciPipelineConfigReadService read.CiPipelineConfigReadService,
 	ciPipelineRepository pipelineConfig.CiPipelineRepository,
 	ecrConfig *EcrConfig,
 	appWorkflowRepository appWorkflow.AppWorkflowRepository,
@@ -178,6 +181,7 @@ func NewCiPipelineConfigServiceImpl(logger *zap.SugaredLogger,
 		materialRepo:                  materialRepo,
 		appRepo:                       pipelineGroupRepo,
 		pipelineRepository:            pipelineRepository,
+		ciPipelineConfigReadService:   ciPipelineConfigReadService,
 		ciPipelineRepository:          ciPipelineRepository,
 		ecrConfig:                     ecrConfig,
 		appWorkflowRepository:         appWorkflowRepository,
@@ -2010,8 +2014,8 @@ func (impl *CiPipelineConfigServiceImpl) DeleteCiPipeline(request *bean.CiPatchR
 	ciPipelineId := request.CiPipeline.Id
 
 	// check for linked ci's before deleting the ci pipeline
-	count, err := impl.ciPipelineRepository.FindByLinkedCiCount(ciPipelineId)
-	if err != nil && err != pg.ErrNoRows {
+	count, err := impl.ciPipelineConfigReadService.GetChildrenCiCount(ciPipelineId)
+	if err != nil {
 		impl.logger.Errorw("error in checking for any linked ci before deleting the ci pipeline", "ciPipelineId", ciPipelineId, "err", err)
 		return nil, err
 	}
diff --git a/pkg/pipeline/BuildPipelineSwitchService.go b/pkg/pipeline/BuildPipelineSwitchService.go
@@ -22,6 +22,7 @@ import (
 	"github.com/devtron-labs/devtron/internal/util"
 	"github.com/devtron-labs/devtron/pkg/bean"
 	pipelineConfigBean "github.com/devtron-labs/devtron/pkg/build/pipeline/bean"
+	"github.com/devtron-labs/devtron/pkg/build/pipeline/read"
 	"github.com/devtron-labs/devtron/pkg/pipeline/adapter"
 	"github.com/devtron-labs/devtron/pkg/pipeline/history"
 	repository4 "github.com/devtron-labs/devtron/pkg/pipeline/history/repository"
@@ -49,6 +50,7 @@ type BuildPipelineSwitchService interface {
 
 type BuildPipelineSwitchServiceImpl struct {
 	logger                       *zap.SugaredLogger
+	ciPipelineConfigReadService  read.CiPipelineConfigReadService
 	ciPipelineRepository         pipelineConfig.CiPipelineRepository
 	ciCdPipelineOrchestrator     CiCdPipelineOrchestrator
 	pipelineRepository           pipelineConfig.PipelineRepository
@@ -60,6 +62,7 @@ type BuildPipelineSwitchServiceImpl struct {
 }
 
 func NewBuildPipelineSwitchServiceImpl(logger *zap.SugaredLogger,
+	ciPipelineConfigReadService read.CiPipelineConfigReadService,
 	ciPipelineRepository pipelineConfig.CiPipelineRepository,
 	ciCdPipelineOrchestrator CiCdPipelineOrchestrator,
 	pipelineRepository pipelineConfig.PipelineRepository,
@@ -70,6 +73,7 @@ func NewBuildPipelineSwitchServiceImpl(logger *zap.SugaredLogger,
 	ciPipelineMaterialRepository pipelineConfig.CiPipelineMaterialRepository) *BuildPipelineSwitchServiceImpl {
 	return &BuildPipelineSwitchServiceImpl{
 		logger:                       logger,
+		ciPipelineConfigReadService:  ciPipelineConfigReadService,
 		ciPipelineRepository:         ciPipelineRepository,
 		ciCdPipelineOrchestrator:     ciCdPipelineOrchestrator,
 		pipelineRepository:           pipelineRepository,
@@ -355,7 +359,7 @@ func (impl *BuildPipelineSwitchServiceImpl) updateLinkedAppWorkflowMappings(tx *
 func (impl *BuildPipelineSwitchServiceImpl) validateSwitchPreConditions(switchFromCiPipelineId int) error {
 
 	// old ci_pipeline should not contain any linked ci_pipelines.
-	linkedCiPipelines, err := impl.ciPipelineRepository.FindLinkedCiCount(switchFromCiPipelineId)
+	linkedCiPipelines, err := impl.ciPipelineConfigReadService.FindLinkedCiCount(switchFromCiPipelineId)
 	if err != nil {
 		impl.logger.Errorw("error in finding the linkedCi count for the pipeline", "ciPipelineId", switchFromCiPipelineId, "err", err)
 		return err
diff --git a/wire_gen.go b/wire_gen.go

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ package artifacts`
`18`	`18`
`19`	`19`	`import "github.com/google/wire"`
`20`	`20`
`21`		`-var ArtifactsWireSet = wire.NewSet(`
	`21`	`+var WireSet = wire.NewSet(`
`22`	`22`	`NewCommonArtifactServiceImpl,`
`23`	`23`	`wire.Bind(new(CommonArtifactService), new(*CommonArtifactServiceImpl)),`
`24`	`24`	`)`
Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,12 @@ package build`
`19`	`19`	`import (`
`20`	`20`	`"github.com/devtron-labs/devtron/pkg/build/artifacts"`
`21`	`21`	`"github.com/devtron-labs/devtron/pkg/build/git"`
	`22`	`+ "github.com/devtron-labs/devtron/pkg/build/pipeline"`
`22`	`23`	`"github.com/google/wire"`
`23`	`24`	`)`
`24`	`25`
`25`		`-var BuildWireSet = wire.NewSet(`
`26`		`- artifacts.ArtifactsWireSet,`
	`26`	`+var WireSet = wire.NewSet(`
	`27`	`+ artifacts.WireSet,`
	`28`	`+ pipeline.WireSet,`
`27`	`29`	`git.GitWireSet,`
`28`	`30`	`)`