releaser-pleaser/forge.go

package rp

import (
	"context"
	"errors"
	"fmt"
	"log/slog"
	"os"
	"strings"

	"github.com/blang/semver/v4"
	"github.com/go-git/go-git/v5/plumbing/transport"
	"github.com/go-git/go-git/v5/plumbing/transport/http"
	"github.com/google/go-github/v63/github"
)

const (
	GitHubPerPageMax  = 100
	GitHubPRStateOpen = "open"
	GitHubEnvAPIToken = "GITHUB_TOKEN"
	GitHubEnvUsername = "GITHUB_USER"
)

type Changeset struct {
	URL              string
	Identifier       string
	ChangelogEntries []AnalyzedCommit
}

type Forge interface {
	RepoURL() string
	CloneURL() string
	ReleaseURL(version string) string

	GitAuth() transport.AuthMethod

	// LatestTags returns the last stable tag created on the main branch. If there is a more recent pre-release tag,
	// that is also returned. If no tag is found, it returns nil.
	LatestTags(context.Context) (Releases, error)

	// CommitsSince returns all commits to main branch after the Tag. The tag can be `nil`, in which case this
	// function should return all commits.
	CommitsSince(context.Context, *Tag) ([]Commit, error)

	// Changesets looks up the Pull/Merge Requests for each commit, returning its parsed metadata.
	Changesets(context.Context, []Commit) ([]Changeset, error)

	// PullRequestForBranch returns the open pull request between the branch and ForgeOptions.BaseBranch. If no open PR
	// exists, it returns nil.
	PullRequestForBranch(context.Context, string) (*ReleasePullRequest, error)

	CreatePullRequest(context.Context, *ReleasePullRequest) (*ReleasePullRequest, error)
}

type ForgeOptions struct {
	Repository string
	BaseBranch string
}

var _ Forge = &GitHub{}

// var _ Forge = &GitLab{}

type GitHub struct {
	options *GitHubOptions

	client *github.Client
	log    *slog.Logger
}

func (g *GitHub) RepoURL() string {
	return fmt.Sprintf("https://github.com/%s/%s", g.options.Owner, g.options.Repo)
}

func (g *GitHub) CloneURL() string {
	return fmt.Sprintf("https://github.com/%s/%s.git", g.options.Owner, g.options.Repo)
}

func (g *GitHub) ReleaseURL(version string) string {
	return fmt.Sprintf("https://github.com/%s/%s/releases/tag/%s", g.options.Owner, g.options.Repo, version)
}

func (g *GitHub) GitAuth() transport.AuthMethod {
	return &http.BasicAuth{
		Username: g.options.Username,
		Password: g.options.APIToken,
	}
}

func (g *GitHub) LatestTags(ctx context.Context) (Releases, error) {
	g.log.DebugContext(ctx, "listing all tags in github repository")

	page := 1

	var releases Releases

	for {
		tags, resp, err := g.client.Repositories.ListTags(
			ctx, g.options.Owner, g.options.Repo,
			&github.ListOptions{Page: page, PerPage: GitHubPerPageMax},
		)
		if err != nil {
			return Releases{}, err
		}

		for _, ghTag := range tags {
			tag := &Tag{
				Hash: ghTag.GetCommit().GetSHA(),
				Name: ghTag.GetName(),
			}

			version, err := semver.Parse(strings.TrimPrefix(tag.Name, "v"))
			if err != nil {
				g.log.WarnContext(
					ctx, "unable to parse tag as semver, skipping",
					"tag.name", tag.Name,
					"tag.hash", tag.Hash,
					"error", err,
				)
				continue
			}

			if releases.Latest == nil {
				releases.Latest = tag
			}
			if len(version.Pre) == 0 {
				// Stable version tag
				// We return once we have found the latest stable tag, not needed to look at every single tag.
				releases.Stable = tag
				break
			}
		}

		if page == resp.LastPage || resp.LastPage == 0 {
			break
		}

		page = resp.NextPage
	}

	return releases, nil
}

