thread_local_inheritable_test.go

package routine

import (
	"math"
	"sync"
	"testing"

	"github.com/stretchr/testify/assert"
)

func TestInheritableThreadLocal_Index(t *testing.T) {
	tls := NewInheritableThreadLocal[string]()
	assert.GreaterOrEqual(t, tls.(*inheritableThreadLocal[string]).index, 0)
	tls2 := NewInheritableThreadLocalWithInitial[string](func() string {
		return "Hello"
	})
	assert.Greater(t, tls2.(*inheritableThreadLocal[string]).index, tls.(*inheritableThreadLocal[string]).index)
}

func TestInheritableThreadLocal_NextIndex(t *testing.T) {
	backup := inheritableThreadLocalIndex
	defer func() {
		inheritableThreadLocalIndex = backup
	}()
	//
	inheritableThreadLocalIndex = math.MaxInt32
	assert.Panics(t, func() {
		nextInheritableThreadLocalIndex()
	})
	assert.Equal(t, math.MaxInt32, int(inheritableThreadLocalIndex))
}

func TestInheritableThreadLocal_Common(t *testing.T) {
	tls := NewInheritableThreadLocal[int]()
	tls2 := NewInheritableThreadLocal[string]()
	tls.Remove()
	tls2.Remove()
	assert.Equal(t, 0, tls.Get())
	assert.Equal(t, "", tls2.Get())
	//
	tls.Set(1)
	tls2.Set("World")
	assert.Equal(t, 1, tls.Get())
	assert.Equal(t, "World", tls2.Get())
	//
	tls.Set(0)
	tls2.Set("")
	assert.Equal(t, 0, tls.Get())
	assert.Equal(t, "", tls2.Get())
	//
	tls.Set(2)
	tls2.Set("!")
	assert.Equal(t, 2, tls.Get())
	assert.Equal(t, "!", tls2.Get())
	//
	tls.Remove()
	tls2.Remove()
	assert.Equal(t, 0, tls.Get())
	assert.Equal(t, "", tls2.Get())
	//
	tls.Set(2)
	tls2.Set("!")
	assert.Equal(t, 2, tls.Get())
	assert.Equal(t, "!", tls2.Get())
	wg := &sync.WaitGroup{}
	wg.Add(100)
	for i := 0; i < 100; i++ {
		Go(func() {
			assert.Equal(t, 2, tls.Get())
			assert.Equal(t, "!", tls2.Get())
			wg.Done()
		})
	}
	wg.Wait()
	assert.Equal(t, 2, tls.Get())
	assert.Equal(t, "!", tls2.Get())
}

func TestInheritableThreadLocal_Mixed(t *testing.T) {
	tls := NewInheritableThreadLocal[int]()
	tls2 := NewInheritableThreadLocalWithInitial[string](func() string {
		return "Hello"
	})
	assert.Equal(t, 0, tls.Get())
	assert.Equal(t, "Hello", tls2.Get())
	//
	tls.Set(1)
	tls2.Set("World")
	assert.Equal(t, 1, tls.Get())
	assert.Equal(t, "World", tls2.Get())
	//
	tls.Set(0)
	tls2.Set("")
	assert.Equal(t, 0, tls.Get())
	assert.Equal(t, "", tls2.Get())
	//
	tls.Set(2)
	tls2.Set("!")
	assert.Equal(t, 2, tls.Get())
	assert.Equal(t, "!", tls2.Get())
	//
	tls.Remove()
	tls2.Remove()
	assert.Equal(t, 0, tls.Get())
	assert.Equal(t, "Hello", tls2.Get())
	//
	tls.Set(2)
	tls2.Set("!")
	assert.Equal(t, 2, tls.Get())
	assert.Equal(t, "!", tls2.Get())
	wg := &sync.WaitGroup{}
	wg.Add(100)
	for i := 0; i < 100; i++ {
		Go(func() {
			assert.Equal(t, 2, tls.Get())
			assert.Equal(t, "!", tls2.Get())
			wg.Done()
		})
	}
	wg.Wait()
	assert.Equal(t, 2, tls.Get())
	assert.Equal(t, "!", tls2.Get())
}

func TestInheritableThreadLocal_WithInitial(t *testing.T) {
	src := &person{Id: 1, Name: "Tim"}
	tls := NewInheritableThreadLocalWithInitial[*person](nil)
	tls2 := NewInheritableThreadLocalWithInitial[*person](func() *person {
		var value *person
		return value
	})
	tls3 := NewInheritableThreadLocalWithInitial[*person](func() *person {
		return src
	})
	tls4 := NewInheritableThreadLocalWithInitial[person](func() person {
		return *src
	})

	for i := 0; i < 100; i++ {
		p := tls.Get()
		assert.Nil(t, p)
		//
		p2 := tls2.Get()
		assert.Nil(t, p2)
		//
		p3 := tls3.Get()
		assert.Same(t, src, p3)

		p4 := tls4.Get()
		assert.NotSame(t, src, &p4)
		assert.Equal(t, *src, p4)

		wg := &sync.WaitGroup{}
		wg.Add(1)
		Go(func() {
			assert.Same(t, src, tls3.Get())
			p5 := tls4.Get()
			assert.NotSame(t, src, &p5)
			assert.Equal(t, *src, p5)
			//
			wg.Done()
		})
		wg.Wait()
	}

	tls3.Set(nil)
	tls4.Set(person{})
	assert.Nil(t, tls3.Get())
	assert.Equal(t, person{}, tls4.Get())

	tls3.Remove()
	tls4.Remove()
	assert.Same(t, src, tls3.Get())
	p6 := tls4.Get()
	assert.NotSame(t, src, &p6)
	assert.Equal(t, *src, p6)
}

