Delete old plan comments on PR update (#1943)

* Add the ability to auto-nuke previous comments

---------

Co-authored-by: motatoes <moe.habib9@gmail.com>

Author: ZIJ

README.md

@@ -23,8 +23,7 @@ Digger runs Terraform natively in your CI. This is:
 - Open Policy Agent (OPA) support for RBAC
 - PR-level locks (on top of Terraform native state locks, similar to Atlantis) to avoid race conditions across multiple PRs
 - Terragrunt, Workspaces, multiple Terraform versions, static analysis via Checkov, plan persistence, ...
-- Drift detection 
-  
+- Drift detection
 
 ## Getting Started
 
@@ -34,6 +33,7 @@ Digger runs Terraform natively in your CI. This is:
 ## How it works
 
 Digger has 2 main components:
+
 - CLI that runs inside your CI and calls Terraform with the right arguments
 - Orchestrator - a minimal backend (that can also be self-hosted) that triggers CI jobs in response to events such as PR comments
 
@@ -49,7 +49,8 @@ Digger also stores PR-level locks and plan cache in your cloud account (DynamoDB
 - Apply-after-merge workflows
 - Web UI (cloud-based)
 - Read more about differences with Atlantis in our [blog post](https://medium.com/@DiggerHQ/digger-and-atlantis-key-differences-c08029ffe112)
-​
+  ​
+
 ## Compared to Terraform Cloud and other TACOs
 
 - Open source; orchestrator can be self-hosted
@@ -67,7 +68,7 @@ Please pick an issue that already exists if you’re interested in contributing,
 
 Not sure where to get started? You can:
 
--   Join our <a href="https://join.slack.com/t/diggertalk/shared_invite/zt-1tocl4w0x-E3RkpPiK7zQkehl8O78g8Q">Slack</a>, and ask us any questions there.
+- Join our <a href="https://join.slack.com/t/diggertalk/shared_invite/zt-1tocl4w0x-E3RkpPiK7zQkehl8O78g8Q">Slack</a>, and ask us any questions there.
 
 ## Telemetry
 
@@ -76,7 +77,15 @@ Digger collects anonymized telemetry. See [usage.go](https://github.com/diggerhq
 ## Running migrations
 
 ```
-atlas migrate apply --url $DATABASE_URL
+atlas migrate apply --url $DATABASE_URL --allow-dirty
+```
+
+## Local postgres
+
+Might need disabling ssl if running default docker image
+
+```
+export DATABASE_URL=postgres://postgres:root@localhost:5432/postgres?sslmode=disable
 ```
 
 ## Resources

backend/controllers/projects.go

@@ -492,6 +492,7 @@ type SetJobStatusRequest struct {
 	JobSummary      *iac_utils.IacSummary       `json:"job_summary"`
 	Footprint       *iac_utils.IacPlanFootprint `json:"job_plan_footprint"`
 	PrCommentUrl    string                      `json:"pr_comment_url"`
+	PrCommentId     string                      `json:"pr_comment_id"`
 	TerraformOutput string                      `json:"terraform_output"`
 }
 
@@ -527,6 +528,7 @@ func (d DiggerController) SetJobStatusForProject(c *gin.Context) {
 		"jobId", jobId,
 		"currentStatus", job.Status,
 		"newStatus", request.Status,
+		"prCommentId", request.PrCommentId,
 		"batchId", job.BatchID,
 	)
 
@@ -566,8 +568,20 @@ func (d DiggerController) SetJobStatusForProject(c *gin.Context) {
 			)
 		}
 
+		var prCommentId *int64
+		num, err := strconv.ParseInt(request.PrCommentId, 10, 64)
+		if err != nil {
+			slog.Debug("could not parse commentID", "prCommentId", prCommentId, "error", err)
+			slog.Warn("setting prCommentId to nil since could not parse")
+			prCommentId = nil
+		} else {
+			prCommentId = &num
+		}
+
 		job.PRCommentUrl = request.PrCommentUrl
-		err := models.DB.UpdateDiggerJob(job)
+		job.PRCommentId = prCommentId
+
+		err = models.DB.UpdateDiggerJob(job)
 		if err != nil {
 			slog.Error("Error updating job",
 				"jobId", jobId,
@@ -820,6 +834,11 @@ func (d DiggerController) SetJobStatusForProject(c *gin.Context) {
 		}
 	}
 
+	err = DeleteOlderPRCommentsIfEnabled(d.GithubClientProvider, batch)
+	if err != nil {
+		slog.Error("failed to delete older comments", "repoFullName", batch.RepoFullName, "prNumber", batch.PrNumber, "batchID", batch.ID, "error", err)
+	}
+
 	// return batch summary to client
 	res, err := batch.MapToJsonStruct()
 	if err != nil {
@@ -1439,3 +1458,121 @@ func AutomergePRforBatchIfEnabled(gh utils.GithubClientProvider, batch *models.D
 
 	return nil
 }
+
+func DeleteOlderPRCommentsIfEnabled(gh utils.GithubClientProvider, batch *models.DiggerBatch) error {
+	slog.Info("Checking if PR should have prior comments deleted",
+		"batchId", batch.ID,
+		"prNumber", batch.PrNumber,
+		"batchStatus", batch.Status,
+		"batchType", batch.BatchType,
+	)
+
+	diggerYmlString := batch.DiggerConfig
+	diggerConfigYml, err := digger_config.LoadDiggerConfigYamlFromString(diggerYmlString)
+	if err != nil {
+		slog.Error("Error loading Digger config from batch",
+			"batchId", batch.ID,
+			"error", err,
+		)
+		return fmt.Errorf("error loading digger config from batch: %v", err)
+	}
+
+	config, _, err := digger_config.ConvertDiggerYamlToConfig(diggerConfigYml)
+	if err != nil {
+		slog.Error("Error converting Digger YAML to config",
+			"batchId", batch.ID,
+			"error", err,
+		)
+		return fmt.Errorf("error loading digger config from yaml: %v", err)
+	}
+
+	deleteOlderComments := config.DeletePriorComments
+
+	slog.Debug("Delete prior comments settings",
+		"enabled", deleteOlderComments,
+		"batchStatus", batch.Status,
+		"batchType", batch.BatchType,
+	)
+
+	if (batch.Status == orchestrator_scheduler.BatchJobSucceeded || batch.Status == orchestrator_scheduler.BatchJobFailed) &&
+		batch.BatchType == orchestrator_scheduler.DiggerCommandPlan &&
+		batch.CoverAllImpactedProjects == true &&
+		deleteOlderComments == true {
+
+		slog.Info("Conditions met for deleting prior comments, proceeding",
+			"batchId", batch.ID,
+			"prNumber", batch.PrNumber,
+		)
+
+		prService, err := GetPrServiceFromBatch(batch, gh)
+		if err != nil {
+			slog.Error("Error getting PR service",
+				"batchId", batch.ID,
+				"error", err,
+			)
+			return fmt.Errorf("error getting github service: %v", err)
+		}
+
+		prBatches, err := models.DB.GetDiggerBatchesForPR(batch.RepoFullName, batch.PrNumber)
+		if err != nil {
+			slog.Error("Error getting PR service",
+				"batchId", batch.ID,
+				"error", err,
+			)
+			return fmt.Errorf("error getting github service: %v", err)
+		}
+
+		for _, prBatch := range prBatches {
+			if prBatch.BatchType == orchestrator_scheduler.DiggerCommandApply {
+				slog.Info("found previous apply job for PR therefore not deleting earlier comments")
+				return nil
+			}
+		}
+
+		allDeletesSuccessful := true
+		for _, prBatch := range prBatches {
+			if prBatch.ID == batch.ID {
+				// don't delete the current batch comments
+				continue
+			}
+			jobs, err := models.DB.GetDiggerJobsForBatch(prBatch.ID)
+			if err != nil {
+				slog.Error("could not get jobs for batch", "batchId", prBatch.ID, "error", err)
+				// won't return error here since can still continue deleting rest of batches
+				continue
+			}
+			for _, prJob := range jobs {
+				if prJob.PRCommentId == nil {
+					slog.Debug("PR comment not found for job, ignoring deletion", "JobID", prJob.ID)
+					continue
+				}
+				// TODO: this delete will fail with 404 for all previous batches that already have been deleted
+				// for now its okay but maybe better approach is only considering the most recent or have a marker on each batch
+				// on whether or not its comments were deleted yet
+				err = prService.DeleteComment(strconv.FormatInt(*prJob.PRCommentId, 10))
+				if err != nil {
+					slog.Error("Could not delete comment for job", "jobID", prJob.ID, "commentID", prJob.PRCommentId, "error", err)
+					allDeletesSuccessful = false
+				}
+			}
+		}
+
+		if !allDeletesSuccessful {
+			slog.Warn("some of the previous comments failed to delete")
+		}
+
+		return nil
+
+	} else {
+		if batch.BatchType != orchestrator_scheduler.DiggerCommandPlan {
+			slog.Debug("Skipping deletion of prior comments - not an plan command",
+				"batchId", batch.ID,
+				"batchType", batch.BatchType,
+			)
+		} else if !deleteOlderComments {
+			slog.Debug("Skipping deletion of prior comments - not enabled in config", "batchId", batch.ID)
+		}
+	}
+
+	return nil
+}

backend/go.sum

@@ -750,6 +750,8 @@ github.com/ajstarks/deck v0.0.0-20200831202436-30c9fc6549a9/go.mod h1:JynElWSGnm
 github.com/ajstarks/deck/generate v0.0.0-20210309230005-c3f852c02e19/go.mod h1:T13YZdzov6OU0A1+RfKZiZN9ca6VeKdBdyDV+BY97Tk=
 github.com/ajstarks/svgo v0.0.0-20180226025133-644b8db467af/go.mod h1:K08gAheRH3/J6wwsYMMT4xOr94bZjxIelGM0+d/wbFw=
 github.com/ajstarks/svgo v0.0.0-20211024235047-1546f124cd8b/go.mod h1:1KcenG0jGWcpt8ov532z81sp/kMMUG485J2InIOyADM=
+github.com/alecthomas/kong v0.7.1 h1:azoTh0IOfwlAX3qN9sHWTxACE2oV8Bg2gAwBsMwDQY4=
+github.com/alecthomas/kong v0.7.1/go.mod h1:n1iCIO2xS46oE8ZfYCNDqdR0b0wZNrXAIAqro/2132U=
 github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
 github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
 github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0=

backend/migrations/20250512172515.sql

@@ -0,0 +1,2 @@
+-- Modify "digger_jobs" table
+ALTER TABLE "public"."digger_jobs" ADD COLUMN "pr_comment_id" bigint NULL;

backend/migrations/20250512213729.sql

@@ -0,0 +1,4 @@
+-- Modify "digger_batches" table
+ALTER TABLE "public"."digger_batches" ADD COLUMN "created_at" timestamptz NULL, ADD COLUMN "updated_at" timestamptz NULL, ADD COLUMN "deleted_at" timestamptz NULL;
+-- Create index "idx_digger_batches_deleted_at" to table: "digger_batches"
+CREATE INDEX "idx_digger_batches_deleted_at" ON "public"."digger_batches" ("deleted_at");

backend/migrations/atlas.sum

@@ -1,4 +1,4 @@
-h1:fdisQq5X2P2f4UyvwdQ2k7q9iqRSi02mm1ydhG0V0G8=
+h1:7qYia+JfrMJUdNvsjR8hZosttT36aVdOje5TP3ekX4w=
 20231227132525.sql h1:43xn7XC0GoJsCnXIMczGXWis9d504FAWi4F1gViTIcw=
 20240115170600.sql h1:IW8fF/8vc40+eWqP/xDK+R4K9jHJ9QBSGO6rN9LtfSA=
 20240116123649.sql h1:R1JlUIgxxF6Cyob9HdtMqiKmx/BfnsctTl5rvOqssQw=
@@ -47,3 +47,5 @@ h1:fdisQq5X2P2f4UyvwdQ2k7q9iqRSi02mm1ydhG0V0G8=
 20250325115901.sql h1:yrha7g515WPkFRHfidvtLVWMeQmRD8rzVyWtPbuk0ws=
 20250325134924.sql h1:5vywDVuT0FPmQKP75AvxopxOeuKXsTEN00rgQjnA+ss=
 20250416152705.sql h1:yeszz4c/BlyVgUUIk7aTUz/DUNMC40+9fe1Q8Ya4TVI=
+20250512172515.sql h1:iIZIhFq3TTyjTzsxNWv3k4FcIkXfOCdHtmHNmYqjBMM=
+20250512213729.sql h1:n8bYIXWko9xOUs+FPcG7lS3GXMVQBSygXX7Hpj20eVs=

backend/models/scheduler.go

@@ -24,6 +24,7 @@ const DiggerVCSGitlab DiggerVCSType = "gitlab"
 const DiggerVCSBitbucket DiggerVCSType = "bitbucket"
 
 type DiggerBatch struct {
+	gorm.Model
 	ID                       uuid.UUID `gorm:"primary_key"`
 	VCS                      DiggerVCSType
 	PrNumber                 int
@@ -53,6 +54,7 @@ type DiggerJob struct {
 	Batch              *DiggerBatch
 	BatchID            *string `gorm:"index:idx_digger_job_id"`
 	PRCommentUrl       string
+	PRCommentId        *int64
 	DiggerJobSummary   DiggerJobSummary
 	DiggerJobSummaryID uint
 	SerializedJobSpec  []byte

backend/models/storage.go

@@ -1839,3 +1839,24 @@ func (db *Database) GetRepoCache(orgId uint, repoFullName string) (*RepoCache, e
 		"configSize", len(repoCache.DiggerConfig))
 	return &repoCache, nil
 }
+
+func (db *Database) GetDiggerBatchesForPR(repoFullName string, prNumber int) ([]DiggerBatch, error) {
+	// Step 1: Get all batches for the PR
+	batches := make([]DiggerBatch, 0)
+	result := db.GormDB.Where("repo_full_name = ? AND pr_number = ?", repoFullName, prNumber).Find(&batches)
+	if result.Error != nil {
+		slog.Error("error fetching batches for PR",
+			"prNumber", prNumber,
+			"repoFullName", repoFullName,
+			"error", result.Error)
+		return nil, result.Error
+	}
+	slog.Info("fetched all digger batches for PR",
+		"prNumber", prNumber,
+		"repoFullName", repoFullName,
+		"batchCount", len(batches),
+		"jobCount", len(batches))
+
+	return batches, nil
+
+}

cli/pkg/digger/digger.go

@@ -131,7 +131,7 @@ func RunJobs(jobs []orchestrator.Job, prService ci.PullRequestService, orgServic
 	if allAppliesSuccess == true && reportFinalStatusToBackend == true {
 		currentJob := jobs[0]
 
-		_, jobPrCommentUrl, err := reporter.Flush()
+		jobPrCommentId, jobPrCommentUrl, err := reporter.Flush()
 		if err != nil {
 			slog.Error("error while sending job comments", "error", err)
 			cmt, cmt_err := prService.PublishComment(*currentJob.PullRequestNumber, fmt.Sprintf(":yellow_circle: Warning: failed to post report for project %v, received error: %v.\n\n you may review details in the job logs", currentJob.ProjectName, err))
@@ -153,7 +153,7 @@ func RunJobs(jobs []orchestrator.Job, prService ci.PullRequestService, orgServic
 		prNumber := *currentJob.PullRequestNumber
 
 		iacUtils := iac_utils.GetIacUtilsIacType(currentJob.IacType())
-		batchResult, err := backendApi.ReportProjectJobStatus(currentJob.Namespace, projectNameForBackendReporting, jobId, "succeeded", time.Now(), &summary, "", jobPrCommentUrl, terraformOutput, iacUtils)
+		batchResult, err := backendApi.ReportProjectJobStatus(currentJob.Namespace, projectNameForBackendReporting, jobId, "succeeded", time.Now(), &summary, "", jobPrCommentUrl, jobPrCommentId, terraformOutput, iacUtils)
 		if err != nil {
 			slog.Error("error reporting Job status", "error", err)
 			return false, false, fmt.Errorf("error while running command: %v", err)

cli/pkg/digger/digger_test.go

@@ -155,6 +155,10 @@ func (m *MockPRManager) EditComment(prNumber int, id string, comment string) err
 	return nil
 }
 
+func (m *MockPRManager) DeleteComment(id string) error {
+	return nil
+}
+
 func (m *MockPRManager) CreateCommentReaction(id string, reaction string) error {
 	m.Commands = append(m.Commands, RunInfo{"EditComment", id + " " + reaction, time.Now()})
 	return nil

cli/pkg/spec/spec.go

@@ -17,7 +17,7 @@ import (
 
 func reportError(spec spec.Spec, backendApi backend2.Api, message string, err error) {
 	slog.Error(message)
-	_, reportingError := backendApi.ReportProjectJobStatus(spec.VCS.RepoName, spec.Job.ProjectName, spec.JobId, "failed", time.Now(), nil, "", "", "", nil)
+	_, reportingError := backendApi.ReportProjectJobStatus(spec.VCS.RepoName, spec.Job.ProjectName, spec.JobId, "failed", time.Now(), nil, "", "", "", "", nil)
 	if reportingError != nil {
 		usage.ReportErrorAndExit(spec.VCS.RepoOwner, fmt.Sprintf("Failed to run commands. %v", err), 5)
 	}
@@ -137,7 +137,7 @@ func RunSpec(
 
 	jobs := []scheduler.Job{job}
 
-	_, err = backendApi.ReportProjectJobStatus(spec.VCS.RepoName, spec.Job.ProjectName, spec.JobId, "started", time.Now(), nil, "", "", "", nil)
+	_, err = backendApi.ReportProjectJobStatus(spec.VCS.RepoName, spec.Job.ProjectName, spec.JobId, "started", time.Now(), nil, "", "", "", "", nil)
 	if err != nil {
 		message := fmt.Sprintf("Failed to report jobSpec status to backend. Exiting. %v", err)
 		reportError(spec, backendApi, message, err)
@@ -158,7 +158,7 @@ func RunSpec(
 	reportTerraformOutput := spec.Reporter.ReportTerraformOutput
 	allAppliesSuccess, _, err := digger.RunJobs(jobs, prService, orgService, lock, reporter, planStorage, policyChecker, commentUpdater, backendApi, spec.JobId, true, reportTerraformOutput, commentId, currentDir)
 	if !allAppliesSuccess || err != nil {
-		serializedBatch, reportingError := backendApi.ReportProjectJobStatus(spec.VCS.RepoName, spec.Job.ProjectName, spec.JobId, "failed", time.Now(), nil, "", "", "", nil)
+		serializedBatch, reportingError := backendApi.ReportProjectJobStatus(spec.VCS.RepoName, spec.Job.ProjectName, spec.JobId, "failed", time.Now(), nil, "", "", "", "", nil)
 		if reportingError != nil {
 			message := fmt.Sprintf("Failed run commands. %v", err)
 			reportError(spec, backendApi, message, err)

docs/ce/reference/digger.yml.mdx

@@ -104,6 +104,7 @@ workflows:
 | auto_merge                  | boolean                                                       | false    | no       | automatically merge pull requests when all checks pass                                                                                 |                                               |
 | auto_merge_strategy         | string                                                        | "squash" | no       | The merge strategy to use while automerging, defaults to "squash". Possible values: 'squash', 'merge' (for merge commits) and 'rebase' | currently only github supported for this flag |
 | pr_locks                    | boolean                                                       | true     | no       | Enable PR-level locking                                                                                                                |                                               |
+| delete_prior_comments       | boolean                                                       | false    | no       | Enables digger to delete previous comments to reduce noise in the PR                                                                   |                                               |
 | projects                    | array of [Projects](/ce/reference/digger.yml#project)         | \[\]     | no       | list of projects to manage                                                                                                             |                                               |
 | generate_projects           | [GenerateProjects](/ce/reference/digger.yml#generateprojects) | {}       | no       | generate projects from a directory structure                                                                                           |                                               |
 | workflows                   | map of [Workflows](/ce/reference/digger.yml#workflows)        | {}       | no       | workflows and configurations to run on events                                                                                          |                                               |

libs/backendapi/backend.go

@@ -9,7 +9,7 @@ import (
 type Api interface {
 	ReportProject(repo string, projectName string, configuration string) error
 	ReportProjectRun(repo string, projectName string, startedAt time.Time, endedAt time.Time, status string, command string, output string) error
-	ReportProjectJobStatus(repo string, projectName string, jobId string, status string, timestamp time.Time, summary *iac_utils.IacSummary, planJson string, PrCommentUrl string, terraformOutput string, iacUtils iac_utils.IacUtils) (*scheduler.SerializedBatch, error)
+	ReportProjectJobStatus(repo string, projectName string, jobId string, status string, timestamp time.Time, summary *iac_utils.IacSummary, planJson string, PrCommentUrl string, PrCommentId string, terraformOutput string, iacUtils iac_utils.IacUtils) (*scheduler.SerializedBatch, error)
 	UploadJobArtefact(zipLocation string) (*int, *string, error)
 	DownloadJobArtefact(downloadTo string) (*string, error)
 }

libs/backendapi/diggerapi.go

@@ -31,7 +31,7 @@ func (n NoopApi) ReportProjectRun(namespace string, projectName string, startedA
 	return nil
 }
 
-func (n NoopApi) ReportProjectJobStatus(repo string, projectName string, jobId string, status string, timestamp time.Time, summary *iac_utils.IacSummary, planJson string, PrCommentUrl string, terraformOutput string, iacUtils iac_utils.IacUtils) (*scheduler.SerializedBatch, error) {
+func (n NoopApi) ReportProjectJobStatus(repo string, projectName string, jobId string, status string, timestamp time.Time, summary *iac_utils.IacSummary, planJson string, PrCommentUrl string, PrCommentId string, terraformOutput string, iacUtils iac_utils.IacUtils) (*scheduler.SerializedBatch, error) {
 	return nil, nil
 }
 
@@ -135,8 +135,8 @@ func (d DiggerApi) ReportProjectRun(namespace string, projectName string, starte
 	return nil
 }
 
-func (d DiggerApi) ReportProjectJobStatus(repoFullName string, projectName string, jobId string, status string, timestamp time.Time, summary *iac_utils.IacSummary, planJson string, PrCommentUrl string, terraformOutput string, iacUtils iac_utils.IacUtils) (*scheduler.SerializedBatch, error) {
-	repoNameForBackendReporting := strings.ReplaceAll(repoFullName, "/", "-")
+func (d DiggerApi) ReportProjectJobStatus(repo string, projectName string, jobId string, status string, timestamp time.Time, summary *iac_utils.IacSummary, planJson string, PrCommentUrl string, PrCommentId string, terraformOutput string, iacUtils iac_utils.IacUtils) (*scheduler.SerializedBatch, error) {
+	repoNameForBackendReporting := strings.ReplaceAll(repo, "/", "-")
 	u, err := url.Parse(d.DiggerHost)
 	if err != nil {
 		slog.Error("not able to parse digger cloud url", "error", err)
@@ -167,6 +167,7 @@ func (d DiggerApi) ReportProjectJobStatus(repoFullName string, projectName strin
 		"job_summary":        planSummaryJson,
 		"job_plan_footprint": planFootprint.ToJson(),
 		"pr_comment_url":     PrCommentUrl,
+		"pr_comment_id":      PrCommentId,
 		"terraform_output":   terraformOutput,
 	}