chart/docs/async_refactor.md
Chris Amow a395818581 Post cross-thread events through the loop, and measure how late it runs
P0 from docs/async_refactor.md. The mutating routes are sync `def`, so FastAPI
runs them in a threadpool, and they reach Runtime.broadcast through
rebuild_levels — writing asyncio.Queue directly from there. That queue is not
thread-safe: it wakes a consumer by resolving a Future, which only the loop
thread may do. A dropped wakeup means a drawing made in one browser does not
reach another until the next market tick.

broadcast now posts through call_soon_threadsafe when it is off the loop, and
publishes directly when it is on it, so the stream's own path pays nothing.

Worth being straight about the tests: the race is timing-dependent and did not
reproduce in twenty attempts — a foreign-thread put_nowait usually lands in the
ready queue before the loop sleeps, and a tick every second covers the rest.
Even asyncio's debug thread-affinity check stays quiet unless a consumer is
parked on the Future at that instant. So the tests assert the contract rather
than provoke the failure: a broadcast from a worker thread must go through
call_soon_threadsafe, one from the loop must deliver synchronously, and both
must arrive.

Also adds the loop-lag probe, which reports scheduling drift as loop_lag_ms on
/api/status. It found P1 on its first run: 19,441ms worst against 1.5ms in
steady state, which is seeding blocking the loop. "The chart feels laggy" is now
a number.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-11 15:30:45 -05:00

