Bound Web Push fan-out latency across devices #558

Merged
timmy merged 1 commits from timmy/557-bounded-push-fanout into main 2026-08-11 08:56:58 +00:00
4 changed files with 137 additions and 41 deletions

View File

@ -193,10 +193,12 @@ export STACKCHAIN_VAPID_PUBLIC_KEY='<url-safe-public-key>'
export STACKCHAIN_VAPID_PRIVATE_KEY='<private-key-from-secret-manager>' export STACKCHAIN_VAPID_PRIVATE_KEY='<private-key-from-secret-manager>'
export STACKCHAIN_VAPID_SUBJECT='mailto:ops@example.com' export STACKCHAIN_VAPID_SUBJECT='mailto:ops@example.com'
# Optional; defaults to a 30-second poll, 10-second endpoint deadline, # Optional; defaults to a 30-second poll, 10-second endpoint deadline,
# 60-second renewable cross-worker lease, and # 8 concurrently dispatched devices, 60-second renewable cross-worker lease,
# STACKCHAIN_STATE_DIR/push-subscriptions.sqlite3. # and STACKCHAIN_STATE_DIR/push-subscriptions.sqlite3. Threads stay ordered
# within each device; one slow device does not delay healthy devices behind it.
export STACKCHAIN_PUSH_POLL_SECONDS=30 export STACKCHAIN_PUSH_POLL_SECONDS=30
export STACKCHAIN_PUSH_SEND_TIMEOUT_SECONDS=10 export STACKCHAIN_PUSH_SEND_TIMEOUT_SECONDS=10
export STACKCHAIN_PUSH_MAX_CONCURRENCY=8
export STACKCHAIN_PUSH_LEASE_SECONDS=60 export STACKCHAIN_PUSH_LEASE_SECONDS=60
export STACKCHAIN_PUSH_DB='/var/lib/stackchain-dashboard/push-subscriptions.sqlite3' export STACKCHAIN_PUSH_DB='/var/lib/stackchain-dashboard/push-subscriptions.sqlite3'
uvicorn src.main:app --host 127.0.0.1 --port 8000 uvicorn src.main:app --host 127.0.0.1 --port 8000

View File

@ -87,6 +87,9 @@ async def _push_poll_loop() -> None:
send_timeout + 5.0, send_timeout + 5.0,
float(os.getenv("STACKCHAIN_PUSH_LEASE_SECONDS", "60")), float(os.getenv("STACKCHAIN_PUSH_LEASE_SECONDS", "60")),
) )
max_concurrency = max(
1, int(os.getenv("STACKCHAIN_PUSH_MAX_CONCURRENCY", "8"))
)
while True: while True:
await asyncio.sleep(interval) await asyncio.sleep(interval)
try: try:
@ -97,6 +100,7 @@ async def _push_poll_loop() -> None:
session_active=dashboard_auth.managed_session_active, session_active=dashboard_auth.managed_session_active,
lease_seconds=lease_seconds, lease_seconds=lease_seconds,
send_timeout_seconds=send_timeout, send_timeout_seconds=send_timeout,
max_concurrency=max_concurrency,
) )
except asyncio.CancelledError: except asyncio.CancelledError:
raise raise

View File

@ -43,6 +43,7 @@ async def dispatch_unread_updates(
session_active: Callable[[str], Awaitable[bool]] | None = None, session_active: Callable[[str], Awaitable[bool]] | None = None,
lease_seconds: float = 60.0, lease_seconds: float = 60.0,
send_timeout_seconds: float = 10.0, send_timeout_seconds: float = 10.0,
max_concurrency: int = 8,
) -> int: ) -> int:
if not configuration.enabled: if not configuration.enabled:
return 0 return 0
@ -78,46 +79,62 @@ async def dispatch_unread_updates(
for delivery, active in zip(deliveries, authorized) for delivery, active in zip(deliveries, authorized)
if active if active
] ]
count = 0 semaphore = asyncio.Semaphore(max(1, max_concurrency))
for delivery in deliveries: ownership_lost = asyncio.Event()
for thread_id in delivery.thread_ids:
still_owner = await asyncio.to_thread( async def dispatch_device(delivery) -> int:
store.acquire_dispatch_lease, async with semaphore:
owner, if ownership_lost.is_set():
now=time.time(), return 0
lease_seconds=lease_seconds, count = 0
) for thread_id in delivery.thread_ids:
if not still_owner: still_owner = await asyncio.to_thread(
return count store.acquire_dispatch_lease,
payload = json.dumps( owner,
{ now=time.time(),
"title": "New work update", lease_seconds=lease_seconds,
"body": "Tap to review it in Stackchain.", )
"route": f"#/my-work/update/{thread_id}", if not still_owner:
"tag": f"stackchain-update-{thread_id}", ownership_lost.set()
}, return count
separators=(",", ":"), payload = json.dumps(
) {
try: "title": "New work update",
if send is None: "body": "Tap to review it in Stackchain.",
operation = send_web_push( "route": f"#/my-work/update/{thread_id}",
delivery.subscription, payload, configuration "tag": f"stackchain-update-{thread_id}",
},
separators=(",", ":"),
)
try:
if send is None:
operation = send_web_push(
delivery.subscription, payload, configuration
)
else:
operation = send(delivery.subscription, payload)
await asyncio.wait_for(operation, timeout=send_timeout_seconds)
except Exception as error:
status = getattr(
getattr(error, "response", None), "status_code", None
) )
else: if status in {404, 410}:
operation = send(delivery.subscription, payload) await asyncio.to_thread(
await asyncio.wait_for(operation, timeout=send_timeout_seconds) store.delete_session, delivery.session_id
except Exception as error: )
status = getattr(getattr(error, "response", None), "status_code", None) break
if status in {404, 410}: # Leave this device's transient failures unseen for a later
await asyncio.to_thread(store.delete_session, delivery.session_id) # poll instead of paying the endpoint deadline repeatedly.
break break
# A transient provider failure belongs to this endpoint; await asyncio.to_thread(
# leave it unseen for a later poll and continue fan-out. store.mark_delivered, delivery.session_id, (thread_id,)
continue )
await asyncio.to_thread( count += 1
store.mark_delivered, delivery.session_id, (thread_id,) return count
)
count += 1 counts = await asyncio.gather(
return count *(dispatch_device(delivery) for delivery in deliveries)
)
return sum(counts)
finally: finally:
await asyncio.to_thread(store.release_dispatch_lease, owner) await asyncio.to_thread(store.release_dispatch_lease, owner)

