refactor(*): add iso8601duration validate tag (#78)

Signed-off-by: lsytj0413 <511121939@qq.com>

Signed-off-by: lsytj0413 <511121939@qq.com>

Author: lsytj0413

model/delay_state.go

@@ -15,8 +15,6 @@
 package model
 
 import (
-	"reflect"
-
 	"github.com/go-playground/validator/v10"
 
 	val "github.com/serverlessworkflow/sdk-go/v2/validator"
@@ -33,15 +31,10 @@ func init() {
 type DelayState struct {
 	BaseState
 	// Amount of time (ISO 8601 format) to delay
-	TimeDelay string `json:"timeDelay" validate:"required"`
+	TimeDelay string `json:"timeDelay" validate:"required,iso8601duration"`
 }
 
 // DelayStateStructLevelValidation custom validator for DelayState Struct
 func DelayStateStructLevelValidation(structLevel validator.StructLevel) {
-	delayStateObj := structLevel.Current().Interface().(DelayState)
-
-	err := validateISO8601TimeDuration(delayStateObj.TimeDelay)
-	if err != nil {
-		structLevel.ReportError(reflect.ValueOf(delayStateObj.TimeDelay), "TimeDelay", "timeDelay", "reqiso8601duration", "")
-	}
+	// TODO
 }

model/delay_state_test.go

@@ -49,7 +49,7 @@ func TestDelayStateStructLevelValidation(t *testing.T) {
 				},
 				TimeDelay: "",
 			},
-			err: `Key: 'DelayState.TimeDelay' Error:Field validation for 'TimeDelay' failed on the 'required' tag\nKey: 'DelayState.TimeDelay' Error:Field validation for 'TimeDelay' failed on the 'reqiso8601duration' tag`,
+			err: `Key: 'DelayState.TimeDelay' Error:Field validation for 'TimeDelay' failed on the 'required' tag`,
 		},
 		{
 			desp: "invalid timeDelay duration",
@@ -60,7 +60,7 @@ func TestDelayStateStructLevelValidation(t *testing.T) {
 				},
 				TimeDelay: "P5S",
 			},
-			err: `Key: 'DelayState.TimeDelay' Error:Field validation for 'TimeDelay' failed on the 'reqiso8601duration' tag`,
+			err: `Key: 'DelayState.TimeDelay' Error:Field validation for 'TimeDelay' failed on the 'iso8601duration' tag`,
 		},
 	}
 	for _, tc := range testCases {

model/retry.go

@@ -36,48 +36,29 @@ type Retry struct {
 	// Unique retry strategy name
 	Name string `json:"name" validate:"required"`
 	// Time delay between retry attempts (ISO 8601 duration format)
-	Delay string `json:"delay,omitempty"`
+	Delay string `json:"delay,omitempty" validate:"omitempty,iso8601duration"`
 	// Maximum time delay between retry attempts (ISO 8601 duration format)
-	MaxDelay string `json:"maxDelay,omitempty"`
+	MaxDelay string `json:"maxDelay,omitempty" validate:"omitempty,iso8601duration"`
 	// Static value by which the delay increases during each attempt (ISO 8601 time format)
-	Increment string `json:"increment,omitempty"`
+	Increment string `json:"increment,omitempty" validate:"omitempty,iso8601duration"`
 	// Numeric value, if specified the delay between retries is multiplied by this value.
 	Multiplier *floatstr.Float32OrString `json:"multiplier,omitempty" validate:"omitempty,min=1"`
 	// Maximum number of retry attempts.
 	MaxAttempts intstr.IntOrString `json:"maxAttempts" validate:"required"`
+
 	// If float type, maximum amount of random time added or subtracted from the delay between each retry relative to total delay (between 0 and 1). If string type, absolute maximum amount of random time added or subtracted from the delay between each retry (ISO 8601 duration format)
+	// TODO: make iso8601duration compatible this type
 	Jitter floatstr.Float32OrString `json:"jitter,omitempty" validate:"omitempty,min=0,max=1"`
 }
 
 // RetryStructLevelValidation custom validator for Retry Struct
 func RetryStructLevelValidation(structLevel validator.StructLevel) {
 	retryObj := structLevel.Current().Interface().(Retry)
 
-	if retryObj.Delay != "" {
-		err := validateISO8601TimeDuration(retryObj.Delay)
-		if err != nil {
-			structLevel.ReportError(reflect.ValueOf(retryObj.Delay), "Delay", "delay", "reqiso8601duration", "")
-		}
-	}
-
-	if retryObj.MaxDelay != "" {
-		err := validateISO8601TimeDuration(retryObj.MaxDelay)
-		if err != nil {
-			structLevel.ReportError(reflect.ValueOf(retryObj.MaxDelay), "MaxDelay", "maxDelay", "reqiso8601duration", "")
-		}
-	}
-
-	if retryObj.Increment != "" {
-		err := validateISO8601TimeDuration(retryObj.Increment)
-		if err != nil {
-			structLevel.ReportError(reflect.ValueOf(retryObj.Increment), "Increment", "increment", "reqiso8601duration", "")
-		}
-	}
-
 	if retryObj.Jitter.Type == floatstr.String && retryObj.Jitter.StrVal != "" {
-		err := validateISO8601TimeDuration(retryObj.Jitter.StrVal)
+		err := val.ValidateISO8601TimeDuration(retryObj.Jitter.StrVal)
 		if err != nil {
-			structLevel.ReportError(reflect.ValueOf(retryObj.Jitter.StrVal), "Jitter", "jitter", "reqiso8601duration", "")
+			structLevel.ReportError(reflect.ValueOf(retryObj.Jitter.StrVal), "Jitter", "jitter", "iso8601duration", "")
 		}
 	}
 }

model/retry_test.go

@@ -41,6 +41,13 @@ func TestRetryStructLevelValidation(t *testing.T) {
 			},
 			err: ``,
 		},