func TestInheritableThreadLocal_CrossCoroutine(t *testing.T) {
	tls := NewInheritableThreadLocal[string]()
	tls.Set("Hello")
	assert.Equal(t, "Hello", tls.Get())
	subWait := &sync.WaitGroup{}
	subWait.Add(2)
	finishWait := &sync.WaitGroup{}
	finishWait.Add(2)
	go func() {
		subWait.Wait()
		assert.Equal(t, "", tls.Get())
		finishWait.Done()
	}()
	Go(func() {
		subWait.Wait()
		assert.Equal(t, "Hello", tls.Get())
		finishWait.Done()
	})
	tls.Remove()      //remove in parent goroutine should not affect child goroutine
	subWait.Done()    //allow sub goroutine run
	subWait.Done()    //allow sub goroutine run
	finishWait.Wait() //wait sub goroutine done
	finishWait.Wait() //wait sub goroutine done
}

func TestInheritableThreadLocal_CreateBatch(t *testing.T) {
	const count = 128
	tlsList := make([]ThreadLocal[int], count)
	for i := 0; i < count; i++ {
		value := i
		tlsList[i] = NewInheritableThreadLocalWithInitial[int](func() int { return value })
	}
	for i := 0; i < count; i++ {
		assert.Equal(t, i, tlsList[i].Get())
	}
}

func TestInheritableThreadLocal_Copy(t *testing.T) {
	tls := NewInheritableThreadLocalWithInitial[*person](func() *person {
		return &person{Id: 1, Name: "Tim"}
	})
	tls2 := NewInheritableThreadLocalWithInitial[person](func() person {
		return person{Id: 2, Name: "Andy"}
	})

	p1 := tls.Get()
	assert.Equal(t, 1, p1.Id)
	assert.Equal(t, "Tim", p1.Name)
	p2 := tls2.Get()
	assert.Equal(t, 2, p2.Id)
	assert.Equal(t, "Andy", p2.Name)
	//
	task := GoWait(func(token CancelToken) {
		p3 := tls.Get()
		assert.Same(t, p1, p3)
		assert.Equal(t, 1, p3.Id)
		assert.Equal(t, "Tim", p1.Name)
		p4 := tls2.Get()
		assert.NotSame(t, &p2, &p4)
		assert.Equal(t, p2, p4)
		assert.Equal(t, 2, p4.Id)
		assert.Equal(t, "Andy", p4.Name)
		//
		p3.Name = "Tim2"
		p4.Name = "Andy2"
	})
	task.Get()
	//
	p5 := tls.Get()
	assert.Same(t, p1, p5)
	assert.Equal(t, 1, p5.Id)
	assert.Equal(t, "Tim2", p5.Name)
	p6 := tls2.Get()
	assert.NotSame(t, &p2, &p6)
	assert.Equal(t, p2, p6)
	assert.Equal(t, 2, p6.Id)
	assert.Equal(t, "Andy", p6.Name)
}

func TestInheritableThreadLocal_Cloneable(t *testing.T) {
	tls := NewInheritableThreadLocalWithInitial[*personCloneable](func() *personCloneable {
		return &personCloneable{Id: 1, Name: "Tim"}
	})
	tls2 := NewInheritableThreadLocalWithInitial[personCloneable](func() personCloneable {
		return personCloneable{Id: 2, Name: "Andy"}
	})

	p1 := tls.Get()
	assert.Equal(t, 1, p1.Id)
	assert.Equal(t, "Tim", p1.Name)
	p2 := tls2.Get()
	assert.Equal(t, 2, p2.Id)
	assert.Equal(t, "Andy", p2.Name)
	//
	task := GoWait(func(token CancelToken) {
		p3 := tls.Get() //p3 is clone from p1
		assert.NotSame(t, p1, p3)
		assert.Equal(t, 1, p3.Id)
		assert.Equal(t, "Tim", p1.Name)
		p4 := tls2.Get()
		assert.NotSame(t, &p2, &p4)
		assert.Equal(t, p2, p4)
		assert.Equal(t, 2, p4.Id)
		assert.Equal(t, "Andy", p4.Name)
		//
		p3.Name = "Tim2"
		p4.Name = "Andy2"
	})
	task.Get()
	//
	p5 := tls.Get()
	assert.Same(t, p1, p5)
	assert.Equal(t, 1, p5.Id)
	assert.Equal(t, "Tim", p5.Name)
	p6 := tls2.Get()
	assert.NotSame(t, &p2, &p6)
	assert.Equal(t, p2, p6)
	assert.Equal(t, 2, p6.Id)
	assert.Equal(t, "Andy", p6.Name)
}