gha.go

package devstatscode

import (
	"fmt"
	"math"
	"os"
	"regexp"
	"sort"
	"strings"
	"time"
)

// Int64Ary - sortable Int64 array
type Int64Ary []int64

func (a Int64Ary) Len() int           { return len(a) }
func (a Int64Ary) Swap(i, j int)      { a[i], a[j] = a[j], a[i] }
func (a Int64Ary) Less(i, j int) bool { return a[i] < a[j] }

// SkipDatesList holds a list of GHA hours to skip
type SkipDatesList struct {
	Dates []time.Time `yaml:"skip_dates"`
}

// AllProjects contain all projects data
type AllProjects struct {
	Projects map[string]Project `yaml:"projects"`
}

// Project contain mapping from project name to its command line used to sync it
type Project struct {
	CommandLine      []string          `yaml:"command_line"`
	StartDate        *time.Time        `yaml:"start_date"`
	PDB              string            `yaml:"psql_db"`
	Disabled         bool              `yaml:"disabled"`
	MainRepo         string            `yaml:"main_repo"`
	AnnotationRegexp string            `yaml:"annotation_regexp"`
	Order            int               `yaml:"order"`
	JoinDate         *time.Time        `yaml:"join_date"`
	FilesSkipPattern string            `yaml:"files_skip_pattern"`
	Env              map[string]string `yaml:"env"`
	FullName         string            `yaml:"name"`
	Status           string            `yaml:"status"`
	SharedDB         string            `yaml:"shared_db"`
	IncubatingDate   *time.Time        `yaml:"incubating_date"`
	GraduatedDate    *time.Time        `yaml:"graduated_date"`
	ArchivedDate     *time.Time        `yaml:"archived_date"`
	SyncProbability  *float64          `yaml:"sync_probabilty"`
	ProjectScale     *float64          `yaml:"project_scale"`
}

// AnyArray - holds array of interface{} - just a shortcut
type AnyArray []interface{}

// Dummy - structure with no data
// pointer to this struct is used to test if such field was present in JSON or not
type Dummy struct{}

// Event - full GHA (GitHub Archive) event structure
type Event struct {
	ID        string    `json:"id"`
	Type      string    `json:"type"`
	Public    bool      `json:"public"`
	CreatedAt time.Time `json:"created_at"`
	Actor     Actor     `json:"actor"`
	Repo      Repo      `json:"repo"`
	Org       *Org      `json:"org"`
	Payload   Payload   `json:"payload"`
}

// EventOld - full GHA (GitHub Archive) event structure, before 2015
type EventOld struct {
	ID         string      `json:"-"`
	Type       string      `json:"type"`
	Public     bool        `json:"public"`
	CreatedAt  time.Time   `json:"created_at"`
	Actor      string      `json:"actor"`
	Repository ForkeeOld   `json:"repository"`
	Payload    *PayloadOld `json:"payload"`
}

// Payload - GHA Payload structure
type Payload struct {
	PushID       *int         `json:"push_id"`
	Size         *int         `json:"size"`
	Ref          *string      `json:"ref"`
	Head         *string      `json:"head"`
	Before       *string      `json:"before"`
	Action       *string      `json:"action"`
	RefType      *string      `json:"ref_type"`
	MasterBranch *string      `json:"master_branch"`
	Description  *string      `json:"description"`
	Number       *int         `json:"number"`
	Forkee       *Forkee      `json:"forkee"`
	Release      *Release     `json:"release"`
	Member       *Actor       `json:"member"`
	Issue        *Issue       `json:"issue"`
	Comment      *Comment     `json:"comment"`
	Review       *Review      `json:"review"`
	Commits      *[]Commit    `json:"commits"`
	Pages        *[]Page      `json:"pages"`
	PullRequest  *PullRequest `json:"pull_request"`
}

