-

pkg/manager/impl/util/filters.go

@@ -3,21 +3,21 @@ package util
 
 import (
 	"context"
+	"fmt"
 	"regexp"
 	"strconv"
 	"strings"
 	"time"
 
 	"github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/core"
 	"github.com/flyteorg/flytestdlib/logger"
-
-	"github.com/flyteorg/flyteadmin/pkg/errors"
 	"google.golang.org/grpc/codes"
-
-	"fmt"
+	"k8s.io/apimachinery/pkg/util/sets"
 
 	"github.com/flyteorg/flyteadmin/pkg/common"
+	"github.com/flyteorg/flyteadmin/pkg/errors"
 	"github.com/flyteorg/flyteadmin/pkg/manager/impl/shared"
+	"github.com/flyteorg/flyteadmin/pkg/repositories/gormimpl"
 )
 
 const (
@@ -120,6 +120,54 @@ func prepareValues(field string, values []string) (interface{}, error) {
 	return preparedValues, nil
 }
 
+var allowedJoinTableColumns = map[common.Entity]map[common.Entity]sets.String{
+	common.Execution: {
+		common.Execution:  gormimpl.ExecutionColumns,
+		common.LaunchPlan: gormimpl.LaunchPlanColumns,
+		common.Workflow:   gormimpl.WorkflowColumns,
+		common.Task:       gormimpl.TaskColumns,
+		common.AdminTag:   gormimpl.AdminTagColumns,
+	},
+	common.LaunchPlan: {
+		common.LaunchPlan: gormimpl.LaunchPlanColumns,
+		common.Workflow:   gormimpl.WorkflowColumns,
+	},
+	common.NodeExecution: {
+		common.NodeExecution: gormimpl.NodeExecutionColumns,
+		common.Execution:     gormimpl.ExecutionColumns,
+	},
+	common.NodeExecutionEvent: {
+		common.NodeExecutionEvent: gormimpl.NodeExecutionEventColumns,
+	},
+	common.Task: {
+		common.Task: gormimpl.TaskColumns,
+	},
+	common.TaskExecution: {
+		common.TaskExecution: gormimpl.TaskExecutionColumns,
+		common.Task:          gormimpl.TaskColumns,
+		common.Execution:     gormimpl.ExecutionColumns,
+		common.NodeExecution: gormimpl.NodeExecutionColumns,
+	},
+	common.Workflow: {
+		common.Workflow: gormimpl.WorkflowColumns,
+	},
+	common.NamedEntity: {
+		common.NamedEntity: gormimpl.NamedEntityColumns,
+	},
+	common.NamedEntityMetadata: {
+		common.NamedEntityMetadata: gormimpl.NamedEntityMetadataColumns,
+	},
+	common.Project: {
+		common.Project: gormimpl.ProjectColumns,
+	},
+	common.Signal: {
+		common.Signal: gormimpl.SignalColumns,
+	},
+	common.AdminTag: {
+		common.AdminTag: gormimpl.AdminTagColumns,
+	},
+}
+
 func ParseFilters(filterParams string, primaryEntity common.Entity) ([]common.InlineFilter, error) {
 	// Multiple filters can be appended as URI-escaped strings joined by filterExpressionSeperator
 	filterExpressions := strings.Split(filterParams, filterExpressionSeperator)
@@ -133,6 +181,20 @@ func ParseFilters(filterParams string, primaryEntity common.Entity) ([]common.In
 		}
 		referencedEntity, field := parseField(matches[fieldMatchIndex], primaryEntity)
 
+		allowedJoinEntities, ok := allowedJoinTableColumns[primaryEntity]
+		if !ok {
+			return nil, fmt.Errorf("unsupported entity '%s'", primaryEntity)
+		}
+
+		referencedEntityColumns, ok := allowedJoinEntities[referencedEntity]
+		if !ok {
+			return nil, errors.NewFlyteAdminErrorf(codes.InvalidArgument, "'%s' entity is not allowed in filters", referencedEntity)
+		}
+
+		if !referencedEntityColumns.Has(field) {
+			return nil, errors.NewFlyteAdminErrorf(codes.InvalidArgument, "'%s.%s' is invalid filter", referencedEntity, field)
+		}
+
 		// Parse and transform values
 		parsedValues := parseRepeatedValues(matches[valueMatchIndex])
 		preparedValues, err := prepareValues(field, parsedValues)

pkg/manager/impl/util/filters_test.go

@@ -6,11 +6,12 @@ import (
 	"time"
 
 	"github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/core"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 
 	"github.com/flyteorg/flyteadmin/pkg/common"
 	"github.com/flyteorg/flyteadmin/pkg/manager/impl/shared"
 	"github.com/flyteorg/flyteadmin/pkg/manager/impl/testutils"
-	"github.com/stretchr/testify/assert"
 )
 
 func TestParseRepeatedValues(t *testing.T) {
@@ -64,30 +65,59 @@ func TestPrepareValues_RepeatedValues(t *testing.T) {
 	assert.Equal(t, []interface{}{"value a", "value b"}, values)
 }
 
-func TestParseFilters(t *testing.T) {
-	filterExpression := "eq(foo, 123)+ne(version, TheWorst)+value_in(bar, 4;5;6)"
+func Test_ParseFilters_Success(t *testing.T) {
+	filterExpression := "eq(project, flytesnacks)+ne(domain, development)+value_in(type, 4;5;6)"
+
 	taskFilters, err := ParseFilters(filterExpression, common.Task)
+
 	assert.NoError(t, err)
+	require.Len(t, taskFilters, 3)
 
-	assert.Len(t, taskFilters, 3)
 	actualFilterExpression, _ := taskFilters[0].GetGormQueryExpr()
-	assert.Equal(t, "foo = ?", actualFilterExpression.Query)
-	assert.Equal(t, "123", actualFilterExpression.Args)
+	assert.Equal(t, "project = ?", actualFilterExpression.Query)
+	assert.Equal(t, "flytesnacks", actualFilterExpression.Args)
 
 	actualFilterExpression, _ = taskFilters[1].GetGormQueryExpr()
-	assert.Equal(t, "version <> ?", actualFilterExpression.Query)
-	assert.Equal(t, "TheWorst", actualFilterExpression.Args)
+	assert.Equal(t, "domain <> ?", actualFilterExpression.Query)
+	assert.Equal(t, "development", actualFilterExpression.Args)
 
 	actualFilterExpression, _ = taskFilters[2].GetGormQueryExpr()
-	assert.Equal(t, "bar in (?)", actualFilterExpression.Query)
+	assert.Equal(t, "type in (?)", actualFilterExpression.Query)
 	assert.Equal(t, []interface{}{"4", "5", "6"}, actualFilterExpression.Args)
+}
+
+func Test_ParseFilters_InvalidFunction(t *testing.T) {
+	filterExpression := "invalid_function(type,bar)"
+
+	_, err := ParseFilters(filterExpression, common.Task)
 
-	filterExpression = "invalid_function(foo,bar)"
-	_, err = ParseFilters(filterExpression, common.Task)
-	assert.Error(t, err)
 	assert.EqualError(t, err, "unrecognized filter function: invalid_function")
 }
 
+func Test_ParseFilters_UnsupportedEntity(t *testing.T) {
+	filterExpression := "eq(foo, 123)"
+
+	_, err := ParseFilters(filterExpression, "wrong")
+
+	assert.EqualError(t, err, "unsupported entity 'wrong'")
+}
+
+func Test_ParseFilters_InvalidJoinEntity(t *testing.T) {
+	filterExpression := "eq(project.name, 123)"
+
+	_, err := ParseFilters(filterExpression, common.Workflow)
+
+	assert.EqualError(t, err, "'p' entity is not allowed in filters")
+}
+
+func Test_ParseFilters_InvalidFilter(t *testing.T) {
+	filterExpression := "eq(foo, 123)"
+
+	_, err := ParseFilters(filterExpression, common.Task)
+
+	assert.EqualError(t, err, "'t.foo' is invalid filter")
+}
+
 func TestGetEqualityFilter(t *testing.T) {
 	filter, err := GetSingleValueEqualityFilter(common.Task, "field", "value")
 	assert.NoError(t, err)
@@ -97,18 +127,20 @@ func TestGetEqualityFilter(t *testing.T) {
 	assert.Equal(t, "value", actualFilterExpression.Args)
 }
 
-func TestAddRequestFilters(t *testing.T) {
+func Test_AddRequestFilters(t *testing.T) {
 	filters, err := AddRequestFilters(
-		"ne(version, TheWorst)+eq(workflow.name, workflow)", common.Execution, make([]common.InlineFilter, 0))
-	assert.Nil(t, err)
-	assert.Len(t, filters, 2)
+		"ne(cluster, TheWorst)+eq(workflow.name, workflow)", common.Execution, make([]common.InlineFilter, 0))
+
+	assert.NoError(t, err)
+	require.Len(t, filters, 2)
+
 	expression, err := filters[0].GetGormQueryExpr()
-	assert.Nil(t, err)
-	assert.Equal(t, "version <> ?", expression.Query)
+	assert.NoError(t, err)
+	assert.Equal(t, "cluster <> ?", expression.Query)
 	assert.Equal(t, "TheWorst", expression.Args)
 
 	expression, err = filters[1].GetGormQueryExpr()
-	assert.Nil(t, err)
+	assert.NoError(t, err)
 	assert.Equal(t, testutils.NameQueryPattern, expression.Query)
 	assert.Equal(t, "workflow", expression.Args)
 }

pkg/repositories/gormimpl/common.go

@@ -2,14 +2,17 @@
 
 import (
 	"fmt"
+	"sync"
+
+	"google.golang.org/grpc/codes"
+	"gorm.io/gorm"
+	"gorm.io/gorm/schema"
+	"k8s.io/apimachinery/pkg/util/sets"
 
 	"github.com/flyteorg/flyteadmin/pkg/common"
 	adminErrors "github.com/flyteorg/flyteadmin/pkg/errors"
 	"github.com/flyteorg/flyteadmin/pkg/repositories/errors"
 	"github.com/flyteorg/flyteadmin/pkg/repositories/interfaces"
-
-	"google.golang.org/grpc/codes"
-	"gorm.io/gorm"
 )
 
 const Project = "project"
@@ -115,3 +118,11 @@
 	}
 	return tx, nil
 }
+
+func modelColumns(v any) sets.String {
+	s, err := schema.Parse(v, &sync.Map{}, schema.NamingStrategy{})
+	if err != nil {
+		panic(err)
+	}
+	return sets.NewString(s.DBNames...)
+}

pkg/repositories/gormimpl/execution_repo.go

@@ -5,16 +5,22 @@ import (
 	"errors"
 	"fmt"
 
+	"github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/core"
+	"github.com/flyteorg/flytestdlib/promutils"
+
 	"github.com/flyteorg/flyteadmin/pkg/common"
 	adminErrors "github.com/flyteorg/flyteadmin/pkg/repositories/errors"
 	"github.com/flyteorg/flyteadmin/pkg/repositories/interfaces"
 	"github.com/flyteorg/flyteadmin/pkg/repositories/models"
-	"github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/core"
-	"github.com/flyteorg/flytestdlib/promutils"
 
 	"gorm.io/gorm"
 )
 
+var (
+	ExecutionColumns = modelColumns(models.Execution{})
+	AdminTagColumns  = modelColumns(models.AdminTag{})
+)
+
 // Implementation of ExecutionInterface.
 type ExecutionRepo struct {
 	db               *gorm.DB

pkg/repositories/gormimpl/launch_plan_repo.go

@@ -8,13 +8,16 @@ import (
 	"github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/core"
 	"github.com/flyteorg/flytestdlib/promutils"
 
+	"github.com/flyteorg/flytestdlib/logger"
+	"gorm.io/gorm"
+
 	adminErrors "github.com/flyteorg/flyteadmin/pkg/repositories/errors"
 	"github.com/flyteorg/flyteadmin/pkg/repositories/interfaces"
 	"github.com/flyteorg/flyteadmin/pkg/repositories/models"
-	"github.com/flyteorg/flytestdlib/logger"
-	"gorm.io/gorm"
 )
 
+var LaunchPlanColumns = modelColumns(models.LaunchPlan{})
+
 const launchPlanTableName = "launch_plans"
 
 type launchPlanMetrics struct {

pkg/repositories/gormimpl/named_entity_repo.go

@@ -7,13 +7,19 @@ import (
 	"github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/core"
 	"google.golang.org/grpc/codes"
 
+	"github.com/flyteorg/flytestdlib/promutils"
+	"gorm.io/gorm"
+
 	"github.com/flyteorg/flyteadmin/pkg/common"
 	adminErrors "github.com/flyteorg/flyteadmin/pkg/errors"
 	"github.com/flyteorg/flyteadmin/pkg/repositories/errors"
 	"github.com/flyteorg/flyteadmin/pkg/repositories/interfaces"
 	"github.com/flyteorg/flyteadmin/pkg/repositories/models"
-	"github.com/flyteorg/flytestdlib/promutils"
-	"gorm.io/gorm"
+)
+
+var (
+	NamedEntityColumns         = modelColumns(models.NamedEntity{})
+	NamedEntityMetadataColumns = modelColumns(models.NamedEntityMetadata{})
 )
 
 const innerJoinTableAlias = "entities"

pkg/repositories/gormimpl/node_execution_event_repo.go

@@ -3,13 +3,16 @@ package gormimpl
 import (
 	"context"
 
+	"github.com/flyteorg/flytestdlib/promutils"
+	"gorm.io/gorm"
+
 	"github.com/flyteorg/flyteadmin/pkg/repositories/errors"
 	"github.com/flyteorg/flyteadmin/pkg/repositories/interfaces"
 	"github.com/flyteorg/flyteadmin/pkg/repositories/models"
-	"github.com/flyteorg/flytestdlib/promutils"
-	"gorm.io/gorm"
 )
 
+var NodeExecutionEventColumns = modelColumns(models.NodeExecutionEvent{})
+
 type NodeExecutionEventRepo struct {
 	db               *gorm.DB
 	errorTransformer errors.ErrorTransformer

pkg/repositories/gormimpl/node_execution_repo.go

@@ -6,15 +6,16 @@ import (
 	"fmt"
 
 	"github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/core"
-
 	"github.com/flyteorg/flytestdlib/promutils"
+	"gorm.io/gorm"
 
 	adminErrors "github.com/flyteorg/flyteadmin/pkg/repositories/errors"
 	"github.com/flyteorg/flyteadmin/pkg/repositories/interfaces"
 	"github.com/flyteorg/flyteadmin/pkg/repositories/models"
-	"gorm.io/gorm"
 )
 
+var NodeExecutionColumns = modelColumns(models.NodeExecution{})
+
 // Implementation of NodeExecutionInterface.
 type NodeExecutionRepo struct {
 	db               *gorm.DB

pkg/repositories/gormimpl/project_repo.go

@@ -4,19 +4,19 @@ import (
 	"context"
 	"errors"
 
-	flyteAdminErrors "github.com/flyteorg/flyteadmin/pkg/errors"
-	"google.golang.org/grpc/codes"
-
 	"github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/admin"
 	"github.com/flyteorg/flytestdlib/promutils"
-
+	"google.golang.org/grpc/codes"
 	"gorm.io/gorm"
 
+	flyteAdminErrors "github.com/flyteorg/flyteadmin/pkg/errors"
 	flyteAdminDbErrors "github.com/flyteorg/flyteadmin/pkg/repositories/errors"
 	"github.com/flyteorg/flyteadmin/pkg/repositories/interfaces"
 	"github.com/flyteorg/flyteadmin/pkg/repositories/models"
 )
 
+var ProjectColumns = modelColumns(models.Project{})
+
 type ProjectRepo struct {
 	db               *gorm.DB
 	errorTransformer flyteAdminDbErrors.ErrorTransformer