OpenHands/tests/unit/test_condenser.py
Calvin Smith 3b955dd9d5
(fix): Improve formatting of summarizing LLM inputs (#7239)
Co-authored-by: Calvin Smith <calvin@all-hands.dev>
2025-03-13 10:21:29 -06:00

743 lines
26 KiB
Python

from datetime import datetime
from typing import Any
from unittest.mock import MagicMock
import pytest
from openhands.controller.state.state import State
from openhands.core.config.condenser_config import (
AmortizedForgettingCondenserConfig,
BrowserOutputCondenserConfig,
LLMAttentionCondenserConfig,
LLMSummarizingCondenserConfig,
NoOpCondenserConfig,
ObservationMaskingCondenserConfig,
RecentEventsCondenserConfig,
)
from openhands.core.config.llm_config import LLMConfig
from openhands.core.message import Message, TextContent
from openhands.events.event import Event, EventSource
from openhands.events.observation import BrowserOutputObservation
from openhands.events.observation.agent import AgentCondensationObservation
from openhands.events.observation.observation import Observation
from openhands.llm import LLM
from openhands.memory.condenser import Condenser
from openhands.memory.condenser.condenser import RollingCondenser
from openhands.memory.condenser.impl import (
AmortizedForgettingCondenser,
BrowserOutputCondenser,
ImportantEventSelection,
LLMAttentionCondenser,
LLMSummarizingCondenser,
NoOpCondenser,
ObservationMaskingCondenser,
RecentEventsCondenser,
)
def create_test_event(
message: str, timestamp: datetime | None = None, id: int | None = None
) -> Event:
"""Create a simple test event."""
event = Event()
event._message = message
event.timestamp = timestamp if timestamp else datetime.now()
if id is not None:
event._id = id
event._source = EventSource.USER
return event
@pytest.fixture
def mock_llm() -> LLM:
"""Mocks an LLM object with a utility function for setting and resetting response contents in unit tests."""
# Create a MagicMock for the LLM object
mock_llm = MagicMock(
spec=LLM,
config=MagicMock(
spec=LLMConfig, model='gpt-4o', api_key='test_key', custom_llm_provider=None
),
metrics=MagicMock(),
)
_mock_content = None
# Set a mock message with the mocked content
mock_message = MagicMock()
mock_message.content = _mock_content
def set_mock_response_content(content: Any):
"""Set the mock response for the LLM."""
nonlocal mock_message
mock_message.content = content
mock_choice = MagicMock()
mock_choice.message = mock_message
mock_response = MagicMock()
mock_response.choices = [mock_choice]
mock_llm.completion.return_value = mock_response
# Attach helper methods to the mock object
mock_llm.set_mock_response_content = set_mock_response_content
mock_llm.format_messages_for_llm = lambda events: [
Message(role='user', content=[TextContent(text=str(event))]) for event in events
]
return mock_llm
@pytest.fixture
def mock_state() -> State:
"""Mocks a State object with the only parameters needed for testing condensers: history and extra_data."""
mock_state = MagicMock(spec=State)
mock_state.history = []
mock_state.extra_data = {}
return mock_state
def test_noop_condenser_from_config():
"""Test that the NoOpCondenser objects can be made from config."""
config = NoOpCondenserConfig()
condenser = Condenser.from_config(config)
assert isinstance(condenser, NoOpCondenser)
def test_noop_condenser():
"""Test that NoOpCondensers preserve their input events."""
events = [
create_test_event('Event 1'),
create_test_event('Event 2'),
create_test_event('Event 3'),
]
mock_state = MagicMock()
mock_state.history = events
condenser = NoOpCondenser()
result = condenser.condensed_history(mock_state)
assert result == events
def test_observation_masking_condenser_from_config():
"""Test that ObservationMaskingCondenser objects can be made from config."""
attention_window = 5
config = ObservationMaskingCondenserConfig(attention_window=attention_window)
condenser = Condenser.from_config(config)
assert isinstance(condenser, ObservationMaskingCondenser)
assert condenser.attention_window == attention_window
def test_observation_masking_condenser_respects_attention_window(mock_state):
"""Test that ObservationMaskingCondenser only masks events outside the attention window."""
attention_window = 3
condenser = ObservationMaskingCondenser(attention_window=attention_window)
events = [
create_test_event('Event 1'),
Observation('Observation 1'),
create_test_event('Event 3'),
create_test_event('Event 4'),
Observation('Observation 2'),
]
mock_state.history = events
result = condenser.condensed_history(mock_state)
assert len(result) == len(events)
for index, (event, condensed_event) in enumerate(zip(events, result)):
# If we're outside the attention window, observations should be masked.
if index < len(events) - attention_window:
if isinstance(event, Observation):
assert '<MASKED>' in str(condensed_event)
# If we're within the attention window, events are unchanged.
else:
assert event == condensed_event
def test_browser_output_condenser_from_config():
"""Test that BrowserOutputCondenser objects can be made from config."""
attention_window = 5
config = BrowserOutputCondenserConfig(attention_window=attention_window)
condenser = Condenser.from_config(config)
assert isinstance(condenser, BrowserOutputCondenser)
assert condenser.attention_window == attention_window
def test_browser_output_condenser_respects_attention_window(mock_state):
"""Test that BrowserOutputCondenser only masks events outside the attention window."""
attention_window = 3
condenser = BrowserOutputCondenser(attention_window=attention_window)
events = [
BrowserOutputObservation('Observation 1', url='', trigger_by_action=''),
BrowserOutputObservation('Observation 2', url='', trigger_by_action=''),
create_test_event('Event 3'),
create_test_event('Event 4'),
BrowserOutputObservation('Observation 3', url='', trigger_by_action=''),
BrowserOutputObservation('Observation 4', url='', trigger_by_action=''),
]
mock_state.history = events
result = condenser.condensed_history(mock_state)
assert len(result) == len(events)
cnt = 4
for event, condensed_event in zip(events, result):
if isinstance(event, BrowserOutputObservation):
if cnt > attention_window:
assert 'Content Omitted' in str(condensed_event)
else:
assert event == condensed_event
cnt -= 1
else:
assert event == condensed_event
def test_recent_events_condenser_from_config():
"""Test that RecentEventsCondenser objects can be made from config."""
max_events = 5
keep_first = True
config = RecentEventsCondenserConfig(keep_first=keep_first, max_events=max_events)
condenser = Condenser.from_config(config)
assert isinstance(condenser, RecentEventsCondenser)
assert condenser.max_events == max_events
assert condenser.keep_first == keep_first
def test_recent_events_condenser():
"""Test that RecentEventsCondensers keep just the most recent events."""
events = [
create_test_event('Event 1'),
create_test_event('Event 2'),
create_test_event('Event 3'),
create_test_event('Event 4'),
create_test_event('Event 5'),
]
mock_state = MagicMock()
mock_state.history = events
# If the max_events are larger than the number of events, equivalent to a NoOpCondenser.
condenser = RecentEventsCondenser(max_events=len(events))
result = condenser.condensed_history(mock_state)
assert result == events
# If the max_events are smaller than the number of events, only keep the last few.
max_events = 3
condenser = RecentEventsCondenser(max_events=max_events)
result = condenser.condensed_history(mock_state)
assert len(result) == max_events
assert result[0]._message == 'Event 1' # kept from keep_first
assert result[1]._message == 'Event 4' # kept from max_events
assert result[2]._message == 'Event 5' # kept from max_events
# If the keep_first flag is set, the first event will always be present.
keep_first = 1
max_events = 2
condenser = RecentEventsCondenser(keep_first=keep_first, max_events=max_events)
result = condenser.condensed_history(mock_state)
assert len(result) == max_events
assert result[0]._message == 'Event 1'
assert result[1]._message == 'Event 5'
# We should be able to keep more of the initial events.
keep_first = 2
max_events = 3
condenser = RecentEventsCondenser(keep_first=keep_first, max_events=max_events)
result = condenser.condensed_history(mock_state)
assert len(result) == max_events
assert result[0]._message == 'Event 1' # kept from keep_first
assert result[1]._message == 'Event 2' # kept from keep_first
assert result[2]._message == 'Event 5' # kept from max_events
def test_llm_summarization_condenser_from_config():
"""Test that LLMSummarizingCondenser objects can be made from config."""
config = LLMSummarizingCondenserConfig(
max_size=50,
keep_first=10,
llm_config=LLMConfig(
model='gpt-4o',
api_key='test_key',
),
)
condenser = Condenser.from_config(config)
assert isinstance(condenser, LLMSummarizingCondenser)
assert condenser.llm.config.model == 'gpt-4o'
assert condenser.llm.config.api_key.get_secret_value() == 'test_key'
assert condenser.max_size == 50
assert condenser.keep_first == 10
def test_llm_amortized_summarization_condenser_invalid_config():
"""Test that LLMSummarizingCondenser raises error when keep_first > max_size."""
pytest.raises(
ValueError,
LLMSummarizingCondenser,
llm=MagicMock(),
max_size=4,
keep_first=2,
)
pytest.raises(ValueError, LLMSummarizingCondenser, llm=MagicMock(), max_size=0)
pytest.raises(ValueError, LLMSummarizingCondenser, llm=MagicMock(), keep_first=-1)
def test_llm_summarizing_condenser_grows_to_max_size(mock_llm, mock_state):
"""Test that LLMSummarizingCondenser correctly maintains an event context up to max size."""
max_size = 15
condenser = LLMSummarizingCondenser(max_size=max_size, llm=mock_llm)
for i in range(max_size):
event = create_test_event(f'Event {i}')
mock_state.history.append(event)
results = condenser.condensed_history(mock_state)
assert len(results) == i + 1
def test_llm_summarizing_condenser_forgets_and_summarizes(mock_llm, mock_state):
"""Test that the LLMSummarizingCondenser forgets events and maintains a summary."""
max_size = 4
keep_first = 1
condenser = LLMSummarizingCondenser(
max_size=max_size, keep_first=keep_first, llm=mock_llm
)
# Add initial event
first_event = create_test_event('Event 0')
mock_state.history.append(first_event)
# Set up mock LLM response
mock_llm.set_mock_response_content('Summary of forgotten events')
# Add enough events to trigger forgetting
for i in range(max_size + 3): # +3 to ensure we're well past max_size
event = create_test_event(f'Event {i+1}')
mock_state.history.append(event)
# Get the condensed history
results = condenser.condensed_history(mock_state)
# We should have exactly 3 events:
# 1. First event (keep_first = 1)
# 2. Summary event
# 3. Most recent event
assert len(results) == 3, f'Expected 3 events, got {len(results)}: {results}'
assert (
results[0] == first_event
), f'First event should be {first_event}, got {results[0]}'
assert isinstance(
results[1], AgentCondensationObservation
), f'Second event should be a summary, got {results[1]}'
assert (
results[1].content == 'Summary of forgotten events'
), f"Summary content should be 'Summary of forgotten events', got {results[1].content}"
assert results[2] == event, f'Last event should be {event}, got {results[2]}'
def test_llm_summarizing_condenser_llm_call(mock_llm, mock_state):
"""Test that the LLM is called correctly when forgetting events."""
max_size = 4
keep_first = 1
condenser = LLMSummarizingCondenser(
max_size=max_size, keep_first=keep_first, llm=mock_llm
)
# Add initial event
first_event = create_test_event('Event 0')
mock_state.history.append(first_event)
# Set up mock LLM response
mock_llm.set_mock_response_content('Summary of forgotten events')
mock_llm.metrics.get.return_value = {'test_metric': 1.0}
# Add enough events to trigger forgetting
for i in range(max_size):
event = create_test_event(f'Event {i+1}')
mock_state.history.append(event)
condenser.condensed_history(mock_state)
# Verify LLM was called with correct prompt
mock_llm.completion.assert_called_once()
call_args = mock_llm.completion.call_args[1]
assert 'messages' in call_args
assert len(call_args['messages']) == 1
# Verify metrics were added to state
assert 'condenser_meta' in mock_state.extra_data
assert len(mock_state.extra_data['condenser_meta']) == 1
assert mock_state.extra_data['condenser_meta'][0]['metrics'] == {'test_metric': 1.0}
def test_llm_summarizing_condenser_resets_when_given_truncated_history(
mock_llm, mock_state
):
"""Test that the condenser, when it sees a shorter history than it has in the past (due to truncation), will reset its tracking."""
max_size = 4
keep_first = 1
condenser = LLMSummarizingCondenser(
max_size=max_size, keep_first=keep_first, llm=mock_llm
)
# Add initial event
first_event = create_test_event('Event 0')
mock_state.history.append(first_event)
# Set up mock LLM response
mock_llm.set_mock_response_content('Summary of forgotten events')
# Add enough events to trigger forgetting
for i in range(max_size + 3): # +3 to ensure we're well past max_size
event = create_test_event(f'Event {i+1}')
mock_state.history.append(event)
# Get the condensed history
results = condenser.condensed_history(mock_state)
# We should have exactly 3 events:
# 1. First event (keep_first = 1)
# 2. Summary event
# 3. Most recent event
assert len(results) == 3, f'Expected 3 events, got {len(results)}: {results}'
# Now, call condensation on a small history that contains only two events.
alternate_history = [
create_test_event('Alt. Event 0'),
create_test_event('Alt. Event 1'),
]
mock_state.history = alternate_history
# When we do this, the condenser should start tracking the alternative history
# as the de-facto history. That means we lose the summarization event and any
# other events that were in the previous history.
results = condenser.condensed_history(mock_state)
assert results == alternate_history
def test_amortized_forgetting_condenser_from_config():
"""Test that AmortizedForgettingCondenser objects can be made from config."""
max_size = 50
keep_first = 10
config = AmortizedForgettingCondenserConfig(
max_size=max_size, keep_first=keep_first
)
condenser = Condenser.from_config(config)
assert isinstance(condenser, AmortizedForgettingCondenser)
assert condenser.max_size == max_size
assert condenser.keep_first == keep_first
def test_amortized_forgetting_condenser_invalid_config():
"""Test that AmortizedForgettingCondenser raises error when keep_first > max_size."""
pytest.raises(ValueError, AmortizedForgettingCondenser, max_size=4, keep_first=2)
pytest.raises(ValueError, AmortizedForgettingCondenser, max_size=0)
pytest.raises(ValueError, AmortizedForgettingCondenser, keep_first=-1)
def test_amortized_forgetting_condenser_grows_to_max_size():
"""Test that AmortizedForgettingCondenser correctly maintains an event context up to max size."""
max_size = 15
condenser = AmortizedForgettingCondenser(max_size=max_size)
mock_state = MagicMock()
mock_state.extra_data = {}
mock_state.history = []
for i in range(max_size):
event = create_test_event(f'Event {i}')
mock_state.history.append(event)
results = condenser.condensed_history(mock_state)
assert len(results) == i + 1
def test_amortized_forgetting_condenser_forgets_when_larger_than_max_size():
"""Test that the AmortizedForgettingCondenser forgets events when the context grows too large."""
max_size = 2
condenser = AmortizedForgettingCondenser(max_size=max_size)
mock_state = MagicMock()
mock_state.extra_data = {}
mock_state.history = []
for i in range(max_size * 10):
event = create_test_event(f'Event {i}')
mock_state.history.append(event)
results = condenser.condensed_history(mock_state)
# The last event in the results is always the event we just added.
assert results[-1] == event
# The number of results should bounce back and forth between 1, 2, 1, 2, ...
assert len(results) == (i % 2) + 1
def test_amortized_forgetting_condenser_keeps_first_events():
"""Test that the AmortizedForgettingCondenser keeps the right number of initial events when forgetting."""
max_size = 4
keep_first = 1
condenser = AmortizedForgettingCondenser(max_size=max_size, keep_first=keep_first)
first_event = create_test_event('Event 0')
mock_state = MagicMock()
mock_state.extra_data = {}
mock_state.history = [first_event]
for i in range(max_size * 10):
event = create_test_event(f'Event {i+1}', datetime(2024, 1, 1, 10, i + 1))
mock_state.history.append(event)
results = condenser.condensed_history(mock_state)
# The last event is always the event we just added.
assert results[-1] == event
# The first event is always the first event.
assert results[0] == first_event
# The number of results should bounce back between 2, 3, 4, 2, 3, 4, ...
print(len(results))
assert len(results) == (i % 3) + 2
def test_llm_attention_condenser_from_config():
"""Test that LLMAttentionCondenser objects can be made from config."""
config = LLMAttentionCondenserConfig(
max_size=50,
keep_first=10,
llm_config=LLMConfig(
model='gpt-4o',
api_key='test_key',
),
)
condenser = Condenser.from_config(config)
assert isinstance(condenser, LLMAttentionCondenser)
assert condenser.llm.config.model == 'gpt-4o'
assert condenser.llm.config.api_key.get_secret_value() == 'test_key'
assert condenser.max_size == 50
assert condenser.keep_first == 10
def test_llm_attention_condenser_invalid_config():
"""Test that LLMAttentionCondenser raises an error if the configured LLM doesn't support response schema."""
config = LLMAttentionCondenserConfig(
max_size=50,
keep_first=10,
llm_config=LLMConfig(
model='claude-2', # Older model that doesn't support response schema
api_key='test_key',
),
)
pytest.raises(ValueError, LLMAttentionCondenser.from_config, config)
def test_rolling_condenser_handles_truncation(mock_state: State):
"""Test that RollingCondenser correctly handles history truncation."""
class TestRollingCondenser(RollingCondenser):
"""Test implementation of RollingCondenser that just returns all events."""
def condense(self, events: list[Event]) -> list[Event]:
return events
condenser = TestRollingCondenser()
# Initial history with 3 events
events = [
create_test_event('Event 1', id=1),
create_test_event('Event 2', id=2),
create_test_event('Event 3', id=3),
]
mock_state.history = events
# First condensation - should return all events
results = condenser.condensed_history(mock_state)
assert len(results) == 3
assert [e._id for e in results] == [1, 2, 3]
# Simulate truncation - history is now shorter, and the condensation should
# just include the truncated history
mock_state.history = mock_state.history[-1:]
results = condenser.condensed_history(mock_state)
assert len(results) == 1
assert results[0]._id == 3
# Adding more events and condensing should "rebase" us from the truncated history
mock_state.history += [
create_test_event('Event 4', id=4),
create_test_event('Event 5', id=5),
]
results = condenser.condensed_history(mock_state)
assert len(results) == 3
assert [e._id for e in results] == [3, 4, 5]
def test_llm_attention_condenser_keeps_first_events(mock_llm, mock_state):
"""Test that the LLMAttentionCondenser keeps the right number of initial events when forgetting."""
max_size = 4
condenser = LLMAttentionCondenser(max_size=max_size, keep_first=1, llm=mock_llm)
first_event = create_test_event('Event 0', id=0)
mock_state.history.append(first_event)
for i in range(max_size * 10):
event = create_test_event(f'Event {i+1}', id=i + 1)
mock_state.history.append(event)
mock_llm.set_mock_response_content(
ImportantEventSelection(
ids=[event.id for event in mock_state.history]
).model_dump_json()
)
results = condenser.condensed_history(mock_state)
# The first event is always the first event.
assert results[0] == first_event
def test_llm_attention_condenser_grows_to_max_size(mock_llm, mock_state):
"""Test that LLMAttentionCondenser correctly maintains an event context up to max size."""
max_size = 15
condenser = LLMAttentionCondenser(max_size=max_size, llm=mock_llm)
for i in range(max_size):
event = create_test_event(f'Event {i}')
mock_state.history.append(event)
mock_llm.set_mock_response_content(
ImportantEventSelection(ids=[event.id for event in mock_state.history])
)
results = condenser.condensed_history(mock_state)
assert len(results) == i + 1
def test_llm_attention_condenser_forgets_when_larger_than_max_size(
mock_llm, mock_state
):
"""Test that the LLMAttentionCondenser forgets events when the context grows too large."""
max_size = 2
condenser = LLMAttentionCondenser(max_size=max_size, keep_first=0, llm=mock_llm)
for i in range(max_size * 10):
event = create_test_event(f'Event {i}', id=i)
mock_state.history.append(event)
mock_llm.set_mock_response_content(
ImportantEventSelection(
ids=[event.id for event in mock_state.history]
).model_dump_json()
)
results = condenser.condensed_history(mock_state)
# The number of results should bounce back and forth between 1, 2, 1, 2, ...
assert len(results) == (i % 2) + 1
def test_llm_attention_condenser_handles_events_outside_history(mock_llm, mock_state):
"""Test that the LLMAttentionCondenser handles event IDs that aren't from the event history."""
max_size = 2
condenser = LLMAttentionCondenser(max_size=max_size, keep_first=0, llm=mock_llm)
for i in range(max_size * 10):
event = create_test_event(f'Event {i}', id=i)
mock_state.history.append(event)
mock_llm.set_mock_response_content(
ImportantEventSelection(
ids=[event.id for event in mock_state.history] + [-1, -2, -3, -4]
).model_dump_json()
)
results = condenser.condensed_history(mock_state)
# The number of results should bounce back and forth between 1, 2, 1, 2, ...
assert len(results) == (i % 2) + 1
def test_llm_attention_condenser_handles_too_many_events(mock_llm, mock_state):
"""Test that the LLMAttentionCondenser handles when the response contains too many event IDs."""
max_size = 2
condenser = LLMAttentionCondenser(max_size=max_size, keep_first=0, llm=mock_llm)
for i in range(max_size * 10):
event = create_test_event(f'Event {i}', id=i)
mock_state.history.append(event)
mock_llm.set_mock_response_content(
ImportantEventSelection(
ids=[event.id for event in mock_state.history]
+ [event.id for event in mock_state.history]
).model_dump_json()
)
results = condenser.condensed_history(mock_state)
# The number of results should bounce back and forth between 1, 2, 1, 2, ...
assert len(results) == (i % 2) + 1
def test_llm_attention_condenser_handles_too_few_events(mock_llm, mock_state):
"""Test that the LLMAttentionCondenser handles when the response contains too few event IDs."""
max_size = 2
# Developer note: We must specify keep_first=0 because
# keep_first (1) >= max_size//2 (1) is invalid.
condenser = LLMAttentionCondenser(max_size=max_size, keep_first=0, llm=mock_llm)
for i in range(max_size * 10):
event = create_test_event(f'Event {i}', id=i)
mock_state.history.append(event)
mock_llm.set_mock_response_content(
ImportantEventSelection(ids=[]).model_dump_json()
)
results = condenser.condensed_history(mock_state)
# The number of results should bounce back and forth between 1, 2, 1, 2, ...
assert len(results) == (i % 2) + 1
# Add a new test verifying that keep_first=1 works with max_size > 2
def test_llm_attention_condenser_handles_keep_first_for_larger_max_size(
mock_llm, mock_state
):
"""Test that LLMAttentionCondenser works when keep_first=1 is allowed (must be less than half of max_size)."""
max_size = 4 # so keep_first=1 < (max_size // 2) = 2
condenser = LLMAttentionCondenser(max_size=max_size, keep_first=1, llm=mock_llm)
for i in range(max_size * 2):
# We append new events, then ensure some are pruned.
event = create_test_event(f'Event {i}', id=i)
mock_state.history.append(event)
mock_llm.set_mock_response_content(
ImportantEventSelection(ids=[]).model_dump_json()
)
results = condenser.condensed_history(mock_state)
# We expect that the first event is always kept, and the tail grows until max_size
if len(mock_state.history) <= max_size:
# No condensation needed yet
assert len(results) == len(mock_state.history)
else:
# The first event is kept, plus some from the tail
assert results[0].id == 0
assert len(results) <= max_size