mirror of
https://github.com/bitechdev/ResolveSpec.git
synced 2026-01-15 15:34:25 +00:00
Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
24a7ef7284 | ||
|
|
b87841a51c |
@@ -166,6 +166,14 @@ func SanitizeWhereClause(where string, tableName string, options ...*RequestOpti
|
||||
logger.Debug("Added preload relation '%s' as allowed table prefix", options[0].Preload[pi].Relation)
|
||||
}
|
||||
}
|
||||
|
||||
// Add join aliases as allowed prefixes
|
||||
for _, alias := range options[0].JoinAliases {
|
||||
if alias != "" {
|
||||
allowedPrefixes[alias] = true
|
||||
logger.Debug("Added join alias '%s' as allowed table prefix", alias)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Split by AND to handle multiple conditions
|
||||
|
||||
@@ -23,6 +23,10 @@ type RequestOptions struct {
|
||||
CursorForward string `json:"cursor_forward"`
|
||||
CursorBackward string `json:"cursor_backward"`
|
||||
FetchRowNumber *string `json:"fetch_row_number"`
|
||||
|
||||
// Join table aliases (used for validation of prefixed columns in filters/sorts)
|
||||
// Not serialized to JSON as it's internal validation state
|
||||
JoinAliases []string `json:"-"`
|
||||
}
|
||||
|
||||
type Parameter struct {
|
||||
|
||||
@@ -214,14 +214,46 @@ x-expand: department:id,name,code
|
||||
**Note:** Currently, expand falls back to preload behavior. Full JOIN expansion is planned for future implementation.
|
||||
|
||||
#### `x-custom-sql-join`
|
||||
Raw SQL JOIN statement.
|
||||
Custom SQL JOIN clauses for joining tables in queries.
|
||||
|
||||
**Format:** SQL JOIN clause
|
||||
**Format:** SQL JOIN clause or multiple clauses separated by `|`
|
||||
|
||||
**Single JOIN:**
|
||||
```
|
||||
x-custom-sql-join: LEFT JOIN departments d ON d.id = employees.department_id
|
||||
```
|
||||
|
||||
⚠️ **Note:** Not yet fully implemented.
|
||||
**Multiple JOINs:**
|
||||
```
|
||||
x-custom-sql-join: LEFT JOIN departments d ON d.id = e.dept_id | INNER JOIN roles r ON r.id = e.role_id
|
||||
```
|
||||
|
||||
**Features:**
|
||||
- Supports any type of JOIN (INNER, LEFT, RIGHT, FULL, CROSS)
|
||||
- Multiple JOINs can be specified using the pipe `|` separator
|
||||
- JOINs are sanitized for security
|
||||
- Can be specified via headers or query parameters
|
||||
- **Table aliases are automatically extracted and allowed for filtering and sorting**
|
||||
|
||||
**Using Join Aliases in Filters and Sorts:**
|
||||
|
||||
When you specify a custom SQL join with an alias, you can use that alias in your filter and sort parameters:
|
||||
|
||||
```
|
||||
# Join with alias
|
||||
x-custom-sql-join: LEFT JOIN departments d ON d.id = employees.department_id
|
||||
|
||||
# Sort by joined table column
|
||||
x-sort: d.name,employees.id
|
||||
|
||||
# Filter by joined table column
|
||||
x-searchop-eq-d.name: Engineering
|
||||
```
|
||||
|
||||
The system automatically:
|
||||
1. Extracts the alias from the JOIN clause (e.g., `d` from `departments d`)
|
||||
2. Validates that prefixed columns (like `d.name`) refer to valid join aliases
|
||||
3. Allows these prefixed columns in filters and sorts
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -26,6 +26,7 @@ type queryCacheKey struct {
|
||||
Sort []common.SortOption `json:"sort"`
|
||||
CustomSQLWhere string `json:"custom_sql_where,omitempty"`
|
||||
CustomSQLOr string `json:"custom_sql_or,omitempty"`
|
||||
CustomSQLJoin []string `json:"custom_sql_join,omitempty"`
|
||||
Expand []expandOptionKey `json:"expand,omitempty"`
|
||||
Distinct bool `json:"distinct,omitempty"`
|
||||
CursorForward string `json:"cursor_forward,omitempty"`
|
||||
@@ -40,7 +41,7 @@ type cachedTotal struct {
|
||||
// buildExtendedQueryCacheKey builds a cache key for extended query options (restheadspec)
|
||||
// Includes expand, distinct, and cursor pagination options
|
||||
func buildExtendedQueryCacheKey(tableName string, filters []common.FilterOption, sort []common.SortOption,
|
||||
customWhere, customOr string, expandOpts []interface{}, distinct bool, cursorFwd, cursorBwd string) string {
|
||||
customWhere, customOr string, customJoin []string, expandOpts []interface{}, distinct bool, cursorFwd, cursorBwd string) string {
|
||||
|
||||
key := queryCacheKey{
|
||||
TableName: tableName,
|
||||
@@ -48,6 +49,7 @@ func buildExtendedQueryCacheKey(tableName string, filters []common.FilterOption,
|
||||
Sort: sort,
|
||||
CustomSQLWhere: customWhere,
|
||||
CustomSQLOr: customOr,
|
||||
CustomSQLJoin: customJoin,
|
||||
Distinct: distinct,
|
||||
CursorForward: cursorFwd,
|
||||
CursorBackward: cursorBwd,
|
||||
@@ -75,8 +77,8 @@ func buildExtendedQueryCacheKey(tableName string, filters []common.FilterOption,
|
||||
jsonData, err := json.Marshal(key)
|
||||
if err != nil {
|
||||
// Fallback to simple string concatenation if JSON fails
|
||||
return hashString(fmt.Sprintf("%s_%v_%v_%s_%s_%v_%v_%s_%s",
|
||||
tableName, filters, sort, customWhere, customOr, expandOpts, distinct, cursorFwd, cursorBwd))
|
||||
return hashString(fmt.Sprintf("%s_%v_%v_%s_%s_%v_%v_%v_%s_%s",
|
||||
tableName, filters, sort, customWhere, customOr, customJoin, expandOpts, distinct, cursorFwd, cursorBwd))
|
||||
}
|
||||
|
||||
return hashString(string(jsonData))
|
||||
|
||||
@@ -502,6 +502,15 @@ func (h *Handler) handleRead(ctx context.Context, w common.ResponseWriter, id st
|
||||
}
|
||||
}
|
||||
|
||||
// Apply custom SQL JOIN clauses
|
||||
if len(options.CustomSQLJoin) > 0 {
|
||||
for _, joinClause := range options.CustomSQLJoin {
|
||||
logger.Debug("Applying custom SQL JOIN: %s", joinClause)
|
||||
// Joins are already sanitized during parsing, so we can apply them directly
|
||||
query = query.Join(joinClause)
|
||||
}
|
||||
}
|
||||
|
||||
// If ID is provided, filter by ID
|
||||
if id != "" {
|
||||
pkName := reflection.GetPrimaryKeyName(model)
|
||||
@@ -552,6 +561,7 @@ func (h *Handler) handleRead(ctx context.Context, w common.ResponseWriter, id st
|
||||
options.Sort,
|
||||
options.CustomSQLWhere,
|
||||
options.CustomSQLOr,
|
||||
options.CustomSQLJoin,
|
||||
expandOpts,
|
||||
options.Distinct,
|
||||
options.CursorForward,
|
||||
|
||||
@@ -26,7 +26,9 @@ type ExtendedRequestOptions struct {
|
||||
CustomSQLOr string
|
||||
|
||||
// Joins
|
||||
Expand []ExpandOption
|
||||
Expand []ExpandOption
|
||||
CustomSQLJoin []string // Custom SQL JOIN clauses
|
||||
JoinAliases []string // Extracted table aliases from CustomSQLJoin for validation
|
||||
|
||||
// Advanced features
|
||||
AdvancedSQL map[string]string // Column -> SQL expression
|
||||
@@ -111,6 +113,7 @@ func (h *Handler) parseOptionsFromHeaders(r common.Request, model interface{}) E
|
||||
AdvancedSQL: make(map[string]string),
|
||||
ComputedQL: make(map[string]string),
|
||||
Expand: make([]ExpandOption, 0),
|
||||
CustomSQLJoin: make([]string, 0),
|
||||
ResponseFormat: "simple", // Default response format
|
||||
SingleRecordAsObject: true, // Default: normalize single-element arrays to objects
|
||||
}
|
||||
@@ -185,8 +188,7 @@ func (h *Handler) parseOptionsFromHeaders(r common.Request, model interface{}) E
|
||||
case strings.HasPrefix(key, "x-expand"):
|
||||
h.parseExpand(&options, decodedValue)
|
||||
case strings.HasPrefix(key, "x-custom-sql-join"):
|
||||
// TODO: Implement custom SQL join
|
||||
logger.Debug("Custom SQL join not yet implemented: %s", decodedValue)
|
||||
h.parseCustomSQLJoin(&options, decodedValue)
|
||||
|
||||
// Sorting & Pagination
|
||||
case strings.HasPrefix(key, "x-sort"):
|
||||
@@ -495,6 +497,101 @@ func (h *Handler) parseExpand(options *ExtendedRequestOptions, value string) {
|
||||
}
|
||||
}
|
||||
|
||||
// parseCustomSQLJoin parses x-custom-sql-join header
|
||||
// Format: Single JOIN clause or multiple JOIN clauses separated by |
|
||||
// Example: "LEFT JOIN departments d ON d.id = employees.department_id"
|
||||
// Example: "LEFT JOIN departments d ON d.id = e.dept_id | INNER JOIN roles r ON r.id = e.role_id"
|
||||
func (h *Handler) parseCustomSQLJoin(options *ExtendedRequestOptions, value string) {
|
||||
if value == "" {
|
||||
return
|
||||
}
|
||||
|
||||
// Split by | for multiple joins
|
||||
joins := strings.Split(value, "|")
|
||||
for _, joinStr := range joins {
|
||||
joinStr = strings.TrimSpace(joinStr)
|
||||
if joinStr == "" {
|
||||
continue
|
||||
}
|
||||
|
||||
// Basic validation: should contain "JOIN" keyword
|
||||
upperJoin := strings.ToUpper(joinStr)
|
||||
if !strings.Contains(upperJoin, "JOIN") {
|
||||
logger.Warn("Invalid custom SQL join (missing JOIN keyword): %s", joinStr)
|
||||
continue
|
||||
}
|
||||
|
||||
// Sanitize the join clause using common.SanitizeWhereClause
|
||||
// Note: This is basic sanitization - in production you may want stricter validation
|
||||
sanitizedJoin := common.SanitizeWhereClause(joinStr, "", nil)
|
||||
if sanitizedJoin == "" {
|
||||
logger.Warn("Custom SQL join failed sanitization: %s", joinStr)
|
||||
continue
|
||||
}
|
||||
|
||||
// Extract table alias from the JOIN clause
|
||||
alias := extractJoinAlias(sanitizedJoin)
|
||||
if alias != "" {
|
||||
options.JoinAliases = append(options.JoinAliases, alias)
|
||||
// Also add to the embedded RequestOptions for validation
|
||||
options.RequestOptions.JoinAliases = append(options.RequestOptions.JoinAliases, alias)
|
||||
logger.Debug("Extracted join alias: %s", alias)
|
||||
}
|
||||
|
||||
logger.Debug("Adding custom SQL join: %s", sanitizedJoin)
|
||||
options.CustomSQLJoin = append(options.CustomSQLJoin, sanitizedJoin)
|
||||
}
|
||||
}
|
||||
|
||||
// extractJoinAlias extracts the table alias from a JOIN clause
|
||||
// Examples:
|
||||
// - "LEFT JOIN departments d ON ..." -> "d"
|
||||
// - "INNER JOIN users AS u ON ..." -> "u"
|
||||
// - "JOIN roles r ON ..." -> "r"
|
||||
func extractJoinAlias(joinClause string) string {
|
||||
// Pattern: JOIN table_name [AS] alias ON ...
|
||||
// We need to extract the alias (word before ON)
|
||||
|
||||
upperJoin := strings.ToUpper(joinClause)
|
||||
|
||||
// Find the "JOIN" keyword position
|
||||
joinIdx := strings.Index(upperJoin, "JOIN")
|
||||
if joinIdx == -1 {
|
||||
return ""
|
||||
}
|
||||
|
||||
// Find the "ON" keyword position
|
||||
onIdx := strings.Index(upperJoin, " ON ")
|
||||
if onIdx == -1 {
|
||||
return ""
|
||||
}
|
||||
|
||||
// Extract the part between JOIN and ON
|
||||
betweenJoinAndOn := strings.TrimSpace(joinClause[joinIdx+4 : onIdx])
|
||||
|
||||
// Split by spaces to get words
|
||||
words := strings.Fields(betweenJoinAndOn)
|
||||
if len(words) == 0 {
|
||||
return ""
|
||||
}
|
||||
|
||||
// If there's an AS keyword, the alias is after it
|
||||
for i, word := range words {
|
||||
if strings.EqualFold(word, "AS") && i+1 < len(words) {
|
||||
return words[i+1]
|
||||
}
|
||||
}
|
||||
|
||||
// Otherwise, the alias is the last word (if there are 2+ words)
|
||||
// Format: "table_name alias" or just "table_name"
|
||||
if len(words) >= 2 {
|
||||
return words[len(words)-1]
|
||||
}
|
||||
|
||||
// Only one word means it's just the table name, no alias
|
||||
return ""
|
||||
}
|
||||
|
||||
// parseSorting parses x-sort header
|
||||
// Format: +field1,-field2,field3 (+ for ASC, - for DESC, default ASC)
|
||||
func (h *Handler) parseSorting(options *ExtendedRequestOptions, value string) {
|
||||
|
||||
@@ -301,6 +301,163 @@ func TestParseOptionsFromQueryParams(t *testing.T) {
|
||||
}
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "Parse custom SQL JOIN from query params",
|
||||
queryParams: map[string]string{
|
||||
"x-custom-sql-join": `LEFT JOIN departments d ON d.id = employees.department_id`,
|
||||
},
|
||||
validate: func(t *testing.T, options ExtendedRequestOptions) {
|
||||
if len(options.CustomSQLJoin) == 0 {
|
||||
t.Error("Expected CustomSQLJoin to be set")
|
||||
return
|
||||
}
|
||||
if len(options.CustomSQLJoin) != 1 {
|
||||
t.Errorf("Expected 1 custom SQL join, got %d", len(options.CustomSQLJoin))
|
||||
return
|
||||
}
|
||||
expected := `LEFT JOIN departments d ON d.id = employees.department_id`
|
||||
if options.CustomSQLJoin[0] != expected {
|
||||
t.Errorf("Expected CustomSQLJoin[0]=%q, got %q", expected, options.CustomSQLJoin[0])
|
||||
}
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "Parse multiple custom SQL JOINs from query params",
|
||||
queryParams: map[string]string{
|
||||
"x-custom-sql-join": `LEFT JOIN departments d ON d.id = e.dept_id | INNER JOIN roles r ON r.id = e.role_id`,
|
||||
},
|
||||
validate: func(t *testing.T, options ExtendedRequestOptions) {
|
||||
if len(options.CustomSQLJoin) != 2 {
|
||||
t.Errorf("Expected 2 custom SQL joins, got %d", len(options.CustomSQLJoin))
|
||||
return
|
||||
}
|
||||
expected1 := `LEFT JOIN departments d ON d.id = e.dept_id`
|
||||
expected2 := `INNER JOIN roles r ON r.id = e.role_id`
|
||||
if options.CustomSQLJoin[0] != expected1 {
|
||||
t.Errorf("Expected CustomSQLJoin[0]=%q, got %q", expected1, options.CustomSQLJoin[0])
|
||||
}
|
||||
if options.CustomSQLJoin[1] != expected2 {
|
||||
t.Errorf("Expected CustomSQLJoin[1]=%q, got %q", expected2, options.CustomSQLJoin[1])
|
||||
}
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "Parse custom SQL JOIN from headers",
|
||||
headers: map[string]string{
|
||||
"X-Custom-SQL-Join": `LEFT JOIN users u ON u.id = posts.user_id`,
|
||||
},
|
||||
validate: func(t *testing.T, options ExtendedRequestOptions) {
|
||||
if len(options.CustomSQLJoin) == 0 {
|
||||
t.Error("Expected CustomSQLJoin to be set from header")
|
||||
return
|
||||
}
|
||||
expected := `LEFT JOIN users u ON u.id = posts.user_id`
|
||||
if options.CustomSQLJoin[0] != expected {
|
||||
t.Errorf("Expected CustomSQLJoin[0]=%q, got %q", expected, options.CustomSQLJoin[0])
|
||||
}
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "Extract aliases from custom SQL JOIN",
|
||||
queryParams: map[string]string{
|
||||
"x-custom-sql-join": `LEFT JOIN departments d ON d.id = employees.department_id`,
|
||||
},
|
||||
validate: func(t *testing.T, options ExtendedRequestOptions) {
|
||||
if len(options.JoinAliases) == 0 {
|
||||
t.Error("Expected JoinAliases to be extracted")
|
||||
return
|
||||
}
|
||||
if len(options.JoinAliases) != 1 {
|
||||
t.Errorf("Expected 1 join alias, got %d", len(options.JoinAliases))
|
||||
return
|
||||
}
|
||||
if options.JoinAliases[0] != "d" {
|
||||
t.Errorf("Expected join alias 'd', got %q", options.JoinAliases[0])
|
||||
}
|
||||
// Also check that it's in the embedded RequestOptions
|
||||
if len(options.RequestOptions.JoinAliases) != 1 || options.RequestOptions.JoinAliases[0] != "d" {
|
||||
t.Error("Expected join alias to also be in RequestOptions.JoinAliases")
|
||||
}
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "Extract multiple aliases from multiple custom SQL JOINs",
|
||||
queryParams: map[string]string{
|
||||
"x-custom-sql-join": `LEFT JOIN departments d ON d.id = e.dept_id | INNER JOIN roles AS r ON r.id = e.role_id`,
|
||||
},
|
||||
validate: func(t *testing.T, options ExtendedRequestOptions) {
|
||||
if len(options.JoinAliases) != 2 {
|
||||
t.Errorf("Expected 2 join aliases, got %d", len(options.JoinAliases))
|
||||
return
|
||||
}
|
||||
expectedAliases := []string{"d", "r"}
|
||||
for i, expected := range expectedAliases {
|
||||
if options.JoinAliases[i] != expected {
|
||||
t.Errorf("Expected join alias[%d]=%q, got %q", i, expected, options.JoinAliases[i])
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "Custom JOIN with sort on joined table",
|
||||
queryParams: map[string]string{
|
||||
"x-custom-sql-join": `LEFT JOIN departments d ON d.id = employees.department_id`,
|
||||
"x-sort": "d.name,employees.id",
|
||||
},
|
||||
validate: func(t *testing.T, options ExtendedRequestOptions) {
|
||||
// Verify join was added
|
||||
if len(options.CustomSQLJoin) != 1 {
|
||||
t.Errorf("Expected 1 custom SQL join, got %d", len(options.CustomSQLJoin))
|
||||
return
|
||||
}
|
||||
// Verify alias was extracted
|
||||
if len(options.JoinAliases) != 1 || options.JoinAliases[0] != "d" {
|
||||
t.Error("Expected join alias 'd' to be extracted")
|
||||
return
|
||||
}
|
||||
// Verify sort was parsed
|
||||
if len(options.Sort) != 2 {
|
||||
t.Errorf("Expected 2 sort options, got %d", len(options.Sort))
|
||||
return
|
||||
}
|
||||
if options.Sort[0].Column != "d.name" {
|
||||
t.Errorf("Expected first sort column 'd.name', got %q", options.Sort[0].Column)
|
||||
}
|
||||
if options.Sort[1].Column != "employees.id" {
|
||||
t.Errorf("Expected second sort column 'employees.id', got %q", options.Sort[1].Column)
|
||||
}
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "Custom JOIN with filter on joined table",
|
||||
queryParams: map[string]string{
|
||||
"x-custom-sql-join": `LEFT JOIN departments d ON d.id = employees.department_id`,
|
||||
"x-searchop-eq-d.name": "Engineering",
|
||||
},
|
||||
validate: func(t *testing.T, options ExtendedRequestOptions) {
|
||||
// Verify join was added
|
||||
if len(options.CustomSQLJoin) != 1 {
|
||||
t.Error("Expected 1 custom SQL join")
|
||||
return
|
||||
}
|
||||
// Verify alias was extracted
|
||||
if len(options.JoinAliases) != 1 || options.JoinAliases[0] != "d" {
|
||||
t.Error("Expected join alias 'd' to be extracted")
|
||||
return
|
||||
}
|
||||
// Verify filter was parsed
|
||||
if len(options.Filters) != 1 {
|
||||
t.Errorf("Expected 1 filter, got %d", len(options.Filters))
|
||||
return
|
||||
}
|
||||
if options.Filters[0].Column != "d.name" {
|
||||
t.Errorf("Expected filter column 'd.name', got %q", options.Filters[0].Column)
|
||||
}
|
||||
if options.Filters[0].Operator != "eq" {
|
||||
t.Errorf("Expected filter operator 'eq', got %q", options.Filters[0].Operator)
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
@@ -395,6 +552,55 @@ func TestHeadersAndQueryParamsCombined(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// TestCustomJoinAliasExtraction tests the extractJoinAlias helper function
|
||||
func TestCustomJoinAliasExtraction(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
join string
|
||||
expected string
|
||||
}{
|
||||
{
|
||||
name: "LEFT JOIN with alias",
|
||||
join: "LEFT JOIN departments d ON d.id = employees.department_id",
|
||||
expected: "d",
|
||||
},
|
||||
{
|
||||
name: "INNER JOIN with AS keyword",
|
||||
join: "INNER JOIN users AS u ON u.id = posts.user_id",
|
||||
expected: "u",
|
||||
},
|
||||
{
|
||||
name: "Simple JOIN with alias",
|
||||
join: "JOIN roles r ON r.id = user_roles.role_id",
|
||||
expected: "r",
|
||||
},
|
||||
{
|
||||
name: "JOIN without alias (just table name)",
|
||||
join: "JOIN departments ON departments.id = employees.dept_id",
|
||||
expected: "",
|
||||
},
|
||||
{
|
||||
name: "RIGHT JOIN with alias",
|
||||
join: "RIGHT JOIN orders o ON o.customer_id = customers.id",
|
||||
expected: "o",
|
||||
},
|
||||
{
|
||||
name: "FULL OUTER JOIN with AS",
|
||||
join: "FULL OUTER JOIN products AS p ON p.id = order_items.product_id",
|
||||
expected: "p",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
result := extractJoinAlias(tt.join)
|
||||
if result != tt.expected {
|
||||
t.Errorf("extractJoinAlias(%q) = %q, want %q", tt.join, result, tt.expected)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Helper function to check if a string contains a substring
|
||||
func contains(s, substr string) bool {
|
||||
return len(s) >= len(substr) && (s == substr || len(s) > len(substr) && containsHelper(s, substr))
|
||||
|
||||
@@ -32,6 +32,7 @@
|
||||
// - X-Clean-JSON: Boolean to remove null/empty fields
|
||||
// - X-Custom-SQL-Where: Custom SQL WHERE clause (AND)
|
||||
// - X-Custom-SQL-Or: Custom SQL WHERE clause (OR)
|
||||
// - X-Custom-SQL-Join: Custom SQL JOIN clauses (pipe-separated for multiple)
|
||||
//
|
||||
// # Usage Example
|
||||
//
|
||||
|
||||
Reference in New Issue
Block a user