// PayloadOld - GHA Payload structure (from before 2015)
type PayloadOld struct {
	Issue        *int           `json:"issue"`
	IssueID      *int           `json:"issue_id"`
	Comment      *Comment       `json:"comment"`
	CommentID    *int           `json:"comment_id"`
	Description  *string        `json:"description"`
	MasterBranch *string        `json:"master_branch"`
	Ref          *string        `json:"ref"`
	Action       *string        `json:"action"`
	RefType      *string        `json:"ref_type"`
	Head         *string        `json:"head"`
	Size         *int           `json:"size"`
	Number       *int           `json:"number"`
	PullRequest  *PullRequest   `json:"pull_request"`
	Member       *Actor         `json:"member"`
	Release      *Release       `json:"release"`
	Pages        *[]Page        `json:"pages"`
	Commit       *string        `json:"commit"`
	SHAs         *[]interface{} `json:"shas"`
	Repository   *Forkee        `json:"repository"`
	Team         *Team          `json:"team"`
}

// ForkeeOld - GHA Forkee structure (from before 2015)
// Handle missing 4 last properties (including two non-nulls!)
type ForkeeOld struct {
	ID            int        `json:"id"`
	CreatedAt     time.Time  `json:"created_at"`
	Description   *string    `json:"description"`
	Fork          bool       `json:"fork"`
	Forks         int        `json:"forks"`
	HasDownloads  bool       `json:"has_downloads"`
	HasIssues     bool       `json:"has_issues"`
	HasWiki       bool       `json:"has_wiki"`
	Homepage      *string    `json:"homepage"`
	Language      *string    `json:"language"`
	DefaultBranch string     `json:"master_branch"`
	Name          string     `json:"name"`
	OpenIssues    int        `json:"open_issues"`
	Organization  *string    `json:"organization"`
	Owner         string     `json:"owner"`
	Private       *bool      `json:"private"`
	PushedAt      *time.Time `json:"pushed_at"`
	Size          int        `json:"size"`
	Stargazers    int        `json:"stargazers"`
	Watchers      int        `json:"watchers"`
}

// Repo - GHA Repo structure
type Repo struct {
	ID   int    `json:"id"`
	Name string `json:"name"`
}

// Actor - GHA Actor structure
// Name is unexported and not used by JSON load/save
// But is used when importing affiliations from cncf/gitdm:github_users.json
type Actor struct {
	ID    int    `json:"id"`
	Login string `json:"login"`
	Name  string `json:"-"`
}

// Org - GHA Org structure
type Org struct {
	ID    int    `json:"id"`
	Login string `json:"login"`
}

// Forkee - GHA Forkee structure
type Forkee struct {
	ID              int        `json:"id"`
	Name            string     `json:"name"`
	FullName        string     `json:"full_name"`
	Owner           Actor      `json:"owner"`
	Description     *string    `json:"description"`
	Public          *bool      `json:"public"`
	Fork            bool       `json:"fork"`
	CreatedAt       time.Time  `json:"created_at"`
	UpdatedAt       time.Time  `json:"updated_at"`
	PushedAt        *time.Time `json:"pushed_at"`
	Homepage        *string    `json:"homepage"`
	Size            int        `json:"size"`
	StargazersCount int        `json:"stargazers_count"`
	HasIssues       bool       `json:"has_issues"`
	HasProjects     *bool      `json:"has_projects"`
	HasDownloads    bool       `json:"has_downloads"`
	HasWiki         bool       `json:"has_wiki"`
	HasPages        *bool      `json:"has_pages"`
	Forks           int        `json:"forks"`
	OpenIssues      int        `json:"open_issues"`
	Watchers        int        `json:"watchers"`
	DefaultBranch   string     `json:"default_branch"`
}

// Release - GHA Release structure
type Release struct {
	ID              int        `json:"id"`
	TagName         string     `json:"tag_name"`
	TargetCommitish string     `json:"target_commitish"`
	Name            *string    `json:"name"`
	Draft           bool       `json:"draft"`
	Author          Actor      `json:"author"`
	Prerelease      bool       `json:"prerelease"`
	CreatedAt       time.Time  `json:"created_at"`
	PublishedAt     *time.Time `json:"published_at"`
	Body            *string    `json:"body"`
	Assets          []Asset    `json:"assets"`
}

