v08 - fix ContinueAs data field assignment (#92)

spolti · web-flow · commit 28e2e7d10da6 · 2022-10-05T10:26:02.000-03:00
Signed-off-by: spolti &lt;filippespolti@gmail.com&gt;

Signed-off-by: spolti &lt;filippespolti@gmail.com&gt;
diff --git a/model/action.go b/model/action.go
@@ -108,58 +108,7 @@ func (f *FunctionRef) UnmarshalJSON(data []byte) error {
 		return nil
 	}
 
-	return fmt.Errorf("functionRef value '%s' not support, it must be an object or string", string(data))
-}
-
-// WorkflowRef holds a reference for a workflow definition
-type WorkflowRef struct {
-	// Sub-workflow unique id
-	WorkflowID string `json:"workflowId" validate:"required"`
-	// Sub-workflow version
-	Version string `json:"version,omitempty"`
-
-	// Invoke specifies if the subflow should be invoked sync or async.
-	// Defaults to sync.
-	Invoke InvokeKind `json:"invoke,omitempty" validate:"required,oneof=async sync"`
-
-	// OnParantComplete specifies how subflow execution should behave when parent workflow completes if invoke is 'async'。
-	// Defaults to terminate.
-	OnParentComplete string `json:"onParentComplete,omitempty" validate:"required,oneof=terminate continue"`
-}
-
-type workflowRefForUnmarshal WorkflowRef
-
-// UnmarshalJSON implements json.Unmarshaler
-func (s *WorkflowRef) UnmarshalJSON(data []byte) error {
-	data = bytes.TrimSpace(data)
-	if len(data) == 0 {
-		return fmt.Errorf("no bytes to unmarshal")
-	}
-
-	var err error
-	switch data[0] {
-	case '"':
-		s.WorkflowID, err = unmarshalString(data)
-		if err != nil {
-			return err
-		}
-		s.Invoke, s.OnParentComplete = InvokeKindSync, "terminate"
-		return nil
-	case '{':
-		v := workflowRefForUnmarshal{
-			Invoke:           InvokeKindSync,
-			OnParentComplete: "terminate",
-		}
-		err = json.Unmarshal(data, &v)
-		if err != nil {
-			// TODO: replace the error message with correct type's name
-			return err
-		}
-		*s = WorkflowRef(v)
-		return nil
-	}
-
-	return fmt.Errorf("subFlowRef value '%s' not support, it must be an object or string", string(data))
+	return fmt.Errorf("functionRef value '%s' is not supported, it must be an object or string", string(data))
 }
 
 // Sleep defines time periods workflow execution should sleep before & after function execution
diff --git a/model/action_test.go b/model/action_test.go
@@ -86,7 +86,7 @@ func TestWorkflowRefUnmarshalJSON(t *testing.T) {
 			desp:   "invalid string or object",
 			data:   `1`,
 			expect: WorkflowRef{},
-			err:    `subFlowRef value '1' not support, it must be an object or string`,
+			err:    `subFlowRef value '1' is not supported, it must be an object or string`,
 		},
 	}
 	for _, tc := range testCases {
diff --git a/model/auth.go b/model/auth.go
@@ -107,7 +107,7 @@ func (a *AuthDefinitions) UnmarshalJSON(b []byte) error {
 		return a.unmarshalMany(b)
 	}
 
-	return fmt.Errorf("auth value '%s' not support, it must be an array or string", string(b))
+	return fmt.Errorf("auth value '%s' is not supported, it must be an array or string", string(b))
 }
 
 func (a *AuthDefinitions) unmarshalFile(data []byte) error {
diff --git a/model/event.go b/model/event.go
@@ -50,7 +50,7 @@ func EventRefStructLevelValidation(structLevel validator.StructLevel) {
 	if len(eventRef.ResultEventTimeout) > 0 {
 		err := val.ValidateISO8601TimeDuration(eventRef.ResultEventTimeout)
 		if err != nil {
-			structLevel.ReportError(reflect.ValueOf(eventRef.ResultEventTimeout), "ResultEventTimeout", "resultEventTimeout", "reqiso8601duration", "")
+			structLevel.ReportError(reflect.ValueOf(eventRef.ResultEventTimeout), "ResultEventTimeout", "resultEventTimeout", "iso8601duration", "")
 		}
 	}
 }
diff --git a/model/event_test.go b/model/event_test.go
@@ -48,7 +48,7 @@ func TestEventRefStructLevelValidation(t *testing.T) {
 				ResultEventTimeout: "10hs",
 				Invoke:             InvokeKindSync,
 			},
-			err: `Key: 'EventRef.ResultEventTimeout' Error:Field validation for 'ResultEventTimeout' failed on the 'reqiso8601duration' tag`,
+			err: `Key: 'EventRef.ResultEventTimeout' Error:Field validation for 'ResultEventTimeout' failed on the 'iso8601duration' tag`,
 		},
 	}
 
