refactor(validation): rename validation error message map for clarity and improve error handling during registration

Author: akrem-chabchoub

pkg/api/api.go

@@ -214,9 +214,9 @@ type Service struct {
 
 	whitelistedWithdrawalAddress []common.Address
 
-	preMapHooks             map[string]func(v string) (string, error)
-	validationCustomErrorMessages map[string]func(err validator.FieldError) error
-	validate                *validator.Validate
+	preMapHooks              map[string]func(v string) (string, error)
+	customValidationMessages map[string]func(err validator.FieldError) error
+	validate                 *validator.Validate
 
 	redistributionAgent *storageincentives.Agent
 
@@ -712,7 +712,7 @@ func (s *Service) mapStructure(input, output any) func(string, log.Logger, http.
 				val = string(v)
 			}
 			var cause error
-			if msgFn, ok := s.validationCustomErrorMessages[err.Tag()]; ok {
+			if msgFn, ok := s.customValidationMessages[err.Tag()]; ok {
 				cause = msgFn(err)
 			} else {
 				cause = fmt.Errorf("want %s:%s", err.Tag(), err.Param())

pkg/api/bytes_test.go

@@ -449,7 +449,7 @@ func TestBytesRedundancyLevel(t *testing.T) {
 				Reasons: []jsonhttp.Reason{
 					{
 						Field: "swarm-redundancy-level",
-						Error: fmt.Sprintf("want redundancy level to be in the range of %d and %d", int(redundancy.NONE), int(redundancy.PARANOID)),
+						Error: fmt.Sprintf("want redundancy level to be between %d and %d", int(redundancy.NONE), int(redundancy.PARANOID)),
 					},
 				},
 			},

pkg/api/bzz_test.go

@@ -1224,7 +1224,7 @@ func TestBzzUploadRedundancyLevel(t *testing.T) {
 				Reasons: []jsonhttp.Reason{
 					{
 						Field: "swarm-redundancy-level",
-						Error: fmt.Sprintf("want lte:%d", maxValidLevel),
+						Error: fmt.Sprintf("want redundancy level to be between %d and %d", int(redundancy.NONE), int(redundancy.PARANOID)),
 					},
 				},
 			},
@@ -1300,7 +1300,7 @@ func TestBzzDownloadRedundancyLevel(t *testing.T) {
 				Reasons: []jsonhttp.Reason{
 					{
 						Field: "swarm-redundancy-level",
-						Error: fmt.Sprintf("want redundancy level to be in the range of %d and %d", int(redundancy.NONE), int(redundancy.PARANOID)),
+						Error: fmt.Sprintf("want redundancy level to be between %d and %d", int(redundancy.NONE), int(redundancy.PARANOID)),
 					},
 				},
 			},

pkg/api/validation.go

@@ -17,14 +17,18 @@ const (
 
 // setupValidation configures custom validation rules and their custom error messages.
 func (s *Service) setupValidation() {
-	s.validate.RegisterValidation(RedundancyLevelTag, func(fl validator.FieldLevel) bool {
+	err := s.validate.RegisterValidation(RedundancyLevelTag, func(fl validator.FieldLevel) bool {
 		level := redundancy.Level(fl.Field().Uint())
 		return level.Validate()
 	})
+	if err != nil {
+		s.logger.Error(err, "failed to register validation")
+		panic(err)
+	}
 
-	s.validationCustomErrorMessages = map[string]func(err validator.FieldError) error{
+	s.customValidationMessages = map[string]func(err validator.FieldError) error{
 		RedundancyLevelTag: func(err validator.FieldError) error {
-			return fmt.Errorf("want redundancy level to be in the range of %d and %d", int(redundancy.NONE), int(redundancy.PARANOID))
+			return fmt.Errorf("want redundancy level to be between %d and %d", int(redundancy.NONE), int(redundancy.PARANOID))
 		},
 	}
 }