#patch Allow unscoped filtering on all NamedEntity(Metadata) fields (flyteorg#124)

* allow unscoped filtering for all named entity/metadata fields

* add comment

* adding test for entity replacement

Author: schottra

pkg/common/entity.go

@@ -14,6 +14,7 @@ const (
 	Task                = "t"
 	TaskExecution       = "te"
 	Workflow            = "w"
+	NamedEntity         = "nen"
 	NamedEntityMetadata = "nem"
 )
 

pkg/common/filters.go

@@ -79,6 +79,11 @@ var executionIdentifierFields = map[string]bool{
 	"name":    true,
 }
 
+var entityMetadataFields = map[string]bool{
+	"description": true,
+	"state":       true,
+}
+
 const unrecognizedFilterFunction = "unrecognized filter function: %s"
 const unsupportedFilterExpression = "unsupported filter expression: %s"
 const invalidSingleValueFilter = "invalid single value filter expression: %s"
@@ -235,14 +240,24 @@ func customizeField(field string, entity Entity) string {
 	return field
 }
 
+func customizeEntity(field string, entity Entity) Entity {
+	// NamedEntity is considered a single object, but the metdata
+	// is stored using a different entity type.
+	if entity == NamedEntity && entityMetadataFields[field] {
+		return NamedEntityMetadata
+	}
+	return entity
+}
+
 // Returns a filter which uses a single argument value.
 func NewSingleValueFilter(entity Entity, function FilterExpression, field string, value interface{}) (InlineFilter, error) {
 	if _, ok := singleValueFilters[function]; !ok {
 		return nil, GetInvalidSingleValueFilterErr(function)
 	}
 	customizedField := customizeField(field, entity)
+	customizedEntity := customizeEntity(field, entity)
 	return &inlineFilterImpl{
-		entity:   entity,
+		entity:   customizedEntity,
 		function: function,
 		field:    customizedField,
 		value:    value,

pkg/common/filters_test.go

@@ -48,7 +48,7 @@ func TestNewSingleBoolValueFilter(t *testing.T) {
 	assert.Equal(t, expression.Args, true)
 }
 
-func TestNewSingleValueCustomizedFilter(t *testing.T) {
+func TestNewSingleValueCustomizedFieldFilter(t *testing.T) {
 	filter, err := NewSingleValueFilter(Execution, Equal, "project", "a project")
 	assert.NoError(t, err)
 
@@ -61,6 +61,18 @@ func TestNewSingleValueCustomizedFilter(t *testing.T) {
 	assert.Equal(t, "node_executions.execution_project = ?", expression.Query)
 }
 
+func TestNewSingleValueCustomizedEntityFilter(t *testing.T) {
+	filter, err := NewSingleValueFilter(NamedEntity, Equal, "state", 1)
+	assert.NoError(t, err)
+
+	assert.Equal(t, NamedEntityMetadata, filter.GetEntity())
+
+	filter, err = NewSingleValueFilter(NamedEntity, Equal, "description", "test value")
+	assert.NoError(t, err)
+
+	assert.Equal(t, NamedEntityMetadata, filter.GetEntity())
+}
+
 func TestNewRepeatedValueFilter(t *testing.T) {
 	vals := []string{"SuperAwesomeProject", "AnotherAwesomeProject"}
 	filter, err := NewRepeatedValueFilter(Workflow, ValueIn, "project", vals)

pkg/manager/impl/named_entity_manager.go

@@ -86,7 +86,7 @@ func (m *NamedEntityManager) getQueryFilters(referenceEntity core.ResourceType,
 	if len(requestFilters) == 0 {
 		return filters, nil
 	}
-	additionalFilters, err := util.ParseFilters(requestFilters, common.NamedEntityMetadata)
+	additionalFilters, err := util.ParseFilters(requestFilters, common.NamedEntity)
 	if err != nil {
 		return nil, err
 	}

pkg/manager/impl/util/filters.go

@@ -58,6 +58,7 @@ var filterFieldEntityPrefix = map[string]common.Entity{
 	"execution":             common.Execution,
 	"node_execution":        common.NodeExecution,
 	"task_execution":        common.TaskExecution,
+	"entities":              common.NamedEntity,
 	"named_entity_metadata": common.NamedEntityMetadata,
 }
 

pkg/repositories/gormimpl/common.go

@@ -45,6 +45,7 @@ var entityToTableName = map[common.Entity]string{
 	common.Task:                "tasks",
 	common.TaskExecution:       "task_executions",
 	common.Workflow:            "workflows",
+	common.NamedEntity:         "entities",
 	common.NamedEntityMetadata: "named_entity_metadata",
 }