BlameConfig and MarkOwnerDelete visitors

Author: steiler

pkg/datastore/datastore_rpc.go

@@ -465,11 +465,15 @@ func (d *Datastore) BlameConfig(ctx context.Context, includeDefaults bool) (*sdc
 	if err != nil {
 		return nil, err
 	}
+
 	// calculate the Blame
-	bte, err := root.BlameConfig(includeDefaults)
+	bcv := tree.NewBlameConfigVisitor(includeDefaults)
+	err = root.Walk(ctx, bcv)
 	if err != nil {
 		return nil, err
 	}
+	bte := bcv.GetResult()
+
 	// set the root level elements name to the target name
 	bte.Name = d.config.Name
 	return bte, nil

pkg/datastore/transaction_rpc.go

@@ -209,7 +209,11 @@ func (d *Datastore) lowlevelTransactionSet(ctx context.Context, transaction *typ
 
 		oldIntentContent := lvs.ToUpdateSlice()
 
-		root.MarkOwnerDelete(intent.GetName(), intent.GetOnlyIntended())
+		marksOwnerDeleteVisitor := tree.NewMarkOwnerDeleteVisitor(intent.GetName(), intent.GetOnlyIntended())
+		err := root.Walk(ctx, marksOwnerDeleteVisitor)
+		if err != nil {
+			return nil, err
+		}
 
 		// store the old intent content in the transaction as the old intent.
 		err = transaction.AddIntentContent(intent.GetName(), types.TransactionIntentOld, oldIntentContent.GetFirstPriorityValue(), oldIntentContent)

pkg/datastore/tree_operation_test.go

@@ -807,7 +807,11 @@ func TestDatastore_populateTree(t *testing.T) {
 				t.Error(err)
 			}
 
-			root.MarkOwnerDelete(tt.intentName, false)
+			marksOwnerDeleteVisitor := tree.NewMarkOwnerDeleteVisitor(tt.intentName, false)
+			err = root.Walk(ctx, marksOwnerDeleteVisitor)
+			if err != nil {
+				t.Error(err)
+			}
 
 			newFlag := types.NewUpdateInsertFlags().SetNewFlag()
 

pkg/tree/entry.go

@@ -70,8 +70,8 @@ type Entry interface {
 	getHighestPrecedenceLeafValue(context.Context) (*LeafEntry, error)
 	// GetByOwner returns the branches Updates by owner
 	GetByOwner(owner string, result []*LeafEntry) LeafVariantSlice
-	// markOwnerDelete Sets the delete flag on all the LeafEntries belonging to the given owner.
-	MarkOwnerDelete(o string, onlyIntended bool)
+	// // markOwnerDelete Sets the delete flag on all the LeafEntries belonging to the given owner.
+	// MarkOwnerDelete(o string, onlyIntended bool)
 	// GetDeletes returns the cache-updates that are not updated, have no lower priority value left and hence should be deleted completely
 	GetDeletes(entries []types.DeleteEntry, aggregatePaths bool) ([]types.DeleteEntry, error)
 	// Walk takes the EntryVisitor and applies it to every Entry in the tree
@@ -154,12 +154,25 @@ type Entry interface {
 	GetListChilds() ([]Entry, error)
 	BreadthSearch(ctx context.Context, path string) ([]Entry, error)
 	DeepCopy(tc *TreeContext, parent Entry) (Entry, error)
-	BlameConfig(includeDefaults bool) (*sdcpb.BlameTreeElement, error)
 	canDeleteBranch(keepDefault bool) bool
 	deleteCanDeleteChilds(keepDefault bool)
+	GetLeafVariantEntries() LeafVariantEntries
 }
 
 type EntryVisitor interface {
 	Visit(ctx context.Context, s *sharedEntryAttributes) error
 	Up()
 }
+
+type LeafVariantEntry interface {
+	MarkDelete(onlyIntended bool)
+	GetEntry() Entry
+	String() string
+}
+
+type LeafVariantEntries interface {
+	MarkOwnerForDeletion(owner string, onlyIntended bool) *LeafEntry
+	GetHighestPrecedence(onlyNewOrUpdated bool, includeDefaults bool) *LeafEntry
+	GetRunning() *LeafEntry
+	DeleteByOwner(owner string) *LeafEntry
+}

pkg/tree/entry_test.go

@@ -306,7 +306,11 @@ func Test_Entry_Three(t *testing.T) {
 
 	// indicate that the intent is receiving an update
 	// therefor invalidate all the present entries of the owner / intent
-	root.MarkOwnerDelete(owner1, false)
+	marksOwnerDeleteVisitor := NewMarkOwnerDeleteVisitor(owner1, false)
+	err = root.Walk(ctx, marksOwnerDeleteVisitor)
+	if err != nil {
+		t.Error(err)
+	}
 
 	// add incomming set intent reques data
 	overwriteDesc := testhelper.GetStringTvProto("Owerwrite Description")
@@ -425,7 +429,11 @@ func Test_Entry_Four(t *testing.T) {
 
 	// indicate that the intent is receiving an update
 	// therefor invalidate all the present entries of the owner / intent
-	root.MarkOwnerDelete(owner1, false)
+	marksOwnerDeleteVisitor := NewMarkOwnerDeleteVisitor(owner1, false)
+	err = root.Walk(ctx, marksOwnerDeleteVisitor)
+	if err != nil {
+		t.Error(err)
+	}
 
 	// add incomming set intent reques data
 	overwriteDesc := testhelper.GetStringTvProto("Owerwrite Description")
@@ -667,7 +675,11 @@ func Test_Entry_Delete_Aggregation(t *testing.T) {
 	}
 
 	// get ready to add the new intent data
-	root.MarkOwnerDelete(owner1, false)
+	marksOwnerDeleteVisitor := NewMarkOwnerDeleteVisitor(owner1, false)
+	err = root.Walk(ctx, marksOwnerDeleteVisitor)
+	if err != nil {
+		t.Error(err)
+	}
 
 	u1n := types.NewUpdate([]string{"interface", "ethernet-1/1", "description"}, desc3, prio50, owner1, ts1)
 	u2n := types.NewUpdate([]string{"interface", "ethernet-1/1", "name"}, testhelper.GetStringTvProto("ethernet-1/1"), prio50, owner1, ts1)

pkg/tree/leaf_variants.go

@@ -11,15 +11,15 @@ import (
 )
 
 type LeafVariants struct {
-	les         []*LeafEntry
+	les         LeafVariantSlice
 	lesMutex    sync.RWMutex
 	tc          *TreeContext
 	parentEntry Entry
 }
 
 func newLeafVariants(tc *TreeContext, parentEnty Entry) *LeafVariants {
 	return &LeafVariants{
-		les:         make([]*LeafEntry, 0, 2),
+		les:         make(LeafVariantSlice, 0, 2),
 		tc:          tc,
 		parentEntry: parentEnty,
 	}
@@ -317,12 +317,15 @@ func (lv *LeafVariants) GetByOwner(owner string) *LeafEntry {
 }
 
 // MarkOwnerForDeletion searches for a LefVariant of given owner, if it exists
-// the entry is marked for deletion
-func (lv *LeafVariants) MarkOwnerForDeletion(owner string, onlyIntended bool) {
+// the entry is marked for deletion.
+// returning true if an owner entry was found, false if not
+func (lv *LeafVariants) MarkOwnerForDeletion(owner string, onlyIntended bool) *LeafEntry {
 	le := lv.GetByOwner(owner)
 	if le != nil {
 		le.MarkDelete(onlyIntended)
+		return le
 	}
+	return nil
 }
 
 func (lv *LeafVariants) DeleteByOwner(owner string) {

pkg/tree/sharedEntryAttributes.go

@@ -18,7 +18,6 @@ import (
 	"github.com/sdcio/data-server/pkg/utils"
 	sdcpb "github.com/sdcio/sdc-protos/sdcpb"
 	log "github.com/sirupsen/logrus"
-	"google.golang.org/protobuf/proto"
 	"google.golang.org/protobuf/types/known/emptypb"
 )
 
@@ -111,7 +110,7 @@ func newSharedEntryAttributes(ctx context.Context, parent Entry, pathElemName st
 }
 
 func (s *sharedEntryAttributes) GetRoot() Entry {
-	if s.parent == nil {
+	if s.IsRoot() {
 		return s
 	}
 	return s.parent.GetRoot()
@@ -410,7 +409,7 @@ func (s *sharedEntryAttributes) GetLevel() int {
 		return *s.level
 	}
 	// if we're at the root level, return 0
-	if s.parent == nil {
+	if s.IsRoot() {
 		return 0
 	}
 	// Get parent level and add 1
@@ -673,7 +672,7 @@ func (s *sharedEntryAttributes) GetDeletes(deletes []types.DeleteEntry, aggregat
 // the level of recursion is indicated via the levelUp attribute
 func (s *sharedEntryAttributes) GetFirstAncestorWithSchema() (Entry, int) {
 	// if root node is reached
-	if s.parent == nil {
+	if s.IsRoot() {
 		return nil, 0
 	}
 	// check if the parent has a schema
@@ -705,7 +704,7 @@ func (s *sharedEntryAttributes) GetByOwner(owner string, result []*LeafEntry) Le
 // Path returns the root based path of the Entry
 func (s *sharedEntryAttributes) Path() types.PathSlice {
 	// special handling for root node
-	if s.parent == nil {
+	if s.IsRoot() {
 		return types.PathSlice{}
 	}
 	return append(s.parent.Path(), s.pathElemName)
@@ -942,7 +941,6 @@ func (s *sharedEntryAttributes) getHighestPrecedenceLeafValue(ctx context.Contex
 }
 
 func (s *sharedEntryAttributes) GetRootBasedEntryChain() []Entry {
-	s.GetLevel()
 	if s.IsRoot() {
 		return []Entry{}
 	}
@@ -1550,15 +1548,6 @@ func (s *sharedEntryAttributes) StringIndent(result []string) []string {
 	return result
 }
 
-// markOwnerDelete Sets the delete flag on all the LeafEntries belonging to the given owner.
-func (s *sharedEntryAttributes) MarkOwnerDelete(o string, onlyIntended bool) {
-	s.leafVariants.MarkOwnerForDeletion(o, onlyIntended)
-	// recurse into childs
-	for _, child := range s.childs.GetAll() {
-		child.MarkOwnerDelete(o, onlyIntended)
-	}
-}
-
 // SdcpbPath returns the sdcpb.Path, with its elements and keys based on the local schema
 func (s *sharedEntryAttributes) SdcpbPath() (*sdcpb.Path, error) {
 	return s.SdcpbPathInternal(s.Path())
@@ -1669,52 +1658,6 @@ func (s *sharedEntryAttributes) TreeExport(owner string) ([]*tree_persist.TreeEl
 	return nil, nil
 }
 
-func (s *sharedEntryAttributes) BlameConfig(includeDefaults bool) (*sdcpb.BlameTreeElement, error) {
-	name := s.pathElemName
-	if s.GetLevel() == 0 {
-		name = "root"
-	}
-	result := sdcpb.NewBlameTreeElement(name)
-
-	// process Value
-	highestLe := s.leafVariants.GetHighestPrecedence(false, true)
-	if highestLe != nil {
-		if highestLe.Update.Owner() != DefaultsIntentName || includeDefaults {
-			result.SetValue(highestLe.Update.Value()).SetOwner(highestLe.Update.Owner())
-
-			// check if running equals the expected
-			runningLe := s.leafVariants.GetRunning()
-			if runningLe != nil {
-				if !proto.Equal(runningLe.Update.Value(), highestLe.Update.Value()) {
-					result.DeviationValue = runningLe.Value()
-				}
-			}
-		} else {
-			// if it is default but no default is meant to be returned
-			return nil, nil
-		}
-	}
-
-	// process Childs
-	for _, c := range s.filterActiveChoiceCaseChilds() {
-		childBlame, err := c.BlameConfig(includeDefaults)
-		if err != nil {
-			return nil, err
-		}
-		// if it is not meant to be added we will get nil, so check and skip in case
-		if childBlame != nil {
-			result.AddChild(childBlame)
-		}
-	}
-
-	// sort to make te output stable
-	slices.SortFunc(result.Childs, func(a *sdcpb.BlameTreeElement, b *sdcpb.BlameTreeElement) int {
-		return strings.Compare(a.GetName(), b.GetName())
-	})
-
-	return result, nil
-}
-
 // getKeyName checks if s is a key level element in the tree, if not an error is throw
 // if it is a key level element, the name of the key is determined via the ancestor schemas
 func (s *sharedEntryAttributes) getKeyName() (string, error) {
@@ -1822,3 +1765,7 @@ func (s *sharedEntryAttributes) containsOnlyDefaults() bool {
 
 	return true
 }
+
+func (s *sharedEntryAttributes) GetLeafVariantEntries() LeafVariantEntries {
+	return s.leafVariants
+}

pkg/tree/sharedEntryAttributes_test.go

@@ -886,11 +886,15 @@ func Test_sharedEntryAttributes_BlameConfig(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			s := tt.r(t)
-			got, err := s.BlameConfig(tt.includeDefaults)
+
+			bcv := NewBlameConfigVisitor(tt.includeDefaults)
+			err := s.Walk(ctx, bcv)
+
 			if (err != nil) != tt.wantErr {
 				t.Errorf("sharedEntryAttributes.BlameConfig() error = %v, wantErr %v", err, tt.wantErr)
 				return
 			}
+			got := bcv.GetResult()
 
 			// // generate the want part via
 			// // ---------------------------------------
@@ -1004,7 +1008,11 @@ func Test_sharedEntryAttributes_ReApply(t *testing.T) {
 			}
 
 			// mark owner delete
-			newRoot.MarkOwnerDelete(owner1, false)
+			marksOwnerDeleteVisitor := NewMarkOwnerDeleteVisitor(owner1, false)
+			err = root.Walk(ctx, marksOwnerDeleteVisitor)
+			if err != nil {
+				t.Error(err)
+			}
 
 			err = newRoot.AddUpdatesRecursive(ctx, updSlice, flagsNew)
 			if err != nil {

pkg/tree/visitor_blame_config.go

@@ -0,0 +1,76 @@
+package tree
+
+import (
+	"context"
+	"slices"
+	"strings"
+
+	sdcpb "github.com/sdcio/sdc-protos/sdcpb"
+	"google.golang.org/protobuf/proto"
+)
+
+type BlameConfigVisitor struct {
+	stack           []*sdcpb.BlameTreeElement
+	includeDefaults bool
+	// skipUp          bool
+}
+
+func NewBlameConfigVisitor(includeDefaults bool) *BlameConfigVisitor {
+	return &BlameConfigVisitor{
+		stack:           []*sdcpb.BlameTreeElement{},
+		includeDefaults: includeDefaults,
+	}
+}
+
+func (b *BlameConfigVisitor) Visit(ctx context.Context, s *sharedEntryAttributes) error {
+	name := s.pathElemName
+	if s.IsRoot() {
+		name = "root"
+	}
+	result := sdcpb.NewBlameTreeElement(name)
+	skipAdd := false
+
+	// process Value
+	highestLe := s.GetLeafVariantEntries().GetHighestPrecedence(false, true)
+	if highestLe != nil {
+		if highestLe.Update.Owner() != DefaultsIntentName || b.includeDefaults {
+			result.SetValue(highestLe.Update.Value()).SetOwner(highestLe.Update.Owner())
+
+			// check if running equals the expected
+			runningLe := s.GetLeafVariantEntries().GetRunning()
+			if runningLe != nil {
+				if !proto.Equal(runningLe.Update.Value(), highestLe.Update.Value()) {
+					result.DeviationValue = runningLe.Value()
+				}
+			}
+		} else {
+			// if it is default but no default is meant to be returned
+			skipAdd = true
+		}
+	}
+	// add to the result tree as a child
+	if !skipAdd && len(b.stack) > 0 {
+		b.stack[len(b.stack)-1].AddChild(result)
+	}
+	// add to the stack as last element
+	b.stack = append(b.stack, result)
+	return nil
+}
+
+func (b *BlameConfigVisitor) Up() {
+	// sort to make te output stable
+	slices.SortFunc(b.stack[len(b.stack)-1].Childs, func(a *sdcpb.BlameTreeElement, b *sdcpb.BlameTreeElement) int {
+		return strings.Compare(a.GetName(), b.GetName())
+	})
+	// remove the last elem from stack
+	if len(b.stack) > 1 {
+		b.stack = b.stack[:len(b.stack)-1]
+	}
+}
+
+func (b *BlameConfigVisitor) GetResult() *sdcpb.BlameTreeElement {
+	if len(b.stack) == 1 {
+		return b.stack[0]
+	}
+	return nil
+}