htmgo/framework/h/cache/lru_store_test.go

package cache

import (
	"fmt"
	"sync"
	"sync/atomic"
	"testing"
	"time"
)

func TestLRUStore_SetAndGet(t *testing.T) {
	store := NewLRUStore[string, string](10)
	defer store.Close()

	// Test basic set and get
	store.Set("key1", "value1", 1*time.Hour)

	val := store.GetOrCompute("key1", func() string {
		t.Error("Should not compute for existing key")
		return "should-not-compute"
	}, 1*time.Hour)
	if val != "value1" {
		t.Errorf("Expected value1, got %s", val)
	}

	// Test getting non-existent key
	computeCalled := false
	val = store.GetOrCompute("nonexistent", func() string {
		computeCalled = true
		return "computed-value"
	}, 1*time.Hour)
	if !computeCalled {
		t.Error("Expected compute function to be called for non-existent key")
	}
	if val != "computed-value" {
		t.Errorf("Expected computed-value for non-existent key, got %s", val)
	}
}

// TestLRUStore_SizeLimit tests are commented out because they rely on
// being able to check cache contents without modifying LRU order,
// which is not possible with GetOrCompute-only interface
/*
func TestLRUStore_SizeLimit(t *testing.T) {
	// Create store with capacity of 3
	store := NewLRUStore[int, string](3)
	defer store.Close()

	// Add 3 items
	store.Set(1, "one", 1*time.Hour)
	store.Set(2, "two", 1*time.Hour)
	store.Set(3, "three", 1*time.Hour)

	// Add fourth item, should evict least recently used (key 1)
	store.Set(4, "four", 1*time.Hour)

	// Key 1 should be evicted
	computeCalled := false
	val := store.GetOrCompute(1, func() string {
		computeCalled = true
		return "recomputed-one"
	}, 1*time.Hour)
	if !computeCalled {
		t.Error("Expected key 1 to be evicted and recomputed")
	}
	if val != "recomputed-one" {
		t.Errorf("Expected recomputed value for key 1, got %s", val)
	}

	// At this point, cache has keys: 1 (just added), 2, 3, 4
	// But capacity is 3, so one of the original keys was evicted
	// Let's just verify we have exactly 3 items and key 1 is now present
	count := 0
	for i := 1; i <= 4; i++ {
		localI := i
		computed := false
		store.GetOrCompute(localI, func() string {
			computed = true
			return fmt.Sprintf("recomputed-%d", localI)
		}, 1*time.Hour)
		if !computed {
			count++
		}
	}
	// We should have found 3 items in cache (since capacity is 3)
	// The 4th check would have caused another eviction and recomputation
	if count != 3 {
		t.Errorf("Expected exactly 3 items in cache, found %d", count)
	}
}
*/

func TestLRUStore_LRUBehavior(t *testing.T) {
	store := NewLRUStore[string, string](3)
	defer store.Close()

	// Add items in order: c (MRU), b, a (LRU)
	store.Set("a", "A", 1*time.Hour)
	store.Set("b", "B", 1*time.Hour)
	store.Set("c", "C", 1*time.Hour)

	// Access "a" to make it recently used
	// Now order is: a (MRU), c, b (LRU)
	val := store.GetOrCompute("a", func() string {
		t.Error("Should not compute for existing key")
		return "should-not-compute"
	}, 1*time.Hour)
	if val != "A" {
		t.Errorf("Expected 'A', got %s", val)
	}

	// Add "d", should evict "b" (least recently used)
	// Now we have: d (MRU), a, c
	store.Set("d", "D", 1*time.Hour)

	// Verify "b" was evicted
	computeCalled := false
	val = store.GetOrCompute("b", func() string {
		computeCalled = true
		return "recomputed-b"
	}, 1*time.Hour)
	if !computeCalled {
		t.Error("Expected 'b' to be evicted")
	}

	// Now cache has: b (MRU), d, a
	// and "c" should have been evicted when we added "b" back
	
	// Verify the current state matches expectations
	// We'll collect all values without modifying order too much
	presentKeys := make(map[string]bool)
	for _, key := range []string{"a", "b", "c", "d"} {
		localKey := key
		computed := false
		store.GetOrCompute(localKey, func() string {
			computed = true
			return "recomputed"
		}, 1*time.Hour)
		if !computed {
			presentKeys[localKey] = true
		}
	}

	// We should have exactly 3 keys in cache
	if len(presentKeys) > 3 {
		t.Errorf("Cache has more than 3 items: %v", presentKeys)
	}
}

