Merge pull request #87 from spiral/bug/collects_loop_issue

fix(collects): Bug in the Collects loop with early exit

.golangci.yml

@@ -17,7 +17,6 @@ linters:
     - nakedret
     - nolintlint
     - rowserrcheck
-    - scopelint
     - staticcheck
     - structcheck
     - typecheck

examples/sample_1/main.go

@@ -64,4 +64,4 @@ func main() {
 			return
 		}
 	}
-}
+}

pkg/container/calculate_deps.go

@@ -159,22 +159,28 @@ func (e *Endure) implCollectorPath(vrtx *vertex.Vertex) error {
 				compatible = append(compatible, e.graph.Vertices[i])
 				// set, that we have interface deps
 				haveInterfaceDeps = true
-				e.logger.Info("vertex is compatible with Collects", zap.String("vertex id", e.graph.Vertices[i].ID), zap.String("collects from vertex", vrtx.ID))
+				e.logger.Debug("vertex is compatible with Collects", zap.String("vertex id", e.graph.Vertices[i].ID), zap.String("collects from vertex", vrtx.ID))
 				continue
 			}
-			e.logger.Info("vertex is not compatible with Collects", zap.String("vertex id", e.graph.Vertices[i].ID), zap.String("collects from vertex", vrtx.ID))
+			e.logger.Debug("vertex is not compatible with Collects", zap.String("vertex id", e.graph.Vertices[i].ID), zap.String("collects from vertex", vrtx.ID))
 		}
 
 		if len(compatible) == 0 && haveInterfaceDeps {
-			e.logger.Info("no compatible vertices found", zap.String("collects from vertex", vrtx.ID))
+			e.logger.Debug("no compatible vertices found", zap.String("collects from vertex", vrtx.ID))
 			return nil
 		}
 		// process mixed deps (interfaces + structs)
 		if haveInterfaceDeps {
-			return e.processInterfaceDeps(compatible, getFunctionName(fn), vrtx, params)
+			err = e.processInterfaceDeps(compatible, getFunctionName(fn), vrtx, params)
+			if err != nil {
+				return err
+			}
 		}
 		// process only struct deps if not interfaces were found
-		return e.processStructDeps(getFunctionName(fn), vrtx, params)
+		err = e.processStructDeps(getFunctionName(fn), vrtx, params)
+		if err != nil {
+			return err
+		}
 	}
 	return nil
 }

tests/happy_scenarios/happyScenario_test.go

