v08 spec aligment - Added resultEventTimeout for action eventref (#90)

* v08 spec aligment - Added resultEventTimeout for action eventref

Signed-off-by: spolti <filippespolti@gmail.com>

* review update

Signed-off-by: spolti <filippespolti@gmail.com>

Signed-off-by: spolti <filippespolti@gmail.com>

Author: spolti

README.md

@@ -9,7 +9,7 @@ Current status of features implemented in the SDK is listed in the table below:
 | Parse workflow JSON and YAML definitions    | :heavy_check_mark: | 
 | Programmatically build workflow definitions | :no_entry_sign:    |
 | Validate workflow definitions (Schema)      | :heavy_check_mark: |
-| Validate workflow definitions (Integrity)   | :heavy_check_mark:    |
+| Validate workflow definitions (Integrity)   | :heavy_check_mark: |
 | Generate workflow diagram (SVG)             | :no_entry_sign:    |
 
 ## Status

model/event.go

@@ -15,10 +15,10 @@
 package model
 
 import (
+	val "github.com/serverlessworkflow/sdk-go/v2/validator"
 	"reflect"
 
 	validator "github.com/go-playground/validator/v10"
-	val "github.com/serverlessworkflow/sdk-go/v2/validator"
 )
 
 const (
@@ -30,17 +30,29 @@ const (
 
 func init() {
 	val.GetValidator().RegisterStructValidation(EventStructLevelValidation, Event{})
+	val.GetValidator().RegisterStructValidation(EventRefStructLevelValidation, EventRef{})
 }
 
 // EventStructLevelValidation custom validator for event kind consumed
 func EventStructLevelValidation(structLevel validator.StructLevel) {
 	event := structLevel.Current().Interface().(Event)
-
 	if event.Kind == EventKindConsumed && len(event.Type) == 0 {
 		structLevel.ReportError(reflect.ValueOf(event.Type), "Type", "type", "reqtypeconsumed", "")
 	}
 }
 
+// EventRefStructLevelValidation custom validator for event kind consumed
+func EventRefStructLevelValidation(structLevel validator.StructLevel) {
+	eventRef := structLevel.Current().Interface().(EventRef)
+
+	if len(eventRef.ResultEventTimeout) > 0 {
+		err := val.ValidateISO8601TimeDuration(eventRef.ResultEventTimeout)
+		if err != nil {
+			structLevel.ReportError(reflect.ValueOf(eventRef.ResultEventTimeout), "ResultEventTimeout", "resultEventTimeout", "reqiso8601duration", "")
+		}
+	}
+}
+
 // EventKind ...
 type EventKind string
 
@@ -75,9 +87,15 @@ type EventRef struct {
 	TriggerEventRef string `json:"triggerEventRef" validate:"required"`
 	// Reference to the unique name of a 'consumed' event definition
 	ResultEventRef string `json:"resultEventRef" validate:"required"`
+	// Maximum amount of time (ISO 8601 format) to wait for the result event. If not defined it will be set to the 'actionExecTimeout'
+	ResultEventTimeout string `json:"resultEventTimeout,omitempty"`
 	// TODO: create StringOrMap structure
-	// If string type, an expression which selects parts of the states data output to become the data (payload) of the event referenced by 'triggerEventRef'. If object type, a custom object to become the data (payload) of the event referenced by 'triggerEventRef'.
+	// If string type, an expression which selects parts of the states data output to become the data (payload) of the event referenced by 'triggerEventRef'.
+	// If object type, a custom object to become the data (payload) of the event referenced by 'triggerEventRef'.
 	Data interface{} `json:"data,omitempty"`
 	// Add additional extension context attributes to the produced event
 	ContextAttributes map[string]interface{} `json:"contextAttributes,omitempty"`
 }
+
+// InvokeKind ...
+type InvokeKind string

model/event_test.go

@@ -0,0 +1,63 @@
+// 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 TestEventRefStructLevelValidation(t *testing.T) {
+	type testCase struct {
+		name     string
+		eventRef EventRef
+		err      string
+	}
+
+	testCases := []testCase{
+		{
+			name: "valid resultEventTimeout",
+			eventRef: EventRef{
+				TriggerEventRef:    "example valid",
+				ResultEventRef:     "example valid",
+				ResultEventTimeout: "PT1H",
+			},
+			err: ``,
+		},
+		{
+			name: "invalid resultEventTimeout",
+			eventRef: EventRef{
+				TriggerEventRef:    "example invalid",
+				ResultEventRef:     "example invalid red",
+				ResultEventTimeout: "10hs",
+			},
+			err: `Key: 'EventRef.ResultEventTimeout' Error:Field validation for 'ResultEventTimeout' failed on the 'reqiso8601duration' tag`,
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			err := val.GetValidator().Struct(tc.eventRef)
+
+			if tc.err != "" {
+				assert.Error(t, err)
+				assert.Regexp(t, tc.err, err)
+				return
+			}
+			assert.NoError(t, err)
+		})
+	}
+}

parser/testdata/workflows/greetings-v08-spec.sw.yaml

@@ -35,6 +35,10 @@ states:
             name: "${ .greet | .name }"
         actionDataFilter:
           dataResultsPath: "${ .payload | .greeting }"
+      - eventRef:
+          triggerEventRef: example
+          resultEventRef: example
+          resultEventTimeout: PT1H
     stateDataFilter:
       dataOutputPath: "${ .greeting }"
     transition: SendTextForHighPriority