diff --git a/model/state_exec_timeout.go b/model/state_exec_timeout.go
@@ -28,7 +28,7 @@ type StateExecTimeout struct {
 	Total string `json:"total" validate:"required,iso8601duration"`
 }
 
-// just define another type to unmarshal object, so the UnmarshalJSON will not called recursively
+// just define another type to unmarshal object, so the UnmarshalJSON will not be called recursively
 type stateExecTimeoutForUnmarshal StateExecTimeout
 
 // UnmarshalJSON unmarshal StateExecTimeout object from json bytes
@@ -57,5 +57,5 @@ func (s *StateExecTimeout) UnmarshalJSON(data []byte) error {
 		return nil
 	}
 
-	return fmt.Errorf("stateExecTimeout value '%s' not support, it must be an object or string", string(data))
+	return fmt.Errorf("stateExecTimeout value '%s' is not supported, it must be an object or string", string(data))
 }
diff --git a/model/state_exec_timeout_test.go b/model/state_exec_timeout_test.go
@@ -71,7 +71,7 @@ func TestStateExecTimeoutUnmarshalJSON(t *testing.T) {
 			data: `PT10S`,
 
 			expect: &StateExecTimeout{},
-			err:    `stateExecTimeout value 'PT10S' not support, it must be an object or string`,
+			err:    `stateExecTimeout value 'PT10S' is not supported, it must be an object or string`,
 		},
 		{
 			desp: "invalid total type",
diff --git a/model/states.go b/model/states.go
@@ -16,7 +16,6 @@ package model
 
 import (
 	"encoding/json"
-
 	"k8s.io/apimachinery/pkg/util/intstr"
 )
 
diff --git a/model/workflow.go b/model/workflow.go
@@ -17,6 +17,9 @@ package model
 import (
 	"encoding/json"
 	"fmt"
+	"github.com/go-playground/validator/v10"
+	val "github.com/serverlessworkflow/sdk-go/v2/validator"
+	"reflect"
 )
 
 // InvokeKind defines how the target is invoked.
@@ -58,6 +61,20 @@ var actionsModelMapping = map[string]func(state map[string]interface{}) State{
 	StateTypeSleep:    func(map[string]interface{}) State { return &SleepState{} },
 }
 
+func init() {
+	val.GetValidator().RegisterStructValidation(continueAsStructLevelValidation, ContinueAs{})
+}
+
+func continueAsStructLevelValidation(structLevel validator.StructLevel) {
+	continueAs := structLevel.Current().Interface().(ContinueAs)
+	if len(continueAs.WorkflowExecTimeout.Duration) > 0 {
+		if err := val.ValidateISO8601TimeDuration(continueAs.WorkflowExecTimeout.Duration); err != nil {
+			structLevel.ReportError(reflect.ValueOf(continueAs.WorkflowExecTimeout.Duration),
+				"workflowExecTimeout", "duration", "iso8601duration", "")
+		}
+	}
+}
+
 // ActionMode ...
 type ActionMode string
 
@@ -493,16 +510,55 @@ func (e *End) UnmarshalJSON(data []byte) error {
 	return nil
 }
 
-// ContinueAs ...
+// ContinueAs can be used to stop the current workflow execution and start another one (of the same or a different type)
 type ContinueAs struct {
 	WorkflowRef
 	// TODO: add object or string data type
-	// If string type, an expression which selects parts of the states data output to become the workflow data input of continued execution. If object type, a custom object to become the workflow data input of the continued execution
+	// If string type, an expression which selects parts of the states data output to become the workflow data input of
+	// continued execution. If object type, a custom object to become the workflow data input of the continued execution
 	Data interface{} `json:"data,omitempty"`
 	// WorkflowExecTimeout Workflow execution timeout to be used by the workflow continuing execution. Overwrites any specific settings set by that workflow
 	WorkflowExecTimeout WorkflowExecTimeout `json:"workflowExecTimeout,omitempty"`
 }
 
+type continueAsForUnmarshal ContinueAs
+
+func (c *ContinueAs) UnmarshalJSON(data []byte) error {
+	continueAs := make(map[string]json.RawMessage)
+	if err := json.Unmarshal(data, &continueAs); err != nil {
+		c.WorkflowID, err = unmarshalString(data)
+		if err != nil {
+			return err
+		}
+		return nil
+	}
+
+	if err := unmarshalKey("data", continueAs, &c.Data); err != nil {
+		return err
+	}
+	if err := unmarshalKey("workflowExecTimeout", continueAs, &c.WorkflowExecTimeout); err != nil {
+		return err
+	}
+
+	v := continueAsForUnmarshal{
+		WorkflowRef: WorkflowRef{
+			Invoke:           "sync",
+			OnParentComplete: "terminate",
+		},
+		Data:                c.Data,
+		WorkflowExecTimeout: c.WorkflowExecTimeout,
+	}
+
+	err := json.Unmarshal(data, &v)
+	if err != nil {
+		return fmt.Errorf("continueAs value '%s' is not supported, it must be an object or string", string(data))
+	}
+
+	*c = ContinueAs(v)
+	return nil
+
+}
+
 // ProduceEvent ...
 type ProduceEvent struct {
 	// References a name of a defined event
diff --git a/model/workflow_ref.go b/model/workflow_ref.go
@@ -0,0 +1,72 @@
+// Copyright 2022 The Serverless Workflow Specification Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package model
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+)
+
+// WorkflowRef holds a reference for a workflow definition
+type WorkflowRef struct {
+	// Sub-workflow unique id
+	WorkflowID string `json:"workflowId" validate:"required"`
+	// Sub-workflow version
+	Version string `json:"version,omitempty"`
+
+	// Invoke specifies if the subflow should be invoked sync or async.
+	// Defaults to sync.
+	Invoke InvokeKind `json:"invoke,omitempty" validate:"required,oneof=async sync"`
+
+	// OnParantComplete specifies how subflow execution should behave when parent workflow completes if invoke is 'async'。
+	// Defaults to terminate.
+	OnParentComplete string `json:"onParentComplete,omitempty" validate:"required,oneof=terminate continue"`
+}
+
+type workflowRefForUnmarshal WorkflowRef
+
+// UnmarshalJSON implements json.Unmarshaler
+func (s *WorkflowRef) UnmarshalJSON(data []byte) error {
+	data = bytes.TrimSpace(data)
+	if len(data) == 0 {
+		return fmt.Errorf("no bytes to unmarshal")
+	}
+
+	var err error
+	switch data[0] {
+	case '"':
+		s.WorkflowID, err = unmarshalString(data)
+		if err != nil {
+			return err
+		}
+		s.Invoke, s.OnParentComplete = InvokeKindSync, "terminate"
+		return nil
+	case '{':
+		v := workflowRefForUnmarshal{
+			Invoke:           InvokeKindSync,
+			OnParentComplete: "terminate",
+		}
+		err = json.Unmarshal(data, &v)
+		if err != nil {
+			// TODO: replace the error message with correct type's name
+			return err
+		}
+		*s = WorkflowRef(v)
+		return nil
+	}
+
+	return fmt.Errorf("subFlowRef value '%s' is not supported, it must be an object or string", string(data))
+}
diff --git a/model/workflow_test.go b/model/workflow_test.go
@@ -0,0 +1,77 @@
+// Copyright 2022 The Serverless Workflow Specification Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package model
+
+import (
+	val "github.com/serverlessworkflow/sdk-go/v2/validator"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestContinueAsStructLevelValidation(t *testing.T) {
+	type testCase struct {
+		name       string
+		continueAs ContinueAs
+		err        string
+	}
+
+	testCases := []testCase{
+		{
+			name: "valid ContinueAs",
+			continueAs: ContinueAs{
+				WorkflowRef: WorkflowRef{
+					WorkflowID:       "another-test",
+					Version:          "2",
+					Invoke:           "sync",
+					OnParentComplete: "terminate",
+				},
+				Data: "${ del(.customerCount) }",
+				WorkflowExecTimeout: WorkflowExecTimeout{
+					Duration:  "PT1H",
+					Interrupt: false,
+					RunBefore: "test",
+				},
+			},
+			err: ``,
+		},
+		{
+			name: "invalid WorkflowExecTimeout",
+			continueAs: ContinueAs{
+				WorkflowRef: WorkflowRef{
+					WorkflowID: "test",
+					Version:    "1",
+				},
+				Data: "${ del(.customerCount) }",
+				WorkflowExecTimeout: WorkflowExecTimeout{
+					Duration: "invalid",
+				},
+			},
+			err: `Key: 'ContinueAs.workflowExecTimeout' Error:Field validation for 'workflowExecTimeout' failed on the 'iso8601duration' tag`,
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			err := val.GetValidator().Struct(tc.continueAs)
+
+			if tc.err != "" {
+				assert.Error(t, err)
+				assert.Regexp(t, tc.err, err)
+				return
+			}
+			assert.NoError(t, err)
+		})
+	}
+}
diff --git a/parser/parser_test.go b/parser/parser_test.go
@@ -329,6 +329,25 @@ func TestFromFile(t *testing.T) {
 				assert.Equal(t, "PT30D", w.Timeouts.WorkflowExecTimeout.Duration)
 				assert.Equal(t, "CancelOrder", w.Timeouts.WorkflowExecTimeout.RunBefore)
 			},
+		}, {
+			"./testdata/workflows/continue-as-example.yaml", func(t *testing.T, w *model.Workflow) {
+				assert.Equal(t, "Notify Customer", w.Name)
+				eventState := w.States[1].(*model.DataBasedSwitchState)
+
+				assert.NotNil(t, eventState)
+				assert.NotEmpty(t, eventState.DataConditions)
+				assert.IsType(t, &model.EndDataCondition{}, eventState.DataConditions[0])
+
+				endDataCondition := eventState.DataConditions[0].(*model.EndDataCondition)
+				assert.Equal(t, "notifycustomerworkflow", endDataCondition.End.ContinueAs.WorkflowRef.WorkflowID)
+				assert.Equal(t, "1.0", endDataCondition.End.ContinueAs.WorkflowRef.Version)
+				assert.Equal(t, "${ del(.customerCount) }", endDataCondition.End.ContinueAs.Data)
+				assert.Equal(t, "GenerateReport", endDataCondition.End.ContinueAs.WorkflowExecTimeout.RunBefore)
+				assert.Equal(t, true, endDataCondition.End.ContinueAs.WorkflowExecTimeout.Interrupt)
+				assert.Equal(t, "PT1H", endDataCondition.End.ContinueAs.WorkflowExecTimeout.Duration)
+				assert.Equal(t, model.InvokeKindSync, endDataCondition.End.ContinueAs.Invoke)
+				assert.Equal(t, "terminate", endDataCondition.End.ContinueAs.OnParentComplete)
+			},
 		},
 	}
 	for _, file := range files {
diff --git a/parser/testdata/workflows/continue-as-example.yaml b/parser/testdata/workflows/continue-as-example.yaml

Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ func TestWorkflowRefUnmarshalJSON(t *testing.T) {`
`86`	`86`	`desp: "invalid string or object",`
`87`	`87`	data: `1`,
`88`	`88`	`expect: WorkflowRef{},`
`89`		- err: `subFlowRef value '1' not support, it must be an object or string`,
	`89`	+ err: `subFlowRef value '1' is not supported, it must be an object or string`,
`90`	`90`	`},`
`91`	`91`	`}`
`92`	`92`	`for _, tc := range testCases {`
Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,7 @@ func (a *AuthDefinitions) UnmarshalJSON(b []byte) error {`
`107`	`107`	`return a.unmarshalMany(b)`
`108`	`108`	`}`
`109`	`109`
`110`		`- return fmt.Errorf("auth value '%s' not support, it must be an array or string", string(b))`
	`110`	`+ return fmt.Errorf("auth value '%s' is not supported, it must be an array or string", string(b))`
`111`	`111`	`}`
`112`	`112`
`113`	`113`	`func (a *AuthDefinitions) unmarshalFile(data []byte) error {`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ func EventRefStructLevelValidation(structLevel validator.StructLevel) {`
`50`	`50`	`if len(eventRef.ResultEventTimeout) > 0 {`
`51`	`51`	`err := val.ValidateISO8601TimeDuration(eventRef.ResultEventTimeout)`
`52`	`52`	`if err != nil {`
`53`		`- structLevel.ReportError(reflect.ValueOf(eventRef.ResultEventTimeout), "ResultEventTimeout", "resultEventTimeout", "reqiso8601duration", "")`
	`53`	`+ structLevel.ReportError(reflect.ValueOf(eventRef.ResultEventTimeout), "ResultEventTimeout", "resultEventTimeout", "iso8601duration", "")`
`54`	`54`	`}`
`55`	`55`	`}`
`56`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ func TestEventRefStructLevelValidation(t *testing.T) {`
`48`	`48`	`ResultEventTimeout: "10hs",`
`49`	`49`	`Invoke: InvokeKindSync,`
`50`	`50`	`},`
`51`		- err: `Key: 'EventRef.ResultEventTimeout' Error:Field validation for 'ResultEventTimeout' failed on the 'reqiso8601duration' tag`,
	`51`	+ err: `Key: 'EventRef.ResultEventTimeout' Error:Field validation for 'ResultEventTimeout' failed on the 'iso8601duration' tag`,
`52`	`52`	`},`
`53`	`53`	`}`
`54`	`54`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ type StateExecTimeout struct {`
`28`	`28`	Total string `json:"total" validate:"required,iso8601duration"`
`29`	`29`	`}`
`30`	`30`
`31`		`-// just define another type to unmarshal object, so the UnmarshalJSON will not called recursively`
	`31`	`+// just define another type to unmarshal object, so the UnmarshalJSON will not be called recursively`
`32`	`32`	`type stateExecTimeoutForUnmarshal StateExecTimeout`
`33`	`33`
`34`	`34`	`// UnmarshalJSON unmarshal StateExecTimeout object from json bytes`
`@@ -57,5 +57,5 @@ func (s *StateExecTimeout) UnmarshalJSON(data []byte) error {`
`57`	`57`	`return nil`
`58`	`58`	`}`
`59`	`59`
`60`		`- return fmt.Errorf("stateExecTimeout value '%s' not support, it must be an object or string", string(data))`
	`60`	`+ return fmt.Errorf("stateExecTimeout value '%s' is not supported, it must be an object or string", string(data))`
`61`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ func TestStateExecTimeoutUnmarshalJSON(t *testing.T) {`
`71`	`71`	data: `PT10S`,
`72`	`72`
`73`	`73`	`expect: &StateExecTimeout{},`
`74`		- err: `stateExecTimeout value 'PT10S' not support, it must be an object or string`,
	`74`	+ err: `stateExecTimeout value 'PT10S' is not supported, it must be an object or string`,
`75`	`75`	`},`
`76`	`76`	`{`
`77`	`77`	`desp: "invalid total type",`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,6 @@ package model`
`16`	`16`
`17`	`17`	`import (`
`18`	`18`	`"encoding/json"`
`19`		`-`
`20`	`19`	`"k8s.io/apimachinery/pkg/util/intstr"`
`21`	`20`	`)`
`22`	`21`