Use db.ListOptions directly instead of Paginator interface to make it easier to user

Author: lunny

models/issues/issue_search.go

@@ -21,7 +21,7 @@ import (
 
 // IssuesOptions represents options of an issue.
 type IssuesOptions struct { //nolint
-	db.Paginator
+	db.ListOptions
 	RepoIDs            []int64 // overwrites RepoCond if the length is not 0
 	AllPublic          bool    // include also all public repositories
 	RepoCond           builder.Cond
@@ -100,27 +100,15 @@ func applySorts(sess *xorm.Session, sortType string, priorityRepoID int64) {
 }
 
 func applyLimit(sess *xorm.Session, opts *IssuesOptions) *xorm.Session {
-	if opts.Paginator == nil || opts.Paginator.IsListAll() {
+	if opts.ListOptions.IsListAll() {
 		return sess
 	}
 
-	// Warning: Do not use GetSkipTake() for *db.ListOptions
-	// Its implementation could reset the page size with setting.API.MaxResponseItems
-	if listOptions, ok := opts.Paginator.(*db.ListOptions); ok {
-		if listOptions.Page >= 0 && listOptions.PageSize > 0 {
-			var start int
-			if listOptions.Page == 0 {
-				start = 0
-			} else {
-				start = (listOptions.Page - 1) * listOptions.PageSize
-			}
-			sess.Limit(listOptions.PageSize, start)
-		}
-		return sess
+	start := 0
+	if opts.ListOptions.Page > 0 {
+		start = (opts.ListOptions.Page - 1) * opts.ListOptions.PageSize
 	}
-
-	start, limit := opts.Paginator.GetSkipTake()
-	sess.Limit(limit, start)
+	sess.Limit(opts.ListOptions.PageSize, start)
 
 	return sess
 }

models/issues/issue_stats.go

@@ -68,13 +68,17 @@ func CountIssuesByRepo(ctx context.Context, opts *IssuesOptions) (map[int64]int6
 }
 
 // CountIssues number return of issues by given conditions.
-func CountIssues(ctx context.Context, opts *IssuesOptions) (int64, error) {
+func CountIssues(ctx context.Context, opts *IssuesOptions, otherConds ...builder.Cond) (int64, error) {
 	sess := db.GetEngine(ctx).
 		Select("COUNT(issue.id) AS count").
 		Table("issue").
 		Join("INNER", "repository", "`issue`.repo_id = `repository`.id")
 	applyConditions(sess, opts)
 
+	for _, cond := range otherConds {
+		sess.And(cond)
+	}
+
 	return sess.Count()
 }
 

models/issues/issue_test.go

@@ -164,7 +164,7 @@ func TestIssues(t *testing.T) {
 			issues_model.IssuesOptions{
 				RepoCond: builder.In("repo_id", 1, 3),
 				SortType: "oldest",
-				Paginator: &db.ListOptions{
+				ListOptions: db.ListOptions{
 					Page:     1,
 					PageSize: 4,
 				},
@@ -174,7 +174,7 @@ func TestIssues(t *testing.T) {
 		{
 			issues_model.IssuesOptions{
 				LabelIDs: []int64{1},
-				Paginator: &db.ListOptions{
+				ListOptions: db.ListOptions{
 					Page:     1,
 					PageSize: 4,
 				},
@@ -184,7 +184,7 @@ func TestIssues(t *testing.T) {
 		{
 			issues_model.IssuesOptions{
 				LabelIDs: []int64{1, 2},
-				Paginator: &db.ListOptions{
+				ListOptions: db.ListOptions{
 					Page:     1,
 					PageSize: 4,
 				},
@@ -326,7 +326,7 @@ func TestCorrectIssueStats(t *testing.T) {
 
 	// Now we will get all issueID's that match the "Bugs are nasty" query.
 	issues, err := issues_model.Issues(context.TODO(), &issues_model.IssuesOptions{
-		Paginator: &db.ListOptions{
+		ListOptions: db.ListOptions{
 			PageSize: issueAmount,
 		},
 		RepoIDs: []int64{1},

modules/indexer/issues/bleve/bleve.go

@@ -266,7 +266,7 @@ func (b *Indexer) Search(ctx context.Context, options *internal.SearchOptions) (
 		indexerQuery = bleve.NewMatchAllQuery()
 	}
 
-	skip, limit := indexer_internal.ParsePaginator(options.Paginator)
+	skip, limit := indexer_internal.ParsePaginator(&options.ListOptions)
 	search := bleve.NewSearchRequestOptions(indexerQuery, limit, skip, false)
 
 	if options.SortBy == "" {

modules/indexer/issues/db/db.go

@@ -78,6 +78,17 @@ func (i *Indexer) Search(ctx context.Context, options *internal.SearchOptions) (
 		return nil, err
 	}
 
+	// If pagesize == 0, return total count only. It's a special case for search count.
+	if options.ListOptions.PageSize == 0 {
+		total, err := issue_model.CountIssues(ctx, opt, cond)
+		if err != nil {
+			return nil, err
+		}
+		return &internal.SearchResult{
+			Total: total,
+		}, nil
+	}
+
 	ids, total, err := issue_model.IssueIDs(ctx, opt, cond)
 	if err != nil {
 		return nil, err

modules/indexer/issues/db/options.go

@@ -50,7 +50,7 @@ func ToDBOptions(ctx context.Context, options *internal.SearchOptions) (*issue_m
 	}
 
 	opts := &issue_model.IssuesOptions{
-		Paginator:          options.Paginator,
+		ListOptions:        options.ListOptions,
 		RepoIDs:            options.RepoIDs,
 		AllPublic:          options.AllPublic,
 		RepoCond:           nil,

modules/indexer/issues/dboptions.go

@@ -65,7 +65,7 @@ func ToSearchOptions(keyword string, opts *issues_model.IssuesOptions) *SearchOp
 		searchOpt.UpdatedBeforeUnix = optional.Some(opts.UpdatedBeforeUnix)
 	}
 
-	searchOpt.Paginator = opts.Paginator
+	searchOpt.ListOptions = opts.ListOptions
 
 	switch opts.SortType {
 	case "":

modules/indexer/issues/elasticsearch/elasticsearch.go

@@ -248,7 +248,7 @@ func (b *Indexer) Search(ctx context.Context, options *internal.SearchOptions) (
 	// TODO: make it configurable since it's configurable in elasticsearch
 	const maxPageSize = 10000
 
-	skip, limit := indexer_internal.ParsePaginator(options.Paginator, maxPageSize)
+	skip, limit := indexer_internal.ParsePaginator(&options.ListOptions, maxPageSize)
 	searchResult, err := b.inner.Client.Search().
 		Index(b.inner.VersionedIndexName()).
 		Query(query).

modules/indexer/issues/indexer.go

@@ -308,7 +308,7 @@ func SearchIssues(ctx context.Context, opts *SearchOptions) ([]int64, int64, err
 
 // CountIssues counts issues by options. It is a shortcut of SearchIssues(ctx, opts) but only returns the total count.
 func CountIssues(ctx context.Context, opts *SearchOptions) (int64, error) {
-	opts = opts.Copy(func(options *SearchOptions) { opts.Paginator = &db_model.ListOptions{PageSize: 0} })
+	opts = opts.Copy(func(options *SearchOptions) { options.ListOptions = db_model.ListOptions{PageSize: 0} })
 
 	_, total, err := SearchIssues(ctx, opts)
 	return total, err

modules/indexer/issues/indexer_test.go

@@ -397,7 +397,7 @@ func searchIssueWithPaginator(t *testing.T) {
 	}{
 		{
 			SearchOptions{
-				Paginator: &db.ListOptions{
+				ListOptions: db.ListOptions{
 					PageSize: 5,
 				},
 			},

modules/indexer/issues/internal/model.go

@@ -106,7 +106,7 @@ type SearchOptions struct {
 	UpdatedAfterUnix  optional.Option[int64]
 	UpdatedBeforeUnix optional.Option[int64]
 
-	db.Paginator
+	db.ListOptions
 
 	SortBy SortBy // sort by field
 }