// Asset - GHA Asset structure
type Asset struct {
	ID            int       `json:"id"`
	CreatedAt     time.Time `json:"created_at"`
	UpdatedAt     time.Time `json:"updated_at"`
	Name          string    `json:"name"`
	Label         *string   `json:"label"`
	Uploader      Actor     `json:"uploader"`
	ContentType   string    `json:"content_type"`
	State         string    `json:"state"`
	Size          int       `json:"size"`
	DownloadCount int       `json:"download_count"`
}

// PullRequest - GHA Pull Request structure
type PullRequest struct {
	ID                  int        `json:"id"`
	Base                Branch     `json:"base"`
	Head                Branch     `json:"head"`
	User                Actor      `json:"user"`
	Number              int        `json:"number"`
	State               string     `json:"state"`
	Locked              *bool      `json:"locked"`
	Title               string     `json:"title"`
	Body                *string    `json:"body"`
	CreatedAt           time.Time  `json:"created_at"`
	UpdatedAt           time.Time  `json:"updated_at"`
	ClosedAt            *time.Time `json:"closed_at"`
	MergedAt            *time.Time `json:"merged_at"`
	MergeCommitSHA      *string    `json:"merge_commit_sha"`
	Assignee            *Actor     `json:"assignee"`
	Assignees           *[]Actor   `json:"assignees"`
	RequestedReviewers  *[]Actor   `json:"requested_reviewers"`
	Milestone           *Milestone `json:"milestone"`
	Merged              *bool      `json:"merged"`
	Mergeable           *bool      `json:"mergeable"`
	MergedBy            *Actor     `json:"merged_by"`
	MergeableState      *string    `json:"mergeable_state"`
	Rebaseable          *bool      `json:"rebaseable"`
	Comments            *int       `json:"comments"`
	ReviewComments      *int       `json:"review_comments"`
	MaintainerCanModify *bool      `json:"maintainer_can_modify"`
	Commits             *int       `json:"commits"`
	Additions           *int       `json:"additions"`
	Deletions           *int       `json:"deletions"`
	ChangedFiles        *int       `json:"changed_files"`
}

// Branch - GHA Branch structure
type Branch struct {
	SHA   string  `json:"sha"`
	User  *Actor  `json:"user"`
	Repo  *Forkee `json:"repo"` // This is confusing, but actually GHA has "repo" fields that holds "forkee" structure
	Label string  `json:"label"`
	Ref   string  `json:"ref"`
}

// Issue - GHA Issue structure
type Issue struct {
	ID          int        `json:"id"`
	Number      int        `json:"number"`
	Comments    int        `json:"comments"`
	Title       string     `json:"title"`
	State       string     `json:"state"`
	Locked      bool       `json:"locked"`
	Body        *string    `json:"body"`
	User        Actor      `json:"user"`
	Assignee    *Actor     `json:"assignee"`
	Labels      []Label    `json:"labels"`
	Assignees   []Actor    `json:"assignees"`
	Milestone   *Milestone `json:"milestone"`
	CreatedAt   time.Time  `json:"created_at"`
	UpdatedAt   time.Time  `json:"updated_at"`
	ClosedAt    *time.Time `json:"closed_at"`
	PullRequest *Dummy     `json:"pull_request"`
}

// Label - GHA Label structure
type Label struct {
	ID      *int   `json:"id"`
	Name    string `json:"name"`
	Color   string `json:"color"`
	Default *bool  `json:"default"`
}

// Milestone - GHA Milestone structure
type Milestone struct {
	ID           int        `json:"id"`
	Name         string     `json:"name"`
	Number       int        `json:"number"`
	Title        string     `json:"title"`
	Description  *string    `json:"description"`
	Creator      *Actor     `json:"creator"`
	OpenIssues   int        `json:"open_issues"`
	ClosedIssues int        `json:"closed_issues"`
	State        string     `json:"state"`
	CreatedAt    time.Time  `json:"created_at"`
	UpdatedAt    time.Time  `json:"updated_at"`
	ClosedAt     *time.Time `json:"closed_at"`
	DueOn        *time.Time `json:"due_on"`
}

