Function TestHeartbeatClose

coderd/httpapi/websocket_internal_test.go:56–185

(t *testing.T)

}

func TestHeartbeatClose(t *testing.T) {
	t.Parallel()

	t.Run("ServerSideClose", func(t *testing.T) {
		t.Parallel()
		ctx := testutil.Context(t, testutil.WaitShort)

		sink := testutil.NewFakeSink(t)
		logger := sink.Logger()
		mClock := quartz.NewMock(t)

		// Trap ticker creation so we can synchronize startup.
		trap := mClock.Trap().NewTicker("HeartbeatClose")
		defer trap.Close()

		serverConn := websocketPair(ctx, t)
		exitCalled := make(chan struct{})

		go heartbeatCloseWith(ctx, logger, func() {
			close(exitCalled)
		}, serverConn, mClock, time.Second)

		// Wait for the ticker to be created, then release.
		trap.MustWait(ctx).MustRelease(ctx)

		// Close the server-side connection before the tick fires.
		// The next ping will get net.ErrClosed.
		_ = serverConn.Close(websocket.StatusGoingAway, "simulated teardown")

		// Advance clock to trigger the tick.
		mClock.Advance(time.Second).MustWait(ctx)

		// Wait for heartbeatClose to call exit.
		select {
		case <-exitCalled:
		case <-ctx.Done():
			t.Fatal("timed out waiting for heartbeatClose to call exit")
		}

		// A closed connection is a normal shutdown condition. The
		// error should be logged at Debug, not Error.
		errorEntries := sink.Entries(func(e slog.SinkEntry) bool { return e.Level == slog.LevelError })
		assert.Empty(t, errorEntries,
			"closed connection should not produce error-level logs, got: %+v", errorEntries)
		debugEntries := sink.Entries(func(e slog.SinkEntry) bool { return e.Level == slog.LevelDebug })
		assert.NotEmpty(t, debugEntries,
			"expected a debug-level log entry for the closed connection")
	})

	t.Run("ContextCanceled", func(t *testing.T) {
		t.Parallel()
		ctx := testutil.Context(t, testutil.WaitShort)

		sink := testutil.NewFakeSink(t)
		logger := sink.Logger()
		mClock := quartz.NewMock(t)

		trap := mClock.Trap().NewTicker("HeartbeatClose")