feat: show more relevant results for 'dependencies' dropdown (#8003)

- Fix issue dropdown breaking when currently selected issue is included in results.
- Add `sort` parameter to `/issues/search` API.
- Sort dropdown by relevance.
- Make priority_repo_id work again.
- Added E2E test.

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8003
Reviewed-by: Shiny Nematoda <[email protected]>
Reviewed-by: Gusted <[email protected]>
Co-authored-by: Danko Aleksejevs <[email protected]>
Co-committed-by: Danko Aleksejevs <[email protected]>

Author: virtulis

models/fixtures/repository.yml

@@ -32,7 +32,7 @@
   created_unix: 1731254961
   updated_unix: 1731254961
   topics: '[]'
-  
+
 -
   id: 2
   owner_id: 2

models/issues/issue_search.go

@@ -48,7 +48,9 @@ type IssuesOptions struct { //nolint
 	UpdatedBeforeUnix  int64
 	// prioritize issues from this repo
 	PriorityRepoID int64
-	IsArchived     optional.Option[bool]
+	// if this issue index (not ID) exists and matches the filters, *and* priorityrepo sort is used, show it first
+	PriorityIssueIndex int64
+	IsArchived         optional.Option[bool]
 
 	// If combined with AllPublic, then private as well as public issues
 	// that matches the criteria will be returned, if AllPublic is false
@@ -60,7 +62,7 @@ type IssuesOptions struct { //nolint
 
 // applySorts sort an issues-related session based on the provided
 // sortType string
-func applySorts(sess *xorm.Session, sortType string, priorityRepoID int64) {
+func applySorts(sess *xorm.Session, sortType string, priorityRepoID, priorityIssueIndex int64) {
 	switch sortType {
 	case "oldest":
 		sess.Asc("issue.created_unix").Asc("issue.id")
@@ -97,8 +99,11 @@ func applySorts(sess *xorm.Session, sortType string, priorityRepoID int64) {
 	case "priorityrepo":
 		sess.OrderBy("CASE "+
 			"WHEN issue.repo_id = ? THEN 1 "+
-			"ELSE 2 END ASC", priorityRepoID).
-			Desc("issue.created_unix").
+			"ELSE 2 END ASC", priorityRepoID)
+		if priorityIssueIndex != 0 {
+			sess.OrderBy("issue.index = ? DESC", priorityIssueIndex)
+		}
+		sess.Desc("issue.created_unix").
 			Desc("issue.id")
 	case "project-column-sorting":
 		sess.Asc("project_issue.sorting").Desc("issue.created_unix").Desc("issue.id")
@@ -470,7 +475,7 @@ func Issues(ctx context.Context, opts *IssuesOptions) (IssueList, error) {
 		Join("INNER", "repository", "`issue`.repo_id = `repository`.id")
 	applyLimit(sess, opts)
 	applyConditions(sess, opts)
-	applySorts(sess, opts.SortType, opts.PriorityRepoID)
+	applySorts(sess, opts.SortType, opts.PriorityRepoID, opts.PriorityIssueIndex)
 
 	issues := IssueList{}
 	if err := sess.Find(&issues); err != nil {
@@ -494,7 +499,7 @@ func IssueIDs(ctx context.Context, opts *IssuesOptions, otherConds ...builder.Co
 	}
 
 	applyLimit(sess, opts)
-	applySorts(sess, opts.SortType, opts.PriorityRepoID)
+	applySorts(sess, opts.SortType, opts.PriorityRepoID, opts.PriorityIssueIndex)
 
 	var res []int64
 	total, err := sess.Select("`issue`.id").Table(&Issue{}).FindAndCount(&res)

models/issues/pull_list.go

@@ -149,7 +149,7 @@ func PullRequests(ctx context.Context, baseRepoID int64, opts *PullRequestsOptio
 	}
 
 	findSession := listPullRequestStatement(ctx, baseRepoID, opts)
-	applySorts(findSession, opts.SortType, 0)
+	applySorts(findSession, opts.SortType, 0, 0)
 	findSession = db.SetSessionPagination(findSession, opts)
 	prs := make([]*PullRequest, 0, opts.PageSize)
 	found := findSession.Find(&prs)

modules/indexer/issues/bleve/bleve.go

@@ -170,7 +170,7 @@ func (b *Indexer) Search(ctx context.Context, options *internal.SearchOptions) (
 
 			if issueID, err := token.ParseIssueReference(); err == nil {
 				idQuery := inner_bleve.NumericEqualityQuery(issueID, "index")
-				idQuery.SetBoost(5.0)
+				idQuery.SetBoost(20.0)
 				innerQ.AddQuery(idQuery)
 			}
 
@@ -197,6 +197,15 @@ func (b *Indexer) Search(ctx context.Context, options *internal.SearchOptions) (
 		queries = append(queries, bleve.NewDisjunctionQuery(repoQueries...))
 	}
 
+	if options.PriorityRepoID.Has() {
+		eq := inner_bleve.NumericEqualityQuery(options.PriorityRepoID.Value(), "repo_id")
+		eq.SetBoost(10.0)
+		meh := bleve.NewMatchAllQuery()
+		meh.SetBoost(0)
+		should := bleve.NewDisjunctionQuery(eq, meh)
+		queries = append(queries, should)
+	}
+
 	if options.IsPull.Has() {
 		queries = append(queries, inner_bleve.BoolFieldQuery(options.IsPull.Value(), "is_pull"))
 	}

modules/indexer/issues/db/db.go

@@ -53,6 +53,7 @@ func (i *Indexer) Search(ctx context.Context, options *internal.SearchOptions) (
 
 	cond := builder.NewCond()
 
+	var priorityIssueIndex int64
 	if options.Keyword != "" {
 		repoCond := builder.In("repo_id", options.RepoIDs)
 		if len(options.RepoIDs) == 1 {
@@ -82,13 +83,15 @@ func (i *Indexer) Search(ctx context.Context, options *internal.SearchOptions) (
 				builder.Eq{"`index`": issueID},
 				cond,
 			)
+			priorityIssueIndex = issueID
 		}
 	}
 
 	opt, err := ToDBOptions(ctx, options)
 	if err != nil {
 		return nil, err
 	}
+	opt.PriorityIssueIndex = priorityIssueIndex
 
 	// If pagesize == 0, return total count only. It's a special case for search count.
 	if options.Paginator != nil && options.Paginator.PageSize == 0 {

modules/indexer/issues/db/options.go

@@ -78,6 +78,11 @@ func ToDBOptions(ctx context.Context, options *internal.SearchOptions) (*issue_m
 		User:               nil,
 	}
 
+	if options.PriorityRepoID.Has() {
+		opts.SortType = "priorityrepo"
+		opts.PriorityRepoID = options.PriorityRepoID.Value()
+	}
+
 	if len(options.MilestoneIDs) == 1 && options.MilestoneIDs[0] == 0 {
 		opts.MilestoneIDs = []int64{db.NoConditionID}
 	} else {

modules/indexer/issues/elasticsearch/elasticsearch.go

@@ -165,7 +165,7 @@ func (b *Indexer) Search(ctx context.Context, options *internal.SearchOptions) (
 			}
 			var eitherQ elastic.Query = innerQ
 			if issueID, err := token.ParseIssueReference(); err == nil {
-				indexQ := elastic.NewTermQuery("index", issueID).Boost(15.0)
+				indexQ := elastic.NewTermQuery("index", issueID).Boost(20)
 				eitherQ = elastic.NewDisMaxQuery().Query(indexQ).Query(innerQ).TieBreaker(0.5)
 			}
 			switch token.Kind {
@@ -188,6 +188,10 @@ func (b *Indexer) Search(ctx context.Context, options *internal.SearchOptions) (
 		}
 		query.Must(q)
 	}
+	if options.PriorityRepoID.Has() {
+		q := elastic.NewTermQuery("repo_id", options.PriorityRepoID.Value()).Boost(10)
+		query.Should(q)
+	}
 
 	if options.IsPull.Has() {
 		query.Must(elastic.NewTermQuery("is_pull", options.IsPull.Value()))

modules/indexer/issues/internal/model.go

@@ -75,8 +75,9 @@ type SearchResult struct {
 type SearchOptions struct {
 	Keyword string // keyword to search
 
-	RepoIDs   []int64 // repository IDs which the issues belong to
-	AllPublic bool    // if include all public repositories
+	RepoIDs        []int64                // repository IDs which the issues belong to
+	AllPublic      bool                   // if include all public repositories
+	PriorityRepoID optional.Option[int64] // issues from this repository will be prioritized when SortByScore
 
 	IsPull   optional.Option[bool] // if the issues is a pull request
 	IsClosed optional.Option[bool] // if the issues is closed

modules/indexer/issues/internal/tests/tests.go

@@ -742,6 +742,25 @@ var cases = []*testIndexerCase{
 			}
 		},
 	},
+	{
+		Name: "PriorityRepoID",
+		SearchOptions: &internal.SearchOptions{
+			IsPull:         optional.Some(false),
+			IsClosed:       optional.Some(false),
+			PriorityRepoID: optional.Some(int64(3)),
+			Paginator:      &db.ListOptionsAll,
+			SortBy:         internal.SortByScore,
+		},
+		Expected: func(t *testing.T, data map[int64]*internal.IndexerData, result *internal.SearchResult) {
+			for i, v := range result.Hits {
+				if i < 7 {
+					assert.Equal(t, int64(3), data[v.ID].RepoID)
+				} else {
+					assert.NotEqual(t, int64(3), data[v.ID].RepoID)
+				}
+			}
+		},
+	},
 }
 
 type testIndexerCase struct {

routers/api/v1/repo/issue.go

@@ -121,6 +121,12 @@ func SearchIssues(ctx *context.APIContext) {
 	//   description: Number of items per page
 	//   type: integer
 	//   minimum: 0
+	// - name: sort
+	//   in: query
+	//   description: Type of sort
+	//   type: string
+	//   enum: [relevance, latest, oldest, recentupdate, leastupdate, mostcomment, leastcomment, nearduedate, farduedate]
+	//   default: latest
 	// responses:
 	//   "200":
 	//     "$ref": "#/responses/IssueList"
@@ -276,7 +282,7 @@ func SearchIssues(ctx *context.APIContext) {
 		IsClosed:            isClosed,
 		IncludedAnyLabelIDs: includedAnyLabels,
 		MilestoneIDs:        includedMilestones,
-		SortBy:              issue_indexer.SortByCreatedDesc,
+		SortBy:              issue_indexer.ParseSortBy(ctx.FormString("sort"), issue_indexer.SortByCreatedDesc),
 	}
 
 	if since != 0 {
@@ -305,9 +311,10 @@ func SearchIssues(ctx *context.APIContext) {
 		}
 	}
 
-	// FIXME: It's unsupported to sort by priority repo when searching by indexer,
-	//        it's indeed an regression, but I think it is worth to support filtering by indexer first.
-	_ = ctx.FormInt64("priority_repo_id")
+	priorityRepoID := ctx.FormInt64("priority_repo_id")
+	if priorityRepoID > 0 {
+		searchOpt.PriorityRepoID = optional.Some(priorityRepoID)
+	}
 
 	ids, total, err := issue_indexer.SearchIssues(ctx, searchOpt)
 	if err != nil {