Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix internal validation. #125

Merged
merged 15 commits into from
Jan 28, 2025
Merged
5 changes: 5 additions & 0 deletions magefiles/generate/validations.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,15 @@ var validations = map[string]string{
"Dataset_Schema": "max:1048575",
"InputTag_Key": "required,max=255",
"InputTag_Value": "required,max=500",
"RenameRegisteredModel_Name": "notEmpty,required",
"RenameRegisteredModel_NewName": "notEmpty,required",
"SetRegisteredModelTag_Name": "required",
"SetRegisteredModelTag_Key": "required,max=250,validMetricParamOrTagName,pathIsUnique",
"SetRegisteredModelTag_Value": "omitempty,max=5000",
"CreateRegisteredModel_Name": "notEmpty,required",
"CreateRegisteredModel_Key": "required,max=250,validMetricParamOrTagName,pathIsUnique",
"CreateRegisteredModel_Value": "omitempty,max=5000,truncate=5000",
"DeleteRegisteredModelTag_Name": "required",
"DeleteRegisteredModelTag_Key": "required,max=250,validMetricParamOrTagName,pathIsUnique",
"SetRegisteredModelAlias_Name": "required",
"SetRegisteredModelAlias_Alias": "required,max=255,validMetricParamOrTagName,pathIsUnique",
Expand Down
38 changes: 3 additions & 35 deletions pkg/model_registry/service/registered_models.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,7 @@ func (m *ModelRegistryService) UpdateRegisteredModel(
func (m *ModelRegistryService) RenameRegisteredModel(
ctx context.Context, input *protos.RenameRegisteredModel,
) (*protos.RenameRegisteredModel_Response, *contract.Error) {
newName := input.GetNewName()
if newName == "" {
return nil, contract.NewError(
protos.ErrorCode_INVALID_PARAMETER_VALUE,
"Registered model name cannot be empty",
)
}

registeredModel, err := m.store.RenameRegisteredModel(ctx, input.GetName(), newName)
registeredModel, err := m.store.RenameRegisteredModel(ctx, input.GetName(), input.GetNewName())
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -75,15 +67,7 @@ func (m *ModelRegistryService) GetRegisteredModel(
func (m *ModelRegistryService) SetRegisteredModelTag(
ctx context.Context, input *protos.SetRegisteredModelTag,
) (*protos.SetRegisteredModelTag_Response, *contract.Error) {
name := input.GetName()
if name == "" {
return nil, contract.NewError(
protos.ErrorCode_INVALID_PARAMETER_VALUE,
"Registered model name cannot be empty",
)
}

if err := m.store.SetRegisteredModelTag(ctx, name, input.GetKey(), input.GetValue()); err != nil {
if err := m.store.SetRegisteredModelTag(ctx, input.GetName(), input.GetKey(), input.GetValue()); err != nil {
return nil, err
}

Expand All @@ -93,14 +77,6 @@ func (m *ModelRegistryService) SetRegisteredModelTag(
func (m *ModelRegistryService) CreateRegisteredModel(
ctx context.Context, input *protos.CreateRegisteredModel,
) (*protos.CreateRegisteredModel_Response, *contract.Error) {
name := input.GetName()
if name == "" {
return nil, contract.NewError(
protos.ErrorCode_INVALID_PARAMETER_VALUE,
"Registered model name cannot be empty.",
)
}

tags := make([]*entities.RegisteredModelTag, 0, len(input.GetTags()))
for _, tag := range input.GetTags() {
tags = append(tags, entities.NewRegisteredModelTagFromProto(tag))
Expand All @@ -119,15 +95,7 @@ func (m *ModelRegistryService) CreateRegisteredModel(
func (m *ModelRegistryService) DeleteRegisteredModelTag(
ctx context.Context, input *protos.DeleteRegisteredModelTag,
) (*protos.DeleteRegisteredModelTag_Response, *contract.Error) {
name := input.GetName()
if name == "" {
return nil, contract.NewError(
protos.ErrorCode_INVALID_PARAMETER_VALUE,
"Registered model name cannot be empty",
)
}

if err := m.store.DeleteRegisteredModelTag(ctx, name, input.GetKey()); err != nil {
if err := m.store.DeleteRegisteredModelTag(ctx, input.GetName(), input.GetKey()); err != nil {
return nil, err
}

Expand Down
10 changes: 5 additions & 5 deletions pkg/protos/model_registry.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 11 additions & 2 deletions pkg/validation/validation.go
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,10 @@ func pathIsClean(fl validator.FieldLevel) bool {
return !(norm != valueStr || norm == "." || strings.HasPrefix(norm, "..") || strings.HasPrefix(norm, "/"))
}

func notEmptyValidation(fl validator.FieldLevel) bool {
return fl.Field().String() != ""
}

func regexValidation(regex *regexp.Regexp) validator.Func {
return func(fl validator.FieldLevel) bool {
valueStr := fl.Field().String()
Expand Down Expand Up @@ -146,6 +150,7 @@ func truncateFn(fieldLevel validator.FieldLevel) bool {
return true
}

//nolint:cyclop
func NewValidator() (*validator.Validate, error) {
validate := validator.New()

Expand Down Expand Up @@ -199,6 +204,10 @@ func NewValidator() (*validator.Validate, error) {
return nil, fmt.Errorf("validation registration for 'positiveNonZeroInteger' failed: %w", err)
}

if err := validate.RegisterValidation("notEmpty", notEmptyValidation); err != nil {
return nil, fmt.Errorf("validation registration for 'notEmpty' failed: %w", err)
}

validate.RegisterStructValidation(validateLogBatchLimits, &protos.LogBatch{})
validate.RegisterStructValidation(validateSetTagRunIDExists, &protos.SetTag{})

Expand Down Expand Up @@ -299,10 +308,10 @@ func NewErrorFromValidationError(err error) *contract.Error {
value := dereference(err.Value())

switch tag {
case "required":
case "notEmpty", "required":
validationErrors = append(
validationErrors,
fmt.Sprintf("Missing value for required parameter '%s'", field),
fmt.Sprintf("Missing value for required parameter '%s'.", field),
)
case "truncate":
validationErrors = append(validationErrors, mkTruncateValidationError(field, value, err))
Expand Down
Loading