Skip to content

CubeLoop — a Pythonic, async-native agent harness core designed for high performance, readability, and production-grade persistence.

11.5 KB
Raw Blame
"""after_model_response hook + TurnAction tests (D8)."""

import pytest

from cubeloop import Agent
from cubeloop.agent.types import AgentContext
from cubeloop.middleware.base import Middleware, TurnAction, compose_middleware
from cubeloop.providers.base import (
    AssistantMessage,
    TextContent,
    Usage,
    UserMessage,
)
from cubeloop.providers.faux import FauxProvider, faux_assistant_message


def _mk_response(text: str = "hi") -> AssistantMessage:
    return AssistantMessage(content=[TextContent(text=text)], usage=Usage())


def _mk_ctx() -> AgentContext:
    return AgentContext(system_prompt="", messages=[])


class _MutateResponse(Middleware):
    async def after_model_response(self, response, ctx, *, signal=None):
        return TurnAction(response=_mk_response(text="mutated"))


class _InjectMessages(Middleware):
    async def after_model_response(self, response, ctx, *, signal=None):
        return TurnAction(
            inject_messages=[UserMessage(content=[TextContent(text="injected")])]
        )


class _Stop(Middleware):
    async def after_model_response(self, response, ctx, *, signal=None):
        return TurnAction(decision="stop")


class _Loop(Middleware):
    async def after_model_response(self, response, ctx, *, signal=None):
        return TurnAction(decision="loop_to_model")


class _NoOp(Middleware):
    async def after_model_response(self, response, ctx, *, signal=None):
        return None


def test_turn_action_defaults() -> None:
    ta = TurnAction()
    assert ta.response is None
    assert ta.inject_messages == []
    assert ta.decision == "natural"


@pytest.mark.asyncio
async def test_single_middleware_mutates_response() -> None:
    hooks = compose_middleware([_MutateResponse()])
    result = await hooks["after_model_response"](_mk_response("orig"), _mk_ctx())
    assert isinstance(result.response, AssistantMessage)
    assert result.response.content[0].text == "mutated"


@pytest.mark.asyncio
async def test_chain_last_response_wins() -> None:
    """Two mutators; last one in chain wins for response."""

    class _MutateAgain(Middleware):
        async def after_model_response(self, response, ctx, *, signal=None):
            return TurnAction(response=_mk_response(text="final"))

    hooks = compose_middleware([_MutateResponse(), _MutateAgain()])
    result = await hooks["after_model_response"](_mk_response("orig"), _mk_ctx())
    assert result.response.content[0].text == "final"


@pytest.mark.asyncio
async def test_inject_messages_concatenate() -> None:
    """inject_messages from multiple middleware concatenate."""

    class _InjectMore(Middleware):
        async def after_model_response(self, response, ctx, *, signal=None):
            return TurnAction(
                inject_messages=[UserMessage(content=[TextContent(text="more")])]
            )

    hooks = compose_middleware([_InjectMessages(), _InjectMore()])
    result = await hooks["after_model_response"](_mk_response(), _mk_ctx())
    assert len(result.inject_messages) == 2


@pytest.mark.asyncio
async def test_decision_last_wins() -> None:
    """Last middleware's decision wins."""
    hooks = compose_middleware([_Stop(), _Loop()])
    result = await hooks["after_model_response"](_mk_response(), _mk_ctx())
    assert result.decision == "loop_to_model"


@pytest.mark.asyncio
async def test_none_return_treated_as_natural() -> None:
    """Middleware returning None doesn't affect the composed TurnAction."""
    hooks = compose_middleware([_NoOp(), _Stop()])
    result = await hooks["after_model_response"](_mk_response(), _mk_ctx())
    assert result.decision == "stop"


@pytest.mark.asyncio
async def test_default_implementation_raises() -> None:
    mw = Middleware()
    with pytest.raises(NotImplementedError):
        await mw.after_model_response(_mk_response(), _mk_ctx())


def test_no_middleware_hook_absent() -> None:
    class Plain(Middleware):
        pass

    hooks = compose_middleware([Plain()])
    assert "after_model_response" not in hooks


@pytest.mark.asyncio
async def test_agent_stops_when_middleware_returns_stop() -> None:
    """decision='stop' terminates after the first model response."""
    provider = FauxProvider(provider_id="faux")
    # Two responses queued; second should never fire because we stop after first.
    provider.set_responses(
        [
            faux_assistant_message("first"),
            faux_assistant_message("should not fire"),
        ]
    )
    agent = Agent(
        model=provider.model("test"),
        middleware=[_Stop()],
    )
    await agent.prompt("hi")
    # Only the first response was consumed; one remains in the queue.
    assert provider.call_count == 1
    assert provider.pending_response_count == 1


@pytest.mark.asyncio
async def test_agent_loops_when_middleware_returns_loop_to_model() -> None:
    """decision='loop_to_model' re-invokes the model with inject_messages."""
    provider = FauxProvider(provider_id="faux")
    provider.set_responses(
        [
            faux_assistant_message("first"),
            faux_assistant_message("second"),
        ]
    )

    call_count = 0

    class _LoopOnce(Middleware):
        async def after_model_response(self, response, ctx, *, signal=None):
            nonlocal call_count
            call_count += 1
            if call_count == 1:
                return TurnAction(
                    decision="loop_to_model",
                    inject_messages=[UserMessage(content=[TextContent(text="retry")])],
                )
            return None

    agent = Agent(
        model=provider.model("test"),
        middleware=[_LoopOnce()],
    )
    await agent.prompt("hi")
    # Both responses consumed: provider called twice.
    assert provider.call_count == 2
    # Hook ran twice: once forced loop, once natural.
    assert call_count == 2


