MokoConsulting/MokoGitea
1
0
Fork 0
Code Issues 145 Pull Requests Releases 96 Wiki Activity

feat(issues): advanced search with custom field filters #497

Merged
jmiller merged 2 commits from feat/issue-custom-field-search into dev 2026-06-06 04:07:26 +00:00
Conversation 0 Commits 2 Files Changed 7
+145 -17
7 changed files with 145 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
models/issues/issue_search.go
+18 -2
View File
@@ -49,8 +49,9 @@ type IssuesOptions struct { //nolint:revive // export stutter
UpdatedAfterUnix int64
UpdatedBeforeUnix int64
// prioritize issues from this repo
PriorityRepoID int64
IsArchived optional.Option[bool]
PriorityRepoID int64
IsArchived optional.Option[bool]
CustomFieldFilters map[int64]string // field_id → required value (AND semantics)
Owner *user_model.User // issues permission scope, it could be an organization or a user
Team *organization.Team // issues permission scope
Doer *user_model.User // issues permission scope
@@ -211,6 +212,20 @@ func applyProjectCondition(sess *xorm.Session, opts *IssuesOptions) {
// do not need to apply any condition
}
func applyCustomFieldCondition(sess *xorm.Session, opts *IssuesOptions) {
if len(opts.CustomFieldFilters) == 0 {
return
}
// Each filtered field adds a subquery: the issue must have a matching
// custom_field_value row for every specified field (AND semantics).
for fieldID, value := range opts.CustomFieldFilters {
subQuery := builder.Select("entity_id").From("custom_field_value").Where(
builder.Eq{"field_id": fieldID, "value": value, "entity_type": "issue"},
)
sess.And(builder.In("issue.id", subQuery))
}
}
func applyRepoConditions(sess *xorm.Session, opts *IssuesOptions) {
if len(opts.RepoIDs) == 1 {
opts.RepoCond = builder.Eq{"issue.repo_id": opts.RepoIDs[0]}
@@ -278,6 +293,7 @@ func applyConditions(sess *xorm.Session, opts *IssuesOptions) {
}
applyLabelsCondition(sess, opts)
applyCustomFieldCondition(sess, opts)
if opts.Owner != nil {
sess.And(repo_model.UserOwnedRepoCond(opts.Owner.ID))
modules/indexer/issues/db/options.go
+2
View File
@@ -82,6 +82,8 @@ func ToDBOptions(ctx context.Context, options *internal.SearchOptions) (*issue_m
Doer: nil,
}
opts.CustomFieldFilters = options.CustomFieldFilters
if len(options.MilestoneIDs) == 1 && options.MilestoneIDs[0] == 0 {
opts.MilestoneIDs = []int64{db.NoConditionID}
} else {
modules/indexer/issues/dboptions.go
+1
View File
@@ -79,6 +79,7 @@ func ToSearchOptions(keyword string, opts *issues_model.IssuesOptions) *SearchOp
}
searchOpt.Paginator = opts.Paginator
searchOpt.CustomFieldFilters = opts.CustomFieldFilters
switch opts.SortType {
case "", "latest":
modules/indexer/issues/internal/model.go
+2
View File
@@ -114,6 +114,8 @@ type SearchOptions struct {
Paginator *db.ListOptions
SortBy SortBy // sort by field
CustomFieldFilters map[int64]string // field_id → required value (AND semantics, DB-only)
}
// Copy returns a copy of the options.
routers/api/v1/repo/issue.go
+31
View File
@@ -289,6 +289,12 @@ func SearchIssues(ctx *context.APIContext) {
}
}
if cfFilters, cfErr := parseAPICustomFieldFilters(ctx); cfErr != nil {
return
} else if len(cfFilters) > 0 {
searchOpt.CustomFieldFilters = cfFilters
}
ids, total, err := issue_indexer.SearchIssues(ctx, searchOpt)
if err != nil {
ctx.APIErrorInternal(err)
@@ -517,6 +523,12 @@ func ListIssues(ctx *context.APIContext) {
searchOpt.MentionID = optional.Some(mentionedByID)
}
if cfFilters, cfErr := parseAPICustomFieldFilters(ctx); cfErr != nil {
return
} else if len(cfFilters) > 0 {
searchOpt.CustomFieldFilters = cfFilters
}
ids, total, err := issue_indexer.SearchIssues(ctx, searchOpt)
if err != nil {
ctx.APIErrorInternal(err)
@@ -553,6 +565,25 @@ func getUserIDForFilter(ctx *context.APIContext, queryName string) int64 {
return user.ID
}
// parseAPICustomFieldFilters extracts cf_{fieldID}=value query parameters.
// Returns an error (and writes a 400 response) if a field ID is non-numeric or non-positive.
func parseAPICustomFieldFilters(ctx *context.APIContext) (map[int64]string, error) {
filters := make(map[int64]string)
for key, values := range ctx.Req.URL.Query() {
after, ok := strings.CutPrefix(key, "cf_")
if !ok || len(values) == 0 || values[0] == "" {
continue
}
fieldID, err := strconv.ParseInt(after, 10, 64)
if err != nil || fieldID <= 0 {
ctx.APIError(http.StatusBadRequest, fmt.Sprintf("invalid custom field filter: cf_%s must use a positive numeric field ID", after))
return nil, fmt.Errorf("invalid cf_ param")
}
filters[fieldID] = values[0]
}
return filters, nil
}
// GetIssue get an issue of a repository
func GetIssue(ctx *context.APIContext) {
// swagger:operation GET /repos/{owner}/{repo}/issues/{index} issue issueGetIssue
routers/web/repo/issue_list.go
+64 -14
View File
@@ -5,8 +5,11 @@ package repo
import (
"bytes"
"encoding/json"
"fmt"
"maps"
"net/http"
"net/url"
"slices"
"sort"
"strconv"
@@ -521,20 +524,52 @@ func prepareIssueFilterAndList(ctx *context.Context, milestoneID int64, projectI
prepareIssueFilterExclusiveOrderScopes(ctx, preparedLabelFilter.AllLabels)
// Parse custom field filters from query params (cf_{fieldID}={value}).
customFieldFilters := parseCustomFieldQueryParams(ctx.Req.URL.Query())
// Load custom field definitions for the filter UI.
// If this fails, clear filters so users don't get invisible filtering.
customFieldDefs, cfErr := issues_model.GetCustomFieldsByOwner(ctx, repo.OwnerID, issues_model.CustomFieldScopeIssue)
if cfErr != nil {
log.Error("prepareIssueFilterAndList: GetCustomFieldsByOwner: %v", cfErr)
customFieldFilters = make(map[int64]string)
}
ctx.Data["CustomFieldDefs"] = customFieldDefs
ctx.Data["CustomFieldFilters"] = customFieldFilters
// Build a query string fragment for cf_ params so they survive pagination/sort changes.
cfQuery := make(url.Values)
for fieldID, value := range customFieldFilters {
cfQuery.Set(fmt.Sprintf("cf_%d", fieldID), value)
}
ctx.Data["CustomFieldQueryString"] = cfQuery.Encode()
fieldOptions := make(map[int64][]string)
for _, f := range customFieldDefs {
if f.Options != "" {
var opts []string
if err := json.Unmarshal([]byte(f.Options), &opts); err != nil {
log.Error("prepareIssueFilterAndList: invalid options JSON for field %d (%s): %v", f.ID, f.Name, err)
} else {
fieldOptions[f.ID] = opts
}
}
}
ctx.Data["CustomFieldOptions"] = fieldOptions
var keywordMatchedIssueIDs []int64
var issueStats *issues_model.IssueStats
statsOpts := &issues_model.IssuesOptions{
RepoIDs: []int64{repo.ID},
LabelIDs: preparedLabelFilter.SelectedLabelIDs,
MilestoneIDs: mileIDs,
ProjectIDs: projectIDs,
AssigneeID: assigneeID,
MentionedID: mentionedID,
PosterID: posterUserID,
ReviewRequestedID: reviewRequestedID,
ReviewedID: reviewedID,
IsPull: isPullOption,
IssueIDs: nil,
RepoIDs: []int64{repo.ID},
LabelIDs: preparedLabelFilter.SelectedLabelIDs,
MilestoneIDs: mileIDs,
ProjectIDs: projectIDs,
AssigneeID: assigneeID,
MentionedID: mentionedID,
PosterID: posterUserID,
ReviewRequestedID: reviewRequestedID,
ReviewedID: reviewedID,
IsPull: isPullOption,
IssueIDs: nil,
CustomFieldFilters: customFieldFilters,
}
if keyword != "" {
@@ -611,9 +646,10 @@ func prepareIssueFilterAndList(ctx *context.Context, milestoneID int64, projectI
ProjectIDs: projectIDs,
IsClosed: isShowClosed,
IsPull: isPullOption,
LabelIDs: preparedLabelFilter.SelectedLabelIDs,
SortType: sortType,
IssueIDs: keywordMatchedIssueIDs,
LabelIDs: preparedLabelFilter.SelectedLabelIDs,
SortType: sortType,
IssueIDs: keywordMatchedIssueIDs,
CustomFieldFilters: customFieldFilters,
})
if err != nil {
ctx.ServerError("DBIndexer.Search", err)
@@ -771,3 +807,17 @@ func Issues(ctx *context.Context) {
ctx.HTML(http.StatusOK, tplIssues)
}
// parseCustomFieldQueryParams extracts cf_{fieldID}=value query parameters.
// Non-numeric or non-positive field IDs are silently skipped.
func parseCustomFieldQueryParams(query url.Values) map[int64]string {
filters := make(map[int64]string)
for key, values := range query {
if after, ok := strings.CutPrefix(key, "cf_"); ok && len(values) > 0 && values[0] != "" {
if fieldID, err := strconv.ParseInt(after, 10, 64); err == nil && fieldID > 0 {
filters[fieldID] = values[0]
}
}
}
return filters
}
templates/repo/issue/filter_list.tmpl
+27 -1
View File
@@ -1,6 +1,6 @@
{{$projectIDs := $.ProjectIDs}}
{{$projectIDsQuery := SliceUtils.JoinInt64 $projectIDs}}
{{$queryLink := QueryBuild "?" "q" $.Keyword "type" $.ViewType "sort" $.SortType "state" $.State "labels" $.SelectLabels "milestone" $.MilestoneID "project" $projectIDsQuery "assignee" $.AssigneeID "poster" $.PosterUsername "archived_labels" (Iif $.ShowArchivedLabels "true")}}
{{$queryLink := QueryBuild (print "?" $.CustomFieldQueryString) "q" $.Keyword "type" $.ViewType "sort" $.SortType "state" $.State "labels" $.SelectLabels "milestone" $.MilestoneID "project" $projectIDsQuery "assignee" $.AssigneeID "poster" $.PosterUsername "archived_labels" (Iif $.ShowArchivedLabels "true")}}
{{$showAllProjects := not $projectIDs}}
{{$showNoProjectSelected := and (eq (len $projectIDs) 1) (eq (index $projectIDs 0) -1)}}
@@ -96,6 +96,32 @@
</div>
{{end}}
{{if .CustomFieldDefs}}
<!-- Custom Field Filters -->
{{$cfFilters := .CustomFieldFilters}}
{{$cfOptions := .CustomFieldOptions}}
{{range $def := .CustomFieldDefs}}
{{$opts := index $cfOptions $def.ID}}
{{if $opts}}
{{$cfKey := printf "cf_%d" $def.ID}}
{{$currentVal := index $cfFilters $def.ID}}
<div class="item ui dropdown jump">
<span class="text {{if $currentVal}}tw-font-bold{{end}}">
{{$def.Name}}
</span>
{{svg "octicon-triangle-down" 14 "dropdown icon"}}
<div class="menu">
<a class="{{if not $currentVal}}active {{end}}item" href="{{QueryBuild $queryLink $cfKey NIL}}">All</a>
<div class="divider"></div>
{{range $opt := $opts}}
<a class="{{if eq $opt $currentVal}}active {{end}}item" href="{{QueryBuild $queryLink $cfKey $opt}}">{{$opt}}</a>
{{end}}
</div>
</div>
{{end}}
{{end}}
{{end}}
<!-- Sort -->
<div class="item ui dropdown jump">
<span class="text">