fix: resolve build errors on github-deployment-status branch

Author: Flo4604

svc/ctrl/worker/deploy/status_reporter_pr_comment.go

@@ -2,7 +2,6 @@ package deploy
 
 import (
 	"fmt"
-	"regexp"
 	"strings"
 	"time"
 
@@ -20,13 +19,15 @@ const (
 	prCommentRowMarkerFmt = "<!-- row:%s:%s -->"
 )
 
-// rowPattern matches a full table row line that starts with a row marker.
-var rowPattern = regexp.MustCompile(`(?m)^\| <!-- row:\S+ --> .+\|$`)
+// findResult bundles the comment ID and body for restate.Run serialisation.
+type findResult struct {
+	ID   int64
+	Body string
+}
 
 // prCommentReporter creates and updates a shared PR comment with one row per
-// deployment, similar to the Vercel deployment comment. Multiple deploy
-// workflows running concurrently for the same PR each manage their own row.
-// All GitHub API calls are fire-and-forget.
+// app/env combination. Multiple deploy workflows for the same PR each manage
+// their own row. All GitHub API calls are fire-and-forget.
 type prCommentReporter struct {
 	github         githubclient.GitHubClient
 	installationID int64
@@ -40,8 +41,8 @@ type prCommentReporter struct {
 	logURL         string
 	environmentURL string
 
-	prNumber  int   // resolved lazily
-	commentID int64 // set after Create
+	prNumber  int
+	commentID int64
 }
 
 type prCommentReporterConfig struct {
@@ -74,8 +75,6 @@ func newPRCommentReporter(cfg prCommentReporterConfig) *prCommentReporter {
 	}
 }
 
-// Create looks up the PR, finds or creates the shared comment, and adds this
-// deployment's row.
 func (r *prCommentReporter) Create(ctx restate.ObjectSharedContext) {
 	if r.installationID == 0 || r.repo == "" || r.branch == "" {
 		return
@@ -92,99 +91,79 @@ func (r *prCommentReporter) Create(ctx restate.ObjectSharedContext) {
 	}
 	r.prNumber = prNumber
 
-	// Look for an existing deployment comment on this PR.
 	existing, err := restate.Run(ctx, func(_ restate.RunContext) (findResult, error) {
-		id, body, err := r.github.FindBotComment(r.installationID, r.repo, r.prNumber, prCommentMainMarker)
-		return findResult{ID: id, Body: body}, err
+		id, body, findErr := r.github.FindBotComment(r.installationID, r.repo, r.prNumber, prCommentMainMarker)
+		return findResult{ID: id, Body: body}, findErr
 	}, restate.WithName("find existing deploy comment"), restate.WithMaxRetryDuration(30*time.Second))
 	if err != nil {
 		logger.Error("failed to search for existing deploy comment", "error", err)
 	}
 
-	row := r.buildRow("⏳ Queued")
+	row := r.buildRow("Queued")
 
 	if existing.ID != 0 {
-		// Add or replace our row in the existing comment.
 		r.commentID = existing.ID
 		body := r.upsertRow(existing.Body, row)
-
 		_ = restate.RunVoid(ctx, func(_ restate.RunContext) error {
 			return r.github.UpdateIssueComment(r.installationID, r.repo, r.commentID, body)
-		}, restate.WithName("add row to existing deploy comment"), restate.WithMaxRetryDuration(30*time.Second))
+		}, restate.WithName("add row to deploy comment"), restate.WithMaxRetryDuration(30*time.Second))
 		return
 	}
 
-	// No existing comment — create one.
 	body := r.buildFullComment(row)
-	commentID, err := restate.Run(ctx, func(_ restate.RunContext) (int64, error) {
+	commentID, createErr := restate.Run(ctx, func(_ restate.RunContext) (int64, error) {
 		return r.github.CreateIssueComment(r.installationID, r.repo, r.prNumber, body)
-	}, restate.WithName("create PR deployment comment"), restate.WithMaxRetryDuration(30*time.Second))
-	if err != nil {
-		logger.Error("failed to create PR comment", "error", err, "pr", r.prNumber)
+	}, restate.WithName("create deploy comment"), restate.WithMaxRetryDuration(30*time.Second))
+	if createErr != nil {
+		logger.Error("failed to create PR comment", "error", createErr, "pr", r.prNumber)
 		return
 	}
 	r.commentID = commentID
 }
 
-// findResult is a helper to return both ID and Body from restate.Run.
-type findResult struct {
-	ID   int64
-	Body string
-}
-
-// Report updates this deployment's row in the shared PR comment.
 func (r *prCommentReporter) Report(ctx restate.ObjectSharedContext, state string, description string) {
 	if r.commentID == 0 {
 		return
 	}
 
-	statusEmoji, statusLabel := r.stateToDisplay(state)
-	row := r.buildRow(statusEmoji + " " + statusLabel)
+	row := r.buildRow(stateLabel(state))
 
-	// Re-read current comment body so we don't clobber other deployments' rows.
+	// Re-read current body so we don't clobber other apps' rows.
 	current, err := restate.Run(ctx, func(_ restate.RunContext) (findResult, error) {
-		id, body, err := r.github.FindBotComment(r.installationID, r.repo, r.prNumber, prCommentMainMarker)
-		return findResult{ID: id, Body: body}, err
-	}, restate.WithName("read deploy comment for update"), restate.WithMaxRetryDuration(30*time.Second))
+		id, body, findErr := r.github.FindBotComment(r.installationID, r.repo, r.prNumber, prCommentMainMarker)
+		return findResult{ID: id, Body: body}, findErr
+	}, restate.WithName("read deploy comment"), restate.WithMaxRetryDuration(30*time.Second))
 	if err != nil || current.ID == 0 {
 		return
 	}
 
 	body := r.upsertRow(current.Body, row)
-
 	_ = restate.RunVoid(ctx, func(_ restate.RunContext) error {
 		return r.github.UpdateIssueComment(r.installationID, r.repo, r.commentID, body)
-	}, restate.WithName(fmt.Sprintf("update PR comment row: %s", state)), restate.WithMaxRetryDuration(30*time.Second))
+	}, restate.WithName(fmt.Sprintf("update deploy comment: %s", state)), restate.WithMaxRetryDuration(30*time.Second))
 }
 
