mirror of
https://github.com/pewdiepie-archdaemon/odysseus.git
synced 2026-06-16 01:35:36 -04:00
Mazen Tamer Salah
f7a3605b16
fire() and fire_and_forget() scheduled delivery with bare create_task()/ loop.create_task() and kept no reference. asyncio holds only a weak reference to a task, so the GC could collect a delivery (or the fire() coroutine itself) before it completed, silently dropping the webhook. Track in-flight tasks in a set on the manager via a _spawn_tracked() helper that holds a strong reference for the task's lifetime and discards it on completion (add_done_callback), and route both schedule sites through it. Adds tests/test_webhook_task_refs.py.
56 lines
1.7 KiB
Python
56 lines
1.7 KiB
Python
"""Fire-and-forget webhook tasks must be referenced until they finish.
|
|
|
|
asyncio keeps only a weak reference to a bare create_task() result, so a
|
|
delivery task could be garbage-collected before it ran and the webhook silently
|
|
dropped. WebhookManager now holds a strong reference for the task's lifetime and
|
|
releases it on completion.
|
|
"""
|
|
import asyncio
|
|
import sys
|
|
|
|
# webhook_manager does `from src.database import SessionLocal, Webhook` at import
|
|
# time. The shared test harness stubs src.database without Webhook, so ensure the
|
|
# attribute exists before importing the manager. These tests never touch the DB
|
|
# (the manager is built via __new__), so a placeholder class is sufficient.
|
|
_db = sys.modules.get("src.database")
|
|
if _db is not None and not hasattr(_db, "Webhook"):
|
|
_db.Webhook = type("Webhook", (), {})
|
|
|
|
from src.webhook_manager import WebhookManager # noqa: E402
|
|
|
|
|
|
def test_spawn_tracked_holds_then_releases_reference():
|
|
async def run():
|
|
wm = WebhookManager.__new__(WebhookManager)
|
|
wm._bg_tasks = set()
|
|
|
|
gate = asyncio.Event()
|
|
|
|
async def work():
|
|
await gate.wait()
|
|
|
|
task = wm._spawn_tracked(work())
|
|
# Referenced while in flight (this is what stops GC from collecting it).
|
|
assert task in wm._bg_tasks
|
|
gate.set()
|
|
await task
|
|
# Reference released once done, so the set does not grow unbounded.
|
|
assert task not in wm._bg_tasks
|
|
|
|
asyncio.run(run())
|
|
|
|
|
|
def test_spawn_tracked_runs_the_coroutine():
|
|
async def run():
|
|
wm = WebhookManager.__new__(WebhookManager)
|
|
wm._bg_tasks = set()
|
|
ran = []
|
|
|
|
async def work():
|
|
ran.append(True)
|
|
|
|
await wm._spawn_tracked(work())
|
|
assert ran == [True]
|
|
|
|
asyncio.run(run())
|