func TestLRUStore_UpdateMovesToFront(t *testing.T) {
	store := NewLRUStore[string, string](3)
	defer store.Close()

	// Fill cache
	store.Set("a", "A", 1*time.Hour)
	store.Set("b", "B", 1*time.Hour)
	store.Set("c", "C", 1*time.Hour)

	// Update "a" with new value - should move to front
	store.Set("a", "A_updated", 1*time.Hour)

	// Add new item - should evict "b" not "a"
	store.Set("d", "D", 1*time.Hour)

	val := store.GetOrCompute("a", func() string {
		t.Error("Should not compute for existing key 'a'")
		return "should-not-compute"
	}, 1*time.Hour)
	if val != "A_updated" {
		t.Errorf("Expected updated value, got %s", val)
	}

	computeCalled := false
	store.GetOrCompute("b", func() string {
		computeCalled = true
		return "recomputed-b"
	}, 1*time.Hour)
	if !computeCalled {
		t.Error("Expected 'b' to be evicted and recomputed")
	}
}

func TestLRUStore_Expiration(t *testing.T) {
	store := NewLRUStore[string, string](10)
	defer store.Close()

	// Set with short TTL
	store.Set("shortlived", "value", 100*time.Millisecond)

	// Should exist immediately
	val := store.GetOrCompute("shortlived", func() string {
		t.Error("Should not compute for existing key")
		return "should-not-compute"
	}, 100*time.Millisecond)
	if val != "value" {
		t.Errorf("Expected value, got %s", val)
	}

	// Wait for expiration
	time.Sleep(150 * time.Millisecond)

	// Should be expired now
	computeCalled := false
	val = store.GetOrCompute("shortlived", func() string {
		computeCalled = true
		return "recomputed-after-expiry"
	}, 100*time.Millisecond)
	if !computeCalled {
		t.Error("Expected compute function to be called for expired key")
	}
	if val != "recomputed-after-expiry" {
		t.Errorf("Expected recomputed value for expired key, got %s", val)
	}
}

func TestLRUStore_Delete(t *testing.T) {
	store := NewLRUStore[string, string](10)
	defer store.Close()

	store.Set("key1", "value1", 1*time.Hour)

	// Verify it exists
	val := store.GetOrCompute("key1", func() string {
		t.Error("Should not compute for existing key")
		return "should-not-compute"
	}, 1*time.Hour)
	if val != "value1" {
		t.Errorf("Expected value1, got %s", val)
	}

	// Delete it
	store.Delete("key1")

	// Verify it's gone
	computeCalled := false
	val = store.GetOrCompute("key1", func() string {
		computeCalled = true
		return "recomputed-after-delete"
	}, 1*time.Hour)
	if !computeCalled {
		t.Error("Expected compute function to be called after deletion")
	}
	if val != "recomputed-after-delete" {
		t.Errorf("Expected recomputed value after deletion, got %s", val)
	}

	// Delete non-existent key should not panic
	store.Delete("nonexistent")
}

func TestLRUStore_Purge(t *testing.T) {
	store := NewLRUStore[string, string](10)
	defer store.Close()

	// Add multiple items
	store.Set("key1", "value1", 1*time.Hour)
	store.Set("key2", "value2", 1*time.Hour)
	store.Set("key3", "value3", 1*time.Hour)

	// Verify they exist
	for i := 1; i <= 3; i++ {
		key := "key" + string(rune('0'+i))
		val := store.GetOrCompute(key, func() string {
			t.Errorf("Should not compute for existing key %s", key)
			return "should-not-compute"
		}, 1*time.Hour)
		expectedVal := "value" + string(rune('0'+i))
		if val != expectedVal {
			t.Errorf("Expected to find %s with value %s, got %s", key, expectedVal, val)
		}
	}

	// Purge all
	store.Purge()

	// Verify all are gone
	for i := 1; i <= 3; i++ {
		key := "key" + string(rune('0'+i))
		computeCalled := false
		store.GetOrCompute(key, func() string {
			computeCalled = true
			return "recomputed-after-purge"
		}, 1*time.Hour)
		if !computeCalled {
			t.Errorf("Expected %s to be purged and recomputed", key)
		}
	}
}

