Skip to content

fix: fix for ci cd workflow fake success status and multiple post/pre cd success notifications #6370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 10, 2025
Merged

fix: fix for ci cd workflow fake success status and multiple post/pre cd success notifications #6370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ecd0d33
fix: ignore handling of the cd workflow status update event no state …
gireesh-naidu Feb 7, 2025
0b9749b
Merge branch 'develop' into fix-ci-cd-workflow-status-oss
gireesh-naidu Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 42 additions & 34 deletions pkg/eventProcessor/in/WorkflowEventProcessorService.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,51 +436,47 @@ func (impl *WorkflowEventProcessorImpl) SubscribeCDWorkflowStatusUpdate() error
return
}

wfrId, wfrStatus, err := impl.cdHandler.UpdateWorkflow(wfStatus)
wfrId, wfrStatus, stateChanged, err := impl.cdHandler.UpdateWorkflow(wfStatus)
impl.logger.Debugw("UpdateWorkflow", "wfrId", wfrId, "wfrStatus", wfrStatus)
if err != nil {
impl.logger.Error("err", err)
return
}

wfr, err := impl.cdWorkflowRepository.FindWorkflowRunnerById(wfrId)
if err != nil {
impl.logger.Errorw("could not get wf runner", "err", err)
return
}
if wfrStatus == string(v1alpha1.NodeFailed) || wfrStatus == string(v1alpha1.NodeError) {
if len(wfr.ImagePathReservationIds) > 0 {
err := impl.cdHandler.DeactivateImageReservationPathsOnFailure(wfr.ImagePathReservationIds)
if err != nil {
impl.logger.Errorw("error in removing image path reservation ")
}
}
}
if wfrStatus == string(v1alpha1.NodeSucceeded) || wfrStatus == string(v1alpha1.NodeFailed) || wfrStatus == string(v1alpha1.NodeError) {
eventType := eventUtil.EventType(0)
if wfrStatus == string(v1alpha1.NodeSucceeded) {
eventType = eventUtil.Success
} else if wfrStatus == string(v1alpha1.NodeFailed) || wfrStatus == string(v1alpha1.NodeError) {
eventType = eventUtil.Fail
if stateChanged {
wfr, err := impl.cdWorkflowRepository.FindWorkflowRunnerById(wfrId)
if err != nil {
impl.logger.Errorw("could not get wf runner", "wfrId", wfrId, "err", err)
return
}

if wfr != nil && executors.CheckIfReTriggerRequired(wfrStatus, wfStatus.Message, wfr.Status) {
err = impl.workflowDagExecutor.HandleCdStageReTrigger(wfr)
if err != nil {
//check if this log required or not
impl.logger.Errorw("error in HandleCdStageReTrigger", "error", err)
if wfrStatus == string(v1alpha1.NodeFailed) || wfrStatus == string(v1alpha1.NodeError) {
if len(wfr.ImagePathReservationIds) > 0 {
err := impl.cdHandler.DeactivateImageReservationPathsOnFailure(wfr.ImagePathReservationIds)
if err != nil {
impl.logger.Errorw("error in removing image path reservation ", "imagePathReservationIds", wfr.ImagePathReservationIds, "err", err)
}
}
}
if wfrStatus == string(v1alpha1.NodeSucceeded) || wfrStatus == string(v1alpha1.NodeFailed) || wfrStatus == string(v1alpha1.NodeError) {
eventType := eventUtil.EventType(0)
if wfrStatus == string(v1alpha1.NodeSucceeded) {
eventType = eventUtil.Success
} else if wfrStatus == string(v1alpha1.NodeFailed) || wfrStatus == string(v1alpha1.NodeError) {
eventType = eventUtil.Fail
}

if wfr.WorkflowType == apiBean.CD_WORKFLOW_TYPE_PRE || wfr.WorkflowType == apiBean.CD_WORKFLOW_TYPE_POST {
event, _ := impl.eventFactory.Build(eventType, &wfr.CdWorkflow.PipelineId, wfr.CdWorkflow.Pipeline.AppId, &wfr.CdWorkflow.Pipeline.EnvironmentId, eventUtil.CD)
impl.logger.Debugw("event pre stage", "event", event)
event = impl.eventFactory.BuildExtraCDData(event, wfr, 0, wfr.WorkflowType)
_, evtErr := impl.eventClient.WriteNotificationEvent(event)
if evtErr != nil {
impl.logger.Errorw("CD stage post fail or success event unable to sent", "error", evtErr)
if wfr != nil && executors.CheckIfReTriggerRequired(wfrStatus, wfStatus.Message, wfr.Status) {
err = impl.workflowDagExecutor.HandleCdStageReTrigger(wfr)
if err != nil {
//check if this log required or not
impl.logger.Errorw("error in HandleCdStageReTrigger", "workflowRunnerId", wfr.Id, "workflowStatus", wfrStatus, "workflowStatusMessage", wfStatus.Message, "error", err)
}
impl.logger.Debugw("re-triggered cd stage", "workflowRunnerId", wfr.Id, "workflowStatus", wfrStatus, "workflowStatusMessage", wfStatus.Message)
} else {
impl.sendPrePostCdNotificationEvent(eventType, wfr)
}
}
} else {
impl.logger.Debugw("no state change detected for the cd workflow status update, ignoring this event", "workflowRunnerId", wfrId, "wfrStatus", wfrStatus)
}
}

Expand All @@ -503,6 +499,18 @@ func (impl *WorkflowEventProcessorImpl) SubscribeCDWorkflowStatusUpdate() error
return nil
}

func (impl *WorkflowEventProcessorImpl) sendPrePostCdNotificationEvent(eventType eventUtil.EventType, wfr *pipelineConfig.CdWorkflowRunner) {
if wfr.WorkflowType == apiBean.CD_WORKFLOW_TYPE_PRE || wfr.WorkflowType == apiBean.CD_WORKFLOW_TYPE_POST {
event, _ := impl.eventFactory.Build(eventType, &wfr.CdWorkflow.PipelineId, wfr.CdWorkflow.Pipeline.AppId, &wfr.CdWorkflow.Pipeline.EnvironmentId, eventUtil.CD)
impl.logger.Debugw("event pre stage", "event", event)
event = impl.eventFactory.BuildExtraCDData(event, wfr, 0, wfr.WorkflowType)
_, evtErr := impl.eventClient.WriteNotificationEvent(event)
if evtErr != nil {
impl.logger.Errorw("CD stage post fail or success event unable to sent", "error", evtErr)
}
}
}

func (impl *WorkflowEventProcessorImpl) extractCiCompleteEventFrom(msg *model.PubSubMsg) (bean.CiCompleteEvent, error) {
ciCompleteEvent := bean.CiCompleteEvent{}
err := json.Unmarshal([]byte(msg.Data), &ciCompleteEvent)
Expand Down
16 changes: 8 additions & 8 deletions pkg/pipeline/CdHandler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ const (
)

type CdHandler interface {
UpdateWorkflow(workflowStatus v1alpha1.WorkflowStatus) (int, string, error)
UpdateWorkflow(workflowStatus v1alpha1.WorkflowStatus) (int, string, bool, error)
GetCdBuildHistory(appId int, environmentId int, pipelineId int, offset int, size int) ([]pipelineBean.CdWorkflowWithArtifact, error)
GetRunningWorkflowLogs(environmentId int, pipelineId int, workflowId int) (*bufio.Reader, func() error, error)
FetchCdWorkflowDetails(appId int, environmentId int, pipelineId int, buildId int) (types.WorkflowResponse, error)
Expand Down Expand Up @@ -262,23 +262,23 @@ func (impl *CdHandlerImpl) handleForceAbortCaseForCdStage(workflowRunner *pipeli
return nil
}

func (impl *CdHandlerImpl) UpdateWorkflow(workflowStatus v1alpha1.WorkflowStatus) (int, string, error) {
func (impl *CdHandlerImpl) UpdateWorkflow(workflowStatus v1alpha1.WorkflowStatus) (int, string, bool, error) {
wfStatusRs := impl.extractWorkfowStatus(workflowStatus)
workflowName, status, podStatus, message, podName := wfStatusRs.WorkflowName, wfStatusRs.Status, wfStatusRs.PodStatus, wfStatusRs.Message, wfStatusRs.PodName
impl.Logger.Debugw("cd update for ", "wf ", workflowName, "status", status)
if workflowName == "" {
return 0, "", errors.New("invalid wf name")
return 0, "", false, errors.New("invalid wf name")
}
workflowId, err := strconv.Atoi(workflowName[:strings.Index(workflowName, "-")])
if err != nil {
impl.Logger.Error("invalid wf status update req", "err", err)
return 0, "", err
return 0, "", false, err
}

savedWorkflow, err := impl.cdWorkflowRepository.FindWorkflowRunnerById(workflowId)
if err != nil {
impl.Logger.Error("cannot get saved wf", "err", err)
return 0, "", err
return 0, "", false, err
}

cdArtifactLocationFormat := impl.config.GetArtifactLocationFormat()
Expand All @@ -299,21 +299,21 @@ func (impl *CdHandlerImpl) UpdateWorkflow(workflowStatus v1alpha1.WorkflowStatus
err = impl.cdWorkflowRunnerService.UpdateCdWorkflowRunnerWithStage(savedWorkflow)
if err != nil {
impl.Logger.Error("update wf failed for id " + strconv.Itoa(savedWorkflow.Id))
return 0, "", err
return 0, "", true, err
}
appId := savedWorkflow.CdWorkflow.Pipeline.AppId
envId := savedWorkflow.CdWorkflow.Pipeline.EnvironmentId
envDeploymentConfig, err := impl.deploymentConfigService.GetConfigForDevtronApps(appId, envId)
if err != nil {
impl.Logger.Errorw("error in fetching environment deployment config by appId and envId", "appId", appId, "envId", envId, "err", err)
return 0, "", err
return 0, "", true, err
}
util3.TriggerCDMetrics(cdWorkflow.GetTriggerMetricsFromRunnerObj(savedWorkflow, envDeploymentConfig), impl.config.ExposeCDMetrics)
if string(v1alpha1.NodeError) == savedWorkflow.Status || string(v1alpha1.NodeFailed) == savedWorkflow.Status {
impl.Logger.Warnw("cd stage failed for workflow: ", "wfId", savedWorkflow.Id)
}
}
return savedWorkflow.Id, savedWorkflow.Status, nil
return savedWorkflow.Id, savedWorkflow.Status, false, nil
}

func (impl *CdHandlerImpl) extractWorkfowStatus(workflowStatus v1alpha1.WorkflowStatus) *types.WorkflowStatus {
Expand Down
24 changes: 16 additions & 8 deletions pkg/pipeline/CiHandler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1223,17 +1223,25 @@ func (impl *CiHandlerImpl) UpdateWorkflow(workflowStatus v1alpha1.WorkflowStatus
impl.Logger.Error("update wf failed for id " + strconv.Itoa(savedWorkflow.Id))
return 0, err
}
if string(v1alpha1.NodeError) == savedWorkflow.Status || string(v1alpha1.NodeFailed) == savedWorkflow.Status {
impl.Logger.Warnw("ci failed for workflow: ", "wfId", savedWorkflow.Id)
impl.sendCIFailEvent(savedWorkflow, status, message)
}
return savedWorkflow.Id, nil
}

if extractErrorCode(savedWorkflow.Message) != workFlow.CiStageFailErrorCode {
go impl.WriteCIFailEvent(savedWorkflow)
} else {
impl.Logger.Infof("Step failed notification received for wfID %d with message %s", savedWorkflow.Id, savedWorkflow.Message)
}
func (impl *CiHandlerImpl) sendCIFailEvent(savedWorkflow *pipelineConfig.CiWorkflow, status, message string) {
if string(v1alpha1.NodeError) == savedWorkflow.Status || string(v1alpha1.NodeFailed) == savedWorkflow.Status {
if executors.CheckIfReTriggerRequired(status, message, savedWorkflow.Status) {
impl.Logger.Infow("not sending failure notification for re-trigger workflow", "workflowId", savedWorkflow.Id)
return
}
impl.Logger.Warnw("ci failed for workflow: ", "wfId", savedWorkflow.Id)

if extractErrorCode(savedWorkflow.Message) != workFlow.CiStageFailErrorCode {
go impl.WriteCIFailEvent(savedWorkflow)
} else {
impl.Logger.Infof("Step failed notification received for wfID %d with message %s", savedWorkflow.Id, savedWorkflow.Message)
}
}
return savedWorkflow.Id, nil
}

func extractErrorCode(msg string) int {
Expand Down
Loading