195 lines
8.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Async refactor — findings, priorities, and how to keep it that way
**Status: P0 and the loop-lag probe are done (2026-08-11). P1–P3 outstanding.** To be implemented once the in-flight chart
work has landed. Everything below is from reading the code on 2026-08-11 and
measuring the running app; each finding names the path it was found on.
## The goal is not "more async"
The target is **nothing blocks the event loop**, which is not the same thing as
converting everything to `async def`. Getting this backwards would make the app
worse, so state it plainly:
- FastAPI runs a **sync `def` route in a threadpool**. Blocking work inside one
never touches the loop. That is protection, not a defect.
- Converting those routes to `async def` *removes* the protection: any blocking
call inside then stalls the market stream and every WebSocket.
- So the rule is per-function. A handler that only awaits should be `async def`.
A handler doing blocking or CPU work should stay `def` — **and must not touch
loop-owned objects** (see P0).
## What is already right
- Every outbound HTTP call is async: `httpx.AsyncClient` in `notify/ntfy.py` and
`market/yahoo.py`; the Schwab `StreamClient` is built with `asyncio=True`.
- The market stream is an `asyncio.Task` owned by the app lifespan, and the
WebSocket endpoint is a coroutine.
- `ManualLineStore` guards itself with a `threading.RLock`, which is the correct
primitive precisely because both threadpool routes and the loop reach it. Do
not "modernise" it to `asyncio.Lock` — that would protect only one of them.
---
## P0 — Cross-thread access to `asyncio.Queue` (correctness) — DONE
Sync route handlers reach loop-owned objects from a worker thread:
```
create_line / create_price_alert / create_comment / patch_line / delete_line (sync def, threadpool)
-> runtime.rebuild_levels()
-> broadcast_level_delta() -> broadcast()
-> queue.put_nowait(event) # asyncio.Queue, owned by the loop
```
`asyncio.Queue` is not thread-safe. It wakes a waiting consumer by setting a
Future's result, and Futures must be resolved on the loop thread — from another
thread that requires `loop.call_soon_threadsafe`. Writing directly can drop the
wakeup or corrupt internal state.
**Why nobody has noticed:** the market stream broadcasts roughly once a second,
so a dropped wakeup is papered over by the next event almost immediately. The
visible symptom would be a drawing made in one browser not appearing in another
until the next tick — easy to misread as network lag.
**Fix.** Give `Runtime` the loop it belongs to and post from the correct thread:
```python
self._loop = asyncio.get_running_loop() # captured in start()
def broadcast(self, event: dict) -> None:
if threading.current_thread() is threading.main_thread() and self._loop.is_running():
self._publish(event) # already on the loop
else:
self._loop.call_soon_threadsafe(self._publish, event)
```
Prefer this over making the routes `async def`: that would move level rebuilding
(P1) onto the loop, trading a rare correctness bug for a guaranteed latency one.
**Verify.** A test that calls a mutating route through `TestClient` while a
WebSocket subscriber waits, asserting the event arrives without another tick
intervening. Today that passes by luck.
---
## P1 — Level rebuilding is CPU-bound on the loop (latency)
`rebuild_levels()` recomputes all five daily moving averages and re-serialises
their points to diff them, on every closed bar. Measured consequence: the seed
replay runs the same path per bar and takes **~82 seconds**, during which the
port is closed. In steady state it is once a minute, which is survivable but is
the largest single thing the loop does.
Threads do not help — it is genuine CPU under the GIL. The fix is algorithmic:
1. **Incremental moving averages.** `indicators.sma` is already a rolling sum;
the waste is recomputing every window from scratch each rebuild rather than
advancing the last one.
2. **Bulk seeding.** Load seeded bars into the store directly and rebuild levels
**once** at the end, rather than replaying each bar through `on_bar`.
3. **Diff without re-serialising.** `broadcast_level_delta()` compares
`to_dict()` output including hundreds of points per MA. Compare a cheap
fingerprint (last point plus length) and serialise only what changed.
Do (2) first — it is contained, testable, and removes most of the 82 seconds.
**Verify.** A test asserting a seed of N bars completes under a threshold, and a
loop-lag probe (below) staying under ~50ms while a bar closes.
---
## P2 — Blocking disk write on the loop (small, real)
```
on_bar (coroutine)
-> rebuild_clusters(evaluate_alerts=True) -> dispatch_alerts() -> disarm()
-> manual_lines.update() -> save() # write_text + atomic replace
```
A ~1KB write, usually sub-millisecond, but it lands on the loop at the exact
moment an alert fires, and it is unbounded on a contended disk.
**Fix.** Either `await asyncio.to_thread(self.manual_lines.update, ...)` on that
path, or mark the line disarmed in memory and flush outside the tick. The same
applies to any future persistence work — see the cold-restart notes, which will
add far more writing than this.
---
## P3 — Seeding blocks startup (architectural)
`Runtime.start()` awaits both seeds before uvicorn binds, so the port refuses
connections for the whole ~82 seconds and any open browser logs a wall of
`ERR_CONNECTION_REFUSED`. Fixing P1(2) may reduce this enough on its own. If it
does not, seed in a background task and serve immediately — but note that
changes what `/api/status`'s `warm` flags mean to every consumer, so it needs
its own thought rather than being bolted on.
---
## Explicitly not doing
- **Converting sync routes to `async def`.** They do in-memory work behind a
threadpool hop, which is correct and cheap. Changing them adds risk for no
gain, and would drag P1's CPU cost onto the loop.
- **`asyncio.Lock` in `ManualLineStore`.** It is reached from both the loop and
threadpool threads; only a threading primitive covers both.
- **Multiple uvicorn workers as a performance fix.** See `Procfile` — a second
process opens a second Schwab stream and duplicates every alert.
---
## Keeping it this way
Findings decay unless something enforces them. Three layers, cheapest first.
### 1. Rules where agents actually read them
`AGENTS.md` is loaded automatically by both Claude Code (via the `CLAUDE.md`
symlink) and OpenCode every session; nothing else in the repo is guaranteed to
be read. Add a short **Async rules** section stating:
- Nothing blocking or CPU-heavy runs on the event loop.
- Sync `def` routes stay sync; they run in a threadpool by design.
- A threadpool thread must never touch `asyncio` objects directly — post through
`loop.call_soon_threadsafe`.
- `ManualLineStore`'s lock is a threading lock deliberately.
Keep it to a handful of lines. A long section is skimmed; a short one is read.
### 2. Comments at the point of danger
A rule in a document does not stop an edit; a comment on the line does. Already
done for the worker count in `Procfile`. Add the same at:
- `Runtime.broadcast` — why it posts through the loop.
- `ManualLineStore._lock` — why it is a threading lock.
- Each mutating route — why it is `def` and not `async def`.
### 3. Make a regression visible
- **Loop-lag probe.** DONE — `Runtime.loop_lag_watch` samples 100ms scheduling
drift and `/api/status` reports `loop_lag_ms`. It found P1 on its first run:
19,441ms worst at startup against 1.5ms in steady state. A stall then shows up as a
number instead of as "the chart feels laggy". This is the single highest-value
addition here, and it costs about ten lines.
- **`loop.set_debug(True)` in dev**, which logs any callback over 100ms with a
traceback — it would have named P1 immediately.
- **A seed-duration test**, so P1 cannot silently regress once fixed.
### 4. Where the record lives
The risk register in `IMPLEMENTATION_PLAN.md` §15 gets one row per finding, so a
reader looking for known hazards finds them. This file holds the detail; the
register holds the pointer.
---
## Suggested order
1. **P0** — correctness, small, self-contained.
2. **Loop-lag probe** — so P1's improvement is measurable rather than asserted.
3. **P1(2)** bulk seeding, then P1(1) and P1(3) if the probe still shows stalls.
4. **P2** — trivial once P0 has established how work leaves the loop.
5. **P3** — only if P1 leaves the startup window unacceptable.
6. Docs and comments alongside each change, not as a final sweep.