fix(iterator): ensure HasNext does not advance state (#47)

- Refactored bufferedIterator to make HasNext idempotent.
- Added peek logic to prefetch the next valid node without advancing.
- Updated HasNext and Next to align with the expected behavior in docs.
- Added test cases to verify HasNext idempotency and empty iterator behavior.

Signed-off-by: Pavel Larkin <[email protected]>

Author: plar

tree_iterator.go

@@ -1,14 +1,18 @@
 package art
 
+import "errors"
+
 // state represents the iteration state during tree traversal.
 type state struct {
 	items []*iteratorContext
 }
 
+// push adds a new iterator context to the state.
 func (s *state) push(ctx *iteratorContext) {
 	s.items = append(s.items, ctx)
 }
 
+// current returns the current iterator context and a flag indicating if there is any.
 func (s *state) current() (*iteratorContext, bool) {
 	if len(s.items) == 0 {
 		return nil, false
@@ -17,6 +21,7 @@ func (s *state) current() (*iteratorContext, bool) {
 	return s.items[len(s.items)-1], true
 }
 
+// discard removes the last iterator context from the state.
 func (s *state) discard() {
 	if len(s.items) == 0 {
 		return
@@ -67,6 +72,7 @@ type iterator struct {
 // assert that iterator implements the Iterator interface.
 var _ Iterator = (*iterator)(nil)
 
+// newTreeIterator creates a new tree iterator.
 func newTreeIterator(tr *tree, opts traverseOpts) Iterator {
 	state := &state{}
 	state.push(newIteratorContext(tr.root, opts.hasReverse()))
@@ -83,10 +89,15 @@ func newTreeIterator(tr *tree, opts traverseOpts) Iterator {
 		return it
 	}
 
-	return &bufferedIterator{
+	bit := &bufferedIterator{
 		opts: opts,
 		it:   it,
 	}
+
+	// peek the first node or leaf
+	bit.peek()
+
+	return bit
 }
 
 // hasConcurrentModification checks if the tree has been modified concurrently.
@@ -148,52 +159,67 @@ type bufferedIterator struct {
 	nextErr  error
 }
 
+// HasNext returns true if there are more nodes to iterate.
 func (bit *bufferedIterator) HasNext() bool {
-	for bit.hasNext() {
-		nxt, err := bit.peek()
-		if err != nil {
-			return true
-		}
+	return bit.nextNode != nil
+}
 
-		// are we looking for a leaf node?
-		if bit.hasLeafIterator() && nxt.Kind() == Leaf {
-			return true
-		}
+// Next returns the next node or leaf node and an error if any.
+// ErrNoMoreNodes is returned if there are no more nodes to iterate.
+// ErrConcurrentModification is returned if the tree has been modified concurrently.
+func (bit *bufferedIterator) Next() (Node, error) {
+	current := bit.nextNode
 
-		// are we looking for a non-leaf node?
-		if bit.hasNodeIterator() && nxt.Kind() != Leaf {
-			return true
-		}
+	if !bit.HasNext() {
+		return nil, bit.nextErr
 	}
 
-	bit.resetNext()
+	bit.peek()
 
-	return false
-}
+	// ErrConcurrentModification should be returned immediately.
+	// ErrNoMoreNodes will be return on the next call.
+	if errors.Is(bit.nextErr, ErrConcurrentModification) {
+		return nil, bit.nextErr
+	}
 
-func (bit *bufferedIterator) Next() (Node, error) {
-	return bit.nextNode, bit.nextErr
+	return current, nil
 }
 
+// hasLeafIterator checks if the iterator is for leaf nodes.
 func (bit *bufferedIterator) hasLeafIterator() bool {
 	return bit.opts&TraverseLeaf == TraverseLeaf
 }
 
+// hasNodeIterator checks if the iterator is for non-leaf nodes.
 func (bit *bufferedIterator) hasNodeIterator() bool {
 	return bit.opts&TraverseNode == TraverseNode
 }
 
-func (bit *bufferedIterator) hasNext() bool {
-	return bit.it.HasNext()
+// peek looks for the next node or leaf node to iterate.
+func (bit *bufferedIterator) peek() {
+	for {
+		bit.nextNode, bit.nextErr = bit.it.Next()
+		if bit.nextErr != nil {
+			return
+		}
+
+		if bit.matchesFilter() {
+			return
+		}
+	}
 }
 
-func (bit *bufferedIterator) peek() (Node, error) {
-	bit.nextNode, bit.nextErr = bit.it.Next()
+// matchesFilter checks if the next node matches the iterator filter.
+func (bit *bufferedIterator) matchesFilter() bool {
+	// check if the iterator is looking for leaf nodes
+	if bit.hasLeafIterator() && bit.nextNode.Kind() == Leaf {
+		return true
+	}
 
-	return bit.nextNode, bit.nextErr
-}
+	// check if the iterator is looking for non-leaf nodes
+	if bit.hasNodeIterator() && bit.nextNode.Kind() != Leaf {
+		return true
+	}
 
-func (bit *bufferedIterator) resetNext() {
-	bit.nextNode = nil
-	bit.nextErr = nil
+	return false
 }

tree_traversal_test.go

@@ -529,4 +529,63 @@ func TestTreeIterateWordsStats(t *testing.T) {
 
 	stats = collectStats(tree.Iterator(TraverseNode))
 	assert.Equal(t, treeStats{0, 113419, 10433, 403, 1}, stats)
+
+	// by default Iterator traverses only leaf nodes
+	stats = collectStats(tree.Iterator())
+	assert.Equal(t, treeStats{235886, 0, 0, 0, 0}, stats)
+}
+
+func TestIteratorHasNextDoesNotAdvanceState(t *testing.T) {
+	t.Parallel()
+
+	tree := newTree()
+	tree.Insert(Key("1"), []byte{1})
+	tree.Insert(Key("2"), []byte{2})
+
+	iter := tree.Iterator()
+
+	// HasNext should not advance the iterator state
+	assert.True(t, iter.HasNext())
+	assert.True(t, iter.HasNext())
+
+	// change the iterator state
+	n, err := iter.Next()
+	require.NoError(t, err)
+	assert.Equal(t, Key("1"), n.Key())
+
+	// HasNext remains idempotent
+	assert.True(t, iter.HasNext())
+	assert.True(t, iter.HasNext())
+
+	// advance to the second key
+	n, err = iter.Next()
+	require.NoError(t, err)
+	assert.Equal(t, Key("2"), n.Key())
+
+	// HasNext returns false at the end
+	assert.False(t, iter.HasNext())
+	assert.False(t, iter.HasNext())
+
+	// calling Next after the iterator is exhausted
+	for i := 0; i < 2; i++ {
+		n, err = iter.Next()
+		assert.Nil(t, n, "Next() should return nil after exhaustion")
+		assert.Equal(t, ErrNoMoreNodes, err, "Next() should return ErrNoMoreNodes after exhaustion")
+	}
+}
+
+func TestIteratorEmptyTreeBehavior(t *testing.T) {
+	t.Parallel()
+
+	tree := New()
+	iter := tree.Iterator()
+
+	// HasNext should return false for an empty tree
+	assert.False(t, iter.HasNext())
+	assert.False(t, iter.HasNext())
+
+	// Next should return nil and ErrNoMoreNodes for an empty tree
+	n, err := iter.Next()
+	assert.Nil(t, n)
+	assert.Equal(t, ErrNoMoreNodes, err)
 }