examples

Author: WolvenSpirit

cover.out

@@ -1,4 +1,10 @@
 mode: set
+github.com/WolvenSpirit/node-graph-flow/circular.go:17.54,18.23 1 1
+github.com/WolvenSpirit/node-graph-flow/circular.go:18.23,19.24 1 1
+github.com/WolvenSpirit/node-graph-flow/circular.go:22.3,22.24 1 1
+github.com/WolvenSpirit/node-graph-flow/circular.go:25.3,26.52 2 1
+github.com/WolvenSpirit/node-graph-flow/circular.go:19.24,21.4 1 1
+github.com/WolvenSpirit/node-graph-flow/circular.go:22.24,24.4 1 1
 github.com/WolvenSpirit/node-graph-flow/main.go:15.38,17.2 1 1
 github.com/WolvenSpirit/node-graph-flow/main.go:25.30,27.2 1 1
 github.com/WolvenSpirit/node-graph-flow/main.go:29.50,30.36 1 1
@@ -25,9 +31,3 @@ github.com/WolvenSpirit/node-graph-flow/main.go:105.35,107.3 1 1
 github.com/WolvenSpirit/node-graph-flow/main.go:108.40,110.3 1 1
 github.com/WolvenSpirit/node-graph-flow/main.go:111.16,114.3 2 1
 github.com/WolvenSpirit/node-graph-flow/main.go:118.43,120.2 1 1
-github.com/WolvenSpirit/node-graph-flow/circular.go:17.54,18.23 1 1
-github.com/WolvenSpirit/node-graph-flow/circular.go:18.23,19.24 1 1
-github.com/WolvenSpirit/node-graph-flow/circular.go:22.3,22.24 1 1
-github.com/WolvenSpirit/node-graph-flow/circular.go:25.3,26.52 2 1
-github.com/WolvenSpirit/node-graph-flow/circular.go:19.24,21.4 1 1
-github.com/WolvenSpirit/node-graph-flow/circular.go:22.24,24.4 1 1

examples/basic/basic.go

@@ -0,0 +1,25 @@
+package main
+
+import (
+	"context"
+
+	flow "github.com/WolvenSpirit/node-graph-flow"
+)
+
+func main() {
+	node1 := flow.Node{Task: func(fc *flow.FlowContext, i flow.Input) (flow.Output, error) {
+		return "node1 Output\n", nil
+	}, Name: "node1"}
+	node2 := flow.Node{Task: func(fc *flow.FlowContext, i flow.Input) (flow.Output, error) {
+		return i.(string) + "node2 Output\n", nil
+	}, Name: "node2"}
+	node3 := flow.Node{Task: func(fc *flow.FlowContext, i flow.Input) (flow.Output, error) {
+		return i.(string) + "node3 Output\n", nil
+	}, Name: "node3"}
+	flow.BindNodes(&node1, &node2)
+	flow.BindNodes(&node2, &node3)
+	ctx, cancel := context.WithCancel(context.Background())
+	fctx := flow.FlowContext{Ctx: ctx, Cancel: cancel}
+	flow.StartFlow(&fctx, &node1)
+	println(node3.Output.(string))
+}

examples/circular/circular.go

@@ -0,0 +1,39 @@
+package main
+
+import (
+	"context"
+	"time"
+
+	flow "github.com/WolvenSpirit/node-graph-flow"
+)
+
+func main() {
+	stopChain := make(chan int, 1)
+
+	node1 := flow.Node{Task: func(fc *flow.FlowContext, i flow.Input) (flow.Output, error) {
+		println("node1 executing")
+		return nil, nil
+	}, Name: "node1"}
+	node2 := flow.Node{Task: func(fc *flow.FlowContext, i flow.Input) (flow.Output, error) {
+		println("node2 executing")
+		return nil, nil
+	}, Name: "node2"}
+	node3 := flow.Node{Task: func(fc *flow.FlowContext, i flow.Input) (flow.Output, error) {
+		println("node3 executing")
+		return nil, nil
+	}, Name: "node3"}
+
+	flow.BuildChain(&stopChain, &node1, &node2, &node3)
+
+	ctx, cancel := context.WithCancel(context.Background())
+	fctx := flow.FlowContext{Ctx: ctx, Cancel: cancel}
+
+	go func() {
+		println("Node chain loop start")
+		flow.StartFlow(&fctx, &node1)
+		println("Chain loop stop")
+	}()
+
+	time.Sleep(time.Second * 3)
+	stopChain <- 1
+}

main.go

@@ -18,16 +18,16 @@ func (err AbortError) Error() string {
 
 // Initialized context and cancel func need to be populated
 type FlowContext struct {
-	ctx    context.Context
-	cancel context.CancelFunc
+	Ctx    context.Context
+	Cancel context.CancelFunc
 }
 
 func (c *FlowContext) Init() {
-	c.ctx, c.cancel = context.WithCancel(context.Background())
+	c.Ctx, c.Cancel = context.WithCancel(context.Background())
 }
 
 func (c *FlowContext) IsCanceled() (bool, error) {
-	if err := c.ctx.Err(); err != nil {
+	if err := c.Ctx.Err(); err != nil {
 		return true, err
 	}
 	return false, nil
@@ -103,7 +103,7 @@ func Flow(ctx *FlowContext, n *Node, i Input, SubNodeIndex int, LateralNodeIndex
 		n.FlowTrail = append(n.ParentNode.FlowTrail, n.FlowTrail...)
 	}
 	if _, ok := err.(AbortError); ok {
-		ctx.cancel() // Unrecoverable error or inability to further process downstream with currently available inputs or no lateral nodes left
+		ctx.Cancel() // Unrecoverable error or inability to further process downstream with currently available inputs or no lateral nodes left
 	}
 	if len(n.SubNodes) != 0 && err == nil {
 		Flow(ctx, n.SubNodes[SubNodeIndex], o, SubNodeIndex, LateralNodeIndex, err)

main_test.go

@@ -151,7 +151,7 @@ func TestStartFlow(t *testing.T) {
 		args args
 	}{
 		{name: "Flow test",
-			args: args{n: &n1, ctx: &FlowContext{ctx: ctx, cancel: cancel}}},
+			args: args{n: &n1, ctx: &FlowContext{Ctx: ctx, Cancel: cancel}}},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {