Files
insights-go/batching_test.go
zeekayandHanzo Dev 8ee8950230 Go 1.27.1, and the code it can say more simply
The module declares go 1.27.1 and the adapter image follows. go fix
applied the modernizers and left ptrString and ptrBool with no callers,
so they are gone; omitzero is not applied, since it changes what the
JSON says.

Co-authored-by: Hanzo Dev <[email protected]>
2026-09-16 19:52:31 -07:00

540 lines
16 KiB
Go

package insights
import (
"context"
"net/http"
json "github.com/goccy/go-json"
"net/http/httptest"
"sync"
"sync/atomic"
"testing"
"time"
"github.com/stretchr/testify/require"
)
// TestBatching_SmallEventsBatchTogether verifies that small events are batched together
func TestBatching_SmallEventsBatchTogether(t *testing.T) {
t.Parallel()
var batchCount atomic.Int64
var totalMessages atomic.Int64
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
var b batch
json.NewDecoder(r.Body).Decode(&b)
batchCount.Add(1)
totalMessages.Add(int64(len(b.Messages)))
w.WriteHeader(200)
}))
defer server.Close()
// Small events (~100 props, ~5KB each)
// With 500KB batch limit, should fit ~100 events per batch
client, err := NewWithConfig("test-key", Config{
Endpoint: server.URL,
BatchSize: 250, // Use default
Interval: 5 * time.Second, // Long interval - rely on Close() to flush
})
require.NoError(t, err)
// Send 50 small events - should all fit in one batch
pool := NewEventPoolWithCardinality(50, CardinalityLow)
for range 50 {
err := client.Enqueue(pool.Next())
require.NoError(t, err)
}
client.Close()
require.Equal(t, int64(50), totalMessages.Load(), "All 50 events should be delivered")
// Small events should batch together efficiently
require.LessOrEqual(t, batchCount.Load(), int64(3), "50 small events should fit in 3 or fewer batches")
}
// TestBatching_LargeEventsTriggerFlush verifies that large events trigger batch flushes
func TestBatching_LargeEventsTriggerFlush(t *testing.T) {
t.Parallel()
var batchCount atomic.Int64
var batchSizes []int
var mu sync.Mutex
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
var b batch
json.NewDecoder(r.Body).Decode(&b)
batchCount.Add(1)
mu.Lock()
batchSizes = append(batchSizes, len(b.Messages))
mu.Unlock()
w.WriteHeader(200)
}))
defer server.Close()
// Medium-high cardinality events (~2000 props, ~100KB each)
// With 500KB batch limit, should fit ~5 events per batch
client, err := NewWithConfig("test-key", Config{
Endpoint: server.URL,
BatchSize: 250, // Use default - byte limit should trigger before count
Interval: 50 * time.Millisecond,
})
require.NoError(t, err)
// Send 10 medium-high cardinality events
pool := NewEventPoolWithCardinality(10, CardinalityMedium)
for range 10 {
err := client.Enqueue(pool.Next())
require.NoError(t, err)
}
client.Close()
// Medium cardinality events should trigger multiple batches
require.GreaterOrEqual(t, batchCount.Load(), int64(1), "Should have at least 1 batch")
t.Logf("Batch count: %d, sizes: %v", batchCount.Load(), batchSizes)
}
// TestBatching_OversizedEventRejected verifies that events >500KB are rejected
func TestBatching_OversizedEventRejected(t *testing.T) {
t.Parallel()
var received atomic.Int64
var failureCount atomic.Int64
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
var b batch
json.NewDecoder(r.Body).Decode(&b)
received.Add(int64(len(b.Messages)))
w.WriteHeader(200)
}))
defer server.Close()
callback := &testCallbackCounter{
onFailure: func() { failureCount.Add(1) },
}
client, err := NewWithConfig("test-key", Config{
Endpoint: server.URL,
Callback: callback,
})
require.NoError(t, err)
// Create an event with MANY properties to exceed 500KB
// Each property is ~50 bytes, need ~10000 properties to hit 500KB
oversizedProps := make(Properties, 15000)
for i := range 15000 {
oversizedProps[generateDistinctId(i)] = generateDistinctId(i + 100000)
}
err = client.Enqueue(Capture{
DistinctId: "user_1",
Event: "oversized_event",
Properties: oversizedProps,
})
require.NoError(t, err) // Enqueue itself doesn't fail
client.Close()
// The oversized event should be rejected via callback
require.Equal(t, int64(0), received.Load(), "Oversized event should not be delivered")
require.Equal(t, int64(1), failureCount.Load(), "Should have 1 failure callback for oversized event")
}
// TestBatching_MixedCardinalityBatching verifies correct batching with mixed event sizes
func TestBatching_MixedCardinalityBatching(t *testing.T) {
t.Parallel()
var batchCount atomic.Int64
var totalMessages atomic.Int64
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
var b batch
json.NewDecoder(r.Body).Decode(&b)
batchCount.Add(1)
totalMessages.Add(int64(len(b.Messages)))
w.WriteHeader(200)
}))
defer server.Close()
client, err := NewWithConfig("test-key", Config{
Endpoint: server.URL,
BatchSize: 250,
Interval: 50 * time.Millisecond,
})
require.NoError(t, err)
// Send mix of small and medium events
smallPool := NewEventPoolWithCardinality(30, CardinalityLow)
mediumPool := NewEventPoolWithCardinality(20, CardinalityMedium)
// Interleave small and medium events
for i := range 30 {
err := client.Enqueue(smallPool.Next())
require.NoError(t, err)
if i < 20 {
err := client.Enqueue(mediumPool.Next())
require.NoError(t, err)
}
}
client.Close()
require.Equal(t, int64(50), totalMessages.Load(), "All 50 events should be delivered")
t.Logf("Batch count for mixed cardinality: %d", batchCount.Load())
}
// TestBatching_BatchCountLimit verifies BatchSize config is respected
func TestBatching_BatchCountLimit(t *testing.T) {
t.Parallel()
var batchSizes []int
var mu sync.Mutex
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
var b batch
json.NewDecoder(r.Body).Decode(&b)
mu.Lock()
batchSizes = append(batchSizes, len(b.Messages))
mu.Unlock()
w.WriteHeader(200)
}))
defer server.Close()
batchSize := 10
client, err := NewWithConfig("test-key", Config{
Endpoint: server.URL,
BatchSize: batchSize,
Interval: 10 * time.Millisecond, // Short interval so batch count limit triggers
})
require.NoError(t, err)
// Send 25 small events with BatchSize=10 and short interval
// The batch count limit should trigger before interval flush
pool := NewEventPoolWithCardinality(25, CardinalityLow)
for range 25 {
err := client.Enqueue(pool.Next())
require.NoError(t, err)
}
// Wait for batches to be flushed before closing
time.Sleep(100 * time.Millisecond)
client.Close()
// Check that no batch exceeds BatchSize
for i, size := range batchSizes {
require.LessOrEqual(t, size, batchSize, "Batch %d has size %d which exceeds BatchSize %d", i, size, batchSize)
}
t.Logf("Batch sizes: %v", batchSizes)
}
// testCallbackCounter is a simple callback for counting successes and failures
type testCallbackCounter struct {
onSuccess func()
onFailure func()
}
func (c *testCallbackCounter) Success(msg APIMessage) {
if c.onSuccess != nil {
c.onSuccess()
}
}
func (c *testCallbackCounter) Failure(msg APIMessage, err error) {
if c.onFailure != nil {
c.onFailure()
}
}
// TestConfigBatchSubmitTimeout verifies the default and custom BatchSubmitTimeout config
func TestConfigBatchSubmitTimeout(t *testing.T) {
t.Parallel()
// Test default value
cfg := makeConfig(Config{})
require.Equal(t, DefaultBatchSubmitTimeout, cfg.BatchSubmitTimeout, "default BatchSubmitTimeout should be %v", DefaultBatchSubmitTimeout)
// Test custom value
customTimeout := 200 * time.Millisecond
cfg = makeConfig(Config{BatchSubmitTimeout: customTimeout})
require.Equal(t, customTimeout, cfg.BatchSubmitTimeout, "custom BatchSubmitTimeout should be preserved")
// Test negative value (non-blocking mode)
cfg = makeConfig(Config{BatchSubmitTimeout: -1})
require.Equal(t, time.Duration(-1), cfg.BatchSubmitTimeout, "negative BatchSubmitTimeout should be preserved")
}
// TestBatchSubmitTimeout_WaitsForWorkers verifies that batch submission waits
// when queue is full, giving workers time to complete during latency spikes.
// Note: params are tuned for reliability under -race (adds ~10x overhead).
func TestBatchSubmitTimeout_WaitsForWorkers(t *testing.T) {
t.Parallel()
var mu sync.Mutex
var batchCount int
// Create a handler with moderate latency
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
time.Sleep(20 * time.Millisecond)
mu.Lock()
batchCount++
mu.Unlock()
w.WriteHeader(200)
}))
defer server.Close()
// Config: queue buffer = MaxEnqueuedRequests = 10
// With 20 events, queue will fill and submissions must wait for goroutines
client, err := NewWithConfig("test-key", Config{
Endpoint: server.URL,
BatchSize: 1, // 1 event per batch
Interval: 1 * time.Millisecond, // Flush immediately
MaxEnqueuedRequests: 10, // Queue buffer = 10
BatchSubmitTimeout: 500 * time.Millisecond, // Ample time for race mode
})
require.NoError(t, err)
// Send 20 events - will exceed queue buffer (10), so some must wait
for range 20 {
client.Enqueue(Capture{
DistinctId: "test-user",
Event: "test-event",
})
}
client.Close()
mu.Lock()
finalBatchCount := batchCount
mu.Unlock()
// With 500ms timeout and 20ms latency, 10 workers can process ~250 batches
// All 20 events should be delivered
require.GreaterOrEqual(t, finalBatchCount, 18, "With BatchSubmitTimeout, nearly all events should be delivered")
}
// TestBatchSubmitTimeout_NonBlocking verifies that negative timeout gives non-blocking behavior
func TestBatchSubmitTimeout_NonBlocking(t *testing.T) {
t.Parallel()
var mu sync.Mutex
var successCount int
var failureCount int
// Create a very slow handler to saturate workers
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
time.Sleep(500 * time.Millisecond) // Very slow backend
w.WriteHeader(200)
}))
defer server.Close()
callback := &testCallbackCounter{
onSuccess: func() {
mu.Lock()
successCount++
mu.Unlock()
},
onFailure: func() {
mu.Lock()
failureCount++
mu.Unlock()
},
}
// Use non-blocking mode with negative timeout
client, err := NewWithConfig("test-key", Config{
Endpoint: server.URL,
BatchSize: 1, // 1 event per batch
Interval: 1 * time.Millisecond, // Flush immediately
MaxEnqueuedRequests: 1, // Only 1 batch can be queued
BatchSubmitTimeout: -1, // Non-blocking (immediate drop)
Callback: callback,
})
require.NoError(t, err)
// Blast events as fast as possible - no sleep between enqueues.
// This ensures the channel fills faster than processBatch goroutines can drain it,
// causing the non-blocking send to drop events when the queue is full.
for range 100 {
client.Enqueue(Capture{
DistinctId: "test-user",
Event: "test-event",
})
}
client.Close()
mu.Lock()
finalSuccess := successCount
finalFailure := failureCount
mu.Unlock()
t.Logf("Non-blocking mode: %d succeeded, %d failed", finalSuccess, finalFailure)
// In non-blocking mode with slow backend, some events should be dropped
require.Greater(t, finalFailure, 0, "In non-blocking mode with slow backend, some events should be dropped")
}
// TestShutdownTimeout_DefaultWaitsForCompletion verifies that with default config
// (ShutdownTimeout=0), Close() waits indefinitely for in-flight batches to complete.
func TestShutdownTimeout_DefaultWaitsForCompletion(t *testing.T) {
t.Parallel()
var received atomic.Int64
// Create a slow server (200ms per request)
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
time.Sleep(200 * time.Millisecond)
var b batch
json.NewDecoder(r.Body).Decode(&b)
received.Add(int64(len(b.Messages)))
w.WriteHeader(200)
}))
defer server.Close()
// Default config - ShutdownTimeout is zero (wait indefinitely)
client, err := NewWithConfig("test-key", Config{
Endpoint: server.URL,
BatchSize: 5,
Interval: 10 * time.Millisecond,
// ShutdownTimeout is intentionally not set (zero value = wait indefinitely)
})
require.NoError(t, err)
// Send events
for range 10 {
err := client.Enqueue(Capture{
DistinctId: "test-user",
Event: "test-event",
})
require.NoError(t, err)
}
// Close should wait for all events to be delivered despite slow server
start := time.Now()
err = client.Close()
elapsed := time.Since(start)
require.NoError(t, err, "Close() should succeed without error when waiting indefinitely")
require.Equal(t, int64(10), received.Load(), "All events should be delivered")
require.GreaterOrEqual(t, elapsed, 200*time.Millisecond, "Close() should have waited for slow server")
t.Logf("Close() waited %v for slow server to complete", elapsed)
}
// TestShutdownTimeout_AbortsAfterTimeout verifies that when ShutdownTimeout is set,
// Close() aborts in-flight requests after the timeout and returns an error.
func TestShutdownTimeout_AbortsAfterTimeout(t *testing.T) {
t.Parallel()
var received atomic.Int64
var mu sync.Mutex
var failureCount int
// Create a very slow server (2s per request) - will exceed our timeout
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
time.Sleep(2 * time.Second)
var b batch
json.NewDecoder(r.Body).Decode(&b)
received.Add(int64(len(b.Messages)))
w.WriteHeader(200)
}))
defer server.Close()
callback := &testCallbackCounter{
onFailure: func() {
mu.Lock()
failureCount++
mu.Unlock()
},
}
// Set a short shutdown timeout (100ms)
client, err := NewWithConfig("test-key", Config{
Endpoint: server.URL,
BatchSize: 5,
Interval: 10 * time.Millisecond,
ShutdownTimeout: 100 * time.Millisecond, // Short timeout - will abort
Callback: callback,
})
require.NoError(t, err)
// Send events
for range 10 {
err := client.Enqueue(Capture{
DistinctId: "test-user",
Event: "test-event",
})
require.NoError(t, err)
}
// Close should abort after timeout
start := time.Now()
err = client.Close()
elapsed := time.Since(start)
// Should return a timeout error
require.Error(t, err, "Close() should return error when timeout is exceeded")
require.Contains(t, err.Error(), "shutdown timeout", "Error should mention shutdown timeout")
// Should have aborted relatively quickly (not waited 2s for server)
require.Less(t, elapsed, 500*time.Millisecond, "Close() should abort quickly, not wait for slow server")
// Some events may have been dropped
mu.Lock()
failures := failureCount
mu.Unlock()
t.Logf("Close() aborted after %v, received=%d, failures=%d", elapsed, received.Load(), failures)
}
// TestCloseWithContext_RespectsDeadline verifies that CloseWithContext honors
// the provided context's deadline for shutdown.
func TestCloseWithContext_RespectsDeadline(t *testing.T) {
t.Parallel()
var received atomic.Int64
// Create a slow server
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
time.Sleep(2 * time.Second)
var b batch
json.NewDecoder(r.Body).Decode(&b)
received.Add(int64(len(b.Messages)))
w.WriteHeader(200)
}))
defer server.Close()
// No ShutdownTimeout configured - will use context deadline instead
client, err := NewWithConfig("test-key", Config{
Endpoint: server.URL,
BatchSize: 5,
Interval: 10 * time.Millisecond,
})
require.NoError(t, err)
// Send events
for range 10 {
err := client.Enqueue(Capture{
DistinctId: "test-user",
Event: "test-event",
})
require.NoError(t, err)
}
// Use CloseWithContext with a short deadline
ctx, cancel := context.WithTimeout(context.Background(), 100*time.Millisecond)
defer cancel()
start := time.Now()
err = client.CloseWithContext(ctx)
elapsed := time.Since(start)
// Should return a timeout error
require.Error(t, err, "CloseWithContext should return error when context deadline exceeded")
require.Contains(t, err.Error(), "shutdown timeout", "Error should mention shutdown timeout")
// Should have aborted at context deadline
require.Less(t, elapsed, 500*time.Millisecond, "CloseWithContext should respect context deadline")
t.Logf("CloseWithContext aborted after %v", elapsed)
}