Refactor expr packaged and shared context

Signed-off-by: Ricardo Zanini <[email protected]>

Author: ricardozanini

expr/expr.go

@@ -12,33 +12,76 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package impl
+package ctx
 
 import (
 	"context"
 	"errors"
+	"github.com/serverlessworkflow/sdk-go/v3/model"
 	"sync"
 )
 
+var ErrWorkflowContextNotFound = errors.New("workflow context not found")
+
+var _ WorkflowContext = &workflowContext{}
+
 type ctxKey string
 
-const runnerCtxKey ctxKey = "wfRunnerContext"
+const (
+	runnerCtxKey ctxKey = "wfRunnerContext"
+	varsContext         = "$context"
+	varsInput           = "$input"
+	varsOutput          = "$output"
+	varsWorkflow        = "$workflow"
+)
+
+type WorkflowContext interface {
+	SetStatus(status StatusPhase)
+	SetTaskStatus(task string, status StatusPhase)
+	SetInstanceCtx(value interface{})
+	GetInstanceCtx() interface{}
+	SetInput(input interface{})
+	GetInput() interface{}
+	SetOutput(output interface{})
+	GetOutput() interface{}
+	GetOutputAsMap() map[string]interface{}
+	AsJQVars() map[string]interface{}
+}
 
-// WorkflowContext holds the necessary data for the workflow execution within the instance.
-type WorkflowContext struct {
+// workflowContext holds the necessary data for the workflow execution within the instance.
+type workflowContext struct {
 	mu               sync.Mutex
-	input            interface{} // input can hold any type
-	output           interface{} // output can hold any type
-	context          map[string]interface{}
+	input            interface{}            // $input can hold any type
+	output           interface{}            // $output can hold any type
+	context          map[string]interface{} // Holds `$context` as the key
+	definition       map[string]interface{} // $workflow representation in the context
 	StatusPhase      []StatusPhaseLog
-	TasksStatusPhase map[string][]StatusPhaseLog // Holds `$context` as the key
+	TasksStatusPhase map[string][]StatusPhaseLog
 }
 
-type TaskContext interface {
-	SetTaskStatus(task string, status StatusPhase)
+func NewWorkflowContext(workflow *model.Workflow) (WorkflowContext, error) {
+	workflowCtx := &workflowContext{}
+	workflowDef, err := workflow.AsMap()
+	if err != nil {
+		return nil, err
+	}
+
+	workflowCtx.definition = workflowDef
+	workflowCtx.SetStatus(PendingStatus)
+
+	return workflowCtx, nil
+}
+
+func (ctx *workflowContext) AsJQVars() map[string]interface{} {
+	vars := make(map[string]interface{})
+	vars[varsInput] = ctx.GetInput()
+	vars[varsOutput] = ctx.GetOutput()
+	vars[varsContext] = ctx.GetInstanceCtx()
+	vars[varsOutput] = ctx.definition
+	return vars
 }
 
-func (ctx *WorkflowContext) SetStatus(status StatusPhase) {
+func (ctx *workflowContext) SetStatus(status StatusPhase) {
 	ctx.mu.Lock()
 	defer ctx.mu.Unlock()
 	if ctx.StatusPhase == nil {
@@ -47,7 +90,7 @@ func (ctx *WorkflowContext) SetStatus(status StatusPhase) {
 	ctx.StatusPhase = append(ctx.StatusPhase, NewStatusPhaseLog(status))
 }
 
-func (ctx *WorkflowContext) SetTaskStatus(task string, status StatusPhase) {
+func (ctx *workflowContext) SetTaskStatus(task string, status StatusPhase) {
 	ctx.mu.Lock()
 	defer ctx.mu.Unlock()
 	if ctx.TasksStatusPhase == nil {
@@ -57,56 +100,56 @@ func (ctx *WorkflowContext) SetTaskStatus(task string, status StatusPhase) {
 }
 
 // SetInstanceCtx safely sets the `$context` value
-func (ctx *WorkflowContext) SetInstanceCtx(value interface{}) {
+func (ctx *workflowContext) SetInstanceCtx(value interface{}) {
 	ctx.mu.Lock()
 	defer ctx.mu.Unlock()
 	if ctx.context == nil {
 		ctx.context = make(map[string]interface{})
 	}
-	ctx.context["$context"] = value
+	ctx.context[varsContext] = value
 }
 
 // GetInstanceCtx safely retrieves the `$context` value
-func (ctx *WorkflowContext) GetInstanceCtx() interface{} {
+func (ctx *workflowContext) GetInstanceCtx() interface{} {
 	ctx.mu.Lock()
 	defer ctx.mu.Unlock()
 	if ctx.context == nil {
 		return nil
 	}
-	return ctx.context["$context"]
+	return ctx.context[varsContext]
 }
 
 // SetInput safely sets the input
-func (ctx *WorkflowContext) SetInput(input interface{}) {
+func (ctx *workflowContext) SetInput(input interface{}) {
 	ctx.mu.Lock()
 	defer ctx.mu.Unlock()
 	ctx.input = input
 }
 
 // GetInput safely retrieves the input
-func (ctx *WorkflowContext) GetInput() interface{} {
+func (ctx *workflowContext) GetInput() interface{} {
 	ctx.mu.Lock()
 	defer ctx.mu.Unlock()
 	return ctx.input
 }
 
 // SetOutput safely sets the output
-func (ctx *WorkflowContext) SetOutput(output interface{}) {
+func (ctx *workflowContext) SetOutput(output interface{}) {
 	ctx.mu.Lock()
 	defer ctx.mu.Unlock()
 	ctx.output = output
 }
 
 // GetOutput safely retrieves the output
-func (ctx *WorkflowContext) GetOutput() interface{} {
+func (ctx *workflowContext) GetOutput() interface{} {
 	ctx.mu.Lock()
 	defer ctx.mu.Unlock()
 	return ctx.output
 }
 
 // GetInputAsMap safely retrieves the input as a map[string]interface{}.
 // If input is not a map, it creates a map with an empty string key and the input as the value.
-func (ctx *WorkflowContext) GetInputAsMap() map[string]interface{} {
+func (ctx *workflowContext) GetInputAsMap() map[string]interface{} {
 	ctx.mu.Lock()
 	defer ctx.mu.Unlock()
 
@@ -122,7 +165,7 @@ func (ctx *WorkflowContext) GetInputAsMap() map[string]interface{} {
 
 // GetOutputAsMap safely retrieves the output as a map[string]interface{}.
 // If output is not a map, it creates a map with an empty string key and the output as the value.
-func (ctx *WorkflowContext) GetOutputAsMap() map[string]interface{} {
+func (ctx *workflowContext) GetOutputAsMap() map[string]interface{} {
 	ctx.mu.Lock()
 	defer ctx.mu.Unlock()
 
@@ -136,16 +179,16 @@ func (ctx *WorkflowContext) GetOutputAsMap() map[string]interface{} {
 	}
 }
 
-// WithWorkflowContext adds the WorkflowContext to a parent context
-func WithWorkflowContext(parent context.Context, wfCtx *WorkflowContext) context.Context {
+// WithWorkflowContext adds the workflowContext to a parent context
+func WithWorkflowContext(parent context.Context, wfCtx WorkflowContext) context.Context {
 	return context.WithValue(parent, runnerCtxKey, wfCtx)
 }
 
-// GetWorkflowContext retrieves the WorkflowContext from a context
-func GetWorkflowContext(ctx context.Context) (*WorkflowContext, error) {
-	wfCtx, ok := ctx.Value(runnerCtxKey).(*WorkflowContext)
+// GetWorkflowContext retrieves the workflowContext from a context
+func GetWorkflowContext(ctx context.Context) (WorkflowContext, error) {
+	wfCtx, ok := ctx.Value(runnerCtxKey).(*workflowContext)
 	if !ok {
-		return nil, errors.New("workflow context not found")
+		return nil, ErrWorkflowContextNotFound
 	}
 	return wfCtx, nil
 }

impl/context.go renamed to impl/ctx/context.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package impl
+package ctx
 
 import "time"