func TestLRUStore_ConcurrentAccess(t *testing.T) {
	// Need capacity for all unique keys: 100 goroutines * 100 operations = 10,000
	store := NewLRUStore[int, int](10000)
	defer store.Close()

	const numGoroutines = 100
	const numOperations = 100

	var wg sync.WaitGroup
	wg.Add(numGoroutines)

	// Concurrent writes and reads
	for i := 0; i < numGoroutines; i++ {
		go func(id int) {
			defer wg.Done()

			for j := 0; j < numOperations; j++ {
				key := (id * numOperations) + j
				store.Set(key, key*2, 1*time.Hour)

				// Immediately read it back
				val := store.GetOrCompute(key, func() int {
					t.Errorf("Goroutine %d: Should not compute for just-set key %d", id, key)
					return -1
				}, 1*time.Hour)
				if val != key*2 {
					t.Errorf("Goroutine %d: Expected value %d, got %d", id, key*2, val)
				}
			}
		}(i)
	}

	wg.Wait()
}

func TestLRUStore_ExpiredEntriesCleanup(t *testing.T) {
	store := NewLRUStore[string, string](100)
	defer store.Close()

	// Add many short-lived entries
	for i := 0; i < 50; i++ {
		key := "key" + string(rune('0'+i))
		store.Set(key, "value", 100*time.Millisecond)
	}

	// Add some long-lived entries
	for i := 50; i < 60; i++ {
		key := "key" + string(rune('0'+i))
		store.Set(key, "value", 1*time.Hour)
	}

	// Wait for short-lived entries to expire and cleanup to run
	time.Sleep(1200 * time.Millisecond)

	// Check that expired entries are gone
	for i := 0; i < 50; i++ {
		key := "key" + string(rune('0'+i))
		computeCalled := false
		store.GetOrCompute(key, func() string {
			computeCalled = true
			return "recomputed-after-expiry"
		}, 100*time.Millisecond)
		if !computeCalled {
			t.Errorf("Expected expired key %s to be cleaned up and recomputed", key)
		}
	}

	// Long-lived entries should still exist
	for i := 50; i < 60; i++ {
		key := "key" + string(rune('0'+i))
		val := store.GetOrCompute(key, func() string {
			t.Errorf("Should not compute for long-lived key %s", key)
			return "should-not-compute"
		}, 1*time.Hour)
		if val != "value" {
			t.Errorf("Expected long-lived key %s to still exist with value 'value', got %s", key, val)
		}
	}
}

func TestLRUStore_InvalidSize(t *testing.T) {
	// Test that creating store with invalid size panics
	defer func() {
		if r := recover(); r == nil {
			t.Error("Expected panic for zero size")
		}
	}()

	NewLRUStore[string, string](0)
}

func TestLRUStore_Close(t *testing.T) {
	store := NewLRUStore[string, string](10)

	// Close should not panic
	store.Close()

	// Multiple closes should not panic
	store.Close()
	store.Close()
}

