review additions

Signed-off-by: Spolti <[email protected]>

Author: spolti

Makefile

@@ -14,6 +14,7 @@ lint:
 
 .PHONY: test
 coverage="false"
+
 test: deepcopy buildergen
 	make lint
 	@go test ./...

builder/builder_test.go

@@ -17,6 +17,7 @@ package builder
 import (
 	"testing"
 
+	"github.com/pkg/errors"
 	"github.com/stretchr/testify/assert"
 
 	"github.com/serverlessworkflow/sdk-go/v2/model"
@@ -58,7 +59,13 @@ func TestValidate(t *testing.T) {
 	state2.End().Terminate(true)
 	err = Validate(state2.Build())
 	if assert.Error(t, err) {
-		assert.Equal(t, "state.name is required", err.(val.WorkflowErrors)[0].Error())
+		var workflowErrors val.WorkflowErrors
+		if errors.As(err, &workflowErrors) {
+			assert.Equal(t, "state.name is required", workflowErrors[0].Error())
+		} else {
+			// Handle other error types if necessary
+			t.Errorf("Unexpected error: %v", err)
+		}
 	}
 }
 

model/workflow.go

@@ -15,8 +15,8 @@
 package model
 
 import (
-	"bytes"
 	"encoding/json"
+	"regexp"
 
 	"github.com/serverlessworkflow/sdk-go/v2/util"
 )
@@ -122,7 +122,7 @@ type BaseWorkflow struct {
 	// qualities.
 	// +optional
 	Annotations []string `json:"annotations,omitempty"`
-	// DataInputSchema URI of the JSON Schema used to validate the workflow data input
+	// DataInputSchema URI or Object of the JSON Schema used to validate the workflow data input
 	// +optional
 	DataInputSchema *DataInputSchema `json:"dataInputSchema,omitempty"`
 	// Serverless Workflow schema version
@@ -522,12 +522,32 @@ type dataInputSchemaUnmarshal DataInputSchema
 // UnmarshalJSON implements json.Unmarshaler
 func (d *DataInputSchema) UnmarshalJSON(data []byte) error {
 	d.ApplyDefault()
-	if data[0] == '"' && len(data) > 0 {
-		replaced := bytes.Replace(data, []byte(`"`), []byte(``), -1)
-		repp := FromString(string(replaced))
-		d.Schema = &repp
-	} else {
-		return util.UnmarshalObject("dataInputSchema", data, (*dataInputSchemaUnmarshal)(d))
+	err := util.UnmarshalObject("dataInputSchema", data, (*dataInputSchemaUnmarshal)(d))
+	if err != nil {
+
+		return err
+	}
+
+	if d.Schema != nil && d.Schema.Type == String {
+		// Define the regex pattern to match the prefixes
+		pattern := `^(http|https|file)`
+		regex := regexp.MustCompile(pattern)
+		// if it is not external, treat as JSON object
+		if !regex.MatchString(d.Schema.StringValue) {
+			point := FromString(d.Schema.StringValue)
+			d.Schema = &point
+			return nil
+		}
+
+		data, err := util.LoadExternalResource(d.Schema.StringValue)
+		if err != nil {
+			return err
+		}
+
+		er := util.UnmarshalObject("schema", data, &d.Schema)
+		// clean the string value to avoid the json URI being appended
+		d.Schema.StringValue = ""
+		return er
 	}
 	return nil
 }

model/workflow_test.go

@@ -516,7 +516,7 @@ func TestDataInputSchemaUnmarshalJSON(t *testing.T) {
 				Schema:                 &schemaName,
 				FailOnValidationErrors: true,
 			},
-			err: ``,
+			err: `dataInputSchema must be string or object`,
 		},
 		{
 			desp: `object success`,

model/workflow_validator_test.go

@@ -449,6 +449,7 @@ func TestDataInputSchemaStructLevelValidation(t *testing.T) {
 		},
 	}
 
+	//fmt.Printf("%+v", testCases[0].Model)
 	StructLevelValidationCtx(t, testCases)
 }
 

model/zz_generated.buildergen.go

@@ -583,8 +583,12 @@ func TestFromFile(t *testing.T) {
 		}, {
 			"./testdata/workflows/dataInputSchemaValidation.yaml", func(t *testing.T, w *model.Workflow) {
 				assert.NotNil(t, w.DataInputSchema)
-				expected := model.FromString("sample schema")
-				assert.Equal(t, &expected, w.DataInputSchema.Schema)
+				expected := model.DataInputSchema{}
+				data, err := util.LoadExternalResource("file://testdata/datainputschema.json")
+				err1 := util.UnmarshalObject("schema", data, &expected.Schema)
+				assert.Nil(t, err)
+				assert.Nil(t, err1)
+				assert.Equal(t, expected.Schema, w.DataInputSchema.Schema)
 				assert.Equal(t, false, w.DataInputSchema.FailOnValidationErrors)
 			},
 		}, {

parser/parser_test.go

@@ -0,0 +1,16 @@
+{
+  "title": "Hello World Schema",
+  "properties": {
+    "person": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "name"
+      ]
+    }
+  }
+}

parser/testdata/datainputschema.json

@@ -18,7 +18,7 @@ specVersion: '0.8'
 start: Start
 dataInputSchema:
   failOnValidationErrors: false
-  schema: "sample schema"
+  schema: "file://testdata/datainputschema.json"
 states:
 - name: Start
   type: inject

parser/testdata/workflows/dataInputSchemaValidation.yaml

@@ -72,6 +72,13 @@ func (e *UnmarshalError) Error() string {
 func (e *UnmarshalError) unmarshalMessageError(err *json.UnmarshalTypeError) string {
 	if err.Struct == "" && err.Field == "" {
 		primitiveTypeName := e.primitiveType.String()
+
+		// in some cases the e.primitiveType might be invalid, one of the reasons is because it is nil
+		// default to string in that case
+		if e.primitiveType == reflect.Invalid {
+			primitiveTypeName = "string"
+		}
+
 		var objectTypeName string
 		if e.objectType != reflect.Invalid {
 			switch e.objectType {
@@ -107,7 +114,7 @@ func (e *UnmarshalError) unmarshalMessageError(err *json.UnmarshalTypeError) str
 	return err.Error()
 }
 
-func loadExternalResource(url string) (b []byte, err error) {
+func LoadExternalResource(url string) (b []byte, err error) {
 	index := strings.Index(url, "://")
 	if index == -1 {
 		b, err = getBytesFromFile(url)
@@ -199,7 +206,7 @@ func UnmarshalObjectOrFile[U any](parameterName string, data []byte, valObject *
 
 	// Assumes that the value inside `data` is a path to a known location.
 	// Returns the content of the file or a not nil error reference.
-	data, err = loadExternalResource(valString)
+	data, err = LoadExternalResource(valString)
 	if err != nil {
 		return err
 	}