Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
Restore the message field and organization_id on foreign stdlib log records (#8024)
Aaron Perezdb63d8e758bd
diff --git a/skyvern/forge/sdk/forge_log.py b/skyvern/forge/sdk/forge_log.pyindex 93befdf6d..fcbe89d65 100644--- a/skyvern/forge/sdk/forge_log.py+++ b/skyvern/forge/sdk/forge_log.py@@ -6,7 +6,7 @@ from types import TracebackTypefrom typing import Anyimport structlog-from structlog.typing import EventDict+from structlog.typing import EventDict, Processorfrom skyvern._version import __version__from skyvern.config import settings@@ -585,6 +585,13 @@ def setup_logger() -> None:+ additional_processors+ [skyvern_logs_processor, sample_logs_processor, structlog.stdlib.ProcessorFormatter.wrap_for_formatter],)+ # Foreign stdlib records never run the structlog chain above, so without these two a+ # record reaches Datadog with an empty message (its remapper reads `msg`, not `event`)+ # and no `organization_id` to group on. Order matters: `add_kv_pairs_to_msg` reads `msg`.+ foreign_msg_chain: list[Processor] = (+ [structlog.processors.EventRenamer("msg"), add_kv_pairs_to_msg] if settings.JSON_LOGGING else []+ )+handler = logging.StreamHandler()handler.setFormatter(structlog.stdlib.ProcessorFormatter(@@ -595,7 +602,8 @@ def setup_logger() -> None:structlog.stdlib.ExtraAdder(),add_error_processor,structlog.processors.format_exc_info,- ],+ ]+ + foreign_msg_chain,processors=[structlog.stdlib.add_log_level,structlog.stdlib.add_logger_name,diff --git a/tests/unit/test_forge_log_stdlib_extra.py b/tests/unit/test_forge_log_stdlib_extra.pyindex d5bd13c23..e79919dbe 100644--- a/tests/unit/test_forge_log_stdlib_extra.py+++ b/tests/unit/test_forge_log_stdlib_extra.py@@ -1,10 +1,26 @@from __future__ import annotations+import jsonimport logging+from collections.abc import Iterator+import pytest++from skyvern.config import settings+from skyvern.forge.sdk.core import skyvern_context+from skyvern.forge.sdk.core.skyvern_context import SkyvernContextfrom skyvern.forge.sdk.forge_log import setup_logger[email protected](autouse=True)+def _restore_root_logging() -> Iterator[None]:+ """setup_logger() replaces the root handler process-wide, so JSON-mode tests would+ otherwise leak that handler into every test that runs after them."""+ yield+ skyvern_context.reset()+ setup_logger()++def _render(record: logging.LogRecord) -> str:setup_logger()formatter = logging.getLogger().handlers[0].formatter@@ -12,6 +28,12 @@ def _render(record: logging.LogRecord) -> str:return formatter.format(record)+def _render_json(record: logging.LogRecord, monkeypatch: pytest.MonkeyPatch) -> dict[str, str]:+ """Render through the JSON branch — the one production and staging run."""+ monkeypatch.setattr(settings, "JSON_LOGGING", True)+ return json.loads(_render(record))++def _foreign_record(**extra: str) -> logging.LogRecord:"""A stdlib record shaped like `LOG.warning(msg, extra={...})` produces."""record = logging.LogRecord(@@ -52,3 +74,33 @@ def test_stdlib_record_without_extra_still_renders() -> None:rendered = _render(_foreign_record())assert "CodeBlock runner unavailable" in rendered+++def test_json_foreign_record_keeps_its_message_alongside_extra_fields(monkeypatch: pytest.MonkeyPatch) -> None:+ # The two tests above pass under the console renderer whether or not the JSON branch+ # works. In production this record arrived with an empty message and the text+ # stranded under `event`, because Datadog's remapper reads `msg`.+ payload = _render_json(+ _foreign_record(+ runner_target="127.0.0.1:7819",+ unavailable_cause="grpc_unavailable",+ grpc_status="UNAVAILABLE",+ ),+ monkeypatch,+ )++ assert payload.get("msg", "").startswith("CodeBlock runner unavailable")+ assert "event" not in payload+ assert payload["unavailable_cause"] == "grpc_unavailable"+ assert payload["runner_target"] == "127.0.0.1:7819"+ assert payload["grpc_status"] == "UNAVAILABLE"+++def test_json_foreign_record_carries_organization_id_from_context(monkeypatch: pytest.MonkeyPatch) -> None:+ # The runner-unavailable alert groups by organization_id. A foreign record cannot bind+ # structlog context itself, so it has to be stamped from the ambient SkyvernContext.+ skyvern_context.set(SkyvernContext(organization_id="o_test_organization"))++ payload = _render_json(_foreign_record(unavailable_cause="grpc_unavailable"), monkeypatch)++ assert payload["organization_id"] == "o_test_organization"