+		{
+			desp: "normal with all optinal",
+			retryObj: Retry{
+				Name: "1",
+			},
+			err: ``,
+		},
 		{
 			desp: "missing required name",
 			retryObj: Retry{
@@ -61,7 +68,7 @@ func TestRetryStructLevelValidation(t *testing.T) {
 				Increment: "PT5S",
 				Jitter:    floatstr.FromString("PT5S"),
 			},
-			err: `Key: 'Retry.Delay' Error:Field validation for 'Delay' failed on the 'reqiso8601duration' tag`,
+			err: `Key: 'Retry.Delay' Error:Field validation for 'Delay' failed on the 'iso8601duration' tag`,
 		},
 		{
 			desp: "invdalid max delay duration",
@@ -72,7 +79,7 @@ func TestRetryStructLevelValidation(t *testing.T) {
 				Increment: "PT5S",
 				Jitter:    floatstr.FromString("PT5S"),
 			},
-			err: `Key: 'Retry.MaxDelay' Error:Field validation for 'MaxDelay' failed on the 'reqiso8601duration' tag`,
+			err: `Key: 'Retry.MaxDelay' Error:Field validation for 'MaxDelay' failed on the 'iso8601duration' tag`,
 		},
 		{
 			desp: "invalid increment duration",
@@ -83,7 +90,7 @@ func TestRetryStructLevelValidation(t *testing.T) {
 				Increment: "P5S",
 				Jitter:    floatstr.FromString("PT5S"),
 			},
-			err: `Key: 'Retry.Increment' Error:Field validation for 'Increment' failed on the 'reqiso8601duration' tag`,
+			err: `Key: 'Retry.Increment' Error:Field validation for 'Increment' failed on the 'iso8601duration' tag`,
 		},
 		{
 			desp: "invalid jitter duration",
@@ -94,7 +101,7 @@ func TestRetryStructLevelValidation(t *testing.T) {
 				Increment: "PT5S",
 				Jitter:    floatstr.FromString("P5S"),
 			},
-			err: `Key: 'Retry.Jitter' Error:Field validation for 'Jitter' failed on the 'reqiso8601duration' tag`,
+			err: `Key: 'Retry.Jitter' Error:Field validation for 'Jitter' failed on the 'iso8601duration' tag`,
 		},
 	}
 

