rest: add jsonb containment operators @> and <@

Signed-off-by: hmoazzem <[email protected]>

Author: hmoazzem

pkg/httputil/context.go

@@ -61,12 +61,13 @@ func BindOrError(r *http.Request, w http.ResponseWriter, dst any) error {
 }
 
 // JSON writes a JSON response with the given status code and data.
-func JSON(w http.ResponseWriter, statusCode int, data any) {
+func JSON(w http.ResponseWriter, statusCode int, v any) {
 	w.Header().Set("Content-Type", "application/json")
 	w.WriteHeader(statusCode)
-	if err := json.NewEncoder(w).Encode(data); err != nil {
-		http.Error(w, "Failed to encode response", http.StatusInternalServerError)
-	}
+
+	encoder := json.NewEncoder(w)
+	encoder.SetIndent("", "  ") // double-spaced pretty json. should take from config
+	encoder.Encode(v)
 }
 
 // Text writes a plain text response with the given status code and text content.

pkg/httputil/router.go

@@ -10,6 +10,8 @@ import (
 	"strings"
 	"sync"
 
+	"slices"
+
 	"github.com/edgeflare/pgo/pkg/util"
 )
 
@@ -95,7 +97,7 @@ func (r *Router) Group(prefix string) *Router {
 	defer r.mu.RUnlock()
 	return &Router{
 		mux:        r.mux,
-		middleware: append([]Middleware{}, r.middleware...),
+		middleware: slices.Clone(r.middleware),
 		server:     r.server,
 		prefix:     r.prefix + prefix,
 	}

pkg/rest/doc.go

@@ -8,22 +8,24 @@
 //
 // Query parameters control filtering, pagination, and ordering:
 //
-//	Parameter         | Description
-//	------------------|------------------------------------------------
-//	?select=col1,col2 | Select specific columns
-//	?order=col.desc   | Order results (supports nullsfirst/nullslast)
+//	Parameter           | Description
+//	--------------------|------------------------------------------------
+//	?select=col1,col2   | Select specific columns
+//	?order=col.desc     | Order results (supports nullsfirst/nullslast)
 //	?order=similarity(col, 'search string') | Order by similarity (requires pg_trgm extension)
-//	?limit=100        | Limit number of results (default: 100)
-//	?offset=0         | Pagination offset (default: 0)
-//	?col=eq.val       | Filter by column equality
-//	?col=gt.val       | Filter with greater than comparison
-//	?col=lt.val       | Filter with less than comparison
-//	?col=gte.val      | Filter with greater than or equal comparison
-//	?col=lte.val      | Filter with less than or equal comparison
-//	?col=like.val     | Filter with pattern matching
-//	?col=in.(a,b,c)   | Filter with value lists
-//	?col=is.null      | Filter for null values
-//	?or=(a.eq.x,b.lt.y) | Combine filters with logical operators
+//	?limit=100           | Limit number of results (default: 100)
+//	?offset=0            | Pagination offset (default: 0)
+//	?col=eq.val          | Filter by column equality
+//	?col=gt.val          | Filter with greater than comparison
+//	?col=lt.val          | Filter with less than comparison
+//	?col=gte.val         | Filter with greater than or equal comparison
+//	?col=lte.val         | Filter with less than or equal comparison
+//	?col=like.val        | Filter with pattern matching
+//	?col=in.a,b,c        | Filter with value lists
+//	?col=is.null         | Filter for null values
+//	?or=(a.eq.x,b.lt.y)  | Combine filters with logical operators
+//	?col=cs.example,new  | contains        (@>)	The column contains all these values. JSON object can be passed with urlencoded string
+//	?col=cd.1,2,3.       | is contained in (<@)	The column’s values are all within this set
 //
 // HTTP headers control response format for POST/PATCH/DELETE operations:
 //

pkg/rest/query.go

@@ -100,10 +100,21 @@ func parseFilterParam(value string) []FilterParam {
 		"fts":   "@@",
 		"plfts": "@@",
 		"phfts": "@@",
+		"cs":    "@>",
+		"cd":    "<@",
+	}
+
+	// Skip split by comma if this is a containment operator
+	// https://www.postgresql.org/docs/current/datatype-json.html#JSON-CONTAINMENT
+	hasContainmentOperator := strings.HasPrefix(value, "cs.") || strings.HasPrefix(value, "cd.")
+
+	var orParts []string
+	if hasContainmentOperator {
+		orParts = []string{value}
+	} else {
+		orParts = strings.Split(value, ",")
 	}
 
-	// Split by commas for OR conditions
-	orParts := strings.Split(value, ",")
 	for _, orPart := range orParts {
 		// Default to equality if no operator is specified
 		operator := "="
@@ -126,6 +137,9 @@ func parseFilterParam(value string) []FilterParam {
 		} else if val == "null" && operator == "!=" {
 			operator = "IS NOT"
 			filterValue = nil
+		} else if operator == "@>" || operator == "<@" {
+			// Handle array/JSONB containment operators
+			filterValue = convertToPostgresArrayOrJSON(val)
 		} else {
 			filterValue = val
 		}

pkg/rest/util.go

@@ -0,0 +1,39 @@
+package rest
+
+import (
+	"fmt"
+	"strings"
+)
+
+func convertToPostgresArrayOrJSON(val string) string {
+	val = strings.TrimSpace(val)
+
+	// check if it's already JSON format (contains quotes around elements)
+	// e.g., {"NVMe"} or ["value"] or {"key": "value"}
+	if strings.Contains(val, "\"") || strings.HasPrefix(val, "[") {
+		// already JSON format, return as-is for JSONB columns
+		return val
+	}
+
+	// otherwise, treat as PostgREST array syntax {a,b,c}
+	// remove outer braces if present
+	if strings.HasPrefix(val, "{") && strings.HasSuffix(val, "}") {
+		val = val[1 : len(val)-1]
+	}
+
+	// split by comma and trim whitespace
+	parts := strings.Split(val, ",")
+	quotedParts := make([]string, 0, len(parts))
+	for _, part := range parts {
+		part = strings.TrimSpace(part)
+		if part != "" {
+			// escape any quotes in the value
+			part = strings.ReplaceAll(part, "\"", "\\\"")
+			quotedParts = append(quotedParts, fmt.Sprintf("\"%s\"", part))
+		}
+	}
+
+	// return as PostgreSQL array literal for array columns
+	// or JSONB array for JSONB columns
+	return fmt.Sprintf("{%s}", strings.Join(quotedParts, ","))
+}