-// rowMarker returns the unique key for this app/env combination.
 func (r *prCommentReporter) rowMarker() string {
 	return fmt.Sprintf(prCommentRowMarkerFmt, r.appSlug, r.envSlug)
 }
 
-// buildRow produces a single markdown table row with this deployment's info.
 func (r *prCommentReporter) buildRow(status string) string {
-	rowMarker := r.rowMarker()
-
 	nameLabel := r.projectSlug
 	if r.appSlug != "default" {
 		nameLabel += " / " + r.appSlug
 	}
 
-	now := time.Now().UTC().Format("Jan 2, 2006 3:04pm")
-
 	preview := "—"
 	if r.environmentURL != "" {
 		preview = fmt.Sprintf("[Visit Preview](%s)", r.environmentURL)
 	}
 
-	inspect := fmt.Sprintf("[Inspect](%s)", r.logURL)
-
-	return fmt.Sprintf("| %s **%s** (%s) | %s | %s | %s | %s |",
-		rowMarker, nameLabel, r.envSlug, status, preview, inspect, now)
+	return fmt.Sprintf("| %s **%s** (%s) | %s | %s | [Inspect](%s) | %s |",
+		r.rowMarker(), nameLabel, r.envSlug, status,
+		preview, r.logURL,
+		time.Now().UTC().Format("Jan 2, 2006 3:04pm"))
 }
 