model/sleep_state.go

@@ -14,20 +14,12 @@
 
 package model
 
-import (
-	"context"
-	"reflect"
-
-	validator "github.com/go-playground/validator/v10"
-	val "github.com/serverlessworkflow/sdk-go/v2/validator"
-)
-
 // SleepState suspends workflow execution for a given time duration.
 type SleepState struct {
 	BaseState
 
 	// Duration (ISO 8601 duration format) to sleep
-	Duration string `json:"duration" validate:"required"`
+	Duration string `json:"duration" validate:"required,iso8601duration"`
 	// Timeouts State specific timeouts
 	Timeouts *SleepStateTimeout `json:"timeouts,omitempty"`
 }
@@ -36,20 +28,3 @@ type SleepState struct {
 type SleepStateTimeout struct {
 	StateExecTimeout StateExecTimeout `json:"stateExecTimeout,omitempty"`
 }
-
-// SleepStateStructLevelValidation custom validator for SleepState
-func SleepStateStructLevelValidation(_ context.Context, structLevel validator.StructLevel) {
-	sleepState := structLevel.Current().Interface().(SleepState)
-
-	err := validateISO8601TimeDuration(sleepState.Duration)
-	if err != nil {
-		structLevel.ReportError(reflect.ValueOf(sleepState.Duration), "Duration", "duration", "reqiso8601duration", "")
-	}
-}
-
-func init() {
-	val.GetValidator().RegisterStructValidationCtx(
-		SleepStateStructLevelValidation,
-		SleepState{},
-	)
-}

model/sleep_state_test.go

@@ -49,7 +49,7 @@ func TestSleepStateStructLevelValidation(t *testing.T) {
 				},
 				Duration: "T10S",
 			},
-			err: `Key: 'SleepState.Duration' Error:Field validation for 'Duration' failed on the 'reqiso8601duration' tag`,
+			err: `Key: 'SleepState.Duration' Error:Field validation for 'Duration' failed on the 'iso8601duration' tag`,
 		},
 	}
 

model/state_exec_timeout.go

@@ -16,21 +16,16 @@ package model
 
 import (
 	"bytes"
-	"context"
 	"encoding/json"
 	"fmt"
-	"reflect"
-
-	validator "github.com/go-playground/validator/v10"
-	val "github.com/serverlessworkflow/sdk-go/v2/validator"
 )
 
 // StateExecTimeout defines workflow state execution timeout
 type StateExecTimeout struct {
 	// Single state execution timeout, not including retries (ISO 8601 duration format)
-	Single string `json:"single,omitempty"`
+	Single string `json:"single,omitempty" validate:"omitempty,iso8601duration"`
 	// Total state execution timeout, including retries (ISO 8601 duration format)
-	Total string `json:"total" validate:"required"`
+	Total string `json:"total" validate:"required,iso8601duration"`
 }
 
 // just define another type to unmarshal object, so the UnmarshalJSON will not called recursively
@@ -64,28 +59,3 @@ func (s *StateExecTimeout) UnmarshalJSON(data []byte) error {
 
 	return fmt.Errorf("stateExecTimeout value '%s' not support, it must be an object or string", string(data))
 }
