0b17a67c70
* feat(codex): add Hindsight memory integration for OpenAI Codex CLI
Hooks-based integration that gives Codex CLI long-term memory via Hindsight.
Three hooks keep memory in sync: SessionStart (daemon pre-warm), UserPromptSubmit
(recall + context injection), Stop (retain conversation to memory).
Key differences from the Claude Code integration:
- Codex transcript format: JSONL with {msg: {type, message}} (user_message/agent_message)
- No CODEX_PLUGIN_ROOT env var — install.sh writes hooks.json with absolute paths
- State stored in ~/.hindsight/codex/state/ (not CLAUDE_PLUGIN_DATA)
- No async: true in hooks (not supported by Codex)
- No SessionEnd event
- hooks.json written to ~/.codex/hooks.json with codex_hooks = true in config.toml
* fix(codex): fix transcript parser for actual Codex disk format
Codex stores sessions as rollout-*.jsonl with response_item entries:
User: {type:response_item, payload:{type:message, role:user, content:[{type:input_text, text:...}]}}
Assistant: {type:response_item, payload:{type:message, role:assistant, phase:final_answer, content:[{type:output_text, text:...}]}}
Previous parser expected an undocumented {msg:{type:user_message}} format from the Rust protocol spec
that does not match the actual on-disk storage format.
* feat(codex): add reflect mode to UserPromptSubmit hook
Add recallMode config option (default: 'recall') that switches the
UserPromptSubmit hook between:
- 'recall': existing behavior, fast raw facts list
- 'reflect': agentic synthesis loop, returns coherent prose answer
Also adds reflect() method to HindsightClient and HINDSIGHT_RECALL_MODE
env var override. Reflect uses a 25s timeout (vs 10s for recall).
* feat(codex): auto mode for recall/reflect selection
Add recallMode: 'auto' (new default) that picks the operation per-query:
- Synthesis patterns (what do you know, what's my, summarize, etc.) → reflect
- All other prompts → recall (fast, raw facts, better for code tasks)
* feat(codex): add automated test suite and finalize recall-only mode
* docs(codex): add docs page and sidebar entry for Codex CLI integration
364 lines
13 KiB
Python
364 lines
13 KiB
Python
"""Tests for lib/content.py — pure content-processing functions."""
|
|
|
|
import json
|
|
import os
|
|
import sys
|
|
|
|
import pytest
|
|
|
|
from lib.content import (
|
|
compose_recall_query,
|
|
format_memories,
|
|
prepare_retention_transcript,
|
|
read_transcript,
|
|
slice_last_turns_by_user_boundary,
|
|
strip_memory_tags,
|
|
truncate_recall_query,
|
|
)
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# strip_memory_tags
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
class TestStripMemoryTags:
|
|
def test_strips_hindsight_memories_block(self):
|
|
raw = "before\n<hindsight_memories>secret</hindsight_memories>\nafter"
|
|
result = strip_memory_tags(raw)
|
|
assert "hindsight_memories" not in result
|
|
assert "before" in result
|
|
assert "after" in result
|
|
|
|
def test_strips_relevant_memories_block(self):
|
|
raw = "text <relevant_memories>old stuff</relevant_memories> text"
|
|
result = strip_memory_tags(raw)
|
|
assert "relevant_memories" not in result
|
|
assert "old stuff" not in result
|
|
|
|
def test_passthrough_clean_text(self):
|
|
raw = "no memory tags here"
|
|
assert strip_memory_tags(raw) == raw
|
|
|
|
def test_strips_multiline_block(self):
|
|
raw = "<hindsight_memories>\n- mem1\n- mem2\n</hindsight_memories>"
|
|
assert strip_memory_tags(raw).strip() == ""
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# read_transcript — flat format
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def _write_jsonl(tmp_path, entries):
|
|
f = tmp_path / "transcript.jsonl"
|
|
f.write_text("\n".join(json.dumps(e) for e in entries))
|
|
return str(f)
|
|
|
|
|
|
class TestReadTranscriptFlat:
|
|
def test_reads_flat_format(self, tmp_path):
|
|
path = _write_jsonl(tmp_path, [
|
|
{"role": "user", "content": "hello"},
|
|
{"role": "assistant", "content": "hi there"},
|
|
])
|
|
msgs = read_transcript(path)
|
|
assert len(msgs) == 2
|
|
assert msgs[0] == {"role": "user", "content": "hello"}
|
|
|
|
def test_returns_empty_for_missing_file(self):
|
|
assert read_transcript("/nonexistent/path.jsonl") == []
|
|
|
|
def test_returns_empty_for_empty_string(self):
|
|
assert read_transcript("") == []
|
|
|
|
|
|
class TestReadTranscriptCodexFormat:
|
|
def test_reads_codex_response_item_format(self, tmp_path):
|
|
entries = [
|
|
{
|
|
"type": "response_item",
|
|
"payload": {
|
|
"type": "message",
|
|
"role": "user",
|
|
"content": [{"type": "input_text", "text": "What is Python?"}],
|
|
},
|
|
},
|
|
{
|
|
"type": "response_item",
|
|
"payload": {
|
|
"type": "message",
|
|
"role": "assistant",
|
|
"content": [{"type": "output_text", "text": "A programming language."}],
|
|
"phase": "final_answer",
|
|
},
|
|
},
|
|
]
|
|
path = _write_jsonl(tmp_path, entries)
|
|
msgs = read_transcript(path)
|
|
assert len(msgs) == 2
|
|
assert msgs[0]["role"] == "user"
|
|
assert msgs[0]["content"] == "What is Python?"
|
|
assert msgs[1]["role"] == "assistant"
|
|
assert msgs[1]["content"] == "A programming language."
|
|
|
|
def test_skips_non_final_answer_assistant_messages(self, tmp_path):
|
|
entries = [
|
|
{
|
|
"type": "response_item",
|
|
"payload": {
|
|
"type": "message",
|
|
"role": "assistant",
|
|
"content": [{"type": "output_text", "text": "thinking..."}],
|
|
"phase": "reasoning",
|
|
},
|
|
},
|
|
{
|
|
"type": "response_item",
|
|
"payload": {
|
|
"type": "message",
|
|
"role": "assistant",
|
|
"content": [{"type": "output_text", "text": "The answer is 42."}],
|
|
"phase": "final_answer",
|
|
},
|
|
},
|
|
]
|
|
path = _write_jsonl(tmp_path, entries)
|
|
msgs = read_transcript(path)
|
|
assert len(msgs) == 1
|
|
assert msgs[0]["content"] == "The answer is 42."
|
|
|
|
def test_skips_non_message_response_items(self, tmp_path):
|
|
entries = [
|
|
{"type": "response_item", "payload": {"type": "tool_call", "name": "Bash"}},
|
|
{
|
|
"type": "response_item",
|
|
"payload": {
|
|
"type": "message",
|
|
"role": "user",
|
|
"content": [{"type": "input_text", "text": "hello"}],
|
|
},
|
|
},
|
|
]
|
|
path = _write_jsonl(tmp_path, entries)
|
|
msgs = read_transcript(path)
|
|
assert len(msgs) == 1
|
|
assert msgs[0]["role"] == "user"
|
|
|
|
def test_skips_invalid_roles(self, tmp_path):
|
|
entries = [
|
|
{
|
|
"type": "response_item",
|
|
"payload": {
|
|
"type": "message",
|
|
"role": "system",
|
|
"content": [{"type": "input_text", "text": "system message"}],
|
|
},
|
|
},
|
|
]
|
|
path = _write_jsonl(tmp_path, entries)
|
|
msgs = read_transcript(path)
|
|
assert len(msgs) == 0
|
|
|
|
def test_skips_blank_lines_gracefully(self, tmp_path):
|
|
f = tmp_path / "transcript.jsonl"
|
|
f.write_text('\n{"role": "user", "content": "hi"}\n\n{"role": "assistant", "content": "hey"}\n')
|
|
msgs = read_transcript(str(f))
|
|
assert len(msgs) == 2
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# slice_last_turns_by_user_boundary
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def _msgs(*pairs):
|
|
return [{"role": r, "content": c} for r, c in pairs]
|
|
|
|
|
|
class TestSliceLastTurnsByUserBoundary:
|
|
def test_returns_all_when_fewer_turns_than_requested(self):
|
|
msgs = _msgs(("user", "hi"), ("assistant", "hello"))
|
|
assert slice_last_turns_by_user_boundary(msgs, 5) == msgs
|
|
|
|
def test_slices_to_last_one_turn(self):
|
|
msgs = _msgs(
|
|
("user", "first"), ("assistant", "a1"),
|
|
("user", "second"), ("assistant", "a2"),
|
|
)
|
|
result = slice_last_turns_by_user_boundary(msgs, 1)
|
|
assert result[0]["content"] == "second"
|
|
assert len(result) == 2
|
|
|
|
def test_slices_to_last_two_turns(self):
|
|
msgs = _msgs(
|
|
("user", "u1"), ("assistant", "a1"),
|
|
("user", "u2"), ("assistant", "a2"),
|
|
("user", "u3"), ("assistant", "a3"),
|
|
)
|
|
result = slice_last_turns_by_user_boundary(msgs, 2)
|
|
assert result[0]["content"] == "u2"
|
|
assert len(result) == 4
|
|
|
|
def test_empty_list_returns_empty(self):
|
|
assert slice_last_turns_by_user_boundary([], 3) == []
|
|
|
|
def test_zero_turns_returns_empty(self):
|
|
assert slice_last_turns_by_user_boundary(_msgs(("user", "hi")), 0) == []
|
|
|
|
def test_non_list_returns_empty(self):
|
|
assert slice_last_turns_by_user_boundary(None, 1) == []
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# compose_recall_query
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
class TestComposeRecallQuery:
|
|
def test_single_turn_returns_latest_only(self):
|
|
msgs = _msgs(("user", "previous"), ("assistant", "reply"))
|
|
result = compose_recall_query("new query", msgs, recall_context_turns=1)
|
|
assert result == "new query"
|
|
|
|
def test_multi_turn_includes_prior_context(self):
|
|
msgs = _msgs(("user", "prior question"), ("assistant", "prior answer"))
|
|
result = compose_recall_query("current question", msgs, recall_context_turns=2)
|
|
assert "Prior context:" in result
|
|
assert "prior question" in result
|
|
assert "current question" in result
|
|
|
|
def test_skips_duplicate_of_latest_query(self):
|
|
msgs = _msgs(("user", "same question"), ("assistant", "answer"))
|
|
result = compose_recall_query("same question", msgs, recall_context_turns=2)
|
|
assert result.count("same question") == 1
|
|
|
|
def test_empty_messages_returns_latest(self):
|
|
result = compose_recall_query("query", [], recall_context_turns=3)
|
|
assert result == "query"
|
|
|
|
def test_strips_memory_tags_from_context(self):
|
|
msgs = _msgs(("user", "<hindsight_memories>secret</hindsight_memories> actual question"))
|
|
result = compose_recall_query("now", msgs, recall_context_turns=2)
|
|
assert "hindsight_memories" not in result
|
|
assert "secret" not in result
|
|
|
|
def test_filters_by_recall_roles(self):
|
|
msgs = _msgs(("user", "user msg"), ("assistant", "assistant msg"))
|
|
result = compose_recall_query("query", msgs, recall_context_turns=2, recall_roles=["user"])
|
|
assert "user msg" in result
|
|
assert "assistant msg" not in result
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# truncate_recall_query
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
class TestTruncateRecallQuery:
|
|
def test_short_query_unchanged(self):
|
|
q = "short"
|
|
assert truncate_recall_query(q, q, max_chars=100) == q
|
|
|
|
def test_plain_query_truncated_to_max(self):
|
|
q = "x" * 50
|
|
result = truncate_recall_query(q, q, max_chars=20)
|
|
assert len(result) <= 20
|
|
|
|
def test_preserves_latest_when_context_dropped(self):
|
|
latest = "final question"
|
|
query = f"Prior context:\n\nuser: old stuff\nassistant: old reply\n\n{latest}"
|
|
result = truncate_recall_query(query, latest, max_chars=30)
|
|
assert latest in result
|
|
|
|
def test_drops_oldest_context_lines_first(self):
|
|
latest = "latest"
|
|
query = f"Prior context:\n\nuser: oldest\nassistant: old\nuser: newer\n\n{latest}"
|
|
max_chars = len(f"Prior context:\n\nnewer\n\n{latest}") + 5
|
|
result = truncate_recall_query(query, latest, max_chars=max_chars)
|
|
if "Prior context:" in result:
|
|
assert "oldest" not in result
|
|
|
|
def test_zero_max_returns_query_unchanged(self):
|
|
q = "anything"
|
|
assert truncate_recall_query(q, q, max_chars=0) == q
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# format_memories
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
class TestFormatMemories:
|
|
def test_formats_single_memory(self):
|
|
mems = [{"text": "Paris is the capital", "type": "world", "mentioned_at": "2024-01-01"}]
|
|
result = format_memories(mems)
|
|
assert "Paris is the capital" in result
|
|
assert "[world]" in result
|
|
assert "(2024-01-01)" in result
|
|
|
|
def test_formats_multiple_memories(self):
|
|
mems = [
|
|
{"text": "mem1", "type": "experience", "mentioned_at": "2024-01-01"},
|
|
{"text": "mem2", "type": "world", "mentioned_at": "2024-02-01"},
|
|
]
|
|
result = format_memories(mems)
|
|
assert "mem1" in result
|
|
assert "mem2" in result
|
|
|
|
def test_empty_list_returns_empty_string(self):
|
|
assert format_memories([]) == ""
|
|
|
|
def test_missing_optional_fields_graceful(self):
|
|
mems = [{"text": "bare memory"}]
|
|
result = format_memories(mems)
|
|
assert "bare memory" in result
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# prepare_retention_transcript
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
class TestPrepareRetentionTranscript:
|
|
def test_formats_last_turn_by_default(self):
|
|
msgs = _msgs(("user", "old"), ("assistant", "old reply"), ("user", "new"), ("assistant", "new reply"))
|
|
transcript, count = prepare_retention_transcript(msgs, retain_full_window=False)
|
|
assert "new" in transcript
|
|
assert "new reply" in transcript
|
|
assert count == 2
|
|
|
|
def test_full_window_retains_all(self):
|
|
msgs = _msgs(("user", "msg1"), ("assistant", "reply1"), ("user", "msg2"), ("assistant", "reply2"))
|
|
transcript, count = prepare_retention_transcript(msgs, retain_full_window=True)
|
|
assert "msg1" in transcript
|
|
assert "msg2" in transcript
|
|
assert count == 4
|
|
|
|
def test_strips_memory_tags(self):
|
|
msgs = _msgs(("user", "<hindsight_memories>leaked</hindsight_memories> actual question"))
|
|
transcript, _ = prepare_retention_transcript(msgs, retain_full_window=True)
|
|
assert "leaked" not in transcript
|
|
assert "actual question" in transcript
|
|
|
|
def test_filters_by_retain_roles(self):
|
|
msgs = _msgs(("user", "user msg"), ("assistant", "assistant msg"))
|
|
transcript, _ = prepare_retention_transcript(msgs, retain_roles=["user"], retain_full_window=True)
|
|
assert "user msg" in transcript
|
|
assert "assistant msg" not in transcript
|
|
|
|
def test_empty_messages_returns_none(self):
|
|
result, count = prepare_retention_transcript([])
|
|
assert result is None
|
|
assert count == 0
|
|
|
|
def test_role_markers_present(self):
|
|
msgs = _msgs(("user", "hello"))
|
|
transcript, _ = prepare_retention_transcript(msgs, retain_full_window=True)
|
|
assert "[role: user]" in transcript
|
|
assert "[user:end]" in transcript
|
|
|
|
def test_no_user_message_returns_none(self):
|
|
msgs = [{"role": "assistant", "content": "only assistant"}]
|
|
result, _ = prepare_retention_transcript(msgs, retain_full_window=False)
|
|
assert result is None
|