async update of workflow urls

Author: motatoes

backend/ci_backends/ci_backends.go

@@ -7,6 +7,7 @@ import (
 
 type CiBackend interface {
 	TriggerWorkflow(spec spec.Spec, runName string, vcsToken string) error
+	GetWorkflowUrl(spec spec.Spec) (string, error)
 }
 
 type JenkinsCi struct{}

backend/ci_backends/github_actions.go

@@ -3,6 +3,7 @@ package ci_backends
 import (
 	"context"
 	"encoding/json"
+	"github.com/diggerhq/digger/backend/utils"
 	orchestrator_scheduler "github.com/diggerhq/digger/libs/scheduler"
 	"github.com/diggerhq/digger/libs/spec"
 	"github.com/google/go-github/v61/github"
@@ -30,3 +31,13 @@ func (g GithubActionCi) TriggerWorkflow(spec spec.Spec, runName string, vcsToken
 
 	return err
 }
+
+func (g GithubActionCi) GetWorkflowUrl(spec spec.Spec) (string, error) {
+	_, workflowRunUrl, err := utils.GetWorkflowIdAndUrlFromDiggerJobId(g.Client, spec.VCS.RepoOwner, spec.VCS.RepoName, spec.JobId)
+	if err != nil {
+		log.Printf("Error getting workflow ID from job: %v", err)
+		return "", err
+	} else {
+		return workflowRunUrl, nil
+	}
+}

backend/services/scheduler.go

@@ -6,10 +6,14 @@ import (
 	"github.com/diggerhq/digger/backend/config"
 	"github.com/diggerhq/digger/backend/models"
 	"github.com/diggerhq/digger/backend/utils"
+	comment_updater "github.com/diggerhq/digger/libs/comment_utils/summary"
 	orchestrator_scheduler "github.com/diggerhq/digger/libs/scheduler"
+	"github.com/diggerhq/digger/libs/spec"
 	"github.com/google/go-github/v61/github"
 	"github.com/google/uuid"
 	"log"
+	"runtime/debug"
+	"time"
 )
 
 func DiggerJobCompleted(client *github.Client, batchId *uuid.UUID, parentJob *models.DiggerJob, repoFullName string, repoOwner string, repoName string, workflowFileName string, gh utils.GithubClientProvider) error {
@@ -131,5 +135,68 @@ func TriggerJob(gh utils.GithubClientProvider, ciBackend ci_backends.CiBackend,
 		return err
 	}
 
+	go UpdateWorkflowUrlForJob(job, ciBackend, spec, gh)
+
 	return nil
 }
+
+// This is meant to run asyncronously since it queries for job url
+// in case of github we don't get it immediately but with some delay
+func UpdateWorkflowUrlForJob(job *models.DiggerJob, ciBackend ci_backends.CiBackend, spec *spec.Spec, gh utils.GithubClientProvider) {
+	defer func() {
+		if r := recover(); r != nil {
+			log.Printf("Recovered from panic in UpdateWorkflowUrlForJob handler: %v", r)
+			log.Printf("\n=== PANIC RECOVERED ===\n")
+			log.Printf("Error: %v\n", r)
+			log.Printf("Stack Trace:\n%s", string(debug.Stack()))
+			log.Printf("=== END PANIC ===\n")
+		}
+	}()
+
+	batch := job.Batch
+	// for now we only perform this update for github
+	if batch.VCS != models.DiggerVCSGithub {
+		return
+	}
+	for n := 0; n < 30; n++ {
+		time.Sleep(1 * time.Second)
+		workflowUrl, err := ciBackend.GetWorkflowUrl(*spec)
+		if err != nil {
+			log.Printf("DiggerJobId %v: error while attempting to fetch workflow url: %v", job.DiggerJobID, err)
+		} else {
+			if workflowUrl == "#" || workflowUrl == "" {
+				log.Printf("DiggerJobId %v: got blank workflow url as response, ignoring", job.DiggerJobID)
+			} else {
+				job.WorkflowRunUrl = &workflowUrl
+				err = models.DB.UpdateDiggerJob(job)
+				if err != nil {
+					log.Printf("DiggerJobId %v: Error updating digger job: %v", job.DiggerJobID, err)
+					continue
+				} else {
+					log.Printf("DiggerJobId %v: successfully updated workflow run url to: %v for DiggerJobID: %v", job.DiggerJobID, workflowUrl, job.DiggerJobID)
+				}
+
+				// refresh the batch from DB to get accurate results
+				batch, err = models.DB.GetDiggerBatch(&job.Batch.ID)
+				if err != nil {
+					log.Printf("DiggerJobId %v: Error getting batch: %v", job.DiggerJobID, err)
+					continue
+				}
+				res, err := batch.MapToJsonStruct()
+				if err != nil {
+					log.Printf("DiggerJobId %v: Error getting batch details: %v", job.DiggerJobID, err)
+					continue
+				}
+				// TODO: make this abstract and extracting the right "prService" based on VCS
+				client, _, err := utils.GetGithubService(gh, batch.GithubInstallationId, spec.VCS.RepoFullname, spec.VCS.RepoOwner, spec.VCS.RepoName)
+				err = comment_updater.BasicCommentUpdater{}.UpdateComment(res.Jobs, *spec.Job.PullRequestNumber, client, spec.CommentId)
+				if err != nil {
+					log.Printf("diggerJobId: %v error whilst updating comment %v", job.DiggerJobID, err)
+					continue
+				}
+				return
+			}
+		}
+	}
+
+}

backend/tasks/runs_test.go

@@ -28,6 +28,10 @@ func (m MockCiBackend) TriggerWorkflow(spec spec.Spec, runName string, vcsToken
 	return nil
 }
 
+func (m MockCiBackend) GetWorkflowUrl(spec spec.Spec) (string, error) {
+	return "", nil
+}
+
 func setupSuite(tb testing.TB) (func(tb testing.TB), *models.Database) {
 	log.Println("setup suite")
 

backend/utils/github.go

@@ -231,7 +231,6 @@ func GetWorkflowIdAndUrlFromDiggerJobId(client *github.Client, repoOwner string,
 	}
 
 	for _, workflowRun := range runs.WorkflowRuns {
-		println(*workflowRun.ID)
 		workflowjobs, _, err := client.Actions.ListWorkflowJobs(context.Background(), repoOwner, repoName, *workflowRun.ID, nil)
 		if err != nil {
 			return 0, "#", fmt.Errorf("error listing workflow jobs for run %v %v", workflowRun.ID, err)

ee/backend/ci_backends/bitbucket_pipeline.go

@@ -37,3 +37,10 @@ func (bbp BitbucketPipelineCI) TriggerWorkflow(spec spec.Spec, runName string, v
 	_, err = bbp.Client.TriggerPipeline(bbp.Branch, variables)
 	return err
 }
+
+// GetWorkflowUrl fetch workflow url after triggering a job
+// since some CI don't return url automatically we split it out to become a
+// followup method
+func (bbp BitbucketPipelineCI) GetWorkflowUrl(spec spec.Spec) (string, error) {
+	return "", nil
+}

ee/backend/ci_backends/buildkite.go

@@ -31,3 +31,7 @@ func (b BuildkiteCi) TriggerWorkflow(spec spec.Spec, runName string, vcsToken st
 	return err
 
 }
+
+func (b BuildkiteCi) GetWorkflowUrl(spec spec.Spec) (string, error) {
+	return "", nil
+}

ee/backend/ci_backends/gitlab_pipeline.go

@@ -59,3 +59,7 @@ func (gl GitlabPipelineCI) TriggerWorkflow(spec spec.Spec, runName string, vcsTo
 
 	return err
 }
+
+func (g GitlabPipelineCI) GetWorkflowUrl(spec spec.Spec) (string, error) {
+	return "", nil
+}

ee/backend/controllers/bitbucket.go

@@ -24,6 +24,7 @@ import (
 	"log"
 	"net/http"
 	"os"
+	"runtime/debug"
 	"strconv"
 	"strings"
 )
@@ -139,6 +140,16 @@ func (ee DiggerEEController) BitbucketWebhookHandler(c *gin.Context) {
 }
 
 func handleIssueCommentEventBB(bitbucketProvider utils.BitbucketProvider, payload *BitbucketCommentCreatedEvent, ciBackendProvider ci_backends.CiBackendProvider, organisationId uint, vcsConnectionId *uint, bbAccessToken string) error {
+	defer func() {
+		if r := recover(); r != nil {
+			log.Printf("Recovered from panic in handleIssueCommentEventBB handler: %v", r)
+			log.Printf("\n=== PANIC RECOVERED ===\n")
+			log.Printf("Error: %v\n", r)
+			log.Printf("Stack Trace:\n%s", string(debug.Stack()))
+			log.Printf("=== END PANIC ===\n")
+		}
+	}()
+
 	repoFullName := payload.Repository.FullName
 	repoOwner := payload.Repository.Owner.Username
 	repoName := payload.Repository.Name

next/ci_backends/ci_backends.go

@@ -7,6 +7,7 @@ import (
 
 type CiBackend interface {
 	TriggerWorkflow(spec spec.Spec, runName string, vcsToken string) error
+	GetWorkflowUrl(spec spec.Spec) (string, error)
 }
 
 type JenkinsCi struct{}