// Comment - GHA Comment structure
type Comment struct {
	ID                  int       `json:"id"`
	Body                string    `json:"body"`
	CreatedAt           time.Time `json:"created_at"`
	UpdatedAt           time.Time `json:"updated_at"`
	User                Actor     `json:"user"`
	CommitID            *string   `json:"commit_id"`
	OriginalCommitID    *string   `json:"original_commit_id"`
	DiffHunk            *string   `json:"diff_hunk"`
	Position            *int      `json:"position"`
	OriginalPosition    *int      `json:"original_position"`
	Path                *string   `json:"path"`
	PullRequestReviewID *int      `json:"pull_request_review_id"`
	Line                *int      `json:"line"`
}

// Review - GHA Review structure
type Review struct {
	ID                int       `json:"id"`
	User              Actor     `json:"user"`
	CommitID          string    `json:"commit_id"`
	SubmittedAt       time.Time `json:"submitted_at"`
	AuthorAssociation string    `json:"author_association"`
	State             string    `json:"state"`
	Body              *string   `json:"body"`
}

// Commit - GHA Commit structure
type Commit struct {
	SHA      string `json:"sha"`
	Author   Author `json:"author"`
	Message  string `json:"message"`
	Distinct bool   `json:"distinct"`
}

// Author - GHA Commit Author structure
type Author struct {
	Name  string `json:"name"`
	Email string `json:"email"`
}

// Page - GHA Page structure
type Page struct {
	SHA    string `json:"sha"`
	Action string `json:"action"`
	Title  string `json:"title"`
}

// Team - GHA Team structure (only used before 2015)
type Team struct {
	ID         int    `json:"id"`
	Name       string `json:"name"`
	Slug       string `json:"slug"`
	Permission string `json:"permission"`
}

// MakeUniqueSort - make string array unique & sorted
func MakeUniqueSort(ary []string) (outAry []string) {
	vals := make(map[string]struct{})
	for _, val := range ary {
		vals[val] = struct{}{}
	}
	for val := range vals {
		outAry = append(outAry, val)
	}
	sort.Strings(outAry)
	return
}

// ExcludedForProject - checks if metric defines project, if so then:
// if metric's project is XYZ and current project is XYZ then calculate this metric
// if metric's project is !XYZ and current project is *not* XYZ then calculate this metric
func ExcludedForProject(currentProject, metricProjects string) bool {
	if metricProjects == "" || currentProject == "" {
		return false
	}
	excludeMode := false
	if metricProjects[:1] == "!" {
		excludeMode = true
		metricProjects = metricProjects[1:]
	}
	metricProjectsAry := strings.Split(metricProjects, ",")
	for _, metricProject := range metricProjectsAry {
		if excludeMode {
			if currentProject == metricProject {
				return true
			}
			continue
		}
		if currentProject == metricProject {
			return false
		}
	}
	return !excludeMode
}

// GetProjectsList return list of projects to process
// It sorts them according to projects.yaml order
// Handles disabled/enabled projects
// Handles ONLY="project1 project2 ... projectN" env
func GetProjectsList(ctx *Ctx, projects *AllProjects) (names []string, projs []Project) {
	if projects == nil {
		Fatalf("GetProjectsList: projects is nil")
	}
	// Order projects
	orders := []int{}
	projectsMap := make(map[int]string)

	// Handle disabled/enabled
	for name, proj := range projects.Projects {
		if IsProjectDisabled(ctx, name, proj.Disabled) {
			continue
		}
		orders = append(orders, proj.Order)
		projectsMap[proj.Order] = name
	}
	sort.Ints(orders)

	// Support ONLY="proj1 proj2 ... projN"
	only := make(map[string]struct{})
	onlyS := os.Getenv("ONLY")
	bOnly := false
	if onlyS != "" {
		onlyA := strings.Split(onlyS, " ")
		for _, item := range onlyA {
			if item == "" {
				continue
			}
			only[item] = struct{}{}
		}
		bOnly = true
	}

	// Order + ONLY
	for _, order := range orders {
		name := projectsMap[order]
		if bOnly {
			_, ok := only[name]
			if !ok {
				continue
			}
		}
		proj := projects.Projects[name]
		names = append(names, name)
		projs = append(projs, proj)
	}
	return
}

