From cfdaeb1822eeabadb2ea425bd350d77c9388f2bb Mon Sep 17 00:00:00 2001
From: Pavel Kalinnikov <pkalinnikov@google.com>
Date: Mon, 11 Apr 2022 14:21:42 +0100
Subject: [PATCH] compact: Visit the seed node in the Append method (#20)

Most uses of compact range invoke the visitor for the leaf node before
the Append call. This change makes it the default behaviour of Append.

The asymmetry between Append and AppendRange can be explained by the
fact that Append is usually called when the new leaf hasn't been
processed yet, whereas AppendRange is usually called when all the nodes
of the compact ranges (as well as nodes below them) have been processed.
---
 compact/range.go      | 7 ++++---
 compact/range_test.go | 4 ----
 2 files changed, 4 insertions(+), 7 deletions(-)

diff --git a/compact/range.go b/compact/range.go
index db178ab..18f79c3 100644
--- a/compact/range.go
+++ b/compact/range.go
@@ -88,10 +88,11 @@ func (r *Range) Hashes() [][]byte {
 }
 
 // Append extends the compact range by appending the passed in hash to it. It
-// uses the tree hasher to calculate hashes of newly created nodes, and reports
-// them through the visitor function (if non-nil).
+// reports all the added nodes through the visitor function (if non-nil).
 func (r *Range) Append(hash []byte, visitor VisitFn) error {
-	// TODO(pphaneuf): Consider calling `visitor` for this hash, for consistency.
+	if visitor != nil {
+		visitor(NewNodeID(0, r.end), hash)
+	}
 	return r.appendImpl(r.end+1, hash, nil, visitor)
 }
 
diff --git a/compact/range_test.go b/compact/range_test.go
index 50c6495..d5a860f 100644
--- a/compact/range_test.go
+++ b/compact/range_test.go
@@ -176,7 +176,6 @@ func TestAppend(t *testing.T) {
 			cr := factory.NewEmptyRange(0)
 			tree.verifyRange(t, cr, true)
 			for i := uint64(0); i < size; i++ {
-				visit(NewNodeID(0, i), tree.leaf(i))
 				if err := cr.Append(tree.leaf(i), visit); err != nil {
 					t.Errorf("Append()=%v", err)
 				}
@@ -227,7 +226,6 @@ func TestMergeBackwards(t *testing.T) {
 	rng := factory.NewEmptyRange(numNodes)
 	tree.verifyRange(t, rng, true)
 	for i := numNodes; i > 0; i-- {
-		visit(NewNodeID(0, i-1), tree.leaf(i-1))
 		prepend := factory.NewEmptyRange(i - 1)
 		tree.verifyRange(t, prepend, true)
 		if err := prepend.Append(tree.leaf(i-1), visit); err != nil {
@@ -256,7 +254,6 @@ func TestMergeInBatches(t *testing.T) {
 		rng := factory.NewEmptyRange(i)
 		tree.verifyRange(t, rng, true)
 		for node := i; node < i+batch && node < numNodes; node++ {
-			visit(NewNodeID(0, node), tree.leaf(node))
 			if err := rng.Append(tree.leaf(node), visit); err != nil {
 				t.Fatalf("Append: %v", err)
 			}
@@ -289,7 +286,6 @@ func TestMergeRandomly(t *testing.T) {
 			mergeAll = func(begin, end uint64) *Range {
 				rng := factory.NewEmptyRange(begin)
 				if begin+1 == end {
-					visit(NewNodeID(0, begin), tree.leaf(begin))
 					if err := rng.Append(tree.leaf(begin), visit); err != nil {
 						t.Fatalf("Append(%d): %v", begin, err)
 					}