cmd/relui: add a "ping early-in-cycle issues" workflow

When adding a dedicated relui workflow, it was tempting to make it fancy
with each issue being a sub-task, etc. But we wouldn't want that if/when
this task joins others as part of a "reopen the dev tree" workflow, so
keep it a simple atomic (and safe to re-run) task. This is similar to
how pushing issues or checking for release blockers is one atomic task.

For golang/go#58856.

Change-Id: Idc8ef3cd62b7bb98c97b37d38ef9cdc2beccc24c
Reviewed-on: https://go-review.googlesource.com/c/build/+/473160
Reviewed-by: Heschi Kreinick <[email protected]>
Auto-Submit: Dmitri Shuralyov <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
TryBot-Result: Gopher Robot <[email protected]>
Run-TryBot: Dmitri Shuralyov <[email protected]>

Author: dmitshur

cmd/gopherbot/gopherbot.go

@@ -440,7 +440,6 @@ var tasks = []struct {
 	// Tasks that are specific to the golang/go repo.
 	{"kicktrain", (*gopherbot).getOffKickTrain},
 	{"unwait-release", (*gopherbot).unwaitRelease},
-	{"ping-early-issues", (*gopherbot).pingEarlyIssues},
 	{"label build issues", (*gopherbot).labelBuildIssues},
 	{"label compiler/runtime issues", (*gopherbot).labelCompilerRuntimeIssues},
 	{"label mobile issues", (*gopherbot).labelMobileIssues},
@@ -932,120 +931,6 @@ func (b *gopherbot) unwaitRelease(ctx context.Context) error {
 	return nil
 }
 
-// pingEarlyIssues pings early-in-cycle issues in the next major release milestone.
-// This is run manually (with --only-run) at the opening of a release cycle.
-func (b *gopherbot) pingEarlyIssues(ctx context.Context) error {
-	// We only run this task if it was explicitly requested via
-	// the --only-run flag.
-	if *onlyRun == "" {
-		return nil
-	}
-
-	// Compute nextMajor, a value like "1.17" representing that Go 1.17
-	// is the next major version (the version whose development just started).
-	majorReleases, _, err := b.fetchReleases(ctx)
-	if err != nil {
-		return err
-	}
-	nextMajor := majorReleases[len(majorReleases)-1]
-
-	// The message posted in this task links to an announcement that the tree is open
-	// for general Go 1.x development. Update the openTreeURLs map appropriately when
-	// running this task.
-	openTreeURLs := map[string]string{
-		"1.22": "https://groups.google.com/g/golang-dev/c/FNPk2joOsXs/m/roCc_a4fBAAJ",
-	}
-	if url, ok := openTreeURLs[nextMajor]; !ok {
-		return fmt.Errorf("openTreeURLs[%q] is missing a value, please fill it in", nextMajor)
-	} else if !strings.HasPrefix(url, "https://groups.google.com/g/golang-dev/c/") {
-		return fmt.Errorf("openTreeURLs[%q] is %q, which doesn't begin with the usual prefix, so please double-check that the URL is correct", nextMajor, url)
-	}
-	var milestoneNumber int // TODO: Determine the milestone number dynamically.
-	if nextMajor == "1.22" {
-		milestoneNumber = 298
-	} else {
-		return fmt.Errorf("major to milestone number mapping is not implemented")
-	}
-
-	// Find all open early-in-cycle issues in the current major release milestone.
-	type issue struct {
-		ID     githubv4.ID
-		Number int
-		Title  string
-
-		TimelineItems struct {
-			Nodes []struct {
-				IssueComment struct {
-					Author struct{ Login string }
-					Body   string
-				} `graphql:"...on IssueComment"`
-			}
-		} `graphql:"timelineItems(since: $avoidDupSince, itemTypes: ISSUE_COMMENT, last: 100)"`
-	}
-	var earlyIssues []issue
-	variables := map[string]interface{}{
-		"avoidDupSince":   githubv4.DateTime{Time: time.Now().Add(-30 * 24 * time.Hour)},
-		"milestoneNumber": githubv4.String(fmt.Sprint(milestoneNumber)), // For some reason GitHub API v4 uses string type for milestone numbers.
-		"issueCursor":     (*githubv4.String)(nil),
-	}
-	for {
-		var q struct {
-			Repository struct {
-				Issues struct {
-					Nodes    []issue
-					PageInfo struct {
-						EndCursor   githubv4.String
-						HasNextPage bool
-					}
-				} `graphql:"issues(first: 100, after: $issueCursor, filterBy: {states: OPEN, labels: \"early-in-cycle\", milestoneNumber: $milestoneNumber}, orderBy: {field: CREATED_AT, direction: ASC})"`
-			} `graphql:"repository(owner: \"golang\", name: \"go\")"`
-		}
-		err := b.ghV4.Query(ctx, &q, variables)
-		if err != nil {
-			return err
-		}
-		earlyIssues = append(earlyIssues, q.Repository.Issues.Nodes...)
-		if !q.Repository.Issues.PageInfo.HasNextPage {
-			break
-		}
-		variables["issueCursor"] = githubv4.NewString(q.Repository.Issues.PageInfo.EndCursor)
-	}
-
-	// Ping them.
-EarlyIssuesLoop:
-	for _, i := range earlyIssues {
-		for _, n := range i.TimelineItems.Nodes {
-			if n.IssueComment.Author.Login == "gopherbot" && strings.Contains(n.IssueComment.Body, "friendly reminder") {
-				log.Printf("skipping early-in-cycle issue %d, it was already pinged", i.Number)
-				continue EarlyIssuesLoop
-			}
-		}
-
-		// Post a comment.
-		if *dryRun {
-			log.Printf("[dry run] would ping early-in-cycle issue\n\t#%d %s", i.Number, i.Title)
-			continue
-		}
-		log.Printf("pinging early-in-cycle issue %d (%.32s…)", i.Number, i.Title)
-		time.Sleep(3 * time.Second) // Take a moment between pinging issues, since a human will be running this task manually.
-		var m struct {
-			AddComment struct {
-				ClientMutationID string // GraphQL doesn't permit empty mutations.
-			} `graphql:"addComment(input: $input)"`
-		}
-		err := b.ghV4.Mutate(ctx, &m, githubv4.AddCommentInput{
-			SubjectID: i.ID,
-			Body: githubv4.String(fmt.Sprintf("This issue is currently labeled as early-in-cycle for Go %s.\n"+
-				"That [time is now](%s), so a friendly reminder to look at it again.", nextMajor, openTreeURLs[nextMajor])),
-		}, nil)
-		if err != nil {
-			return err
-		}
-	}
-
-	return nil
-}
-
 // freezeOldIssues locks any issue that's old and closed.
 // (Otherwise people find ancient bugs via searches and start asking questions
 // into a void and it's sad for everybody.)

internal/relui/buildrelease_test.go

@@ -30,6 +30,7 @@ import (
 	"github.com/google/go-cmp/cmp/cmpopts"
 	"github.com/google/go-github/github"
 	"github.com/google/uuid"
+	"github.com/shurcooL/githubv4"
 	"golang.org/x/build/gerrit"
 	"golang.org/x/build/internal"
 	"golang.org/x/build/internal/gcsfs"
@@ -741,6 +742,10 @@ func (fakeGitHub) EditMilestone(_ context.Context, owner string, repo string, nu
 	return nil, nil, nil
 }
 
+func (fakeGitHub) PostComment(_ context.Context, _ githubv4.ID, _ string) error {
+	return fmt.Errorf("pretend that PostComment failed")
+}
+
 type verboseListener struct {
 	t       *testing.T
 	onStall func()

internal/relui/workflows.go

@@ -266,6 +266,27 @@ func RegisterReleaseWorkflows(ctx context.Context, h *DefinitionHolder, build *B
 		h.RegisterDefinition("pre-announce "+r.name, wd)
 	}
 
+	// Register workflows for miscellaneous tasks that happen as part of the Go release cycle.
+	{
+		// Register a "ping early-in-cycle issues" workflow.
+		wd := wf.New()
+		openTreeURL := wf.Param(wd, wf.ParamDef[string]{
+			Name:    "Open Tree URL",
+			Doc:     `Open Tree URL is the URL of an announcement that the tree is open for general Go 1.x development.`,
+			Example: "https://groups.google.com/g/golang-dev/c/09IwUs7cxXA/m/c2jyIhECBQAJ",
+			Check: func(openTreeURL string) error {
+				if !strings.HasPrefix(openTreeURL, "https://groups.google.com/g/golang-dev/c/") {
+					return fmt.Errorf("openTreeURL value %q doesn't begin with the usual prefix, so please double-check that the URL is correct", openTreeURL)
+				}
+				return nil
+			},
+		})
+		devVer := wf.Task0(wd, "Get development version", version.GetDevelVersion)
+		pinged := wf.Task2(wd, "Ping early-in-cycle issues", milestone.PingEarlyIssues, devVer, openTreeURL)
+		wf.Output(wd, "pinged", pinged)
+		h.RegisterDefinition("ping early-in-cycle issues in development milestone", wd)
+	}
+
 	// Register dry-run release workflows.
 	registerBuildTestSignOnlyWorkflow(h, version, build, currentMajor+1, task.KindBeta)
 

internal/task/gerrit.go

@@ -38,6 +38,7 @@ type GerritClient interface {
 	// ListProjects lists all the projects on the server.
 	ListProjects(ctx context.Context) ([]string, error)
 	// ReadFile reads a file from project at the specified commit.
+	// If the file doesn't exist, it returns an error matching gerrit.ErrResourceNotExist.
 	ReadFile(ctx context.Context, project, commit, file string) ([]byte, error)
 	// GetCommitsInRefs gets refs in which the specified commits were merged into.
 	GetCommitsInRefs(ctx context.Context, project string, commits, refs []string) (map[string][]string, error)

internal/task/milestones.go

@@ -9,6 +9,7 @@ import (
 	"fmt"
 	"sort"
 	"strings"
+	"time"
 
 	"github.com/google/go-github/github"
 	"github.com/shurcooL/githubv4"
@@ -36,7 +37,11 @@ const (
 )
 
 type ReleaseMilestones struct {
-	Current, Next int
+	// Current is the GitHub milestone number for the current Go release.
+	// For example, 279 for the "Go1.21" milestone (https://github.com/golang/go/milestone/279).
+	Current int
+	// Next is the GitHub milestone number for the next Go release of the same kind.
+	Next int
 }
 
 // FetchMilestones returns the milestone numbers for the version currently being
@@ -172,11 +177,107 @@ func (m *MilestoneTasks) PushIssues(ctx *wf.TaskContext, milestones ReleaseMiles
 	return nil
 }
 
+// PingEarlyIssues pings early-in-cycle issues in the development major release milestone.
+// This is done once at the opening of a release cycle, currently via a standalone workflow.
+//
+// develVersion is a value like 22 representing that Go 1.22 is the major version whose
+// development has recently started, and whose early-in-cycle issues are to be pinged.
+func (m *MilestoneTasks) PingEarlyIssues(ctx *wf.TaskContext, develVersion int, openTreeURL string) (result struct{}, _ error) {
+	milestoneName := fmt.Sprintf("Go1.%d", develVersion)
+
+	gh, ok := m.Client.(*GitHubClient)
+	if !ok || gh.V4 == nil {
+		// TODO(go.dev/issue/58856): Decide if it's worth moving the GraphQL query/mutation
+		// into GitHubClientInterface. That kinda harms readability because GraphQL code is
+		// basically a flexible API call, so it's most readable when close to where they're
+		// used. This also depends on what kind of tests we'll want to use for this.
+		return struct{}{}, fmt.Errorf("no GitHub API v4 client")
+	}
+
+	// Find all open early-in-cycle issues in the development major release milestone.
+	type issue struct {
+		ID     githubv4.ID
+		Number int
+		Title  string
+
+		TimelineItems struct {
+			Nodes []struct {
+				IssueComment struct {
+					Author struct{ Login string }
+					Body   string
+				} `graphql:"...on IssueComment"`
+			}
+		} `graphql:"timelineItems(since: $avoidDupSince, itemTypes: ISSUE_COMMENT, last: 100)"`
+	}
+	var earlyIssues []issue
+	milestoneNumber, err := m.Client.FetchMilestone(ctx, m.RepoOwner, m.RepoName, milestoneName, false)
+	if err != nil {
+		return struct{}{}, err
+	}
+	variables := map[string]interface{}{
+		"repoOwner":       githubv4.String(m.RepoOwner),
+		"repoName":        githubv4.String(m.RepoName),
+		"avoidDupSince":   githubv4.DateTime{Time: time.Now().Add(-30 * 24 * time.Hour)},
+		"milestoneNumber": githubv4.String(fmt.Sprint(milestoneNumber)), // For some reason GitHub API v4 uses string type for milestone numbers.
+		"issueCursor":     (*githubv4.String)(nil),
+	}
+	for {
+		var q struct {
+			Repository struct {
+				Issues struct {
+					Nodes    []issue
+					PageInfo struct {
+						EndCursor   githubv4.String
+						HasNextPage bool
+					}
+				} `graphql:"issues(first: 100, after: $issueCursor, filterBy: {states: OPEN, labels: \"early-in-cycle\", milestoneNumber: $milestoneNumber}, orderBy: {field: CREATED_AT, direction: ASC})"`
+			} `graphql:"repository(owner: $repoOwner, name: $repoName)"`
+		}
+		err := gh.V4.Query(ctx, &q, variables)
+		if err != nil {
+			return struct{}{}, err
+		}
+		earlyIssues = append(earlyIssues, q.Repository.Issues.Nodes...)
+		if !q.Repository.Issues.PageInfo.HasNextPage {
+			break
+		}
+		variables["issueCursor"] = githubv4.NewString(q.Repository.Issues.PageInfo.EndCursor)
+	}
+
+	// Ping them.
+	ctx.Printf("Processing %d early-in-cycle issues in %s milestone (milestone number %d).", len(earlyIssues), milestoneName, milestoneNumber)
+EarlyIssuesLoop:
+	for _, i := range earlyIssues {
+		for _, n := range i.TimelineItems.Nodes {
+			if n.IssueComment.Author.Login == "gopherbot" && strings.Contains(n.IssueComment.Body, "friendly reminder") {
+				ctx.Printf("Skipping issue %d, it was already pinged.", i.Number)
+				continue EarlyIssuesLoop
+			}
+		}
+
+		// Post a comment.
+		const dryRun = false
+		if dryRun {
+			ctx.Printf("[dry run] Would've pinged issue %d (%.32s…).", i.Number, i.Title)
+			continue
+		}
+		err := m.Client.PostComment(ctx, i.ID, fmt.Sprintf("This issue is currently labeled as early-in-cycle for Go 1.%d.\n"+
+			"That [time is now](%s), so a friendly reminder to look at it again.", develVersion, openTreeURL))
+		if err != nil {
+			return struct{}{}, err
+		}
+		ctx.Printf("Pinged issue %d (%.32s…).", i.Number, i.Title)
+		time.Sleep(3 * time.Second) // Take a moment between pinging issues to avoid a high rate of addComment mutations.
+	}
+
+	return struct{}{}, nil
+}
+
 // GitHubClientInterface is a wrapper around the GitHub v3 and v4 APIs, for
 // testing and dry-run support.
 type GitHubClientInterface interface {
-	// FetchMilestone returns the number of the requested milestone. If create is true,
-	// and the milestone doesn't exist, it will be created.
+	// FetchMilestone returns the number of the GitHub milestone with the specified name.
+	// If create is true, and the milestone doesn't exist, it will be created.
 	FetchMilestone(ctx context.Context, owner, repo, name string, create bool) (int, error)
 
 	// FetchMilestoneIssues returns all the open issues in the specified milestone
@@ -186,8 +287,12 @@ type GitHubClientInterface interface {
 	// See github.Client.Issues.Edit.
 	EditIssue(ctx context.Context, owner string, repo string, number int, issue *github.IssueRequest) (*github.Issue, *github.Response, error)
 
-	// See github.Client.Issues.EditMilestone
+	// See github.Client.Issues.EditMilestone.
 	EditMilestone(ctx context.Context, owner string, repo string, number int, milestone *github.Milestone) (*github.Milestone, *github.Response, error)
+
+	// PostComment creates a comment on a GitHub issue or pull request
+	// identified by the given GitHub Node ID.
+	PostComment(_ context.Context, id githubv4.ID, body string) error
 }
 
 type GitHubClient struct {
@@ -326,3 +431,14 @@ func (c *GitHubClient) EditIssue(ctx context.Context, owner string, repo string,
 func (c *GitHubClient) EditMilestone(ctx context.Context, owner string, repo string, number int, milestone *github.Milestone) (*github.Milestone, *github.Response, error) {
 	return c.V3.Issues.EditMilestone(ctx, owner, repo, number, milestone)
 }
+
+func (c *GitHubClient) PostComment(ctx context.Context, id githubv4.ID, body string) error {
+	return c.V4.Mutate(ctx, new(struct {
+		AddComment struct {
+			ClientMutationID string // Unused; GraphQL doesn't allow for mutations to return nothing.
+		} `graphql:"addComment(input: $input)"`
+	}), githubv4.AddCommentInput{
+		SubjectID: id,
+		Body:      githubv4.String(body),
+	}, nil)
+}

internal/task/milestones_test.go

@@ -98,6 +98,10 @@ func (fakeGitHub) EditMilestone(_ context.Context, owner string, repo string, nu
 	return nil, nil, nil
 }
 
+func (fakeGitHub) PostComment(_ context.Context, _ githubv4.ID, _ string) error {
+	return fmt.Errorf("pretend that PostComment failed")
+}
+
 var (
 	flagRun   = flag.Bool("run-destructive-milestones-test", false, "Run the milestone test. Requires repository owner and name flags, and GITHUB_TOKEN set in the environment.")
 	flagOwner = flag.String("milestones-github-owner", "", "Owner of testing repository")