Add tests and benchmarks

i5heu · May 18, 2024 · 602debf · 602debf
1 parent 41f0a41
commit 602debf
Show file tree

Hide file tree

Showing 4 changed files with 156 additions and 8 deletions.
diff --git a/ouroboros_test.go b/ouroboros_test.go
@@ -155,6 +155,53 @@ func Test_Index_RebuildIndex(t *testing.T) {
 	}
 }
 
+func Test_Index_GetDirectParentOfEvent(t *testing.T) {
+	ou, evs := setupDBWithData(t, setupDBConfig{
+		totalEvents:     1000,
+		returnAllEvents: true,
+		eventLevels:     5,
+	})
+
+	var parentCount int
+
+	for _, evHash := range evs {
+		parent, err := ou.Index.GetDirectParentOfEvent(evHash)
+		if err != nil {
+			t.Errorf("GetDirectParentOfEvent failed with error: %v", err)
+		}
+		if parent == nil {
+			continue
+		}
+		parentCount++
+	}
+
+	if parentCount == 0 {
+		t.Errorf("GetDirectParentOfEvent failed, expected non-zero count, got %d", parentCount)
+	}
+}
+
+func Test_Index_GetParentHashOfEvent(t *testing.T) {
+	ou, evs := setupDBWithData(t, setupDBConfig{
+		totalEvents:     1000,
+		returnAllEvents: true,
+		eventLevels:     5,
+	})
+
+	var childrenCount int
+
+	for _, evHash := range evs {
+		parent := ou.Index.GetParentHashOfEvent(evHash)
+		if parent == [64]byte{} {
+			continue
+		}
+		childrenCount++
+	}
+
+	if childrenCount == 0 {
+		t.Errorf("GetChildrenHashesOfEvent failed, expected non-zero count, got %d", childrenCount)
+	}
+}
+
 func Test_Index_GetDirectChildrenOfEvent(t *testing.T) {
 	ou, evs := setupDBWithData(t, setupDBConfig{
 		totalEvents:     100,
@@ -429,6 +476,42 @@ func Test_DB_CreateNewEvent(t *testing.T) {
 	}
 }
 
+func Test_DB_fastMeta(t *testing.T) {
+	ou, evs := setupDBWithData(t, setupDBConfig{
+		totalEvents: 1,
+	})
+
+	rootEv := evs[0]
+
+	fm := types.FastMeta{
+		types.FastMetaParameter([]byte("test1")),
+		types.FastMetaParameter([]byte("test2")),
+		types.FastMetaParameter([]byte("test3")),
+		types.FastMetaParameter([]byte("test4")),
+		types.FastMetaParameter([]byte("test5")),
+		types.FastMetaParameter([]byte("test6")),
+	}
+
+	ev, err := ou.DB.CreateNewEvent(storage.EventOptions{
+		ParentEvent: rootEv,
+		FastMeta:    fm,
+	})
+	if err != nil {
+		t.Errorf("CreateNewEvent failed with error: %v", err)
+	}
+
+	evGet, err := ou.DB.GetEvent(ev.EventIdentifier.EventHash)
+	if err != nil {
+		t.Errorf("GetEvent failed with error: %v", err)
+	}
+
+	for i, param := range evGet.FastMeta {
+		if string(param) != string(fm[i]) {
+			t.Errorf("FastMeta failed, expected %s, got %s", fm[i], param)
+		}
+	}
+}
+
 func Example() {
 	// Initialize OuroborosDB with basic configuration
 	ou, err := ouroboros.NewOuroborosDB(ouroboros.Config{
@@ -731,3 +814,69 @@ func Benchmark_DB_CreateNewEvent(b *testing.B) {
 		}
 	})
 }
+
+func Benchmark_DB_fastMeta(b *testing.B) {
+	ou, evs := setupDBWithData(b, setupDBConfig{
+		totalEvents: 1,
+	})
+
+	rootEv := evs[0]
+
+	fm := types.FastMeta{
+		types.FastMetaParameter([]byte("test1")),
+		types.FastMetaParameter([]byte("test2")),
+		types.FastMetaParameter([]byte("test3")),
+		types.FastMetaParameter([]byte("test4")),
+		types.FastMetaParameter([]byte("test5")),
+		types.FastMetaParameter([]byte("test6")),
+	}
+
+	b.Run("CreateNewEvent with FastMeta", func(b *testing.B) {
+		for i := 0; i < b.N; i++ {
+			_, err := ou.DB.CreateNewEvent(storage.EventOptions{
+				ParentEvent: rootEv,
+				FastMeta:    fm,
+			})
+			if err != nil {
+				b.Errorf("CreateNewEvent failed with error: %v", err)
+			}
+		}
+	})
+
+	ev, err := ou.DB.CreateNewEvent(storage.EventOptions{
+		ParentEvent: rootEv,
+		FastMeta:    fm,
+	})
+	if err != nil {
+		b.Errorf("CreateNewEvent failed with error: %v", err)
+	}
+
+	b.Run("GetEvent with FastMeta", func(b *testing.B) {
+		for i := 0; i < b.N; i++ {
+			evGet, err := ou.DB.GetEvent(ev.EventIdentifier.EventHash)
+			if err != nil {
+				b.Errorf("GetEvent failed with error: %v", err)
+			}
+			for i, param := range evGet.FastMeta {
+				if string(param) != string(fm[i]) {
+					b.Errorf("FastMeta failed, expected %s, got %s", fm[i], param)
+				}
+			}
+		}
+	})
+}
+
+func Benchmark_Index_GetParentHashOfEvent(b *testing.B) {
+	ou, evs := setupDBWithData(b, setupDBConfig{
+		totalEvents:     1000,
+		returnAllEvents: true,
+		eventLevels:     5,
+	})
+
+	b.Run("GetParentHashOfEvent", func(b *testing.B) {
+		for i := 0; i < b.N; i++ {
+			evHash := evs[rand.Intn(len(evs))]
+			_ = ou.Index.GetParentHashOfEvent(evHash)
+		}
+	})
+}
diff --git a/pkg/index/ChildrenToParents.go b/pkg/index/ChildrenToParents.go
@@ -15,17 +15,16 @@ func (i *Index) RebuildChildrenToParents(allEvents []types.Event) error {
 	return nil
 }
 
-func (i *Index) GetParentHashOfEvent(eventHash types.Hash) (types.Hash, bool) {
+func (i *Index) GetParentHashOfEvent(eventHash types.Hash) types.Hash {
 	i.evChildToParentLock.RLock()
 	defer i.evChildToParentLock.RUnlock()
-	parentHash, exists := i.evChildToParent[eventHash]
-	return parentHash, exists
+	return i.evChildToParent[eventHash]
 }
 
 func (i *Index) GetDirectParentOfEvent(eventHash types.Hash) (*types.Event, error) {
-	parentHash, exists := i.GetParentHashOfEvent(eventHash)
-	if !exists {
-		return nil, nil // No parent found
+	parentHash := i.GetParentHashOfEvent(eventHash)
+	if parentHash == (types.Hash{}) {
+		return nil, nil
 	}
 
 	parentEvent, err := i.s.GetEvent(parentHash)

diff --git a/pkg/index/FastMeta.go b/pkg/index/FastMeta.go
@@ -0,0 +1 @@
+package index
diff --git a/pkg/index/index_test.go b/pkg/index/index_test.go
@@ -110,8 +110,7 @@ func TestIndex_GetParentHashOfEvent(t *testing.T) {
 	childHash := types.Hash{2}
 	index.evChildToParent[childHash] = parentHash
 
-	retrievedParentHash, exists := index.GetParentHashOfEvent(childHash)
-	assert.True(t, exists)
+	retrievedParentHash := index.GetParentHashOfEvent(childHash)
 	assert.Equal(t, parentHash, retrievedParentHash)
 }