func (g *GitHub) CommitsSince(ctx context.Context, tag *Tag) ([]Commit, error) {
	var repositoryCommits []*github.RepositoryCommit
	var err error
	if tag != nil {
		repositoryCommits, err = g.commitsSinceTag(ctx, tag)
	} else {
		repositoryCommits, err = g.commitsSinceInit(ctx)
	}

	if err != nil {
		return nil, err
	}

	var commits = make([]Commit, 0, len(repositoryCommits))
	for _, ghCommit := range repositoryCommits {
		commits = append(commits, Commit{
			Hash:    ghCommit.GetSHA(),
			Message: ghCommit.GetCommit().GetMessage(),
		})
	}

	return commits, nil
}

func (g *GitHub) commitsSinceTag(ctx context.Context, tag *Tag) ([]*github.RepositoryCommit, error) {
	head := g.options.BaseBranch
	log := g.log.With("base", tag.Hash, "head", head)
	log.Debug("comparing commits", "base", tag.Hash, "head", head)

	page := 1

	var repositoryCommits []*github.RepositoryCommit
	for {
		log.Debug("fetching page", "page", page)
		comparison, resp, err := g.client.Repositories.CompareCommits(
			ctx, g.options.Owner, g.options.Repo,
			tag.Hash, head, &github.ListOptions{
				Page:    page,
				PerPage: GitHubPerPageMax,
			})
		if err != nil {
			return nil, err
		}

		if repositoryCommits == nil {
			// Pre-initialize slice on first request
			log.Debug("found commits", "length", comparison.GetTotalCommits())
			repositoryCommits = make([]*github.RepositoryCommit, 0, comparison.GetTotalCommits())
		}

		repositoryCommits = append(repositoryCommits, comparison.Commits...)

		if page == resp.LastPage || resp.LastPage == 0 {
			break
		}

		page = resp.NextPage
	}

	return repositoryCommits, nil
}

func (g *GitHub) commitsSinceInit(ctx context.Context) ([]*github.RepositoryCommit, error) {
	head := g.options.BaseBranch
	log := g.log.With("head", head)
	log.Debug("listing all commits")

	page := 1

	var repositoryCommits []*github.RepositoryCommit
	for {
		log.Debug("fetching page", "page", page)
		commits, resp, err := g.client.Repositories.ListCommits(
			ctx, g.options.Owner, g.options.Repo,
			&github.CommitsListOptions{
				SHA: head,
				ListOptions: github.ListOptions{
					Page:    page,
					PerPage: GitHubPerPageMax,
				},
			})
		if err != nil {
			return nil, err
		}

		if repositoryCommits == nil && resp.LastPage > 0 {
			// Pre-initialize slice on first request
			log.Debug("found commits", "pages", resp.LastPage)
			repositoryCommits = make([]*github.RepositoryCommit, 0, resp.LastPage*GitHubPerPageMax)
		}

		repositoryCommits = append(repositoryCommits, commits...)

		if page == resp.LastPage || resp.LastPage == 0 {
			break
		}

		page = resp.NextPage
	}

	return repositoryCommits, nil
}

func (g *GitHub) Changesets(ctx context.Context, commits []Commit) ([]Changeset, error) {
	// We naively look up the associated PR for each commit through the "List pull requests associated with a commit"
	// endpoint. This requires len(commits) requests.
	// Using the "List pull requests" endpoint might be faster, as it allows us to fetch 100 arbitrary PRs per request,
	// but worst case we need to look up all PRs made in the repository ever.

	changesets := make([]Changeset, 0, len(commits))

	for _, commit := range commits {
		log := g.log.With("commit.hash", commit.Hash)
		page := 1
		var associatedPRs []*github.PullRequest

		for {
			log.Debug("fetching pull requests associated with commit", "page", page)
			prs, resp, err := g.client.PullRequests.ListPullRequestsWithCommit(
				ctx, g.options.Owner, g.options.Repo,
				commit.Hash, &github.ListOptions{
					Page:    page,
					PerPage: GitHubPerPageMax,
				})
			if err != nil {
				return nil, err
			}

			associatedPRs = append(associatedPRs, prs...)

			if page == resp.LastPage || resp.LastPage == 0 {
				break
			}
			page = resp.NextPage
		}

		var pullrequest *github.PullRequest
		for _, pr := range associatedPRs {
			// We only look for the PR that has this commit set as the "merge commit" => The result of squashing this branch onto main
			if pr.GetMergeCommitSHA() == commit.Hash {
				pullrequest = pr
				break
			}
		}
		if pullrequest == nil {
			log.Warn("did not find associated pull request, not considering it for changesets")
			// No pull request was found for this commit, nothing to do here
			// TODO: We could also return the minimal changeset for this commit, so at least it would come up in the changelog.
			continue
		}

		log = log.With("pullrequest.id", pullrequest.GetID())

		// TODO: Parse PR description for overrides
		changelogEntries, _, err := AnalyzeCommits([]Commit{commit})
		if err != nil {
			log.Warn("unable to parse changelog entries", "error", err)
			continue
		}

		if len(changelogEntries) > 0 {
			changesets = append(changesets, Changeset{
				URL:              pullrequest.GetHTMLURL(),
				Identifier:       fmt.Sprintf("#%d", pullrequest.GetNumber()),
				ChangelogEntries: changelogEntries,
			})
		}
	}

	return changesets, nil
}

