add test cases for fields

utils/log/loggers/test/benchmark_test.go

@@ -0,0 +1,24 @@
+//go test -v -bench=. -run=none .
+package loggers_test
+
+import (
+	"context"
+	"fmt"
+	"testing"
+
+	s "github.com/carousell/Orion/utils/log/loggers"
+)
+
+func BenchmarkFromContext(b *testing.B) {
+	ctx := context.Background()
+	for i := 0; i < b.N; i++ {
+		s.FromContext(ctx)
+	}
+}
+
+func BenchmarkFromAddToLogContext(b *testing.B) {
+	ctx := context.Background()
+	for i := 0; i < b.N; i++ {
+		s.AddToLogContext(ctx, fmt.Sprintf("key%d", i), "good value")
+	}
+}

utils/log/loggers/test/example_test.go

@@ -0,0 +1,19 @@
+package loggers_test
+
+import (
+	"context"
+	"fmt"
+
+	s "github.com/carousell/Orion/utils/log/loggers"
+)
+
+func ExampleFromContext() {
+	ctx := context.Background()
+	ctx = s.AddToLogContext(ctx, "indespensable", "amazing data")
+	ctx = s.AddToLogContext(ctx, "preciousData", "valuable key")
+	lf := s.FromContext(ctx)
+	fmt.Println(lf)
+
+	// Output:
+	// map[indespensable:amazing data preciousData:valuable key]
+}

utils/log/loggers/test/parallelism_test.go

@@ -0,0 +1,107 @@
+//go test -race
+package loggers_test
+
+import (
+	"context"
+	"fmt"
+	"math/rand"
+	"sync"
+	"testing"
+	"time"
+
+	s "github.com/carousell/Orion/utils/log/loggers"
+	"github.com/stretchr/testify/assert"
+)
+
+const readWorkerCount = 5
+const writeWorkerCount = 5
+
+func readWorker(idx int, ctx context.Context) {
+	lf := s.FromContext(ctx)
+	// simulate reading task
+	time.Sleep(time.Millisecond * 250)
+	fmt.Printf("Reader %d read from logfields %+v\n", idx, lf)
+}
+
+func writeWorker(idx int, ctx context.Context) context.Context {
+	key := fmt.Sprintf("key%d", idx)
+	val := fmt.Sprintf("val%d", rand.Intn(10000))
+	ctx = s.AddToLogContext(ctx, key, val)
+	time.Sleep(time.Millisecond * 250)
+	fmt.Printf("Writer %d wrote %s:%s\n", idx, key, val)
+	return ctx
+}
+
+func TestParallelRead(t *testing.T) {
+	// LogContext init, non-paralel
+	ctx := context.Background()
+	ctx = s.AddToLogContext(ctx, "k1", "v1")
+	ctx = s.AddToLogContext(ctx, "k2", "v2")
+
+	var wg sync.WaitGroup
+	for i := 1; i <= readWorkerCount; i++ {
+		wg.Add(1)
+		go func(j int) {
+			defer wg.Done()
+			readWorker(j, ctx)
+		}(i)
+	}
+	wg.Wait()
+}
+
+func TestParallelWrite(t *testing.T) {
+	ctx := context.Background()
+	ctx = s.AddToLogContext(ctx, "test-key", "test-value")
+
+	var wg sync.WaitGroup
+	for i := 1; i <= writeWorkerCount; i++ {
+		wg.Add(1)
+		go func(j int) {
+			defer wg.Done()
+			writeWorker(j, ctx)
+		}(i)
+	}
+	wg.Wait()
+
+	lf := s.FromContext(ctx)
+	fmt.Println(lf)
+
+	assert.Contains(t, lf, "test-key")
+	for i := 1; i <= writeWorkerCount; i++ {
+		key := fmt.Sprintf("key%d", i)
+		assert.Contains(t, lf, key)
+	}
+}
+
+func TestParallelReadAndWrite(t *testing.T) {
+	ctx := context.Background()
+	ctx = s.AddToLogContext(ctx, "test-key", "test-value")
+
+	var wgRead sync.WaitGroup
+	for i := 1; i <= readWorkerCount; i++ {
+		wgRead.Add(1)
+		go func(j int) {
+			defer wgRead.Done()
+			readWorker(j, ctx)
+		}(i)
+	}
+	var wgWrite sync.WaitGroup
+	for i := 1; i <= writeWorkerCount; i++ {
+		wgWrite.Add(1)
+		go func(j int) {
+			defer wgWrite.Done()
+			writeWorker(j, ctx)
+		}(i)
+	}
+	wgRead.Wait()
+	wgWrite.Wait()
+
+	lf := s.FromContext(ctx)
+	fmt.Println(lf)
+
+	assert.Contains(t, lf, "test-key")
+	for i := 1; i <= writeWorkerCount; i++ {
+		key := fmt.Sprintf("key%d", i)
+		assert.Contains(t, lf, key)
+	}
+}