chore: add collapse parameter to query builder (#264)

* chore: add collapse parameter to query builder

* chore: update docs

Author: medcl

core/api/util.go

@@ -88,13 +88,14 @@ func WriteAckOKJSON(w http.ResponseWriter) {
 
 func MustGetParameter(w http.ResponseWriter, r *http.Request, key string) string {
 	if r.URL == nil {
-		panic("URL is nil")
+		panic(errors.NewWithHTTPCode(400, "URL is nil"))
+
 	}
 
 	v := r.URL.Query().Get(key)
 
 	if len(v) == 0 {
-		panic("missing parameter " + key)
+		panic(errors.NewWithHTTPCode(400, "missing parameter "+key))
 	}
 
 	return v

core/orm/aggs.go

@@ -95,8 +95,9 @@ func (b *baseAggregation) SetParams(params map[string]interface{}) {
 // TermsAggregation represents a "group by" or "bucketing" operation on a field.
 type TermsAggregation struct {
 	baseAggregation
-	Field string
-	Size  int
+	Field   string
+	Include string
+	Size    int
 }
 
 // AddNested provides a correctly typed chained call for TermsAggregation.

core/orm/query.go

@@ -98,9 +98,10 @@ type QueryBuilder struct {
 	size      int
 	fuzziness int
 
-	query    string
-	includes []string
-	excludes []string
+	query             string
+	collapseOverField string
+	includes          []string
+	excludes          []string
 
 	defaultOperator       string
 	defaultQueryFields    []string
@@ -463,6 +464,10 @@ func (q *QueryBuilder) ToString() string {
 		b.WriteString(", Default Fields: ")
 		b.WriteString(strings.Join(q.defaultQueryFields, ","))
 	}
+	if len(q.collapseOverField) > 0 {
+		b.WriteString(", Collapse Field: ")
+		b.WriteString(q.collapseOverField)
+	}
 
 	if len(q.defaultQueryFields) > 0 {
 		b.WriteString(", Default QueryFields: ")
@@ -780,6 +785,14 @@ func (q *QueryBuilder) buildFuzzinessQuery() {
 	}
 }
 
+func (q *QueryBuilder) CollapseVal() string {
+	return q.collapseOverField
+}
+
+func (q *QueryBuilder) Collapse(field string) {
+	q.collapseOverField = field
+}
+
 // parseQuery attempts to extract field:value only if the field name is valid
 func parseQuery(queryStr string) (field string, value string) {
 	parts := strings.SplitN(queryStr, ":", 2)

core/security/principal.go

@@ -14,7 +14,7 @@ type OrganizationPrincipal struct {
 	Type        string `json:"type,omitempty" elastic_mapping:"type:{type:keyword}"` //  "type": "user", // or "team"
 	Name        string `json:"name,omitempty" elastic_mapping:"name:{type:text,copy_to:combined_fulltext,fields:{keyword: {type: keyword}, pinyin: {type: text, analyzer: pinyin_analyzer}}}"`
 	Description string `json:"description,omitempty" elastic_mapping:"description:{type:keyword,copy_to:combined_fulltext}"`
-	Avatar      string `json:"avatar,omitempty" elastic_mapping:"avatar:{type:keyword}"`
+	Avatar      string `json:"avatar,omitempty" elastic_mapping:"avatar:{enabled:false}"`
 }
 
 type OrganizationPrincipalCache struct {

docs/content.en/docs/release-notes/_index.md

@@ -26,6 +26,7 @@ Information about release notes of INFINI Framework is provided here.
 - refactor: refactoring user and permissions #256
 - chore: improve badger logging #260
 - chore: handle self-signed certs oauth client #263
+- chore: add collapse parameter to query builder #264
 
 ## 1.4.0 (2025-12-19)
 ### ❌ Breaking changes  

modules/elastic/orm.go

@@ -360,6 +360,10 @@ func (handler *ElasticORM) DeleteByQuery(ctx *api.Context, qb *api.QueryBuilder)
 		return nil, errors.New("failed to build query DSL")
 	}
 
+	if global.Env().IsDebug {
+		log.Debug("delete by query:", indexName, util.MustToJSON(dsl))
+	}
+
 	// Execute delete-by-query
 	resp, err := handler.Client.DeleteByQuery(indexName, util.MustToJSONBytes(dsl))
 	if err != nil {
@@ -383,6 +387,10 @@ func (handler *ElasticORM) SearchV2(ctx *api.Context, qb *api.QueryBuilder) (*ap
 	if qb != nil {
 		request.From = qb.FromVal()
 		request.Size = qb.SizeVal()
+
+		if v := qb.CollapseVal(); v != "" {
+			request.Collapse = &elastic.Collapse{Field: v}
+		}
 	}
 
 	if collapseField := api.GetCollapseField(ctx); collapseField != "" {
@@ -406,6 +414,7 @@ func (handler *ElasticORM) SearchV2(ctx *api.Context, qb *api.QueryBuilder) (*ap
 		} else {
 			dsl = orm.BuildQueryDSL(qb)
 		}
+
 		if len(qb.Aggs) > 0 {
 			aggBuilder := orm.AggreationBuilder{}
 			aggs, err := aggBuilder.Build(qb.Aggs)

modules/elastic/orm/aggs.go

@@ -50,8 +50,9 @@ type ESAggregation struct {
 }
 
 type esTermsAggregation struct {
-	Field string `json:"field,omitempty"`
-	Size  int    `json:"size,omitempty"`
+	Field   string `json:"field,omitempty"`
+	Include string `json:"include,omitempty"`
+	Size    int    `json:"size,omitempty"`
 }
 
 type esMetricAggregation struct {
@@ -118,8 +119,9 @@ func (c *AggreationBuilder) translateAggregation(agg orm.Aggregation) (*ESAggreg
 	switch v := agg.(type) {
 	case *orm.TermsAggregation:
 		esAgg.Terms = &esTermsAggregation{
-			Field: v.Field,
-			Size:  v.Size,
+			Field:   v.Field,
+			Include: v.Include,
+			Size:    v.Size,
 		}
 	case *orm.MetricAggregation:
 		metric := &esMetricAggregation{Field: v.Field}

modules/elastic/orm/query_dsl.go

@@ -24,9 +24,10 @@
 package orm
 
 import (
+	"strings"
+
 	"infini.sh/framework/core/orm"
 	"infini.sh/framework/core/util"
-	"strings"
 )
 
 func BuildQueryDSLOnTopOfDSL(q *orm.QueryBuilder, reqBody []byte) map[string]interface{} {
@@ -199,10 +200,17 @@ func BuildQueryDSL(q *orm.QueryBuilder) map[string]interface{} {
 	if q.FromVal() > 0 {
 		dsl["from"] = q.FromVal()
 	}
+
 	if q.SizeVal() > 0 {
 		dsl["size"] = q.SizeVal()
 	}
 
+	if q.CollapseVal() != "" {
+		dsl["collapse"] = map[string]interface{}{
+			"field": q.CollapseVal(),
+		}
+	}
+
 	if len(q.IncludesVal()) > 0 || len(q.ExcludesVal()) > 0 {
 		sources := util.MapStr{}
 		if len(q.IncludesVal()) > 0 {