event/issues_test.go

package event_test

import (
	"bytes"
	"context"
	"fmt"
	"testing"
	"time"

	"github.com/gookit/event"
	"github.com/gookit/goutil/testutil/assert"
)

type testNotify struct{}

func (notify *testNotify) Handle(_ event.Event) error {
	isRun = true
	return nil
}

var isRun = false

// https://github.com/gookit/event/issues/8
func TestIssue_8(t *testing.T) {
	notify := testNotify{}

	event.On("*", &notify)
	err, _ := event.Fire("test_notify", event.M{})
	assert.Nil(t, err)
	assert.True(t, isRun)

	event.On("test_notify", &notify)
	err, _ = event.Fire("test_notify", event.M{})
	assert.Nil(t, err)
	assert.True(t, isRun)
}

// https://github.com/gookit/event/issues/9
func TestIssues_9(t *testing.T) {
	evBus := event.NewManager("")
	eName := "evt1"

	f1 := makeFn(11)
	evBus.On(eName, f1)

	f2 := makeFn(22)
	evBus.On(eName, f2)
	assert.Equal(t, 2, evBus.ListenersCount(eName))

	f3 := event.ListenerFunc(func(e event.Event) error {
		// dump.Println(e.Name())
		return nil
	})
	evBus.On(eName, f3)
	assert.Equal(t, 3, evBus.ListenersCount(eName))

	evBus.RemoveListener(eName, f1) // DON'T REMOVE ALL !!!
	assert.Equal(t, 2, evBus.ListenersCount(eName))

	evBus.MustFire(eName, event.M{"arg0": "val0", "arg1": "val1"})
}

func makeFn(a int) event.ListenerFunc {
	return func(e event.Event) error {
		e.Set("val", a)
		// dump.Println(a, e.Name())
		return nil
	}
}

// https://github.com/gookit/event/issues/20
func TestIssues_20(t *testing.T) {
	buf := new(bytes.Buffer)
	mgr := event.NewManager("test")

	handler := event.ListenerFunc(func(e event.Event) error {
		_, _ = fmt.Fprintf(buf, "%s-%s|", e.Name(), e.Get("user"))
		return nil
	})

	mgr.On("app.user.*", handler)
	// ERROR: if not register "app.user.add", will not trigger "app.user.*"
	// mgr.On("app.user.add", handler)

	err, _ := mgr.Fire("app.user.add", event.M{"user": "INHERE"})
	assert.NoError(t, err)
	assert.Equal(t, "app.user.add-INHERE|", buf.String())

	// dump.P(buf.String())
}

// https://github.com/gookit/event/issues/53
// 我现在 在事件1里面， 触发启动事件2 是 启动不了的，貌似他会进入一个死循环进行卡死状态
func TestIssues_53(t *testing.T) {
	buf := new(bytes.Buffer)
	mgr := event.NewManager("test")

	handler1 := event.ListenerFunc(func(e event.Event) error {
		_, _ = fmt.Fprintf(buf, "%s-%s|", e.Name(), e.Get("user"))
		// trigger event2
		err, _ := mgr.Fire("app.event2", event.M{"user": "INHERE"})
		return err
	})

	handler2 := event.ListenerFunc(func(e event.Event) error {
		_, _ = fmt.Fprintf(buf, "%s-%s|", e.Name(), e.Get("user"))
		return nil
	})

	mgr.On("app.event1", handler1)
	mgr.On("app.event2", handler2)

	err, _ := mgr.Fire("app.event1", event.M{"user": "INHERE"})
	assert.NoError(t, err)
	assert.StrContains(t, "app.event1-INHERE|app.event2-INHERE|", buf.String())
}