View File

@ -83,6 +83,7 @@ async def test_push_poll_authorizes_delivery_against_managed_session(monkeypatch
captured.update(kwargs) captured.update(kwargs)
raise asyncio.CancelledError raise asyncio.CancelledError
monkeypatch.setenv("STACKCHAIN_PUSH_MAX_CONCURRENCY", "3")
monkeypatch.setattr(main.asyncio, "sleep", no_wait) monkeypatch.setattr(main.asyncio, "sleep", no_wait)
monkeypatch.setattr(main, "dispatch_unread_updates", stop_after_capture) monkeypatch.setattr(main, "dispatch_unread_updates", stop_after_capture)
@ -90,6 +91,7 @@ async def test_push_poll_authorizes_delivery_against_managed_session(monkeypatch
await main._push_poll_loop() await main._push_poll_loop()
assert captured["session_active"] is dashboard_auth.managed_session_active assert captured["session_active"] is dashboard_auth.managed_session_active
assert captured["max_concurrency"] == 3
def test_replacing_subscription_resets_delivery_cursor_and_revocation_removes_device(tmp_path): def test_replacing_subscription_resets_delivery_cursor_and_revocation_removes_device(tmp_path):
@ -224,6 +226,38 @@ async def test_transient_endpoint_failure_does_not_block_healthy_devices(tmp_pat
assert store.claim_unseen({8})[0].session_id == "session-a" assert store.claim_unseen({8})[0].session_id == "session-a"
@pytest.mark.anyio
async def test_transient_failure_stops_that_device_until_the_next_poll(tmp_path):
store = PushSubscriptionStore(tmp_path / "push.sqlite3")
for session_id in ("failing-device", "healthy-device"):
store.upsert(session_id, {
"endpoint": f"https://push.example/{session_id}",
"keys": {"p256dh": "public-key", "auth": "auth-secret"},
})
attempts = []
async def unread():
return {"items": [
{"notification_id": 8},
{"notification_id": 9},
]}
async def send(subscription, payload):
endpoint = subscription["endpoint"]
thread_id = int(json.loads(payload)["route"].rsplit("/", 1)[1])
attempts.append((endpoint, thread_id))
if endpoint.endswith("failing-device"):
raise RuntimeError("provider unavailable")
config = PushConfiguration("public", "private", "mailto:ops@example.com")
assert await dispatch_unread_updates(store, config, unread, send) == 2
assert [item for item in attempts if item[0].endswith("failing-device")] == [
("https://push.example/failing-device", 8)
]
remaining = {item.session_id: item.thread_ids for item in store.claim_unseen({8, 9})}
assert remaining == {"failing-device": (8, 9)}
@pytest.mark.anyio @pytest.mark.anyio
async def test_timed_out_endpoint_does_not_stall_push_fanout(tmp_path): async def test_timed_out_endpoint_does_not_stall_push_fanout(tmp_path):
store = PushSubscriptionStore(tmp_path / "push.sqlite3") store = PushSubscriptionStore(tmp_path / "push.sqlite3")
@ -254,6 +288,45 @@ async def test_timed_out_endpoint_does_not_stall_push_fanout(tmp_path):
assert sent == ["https://push.example/session-b"] assert sent == ["https://push.example/session-b"]
@pytest.mark.anyio
async def test_dispatches_devices_concurrently_with_a_strict_bound(tmp_path):
store = PushSubscriptionStore(tmp_path / "push.sqlite3")
for index in range(4):
store.upsert(f"session-{index}", {
"endpoint": f"https://push.example/session-{index}",
"keys": {"p256dh": "public-key", "auth": "auth-secret"},
})
active = 0
peak = 0
bound_reached = asyncio.Event()
release = asyncio.Event()
async def unread():
return {"items": [{"notification_id": 13}]}
async def send(_subscription, _payload):
nonlocal active, peak
active += 1
peak = max(peak, active)
if active == 2:
bound_reached.set()
await release.wait()
active -= 1
config = PushConfiguration("public", "private", "mailto:ops@example.com")
dispatch = asyncio.create_task(dispatch_unread_updates(
store, config, unread, send, max_concurrency=2
))
await asyncio.wait_for(bound_reached.wait(), timeout=0.2)
assert peak == 2
assert dispatch.done() is False
release.set()
assert await dispatch == 4
assert peak == 2
@pytest.mark.anyio @pytest.mark.anyio
async def test_dispatch_removes_inactive_sessions_without_blocking_active_devices(tmp_path): async def test_dispatch_removes_inactive_sessions_without_blocking_active_devices(tmp_path):
store = PushSubscriptionStore(tmp_path / "push.sqlite3") store = PushSubscriptionStore(tmp_path / "push.sqlite3")