// IsProjectDisabled - checks if project is disabled or not:
// fullName comes from makeOldRepoName for pre-2015 data!
// yamlDisabled (this is from projects.yaml - can be true or false)
// it also checks context (which can override `disabled: true` from projects.yaml)
// +pro1,-pro2 creates map {"pro1":true, "pro2":false}
func IsProjectDisabled(ctx *Ctx, proj string, yamlDisabled bool) bool {
	override, ok := ctx.ProjectsOverride[proj]
	// No override for this project - just return YAML property value
	if !ok {
		return yamlDisabled
	}
	// If project override present then true means NOT disabled, and false means disabled
	return !override
}

// MakeOldRepoName - before 2015 repository name should be Organization/Name (if Organization present) or just Name
func MakeOldRepoName(repo *ForkeeOld) string {
	if repo.Organization == nil || *repo.Organization == "" {
		return repo.Name
	}
	// FIXME: what if repo.NAME == "" --> "kubernetes/"
	return fmt.Sprintf("%s/%s", *repo.Organization, repo.Name)
}

// ActorHit - are we intereste din this actor?
func ActorHit(ctx *Ctx, actorName string) bool {
	if !ctx.ActorsFilter {
		return true
	}
	if (ctx.ActorsAllow == nil || (ctx.ActorsAllow != nil && ctx.ActorsAllow.MatchString(actorName))) &&
		(ctx.ActorsForbid == nil || (ctx.ActorsForbid != nil && !ctx.ActorsForbid.MatchString(actorName))) {
		return true
	}
	return false
}

// RepoHit - are we interested in this org/repo ?
func RepoHit(ctx *Ctx, fullName string, forg, frepo map[string]struct{}, orgRE, repoRE *regexp.Regexp) bool {
	// Return false if no repo name
	if fullName == "" {
		return false
	}
	// If given repo full name is in the exclude list, signal no hit
	_, ok := ctx.ExcludeRepos[fullName]
	if ok {
		return false
	}
	exact := ctx.Exact
	// If repo name in old format (no org name) then assume org = ""
	res := strings.Split(fullName, "/")
	org, repo := "", res[0]
	// New repo name format org/repo
	if len(res) > 1 {
		org, repo = res[0], res[1]
	}
	// Now check for full name hit in org (one can provide full repo name org/repo)
	if orgRE != nil {
		ok = orgRE.MatchString(fullName)
	} else {
		_, ok = forg[fullName]
	}
	// If we hit then we can have two cases
	// We hit a full name with "/" - this is a direct hit, return true
	// We hit old repo name format but special flag GHA2DB_EXACT is used
	// Only return hit when this flag is set
	if ok && (exact || len(res) > 1) {
		return ok
	}
	// Now if org list given and different org, return false
	if orgRE != nil && !orgRE.MatchString(org) {
		return false
	}
	if len(forg) > 0 {
		_, ok = forg[org]
		if !ok {
			return false
		}
	}
	// Now if repo list given and different repo, return false
	if repoRE != nil && !repoRE.MatchString(repo) {
		return false
	}
	if len(frepo) > 0 {
		_, ok = frepo[repo]
		if !ok {
			return false
		}
	}
	// Either org matches given list or no org given
	// and repo name matches given or no repo given
	// Check all test cases in gha_test.go: TestRepoHit()
	return true
}

// OrgIDOrNil - return Org ID from pointer or nil
func OrgIDOrNil(orgPtr *Org) interface{} {
	if orgPtr == nil {
		return nil
	}
	return orgPtr.ID
}

// OrgLoginOrNil - return Org ID from pointer or nil
func OrgLoginOrNil(orgPtr *Org) interface{} {
	if orgPtr == nil {
		return nil
	}
	return orgPtr.Login
}