-
-// StateExecTimeoutStructLevelValidation custom validator for StateExecTimeout
-func StateExecTimeoutStructLevelValidation(_ context.Context, structLevel validator.StructLevel) {
-	timeoutObj := structLevel.Current().Interface().(StateExecTimeout)
-
-	// TODO: use Custom Validation Functions tags for iso8601duration
-	err := validateISO8601TimeDuration(timeoutObj.Total)
-	if err != nil {
-		structLevel.ReportError(reflect.ValueOf(timeoutObj.Total), "Total", "total", "reqiso8601duration", "")
-	}
-
-	if timeoutObj.Single != "" {
-		err = validateISO8601TimeDuration(timeoutObj.Single)
-		if err != nil {
-			structLevel.ReportError(reflect.ValueOf(timeoutObj.Single), "Single", "single", "reqiso8601duration", "")
-		}
-	}
-}
-
-func init() {
-	val.GetValidator().RegisterStructValidationCtx(
-		StateExecTimeoutStructLevelValidation,
-		StateExecTimeout{},
-	)
-}

model/state_exec_timeout_test.go

@@ -142,23 +142,23 @@ func TestStateExecTimeoutStructLevelValidation(t *testing.T) {
 				Single: "PT10S",
 				Total:  "",
 			},
-			err: `Key: 'StateExecTimeout.Total' Error:Field validation for 'Total' failed on the 'required' tag\nKey: 'StateExecTimeout.Total' Error:Field validation for 'Total' failed on the 'reqiso8601duration' tag`,
+			err: `Key: 'StateExecTimeout.Total' Error:Field validation for 'Total' failed on the 'required' tag`,
 		},
 		{
 			desp: "invalid total duration",
 			timeout: StateExecTimeout{
 				Single: "PT10S",
 				Total:  "T10S",
 			},
-			err: `Key: 'StateExecTimeout.Total' Error:Field validation for 'Total' failed on the 'reqiso8601duration' tag`,
+			err: `Key: 'StateExecTimeout.Total' Error:Field validation for 'Total' failed on the 'iso8601duration' tag`,
 		},
 		{
 			desp: "invalid single duration",
 			timeout: StateExecTimeout{
 				Single: "T10S",
 				Total:  "PT10S",
 			},
-			err: `Key: 'StateExecTimeout.Single' Error:Field validation for 'Single' failed on the 'reqiso8601duration' tag`,
+			err: `Key: 'StateExecTimeout.Single' Error:Field validation for 'Single' failed on the 'iso8601duration' tag`,
 		},
 	}
 	for _, tc := range testCases {

model/util.go

@@ -21,8 +21,6 @@ import (
 	"os"
 	"path/filepath"
 	"strings"
-
-	"github.com/senseyeio/duration"
 )
 
 const prefix = "file:/"
@@ -92,8 +90,3 @@ func unmarshalFile(data []byte) (b []byte, err error) {
 	}
 	return file, nil
 }
-
-func validateISO8601TimeDuration(s string) error {
-	_, err := duration.ParseISO8601(s)
-	return err
-}

model/util_test.go

@@ -13,47 +13,3 @@
 // limitations under the License.
 
 package model
-
-import (
-	"testing"
-
-	"github.com/stretchr/testify/assert"
-)
-
-func TestValidateISO8601TimeDuration(t *testing.T) {
-	type testCase struct {
-		desp string
-		s    string
-		err  string
-	}
-	testCases := []testCase{
-		{
-			desp: "normal_all_designator",
-			s:    "P3Y6M4DT12H30M5S",
-			err:  ``,
-		},
-		{
-			desp: "normal_second_designator",
-			s:    "PT5S",
-			err:  ``,
-		},
-		{
-			desp: "empty value",
-			s:    "",
-			err:  `could not parse duration string`,
-		},
-	}
-	for _, tc := range testCases {
-		t.Run(tc.desp, func(t *testing.T) {
-			err := validateISO8601TimeDuration(tc.s)
-
-			if tc.err != "" {
-				assert.Error(t, err)
-				assert.Regexp(t, tc.err, err)
-				return
-			}
-
-			assert.NoError(t, err)
-		})
-	}
-}