// TestLRUStore_ComplexEvictionScenario is commented out because
// checking cache state with GetOrCompute modifies the LRU order
/*
func TestLRUStore_ComplexEvictionScenario(t *testing.T) {
	store := NewLRUStore[string, string](4)
	defer store.Close()

	// Fill cache: d (MRU), c, b, a (LRU)
	store.Set("a", "A", 1*time.Hour)
	store.Set("b", "B", 1*time.Hour)
	store.Set("c", "C", 1*time.Hour)
	store.Set("d", "D", 1*time.Hour)

	// Access in specific order to control LRU order
	store.GetOrCompute("b", func() string { return "B" }, 1*time.Hour) // b (MRU), d, c, a (LRU)
	store.GetOrCompute("d", func() string { return "D" }, 1*time.Hour) // d (MRU), b, c, a (LRU)
	store.GetOrCompute("a", func() string { return "A" }, 1*time.Hour) // a (MRU), d, b, c (LRU)

	// Record initial state
	initialOrder := "a (MRU), d, b, c (LRU)"
	_ = initialOrder // for documentation

	// Add two new items
	store.Set("e", "E", 1*time.Hour) // Should evict c (LRU) -> a, d, b, e
	store.Set("f", "F", 1*time.Hour) // Should evict b (LRU) -> a, d, e, f

	// Check if our expectations match by counting present keys
	// We'll check each key once to minimize LRU order changes
	evicted := []string{}
	present := []string{}
	
	for _, key := range []string{"a", "b", "c", "d", "e", "f"} {
		localKey := key
		computeCalled := false
		store.GetOrCompute(localKey, func() string {
			computeCalled = true
			return "recomputed-" + localKey
		}, 1*time.Hour)
		
		if computeCalled {
			evicted = append(evicted, localKey)
		} else {
			present = append(present, localKey)
		}
		
		// After checking all 6 keys, we'll have at most 4 in cache
		if len(present) > 4 {
			break
		}
	}

	// We expect c and b to have been evicted
	expectedEvicted := map[string]bool{"b": true, "c": true}
	for _, key := range evicted {
		if !expectedEvicted[key] {
			t.Errorf("Unexpected key %s was evicted", key)
		}
	}

	// Verify we have exactly 4 items in cache
	if len(present) > 4 {
		t.Errorf("Cache has more than 4 items: %v", present)
	}
}
*/

func TestLRUStore_GetOrCompute(t *testing.T) {
	store := NewLRUStore[string, string](10)
	defer store.Close()

	computeCount := 0

	// Test computing when not in cache
	result := store.GetOrCompute("key1", func() string {
		computeCount++
		return "computed-value"
	}, 1*time.Hour)

	if result != "computed-value" {
		t.Errorf("Expected computed-value, got %s", result)
	}
	if computeCount != 1 {
		t.Errorf("Expected compute to be called once, called %d times", computeCount)
	}

	// Test returning cached value
	result = store.GetOrCompute("key1", func() string {
		computeCount++
		return "should-not-compute"
	}, 1*time.Hour)

	if result != "computed-value" {
		t.Errorf("Expected cached value, got %s", result)
	}
	if computeCount != 1 {
		t.Errorf("Expected compute to not be called again, total calls: %d", computeCount)
	}
}

func TestLRUStore_GetOrCompute_Expiration(t *testing.T) {
	store := NewLRUStore[string, string](10)
	defer store.Close()

	computeCount := 0

	// Set with short TTL
	result := store.GetOrCompute("shortlived", func() string {
		computeCount++
		return "value1"
	}, 100*time.Millisecond)

	if result != "value1" {
		t.Errorf("Expected value1, got %s", result)
	}
	if computeCount != 1 {
		t.Errorf("Expected 1 compute, got %d", computeCount)
	}

	// Should return cached value immediately
	result = store.GetOrCompute("shortlived", func() string {
		computeCount++
		return "value2"
	}, 100*time.Millisecond)

	if result != "value1" {
		t.Errorf("Expected cached value1, got %s", result)
	}
	if computeCount != 1 {
		t.Errorf("Expected still 1 compute, got %d", computeCount)
	}

	// Wait for expiration
	time.Sleep(150 * time.Millisecond)

	// Should compute new value after expiration
	result = store.GetOrCompute("shortlived", func() string {
		computeCount++
		return "value2"
	}, 100*time.Millisecond)

	if result != "value2" {
		t.Errorf("Expected new value2, got %s", result)
	}
	if computeCount != 2 {
		t.Errorf("Expected 2 computes after expiration, got %d", computeCount)
	}
}

