Merge pull request #28 from linuxfoundation/andrest50/query-direct-fields

[LFXV2-924] Add direct field filtering support for data object queries

Author: andrest50

cmd/service/converters.go

@@ -5,7 +5,9 @@ package service
 
 import (
 	"context"
+	"fmt"
 	"log/slog"
+	"strings"
 
 	querysvc "github.com/linuxfoundation/lfx-v2-query-service/gen/query_svc"
 	"github.com/linuxfoundation/lfx-v2-query-service/internal/domain/model"
@@ -14,15 +16,48 @@ import (
 	"github.com/linuxfoundation/lfx-v2-query-service/pkg/paging"
 )
 
+// parseFilters parses filter strings in "field:value" format
+// All fields are automatically prefixed with "data." to filter only within the data object
+func parseFilters(filters []string) ([]model.FieldFilter, error) {
+	if len(filters) == 0 {
+		return nil, nil
+	}
+
+	parsed := make([]model.FieldFilter, 0, len(filters))
+	for _, filter := range filters {
+		parts := strings.SplitN(filter, ":", 2)
+		if len(parts) != 2 {
+			return nil, fmt.Errorf("invalid filter format '%s': expected 'field:value'", filter)
+		}
+		fieldName := strings.TrimSpace(parts[0])
+		if fieldName == "" {
+			return nil, fmt.Errorf("invalid filter format '%s': field name cannot be empty", filter)
+		}
+		// Automatically prefix with "data." to ensure filtering only on data fields
+		parsed = append(parsed, model.FieldFilter{
+			Field: "data." + fieldName,
+			Value: strings.TrimSpace(parts[1]),
+		})
+	}
+	return parsed, nil
+}
+
 // payloadToCriteria converts the generated payload to domain search criteria
 func (s *querySvcsrvc) payloadToCriteria(ctx context.Context, p *querysvc.QueryResourcesPayload) (model.SearchCriteria, error) {
+	// Parse filters from "field:value" format
+	filters, err := parseFilters(p.Filters)
+	if err != nil {
+		slog.ErrorContext(ctx, "failed to parse filters", "error", err)
+		return model.SearchCriteria{}, wrapError(ctx, err)
+	}
 
 	criteria := model.SearchCriteria{
 		Name:         p.Name,
 		Parent:       p.Parent,
 		ResourceType: p.Type,
 		Tags:         p.Tags,
 		TagsAll:      p.TagsAll,
+		Filters:      filters,
 		CelFilter:    p.CelFilter,
 		SortBy:       p.Sort,
 		PageToken:    p.PageToken,
@@ -81,7 +116,7 @@ func (s *querySvcsrvc) domainResultToResponse(result *model.SearchResult) *query
 	return response
 }
 
-func (s *querySvcsrvc) payloadToCountPublicCriteria(payload *querysvc.QueryResourcesCountPayload) model.SearchCriteria {
+func (s *querySvcsrvc) payloadToCountPublicCriteria(payload *querysvc.QueryResourcesCountPayload) (model.SearchCriteria, error) {
 	// Parameters used for /<index>/_count search.
 	criteria := model.SearchCriteria{
 		GroupBySize: constants.DefaultBucketSize,
@@ -91,9 +126,16 @@ func (s *querySvcsrvc) payloadToCountPublicCriteria(payload *querysvc.QueryResou
 		PublicOnly: true,
 	}
 
+	// Parse filters from "field:value" format
+	filters, err := parseFilters(payload.Filters)
+	if err != nil {
+		return criteria, fmt.Errorf("invalid filters: %w", err)
+	}
+
 	// Set the criteria from the payload
 	criteria.Tags = payload.Tags
 	criteria.TagsAll = payload.TagsAll
+	criteria.Filters = filters
 	if payload.Name != nil {
 		criteria.Name = payload.Name
 	}
@@ -104,10 +146,10 @@ func (s *querySvcsrvc) payloadToCountPublicCriteria(payload *querysvc.QueryResou
 		criteria.ParentRef = payload.Parent
 	}
 
-	return criteria
+	return criteria, nil
 }
 
-func (s *querySvcsrvc) payloadToCountAggregationCriteria(payload *querysvc.QueryResourcesCountPayload) model.SearchCriteria {
+func (s *querySvcsrvc) payloadToCountAggregationCriteria(payload *querysvc.QueryResourcesCountPayload) (model.SearchCriteria, error) {
 	// Parameters used for the "group by" aggregated /<index>/_search search.
 	criteria := model.SearchCriteria{
 		GroupBySize: constants.DefaultBucketSize,
@@ -120,9 +162,16 @@ func (s *querySvcsrvc) payloadToCountAggregationCriteria(payload *querysvc.Query
 		GroupBy: "access_check_query.keyword",
 	}
 
+	// Parse filters from "field:value" format
+	filters, err := parseFilters(payload.Filters)
+	if err != nil {
+		return criteria, fmt.Errorf("invalid filters: %w", err)
+	}
+
 	// Set the criteria from the payload
 	criteria.Tags = payload.Tags
 	criteria.TagsAll = payload.TagsAll
+	criteria.Filters = filters
 	if payload.Name != nil {
 		criteria.Name = payload.Name
 	}
@@ -133,7 +182,7 @@ func (s *querySvcsrvc) payloadToCountAggregationCriteria(payload *querysvc.Query
 		criteria.ParentRef = payload.Parent
 	}
 
-	return criteria
+	return criteria, nil
 }
 
 func (s *querySvcsrvc) domainCountResultToResponse(result *model.CountResult) *querysvc.QueryResourcesCountResult {

cmd/service/converters_test.go

@@ -590,6 +590,105 @@ func TestDomainOrganizationSuggestionsToResponse(t *testing.T) {
 	}
 }
 
+func TestParseFilters(t *testing.T) {
+	tests := []struct {
+		name           string
+		filters        []string
+		expected       []model.FieldFilter
+		expectedError  bool
+		errorSubstring string
+	}{
+		{
+			name:          "valid single filter - auto-prefixed with data",
+			filters:       []string{"status:active"},
+			expected:      []model.FieldFilter{{Field: "data.status", Value: "active"}},
+			expectedError: false,
+		},
+		{
+			name:    "valid multiple filters - auto-prefixed with data",
+			filters: []string{"status:active", "priority:high"},
+			expected: []model.FieldFilter{
+				{Field: "data.status", Value: "active"},
+				{Field: "data.priority", Value: "high"},
+			},
+			expectedError: false,
+		},
+		{
+			name:          "filter with spaces (trimmed and auto-prefixed)",
+			filters:       []string{" status : active "},
+			expected:      []model.FieldFilter{{Field: "data.status", Value: "active"}},
+			expectedError: false,
+		},
+		{
+			name:          "filter with colon in value",
+			filters:       []string{"url:https://example.com"},
+			expected:      []model.FieldFilter{{Field: "data.url", Value: "https://example.com"}},
+			expectedError: false,
+		},
+		{
+			name:           "invalid filter format (no colon)",
+			filters:        []string{"invalid"},
+			expected:       nil,
+			expectedError:  true,
+			errorSubstring: "invalid filter format",
+		},
+		{
+			name:           "invalid filter format (empty after colon)",
+			filters:        []string{"status:"},
+			expected:       []model.FieldFilter{{Field: "data.status", Value: ""}},
+			expectedError:  false,
+		},
+		{
+			name:           "invalid filter format (empty field name)",
+			filters:        []string{":value"},
+			expected:       nil,
+			expectedError:  true,
+			errorSubstring: "field name cannot be empty",
+		},
+		{
+			name:           "invalid filter format (whitespace-only field name)",
+			filters:        []string{"  :value"},
+			expected:       nil,
+			expectedError:  true,
+			errorSubstring: "field name cannot be empty",
+		},
+		{
+			name:          "empty filters array",
+			filters:       []string{},
+			expected:      nil,
+			expectedError: false,
+		},
+		{
+			name:          "nil filters",
+			filters:       nil,
+			expected:      nil,
+			expectedError: false,
+		},
+		{
+			name:          "nested field name (auto-prefixed)",
+			filters:       []string{"project.id:123"},
+			expected:      []model.FieldFilter{{Field: "data.project.id", Value: "123"}},
+			expectedError: false,
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			result, err := parseFilters(tc.filters)
+
+			if tc.expectedError {
+				assert.Error(t, err)
+				if tc.errorSubstring != "" {
+					assert.Contains(t, err.Error(), tc.errorSubstring)
+				}
+			} else {
+				assert.NoError(t, err)
+				assert.Equal(t, tc.expected, result)
+			}
+		})
+	}
+}
+
 // Helper function to create string pointers
 func stringPtr(s string) *string {
 	return &s

cmd/service/service.go

@@ -76,8 +76,14 @@ func (s *querySvcsrvc) QueryResourcesCount(ctx context.Context, p *querysvc.Quer
 	)
 
 	// Convert payload to domain criteria
-	countCriteria := s.payloadToCountPublicCriteria(p)
-	aggregationCriteria := s.payloadToCountAggregationCriteria(p)
+	countCriteria, errCountCriteria := s.payloadToCountPublicCriteria(p)
+	if errCountCriteria != nil {
+		return nil, wrapError(ctx, errCountCriteria)
+	}
+	aggregationCriteria, errAggCriteria := s.payloadToCountAggregationCriteria(p)
+	if errAggCriteria != nil {
+		return nil, wrapError(ctx, errAggCriteria)
+	}
 
 	// Execute search using the service layer
 	result, errQueryResources := s.resourceService.QueryResourcesCount(ctx, countCriteria, aggregationCriteria)

design/query-svc.go

@@ -56,6 +56,9 @@ var _ = dsl.Service("query-svc", func() {
 			dsl.Attribute("tags_all", dsl.ArrayOf(dsl.String), "Tags to search with AND logic - matches resources that have all of these tags", func() {
 				dsl.Example([]string{"governance", "security"})
 			})
+			dsl.Attribute("filters", dsl.ArrayOf(dsl.String), "Direct field filters with term clauses on data fields - format: 'field:value' (e.g., 'status:active'). Fields are automatically prefixed with 'data.'", func() {
+				dsl.Example([]string{"status:active", "priority:high"})
+			})
 			dsl.Attribute("cel_filter", dsl.String, "CEL expression to filter results on resource data fields. Available variables: data (map), resource_type (string), id (string)", func() {
 				dsl.Example(`data.slug == "tlf"`)
 				dsl.MaxLength(1000)
@@ -82,6 +85,7 @@ var _ = dsl.Service("query-svc", func() {
 			dsl.Param("type")
 			dsl.Param("tags")
 			dsl.Param("tags_all")
+			dsl.Param("filters")
 			dsl.Param("cel_filter")
 			dsl.Param("sort")
 			dsl.Param("page_token")
@@ -125,6 +129,9 @@ var _ = dsl.Service("query-svc", func() {
 			dsl.Attribute("tags_all", dsl.ArrayOf(dsl.String), "Tags to search with AND logic - matches resources that have all of these tags", func() {
 				dsl.Example([]string{"governance", "security"})
 			})
+			dsl.Attribute("filters", dsl.ArrayOf(dsl.String), "Direct field filters with term clauses on data fields - format: 'field:value' (e.g., 'status:active'). Fields are automatically prefixed with 'data.'", func() {
+				dsl.Example([]string{"status:active", "priority:high"})
+			})
 			dsl.Required("bearer_token", "version")
 		})
 
@@ -149,6 +156,7 @@ var _ = dsl.Service("query-svc", func() {
 			dsl.Param("type")
 			dsl.Param("tags")
 			dsl.Param("tags_all")
+			dsl.Param("filters")
 			dsl.Header("bearer_token:Authorization")
 			dsl.Response(dsl.StatusOK, func() {
 				dsl.Header("cache_control:Cache-Control")