feat: add support for contains_any() and contains_all(), (Resolves #82)

Author: steve-r-west

README.md

@@ -142,7 +142,7 @@ By default, when using validation in this library, it will cap the complexity of
 For example if you were searching for (a=1 OR b=2) AND (c=3 OR d=4 OR e=5), we compute that there might be 6 index intersections needed, (a=1,c=3),(a=1,d=4),(a=1,e=5),... This provides a heuristic to cap costs and prevent 
 runaway queries from being generated. It was actually intended that we look at the number of index scans needed, and maybe that's a closer measure to expense in the DB, but the math would only be slightly different.
 
-Over time this value and argument might change as we get more experience, in the interm you can use 0 as a value to allow everything (say if the collection is small).
+Over time this value and argument might change as we get more experience, in the interim you can use 0 as a value to allow everything (say if the collection is small).
 
 #### Regular Expressions
 

external/epsearchast/v3/ast.go

@@ -122,6 +122,8 @@ type AstVisitor interface {
 	VisitLike(astNode *AstNode) (bool, error)
 	VisitILike(astNode *AstNode) (bool, error)
 	VisitContains(astNode *AstNode) (bool, error)
+	VisitContainsAny(astNode *AstNode) (bool, error)
+	VisitContainsAll(astNode *AstNode) (bool, error)
 	VisitText(astNode *AstNode) (bool, error)
 	VisitIsNull(astNode *AstNode) (bool, error)
 }
@@ -171,6 +173,10 @@ func (a *AstNode) accept(v AstVisitor) error {
 		descend, err = v.VisitILike(a)
 	case "CONTAINS":
 		descend, err = v.VisitContains(a)
+	case "CONTAINS_ANY":
+		descend, err = v.VisitContainsAny(a)
+	case "CONTAINS_ALL":
+		descend, err = v.VisitContainsAll(a)
 	case "TEXT":
 		descend, err = v.VisitText(a)
 	case "IS_NULL":
@@ -232,7 +238,7 @@ func (a *AstNode) checkValid() error {
 		if len(a.Children) < 2 {
 			return fmt.Errorf("or should have at least two children")
 		}
-	case "IN":
+	case "IN", "CONTAINS_ANY", "CONTAINS_ALL":
 		if len(a.Children) > 0 {
 			return fmt.Errorf("operator %v should not have any children", strings.ToLower(a.NodeType))
 		}

external/epsearchast/v3/ast_test.go

@@ -217,6 +217,40 @@ func TestValidObjectWithContainsReturnsAst(t *testing.T) {
 	require.NotNil(t, astNode)
 }
 
+func TestValidObjectWithContainsAnyReturnsAst(t *testing.T) {
+	// Fixture Setup
+	// language=JSON
+	jsonTxt := `
+{
+	"type": "CONTAINS_ANY",
+	"args": [ "status",  "paid", "pending", "failed"]
+}
+`
+	// Execute SUT
+	astNode, err := GetAst(jsonTxt)
+
+	// Verify
+	require.NoError(t, err)
+	require.NotNil(t, astNode)
+}
+
+func TestValidObjectWithContainsAllReturnsAst(t *testing.T) {
+	// Fixture Setup
+	// language=JSON
+	jsonTxt := `
+{
+	"type": "CONTAINS_ALL",
+	"args": [ "tags",  "important", "urgent"]
+}
+`
+	// Execute SUT
+	astNode, err := GetAst(jsonTxt)
+
+	// Verify
+	require.NoError(t, err)
+	require.NotNil(t, astNode)
+}
+
 func TestValidObjectWithTextReturnsAst(t *testing.T) {
 	// Fixture Setup
 	// language=JSON

external/epsearchast/v3/ast_visitor_test.go

@@ -218,6 +218,66 @@ func TestPreAndPostAndInCalledOnAccept(t *testing.T) {
 
 }
 
+func TestPreAndPostAndContainsAnyCalledOnAccept(t *testing.T) {
+	// Fixture Setup
+	// language=JSON
+	jsonTxt := `
+{
+	"type": "CONTAINS_ANY",
+	"args": [
+		"tags",
+		"important",
+		"urgent"
+	]
+}
+`
+
+	mockObj := new(MyMockedVisitor)
+	mockObj.On("PreVisit").Return(nil).
+		On("PostVisit").Return(nil).
+		On("VisitContainsAny", mock.Anything).Return(true, nil)
+
+	astNode, err := GetAst(jsonTxt)
+	require.NoError(t, err)
+
+	// Execute SUT
+	err = astNode.Accept(mockObj)
+
+	// Verification
+	require.NoError(t, err)
+
+}
+
+func TestPreAndPostAndContainsAllCalledOnAccept(t *testing.T) {
+	// Fixture Setup
+	// language=JSON
+	jsonTxt := `
+{
+	"type": "CONTAINS_ALL",
+	"args": [
+		"tags",
+		"important",
+		"urgent"
+	]
+}
+`
+
+	mockObj := new(MyMockedVisitor)
+	mockObj.On("PreVisit").Return(nil).
+		On("PostVisit").Return(nil).
+		On("VisitContainsAll", mock.Anything).Return(true, nil)
+
+	astNode, err := GetAst(jsonTxt)
+	require.NoError(t, err)
+
+	// Execute SUT
+	err = astNode.Accept(mockObj)
+
+	// Verification
+	require.NoError(t, err)
+
+}
+
 func TestPreOnAcceptWithError(t *testing.T) {
 	// Fixture Setup
 	// language=JSON
@@ -808,6 +868,16 @@ func (m *MyMockedVisitor) VisitContains(astNode *AstNode) (bool, error) {
 	return args.Bool(0), args.Error(1)
 }
 
+func (m *MyMockedVisitor) VisitContainsAny(astNode *AstNode) (bool, error) {
+	args := m.Called(astNode)
+	return args.Bool(0), args.Error(1)
+}
+
+func (m *MyMockedVisitor) VisitContainsAll(astNode *AstNode) (bool, error) {
+	args := m.Called(astNode)
+	return args.Bool(0), args.Error(1)
+}
+
 func (m *MyMockedVisitor) VisitText(astNode *AstNode) (bool, error) {
 	args := m.Called(astNode)
 	return args.Bool(0), args.Error(1)

external/epsearchast/v3/es/es_query_builder.go

@@ -208,6 +208,33 @@ func (d DefaultEsQueryBuilder) VisitContains(first, second string) (*JsonObject,
 	return d.buildQueryWithBuilder(b, first, second)
 }
 
+func (d DefaultEsQueryBuilder) VisitContainsAny(args ...string) (*JsonObject, error) {
+	b := d.GetTermsQueryBuilderForArrayField()
+
+	return d.buildQueryWithBuilder(b, args...)
+}
+
+func (d DefaultEsQueryBuilder) VisitContainsAll(args ...string) (*JsonObject, error) {
+	// Build individual term queries for each value
+	b := d.GetTermQueryBuilderForArrayField()
+
+	var termQueries []*JsonObject
+	for _, value := range args[1:] {
+		query, err := d.buildQueryWithBuilder(b, args[0], value)
+		if err != nil {
+			return nil, err
+		}
+		termQueries = append(termQueries, query)
+	}
+
+	// Wrap in a bool query with must clause
+	return &JsonObject{
+		"bool": map[string]any{
+			"must": termQueries,
+		},
+	}, nil
+}
+
 func (d DefaultEsQueryBuilder) GetTermQueryBuilderForArrayField() func(args ...string) *JsonObject {
 	return func(args ...string) *JsonObject {
 		return &JsonObject{
@@ -218,6 +245,16 @@ func (d DefaultEsQueryBuilder) GetTermQueryBuilderForArrayField() func(args ...s
 	}
 }
 
+func (d DefaultEsQueryBuilder) GetTermsQueryBuilderForArrayField() func(args ...string) *JsonObject {
+	return func(args ...string) *JsonObject {
+		return &JsonObject{
+			"terms": map[string]any{
+				d.GetFieldMapping(args[0]).Array: args[1:],
+			},
+		}
+	}
+}
+
 func (d DefaultEsQueryBuilder) VisitText(first, second string) (*JsonObject, error) {
 	b := d.BuildMatchBoolPrefixQuery()
 

external/epsearchast/v3/es/es_query_builder_int_test.go

@@ -935,6 +935,94 @@ func TestSmokeTestElasticSearchWithFilters(t *testing.T) {
 					}`,
 			count: 1,
 		},
+		{
+			//language=JSON
+			filter: `{
+						"type": "CONTAINS_ANY",
+						"args": ["array_field", "a", "c"]
+					}`,
+			count: 3,
+		},
+		{
+			//language=JSON
+			filter: `{
+						"type": "CONTAINS_ANY",
+						"args": ["array_field", "a", "d"]
+					}`,
+			count: 2,
+		},
+		{
+			//language=JSON
+			filter: `{
+						"type": "CONTAINS_ANY",
+						"args": ["array_field", "z"]
+					}`,
+			count: 0,
+		},
+		{
+			//language=JSON
+			filter: `{
+						"type": "CONTAINS_ALL",
+						"args": ["array_field", "a", "b"]
+					}`,
+			count: 1,
+		},
+		{
+			//language=JSON
+			filter: `{
+						"type": "CONTAINS_ALL",
+						"args": ["array_field", "c"]
+					}`,
+			count: 2,
+		},
+		{
+			//language=JSON
+			filter: `{
+						"type": "CONTAINS_ALL",
+						"args": ["array_field", "c", "d"]
+					}`,
+			count: 1,
+		},
+		{
+			//language=JSON
+			filter: `{
+						"type": "CONTAINS_ALL",
+						"args": ["array_field", "d", "c"]
+					}`,
+			count: 1,
+		},
+		{
+			//language=JSON
+			filter: `{
+						"type": "CONTAINS_ALL",
+						"args": ["array_field", "a", "c"]
+					}`,
+			count: 0,
+		},
+		{
+			//language=JSON
+			filter: `{
+						"type": "CONTAINS_ANY",
+						"args": ["array_field", "d", "a"]
+					}`,
+			count: 2,
+		},
+		{
+			//language=JSON
+			filter: `{
+						"type": "CONTAINS_ANY",
+						"args": ["array_field", "a", "b", "c"]
+					}`,
+			count: 3,
+		},
+		{
+			//language=JSON
+			filter: `{
+						"type": "CONTAINS_ALL",
+						"args": ["array_field", "a", "b", "c"]
+					}`,
+			count: 0,
+		},
 	}
 
 	for _, tc := range testCases {

external/epsearchast/v3/gorm/gorm_query_builder.go

@@ -3,6 +3,7 @@ package epsearchast_v3_gorm
 import (
 	"fmt"
 	epsearchast_v3 "github.com/elasticpath/epcc-search-ast-helper/external/epsearchast/v3"
+	"github.com/lib/pq"
 	"strings"
 )
 
@@ -114,6 +115,20 @@ func (g DefaultGormQueryBuilder) VisitContains(first, second string) (*SubQuery,
 	}, nil
 }
 
+func (g DefaultGormQueryBuilder) VisitContainsAny(args ...string) (*SubQuery, error) {
+	return &SubQuery{
+		Clause: fmt.Sprintf("%s && ?", args[0]),
+		Args:   []interface{}{pq.Array(args[1:])},
+	}, nil
+}
+
+func (g DefaultGormQueryBuilder) VisitContainsAll(args ...string) (*SubQuery, error) {
+	return &SubQuery{
+		Clause: fmt.Sprintf("%s @> ?", args[0]),
+		Args:   []interface{}{pq.Array(args[1:])},
+	}, nil
+}
+
 func (g DefaultGormQueryBuilder) VisitText(first, second string) (*SubQuery, error) {
 	return &SubQuery{
 		Clause: fmt.Sprintf("to_tsvector('english', %s) @@ plainto_tsquery('english', ?)", first),