[#102]: feat(refactor): code cleanup

## Description of Changes

- Remove unused data structures
- Cleanup tests

Author: rustatian

CHANGELOG.md

@@ -1,6 +1,19 @@
 CHANGELOG
 =========
 
+v1.1.0 (14.10.2021)
+-------------------
+- Fix a bug where disabled vertices don't move the LL pointer forward during the shutdown.
+- Prevent from calling Init() method on the already initialized vertices.
+- Code cleanup.
+
+## 👀 Packages:
+
+- Go updated to 1.17
+- Zap logger updated to 1.19
+- Spiral/errors updated to 1.0.12
+- Github actions moved to Go 1.17
+
 v1.0.3 (19.08.2021)
 -------------------
 

pkg/container/common.go

@@ -6,7 +6,7 @@ import (
 	"github.com/cenkalti/backoff/v4"
 	"github.com/spiral/endure/pkg/fsm"
 	"github.com/spiral/endure/pkg/graph"
-	"github.com/spiral/endure/pkg/linked_list"
+	ll "github.com/spiral/endure/pkg/linked_list"
 	"github.com/spiral/endure/pkg/vertex"
 	"github.com/spiral/errors"
 	"go.uber.org/zap"
@@ -20,7 +20,7 @@ func (e *Endure) sendResultToUser(res *result) {
 }
 
 // traverseBackStop used to visit every Prev node and internalStop vertices
-func (e *Endure) traverseBackStop(n *linked_list.DllNode) {
+func (e *Endure) traverseBackStop(n *ll.DllNode) {
 	const op = errors.Op("endure_traverse_back_stop")
 	e.logger.Debug("stopping vertex in the first Serve call", zap.String("id", n.Vertex.ID))
 	nCopy := n
@@ -76,7 +76,7 @@ func (e *Endure) retryHandler(res *result) {
 	b.MaxElapsedTime = e.maxInterval
 	b.InitialInterval = e.initialInterval
 
-	affectedRunList := linked_list.NewDoublyLinkedList()
+	affectedRunList := ll.NewDoublyLinkedList()
 	for i := 0; i <= len(sorted)-1; i++ {
 		affectedRunList.Push(sorted[i])
 	}

pkg/container/endure.go

@@ -10,7 +10,7 @@ import (
 
 	"github.com/spiral/endure/pkg/fsm"
 	"github.com/spiral/endure/pkg/graph"
-	"github.com/spiral/endure/pkg/linked_list"
+	ll "github.com/spiral/endure/pkg/linked_list"
 	"github.com/spiral/errors"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
@@ -55,7 +55,7 @@ type Endure struct {
 	// Dependency graph
 	graph *graph.Graph
 	// DLL used as run list to run in order
-	runList *linked_list.DoublyLinkedList
+	runList *ll.DoublyLinkedList
 	// logger
 	logger *zap.Logger
 	// OPTIONS
@@ -65,8 +65,11 @@ type Endure struct {
 	initialInterval time.Duration
 	stopTimeout     time.Duration
 
-	deps        map[string]interface{}
-	disabled    map[string]bool
+	// deps is a map with all saved deps
+	deps map[string]interface{}
+	// disabled is a map with disabled deps
+	disabled map[string]bool
+	// initialized vertices map
 	initialized map[string]bool
 
 	// Graph visualizer
@@ -138,7 +141,7 @@ func NewContainer(logger *zap.Logger, options ...Options) (*Endure, error) {
 	c.FSM = fsm.NewFSM(fsm.Uninitialized, transitionMap)
 
 	c.graph = graph.NewGraph()
-	c.runList = linked_list.NewDoublyLinkedList()
+	c.runList = ll.NewDoublyLinkedList()
 
 	// Main thread channels
 	c.handleErrorCh = make(chan *result)
@@ -272,10 +275,6 @@ func (e *Endure) reRegister(vertex interface{}) error {
 	t := reflect.TypeOf(vertex)
 	vertexID := removePointerAsterisk(t.String())
 
-	if t.Kind() != reflect.Ptr {
-		return errors.E(op, errors.Register, errors.Errorf("you should pass pointer to the structure instead of value"))
-	}
-
 	err := e.register(vertexID, vertex)
 	if err != nil {
 		return errors.E(op, errors.Register, err)
@@ -370,7 +369,7 @@ START:
 		return errors.E(op, errors.Init, errors.Errorf("graph should contain at least 1 vertex, possibly you forget to invoke registers"))
 	}
 
-	e.runList = linked_list.NewDoublyLinkedList()
+	e.runList = ll.NewDoublyLinkedList()
 	for i := len(sorted) - 1; i >= 0; i-- {
 		e.runList.Push(sorted[i])
 	}
@@ -382,6 +381,7 @@ START:
 			head = head.Next
 			continue
 		}
+
 		// check for disabled, because that can be interface
 		if _, ok := e.disabled[head.Vertex.ID]; ok {
 			err = e.removeVertex(head)
@@ -431,10 +431,6 @@ func (e *Endure) Start() (<-chan *Result, error) {
 
 	nCopy := e.runList.Head
 	for nCopy != nil {
-		if nCopy.Vertex.IsDisabled {
-			nCopy = nCopy.Next
-			continue
-		}
 		atLeastOne = true
 		nCopy.Vertex.SetState(fsm.Starting)
 		err := e.serveInternal(nCopy)
@@ -448,7 +444,7 @@ func (e *Endure) Start() (<-chan *Result, error) {
 	}
 	// all vertices disabled
 	if !atLeastOne {
-		return nil, errors.E(op, errors.Disabled, errors.Str("all vertices disabled, nothing to serveInternal"))
+		return nil, errors.E(op, errors.Disabled, errors.Str("all vertices disabled, nothing to run"))
 	}
 	return e.userResultsCh, nil
 }
@@ -457,20 +453,27 @@ func (e *Endure) Start() (<-chan *Result, error) {
 // Do not change this method fn, sync with constants in the beginning of this file
 func (e *Endure) Shutdown() error {
 	e.logger.Info("exiting from the Endure")
+	if e.runList == nil {
+		return nil
+	}
 	return e.shutdown(e.runList.Head, true)
 }
 
-func (e *Endure) removeVertex(head *linked_list.DllNode) error {
+func (e *Endure) removeVertex(head *ll.DllNode) error {
 	const op = errors.Op("endure_disable")
 	e.logger.Debug("found disabled vertex", zap.String("id", head.Vertex.ID))
 	// add vertex to the map with disabled vertices
 	for providesID := range head.Vertex.Provides {
+		// disable all types which vertex provides as a root
 		e.disabled[providesID] = true
 		delete(e.deps, providesID)
 	}
+
 	e.disabled[head.Vertex.ID] = true
+
 	// reset run list
-	e.runList.Reset()
+	e.runList = nil
+
 	// reset graph
 	e.graph = nil
 	e.graph = graph.NewGraph()
@@ -485,8 +488,5 @@ func (e *Endure) removeVertex(head *linked_list.DllNode) error {
 		}
 	}
 
-	e.runList.Remove(head)
-	head.Vertex = nil
-
 	return nil
 }

pkg/container/serve.go

@@ -3,7 +3,7 @@ package endure
 import (
 	"reflect"
 
-	"github.com/spiral/endure/pkg/linked_list"
+	ll "github.com/spiral/endure/pkg/linked_list"
 	"github.com/spiral/endure/pkg/vertex"
 	"github.com/spiral/errors"
 	"go.uber.org/zap"
@@ -39,7 +39,7 @@ func (e *Endure) callServeFn(vrtx *vertex.Vertex, in []reflect.Value) (*result,
 }
 
 // serveInternal run calls callServeFn for each node and put the results in the map
-func (e *Endure) serveInternal(n *linked_list.DllNode) error {
+func (e *Endure) serveInternal(n *ll.DllNode) error {
 	const op = errors.Op("endure_serve_internal")
 	// check if type implements serveInternal, if implements, call serveInternal
 	if reflect.TypeOf(n.Vertex.Iface).Implements(reflect.TypeOf((*Service)(nil)).Elem()) {

pkg/container/stop.go

@@ -5,7 +5,7 @@ import (
 	"reflect"
 
 	"github.com/spiral/endure/pkg/fsm"
-	"github.com/spiral/endure/pkg/linked_list"
+	ll "github.com/spiral/endure/pkg/linked_list"
 	"github.com/spiral/endure/pkg/vertex"
 	"github.com/spiral/errors"
 	"go.uber.org/zap"
@@ -46,7 +46,7 @@ func (e *Endure) callStopFn(vrtx *vertex.Vertex, in []reflect.Value) error {
 
 // true -> next
 // false -> prev
-func (e *Endure) shutdown(n *linked_list.DllNode, traverseNext bool) error {
+func (e *Endure) shutdown(n *ll.DllNode, traverseNext bool) error {
 	const op = errors.Op("endure_shutdown")
 	numOfVertices := calculateDepth(n, traverseNext)
 	if numOfVertices == 0 {
@@ -153,7 +153,7 @@ func (e *Endure) shutdown(n *linked_list.DllNode, traverseNext bool) error {
 }
 
 // Using to calculate number of Vertices in DLL
-func calculateDepth(n *linked_list.DllNode, traverse bool) int {
+func calculateDepth(n *ll.DllNode, traverse bool) int {
 	num := 0
 	if traverse {
 		tmp := n

pkg/linked_list/linked_list.go

@@ -1,4 +1,4 @@
-package linked_list
+package linkedlist
 
 import "github.com/spiral/endure/pkg/vertex"
 

tests/disabled_vertices/plugin5/plugin5.go

@@ -1,12 +1,18 @@
 package plugin5
 
+import (
+	"github.com/spiral/errors"
+)
+
 type Plugin5 struct {
 	val int
 }
 
 func (p5 *Plugin5) Init() error {
 	p5.val++
-	println(p5.val)
+	if p5.val > 1 {
+		return errors.E("should not be more than 1")
+	}
 	return nil
 }