refactor: Rename context setting functions and update their docstrings for clarity.

Author: RayBB

openlibrary/asgi_app.py

@@ -13,7 +13,7 @@
 from uvicorn.middleware.proxy_headers import ProxyHeadersMiddleware
 
 import infogami
-from openlibrary.utils.async_utils import set_context_for_async_request
+from openlibrary.utils.async_utils import set_context_from_fastapi
 from openlibrary.utils.sentry import Sentry, init_sentry
 
 logger = logging.getLogger("openlibrary.asgi_app")
@@ -166,7 +166,7 @@ async def add_fastapi_header(request: Request, call_next):
 
     @app.middleware("http")
     async def set_context(request: Request, call_next):
-        set_context_for_async_request(request)
+        set_context_from_fastapi(request)
         response = await call_next(request)
         return response
 

openlibrary/plugins/openlibrary/code.py

@@ -48,7 +48,7 @@
 from openlibrary.core.models import Edition
 from openlibrary.plugins.openlibrary import processors
 from openlibrary.plugins.openlibrary.stats import increment_error_count
-from openlibrary.utils.async_utils import set_context_for_sync_request
+from openlibrary.utils.async_utils import set_context_from_legacy_web_py
 from openlibrary.utils.isbn import canonical, isbn_10_to_isbn_13, isbn_13_to_isbn_10
 
 delegate.app.add_processor(processors.ReadableUrlProcessor())
@@ -113,7 +113,7 @@ def contextvars_processor(handler):
 
     def inner():
         # Now we are inside the new, empty context
-        set_context_for_sync_request()
+        set_context_from_legacy_web_py()
         return handler()
 
     return ctx.run(inner)

openlibrary/utils/async_utils.py

@@ -45,9 +45,7 @@ def wrapper(*args: P.args, **kwargs: P.kwargs) -> T:
 
 async_bridge = AsyncBridge()
 
-# ContextVariables
-# These are scoped to a specific request
-# Defining them here for now to keep things close together
+################### ContextVariables ###################
 
 
 @dataclass(frozen=True)
@@ -67,12 +65,9 @@ class RequestContextVars:
 site: ContextVar[Site] = ContextVar("site")
 
 
-def set_context_for_sync_request():
+def set_context_from_legacy_web_py() -> None:
     """
-    Sets the contextvars for the current request when called from web.py
-
-    create_site is ultimately temporary as we'll need an async version of site
-    That version should be usable without instantiating a site
+    Extracts context from the global web.ctx (sync) and populates ContextVars.
     """
     site.set(create_site())
     req_context.set(
@@ -83,15 +78,12 @@ def set_context_for_sync_request():
     )
 
 
-def set_context_for_async_request(request: Request):
+def set_context_from_fastapi(request: Request) -> None:
     """
-    These are set automatically in the middleware of fastapi
-    They are made available to all requests
-
-    BEFORE ADDING:
-    Please consider if we could feasibly just pass it down to the function instead
-    This is preferable for testable and maintainable code.
+    Extracts context from a FastAPI request (async) and populates ContextVars.
+    Should be called within the middleware stack.
     """
+    # NOTE: Avoid adding new fields here if they can be passed as function arguments instead.
     site.set(create_site())
     req_context.set(
         RequestContextVars(