func (g *GitHub) PullRequestForBranch(ctx context.Context, branch string) (*ReleasePullRequest, error) {
	page := 1

	for {
		prs, resp, err := g.client.PullRequests.ListPullRequestsWithCommit(ctx, g.options.Owner, g.options.Repo, branch, &github.ListOptions{
			Page:    page,
			PerPage: GitHubPerPageMax,
		})
		if err != nil {
			var ghErr *github.ErrorResponse
			if errors.As(err, &ghErr) {
				if ghErr.Message == fmt.Sprintf("No commit found for SHA: %s", branch) {
					return nil, nil
				}
			}
			return nil, err
		}

		for _, pr := range prs {
			if pr.GetBase().GetLabel() == g.options.BaseBranch && pr.GetHead().GetLabel() == branch && pr.GetState() == GitHubPRStateOpen {
				labels := make([]string, 0, len(pr.Labels))
				for _, label := range pr.Labels {
					labels = append(labels, label.GetName())
				}

				return &ReleasePullRequest{
					ID:          pr.GetNumber(),
					Title:       pr.GetTitle(),
					Description: pr.GetBody(),
					Labels:      labels,
					Head:        pr.GetHead().GetLabel(),
				}, nil
			}
		}

		if page == resp.LastPage || resp.LastPage == 0 {
			break
		}
		page = resp.NextPage
	}

	return nil, nil
}

func (g *GitHub) CreatePullRequest(ctx context.Context, pr *ReleasePullRequest) (*ReleasePullRequest, error) {
	ghPR, _, err := g.client.PullRequests.Create(
		ctx, g.options.Owner, g.options.Repo,
		&github.NewPullRequest{
			Title: &pr.Title,
			Head:  &pr.Head,
			Base:  &g.options.BaseBranch,
			Body:  &pr.Description,
		},
	)
	if err != nil {
		return nil, err
	}

	pr.ID = int(*ghPR.ID) // TODO: String ID?

	return pr, nil
}

func (g *GitHubOptions) autodiscover() {
	if apiToken := os.Getenv(GitHubEnvAPIToken); apiToken != "" {
		g.APIToken = apiToken
	}
	// TODO: Check if there is a better solution for cloning/pushing locally
	if username := os.Getenv(GitHubEnvUsername); username != "" {
		g.Username = username
	}
	// TODO: Read settings from GitHub Actions env vars
}

type GitHubOptions struct {
	ForgeOptions

	Owner string
	Repo  string

	APIToken string
	Username string
}

func NewGitHub(log *slog.Logger, options *GitHubOptions) *GitHub {
	options.autodiscover()

	client := github.NewClient(nil)
	if options.APIToken != "" {
		client = client.WithAuthToken(options.APIToken)
	}

	gh := &GitHub{
		options: options,

		client: client,
		log:    log.With("forge", "github"),
	}

	return gh
}

type GitLab struct {
	options ForgeOptions
}

func (g *GitLab) autodiscover() {
	// Read settings from GitLab-CI env vars
}

func NewGitLab(options ForgeOptions) *GitLab {
	gl := &GitLab{
		options: options,
	}

	gl.autodiscover()

	return gl
}

func (g *GitLab) RepoURL() string {
	return fmt.Sprintf("https://gitlab.com/%s", g.options.Repository)
}