[API] generalize list header (#16551)

* Add info about list endpoints to CONTRIBUTING.md

* Let all list endpoints return X-Total-Count header 

* Add TODOs for GetCombinedCommitStatusByRef

* Fix models/issue_stopwatch.go

* Rrefactor models.ListDeployKeys

* Introduce helper func and use them for SetLinkHeader related func

modules/context/api.go

@@ -181,6 +181,23 @@ func (ctx *APIContext) SetLinkHeader(total, pageSize int) {
 
 	if len(links) > 0 {
 		ctx.Header().Set("Link", strings.Join(links, ","))
+		ctx.AppendAccessControlExposeHeaders("Link")
+	}
+}
+
+// SetTotalCountHeader set "X-Total-Count" header
+func (ctx *APIContext) SetTotalCountHeader(total int64) {
+	ctx.Header().Set("X-Total-Count", fmt.Sprint(total))
+	ctx.AppendAccessControlExposeHeaders("X-Total-Count")
+}
+
+// AppendAccessControlExposeHeaders append headers by name to "Access-Control-Expose-Headers" header
+func (ctx *APIContext) AppendAccessControlExposeHeaders(names ...string) {
+	val := ctx.Header().Get("Access-Control-Expose-Headers")
+	if len(val) != 0 {
+		ctx.Header().Set("Access-Control-Expose-Headers", fmt.Sprintf("%s, %s", val, strings.Join(names, ", ")))
+	} else {
+		ctx.Header().Set("Access-Control-Expose-Headers", strings.Join(names, ", "))
 	}
 }
 

modules/context/org.go

@@ -123,8 +123,8 @@ func HandleOrgAssignment(ctx *Context, args ...bool) {
 	// Team.
 	if ctx.Org.IsMember {
 		if ctx.Org.IsOwner {
-			if err := org.GetTeams(&models.SearchTeamOptions{}); err != nil {
-				ctx.ServerError("GetTeams", err)
+			if err := org.LoadTeams(); err != nil {
+				ctx.ServerError("LoadTeams", err)
 				return
 			}
 		} else {

modules/git/repo_tag.go

@@ -10,6 +10,7 @@ import (
 	"strings"
 
 	"code.gitea.io/gitea/modules/log"
+	"code.gitea.io/gitea/modules/util"
 )
 
 // TagPrefix tags prefix path on the repository
@@ -160,24 +161,18 @@ func (repo *Repository) GetTag(name string) (*Tag, error) {
 }
 
 // GetTagInfos returns all tag infos of the repository.
-func (repo *Repository) GetTagInfos(page, pageSize int) ([]*Tag, error) {
+func (repo *Repository) GetTagInfos(page, pageSize int) ([]*Tag, int, error) {
 	// TODO this a slow implementation, makes one git command per tag
 	stdout, err := NewCommand("tag").RunInDir(repo.Path)
 	if err != nil {
-		return nil, err
+		return nil, 0, err
 	}
 
 	tagNames := strings.Split(strings.TrimRight(stdout, "\n"), "\n")
+	tagsTotal := len(tagNames)
 
 	if page != 0 {
-		skip := (page - 1) * pageSize
-		if skip >= len(tagNames) {
-			return nil, nil
-		}
-		if (len(tagNames) - skip) < pageSize {
-			pageSize = len(tagNames) - skip
-		}
-		tagNames = tagNames[skip : skip+pageSize]
+		tagNames = util.PaginateSlice(tagNames, page, pageSize).([]string)
 	}
 
 	var tags = make([]*Tag, 0, len(tagNames))
@@ -189,13 +184,13 @@ func (repo *Repository) GetTagInfos(page, pageSize int) ([]*Tag, error) {
 
 		tag, err := repo.GetTag(tagName)
 		if err != nil {
-			return nil, err
+			return nil, tagsTotal, err
 		}
 		tag.Name = tagName
 		tags = append(tags, tag)
 	}
 	sortTagsByTime(tags)
-	return tags, nil
+	return tags, tagsTotal, nil
 }
 
 // GetTagType gets the type of the tag, either commit (simple) or tag (annotated)

modules/git/repo_tag_test.go

@@ -18,9 +18,10 @@ func TestRepository_GetTags(t *testing.T) {
 	assert.NoError(t, err)
 	defer bareRepo1.Close()
 
-	tags, err := bareRepo1.GetTagInfos(0, 0)
+	tags, total, err := bareRepo1.GetTagInfos(0, 0)
 	assert.NoError(t, err)
 	assert.Len(t, tags, 1)
+	assert.Equal(t, len(tags), total)
 	assert.EqualValues(t, "test", tags[0].Name)
 	assert.EqualValues(t, "3ad28a9149a2864384548f3d17ed7f38014c9e8a", tags[0].ID.String())
 	assert.EqualValues(t, "tag", tags[0].Type)

modules/migrations/gitea_uploader_test.go

@@ -54,14 +54,14 @@ func TestGiteaUploadRepo(t *testing.T) {
 	assert.True(t, repo.HasWiki())
 	assert.EqualValues(t, models.RepositoryReady, repo.Status)
 
-	milestones, err := models.GetMilestones(models.GetMilestonesOption{
+	milestones, _, err := models.GetMilestones(models.GetMilestonesOption{
 		RepoID: repo.ID,
 		State:  structs.StateOpen,
 	})
 	assert.NoError(t, err)
 	assert.Len(t, milestones, 1)
 
-	milestones, err = models.GetMilestones(models.GetMilestonesOption{
+	milestones, _, err = models.GetMilestones(models.GetMilestonesOption{
 		RepoID: repo.ID,
 		State:  structs.StateClosed,
 	})