|
| 1 | +"""Tests that LangSmithPlugin defers to ``langsmith.utils.tracing_is_enabled()``. |
| 2 | +
|
| 3 | +Tracing requires the env to explicitly say so (``LANGSMITH_TRACING=true`` etc); |
| 4 | +it is off when the env is unset or set to ``false``. Tests verify that |
| 5 | +``LANGSMITH_TRACING=false`` produces zero runs and ``LANGSMITH_TRACING=true`` |
| 6 | +produces runs. |
| 7 | +""" |
| 8 | + |
| 9 | +from __future__ import annotations |
| 10 | + |
| 11 | +import uuid |
| 12 | +from datetime import timedelta |
| 13 | + |
| 14 | +import pytest |
| 15 | +from langsmith import traceable |
| 16 | + |
| 17 | +from temporalio import activity, workflow |
| 18 | +from temporalio.client import Client |
| 19 | +from temporalio.testing import WorkflowEnvironment |
| 20 | +from tests.contrib.langsmith.test_integration import ( |
| 21 | + DirectTraceableNexusService, |
| 22 | + NexusDirectTraceableWorkflow, |
| 23 | + _make_client_and_collector, |
| 24 | +) |
| 25 | +from tests.helpers import new_worker |
| 26 | +from tests.helpers.nexus import make_nexus_endpoint_name |
| 27 | + |
| 28 | +# --------------------------------------------------------------------------- |
| 29 | +# Sample workflow / activity |
| 30 | +# --------------------------------------------------------------------------- |
| 31 | + |
| 32 | + |
| 33 | +@traceable(name="inner_call") |
| 34 | +async def _inner_call(prompt: str) -> str: |
| 35 | + return f"response to: {prompt}" |
| 36 | + |
| 37 | + |
| 38 | +@traceable |
| 39 | +@activity.defn |
| 40 | +async def env_override_activity() -> str: |
| 41 | + result = await _inner_call("hello") |
| 42 | + return result |
| 43 | + |
| 44 | + |
| 45 | +@workflow.defn |
| 46 | +class EnvOverrideWorkflow: |
| 47 | + @workflow.run |
| 48 | + async def run(self) -> str: |
| 49 | + return await workflow.execute_activity( |
| 50 | + env_override_activity, |
| 51 | + start_to_close_timeout=timedelta(seconds=10), |
| 52 | + ) |
| 53 | + |
| 54 | + |
| 55 | +# --------------------------------------------------------------------------- |
| 56 | +# Tests |
| 57 | +# --------------------------------------------------------------------------- |
| 58 | + |
| 59 | + |
| 60 | +class TestTracingEnvOverride: |
| 61 | + """LangSmithPlugin must respect LANGSMITH_TRACING=false.""" |
| 62 | + |
| 63 | + async def test_no_runs_when_tracing_disabled_with_temporal_runs( |
| 64 | + self, |
| 65 | + client: Client, |
| 66 | + env: WorkflowEnvironment, # type:ignore[reportUnusedParameter] |
| 67 | + monkeypatch: pytest.MonkeyPatch, |
| 68 | + ) -> None: |
| 69 | + """With LANGSMITH_TRACING=false and add_temporal_runs=True, no runs.""" |
| 70 | + monkeypatch.setenv("LANGSMITH_TRACING", "false") |
| 71 | + monkeypatch.delenv("LANGCHAIN_TRACING_V2", raising=False) |
| 72 | + |
| 73 | + temporal_client, collector, _ = _make_client_and_collector( |
| 74 | + client, add_temporal_runs=True |
| 75 | + ) |
| 76 | + |
| 77 | + async with new_worker( |
| 78 | + temporal_client, |
| 79 | + EnvOverrideWorkflow, |
| 80 | + activities=[env_override_activity], |
| 81 | + max_cached_workflows=0, |
| 82 | + ) as worker: |
| 83 | + handle = await temporal_client.start_workflow( |
| 84 | + EnvOverrideWorkflow.run, |
| 85 | + id=f"env-override-temporal-{uuid.uuid4()}", |
| 86 | + task_queue=worker.task_queue, |
| 87 | + ) |
| 88 | + result = await handle.result() |
| 89 | + |
| 90 | + assert result == "response to: hello" |
| 91 | + assert len(collector.runs) == 0, ( |
| 92 | + f"Expected zero LangSmith runs when LANGSMITH_TRACING=false, " |
| 93 | + f"but got {len(collector.runs)}: " |
| 94 | + f"{[r.name for r in collector.runs]}" |
| 95 | + ) |
| 96 | + |
| 97 | + async def test_no_runs_when_tracing_disabled_without_temporal_runs( |
| 98 | + self, |
| 99 | + client: Client, |
| 100 | + env: WorkflowEnvironment, # type:ignore[reportUnusedParameter] |
| 101 | + monkeypatch: pytest.MonkeyPatch, |
| 102 | + ) -> None: |
| 103 | + """With LANGSMITH_TRACING=false and add_temporal_runs=False, no runs.""" |
| 104 | + monkeypatch.setenv("LANGSMITH_TRACING", "false") |
| 105 | + monkeypatch.delenv("LANGCHAIN_TRACING_V2", raising=False) |
| 106 | + |
| 107 | + temporal_client, collector, _ = _make_client_and_collector( |
| 108 | + client, add_temporal_runs=False |
| 109 | + ) |
| 110 | + |
| 111 | + async with new_worker( |
| 112 | + temporal_client, |
| 113 | + EnvOverrideWorkflow, |
| 114 | + activities=[env_override_activity], |
| 115 | + max_cached_workflows=0, |
| 116 | + ) as worker: |
| 117 | + handle = await temporal_client.start_workflow( |
| 118 | + EnvOverrideWorkflow.run, |
| 119 | + id=f"env-override-no-temporal-{uuid.uuid4()}", |
| 120 | + task_queue=worker.task_queue, |
| 121 | + ) |
| 122 | + result = await handle.result() |
| 123 | + |
| 124 | + assert result == "response to: hello" |
| 125 | + assert len(collector.runs) == 0, ( |
| 126 | + f"Expected zero LangSmith runs when LANGSMITH_TRACING=false, " |
| 127 | + f"but got {len(collector.runs)}: " |
| 128 | + f"{[r.name for r in collector.runs]}" |
| 129 | + ) |
| 130 | + |
| 131 | + async def test_no_runs_when_langchain_tracing_v2_disabled( |
| 132 | + self, |
| 133 | + client: Client, |
| 134 | + env: WorkflowEnvironment, # type:ignore[reportUnusedParameter] |
| 135 | + monkeypatch: pytest.MonkeyPatch, |
| 136 | + ) -> None: |
| 137 | + """LANGCHAIN_TRACING_V2=false also suppresses runs (legacy env var).""" |
| 138 | + monkeypatch.setenv("LANGCHAIN_TRACING_V2", "false") |
| 139 | + monkeypatch.delenv("LANGSMITH_TRACING", raising=False) |
| 140 | + |
| 141 | + temporal_client, collector, _ = _make_client_and_collector( |
| 142 | + client, add_temporal_runs=True |
| 143 | + ) |
| 144 | + |
| 145 | + async with new_worker( |
| 146 | + temporal_client, |
| 147 | + EnvOverrideWorkflow, |
| 148 | + activities=[env_override_activity], |
| 149 | + max_cached_workflows=0, |
| 150 | + ) as worker: |
| 151 | + handle = await temporal_client.start_workflow( |
| 152 | + EnvOverrideWorkflow.run, |
| 153 | + id=f"env-override-v2-{uuid.uuid4()}", |
| 154 | + task_queue=worker.task_queue, |
| 155 | + ) |
| 156 | + result = await handle.result() |
| 157 | + |
| 158 | + assert result == "response to: hello" |
| 159 | + assert len(collector.runs) == 0, ( |
| 160 | + f"Expected zero LangSmith runs when LANGCHAIN_TRACING_V2=false, " |
| 161 | + f"but got {len(collector.runs)}: " |
| 162 | + f"{[r.name for r in collector.runs]}" |
| 163 | + ) |
| 164 | + |
| 165 | + async def test_no_runs_when_tracing_disabled_for_nexus_start( |
| 166 | + self, |
| 167 | + client: Client, |
| 168 | + env: WorkflowEnvironment, |
| 169 | + monkeypatch: pytest.MonkeyPatch, |
| 170 | + ) -> None: |
| 171 | + """With LANGSMITH_TRACING=false, nexus start handler emits no runs.""" |
| 172 | + if env.supports_time_skipping: |
| 173 | + pytest.skip("Time-skipping server doesn't persist headers.") |
| 174 | + |
| 175 | + monkeypatch.setenv("LANGSMITH_TRACING", "false") |
| 176 | + monkeypatch.delenv("LANGCHAIN_TRACING_V2", raising=False) |
| 177 | + |
| 178 | + temporal_client, collector, _ = _make_client_and_collector( |
| 179 | + client, add_temporal_runs=True |
| 180 | + ) |
| 181 | + |
| 182 | + task_queue = f"env-override-nexus-{uuid.uuid4()}" |
| 183 | + async with new_worker( |
| 184 | + temporal_client, |
| 185 | + NexusDirectTraceableWorkflow, |
| 186 | + nexus_service_handlers=[DirectTraceableNexusService()], |
| 187 | + task_queue=task_queue, |
| 188 | + max_cached_workflows=0, |
| 189 | + ) as worker: |
| 190 | + await env.create_nexus_endpoint( |
| 191 | + make_nexus_endpoint_name(worker.task_queue), |
| 192 | + worker.task_queue, |
| 193 | + ) |
| 194 | + handle = await temporal_client.start_workflow( |
| 195 | + NexusDirectTraceableWorkflow.run, |
| 196 | + id=f"env-override-nexus-{uuid.uuid4()}", |
| 197 | + task_queue=worker.task_queue, |
| 198 | + ) |
| 199 | + result = await handle.result() |
| 200 | + |
| 201 | + assert result == "response to: nexus-input" |
| 202 | + assert len(collector.runs) == 0, ( |
| 203 | + f"Expected zero LangSmith runs when LANGSMITH_TRACING=false " |
| 204 | + f"(nexus start path), but got {len(collector.runs)}: " |
| 205 | + f"{[r.name for r in collector.runs]}" |
| 206 | + ) |
| 207 | + |
| 208 | + # NOTE: test_no_runs_when_tracing_disabled_for_nexus_cancel is not |
| 209 | + # included — cancelling an in-flight nexus operation requires non-trivial |
| 210 | + # orchestration (long-running handler + external cancel signal). Flagged |
| 211 | + # for a follow-up ticket. |
| 212 | + |
| 213 | + async def test_runs_emitted_when_tracing_enabled( |
| 214 | + self, |
| 215 | + client: Client, |
| 216 | + env: WorkflowEnvironment, # type:ignore[reportUnusedParameter] |
| 217 | + monkeypatch: pytest.MonkeyPatch, |
| 218 | + ) -> None: |
| 219 | + """Positive control: with LANGSMITH_TRACING=true, runs ARE emitted.""" |
| 220 | + monkeypatch.setenv("LANGSMITH_TRACING", "true") |
| 221 | + monkeypatch.delenv("LANGCHAIN_TRACING_V2", raising=False) |
| 222 | + |
| 223 | + temporal_client, collector, _ = _make_client_and_collector( |
| 224 | + client, add_temporal_runs=True |
| 225 | + ) |
| 226 | + |
| 227 | + async with new_worker( |
| 228 | + temporal_client, |
| 229 | + EnvOverrideWorkflow, |
| 230 | + activities=[env_override_activity], |
| 231 | + max_cached_workflows=0, |
| 232 | + ) as worker: |
| 233 | + handle = await temporal_client.start_workflow( |
| 234 | + EnvOverrideWorkflow.run, |
| 235 | + id=f"env-enabled-{uuid.uuid4()}", |
| 236 | + task_queue=worker.task_queue, |
| 237 | + ) |
| 238 | + result = await handle.result() |
| 239 | + |
| 240 | + assert result == "response to: hello" |
| 241 | + assert ( |
| 242 | + len(collector.runs) > 0 |
| 243 | + ), "Expected LangSmith runs when LANGSMITH_TRACING=true, but got none" |
0 commit comments