Files
turnstone/tests/test_session_manager.py
T
Patrick Buckley c77b237033 refactor(core): defer emit_created on SessionManager.create + commit_create / discard pair (#417)
* refactor(core): defer emit_created on SessionManager.create + commit_create / discard pair

Eliminates the phantom create→close pair on coord rollback that was
documented as a known limitation in PR #416. The pair surfaced on the
cluster events stream when a multipart workstream-create request
failed attachment validation: coord's ``mgr.create`` fired
``emit_created`` synchronously, then the rollback called
``mgr.close`` which fired ``emit_closed``. Cluster consumers had to
reconcile via the collector's diff path. Post-fix, a rejected upload
produces zero events.

API changes on ``SessionManager``:

- ``create(..., defer_emit_created: bool = False)`` — when True,
  skip the trailing ``emit_created`` so the caller can run additional
  post-create work (attachment validation in the lifted HTTP handler)
  before advertising the workstream. Default preserves the existing
  "advertise immediately" contract for direct callers (test fixtures,
  CLI REPL, channel adapters).
- ``commit_create(ws)`` — fires the deferred ``emit_created`` event
  after the caller's post-create work confirms the workstream should
  be advertised. Synchronous; the wrapped work is in-memory and
  non-blocking on every kind (interactive: documented no-op stub;
  coord: dict updates under a lock + ``queue.put_nowait`` fan-out).
- ``discard(ws_id)`` — releases the in-memory slot + cleans up the UI
  WITHOUT firing ``emit_closed``. Distinct from ``close`` which
  advertises the transition; ``discard`` is for the rollback case
  where the workstream's existence was never advertised. Storage-row
  deletion stays a separate concern (caller invokes
  ``delete_workstream``), mirroring ``mgr.create``'s split between
  slot reservation and ``register_workstream``.

Caller-bug detection: ``Workstream._emit_created_fired`` is set
inside ``create`` (non-deferred path) and ``commit_create``;
``discard`` logs ``session_mgr.discard.after_emit_created`` warning
when invoked on an already-advertised workstream. Slot is still
released so capacity isn't stranded.

Lifted ``make_create_handler`` updated to use the deferred bracket:
pass ``defer_emit_created=True``, validate uploaded attachments,
then ``mgr.commit_create(ws)`` on success / ``mgr.discard(ws.id)``
on failure. Ordering invariants (``commit_create`` BEFORE
``audit_emit`` and ``post_install`` so any state events the worker
fires reach the cluster collector for an already-known ws_id) are
documented in the handler docstring.

Tests:

- 5 new ``SessionManager`` unit tests (defer skips emit, commit
  fires it, commit no-ops without emitter, discard releases without
  emit_closed, discard returns False on unknown id).
- 2 caller-bug regression tests (commit_create after discard pins
  the silent re-emit behaviour; discard after non-deferred create
  asserts the warning fires + slot still releases).
- 1 coord regression test asserting the cluster collector sees zero
  events when attachment validation fails.

``/review`` pipeline run; M1 (test gap on caller-bug paths) +
Mi1 (no runtime guard for already-advertised) + Mi2
(``_make_manager`` event_emitter override) + Mi3 / N2 (duplicated
comments + ordering invariant) + N1 (drop ``to_thread`` on
``commit_create``) all addressed.

4509 tests passing; ruff + mypy clean.

* fix(core): apply Copilot + code-quality review feedback on PR #417

Copilot review:

- ``Workstream._emit_created_fired`` comment claimed the flag was
  "set under the manager's _lock-protected emit", but the actual
  ordering set it OUTSIDE the lock. Comment updated to describe the
  real synchronization (non-deferred ``create`` sets it immediately
  before ``emit_created``; ``commit_create`` sets it under the
  manager lock alongside the tracked-ws check).
- ``commit_create`` had no guard against duplicate calls,
  post-discard calls, or calls on workstreams not tracked by this
  manager — any of those would have fired duplicate or phantom
  ``ws_created`` events. Added a guard symmetric to ``discard``'s
  after-emit warning: under ``self._lock``, check ``_emit_created_fired``
  + ``_workstreams.get(ws.id) is ws``, no-op + log a warning
  (``session_mgr.commit_create.already_fired`` /
  ``session_mgr.commit_create.untracked``) on either failure. The
  emit itself still runs outside the lock so coord's collector
  fan-out doesn't couple to the manager mutex.
- ``test_commit_create_after_discard_is_caller_bug_no_op`` was
  internally inconsistent — name + docstring said "must not re-emit"
  but the assertion expected the re-emit. Renamed to
  ``test_commit_create_after_discard_is_no_op`` and updated to
  assert the new no-op + warning behaviour.

New test ``test_commit_create_is_idempotent_on_duplicate_call``
pins the second-commit-call code path: exactly one ``ws_created``
event fires, second call short-circuits via the guard with a
``commit_create.already_fired`` warning.

Code-quality bot review (3 findings, identical pattern):

- Three test ``assert`` statements wrapped side-effecting calls
  (``assert mgr.discard(ws_id) is True/False``); under ``python -O``
  the asserts strip and the side-effect strips with them. Refactored
  all three to assign the result to a local first, assert on the
  local. No behaviour change.

4510 tests passing; ruff + mypy clean.
2026-04-26 12:06:59 -07:00

988 lines
36 KiB
Python

"""Smoke tests for the unified SessionManager.
Cover the concurrency-sensitive paths that historically diverged
between ``WorkstreamManager`` and ``CoordinatorManager`` — slot
reservation, eviction, per-ws lock serialization on lazy rehydrate,
state flips, close-unblocks-UI. All exercised through a
``FakeAdapter`` that records ``emit_*`` / ``cleanup_ui`` calls so
tests can assert the transport contract without spinning up real
WebUI / ClusterCollector pipelines. The adapter is wired as both the
manager's ``adapter`` (for ``cleanup_ui`` / ``build_*``) and its
``event_emitter`` (for the ``emit_*`` lifecycle calls); production
adapters do the same — interactive on ``server.py``, coordinator on
``console/server.py``.
"""
from __future__ import annotations
import threading
import time
from dataclasses import dataclass
from typing import Any
from unittest.mock import MagicMock
import pytest
from turnstone.core.session_manager import SessionKindAdapter, SessionManager
from turnstone.core.workstream import Workstream, WorkstreamKind, WorkstreamState
# ---------------------------------------------------------------------------
# Test fixtures
# ---------------------------------------------------------------------------
@dataclass
class _Event:
kind: str # "created" | "rehydrated" | "state" | "closed"
ws_id: str
state: WorkstreamState | None = None
reason: str | None = None
name: str | None = None
class FakeUI:
"""Minimal UI stand-in with the events close() needs to unblock."""
def __init__(self) -> None:
self.approval_unblocked = False
self.plan_unblocked = False
self.fg_unblocked = False
self.closed_broadcast = False
def _unblock(self) -> None:
self.approval_unblocked = True
self.plan_unblocked = True
self.fg_unblocked = True
def broadcast_ws_closed(self) -> None:
self.closed_broadcast = True
class FakeSession:
"""Minimal ChatSession stand-in; exposes cancel / close / resume."""
def __init__(self, ws_id: str) -> None:
self.ws_id = ws_id
self.cancelled = False
self.closed = False
self.resumed = False
def cancel(self) -> None:
self.cancelled = True
def close(self) -> None:
self.closed = True
def resume(self, ws_id: str) -> None:
self.resumed = True
class FakeAdapter:
"""Records events + builds FakeUI / FakeSession for tests."""
def __init__(
self,
kind: WorkstreamKind = WorkstreamKind.INTERACTIVE,
*,
build_session_raises: bool = False,
) -> None:
self.kind = kind
self.events: list[_Event] = []
self._events_lock = threading.Lock()
self.cleaned_up: list[str] = []
self.build_session_calls = 0
self.build_session_raises = build_session_raises
# Slow down session build so concurrent tests can race.
self.build_session_delay = 0.0
def emit_created(self, ws: Workstream) -> None:
with self._events_lock:
self.events.append(_Event("created", ws.id))
def emit_rehydrated(self, ws: Workstream) -> None:
# Distinct from "created" so a regression where the manager
# fires emit_created on the rehydrate path (or emit_rehydrated
# on the create path) actually fails a test. The
# SessionEventEmitter Protocol carves these out as semantically
# different — coord uses emit_rehydrated for the storage-seeded
# subtree rebuild that emit_created skips.
with self._events_lock:
self.events.append(_Event("rehydrated", ws.id))
def emit_state(self, ws: Workstream, state: WorkstreamState) -> None:
with self._events_lock:
self.events.append(_Event("state", ws.id, state=state))
def emit_closed(
self,
ws_id: str,
*,
reason: str = "closed",
name: str = "",
) -> None:
with self._events_lock:
self.events.append(_Event("closed", ws_id, reason=reason, name=name))
def cleanup_ui(self, ws: Workstream) -> None:
self.cleaned_up.append(ws.id)
if ws.session is not None:
ws.session.cancel()
ws.session.close()
if ws.ui is not None:
ws.ui._unblock()
ws.ui.broadcast_ws_closed()
def build_ui(self, ws: Workstream) -> Any:
return FakeUI()
def build_session(self, ws: Workstream, **_: object) -> Any:
self.build_session_calls += 1
if self.build_session_delay:
time.sleep(self.build_session_delay)
if self.build_session_raises:
raise RuntimeError("build_session forced failure")
return FakeSession(ws.id)
def events_of(self, kind: str) -> list[_Event]:
with self._events_lock:
return [e for e in self.events if e.kind == kind]
@dataclass
class _Row:
ws_id: str
user_id: str
name: str
kind: str
state: str = "idle"
parent_ws_id: str | None = None
class FakeStorage:
"""In-memory storage that mirrors the StorageBackend surface the manager uses."""
def __init__(self) -> None:
self.rows: dict[str, _Row] = {}
self.state_updates: list[tuple[str, str]] = []
self.register_raises = False
self.lock = threading.Lock()
def register_workstream(
self,
ws_id: str,
*,
node_id: str | None = None,
user_id: str | None = None,
name: str = "",
kind: WorkstreamKind | str = WorkstreamKind.INTERACTIVE,
parent_ws_id: str | None = None,
skill_id: str = "",
skill_version: int = 0,
) -> None:
if self.register_raises:
raise RuntimeError("register forced failure")
kind_str = kind.value if isinstance(kind, WorkstreamKind) else str(kind)
with self.lock:
self.rows[ws_id] = _Row(
ws_id=ws_id,
user_id=user_id or "",
name=name,
kind=kind_str,
parent_ws_id=parent_ws_id,
)
def update_workstream_state(self, ws_id: str, state: str) -> None:
with self.lock:
self.state_updates.append((ws_id, state))
if ws_id in self.rows:
self.rows[ws_id].state = state
def get_workstream(self, ws_id: str) -> dict[str, Any] | None:
with self.lock:
row = self.rows.get(ws_id)
if row is None:
return None
return {
"ws_id": row.ws_id,
"user_id": row.user_id,
"name": row.name,
"kind": row.kind,
"state": row.state,
"parent_ws_id": row.parent_ws_id,
}
def delete_workstream(self, ws_id: str) -> None:
with self.lock:
self.rows.pop(ws_id, None)
def count_skill_versions(self, template_id: str) -> int:
return 0
_EMITTER_DEFAULT = object()
def _make_manager(
adapter: FakeAdapter | None = None,
*,
max_active: int = 5,
storage: FakeStorage | None = None,
event_emitter: Any = _EMITTER_DEFAULT,
) -> tuple[SessionManager, FakeAdapter, FakeStorage]:
"""Build a SessionManager wired to a FakeAdapter for both Protocols.
``event_emitter`` defaults to the adapter (production wiring shape);
pass ``None`` explicitly to disable the lifecycle-event side
channel for tests that care about no-emitter behaviour.
"""
adapter = adapter or FakeAdapter()
storage = storage or FakeStorage()
# FakeAdapter implements both Protocols (the production adapters
# do too — wire as both so the emit_* assertions in this file
# still see the events the manager fires).
emitter = adapter if event_emitter is _EMITTER_DEFAULT else event_emitter
mgr = SessionManager(
adapter,
storage=storage,
max_active=max_active,
event_emitter=emitter,
)
return mgr, adapter, storage
# ---------------------------------------------------------------------------
# Construction
# ---------------------------------------------------------------------------
def test_session_manager_constructs_with_adapter() -> None:
mgr, adapter, _ = _make_manager()
assert mgr.max_active == 5
assert mgr.kind == adapter.kind
def test_session_manager_rejects_invalid_max_active() -> None:
with pytest.raises(ValueError, match="max_active must be >= 1"):
SessionManager(FakeAdapter(), storage=FakeStorage(), max_active=0)
def test_noop_adapter_satisfies_protocol() -> None:
adapter: SessionKindAdapter = FakeAdapter()
assert adapter.kind == WorkstreamKind.INTERACTIVE
# ---------------------------------------------------------------------------
# create
# ---------------------------------------------------------------------------
def test_create_persists_and_emits_created() -> None:
mgr, adapter, storage = _make_manager()
ws = mgr.create(user_id="u1", name="hello")
assert ws.user_id == "u1"
assert ws.name == "hello"
assert ws.session is not None
assert ws.ui is not None
assert ws.id in storage.rows
assert storage.rows[ws.id].kind == WorkstreamKind.INTERACTIVE.value
assert [e.ws_id for e in adapter.events_of("created")] == [ws.id]
def test_create_with_defer_emit_created_skips_emit() -> None:
"""``defer_emit_created=True`` returns the workstream but skips
the ``emit_created`` call. The slot, storage row, and built
session all exist — only the lifecycle event is held back.
Caller takes ownership of advertising the workstream via
:meth:`SessionManager.commit_create` (success) or
:meth:`SessionManager.discard` (rollback)."""
mgr, adapter, storage = _make_manager()
ws = mgr.create(user_id="u1", name="deferred", defer_emit_created=True)
# Workstream is fully constructed — only the broadcast is deferred.
assert ws.session is not None
assert ws.ui is not None
assert ws.id in storage.rows
assert mgr.get(ws.id) is ws
# No created event fired.
assert adapter.events_of("created") == []
def test_commit_create_fires_deferred_emit_created() -> None:
"""``commit_create`` is the deferred counterpart that fires the
pending ``emit_created`` event after the caller's post-create
work (e.g. attachment validation in the lifted HTTP handler)
confirms the workstream should be advertised."""
mgr, adapter, _ = _make_manager()
ws = mgr.create(user_id="u1", defer_emit_created=True)
assert adapter.events_of("created") == []
mgr.commit_create(ws)
assert [e.ws_id for e in adapter.events_of("created")] == [ws.id]
def test_commit_create_is_noop_without_event_emitter() -> None:
"""``commit_create`` must tolerate a manager constructed without
an event emitter — the deferred-create + commit pair has to
work the same shape regardless of whether transport fan-out is
wired (test fixtures, future kinds without an emitter)."""
mgr, adapter, _ = _make_manager(event_emitter=None)
ws = mgr.create(user_id="u1", defer_emit_created=True)
# Must not raise; nothing observable should happen.
mgr.commit_create(ws)
assert adapter.events_of("created") == []
def test_discard_releases_slot_without_emit_closed() -> None:
"""``discard`` is the rollback counterpart to ``commit_create``.
Releases the in-memory slot + cleans up the UI, but does NOT
fire ``emit_closed`` because the workstream's existence was
never advertised (caller used ``defer_emit_created=True``).
Distinct from ``close`` which DOES fire ``emit_closed`` to
advertise the transition. Pre-fix, the lifted create handler's
rollback path called ``close`` and produced a phantom
create→close pair on the cluster events stream when attachment
validation failed; ``discard`` is the surgical fix."""
mgr, adapter, storage = _make_manager(max_active=2)
ws = mgr.create(user_id="u1", name="will-be-discarded", defer_emit_created=True)
ws_id = ws.id
discarded = mgr.discard(ws_id)
assert discarded is True
# In-memory slot released — capacity restored.
assert mgr.get(ws_id) is None
assert mgr.count == 0
# UI cleanup ran (cleanup_ui is part of discard's contract).
assert ws_id in adapter.cleaned_up
# No advertisement at any point: no created event, no closed event.
assert adapter.events_of("created") == []
assert adapter.events_of("closed") == []
# Storage row survives — caller is responsible for
# ``delete_workstream`` if they want a complete rollback. Mirrors
# mgr.create's own session-build-failure path.
assert ws_id in storage.rows
def test_discard_returns_false_for_unknown_ws_id() -> None:
"""``discard`` is idempotent on an absent ws_id — returns False
instead of raising so the lifted handler's rollback path can
safely call discard inside ``contextlib.suppress`` without
spurious failures swallowing real errors."""
mgr, _, _ = _make_manager()
result = mgr.discard("nonexistent-ws-id")
assert result is False
def test_commit_create_after_discard_is_no_op(caplog) -> None:
"""Caller-bug case: ``commit_create`` after ``discard`` must not
fire ``emit_created`` for a workstream that's no longer tracked
by the manager. The workstream object still exists in the
caller's scope (discard only removed it from the manager's slot
map), so forwarding it to ``commit_create`` would fire a phantom
``ws_created`` for an id the cluster collector / children
registry will then never see ``ws_closed`` for. The guard logs
``session_mgr.commit_create.untracked`` and returns without
emitting."""
import logging
mgr, adapter, _ = _make_manager()
ws = mgr.create(user_id="u1", defer_emit_created=True)
discarded = mgr.discard(ws.id)
assert discarded is True
assert adapter.events_of("created") == []
with caplog.at_level(logging.WARNING, logger="turnstone.core.session_manager"):
mgr.commit_create(ws)
# No event emitted — the tracked-ws check failed.
assert adapter.events_of("created") == []
# Warning surfaced for operator triage.
assert any("commit_create.untracked" in record.message for record in caplog.records), [
r.message for r in caplog.records
]
def test_commit_create_is_idempotent_on_duplicate_call(caplog) -> None:
"""Caller-bug case: calling ``commit_create`` twice on the same
workstream must fire ``emit_created`` exactly once. The second
call hits the ``_emit_created_fired`` guard, logs
``session_mgr.commit_create.already_fired``, and returns without
re-emitting."""
import logging
mgr, adapter, _ = _make_manager()
ws = mgr.create(user_id="u1", defer_emit_created=True)
mgr.commit_create(ws)
assert [e.ws_id for e in adapter.events_of("created")] == [ws.id]
with caplog.at_level(logging.WARNING, logger="turnstone.core.session_manager"):
mgr.commit_create(ws)
# Still exactly one created event — the guard short-circuited
# the second call.
assert [e.ws_id for e in adapter.events_of("created")] == [ws.id]
assert any("commit_create.already_fired" in record.message for record in caplog.records), [
r.message for r in caplog.records
]
def test_discard_after_emit_created_warns_but_releases_slot(caplog) -> None:
"""Caller-bug case: ``discard`` on a workstream where
``emit_created`` has already fired (either via the non-deferred
create path or via ``commit_create``). The intended retraction
path is ``close`` (which fires ``emit_closed``); ``discard``
leaves a stale ``ws_created`` on the wire with no matching
``ws_closed``, which is exactly the phantom-event bug
``defer_emit_created`` was added to fix.
``discard`` still releases the in-memory slot (so capacity is
freed even when the caller misuses the API) but logs a
``warning`` so the misuse surfaces in ops logs.
"""
import logging
mgr, adapter, _ = _make_manager()
# Non-deferred create — emit_created fires inside mgr.create.
ws = mgr.create(user_id="u1", name="created-then-discarded")
assert [e.ws_id for e in adapter.events_of("created")] == [ws.id]
with caplog.at_level(logging.WARNING, logger="turnstone.core.session_manager"):
result = mgr.discard(ws.id)
# Slot released (caller-bug doesn't strand capacity).
assert result is True
assert mgr.get(ws.id) is None
# Warning surfaced for operator triage.
assert any("discard.after_emit_created" in record.message for record in caplog.records), [
r.message for r in caplog.records
]
# No ws_closed was fired — the bug being warned about is exactly
# this asymmetry (created without close on the wire). Operators
# who actually want a clean retraction should call close instead.
assert adapter.events_of("closed") == []
def test_create_evicts_oldest_idle_at_capacity() -> None:
mgr, adapter, _ = _make_manager(max_active=2)
first = mgr.create(user_id="u1")
# Nudge the timestamp so 'first' is the clear eviction candidate.
first.last_active = time.monotonic() - 100
mgr.create(user_id="u1")
# Third create triggers eviction of the oldest IDLE (= first).
third = mgr.create(user_id="u1")
assert mgr.get(first.id) is None
assert mgr.get(third.id) is not None
# Adapter transport saw the eviction and the new create.
assert first.id in [e.ws_id for e in adapter.events_of("closed")]
assert third.id in [e.ws_id for e in adapter.events_of("created")]
assert first.id in adapter.cleaned_up
def test_create_raises_when_all_active_and_no_idle() -> None:
mgr, _, _ = _make_manager(max_active=1)
ws = mgr.create(user_id="u1")
ws.state = WorkstreamState.RUNNING # block eviction
with pytest.raises(RuntimeError, match="slots are active"):
mgr.create(user_id="u1")
def test_create_rolls_back_slot_on_session_failure() -> None:
adapter = FakeAdapter(build_session_raises=True)
mgr, _, storage = _make_manager(adapter=adapter)
with pytest.raises(RuntimeError, match="build_session forced failure"):
mgr.create(user_id="u1")
# Slot freed — no dangling capacity consumption. The storage row
# survives construction failure on purpose: the next ``open(ws_id)``
# retries build_session rather than forcing the user to create a
# brand-new workstream.
assert mgr.count == 0
assert len(storage.rows) == 1
def test_create_rolls_back_slot_on_persist_failure() -> None:
storage = FakeStorage()
storage.register_raises = True
mgr, _, _ = _make_manager(storage=storage)
with pytest.raises(RuntimeError, match="register forced failure"):
mgr.create(user_id="u1")
assert mgr.count == 0
def test_concurrent_create_does_not_exceed_max_active() -> None:
mgr, _, _ = _make_manager(max_active=3)
adapter = mgr._adapter # type: ignore[attr-defined]
assert isinstance(adapter, FakeAdapter)
adapter.build_session_delay = 0.02 # widen the race window
results: list[Workstream | Exception] = []
lock = threading.Lock()
def _create() -> None:
try:
ws = mgr.create(user_id="u1")
with lock:
results.append(ws)
except Exception as e:
with lock:
results.append(e)
threads = [threading.Thread(target=_create) for _ in range(8)]
for t in threads:
t.start()
for t in threads:
t.join()
# Manager holds at most max_active; overflow creates must raise
# (5 overflows raise, 3 succeed — no silent exceed).
assert mgr.count <= 3
successes = [r for r in results if isinstance(r, Workstream)]
assert len(successes) <= 3
# ---------------------------------------------------------------------------
# open — lazy rehydrate
# ---------------------------------------------------------------------------
def test_open_returns_none_for_missing_row() -> None:
mgr, _, _ = _make_manager()
opened = mgr.open("missing")
assert opened is None
def test_open_blocks_deleted_state() -> None:
mgr, _, storage = _make_manager()
ws = mgr.create(user_id="u1")
mgr.close(ws.id)
# Flip the row to the tombstone state — open must refuse it.
storage.rows[ws.id].state = "deleted"
opened = mgr.open(ws.id)
assert opened is None
def test_open_resurrects_closed_state() -> None:
mgr, adapter, _ = _make_manager()
ws = mgr.create(user_id="u1")
ws_id = ws.id
mgr.close(ws_id)
assert mgr.get(ws_id) is None
reopened = mgr.open(ws_id)
assert reopened is not None
assert reopened.id == ws_id
assert reopened.session is not None
assert reopened.session.resumed is True # type: ignore[attr-defined]
# Open fires emit_rehydrated (NOT emit_created) so observers can
# gate any extra resurrect-only setup on it (e.g. coord's
# storage-seeded children rebuild).
assert ws_id in [e.ws_id for e in adapter.events_of("rehydrated")]
def test_open_ignores_owner_mismatch() -> None:
# Turnstone is a trusted-team tool; row-level ownership is
# metadata, not an access boundary. ``open`` no longer cares
# who the caller is — any authenticated caller can rehydrate
# any persisted workstream. Scope-level auth at the HTTP
# layer is the only gate.
mgr, _, _ = _make_manager()
ws = mgr.create(user_id="u1")
mgr.close(ws.id)
reopened = mgr.open(ws.id)
assert reopened is not None
assert reopened.user_id == "u1" # metadata preserved
def test_open_rejects_wrong_kind() -> None:
mgr, _, storage = _make_manager()
ws = mgr.create(user_id="u1")
# Storage row claims a different kind than our adapter's.
storage.rows[ws.id].kind = WorkstreamKind.COORDINATOR.value
mgr.close(ws.id)
opened = mgr.open(ws.id)
assert opened is None
def test_concurrent_open_for_same_ws_id_returns_same_session() -> None:
mgr, adapter, _ = _make_manager()
ws = mgr.create(user_id="u1")
ws_id = ws.id
mgr.close(ws_id)
adapter.build_session_calls = 0
adapter.build_session_delay = 0.02
results: list[Workstream | None] = []
lock = threading.Lock()
def _open() -> None:
r = mgr.open(ws_id)
with lock:
results.append(r)
threads = [threading.Thread(target=_open) for _ in range(6)]
for t in threads:
t.start()
for t in threads:
t.join()
loaded = [r for r in results if r is not None]
assert len(loaded) == 6
# All threads got the same Workstream instance — no duplicate session.
sessions = {id(r.session) for r in loaded}
assert len(sessions) == 1
# build_session ran exactly once — the per-ws lock serialized the rest.
assert adapter.build_session_calls == 1
# ---------------------------------------------------------------------------
# close
# ---------------------------------------------------------------------------
def test_close_unblocks_ui_and_emits_closed() -> None:
mgr, adapter, storage = _make_manager()
ws = mgr.create(user_id="u1")
ws_id = ws.id
closed = mgr.close(ws_id)
assert closed is True
assert mgr.get(ws_id) is None
assert ws_id in adapter.cleaned_up
assert ws_id in [e.ws_id for e in adapter.events_of("closed")]
# Storage reflects the close.
assert (ws_id, "closed") in storage.state_updates
# UI events unblocked.
assert ws.ui.approval_unblocked is True # type: ignore[attr-defined]
assert ws.ui.plan_unblocked is True # type: ignore[attr-defined]
assert ws.ui.closed_broadcast is True # type: ignore[attr-defined]
# Session cancelled + closed.
assert ws.session.cancelled is True # type: ignore[attr-defined]
assert ws.session.closed is True # type: ignore[attr-defined]
def test_close_last_workstream_succeeds() -> None:
"""The WSM 'refuse to close last workstream' guard is gone (#400 follow-up).
The default startup workstream relic is deleted; the dashboard
handles the 0-workstream state and callers can close freely.
"""
mgr, _, _ = _make_manager()
ws = mgr.create(user_id="u1")
closed = mgr.close(ws.id)
assert closed is True
assert mgr.count == 0
def test_close_unknown_returns_false() -> None:
mgr, _, _ = _make_manager()
closed = mgr.close("not-there")
assert closed is False
# ---------------------------------------------------------------------------
# set_state
# ---------------------------------------------------------------------------
def test_set_state_updates_storage_and_fires_observer() -> None:
mgr, adapter, storage = _make_manager()
ws = mgr.create(user_id="u1")
mgr.set_state(ws.id, WorkstreamState.RUNNING)
assert ws.state == WorkstreamState.RUNNING
assert (ws.id, WorkstreamState.RUNNING.value) in storage.state_updates
state_events = adapter.events_of("state")
assert any(e.ws_id == ws.id and e.state == WorkstreamState.RUNNING for e in state_events)
def test_set_state_unknown_ws_is_noop() -> None:
mgr, adapter, _ = _make_manager()
mgr.set_state("ghost", WorkstreamState.RUNNING)
assert adapter.events_of("state") == []
# ---------------------------------------------------------------------------
# close_idle / list_all / get / count
# ---------------------------------------------------------------------------
def test_close_idle_closes_old_idle_and_keeps_active() -> None:
mgr, _, _ = _make_manager()
old = mgr.create(user_id="u1")
fresh = mgr.create(user_id="u1")
running = mgr.create(user_id="u1")
old.last_active = time.monotonic() - 100
running.state = WorkstreamState.RUNNING
running.last_active = time.monotonic() - 100
closed = mgr.close_idle(max_age_seconds=10.0)
assert old.id in closed
assert mgr.get(old.id) is None
# Fresh stays (not old enough).
assert mgr.get(fresh.id) is not None
# Running stays (wrong state).
assert mgr.get(running.id) is not None
def test_close_idle_on_empty_manager_returns_empty_list() -> None:
mgr, _, _ = _make_manager()
assert mgr.close_idle(max_age_seconds=1.0) == []
def test_list_all_returns_creation_order() -> None:
mgr, _, _ = _make_manager()
a = mgr.create(user_id="u1")
b = mgr.create(user_id="u1")
c = mgr.create(user_id="u1")
assert [ws.id for ws in mgr.list_all()] == [a.id, b.id, c.id]
def test_count_reflects_live_workstreams() -> None:
mgr, _, _ = _make_manager()
assert mgr.count == 0
a = mgr.create(user_id="u1")
assert mgr.count == 1
mgr.create(user_id="u1")
assert mgr.count == 2
mgr.close(a.id)
assert mgr.count == 1
# ---------------------------------------------------------------------------
# Eviction transport — adapter contract
# ---------------------------------------------------------------------------
def test_eviction_fires_emit_closed_to_adapter_transport() -> None:
mgr, adapter, _ = _make_manager(max_active=2)
a = mgr.create(user_id="u1")
a.last_active = time.monotonic() - 100
mgr.create(user_id="u1")
mgr.create(user_id="u1") # triggers eviction of 'a'
closed_events = adapter.events_of("closed")
evicted = [e for e in closed_events if e.ws_id == a.id]
assert evicted and evicted[0].reason == "evicted"
assert a.id in adapter.cleaned_up
def test_manual_close_uses_closed_reason() -> None:
mgr, adapter, _ = _make_manager()
ws = mgr.create(user_id="u1")
mgr.close(ws.id)
closed_events = [e for e in adapter.events_of("closed") if e.ws_id == ws.id]
assert closed_events and closed_events[0].reason == "closed"
# ---------------------------------------------------------------------------
# CLI focus state
# ---------------------------------------------------------------------------
def test_active_id_seeded_on_first_create() -> None:
mgr, _, _ = _make_manager()
assert mgr.active_id is None
ws = mgr.create(user_id="u1")
assert mgr.active_id == ws.id
assert mgr.get_active() is ws
def test_active_id_unchanged_on_subsequent_creates() -> None:
mgr, _, _ = _make_manager()
first = mgr.create(user_id="u1")
mgr.create(user_id="u1")
# Creating a second workstream doesn't change focus.
assert mgr.active_id == first.id
def test_switch_moves_active_id() -> None:
mgr, _, _ = _make_manager()
a = mgr.create(user_id="u1")
b = mgr.create(user_id="u1")
assert mgr.active_id == a.id
result = mgr.switch(b.id)
assert result is b
assert mgr.active_id == b.id
# Unknown id → no change.
assert mgr.switch("ghost") is None
assert mgr.active_id == b.id
def test_switch_by_index_uses_1_based_ordering() -> None:
mgr, _, _ = _make_manager()
a = mgr.create(user_id="u1")
b = mgr.create(user_id="u1")
c = mgr.create(user_id="u1")
assert mgr.switch_by_index(2) is b
assert mgr.active_id == b.id
assert mgr.switch_by_index(3) is c
assert mgr.switch_by_index(0) is None
assert mgr.switch_by_index(99) is None
# Still on c after the invalid switches.
assert mgr.active_id == c.id
assert mgr.index_of(a.id) == 1
assert mgr.index_of("ghost") == 0
def test_active_id_moves_on_eviction() -> None:
mgr, _, _ = _make_manager(max_active=2)
a = mgr.create(user_id="u1")
a.last_active = time.monotonic() - 100
mgr.create(user_id="u1")
# First create seeded active to a; eviction of a must re-home active.
assert mgr.active_id == a.id
c = mgr.create(user_id="u1") # evicts a
assert mgr.active_id != a.id
assert mgr.active_id in (mgr._order[0], c.id) # type: ignore[attr-defined]
def test_active_id_moves_on_close() -> None:
mgr, _, _ = _make_manager()
a = mgr.create(user_id="u1")
b = mgr.create(user_id="u1")
mgr.switch(a.id)
mgr.close(a.id)
assert mgr.active_id == b.id
def test_eviction_count_tracks_evictions() -> None:
mgr, _, _ = _make_manager(max_active=2)
assert mgr.eviction_count == 0
a = mgr.create(user_id="u1")
a.last_active = time.monotonic() - 100
mgr.create(user_id="u1")
mgr.create(user_id="u1") # evicts a
assert mgr.eviction_count == 1
# ---------------------------------------------------------------------------
# Storage access patterns with mocks (defensive coverage)
# ---------------------------------------------------------------------------
def test_create_uses_configured_node_id() -> None:
storage = MagicMock()
adapter = FakeAdapter()
mgr = SessionManager(
adapter, storage=storage, max_active=3, node_id="node-xyz", event_emitter=adapter
)
mgr.create(user_id="u1")
assert storage.register_workstream.call_args.kwargs["node_id"] == "node-xyz"
# ---------------------------------------------------------------------------
# StateWriter integration — bug-3 invariant under write-behind
# ---------------------------------------------------------------------------
class TestSessionManagerWithStateWriter:
"""When a buffered StateWriter is wired in, ``set_state`` no longer
blocks ``ws._lock`` on a sync DB write — but ``close`` must still
leave 'closed' as the durable final state for the row, never
a buffered transient that flushes after close."""
def _make_with_writer(
self, *, flush_interval: float = 0.05
) -> tuple[SessionManager, FakeStorage, Any]:
from turnstone.core.state_writer import StateWriter
storage = FakeStorage()
writer = StateWriter(storage, flush_interval=flush_interval)
adapter = FakeAdapter()
mgr = SessionManager(
adapter,
storage=storage,
max_active=3,
state_writer=writer,
event_emitter=adapter,
)
return mgr, storage, writer
def test_set_state_buffers_through_writer(self) -> None:
mgr, storage, writer = self._make_with_writer(flush_interval=60.0)
ws = mgr.create(user_id="u1")
# Initial register write may have landed; clear and inspect afterwards.
storage.state_updates.clear()
mgr.set_state(ws.id, WorkstreamState.RUNNING)
# Long flush_interval → buffered, no sync write yet.
assert storage.state_updates == []
# Drain the buffer manually (test stand-in for the periodic flush).
writer.flush()
assert (ws.id, "running") in storage.state_updates
def test_set_state_error_flushes_sync(self) -> None:
"""Terminal ERROR transitions must be durable on return — error
surfacing paths (audit, dashboard) need the row to reflect
the failure before any observer sees it."""
mgr, storage, _writer = self._make_with_writer(flush_interval=60.0)
ws = mgr.create(user_id="u1")
storage.state_updates.clear()
mgr.set_state(ws.id, WorkstreamState.ERROR, error_msg="boom")
# No buffer-drain needed — error path bypasses.
assert (ws.id, "error") in storage.state_updates
def test_close_after_buffered_set_state_writes_closed_not_transient(self) -> None:
"""The bug-3 invariant under write-behind. close() must call
state_writer.discard BEFORE its sync 'closed' write, so any
buffered 'running' state can't be flushed AFTER 'closed'.
"""
mgr, storage, writer = self._make_with_writer(flush_interval=60.0)
ws = mgr.create(user_id="u1")
storage.state_updates.clear()
# Buffer a transient transition.
mgr.set_state(ws.id, WorkstreamState.RUNNING)
# Now close — must drain/discard the buffer + write 'closed' sync.
ok = mgr.close(ws.id)
assert ok is True
# Force a flush; the buffered 'running' must already be gone.
writer.flush()
# The final write for ws.id must be 'closed', and 'running' must
# NOT have landed in storage at all.
ws_writes = [s for w, s in storage.state_updates if w == ws.id]
assert "running" not in ws_writes, f"buffered running flushed after close: {ws_writes}"
assert ws_writes[-1] == "closed"
def test_close_idle_after_buffered_set_state_writes_closed(self) -> None:
"""Same invariant via close_idle (the idle-cleanup batch path)."""
mgr, storage, writer = self._make_with_writer(flush_interval=60.0)
ws = mgr.create(user_id="u1")
storage.state_updates.clear()
mgr.set_state(ws.id, WorkstreamState.RUNNING)
# Force the workstream into IDLE state before close_idle considers
# it (close_idle gates on ws.state, not the buffered state).
with mgr._lock:
mgr._workstreams[ws.id].state = WorkstreamState.IDLE
mgr._workstreams[ws.id].last_active = 0.0 # ancient → stale
closed = mgr.close_idle(max_age_seconds=0)
assert ws.id in closed
writer.flush()
ws_writes = [s for w, s in storage.state_updates if w == ws.id]
assert "running" not in ws_writes, f"buffered running flushed after close_idle: {ws_writes}"
assert ws_writes[-1] == "closed"
def test_set_state_after_close_short_circuits(self) -> None:
"""The existing tombstone (ws._closed) check must still fire
before reaching state_writer.record — set_state after close
must NOT enqueue 'running' to the buffer (which would then
get flushed and resurrect the closed row)."""
mgr, storage, writer = self._make_with_writer(flush_interval=60.0)
ws = mgr.create(user_id="u1")
ws_id = ws.id
# Close first — sets ws._closed=True synchronously.
mgr.close(ws_id)
storage.state_updates.clear()
# A late set_state call (e.g. from a worker still cleaning up).
# Should NOT buffer 'running' for this ws.
mgr.set_state(ws_id, WorkstreamState.RUNNING)
writer.flush()
ws_writes = [s for w, s in storage.state_updates if w == ws_id]
assert "running" not in ws_writes, (
f"set_state after close enqueued through buffer: {ws_writes}"
)