-// buildFullComment wraps the header, table, and a single row into a new comment.
 func (r *prCommentReporter) buildFullComment(firstRow string) string {
 	var b strings.Builder
 	b.WriteString(prCommentMainMarker)
@@ -198,55 +177,48 @@ func (r *prCommentReporter) buildFullComment(firstRow string) string {
 }
 
 // upsertRow replaces an existing row for this app/env or appends a new one.
-func (r *prCommentReporter) upsertRow(existingBody string, newRow string) string {
-	rowMarker := r.rowMarker()
+func (r *prCommentReporter) upsertRow(body string, newRow string) string {
+	marker := r.rowMarker()
+	lines := strings.Split(body, "\n")
 
-	if strings.Contains(existingBody, rowMarker) {
-		// Replace the existing row (the whole line containing our marker).
-		lines := strings.Split(existingBody, "\n")
+	if strings.Contains(body, marker) {
 		for i, line := range lines {
-			if strings.Contains(line, rowMarker) {
+			if strings.Contains(line, marker) {
 				lines[i] = newRow
-				break
+				return strings.Join(lines, "\n")
 			}
 		}
-		return strings.Join(lines, "\n")
 	}
 
-	// Append new row after the last table row.
-	// Find the last line that starts with "| " (table row).
-	lines := strings.Split(existingBody, "\n")
+	// Append after the last table row (any line starting with "|" that isn't the separator).
 	lastRowIdx := -1
 	for i, line := range lines {
-		if strings.HasPrefix(line, "|") && !strings.Contains(line, ":--") && i > 0 {
+		if i > 0 && strings.HasPrefix(line, "|") && !strings.Contains(line, ":--") {
 			lastRowIdx = i
 		}
 	}
-
 	if lastRowIdx >= 0 {
-		// Insert after the last row.
 		result := make([]string, 0, len(lines)+1)
 		result = append(result, lines[:lastRowIdx+1]...)
 		result = append(result, newRow)
 		result = append(result, lines[lastRowIdx+1:]...)
 		return strings.Join(result, "\n")
 	}
 
-	// Fallback: just append.
-	return existingBody + newRow + "\n"
+	return body + newRow + "\n"
 }
 
-func (r *prCommentReporter) stateToDisplay(state string) (string, string) {
+func stateLabel(state string) string {
 	switch state {
 	case "pending":
-		return "⏳", "Queued"
+		return "Queued"
 	case "in_progress":
-		return "🔨", "Building"
+		return "Building"
 	case "success":
-		return "✅", "Ready"
+		return "Ready"
 	case "failure", "error":
-		return "❌", "Failed"
+		return "Failed"
 	default:
-		return "⏳", "In Progress"
+		return "In Progress"
 	}
 }

svc/ctrl/worker/github/client.go

@@ -372,7 +372,7 @@ func (c *Client) FindPullRequestForBranch(installationID int64, repo string, bra
 	apiURL := fmt.Sprintf("https://api.github.com/repos/%s/pulls?state=open&head=%s:%s&per_page=1",
 		repo, strings.Split(repo, "/")[0], url.PathEscape(branch))
 
-	prs, err := httpclient.Request[[]ghPullRequest](c.httpClient, http.MethodGet, apiURL, headers, nil, http.StatusOK)
+	prs, err := request[[]ghPullRequest](c.httpClient, http.MethodGet, apiURL, headers, nil, http.StatusOK)
 	if err != nil {
 		return 0, err
 	}
@@ -392,7 +392,7 @@ func (c *Client) CreateIssueComment(installationID int64, repo string, prNumber
 
 	apiURL := fmt.Sprintf("https://api.github.com/repos/%s/issues/%d/comments", repo, prNumber)
 
-	comment, err := httpclient.Request[ghIssueComment](c.httpClient, http.MethodPost, apiURL, headers, map[string]string{
+	comment, err := request[ghIssueComment](c.httpClient, http.MethodPost, apiURL, headers, map[string]string{
 		"body": body,
 	}, http.StatusCreated)
 	if err != nil {
@@ -410,7 +410,7 @@ func (c *Client) UpdateIssueComment(installationID int64, repo string, commentID
 
 	apiURL := fmt.Sprintf("https://api.github.com/repos/%s/issues/comments/%d", repo, commentID)
 
-	return httpclient.Do(c.httpClient, http.MethodPatch, apiURL, headers, map[string]string{
+	return doRequest(c.httpClient, http.MethodPatch, apiURL, headers, map[string]string{
 		"body": body,
 	}, http.StatusOK)
 }
@@ -431,7 +431,7 @@ func (c *Client) FindBotComment(installationID int64, repo string, prNumber int,
 		Body string `json:"body"`
 	}
 
-	comments, err := httpclient.Request[[]ghCommentWithBody](c.httpClient, http.MethodGet, apiURL, headers, nil, http.StatusOK)
+	comments, err := request[[]ghCommentWithBody](c.httpClient, http.MethodGet, apiURL, headers, nil, http.StatusOK)
 	if err != nil {
 		return 0, "", err
 	}

svc/ctrl/worker/github/http.go

@@ -126,7 +126,6 @@ func statusCheck(client *http.Client, method string, url string, headers map[str
 
 	return resp.StatusCode == expectedStatus, nil
 }
-
 // githubHeaders returns common GitHub API headers with the given bearer token.
 func githubHeaders(token string) map[string]string {
 	h := map[string]string{