From c2910f8f7ab60ed1f16aeaed026d9c8b4400d07c Mon Sep 17 00:00:00 2001 From: Quentin McGaw Date: Tue, 11 Oct 2022 11:25:12 +0000 Subject: [PATCH] `newDeletedMerkleValues` -> `pendingDeletedMerkleValues` --- lib/trie/trie.go | 42 +++++++++++------------ lib/trie/trie_test.go | 78 +++++++++++++++++++++---------------------- 2 files changed, 60 insertions(+), 60 deletions(-) diff --git a/lib/trie/trie.go b/lib/trie/trie.go index a8c50e20fb..2a3216bb77 100644 --- a/lib/trie/trie.go +++ b/lib/trie/trie.go @@ -26,11 +26,11 @@ type Trie struct { // pruner to detect with database keys (trie node Merkle values) can // be deleted. deletedMerkleValues map[string]struct{} - // newDeletedMerkleValues contains deleted Merkle values for operations + // pendingDeletedMerkleValues contains deleted Merkle values for operations // in progress. Its goal is to prevent having the trie `deletedMerkleValues` // in a bad state if one of the trie operation modified some (deep copied) trie // node and then failed. - newDeletedMerkleValues map[string]struct{} + pendingDeletedMerkleValues map[string]struct{} } // NewEmptyTrie creates a trie with a nil root @@ -41,11 +41,11 @@ func NewEmptyTrie() *Trie { // NewTrie creates a trie with an existing root node func NewTrie(root *Node) *Trie { return &Trie{ - root: root, - childTries: make(map[common.Hash]*Trie), - generation: 0, // Initially zero but increases after every snapshot. - deletedMerkleValues: make(map[string]struct{}), - newDeletedMerkleValues: make(map[string]struct{}), + root: root, + childTries: make(map[common.Hash]*Trie), + generation: 0, // Initially zero but increases after every snapshot. + deletedMerkleValues: make(map[string]struct{}), + pendingDeletedMerkleValues: make(map[string]struct{}), } } @@ -60,32 +60,32 @@ func (t *Trie) Snapshot() (newTrie *Trie) { rootCopySettings.CopyCached = true for rootHash, childTrie := range t.childTries { childTries[rootHash] = &Trie{ - generation: childTrie.generation + 1, - root: childTrie.root.Copy(rootCopySettings), - deletedMerkleValues: make(map[string]struct{}), - newDeletedMerkleValues: make(map[string]struct{}), + generation: childTrie.generation + 1, + root: childTrie.root.Copy(rootCopySettings), + deletedMerkleValues: make(map[string]struct{}), + pendingDeletedMerkleValues: make(map[string]struct{}), } } return &Trie{ - generation: t.generation + 1, - root: t.root, - childTries: childTries, - deletedMerkleValues: make(map[string]struct{}), - newDeletedMerkleValues: make(map[string]struct{}), + generation: t.generation + 1, + root: t.root, + childTries: childTries, + deletedMerkleValues: make(map[string]struct{}), + pendingDeletedMerkleValues: make(map[string]struct{}), } } // handleTrackedDeltas modifies the trie deleted merkle values set // only if the error is nil. In all cases, it resets the -// `newDeletedMerkleValues` map. +// `pendingDeletedMerkleValues` map. func (t *Trie) handleTrackedDeltas(err error) { if err == nil { - for merkleValue := range t.newDeletedMerkleValues { + for merkleValue := range t.pendingDeletedMerkleValues { t.deletedMerkleValues[merkleValue] = struct{}{} } } - t.newDeletedMerkleValues = make(map[string]struct{}) + t.pendingDeletedMerkleValues = make(map[string]struct{}) } func (t *Trie) prepLeafForMutation(currentLeaf *Node, @@ -95,7 +95,7 @@ func (t *Trie) prepLeafForMutation(currentLeaf *Node, // of current leaf. newLeaf = currentLeaf } else { - newLeaf = updateGeneration(currentLeaf, t.generation, t.newDeletedMerkleValues, copySettings) + newLeaf = updateGeneration(currentLeaf, t.generation, t.pendingDeletedMerkleValues, copySettings) } newLeaf.SetDirty() return newLeaf @@ -108,7 +108,7 @@ func (t *Trie) prepBranchForMutation(currentBranch *Node, // of current branch. newBranch = currentBranch } else { - newBranch = updateGeneration(currentBranch, t.generation, t.newDeletedMerkleValues, copySettings) + newBranch = updateGeneration(currentBranch, t.generation, t.pendingDeletedMerkleValues, copySettings) } newBranch.SetDirty() return newBranch diff --git a/lib/trie/trie_test.go b/lib/trie/trie_test.go index 00c4f4d3d4..2771c9fe29 100644 --- a/lib/trie/trie_test.go +++ b/lib/trie/trie_test.go @@ -18,9 +18,9 @@ import ( func Test_NewEmptyTrie(t *testing.T) { expectedTrie := &Trie{ - childTries: make(map[common.Hash]*Trie), - deletedMerkleValues: map[string]struct{}{}, - newDeletedMerkleValues: map[string]struct{}{}, + childTries: make(map[common.Hash]*Trie), + deletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, } trie := NewEmptyTrie() assert.Equal(t, expectedTrie, trie) @@ -36,9 +36,9 @@ func Test_NewTrie(t *testing.T) { Key: []byte{0}, SubValue: []byte{17}, }, - childTries: make(map[common.Hash]*Trie), - deletedMerkleValues: map[string]struct{}{}, - newDeletedMerkleValues: map[string]struct{}{}, + childTries: make(map[common.Hash]*Trie), + deletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, } trie := NewTrie(root) assert.Equal(t, expectedTrie, trie) @@ -57,7 +57,7 @@ func Test_Trie_Snapshot(t *testing.T) { deletedMerkleValues: map[string]struct{}{ "a": {}, }, - newDeletedMerkleValues: map[string]struct{}{ + pendingDeletedMerkleValues: map[string]struct{}{ "a temp": {}, }, }, @@ -67,7 +67,7 @@ func Test_Trie_Snapshot(t *testing.T) { deletedMerkleValues: map[string]struct{}{ "b": {}, }, - newDeletedMerkleValues: map[string]struct{}{ + pendingDeletedMerkleValues: map[string]struct{}{ "b temp": {}, }, }, @@ -76,7 +76,7 @@ func Test_Trie_Snapshot(t *testing.T) { "a": {}, "b": {}, }, - newDeletedMerkleValues: map[string]struct{}{ + pendingDeletedMerkleValues: map[string]struct{}{ "a temp": {}, "b temp": {}, }, @@ -87,20 +87,20 @@ func Test_Trie_Snapshot(t *testing.T) { root: &Node{Key: []byte{8}, SubValue: []byte{1}}, childTries: map[common.Hash]*Trie{ {1}: { - generation: 2, - root: &Node{Key: []byte{1}, SubValue: []byte{1}}, - deletedMerkleValues: map[string]struct{}{}, - newDeletedMerkleValues: map[string]struct{}{}, + generation: 2, + root: &Node{Key: []byte{1}, SubValue: []byte{1}}, + deletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, }, {2}: { - generation: 3, - root: &Node{Key: []byte{2}, SubValue: []byte{1}}, - deletedMerkleValues: map[string]struct{}{}, - newDeletedMerkleValues: map[string]struct{}{}, + generation: 3, + root: &Node{Key: []byte{2}, SubValue: []byte{1}}, + deletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, }, }, - deletedMerkleValues: map[string]struct{}{}, - newDeletedMerkleValues: map[string]struct{}{}, + deletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, } newTrie := trie.Snapshot() @@ -1022,8 +1022,8 @@ func Test_Trie_Put(t *testing.T) { }{ "trie with key and value": { trie: Trie{ - generation: 1, - newDeletedMerkleValues: map[string]struct{}{}, + generation: 1, + pendingDeletedMerkleValues: map[string]struct{}{}, root: &Node{ Key: []byte{1, 2, 0, 5}, SubValue: []byte{1}, @@ -1032,8 +1032,8 @@ func Test_Trie_Put(t *testing.T) { key: []byte{0x12, 0x16}, value: []byte{2}, expectedTrie: Trie{ - generation: 1, - newDeletedMerkleValues: map[string]struct{}{}, + generation: 1, + pendingDeletedMerkleValues: map[string]struct{}{}, root: &Node{ Key: []byte{1, 2}, Generation: 1, @@ -1597,13 +1597,13 @@ func Test_Trie_LoadFromMap(t *testing.T) { }{ "nil data": { expectedTrie: Trie{ - newDeletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, }, }, "empty data": { data: map[string]string{}, expectedTrie: Trie{ - newDeletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, }, }, "bad key": { @@ -1611,7 +1611,7 @@ func Test_Trie_LoadFromMap(t *testing.T) { "0xa": "0x01", }, expectedTrie: Trie{ - newDeletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, }, errWrapped: hex.ErrLength, errMessage: "cannot convert key hex to bytes: encoding/hex: odd length hex string: 0xa", @@ -1621,7 +1621,7 @@ func Test_Trie_LoadFromMap(t *testing.T) { "0x01": "0xa", }, expectedTrie: Trie{ - newDeletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, }, errWrapped: hex.ErrLength, errMessage: "cannot convert value hex to bytes: encoding/hex: odd length hex string: 0xa", @@ -1633,7 +1633,7 @@ func Test_Trie_LoadFromMap(t *testing.T) { "0x0130": "0x08", }, expectedTrie: Trie{ - newDeletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, root: &Node{ Key: []byte{00, 01}, SubValue: []byte{6}, @@ -1681,7 +1681,7 @@ func Test_Trie_LoadFromMap(t *testing.T) { "0x0130": "0x08", }, expectedTrie: Trie{ - newDeletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, root: &Node{ Key: []byte{00, 01}, SubValue: []byte{6}, @@ -2172,7 +2172,7 @@ func Test_Trie_ClearPrefixLimit(t *testing.T) { }{ "limit is zero": { expectedTrie: Trie{ - newDeletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, }, }, "clear prefix limit": { @@ -2195,7 +2195,7 @@ func Test_Trie_ClearPrefixLimit(t *testing.T) { deleted: 2, allDeleted: true, expectedTrie: Trie{ - newDeletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, }, }, } @@ -2940,7 +2940,7 @@ func Test_Trie_ClearPrefix(t *testing.T) { root: &Node{SubValue: []byte{1}}, }, expectedTrie: Trie{ - newDeletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, }, }, "empty prefix": { @@ -2949,13 +2949,13 @@ func Test_Trie_ClearPrefix(t *testing.T) { }, prefix: []byte{}, expectedTrie: Trie{ - newDeletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, }, }, "empty trie": { prefix: []byte{0x12}, expectedTrie: Trie{ - newDeletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, }, }, "clear prefix": { @@ -2988,7 +2988,7 @@ func Test_Trie_ClearPrefix(t *testing.T) { SubValue: []byte{1}, Dirty: true, }, - newDeletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, }, }, } @@ -3321,7 +3321,7 @@ func Test_Trie_Delete(t *testing.T) { root: &Node{SubValue: []byte{1}}, }, expectedTrie: Trie{ - newDeletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, }, }, "empty key": { @@ -3329,13 +3329,13 @@ func Test_Trie_Delete(t *testing.T) { root: &Node{SubValue: []byte{1}}, }, expectedTrie: Trie{ - newDeletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, }, }, "empty trie": { key: []byte{0x12}, expectedTrie: Trie{ - newDeletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, }, }, "delete branch node": { @@ -3384,7 +3384,7 @@ func Test_Trie_Delete(t *testing.T) { }, }), }, - newDeletedMerkleValues: map[string]struct{}{}, + pendingDeletedMerkleValues: map[string]struct{}{}, }, }, }