Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

fix(tracing): exclude called tool internals from external exports (#42823)

-LAN-4ac22a7316d8
diff --git a/api/core/ops/unified_trace/trace_builder.py b/api/core/ops/unified_trace/trace_builder.py
index 8390c89020a..2847bda22f7 100644
--- a/api/core/ops/unified_trace/trace_builder.py
+++ b/api/core/ops/unified_trace/trace_builder.py
@@ -41,7 +41,7 @@ ServiceAccountResolver = Callable[[str], Account]
class RepositoryWorkflowExecutionLoader:
- """Load one workflow's executions through the tenant-scoped core repository."""
+ """Export caller executions; Workflow Tool source internals stay in authorized console traces."""
def __init__(self, get_service_account: ServiceAccountResolver) -> None:
self._get_service_account = get_service_account
diff --git a/api/providers/trace/trace-mlflow/src/dify_trace_mlflow/mlflow_trace.py b/api/providers/trace/trace-mlflow/src/dify_trace_mlflow/mlflow_trace.py
index 17173acbbb5..c89a69b90f8 100644
--- a/api/providers/trace/trace-mlflow/src/dify_trace_mlflow/mlflow_trace.py
+++ b/api/providers/trace/trace-mlflow/src/dify_trace_mlflow/mlflow_trace.py
@@ -27,7 +27,7 @@ from dify_trace_mlflow.config import DatabricksConfig, MLflowConfig
from extensions.ext_database import db
from graphon.enums import BuiltinNodeTypes
from models import EndUser
-from models.workflow import WorkflowNodeExecutionModel
+from models.workflow import WorkflowNodeExecutionModel, WorkflowNodeExecutionTriggeredFrom
logger = logging.getLogger(__name__)
@@ -165,7 +165,7 @@ class MLflowDataTrace(BaseTraceInstance):
try:
# Create child spans for workflow nodes
- for node in self._get_workflow_nodes(trace_info.workflow_run_id):
+ for node in self._get_workflow_nodes(trace_info):
inputs = None
attributes: SpanAttributes = {
"node_id": node.id,
@@ -476,11 +476,19 @@ class MLflowDataTrace(BaseTraceInstance):
)
span.end(outputs=trace_info.outputs, end_time_ns=datetime_to_nanoseconds(trace_info.end_time))
- def _get_workflow_nodes(self, workflow_run_id: str):
- """Helper method to get workflow nodes"""
+ def _get_workflow_nodes(self, trace_info: WorkflowTraceInfo):
+ """Export caller nodes without disclosing Workflow Tool source internals."""
+ app_id = trace_info.metadata.get("app_id")
+ if not isinstance(app_id, str) or not app_id:
+ raise ValueError("No app_id found in workflow trace metadata")
workflow_nodes = db.session.scalars(
select(WorkflowNodeExecutionModel)
- .where(WorkflowNodeExecutionModel.workflow_run_id == workflow_run_id)
+ .where(
+ WorkflowNodeExecutionModel.workflow_run_id == trace_info.workflow_run_id,
+ WorkflowNodeExecutionModel.tenant_id == trace_info.tenant_id,
+ WorkflowNodeExecutionModel.app_id == app_id,
+ WorkflowNodeExecutionModel.triggered_from == WorkflowNodeExecutionTriggeredFrom.WORKFLOW_RUN,
+ )
.order_by(WorkflowNodeExecutionModel.created_at)
).all()
return workflow_nodes
diff --git a/api/providers/trace/trace-mlflow/tests/unit_tests/mlflow_trace/test_mlflow_trace.py b/api/providers/trace/trace-mlflow/tests/unit_tests/mlflow_trace/test_mlflow_trace.py
index 08c1b52c88f..7e1aa5f43f0 100644
--- a/api/providers/trace/trace-mlflow/tests/unit_tests/mlflow_trace/test_mlflow_trace.py
+++ b/api/providers/trace/trace-mlflow/tests/unit_tests/mlflow_trace/test_mlflow_trace.py
@@ -44,7 +44,7 @@ def _make_workflow_trace_info(**overrides) -> WorkflowTraceInfo:
"total_tokens": 10,
"file_list": [],
"query": "hello",
- "metadata": {"user_id": "u1", "conversation_id": "c1"},
+ "metadata": {"app_id": "app-1", "user_id": "u1", "conversation_id": "c1"},
"start_time": _dt(),
"end_time": _dt(),
}
@@ -502,7 +502,7 @@ class TestWorkflowTrace:
mock_tracing["set"].return_value = "token"
trace_info = _make_workflow_trace_info(
- metadata={},
+ metadata={"app_id": "app-1"},
conversation_id=None,
)
trace_instance.workflow_trace(trace_info)
@@ -860,9 +860,16 @@ class TestGenerateNameTrace:
class TestGetWorkflowNodes:
def test_queries_db(self, trace_instance, mock_db):
mock_db.session.scalars.return_value.all.return_value = ["n1", "n2"]
- result = trace_instance._get_workflow_nodes("run-1")
+ result = trace_instance._get_workflow_nodes(_make_workflow_trace_info())
assert result == ["n1", "n2"]
+ @pytest.mark.parametrize("metadata", [{}, {"app_id": ""}, {"app_id": 123}], ids=["missing", "empty", "non-string"])
+ def test_rejects_invalid_app_id_before_querying_nodes(self, metadata, trace_instance, mock_db):
+ with pytest.raises(ValueError, match="No app_id found in workflow trace metadata"):
+ trace_instance._get_workflow_nodes(_make_workflow_trace_info(metadata=metadata))
+
+ mock_db.session.scalars.assert_not_called()
+
# ── _get_node_span_type ─────────────────────────────────────────────────────
diff --git a/api/tests/unit_tests/core/ops/test_workflow_tool_export_boundary.py b/api/tests/unit_tests/core/ops/test_workflow_tool_export_boundary.py
new file mode 100644
index 00000000000..1402b82c34b
--- /dev/null
+++ b/api/tests/unit_tests/core/ops/test_workflow_tool_export_boundary.py
@@ -0,0 +1,125 @@
+"""External traces retain the caller's Tool contract without source workflow internals."""
+
+import json
+from datetime import datetime
+
+import pytest
+from sqlalchemy.orm import Session
+
+from core.ops.entities.trace_entity import WorkflowTraceInfo
+from core.ops.unified_trace.trace_builder import CanonicalTraceBuilder, RepositoryWorkflowExecutionLoader
+from extensions.ext_database import db
+from models import Account
+from models.enums import CreatorUserRole
+from models.workflow import WorkflowNodeExecutionModel, WorkflowNodeExecutionTriggeredFrom
+
+
[email protected]("exporter", ["canonical", "mlflow"])
+def test_external_workflow_trace_omits_source_internals(
+ exporter: str, sqlite_session: Session, monkeypatch: pytest.MonkeyPatch
+) -> None:
+ started_at = datetime(2025, 1, 1)
+ public_inputs = {"query": "public tool input"}
+ public_outputs = {"answer": "public tool output"}
+ for index, (execution_id, app_id, origin) in enumerate(
+ [
+ ("outer-tool", "caller-app", WorkflowNodeExecutionTriggeredFrom.WORKFLOW_RUN),
+ ("source-llm", "source-app", WorkflowNodeExecutionTriggeredFrom.WORKFLOW_TOOL),
+ ("recursive-llm", "caller-app", WorkflowNodeExecutionTriggeredFrom.WORKFLOW_TOOL),
+ ]
+ ):
+ is_outer = execution_id == "outer-tool"
+ sqlite_session.add(
+ WorkflowNodeExecutionModel(
+ id=execution_id,
+ tenant_id="tenant-1",
+ app_id=app_id,
+ workflow_id=f"{app_id}-workflow",
+ workflow_run_id="run-1",
+ triggered_from_workflow_id=None if is_outer else "caller-app-workflow",
+ triggered_from_node_execution_id=None if is_outer else "outer-tool",
+ triggered_from=origin,
+ index=index,
+ node_execution_id=execution_id,
+ node_id=execution_id,
+ node_type="tool" if is_outer else "llm",
+ title=execution_id,
+ inputs=json.dumps(public_inputs if is_outer else {"secret": "private source input"}),
+ outputs=json.dumps(public_outputs if is_outer else {"text": "private source output"}),
+ process_data=json.dumps(
+ {}
+ if is_outer
+ else {
+ "prompts": [{"role": "system", "text": "private source prompt"}],
+ "workflow_tool_root_app_id": "caller-app",
+ }
+ ),
+ status="succeeded",
+ elapsed_time=1,
+ created_at=started_at,
+ created_by_role=CreatorUserRole.ACCOUNT,
+ created_by="account-1",
+ )
+ )
+ sqlite_session.commit()
+ info = WorkflowTraceInfo(
+ tenant_id="tenant-1",
+ workflow_id="caller-workflow",
+ workflow_run_id="run-1",
+ workflow_run_elapsed_time=1,
+ workflow_run_status="succeeded",
+ workflow_run_inputs={},
+ workflow_run_outputs={},
+ workflow_run_version="1",
+ total_tokens=0,
+ file_list=[],
+ query="",
+ metadata={"app_id": "caller-app"},
+ start_time=started_at,
+ end_time=started_at,
+ )
+ monkeypatch.setattr(type(db), "engine", property(lambda _: sqlite_session.get_bind()))
+ monkeypatch.setattr(db, "session", sqlite_session)
+ if exporter == "canonical":
+ account = Account(name="Caller maintainer", email="[email protected]")
+ account.id = "account-1"
+ trace = CanonicalTraceBuilder(RepositoryWorkflowExecutionLoader(lambda _: account)).build(info)
+ assert trace is not None
+ assert len(trace.spans) == 2
+ payload = trace.model_dump_json()
+ tool = next(span for span in trace.spans if span.id == "outer-tool")
+ assert tool.inputs == public_inputs
+ assert tool.outputs == public_outputs
+ else:
+ from dify_trace_mlflow.config import MLflowConfig
+ from dify_trace_mlflow.mlflow_trace import MLflowDataTrace
+ from mlflow.entities import Span
+ from mlflow.tracing import provider
+ from mlflow.tracing.processor.mlflow_v3 import MlflowV3SpanProcessor
+ from mlflow.tracing.trace_manager import InMemoryTraceManager
+ from opentelemetry.sdk.trace import TracerProvider
+ from opentelemetry.sdk.trace.export.in_memory_span_exporter import InMemorySpanExporter
+
+ monkeypatch.setattr("dify_trace_mlflow.mlflow_trace.mlflow.set_tracking_uri", lambda _uri: None)
+ monkeypatch.setattr("dify_trace_mlflow.mlflow_trace.mlflow.set_experiment", lambda **_kwargs: None)
+ monkeypatch.setattr("mlflow.tracking.fluent._active_experiment_id", "0")
+ monkeypatch.setattr(InMemoryTraceManager, "_instance", InMemoryTraceManager())
+ monkeypatch.setenv("MLFLOW_ENABLE_ASYNC_TRACE_LOGGING", "true")
+ span_exporter = InMemorySpanExporter()
+ tracer_provider = TracerProvider()
+ tracer_provider.add_span_processor(MlflowV3SpanProcessor(span_exporter, export_metrics=False))
+ monkeypatch.setattr(provider, "_get_tracer", tracer_provider.get_tracer)
+ try:
+ MLflowDataTrace(MLflowConfig()).workflow_trace(info)
+ spans = [Span(span) for span in span_exporter.get_finished_spans()]
+ assert len(spans) == 2
+ payload = json.dumps([span.to_dict() for span in spans])
+ tool = next(span for span in spans if span.name == "outer-tool")
+ assert tool.inputs == public_inputs
+ assert tool.outputs == public_outputs
+ finally:
+ tracer_provider.shutdown()
+ assert "private source" not in payload
+ assert "source-llm" not in payload
+ assert "recursive-llm" not in payload
+ assert "workflow_tool_root_app_id" not in payload