@pytest.mark.asyncio
async def test_agent_direct_hook_returning_none_emits_message_end() -> None:
    """When after_model_response is passed directly (bypassing compose) and
    returns None, the loop still emits message_end via the dedicated branch."""
    provider = FauxProvider(provider_id="faux")
    provider.set_responses([faux_assistant_message("ok")])

    hook_calls: list[AssistantMessage] = []

    async def _hook(response, ctx, *, signal=None):
        hook_calls.append(response)
        return None

    agent = Agent(
        model=provider.model("test"),
        after_model_response=_hook,
    )

    events: list[str] = []

    def _listener(event, signal):
        events.append(event.type)

    agent.subscribe(_listener)
    await agent.prompt("hi")

    assert len(hook_calls) == 1
    assert events.count("message_end") >= 1
    assert "agent_end" in events


@pytest.mark.asyncio
async def test_agent_no_middleware_natural_flow() -> None:
    """Without after_model_response middleware, natural flow proceeds."""
    provider = FauxProvider(provider_id="faux")
    provider.set_responses([faux_assistant_message("ok")])
    agent = Agent(
        model=provider.model("test"),
    )

    events: list[str] = []

    def _listener(event, signal):
        events.append(event.type)

    agent.subscribe(_listener)
    await agent.prompt("hi")
    # Natural flow: agent_end fires and no second provider call.
    assert "agent_end" in events
    assert provider.call_count == 1


# --- Bug A, B, C regression tests ---


@pytest.mark.asyncio
async def test_ctx_extra_flows_into_loop_context(tmp_path) -> None:
    """Middleware reading ctx.extra inside the loop sees the hydrated value
    AND mutations persist to checkpointer after the turn (Bug A)."""
    from cubeloop.checkpointer import MemoryCheckpointer

    seen_extra: list[dict] = []

    class _Observe(Middleware):
        async def after_model_response(self, response, ctx, *, signal=None):
            # Snapshot what the loop's ctx.extra looks like
            seen_extra.append(dict(ctx.extra))
            # Mutate
            ctx.extra["mutated_by_hook"] = True
            return None

    cp = MemoryCheckpointer()
    # Seed extra BEFORE prompt by saving directly
    await cp.save_extra("t", {"seeded": "value"})

    provider = FauxProvider(provider_id="faux")
    provider.set_responses([faux_assistant_message("ok")])
    agent = Agent(
        model=provider.model("test"),
        checkpointer=cp,
        thread_id="t",
        middleware=[_Observe()],
    )
    await agent.prompt("hi")

    # 1. Hook saw the seeded value (Bug A: flow into loop ctx)
    assert seen_extra == [{"seeded": "value"}]

    # 2. Mutation persisted (Bug A: flow back to self._extra and save_extra)
    data = await cp.load("t")
    assert data is not None
    assert data.extra == {"seeded": "value", "mutated_by_hook": True}


@pytest.mark.asyncio
async def test_turn_action_response_persists_in_agent_state(tmp_path) -> None:
    """When after_model_response mutates the response, agent state and
    checkpointer reflect the mutation (Bug B)."""
    from cubeloop.checkpointer import MemoryCheckpointer

    def _mk(text: str) -> AssistantMessage:
        return AssistantMessage(content=[TextContent(text=text)], usage=Usage())

    class _Mutate(Middleware):
        async def after_model_response(self, response, ctx, *, signal=None):
            return TurnAction(response=_mk("MUTATED"))

    cp = MemoryCheckpointer()
    provider = FauxProvider(provider_id="faux")
    provider.set_responses([faux_assistant_message("ORIGINAL")])
    agent = Agent(
        model=provider.model("test"),
        checkpointer=cp,
        thread_id="t",
        middleware=[_Mutate()],
    )
    await agent.prompt("hi")

    # Agent.state.messages: last message should be MUTATED, not ORIGINAL
    last = agent.state.messages[-1]
    assert isinstance(last, AssistantMessage)
    assert last.content[0].text == "MUTATED"

    # Checkpointer: loading again must give MUTATED
    data = await cp.load("t")
    assert data is not None
    last_assistant = next(
        (m for m in reversed(data.messages) if isinstance(m, AssistantMessage)),
        None,
    )
    assert last_assistant is not None
    assert last_assistant.content[0].text == "MUTATED"


@pytest.mark.asyncio
async def test_turn_action_inject_messages_persist(tmp_path) -> None:
    """Messages injected via TurnAction.inject_messages persist to agent
    state and checkpointer (Bug C)."""
    from cubeloop.checkpointer import MemoryCheckpointer
    from cubeloop.providers.base import UserMessage

    injected_once = False

    class _InjectOnce(Middleware):
        async def after_model_response(self, response, ctx, *, signal=None):
            nonlocal injected_once
            if injected_once:
                return None
            injected_once = True
            return TurnAction(
                decision="loop_to_model",
                inject_messages=[
                    UserMessage(content=[TextContent(text="retry-please")])
                ],
            )

    cp = MemoryCheckpointer()
    provider = FauxProvider(provider_id="faux")
    provider.set_responses(
        [
            faux_assistant_message("first"),
            faux_assistant_message("second"),
        ]
    )
    agent = Agent(
        model=provider.model("test"),
        checkpointer=cp,
        thread_id="t",
        middleware=[_InjectOnce()],
    )
    await agent.prompt("hi")

    # Reload from checkpointer — injected message must be in history
    data = await cp.load("t")
    assert data is not None
    texts = [
        m.content[0].text
        for m in data.messages
        if hasattr(m, "content") and m.content and hasattr(m.content[0], "text")
    ]
    assert "retry-please" in texts, f"Injected message missing from history: {texts!r}"