Skip to content

A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.

fix: cleanup kernel threads in test_middleware.py (#7842)

Akshay Agrawal7c176a1fb401
diff --git a/tests/_server/api/test_middleware.py b/tests/_server/api/test_middleware.py
index d181922c7b..cb2458d550 100644
--- a/tests/_server/api/test_middleware.py
+++ b/tests/_server/api/test_middleware.py
@@ -31,6 +31,7 @@ from marimo._server.session_manager import SessionManager
from marimo._server.tokens import AuthToken
from marimo._session.model import SessionMode
from marimo._utils.net import find_free_port
+from tests._server.conftest import join_kernel_tasks
from tests._server.mocks import get_mock_session_manager, token_header
if TYPE_CHECKING:
@@ -167,13 +168,18 @@ def edit_app() -> Starlette:
@pytest.fixture
def read_app() -> Starlette:
+ main = sys.modules["__main__"]
app = create_starlette_app(base_url="")
# Mock out the server
with_server(app)
- init_state(
- session_manager=get_mock_session_manager(mode=SessionMode.RUN),
- ).apply(app.state)
- return app
+ session_manager = get_mock_session_manager(mode=SessionMode.RUN)
+ init_state(session_manager=session_manager).apply(app.state)
+ yield app
+
+ try:
+ join_kernel_tasks(session_manager)
+ finally:
+ sys.modules["__main__"] = main
@pytest.fixture(params=["read_app", "edit_app"])
@@ -196,6 +202,7 @@ def no_auth_edit_app() -> Starlette:
@pytest.fixture
def no_auth_read_app() -> Starlette:
+ main = sys.modules["__main__"]
app = create_starlette_app(base_url="", enable_auth=False)
session_manager = get_mock_session_manager(mode=SessionMode.RUN)
# no auth
@@ -204,7 +211,13 @@ def no_auth_read_app() -> Starlette:
init_state(session_manager=session_manager, enable_auth=False).apply(
app.state
)
- return app
+
+ yield app
+
+ try:
+ join_kernel_tasks(session_manager)
+ finally:
+ sys.modules["__main__"] = main
@pytest.fixture(params=["no_auth_read_app", "no_auth_edit_app"])
diff --git a/tests/_server/conftest.py b/tests/_server/conftest.py
index 3bef2e51b1..f1d78c334d 100644
--- a/tests/_server/conftest.py
+++ b/tests/_server/conftest.py
@@ -2,7 +2,6 @@
from __future__ import annotations
import sys
-import threading
from pathlib import Path
from tempfile import TemporaryDirectory
from typing import TYPE_CHECKING
@@ -30,6 +29,24 @@ if TYPE_CHECKING:
_module_app = create_starlette_app(base_url="", enable_auth=True)
+def join_kernel_tasks(session_manager: SessionManager) -> None:
+ # Kernels started in run mode run in their own threads; if these kernels
+ # execute code, they may patch and restore their own main modules.
+ # To ensure that this fixture correctly restores the original saved
+ # main module, we wait for threads to finish before restoring the module.
+ kernel_tasks = []
+ for session in session_manager.sessions.values():
+ assert isinstance(session, SessionImpl)
+ kernel_task = session._kernel_manager.kernel_task
+ if kernel_task is not None:
+ kernel_tasks.append(kernel_task)
+
+ session_manager.shutdown()
+ for task in kernel_tasks:
+ if task.is_alive():
+ task.join()
+
+
@pytest.fixture(scope="session", autouse=True)
def init() -> bool:
initialize_asyncio()
@@ -90,24 +107,7 @@ def client(user_config_manager: UserConfigManager) -> Iterator[TestClient]:
yield client
try:
- session_manager: SessionManager = client.app.state.session_manager
- kernel_tasks = []
- # Kernels started in run mode run in their own threads; if these kernels
- # execute code, they may patch and restore their own main modules.
- # To ensure that this fixture correctly restores the original saved
- # main module, we wait for threads to finish before restoring the module.
- for session in session_manager.sessions.values():
- assert isinstance(session, SessionImpl)
- kernel_task = session._kernel_manager.kernel_task
- if kernel_task is not None and isinstance(
- kernel_task, threading.Thread
- ):
- kernel_tasks.append(kernel_task)
-
- session_manager.shutdown()
- for task in kernel_tasks:
- if task.is_alive():
- task.join()
+ join_kernel_tasks(client.app.state.session_manager)
finally:
sys.modules["__main__"] = main