// https://github.com/gookit/event/issues/61
// prepare: 此时设置 ConsumerNum = 10, 每个任务耗时1s, 触发100个任务
// expected: 10s左右执行完所有任务
// actual: 执行了 100s左右
func TestIssues_61(t *testing.T) {
	var em = event.NewManager("default", func(o *event.Options) {
		o.ConsumerNum = 10
		o.EnableLock = false
	})
	defer em.CloseWait()

	var listener event.ListenerFunc = func(e event.Event) error {
		time.Sleep(1 * time.Second)
		fmt.Println("event received!", e.Name(), "index", e.Get("arg0"))
		return nil
	}

	em.On("app.evt1", listener, event.Normal)

	for i := 0; i < 20; i++ {
		em.FireAsync(event.New("app.evt1", event.M{"arg0": i}))
	}

	fmt.Println("publish event finished!")
}

// https://github.com/gookit/event/issues/67 我这有 投递了一个异步事件, 经常发现 这个事件执行了几次 后面都没 执行了
func TestIssues_67(t *testing.T) {
	em := event.NewManager("test", event.WithConsumerNum(10), event.WithChannelSize(100))

	var counter int
	em.On("new.member", event.ListenerFunc(func(e event.Event) error {
		counter++
		fmt.Print(e.Get("memberId"), " ")
		return nil
	}))

	total := 200
	for i := 0; i < total; i++ {
		em.Async("new.member", event.M{"memberId": i + 1, "superiorId": "superior23"})
	}
	em.MustCloseWait() // MUST wait all async event done

	fmt.Println("Total:", counter)
	assert.Eq(t, total, counter)
}

type MyEventI68 struct {
	event.BasicEvent
	customData string
}

func (e *MyEventI68) CustomData() string {
	return e.customData
}

// https://github.com/gookit/event/issues/68 Custom events failed to execute
func TestIssues_68(t *testing.T) {
	e := &MyEventI68{customData: "hello"}
	e.SetName("e1")
	defer event.Reset()
	assert.NoErr(t, event.AddEvent(e))

	// add listener
	event.On("e1", event.ListenerFunc(func(e event.Event) error {
		fmt.Printf("custom Data: %s\n", e.(*MyEventI68).CustomData())
		return nil
	}))

	// trigger
	err, e2 := event.Fire("e1", nil)
	assert.NoErr(t, err)
	assert.Eq(t, "e1", e2.Name())
}

// https://github.com/gookit/event/issues/78
// It is expected to support event passing context, timeout control, and log trace passing such as trace ID information.
// 希望事件支持通过上下文，超时控制和日志跟踪传递，例如跟踪ID信息。
func TestIssues_78(t *testing.T) {
	// Test with context
	ctx := context.Background()

	// Create a context with value (simulating trace ID)
	ctx = context.WithValue(ctx, "trace_id", "trace-12345")

	// Create a context with timeout
	ctx, cancel := context.WithTimeout(ctx, 1*time.Second)
	defer cancel()

	manager := event.NewManager("test")

	var traceID string
	var ctxErr error

	// Register event listener
	manager.On("app.test", event.ListenerFunc(func(e event.Event) error {
		ec, ok := e.(event.ContextAble)
		if !ok {
			return nil
		}

		// Get trace ID from context
		traceID, _ = ec.Context().Value("trace_id").(string)

		// Check if context is canceled
		select {
		case <-ec.Context().Done():
			ctxErr = ec.Context().Err()
			return ctxErr
		default:
		}

		return nil
	}))

	// Test firing event with context
	err, _ := manager.FireCtx(ctx, "app.test", event.M{"key": "value"})
	assert.NoError(t, err)
	assert.Equal(t, "trace-12345", traceID)
	assert.Nil(t, ctxErr)

	// Test with std
	stdTraceID := ""
	event.On("std.test", event.ListenerFunc(func(e event.Event) error {
		ec, ok := e.(event.ContextAble)
		if !ok {
			return nil
		}
		stdTraceID, _ = ec.Context().Value("trace_id").(string)
		return nil
	}))

	err, _ = event.FireCtx(ctx, "std.test", event.M{"key": "value"})
	assert.NoError(t, err)
	assert.Equal(t, "trace-12345", stdTraceID)
}