API add/generalize pagination (#9452)

* paginate results

* fixed deadlock

* prevented breaking change

* updated swagger

* go fmt

* fixed find topic

* go mod tidy

* go mod vendor with go1.13.5

* fixed repo find topics

* fixed unit test

* added Limit method to Engine struct; use engine variable when provided; fixed gitignore

* use ItemsPerPage for default pagesize; fix GetWatchers, getOrgUsersByOrgID and GetStargazers; fix GetAllCommits headers; reverted some changed behaviors

* set Page value on Home route

* improved memory allocations

* fixed response headers

* removed logfiles

* fixed import order

* import order

* improved swagger

* added function to get models.ListOptions from context

* removed pagesize diff on unit test

* fixed imports

* removed unnecessary struct field

* fixed go fmt

* scoped PR

* code improvements

* code improvements

* go mod tidy

* fixed import order

* fixed commit statuses session

* fixed files headers

* fixed headers; added pagination for notifications

* go mod tidy

* go fmt

* removed Private from user search options; added setting.UI.IssuePagingNum as default valeu on repo's issues list

* Apply suggestions from code review

Co-Authored-By: 6543 <6543@obermui.de>
Co-Authored-By: zeripath <art27@cantab.net>

* fixed build error

* CI.restart()

* fixed merge conflicts resolve

* fixed conflicts resolve

* improved FindTrackedTimesOptions.ToOptions() method

* added backwards compatibility on ListReleases request; fixed issue tracked time ToSession

* fixed build error; fixed swagger template

* fixed swagger template

* fixed ListReleases backwards compatibility

* added page to user search route

Co-authored-by: techknowlogick <matti@mdranta.net>
Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: zeripath <art27@cantab.net>

modules/context/org.go

@@ -1,4 +1,5 @@
 // Copyright 2014 The Gogs Authors. All rights reserved.
+// Copyright 2020 The Gitea Authors.
 // Use of this source code is governed by a MIT-style
 // license that can be found in the LICENSE file.
 
@@ -118,7 +119,7 @@ func HandleOrgAssignment(ctx *Context, args ...bool) {
 	// Team.
 	if ctx.Org.IsMember {
 		if ctx.Org.IsOwner {
-			if err := org.GetTeams(); err != nil {
+			if err := org.GetTeams(&models.SearchTeamOptions{}); err != nil {
 				ctx.ServerError("GetTeams", err)
 				return
 			}

modules/git/commit.go

@@ -297,8 +297,8 @@ func (c *Commit) CommitsCount() (int64, error) {
 }
 
 // CommitsByRange returns the specific page commits before current revision, every page's number default by CommitsRangeSize
-func (c *Commit) CommitsByRange(page int) (*list.List, error) {
-	return c.repo.commitsByRange(c.ID, page)
+func (c *Commit) CommitsByRange(page, pageSize int) (*list.List, error) {
+	return c.repo.commitsByRange(c.ID, page, pageSize)
 }
 
 // CommitsBefore returns all the commits before current revision

modules/git/repo_commit.go

@@ -198,9 +198,10 @@ func (repo *Repository) GetCommitByPath(relpath string) (*Commit, error) {
 // CommitsRangeSize the default commits range size
 var CommitsRangeSize = 50
 
-func (repo *Repository) commitsByRange(id SHA1, page int) (*list.List, error) {
-	stdout, err := NewCommand("log", id.String(), "--skip="+strconv.Itoa((page-1)*CommitsRangeSize),
-		"--max-count="+strconv.Itoa(CommitsRangeSize), prettyLogFormat).RunInDirBytes(repo.Path)
+func (repo *Repository) commitsByRange(id SHA1, page, pageSize int) (*list.List, error) {
+	stdout, err := NewCommand("log", id.String(), "--skip="+strconv.Itoa((page-1)*pageSize),
+		"--max-count="+strconv.Itoa(pageSize), prettyLogFormat).RunInDirBytes(repo.Path)
+
 	if err != nil {
 		return nil, err
 	}

modules/indexer/issues/indexer.go

@@ -221,8 +221,7 @@ func populateIssueIndexer(ctx context.Context) {
 		default:
 		}
 		repos, _, err := models.SearchRepositoryByName(&models.SearchRepoOptions{
-			Page:        page,
-			PageSize:    models.RepositoryListDefaultPageSize,
+			ListOptions: models.ListOptions{Page: page, PageSize: models.RepositoryListDefaultPageSize},
 			OrderBy:     models.SearchOrderByID,
 			Private:     true,
 			Collaborate: util.OptionalBoolFalse,

modules/migrations/gitea_test.go

@@ -59,19 +59,27 @@ func TestGiteaUploadRepo(t *testing.T) {
 	assert.NoError(t, err)
 	assert.EqualValues(t, 0, len(milestones))
 
-	labels, err := models.GetLabelsByRepoID(repo.ID, "")
+	labels, err := models.GetLabelsByRepoID(repo.ID, "", models.ListOptions{})
 	assert.NoError(t, err)
 	assert.EqualValues(t, 11, len(labels))
 
 	releases, err := models.GetReleasesByRepoID(repo.ID, models.FindReleasesOptions{
+		ListOptions: models.ListOptions{
+			PageSize: 10,
+			Page:     0,
+		},
 		IncludeTags: true,
-	}, 0, 10)
+	})
 	assert.NoError(t, err)
 	assert.EqualValues(t, 8, len(releases))
 
 	releases, err = models.GetReleasesByRepoID(repo.ID, models.FindReleasesOptions{
+		ListOptions: models.ListOptions{
+			PageSize: 10,
+			Page:     0,
+		},
 		IncludeTags: false,
-	}, 0, 10)
+	})
 	assert.NoError(t, err)
 	assert.EqualValues(t, 1, len(releases))
 

modules/repository/create_test.go

@@ -19,7 +19,7 @@ func TestIncludesAllRepositoriesTeams(t *testing.T) {
 
 	testTeamRepositories := func(teamID int64, repoIds []int64) {
 		team := models.AssertExistsAndLoadBean(t, &models.Team{ID: teamID}).(*models.Team)
-		assert.NoError(t, team.GetRepositories(), "%s: GetRepositories", team.Name)
+		assert.NoError(t, team.GetRepositories(&models.SearchTeamOptions{}), "%s: GetRepositories", team.Name)
 		assert.Len(t, team.Repos, team.NumRepos, "%s: len repo", team.Name)
 		assert.Equal(t, len(repoIds), len(team.Repos), "%s: repo count", team.Name)
 		for i, rid := range repoIds {

modules/repository/repo.go

@@ -183,9 +183,10 @@ func CleanUpMigrateInfo(repo *models.Repository) (*models.Repository, error) {
 // SyncReleasesWithTags synchronizes release table with repository tags
 func SyncReleasesWithTags(repo *models.Repository, gitRepo *git.Repository) error {
 	existingRelTags := make(map[string]struct{})
-	opts := models.FindReleasesOptions{IncludeDrafts: true, IncludeTags: true}
+	opts := models.FindReleasesOptions{IncludeDrafts: true, IncludeTags: true, ListOptions: models.ListOptions{PageSize: 50}}
 	for page := 1; ; page++ {
-		rels, err := models.GetReleasesByRepoID(repo.ID, opts, page, 100)
+		opts.Page = page
+		rels, err := models.GetReleasesByRepoID(repo.ID, opts)
 		if err != nil {
 			return fmt.Errorf("GetReleasesByRepoID: %v", err)
 		}