Compare commits

...
2 Commits
Author SHA1 Message Date
Hein 82f82b998f fix(common): skip bun relation fields when building valid columns
Tests / Integration Tests (push) Skipped
Build , Vet Test, and Lint / Build (push) Successful in 1m58s
Tests / Unit Tests (push) Successful in 2m26s
Build , Vet Test, and Lint / Run Vet Tests (1.23.x) (push) Successful in 2m55s
Build , Vet Test, and Lint / Run Vet Tests (1.24.x) (push) Successful in 2m57s
Build , Vet Test, and Lint / Lint Code (push) Successful in 3m19s
Tests / Race Detector (push) Successful in 5m34s
Fields tagged rel:, join: or m2m: were registered as columns (e.g. rel:has-many),
which broke the 'all' filter expansion with invalid SQL.
2026-10-12 16:30:32 +02:00
Hein 5dbe187915 feat(restheadspec): add x-searchop-notcontain operator
Maps notcontain/notcontains/notlike to a not_ilike filter rendered as
(col IS NULL OR CAST(col AS TEXT) NOT ILIKE ?), so NULL rows are kept.
2026-10-12 15:56:42 +02:00
8 changed files with 98 additions and 2 deletions
+4
View File
@@ -139,6 +139,10 @@ func BuildJSONFilterCondition(model interface{}, tableAlias, token, operator str
return fmt.Sprintf("%s LIKE ?", colExpr), prepend(value), true
case "ilike":
return fmt.Sprintf("%s ILIKE ?", colExpr), prepend(value), true
case "not_ilike":
// colExpr appears twice, so its bound args must be repeated too.
notArgs := append(append([]interface{}{}, colArgs...), colArgs...)
return fmt.Sprintf("(%s IS NULL OR %s NOT ILIKE ?)", colExpr, colExpr), append(notArgs, value), true
case "in":
inCond, inArgs := BuildInCondition(colExpr, value)
if inCond == "" {
+5
View File
@@ -93,6 +93,11 @@ func TestBuildJSONFilterCondition(t *testing.T) {
wantCond: `("data" #>> ?::text[]) ILIKE ?`,
wantArgs: []interface{}{"{city}", "%la%"},
},
{
name: "not_ilike repeats bound path", token: "data->>'city'", operator: "not_ilike", value: "%la%",
wantCond: `(("data" #>> ?::text[]) IS NULL OR ("data" #>> ?::text[]) NOT ILIKE ?)`,
wantArgs: []interface{}{"{city}", "{city}", "%la%"},
},
{
name: "in", token: "data->>'tier'", operator: "in", value: []string{"a", "b"},
wantCond: `("data" #>> ?::text[]) IN (?,?)`,
+17
View File
@@ -49,6 +49,11 @@ func (v *ColumnValidator) buildValidColumns() {
continue
}
// Relation fields are not columns
if isBunRelationTag(field.Tag.Get("bun")) {
continue
}
// Get column name from bun, gorm, or json tag
columnName := v.getColumnName(field)
if columnName != "" && columnName != "-" {
@@ -57,6 +62,18 @@ func (v *ColumnValidator) buildValidColumns() {
}
}
// isBunRelationTag reports whether a bun tag describes a relation (rel:, join:, m2m:)
// rather than a database column.
func isBunRelationTag(tag string) bool {
for _, part := range strings.Split(tag, ",") {
part = strings.TrimSpace(part)
if strings.HasPrefix(part, "rel:") || strings.HasPrefix(part, "join:") || strings.HasPrefix(part, "m2m:") {
return true
}
}
return false
}
// getColumnName extracts the column name from a struct field's tags
// Supports both Bun and GORM tags
func (v *ColumnValidator) getColumnName(field reflect.StructField) string {
+26
View File
@@ -545,3 +545,29 @@ func TestFilterRequestOptions_PreloadColumnsParentModelFallback(t *testing.T) {
t.Errorf("Expected preload column 'id', got '%s'", cols[0])
}
}
type relationTestModel struct {
ID int64 `bun:"id,pk"`
Name string `bun:"name"`
Children []*relationTestKid `bun:"rel:has-many,join:id=parent_id"`
Parent *relationTestKid `bun:"rel:has-one,join:parent_id=id"`
Tags []*relationTestKid `bun:"m2m:model_tags,join:Model=Tag"`
}
type relationTestKid struct{}
func TestNewColumnValidator_SkipsRelationFields(t *testing.T) {
cols := NewColumnValidator(relationTestModel{}).GetValidColumns()
set := map[string]bool{}
for _, c := range cols {
set[c] = true
}
if !set["id"] || !set["name"] {
t.Errorf("expected id and name columns, got %v", cols)
}
for _, bad := range []string{"rel:has-many", "rel:has-one", "m2m:model_tags", "children", "parent", "tags"} {
if set[bad] {
t.Errorf("relation %q must not be a valid column (got %v)", bad, cols)
}
}
}
+1
View File
@@ -89,6 +89,7 @@ Search with specific operators (AND logic).
**Supported Operators:**
- `contains` - Contains substring (case-insensitive). Implemented as `CAST(col AS TEXT) ILIKE '%value%'` for every column type, including arrays (stringifies the array, then substring-matches). **Not** array containment — no GIN index use, and can false-positive on partial matches within array elements. resolvespec (a different spec package in this repo) defines `contains` differently: real PostgreSQL array-overlap (`&&`). Don't assume the two behave the same.
- `notcontains` / `notcontain` / `notlike` - Does not contain substring (case-insensitive). Implemented as `(col IS NULL OR CAST(col AS TEXT) NOT ILIKE '%value%')`, so NULLs are kept
- `beginswith` / `startswith` - Starts with (case-insensitive)
- `endswith` - Ends with (case-insensitive)
- `equals` / `eq` - Exact match
+33
View File
@@ -283,3 +283,36 @@ func TestNullAsZero_RestHeadSpecConfig(t *testing.T) {
t.Fatalf("disabled should be plain equality, got %q", got)
}
}
func TestSearchOp_NotContain(t *testing.T) {
h := NewHandler(nil, nil)
model := inactiveModel{}
for _, op := range []string{"notcontain", "notcontains", "notlike"} {
req := &MockRequest{headers: map[string]string{"x-searchop-" + op + "-inactive": "99"}, queryParams: map[string]string{}}
opts := h.parseOptionsFromHeaders(req, model)
if len(opts.Filters) != 1 || opts.Filters[0].Operator != "not_ilike" || opts.Filters[0].Value != "%99%" {
t.Fatalf("%s: unexpected filters %+v", op, opts.Filters)
}
}
req := &MockRequest{headers: map[string]string{"x-searchop-notcontain-inactive": "99"}, queryParams: map[string]string{}}
f := h.parseOptionsFromHeaders(req, model).Filters[0]
ci := h.ValidateAndAdjustFilterForColumnType(&f, model)
if !ci.NeedsCast {
t.Fatalf("numeric column must be cast to TEXT for NOT ILIKE")
}
q := &jsonCapQuery{}
h.applyFilter(q, f, "public.t", ci.NeedsCast, "AND", model)
c := q.only(t)
if want := "(t.inactive IS NULL OR CAST(t.inactive AS TEXT) NOT ILIKE ?)"; c.query != want || !reflect.DeepEqual(c.args, []interface{}{"%99%"}) {
t.Fatalf("got %q %#v, want %q", c.query, c.args, want)
}
q = &jsonCapQuery{}
h.applyOrFilterGroup(q, []*common.FilterOption{&f}, []ColumnCastInfo{ci}, "public.t", model)
c = q.only(t)
if want := "((t.inactive IS NULL OR CAST(t.inactive AS TEXT) NOT ILIKE ?))"; c.query != want {
t.Fatalf("or group got %q, want %q", c.query, want)
}
}
+9 -1
View File
@@ -2550,6 +2550,9 @@ func (h *Handler) applyFilter(query common.SelectQuery, filter common.FilterOpti
// columns are compared natively (see likeColumn above) since citext is
// already case-insensitive.
return applyWhere(fmt.Sprintf("%s ILIKE ?", likeColumn), filter.Value)
case "not_ilike":
// NULLs don't contain the value, so they are kept
return applyWhere(fmt.Sprintf("(%s IS NULL OR %s NOT ILIKE ?)", rawQualifiedColumn, likeColumn), filter.Value)
case "in":
cond, inArgs := common.BuildInCondition(qualifiedColumn, filter.Value)
if cond == "" {
@@ -2636,7 +2639,7 @@ func (h *Handler) applyOrFilterGroup(query common.SelectQuery, filters []*common
qualifiedColumn := rawQualifiedColumn
op := strings.ToLower(filter.Operator)
if op == "like" || op == "ilike" {
if op == "like" || op == "ilike" || op == "not_ilike" {
// Cast to TEXT for LIKE/ILIKE to support date/time/timestamp columns.
// citext columns are left native: they're already case-insensitive and
// casting would defeat a citext index.
@@ -2692,6 +2695,9 @@ func (h *Handler) buildFilterCondition(qualifiedColumn string, filter *common.Fi
return fmt.Sprintf("%s LIKE ?", qualifiedColumn), []interface{}{filter.Value}
case "ilike":
return fmt.Sprintf("%s ILIKE ?", qualifiedColumn), []interface{}{filter.Value}
case "not_ilike":
rawCol := h.qualifyColumnName(filter.Column, tableName)
return fmt.Sprintf("(%s IS NULL OR %s NOT ILIKE ?)", rawCol, qualifiedColumn), []interface{}{filter.Value}
case "in":
cond, inArgs := common.BuildInCondition(qualifiedColumn, filter.Value)
return cond, inArgs
@@ -3440,6 +3446,8 @@ func (h *Handler) buildFilterSQL(filter *common.FilterOption, tableName string)
return fmt.Sprintf("%s LIKE '%v'", qualifiedColumn, filter.Value)
case "ilike":
return fmt.Sprintf("%s ILIKE '%v'", qualifiedColumn, filter.Value)
case "not_ilike":
return fmt.Sprintf("(%s IS NULL OR CAST(%s AS TEXT) NOT ILIKE '%v')", qualifiedColumn, qualifiedColumn, filter.Value)
case "in":
if values, ok := filter.Value.([]any); ok {
valueStrs := make([]string, len(values))
+3 -1
View File
@@ -496,6 +496,8 @@ func (h *Handler) mapSearchOperator(colName, operator, value string) common.Filt
switch operator {
case "contains", "contain", "like":
return common.FilterOption{Column: colName, Operator: "ilike", Value: "%" + value + "%"}
case "notcontains", "notcontain", "notlike":
return common.FilterOption{Column: colName, Operator: "not_ilike", Value: "%" + value + "%"}
case "beginswith", "startswith":
return common.FilterOption{Column: colName, Operator: "ilike", Value: value + "%"}
case "endswith":
@@ -1485,7 +1487,7 @@ func (h *Handler) ValidateAndAdjustFilterForColumnType(filter *common.FilterOpti
// strips the '%' wildcards and hands the driver a non-string argument,
// which fails with "operator does not exist: text ~~* integer" once the
// column is cast to TEXT below.
if op := strings.ToLower(filter.Operator); op == "like" || op == "ilike" {
if op := strings.ToLower(filter.Operator); op == "like" || op == "ilike" || op == "not_ilike" {
if reflection.IsStringType(colType) {
return ColumnCastInfo{NeedsCast: false, IsNumericType: false}
}