Normandy.Behaviours.SessionStore behaviour
(normandy v1.1.1)
View Source
Contract for externalizing a session's conversation entries and turn state.
The memory-backing half (append_entry, history, fork) persists the
parent-linked entry graph keyed by session_id. The turn-state half
(save_turn_state, load_turn_state) round-trips an opaque term — defined
and contract-tested in Phase 3 but with no real consumer until Phase 4's
%TurnState{} (suspendable turn / passivation).
handle is impl-specific (a pid for InMemory, a table for ETS). Each impl
exposes new/0 (or new/1) returning a fresh handle for tests and callers.
This seam persists the full entry graph: it deliberately does not apply
max_messages windowing (that is a read-time / agent-runtime concern, applied
by the turn loop in Phase 4, not at the persistence layer).
Missing-session semantics are asymmetric by intent: history/2 is lenient and
returns {:ok, []} for an unknown session, while fork/3 is strict and returns
{:error, _} — you cannot branch a conversation that does not exist.
Summary
Callbacks
Lists the session_ids whose persisted config template has resume_policy: :eager.
Types
Callbacks
@callback append_entry(handle(), session_id(), Normandy.Components.AgentMemory.Entry.t()) :: {:ok, String.t()} | {:error, term()}
@callback fork(handle(), session_id(), from_entry_id :: String.t()) :: {:ok, session_id()} | {:error, term()}
@callback history(handle(), session_id()) :: {:ok, [Normandy.Components.AgentMemory.Entry.t()]} | {:error, term()}
@callback list_resumable(handle()) :: {:ok, [session_id()]} | {:error, term()}
Lists the session_ids whose persisted config template has resume_policy: :eager.
Used by Turn.ResumeReaper on node-down to find candidate eager sessions; the
reaper further filters by liveness (whereis) and non-terminal turn state, so
this returns eager sessions regardless of their turn state.
@callback load_config_template(handle(), session_id()) :: {:ok, term()} | :error
@callback load_turn_state(handle(), session_id()) :: {:ok, term()} | :error
@callback save_config_template(handle(), session_id(), template :: term()) :: :ok | {:error, term()}
@callback save_turn_state(handle(), session_id(), state :: term()) :: :ok | {:error, term()}