// RepoIDOrNil - return Repo ID from pointer or nil
func RepoIDOrNil(repoPtr *Repo) interface{} {
	if repoPtr == nil {
		return nil
	}
	return repoPtr.ID
}

// RepoNameOrNil - return Repo Name from pointer or nil
func RepoNameOrNil(repoPtr *Repo) interface{} {
	if repoPtr == nil {
		return nil
	}
	return repoPtr.Name
}

// IssueIDOrNil - return Issue ID from pointer or nil
func IssueIDOrNil(issuePtr *Issue) interface{} {
	if issuePtr == nil {
		return nil
	}
	return issuePtr.ID
}

// PullRequestIDOrNil - return PullRequest ID from pointer or nil
func PullRequestIDOrNil(prPtr *PullRequest) interface{} {
	if prPtr == nil {
		return nil
	}
	return prPtr.ID
}

// CommentIDOrNil - return Comment ID from pointer or nil
func CommentIDOrNil(commPtr *Comment) interface{} {
	if commPtr == nil {
		return nil
	}
	return commPtr.ID
}

// ForkeeIDOrNil - return Forkee ID from pointer or nil
func ForkeeIDOrNil(forkPtr *Forkee) interface{} {
	if forkPtr == nil {
		return nil
	}
	return forkPtr.ID
}

// ForkeeOldIDOrNil - return ForkeeOld ID from pointer or nil
func ForkeeOldIDOrNil(forkPtr *ForkeeOld) interface{} {
	if forkPtr == nil {
		return nil
	}
	return forkPtr.ID
}

// ForkeeNameOrNil - return Forkee Name from pointer or nil
func ForkeeNameOrNil(forkPtr *Forkee) interface{} {
	if forkPtr == nil {
		return nil
	}
	return forkPtr.Name
}

// ActorIDOrNil - return Actor ID from pointer or nil
func ActorIDOrNil(actPtr *Actor) interface{} {
	if actPtr == nil {
		return nil
	}
	return actPtr.ID
}

// ActorLoginOrNil - return Actor Login from pointer or nil
func ActorLoginOrNil(actPtr *Actor, maybeHide func(string) string) interface{} {
	if actPtr == nil {
		return nil
	}
	return maybeHide(actPtr.Login)
}

// ReleaseIDOrNil - return Release ID from pointer or nil
func ReleaseIDOrNil(relPtr *Release) interface{} {
	if relPtr == nil {
		return nil
	}
	return relPtr.ID
}

// MilestoneIDOrNil - return Milestone ID from pointer or nil
func MilestoneIDOrNil(milPtr *Milestone) interface{} {
	if milPtr == nil {
		return nil
	}
	return milPtr.ID
}

// CompareStringPtr - compares two string pointers
// returns true if both pointers are null or both are non null and point to strings with the same content
func CompareStringPtr(p1, p2 *string) bool {
	if p1 == nil && p2 == nil {
		return true
	}
	if (p1 == nil && p2 != nil) || (p1 != nil && p2 == nil) {
		return false
	}
	s1 := *p1
	s2 := *p2
	return s1 == s2
}

// CompareIntPtr - compares two int pointers
// returns true if both pointers are null or both are non null and point to integers with the same value
func CompareIntPtr(p1, p2 *int) bool {
	if p1 == nil && p2 == nil {
		return true
	}
	if (p1 == nil && p2 != nil) || (p1 != nil && p2 == nil) {
		return false
	}
	i1 := *p1
	i2 := *p2
	return i1 == i2
}

// CompareFloat64Ptr - compares two string pointers
// returns true if both pointers are null or both are non null and point to floats with the same value (with epsilon)
func CompareFloat64Ptr(p1, p2 *float64) bool {
	if p1 == nil && p2 == nil {
		return true
	}
	if (p1 == nil && p2 != nil) || (p1 != nil && p2 == nil) {
		return false
	}
	f1 := *p1
	f2 := *p2
	return math.Abs(f1-f2) < 1e-10
}