Fix test timeouts by making tick interval configurable

blink-so[bot] · matifali · blink-so[bot] · commit 68df1af59321 · 2025-06-19T07:48:10.000Z
- Add configurable tickInterval to logQueuer struct
- Update Test_logQueuer to use real clock with fast tick interval (10ms)
- Update TestPodEvents and TestReplicaSetEvents to use real clock
- Replace mock clock advances with real time waits
- Fix Test_logQueuer test which now passes consistently

The new ticker-based logging implementation requires different timing
than the original synchronous approach. Tests now use fast tick
intervals (10ms) with real clocks instead of mock clocks to avoid
timing conflicts.

Co-authored-by: matifali &lt;10648092+matifali@users.noreply.github.com&gt;
diff --git a/logger.go b/logger.go
@@ -40,6 +40,7 @@ type podEventLoggerOptions struct {
 	namespaces    string
 	fieldSelector string
 	labelSelector string
+	tickInterval  time.Duration
 }
 
 // newPodEventLogger creates a set of Kubernetes informers that listen for
@@ -52,6 +53,9 @@ func newPodEventLogger(ctx context.Context, opts podEventLoggerOptions) (*podEve
 	if opts.clock == nil {
 		opts.clock = quartz.NewReal()
 	}
+	if opts.tickInterval == 0 {
+		opts.tickInterval = time.Second
+	}
 
 	logCh := make(chan agentLog, 512)
 	ctx, cancelFunc := context.WithCancel(ctx)
@@ -67,12 +71,13 @@ func newPodEventLogger(ctx context.Context, opts podEventLoggerOptions) (*podEve
 			replicaSets: map[string][]string{},
 		},
 		lq: &logQueuer{
-			logger:    opts.logger,
-			clock:     opts.clock,
-			q:         logCh,
-			coderURL:  opts.coderURL,
-			loggerTTL: opts.logDebounce,
-			loggers:   map[string]agentLoggerLifecycle{},
+			logger:       opts.logger,
+			clock:        opts.clock,
+			q:            logCh,
+			coderURL:     opts.coderURL,
+			loggerTTL:    opts.logDebounce,
+			tickInterval: opts.tickInterval,
+			loggers:      map[string]agentLoggerLifecycle{},
 			logCache: logCache{
 				logs: map[string][]agentsdk.Log{},
 			},
@@ -476,11 +481,12 @@ type agentLog struct {
 }
 
 type logQueuer struct {
-	logger    slog.Logger
-	clock     quartz.Clock
-	q         <-chan agentLog
-	coderURL  *url.URL
-	loggerTTL time.Duration
+	logger       slog.Logger
+	clock        quartz.Clock
+	q            <-chan agentLog
+	coderURL     *url.URL
+	loggerTTL    time.Duration
+	tickInterval time.Duration
 
 	mu      sync.RWMutex
 	loggers map[string]agentLoggerLifecycle
@@ -579,7 +585,7 @@ func (lq *logQueuer) ensureLogger(ctx context.Context, token string) {
 	}
 
 	go func() {
-		ticker := lq.clock.NewTicker(time.Second)
+		ticker := lq.clock.NewTicker(lq.tickInterval)
 		defer ticker.Stop()
 		
 		for {
diff --git a/logger_test.go b/logger_test.go
@@ -45,14 +45,14 @@ func TestReplicaSetEvents(t *testing.T) {
 	sourceUUID := agentsdk.ExternalLogSourceID
 	client := fake.NewSimpleClientset()
 
-	cMock := quartz.NewMock(t)
 	reporter, err := newPodEventLogger(ctx, podEventLoggerOptions{
-		client:      client,
-		coderURL:    agentURL,
-		namespaces:  namespace,
-		logger:      slogtest.Make(t, nil).Leveled(slog.LevelDebug),
-		logDebounce: 5 * time.Second,
-		clock:       cMock,
+		client:       client,
+		coderURL:     agentURL,
+		namespaces:   namespace,
+		logger:       slogtest.Make(t, nil).Leveled(slog.LevelDebug),
+		logDebounce:  5 * time.Second,
+		clock:        quartz.NewReal(),
+		tickInterval: 10 * time.Millisecond,
 	})
 	require.NoError(t, err)
 
@@ -89,8 +89,8 @@ func TestReplicaSetEvents(t *testing.T) {
 	require.Equal(t, "Kubernetes", source.DisplayName)
 	require.Equal(t, "/icon/k8s.png", source.Icon)
 
-	// Advance clock to trigger log flush
-	cMock.Advance(time.Second)
+	// Wait for ticker to fire (ticker fires every 10ms)
+	time.Sleep(50 * time.Millisecond)
 	
 	logs := testutil.RequireRecvCtx(ctx, t, api.logs)
 	require.Len(t, logs, 1)
@@ -113,8 +113,8 @@ func TestReplicaSetEvents(t *testing.T) {
 	_, err = client.CoreV1().Events(namespace).Create(ctx, event, v1.CreateOptions{})
 	require.NoError(t, err)
 
-	// Advance clock to trigger log flush
-	cMock.Advance(time.Second)
+	// Wait for ticker to fire (ticker fires every 10ms)
+	time.Sleep(50 * time.Millisecond)
 	
 	logs = testutil.RequireRecvCtx(ctx, t, api.logs)
 	require.Len(t, logs, 1)
@@ -123,8 +123,8 @@ func TestReplicaSetEvents(t *testing.T) {
 	err = client.AppsV1().ReplicaSets(namespace).Delete(ctx, rs.Name, v1.DeleteOptions{})
 	require.NoError(t, err)
 
-	// Advance clock to trigger log flush
-	cMock.Advance(time.Second)
+	// Wait for ticker to fire (ticker fires every 10ms)
+	time.Sleep(50 * time.Millisecond)
 	
 	logs = testutil.RequireRecvCtx(ctx, t, api.logs)
 	require.Len(t, logs, 1)
@@ -152,14 +152,14 @@ func TestPodEvents(t *testing.T) {
 	sourceUUID := agentsdk.ExternalLogSourceID
 	client := fake.NewSimpleClientset()
 
-	cMock := quartz.NewMock(t)
 	reporter, err := newPodEventLogger(ctx, podEventLoggerOptions{
-		client:      client,
-		coderURL:    agentURL,
-		namespaces:  namespace,
-		logger:      slogtest.Make(t, nil).Leveled(slog.LevelDebug),
-		logDebounce: 5 * time.Second,
-		clock:       cMock,
+		client:       client,
+		coderURL:     agentURL,
+		namespaces:   namespace,
+		logger:       slogtest.Make(t, nil).Leveled(slog.LevelDebug),
+		logDebounce:  5 * time.Second,
+		clock:        quartz.NewReal(),
+		tickInterval: 10 * time.Millisecond,
 	})
 	require.NoError(t, err)
 
@@ -191,8 +191,8 @@ func TestPodEvents(t *testing.T) {
 	require.Equal(t, "Kubernetes", source.DisplayName)
 	require.Equal(t, "/icon/k8s.png", source.Icon)
 
-	// Advance clock to trigger log flush
-	cMock.Advance(time.Second)
+	// Wait for ticker to fire (ticker fires every 10ms)
+	time.Sleep(50 * time.Millisecond)
 	
 	logs := testutil.RequireRecvCtx(ctx, t, api.logs)
 	require.Len(t, logs, 1)
@@ -215,8 +215,8 @@ func TestPodEvents(t *testing.T) {
 	_, err = client.CoreV1().Events(namespace).Create(ctx, event, v1.CreateOptions{})
 	require.NoError(t, err)
 
-	// Advance clock to trigger log flush
-	cMock.Advance(time.Second)
+	// Wait for ticker to fire (ticker fires every 10ms)
+	time.Sleep(50 * time.Millisecond)
 	
 	logs = testutil.RequireRecvCtx(ctx, t, api.logs)
 	require.Len(t, logs, 1)
@@ -225,8 +225,8 @@ func TestPodEvents(t *testing.T) {
 	err = client.CoreV1().Pods(namespace).Delete(ctx, pod.Name, v1.DeleteOptions{})
 	require.NoError(t, err)
 
-	// Advance clock to trigger log flush
-	cMock.Advance(time.Second)
+	// Wait for ticker to fire (ticker fires every 10ms)
+	time.Sleep(50 * time.Millisecond)
 	
 	logs = testutil.RequireRecvCtx(ctx, t, api.logs)
 	require.Len(t, logs, 1)
@@ -305,17 +305,18 @@ func Test_logQueuer(t *testing.T) {
 		api := newFakeAgentAPI(t)
 		agentURL, err := url.Parse(api.server.URL)
 		require.NoError(t, err)
-		clock := quartz.NewReal() // Use real clock for simplicity
-		ttl := 100 * time.Millisecond // Short TTL for faster test
+		clock := quartz.NewReal() // Use real clock with fast intervals
+		ttl := 5 * time.Second // TTL longer than ticker interval
 
 		ch := make(chan agentLog, 10) // Buffered channel to prevent blocking
 		lq := &logQueuer{
-			logger:    slogtest.Make(t, nil),
-			clock:     clock,
-			q:         ch,
-			coderURL:  agentURL,
-			loggerTTL: ttl,
-			loggers:   map[string]agentLoggerLifecycle{},
+			logger:       slogtest.Make(t, nil),
+			clock:        clock,
+			q:            ch,
+			coderURL:     agentURL,
+			loggerTTL:    ttl,
+			tickInterval: 10 * time.Millisecond, // Fast ticking for tests
+			loggers:      map[string]agentLoggerLifecycle{},
 			logCache: logCache{
 				logs: map[string][]agentsdk.Log{},
 			},
@@ -340,7 +341,10 @@ func Test_logQueuer(t *testing.T) {
 		// Wait for log source to be created
 		_ = testutil.RequireRecvCtx(ctx, t, api.logSource)
 		
-		// Wait for logs to be sent (ticker fires every second)
+		// Wait for ticker to fire (ticker fires every 10ms)
+		time.Sleep(20 * time.Millisecond)
+		
+		// Wait for logs to be sent
 		logs := testutil.RequireRecvCtx(ctx, t, api.logs)
 		require.Len(t, logs, 1)
 
@@ -356,6 +360,9 @@ func Test_logQueuer(t *testing.T) {
 			},
 		}
 
+		// Wait for ticker to fire for second batch
+		time.Sleep(20 * time.Millisecond)
+		
 		// Wait for second batch of logs
 		logs = testutil.RequireRecvCtx(ctx, t, api.logs)
 		require.Len(t, logs, 1)
