Implement new endpoint for fetching contributors data

Author: sahinakkaya

models/contributors/contributors_graph.go

@@ -8,30 +8,15 @@ import (
 	repo_model "code.gitea.io/gitea/models/repo"
 	user_model "code.gitea.io/gitea/models/user"
 	"code.gitea.io/gitea/modules/git"
+	api "code.gitea.io/gitea/modules/structs"
 	util "code.gitea.io/gitea/modules/util"
 )
 
-type WeekData struct {
-	Week      int64 `json:"week"`
-	Additions int   `json:"additions"`
-	Deletions int   `json:"deletions"`
-	Commits   int   `json:"commits"`
-}
-
-// ContributorData represents statistical git commit count data
-type ContributorData struct {
-	Name         string      `json:"name"`
-	Login        string      `json:"login"`
-	AvatarLink   string      `json:"avatar_link"`
-	HomeLink     string      `json:"home_link"`
-	TotalCommits int64       `json:"total_commits"`
-	Weeks        []*WeekData `json:"weeks"`
-}
-
-func CreateWeeks(sundays []int64) []*WeekData {
-	var weeks []*WeekData
+// CreateWeeks converts list of sundays to list of *api.WeekData
+func CreateWeeks(sundays []int64) []*api.WeekData {
+	var weeks []*api.WeekData
 	for _, week := range sundays {
-		weeks = append(weeks, &WeekData{
+		weeks = append(weeks, &api.WeekData{
 			Week:      week,
 			Additions: 0,
 			Deletions: 0,
@@ -42,16 +27,18 @@ func CreateWeeks(sundays []int64) []*WeekData {
 	return weeks
 }
 
-// GetContributorStats returns contributors stats for git commits
-func GetContributorStats(ctx context.Context, repo *repo_model.Repository) (map[string]*ContributorData, error) {
+// GetContributorStats returns contributors stats for git commits for given revision or default branch
+func GetContributorStats(ctx context.Context, repo *repo_model.Repository, revision string) (map[string]*api.ContributorData, error) {
 	gitRepo, closer, err := git.RepositoryFromContextOrOpen(ctx, repo.RepoPath())
 	if err != nil {
 		return nil, fmt.Errorf("OpenRepository: %w", err)
 	}
 	defer closer.Close()
 
-	default_branch, _ := gitRepo.GetDefaultBranch()
-	extended_commit_stats, err := gitRepo.ExtendedCommitStats(default_branch)
+	if len(revision) == 0 {
+		revision = repo.DefaultBranch
+	}
+	extended_commit_stats, err := gitRepo.ExtendedCommitStats(revision)
 	if err != nil {
 		return nil, fmt.Errorf("ExtendedCommitStats: %w", err)
 	}
@@ -65,8 +52,8 @@ func GetContributorStats(ctx context.Context, repo *repo_model.Repository) (map[
 	sundays, _ := util.ListSundaysBetween(starting_sunday, ending_sunday)
 
 	unknownUserAvatarLink := user_model.NewGhostUser().AvatarLink(ctx)
-	contributors_commit_stats := make(map[string]*ContributorData)
-	contributors_commit_stats["Total"] = &ContributorData{
+	contributors_commit_stats := make(map[string]*api.ContributorData)
+	contributors_commit_stats["Total"] = &api.ContributorData{
 		Name:       "Total",
 		AvatarLink: unknownUserAvatarLink,
 		Weeks:      CreateWeeks(sundays),
@@ -80,13 +67,13 @@ func GetContributorStats(ctx context.Context, repo *repo_model.Repository) (map[
 		if _, ok := contributors_commit_stats[v.Author.Email]; !ok {
 			u, err := user_model.GetUserByEmail(ctx, v.Author.Email)
 			if u == nil || user_model.IsErrUserNotExist(err) {
-				contributors_commit_stats[v.Author.Email] = &ContributorData{
+				contributors_commit_stats[v.Author.Email] = &api.ContributorData{
 					Name:       v.Author.Name,
 					AvatarLink: unknownUserAvatarLink,
 					Weeks:      CreateWeeks(sundays),
 				}
 			} else {
-				contributors_commit_stats[v.Author.Email] = &ContributorData{
+				contributors_commit_stats[v.Author.Email] = &api.ContributorData{
 					Name:       u.DisplayName(),
 					Login:      u.LowerName,
 					AvatarLink: u.AvatarLink(ctx),

modules/structs/repo_collaborator.go

@@ -14,3 +14,20 @@ type RepoCollaboratorPermission struct {
 	RoleName   string `json:"role_name"`
 	User       *User  `json:"user"`
 }
+
+type WeekData struct {
+	Week      int64 `json:"week"`
+	Additions int   `json:"additions"`
+	Deletions int   `json:"deletions"`
+	Commits   int   `json:"commits"`
+}
+
+// ContributorData represents statistical git commit count data
+type ContributorData struct {
+	Name         string      `json:"name"`
+	Login        string      `json:"login"`
+	AvatarLink   string      `json:"avatar_link"`
+	HomeLink     string      `json:"home_link"`
+	TotalCommits int64       `json:"total_commits"`
+	Weeks        []*WeekData `json:"weeks"`
+}

routers/api/v1/api.go

@@ -1096,6 +1096,7 @@ func Routes() *web.Route {
 						m.Get("/statuses", repo.GetCommitStatusesByRef)
 					}, context.ReferencesGitRepo())
 				}, reqRepoReader(unit.TypeCode))
+				m.Get("/contributors", context.ReferencesGitRepo(), reqRepoReader(unit.TypeCode), repo.GetAllContributorsStats)
 				m.Group("/git", func() {
 					m.Group("/commits", func() {
 						m.Get("/{sha}", repo.GetSingleCommit)

routers/api/v1/repo/collaborators.go

@@ -9,12 +9,14 @@ import (
 	"net/http"
 
 	"code.gitea.io/gitea/models"
+	contributors_model "code.gitea.io/gitea/models/contributors"
 	"code.gitea.io/gitea/models/perm"
 	access_model "code.gitea.io/gitea/models/perm/access"
 	repo_model "code.gitea.io/gitea/models/repo"
 	user_model "code.gitea.io/gitea/models/user"
 	"code.gitea.io/gitea/modules/context"
 	repo_module "code.gitea.io/gitea/modules/repository"
+	"code.gitea.io/gitea/modules/setting"
 	api "code.gitea.io/gitea/modules/structs"
 	"code.gitea.io/gitea/modules/web"
 	"code.gitea.io/gitea/routers/api/v1/utils"
@@ -349,3 +351,54 @@ func GetAssignees(ctx *context.APIContext) {
 	}
 	ctx.JSON(http.StatusOK, convert.ToUsers(ctx, ctx.Doer, assignees))
 }
+
+// GetAllContributorsStats retrieves a map of contributors along with their weekly commit statistics
+func GetAllContributorsStats(ctx *context.APIContext) {
+	// swagger:operation GET /repos/{owner}/{repo}/contributors repository repoGetAllContributorsStats
+	// ---
+	// summary: Get a map of all contributors along with their weekly commit statistics from a repository
+	// produces:
+	// - application/json
+	// parameters:
+	// - name: owner
+	//   in: path
+	//   description: owner of the repo
+	//   type: string
+	//   required: true
+	// - name: repo
+	//   in: path
+	//   description: name of the repo
+	//   type: string
+	//   required: true
+	// - name: sha
+	//   in: query
+	//   description: SHA or branch to start listing commits from (usually 'master')
+	//   type: string
+	// responses:
+	//   "200":
+	//     "$ref": "#/responses/ContributorDataMap"
+	//   "404":
+	//     "$ref": "#/responses/notFound"
+	//   "409":
+	//     "$ref": "#/responses/EmptyRepository"
+
+	if ctx.Repo.Repository.IsEmpty {
+		ctx.JSON(http.StatusConflict, api.APIError{
+			Message: "Git Repository is empty.",
+			URL:     setting.API.SwaggerURL,
+		})
+		return
+	}
+
+	sha := ctx.FormString("sha")
+
+	if len(sha) == 0 {
+		sha = ctx.Repo.Repository.DefaultBranch
+	}
+
+	if contributor_stats, err := contributors_model.GetContributorStats(ctx, ctx.Repo.Repository, sha); err != nil {
+		ctx.Error(http.StatusInternalServerError, "GetContributorStats", err)
+	} else {
+		ctx.JSON(http.StatusOK, &contributor_stats)
+	}
+}

routers/api/v1/swagger/repo.go

@@ -253,6 +253,11 @@ type swaggerCommitList struct {
 	Body []api.Commit `json:"body"`
 }
 
+type swaggerContributorDataMap struct {
+	// in: body
+	Body map[string]*api.ContributorData `json:"body"`
+}
+
 // ChangedFileList
 // swagger:response ChangedFileList
 type swaggerChangedFileList struct {

routers/web/repo/contributors.go

@@ -26,7 +26,7 @@ func Contributors(ctx *context.Context) {
 
 	ctx.Data["ContributionTypeText"] = ctx.Tr("repo.contributors.contribution_type." + ctx.Data["ContributionType"].(string))
 
-	if contributor_stats, err := contributors_model.GetContributorStats(ctx, ctx.Repo.Repository); err != nil {
+	if contributor_stats, err := contributors_model.GetContributorStats(ctx, ctx.Repo.Repository, ""); err != nil {
 		ctx.ServerError("GetContributorStats", err)
 		return
 	} else {