@@ -100,9 +100,9 @@ func TestEndure_DoubleInitDoubleServe_OK(t *testing.T) {
 	assert.NoError(t, c.Init())
 	assert.Error(t, c.Init())
 
-	res, err := c.Serve()
+	_, err = c.Serve()
 	assert.NoError(t, err)
-	res, err = c.Serve()
+	res, err := c.Serve()
 	assert.Error(t, err)
 	go func() {
 		for r := range res {

tests/interfaces/collects/collects_get_all_deps/plugin1.go

@@ -0,0 +1,34 @@
+package collects_get_all_deps
+
+type Plugin1 struct {
+}
+
+type SuperInterface interface {
+	Super() string
+}
+
+type Super2Interface interface {
+	Super2() string
+}
+
+func (f *Plugin1) Init() error {
+	return nil
+}
+
+func (f *Plugin1) Serve() chan error {
+	errCh := make(chan error)
+	return errCh
+}
+
+func (f *Plugin1) Stop() error {
+	return nil
+}
+
+// Super and Super2 interface impl
+func (f *Plugin1) Super() string {
+	return "SUPER -> "
+}
+
+func (f *Plugin1) Super2() string {
+	return "I'm also SUPER2 -> "
+}

tests/interfaces/collects/collects_get_all_deps/plugin2.go

@@ -0,0 +1,40 @@
+package collects_get_all_deps
+
+import "github.com/spiral/errors"
+
+type Plugin2 struct {
+	collectsDeps []interface{}
+}
+
+func (f *Plugin2) Init() error {
+	// should be 2 deps
+	f.collectsDeps = make([]interface{}, 0, 2)
+	return nil
+}
+
+func (f *Plugin2) Serve() chan error {
+	errCh := make(chan error)
+	if len(f.collectsDeps) != 2 {
+		errCh <- errors.E("not enough deps collected")
+	}
+	return errCh
+}
+
+func (f *Plugin2) Stop() error {
+	return nil
+}
+
+func (f *Plugin2) Collects() []interface{} {
+	return []interface{}{
+		f.GetSuper,
+		f.GetSuper2,
+	}
+}
+
+func (f *Plugin2) GetSuper(s SuperInterface) {
+	f.collectsDeps = append(f.collectsDeps, s)
+}
+
+func (f *Plugin2) GetSuper2(s Super2Interface) {
+	f.collectsDeps = append(f.collectsDeps, s)
+}

tests/interfaces/interfaces_test.go

@@ -20,6 +20,8 @@ import (
 	"github.com/spiral/endure/tests/interfaces/plugins/plugin9"
 	notImplPlugin1 "github.com/spiral/endure/tests/interfaces/service/not_implemented_service/plugin1"
 	notImplPlugin2 "github.com/spiral/endure/tests/interfaces/service/not_implemented_service/plugin2"
+
+	collects_get_all_deps "github.com/spiral/endure/tests/interfaces/collects/collects_get_all_deps"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -193,3 +195,32 @@ func Test_MultiplyCollectsInterface(t *testing.T) {
 	assert.NoError(t, c.Stop())
 	time.Sleep(time.Second * 1)
 }
+
+func Test_MultiplyCollectsInterface2(t *testing.T) {
+	c, err := endure.NewContainer(nil)
+	assert.NoError(t, err)
+
+	assert.NoError(t, c.Register(&collects_get_all_deps.Plugin2{}))
+	assert.NoError(t, c.Register(&collects_get_all_deps.Plugin1{}))
+	err = c.Init()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	res, err := c.Serve()
+	assert.NoError(t, err)
+
+	go func() {
+		for r := range res {
+			if r.Error != nil {
+				assert.NoError(t, r.Error)
+				return
+			}
+		}
+	}()
+
+	time.Sleep(time.Second * 2)
+
+	assert.NoError(t, c.Stop())
+	time.Sleep(time.Second * 1)
+}

tests/interfaces/plugins/plugin10/plugin10.go

@@ -2,8 +2,7 @@ package plugin10
 
 import "fmt"
 
-type Plugin10 struct {
-}
+type Plugin10 struct{}
 
 // No deps
 func (s *Plugin10) Init() error {
@@ -20,5 +19,5 @@ func (s *Plugin10) Stop() error {
 }
 
 func (s *Plugin10) Boo() {
-	fmt.Println("Boo")
+	fmt.Println("Boo from plugin10")
 }

tests/interfaces/plugins/plugin7/plugin7.go

@@ -15,5 +15,5 @@ func (s *Plugin7) Name() string {
 }
 
 func (s *Plugin7) Boom() {
-	fmt.Println("Boom")
+	fmt.Println("Boom from plugin7")
 }

tests/interfaces/plugins/plugin8/plugin8.go

@@ -1,26 +1,36 @@
 package plugin8
 
 import (
-	"fmt"
-
 	endure "github.com/spiral/endure/pkg/container"
 	"github.com/spiral/endure/tests/interfaces/plugins/plugin10"
+	"github.com/spiral/errors"
 )
 
 type SomeInterface interface {
 	Boom()
 }
 
 type Plugin8 struct {
+	collectedDeps []interface{}
 }
 
 // No deps
 func (s *Plugin8) Init() error {
+	s.collectedDeps = make([]interface{}, 0, 6)
 	return nil
 }
 
 func (s *Plugin8) Serve() chan error {
 	errCh := make(chan error, 1)
+	// plugin7
+	// plugin9
+	// named + plugin10 (plugin7)
+	// named + plugin10 (plugin9)
+	// plugin7 + plugin10
+	// plugin9 + plugin10
+	if len(s.collectedDeps) != 6 {
+		errCh <- errors.E("not enough deps collected")
+	}
 	return errCh
 }
 
@@ -37,18 +47,22 @@ func (s *Plugin8) Collects() []interface{} {
 }
 
 func (s *Plugin8) SomeCollects(named endure.Named, b SomeInterface, p10 *plugin10.Plugin10) error {
-	fmt.Println(named.Name())
+	s.collectedDeps = append(s.collectedDeps, b)
 	b.Boom()
 	return nil
 }
 
 func (s *Plugin8) SomeCollects2(named endure.Named, p10 *plugin10.Plugin10) error {
-	fmt.Println(named.Name())
+	s.collectedDeps = append(s.collectedDeps, p10)
+	println(named.Name())
+	p10.Boo()
 	return nil
 }
 
 func (s *Plugin8) SomeCollects3(named endure.Named, p10 *plugin10.Plugin10, named2 endure.Named, p *plugin10.Plugin10) error {
-	fmt.Println(named.Name())
+	s.collectedDeps = append(s.collectedDeps, p)
+	println(named.Name())
+	println(named2.Name())
 	p10.Boo()
 	p.Boo()
 	return nil

tests/interfaces/plugins/plugin9/plugin9.go

@@ -15,5 +15,5 @@ func (s *Plugin9) Name() string {
 }
 
 func (s *Plugin9) Boom() {
-	fmt.Println("Boom")
+	fmt.Println("Boom from plugin9")
 }