func TestLRUStore_GetOrCompute_Concurrent(t *testing.T) {
	store := NewLRUStore[string, string](100)
	defer store.Close()

	var computeCount int32
	const numGoroutines = 100

	var wg sync.WaitGroup
	wg.Add(numGoroutines)

	// Launch many goroutines trying to compute the same key
	for i := 0; i < numGoroutines; i++ {
		go func(id int) {
			defer wg.Done()

			result := store.GetOrCompute("shared-key", func() string {
				// Increment atomically to count calls
				atomic.AddInt32(&computeCount, 1)
				// Simulate some work
				time.Sleep(10 * time.Millisecond)
				return "shared-value"
			}, 1*time.Hour)

			if result != "shared-value" {
				t.Errorf("Goroutine %d: Expected shared-value, got %s", id, result)
			}
		}(i)
	}

	wg.Wait()

	// Only one goroutine should have computed the value
	if computeCount != 1 {
		t.Errorf("Expected exactly 1 compute for concurrent access, got %d", computeCount)
	}
}

func TestLRUStore_GetOrCompute_WithEviction(t *testing.T) {
	// Small cache to test eviction behavior
	store := NewLRUStore[int, string](3)
	defer store.Close()

	computeCounts := make(map[int]int)

	// Fill cache to capacity
	for i := 1; i <= 3; i++ {
		store.GetOrCompute(i, func() string {
			computeCounts[i]++
			return fmt.Sprintf("value-%d", i)
		}, 1*time.Hour)
	}

	// All should be computed once
	for i := 1; i <= 3; i++ {
		if computeCounts[i] != 1 {
			t.Errorf("Key %d: Expected 1 compute, got %d", i, computeCounts[i])
		}
	}

	// Add fourth item - should evict key 1
	store.GetOrCompute(4, func() string {
		computeCounts[4]++
		return "value-4"
	}, 1*time.Hour)

	// Try to get key 1 again - should need to recompute
	result := store.GetOrCompute(1, func() string {
		computeCounts[1]++
		return "value-1-recomputed"
	}, 1*time.Hour)

	if result != "value-1-recomputed" {
		t.Errorf("Expected recomputed value, got %s", result)
	}
	if computeCounts[1] != 2 {
		t.Errorf("Key 1: Expected 2 computes after eviction, got %d", computeCounts[1])
	}
}

// TestLRUStore_GetOrCompute_UpdatesLRU is commented out because
// verifying cache state with GetOrCompute modifies the LRU order
/*
func TestLRUStore_GetOrCompute_UpdatesLRU(t *testing.T) {
	store := NewLRUStore[string, string](3)
	defer store.Close()

	// Fill cache: c (MRU), b, a (LRU)
	store.GetOrCompute("a", func() string { return "A" }, 1*time.Hour)
	store.GetOrCompute("b", func() string { return "B" }, 1*time.Hour)
	store.GetOrCompute("c", func() string { return "C" }, 1*time.Hour)

	// Access "a" again - should move to front
	// Order becomes: a (MRU), c, b (LRU)
	val := store.GetOrCompute("a", func() string { return "A-new" }, 1*time.Hour)
	if val != "A" {
		t.Errorf("Expected existing value 'A', got %s", val)
	}

	// Add new item - should evict "b" (least recently used)
	// Order becomes: d (MRU), a, c
	store.GetOrCompute("d", func() string { return "D" }, 1*time.Hour)

	// Verify "b" was evicted by trying to get it
	computeCalled := false
	val = store.GetOrCompute("b", func() string {
		computeCalled = true
		return "B-recomputed"
	}, 1*time.Hour)
	
	if !computeCalled {
		t.Error("Expected 'b' to be evicted and recomputed")
	}
	if val != "B-recomputed" {
		t.Errorf("Expected 'B-recomputed', got %s", val)
	}

	// At this point, the cache contains b (just added), d, a
	// and c was evicted when b was re-added
	// Let's verify by checking the cache has exactly 3 items
	presentCount := 0
	for _, key := range []string{"a", "b", "c", "d"} {
		localKey := key
		computed := false
		store.GetOrCompute(localKey, func() string {
			computed = true
			return "check-" + localKey
		}, 1*time.Hour)
		if !computed {
			presentCount++
		}
	}

	if presentCount != 3 {
		t.Errorf("Expected exactly 3 items in cache, found %d", presentCount)
	}
}
*/