Files
arc53--docsgpt/tests/agents/test_workflow_input_documents.py
T
wehub-resource-sync fed8b2eed7
Backend release / release (push) Waiting to run
Bandit Security Scan / bandit_scan (push) Waiting to run
Build and push multi-arch DocsGPT Docker image / build (linux/amd64, ubuntu-latest, amd64) (push) Waiting to run
Build and push multi-arch DocsGPT Docker image / build (linux/arm64, ubuntu-24.04-arm, arm64) (push) Waiting to run
Build and push multi-arch DocsGPT Docker image / manifest (push) Blocked by required conditions
Build and push DocsGPT FE Docker image for development / build (linux/amd64, ubuntu-latest, amd64) (push) Waiting to run
Build and push DocsGPT FE Docker image for development / build (linux/arm64, ubuntu-24.04-arm, arm64) (push) Waiting to run
Build and push DocsGPT FE Docker image for development / manifest (push) Blocked by required conditions
Python linting / ruff (push) Waiting to run
Run python tests with pytest / Run tests and count coverage (3.12) (push) Waiting to run
React Widget Build / build (push) Waiting to run
chore: import upstream snapshot with attribution
2026-07-13 13:28:29 +08:00

595 lines
23 KiB
Python

"""Workflow input-document bridge: uploaded attachments become run-scoped artifacts.
The agent pre-creates the ``workflow_runs`` row, re-persists each attachment's bytes
through the canonical artifact path (server-side size/sha256/storage key), and passes
the resulting references into the run as ``initial_inputs["input_documents"]`` so nodes
can read ``agent.input_documents``.
"""
from __future__ import annotations
import hashlib
import io
import uuid
import pytest
from sqlalchemy import text
from application.agents.workflow_agent import WorkflowAgent, _MAX_INPUT_DOCUMENTS
from application.agents.workflows.schemas import AgentNodeConfig
from application.agents.workflows.workflow_engine import (
_EXTRACT_TRUNCATION_ID,
WorkflowEngine,
)
from application.storage.db.repositories.artifacts import ArtifactsRepository
from application.storage.db.repositories.workflow_runs import WorkflowRunsRepository
from application.storage.local import LocalStorage
from application.storage.storage_creator import StorageCreator
pytestmark = pytest.mark.integration
OWNER = "user-bridge"
# A distinct caller for the shared-agent case (caller != workflow owner).
RUNNER = "user-runner"
def _wire(pg_engine, tmp_path, monkeypatch) -> LocalStorage:
"""Point storage + the db session at the ephemeral fixtures."""
storage = LocalStorage(base_dir=str(tmp_path))
monkeypatch.setattr(StorageCreator, "_instance", storage, raising=False)
monkeypatch.setattr("application.storage.db.session.get_engine", lambda: pg_engine)
return storage
def _make_workflow(pg_engine, owner: str = OWNER) -> str:
"""Insert an owned workflow row and return its id."""
wf_id = str(uuid.uuid4())
with pg_engine.begin() as conn:
conn.execute(
text(
"INSERT INTO workflows (id, user_id, name, current_graph_version) "
"VALUES (CAST(:id AS uuid), :uid, :name, 1)"
),
{"id": wf_id, "uid": owner, "name": "Bridge WF"},
)
return wf_id
def _stage_attachment(storage: LocalStorage, data: bytes, filename: str, mime: str) -> dict:
"""Write attachment bytes to storage and return the attachment dict shape."""
upload_path = f"inputs/{OWNER}/attachments/{uuid.uuid4()}_{filename}"
storage.save_file(io.BytesIO(data), upload_path)
return {
"id": str(uuid.uuid4()),
"filename": filename,
"upload_path": upload_path,
"path": upload_path,
"mime_type": mime,
"size": len(data),
"user_id": OWNER,
}
def _agent(workflow_id, attachments, owner: str = OWNER) -> WorkflowAgent:
"""Build a WorkflowAgent without invoking the LLM-creating base __init__."""
agent = WorkflowAgent.__new__(WorkflowAgent)
agent.workflow_id = workflow_id
agent.workflow_owner = owner
agent.decoded_token = {"sub": owner}
agent.attachments = attachments
agent.chat_history = []
agent.retrieved_docs = []
agent._workflow_data = None
agent._engine = None
agent._run_persisted = False
agent._bridge_error = None
return agent
_EMBEDDED_GRAPH = {
"name": "Draft",
"nodes": [
{"id": "n1", "type": "start", "title": "Start"},
{"id": "n2", "type": "end", "title": "End", "data": {}},
],
"edges": [{"id": "e1", "source": "n1", "target": "n2"}],
}
class _RecordingEngine(WorkflowEngine):
"""Engine that records initial_inputs and runs the run-row existence probe."""
probe = None
instances: list = []
def __init__(self, graph, agent, workflow_run_id=None):
super().__init__(graph, agent, workflow_run_id=workflow_run_id)
self.captured_inputs = None
_RecordingEngine.instances.append(self)
def execute(self, initial_inputs, query):
self.captured_inputs = initial_inputs
if _RecordingEngine.probe is not None:
_RecordingEngine.probe(self.workflow_run_id)
self._initialize_state(initial_inputs, query)
return iter(())
def _patch_engine(monkeypatch, probe=None) -> None:
"""Make ``_gen_inner`` build the recording engine and reset its capture state."""
_RecordingEngine.instances = []
_RecordingEngine.probe = probe
monkeypatch.setattr(
"application.agents.workflow_agent.WorkflowEngine", _RecordingEngine
)
def test_attachments_bridge_to_run_scoped_artifacts(pg_engine, tmp_path, monkeypatch):
"""N attachments -> N run-scoped artifacts + input_documents refs; nodes can read them."""
storage = _wire(pg_engine, tmp_path, monkeypatch)
wf_id = _make_workflow(pg_engine)
a1 = b"report-one-bytes"
a2 = b"second attachment payload"
attachments = [
_stage_attachment(storage, a1, "report.txt", "text/plain"),
_stage_attachment(storage, a2, "data.csv", "text/csv"),
]
agent = _agent(wf_id, attachments)
run_seen = {}
def _probe(run_id):
with pg_engine.connect() as conn:
run_seen["row"] = WorkflowRunsRepository(conn).get(run_id)
_patch_engine(monkeypatch, probe=_probe)
list(agent._gen_inner("summarize", log_context=None))
engine = _RecordingEngine.instances[-1]
# The run row existed BEFORE execute (so a mid-run download would authz).
assert run_seen["row"] is not None
assert run_seen["row"]["user_id"] == OWNER
# initial_inputs carried the refs into the run.
refs = engine.captured_inputs["input_documents"]
assert len(refs) == 2
assert {r["filename"] for r in refs} == {"report.txt", "data.csv"}
assert all(r["artifact_id"] for r in refs)
assert refs[0]["ref"] == "A1"
assert refs[1]["ref"] == "A2"
# N run-scoped artifacts persisted, parented to THIS run, server-computed size/sha256.
run_id = engine.workflow_run_id
with pg_engine.connect() as conn:
repo = ArtifactsRepository(conn)
by_name = {}
for ref, payload in zip(refs, (a1, a2)):
artifact = repo.get_artifact_in_parent(ref["artifact_id"], workflow_run_id=run_id)
assert artifact is not None
assert artifact["kind"] == "file"
version = repo.get_version(ref["artifact_id"], 1)
assert version["size"] == len(payload)
assert version["sha256"] == hashlib.sha256(payload).hexdigest()
by_name[version["filename"]] = version
assert set(by_name) == {"report.txt", "data.csv"}
assert by_name["report.txt"]["size"] == len(a1)
# A node/template can read agent.input_documents from the engine state.
context = engine._build_template_context()
assert context["agent"]["input_documents"] == refs
assert len(context["agent"]["input_documents"]) == 2
# The bytes round-trip from storage (never entered state).
with pg_engine.connect() as conn:
v = ArtifactsRepository(conn).get_version(refs[0]["artifact_id"], 1)
with storage.get_file(v["storage_path"]) as fh:
assert fh.read() == a1
def test_shared_agent_run_and_artifacts_owned_by_caller(pg_engine, tmp_path, monkeypatch):
"""Shared agent (caller != owner): the run + bridged artifacts are owned by the caller.
The workflow row is still resolved against its owner, but the run.user_id and
the artifact owner are the caller, so quota is charged to the uploader and the
caller (not the agent owner) can read the run's artifacts.
"""
storage = _wire(pg_engine, tmp_path, monkeypatch)
wf_id = _make_workflow(pg_engine, owner=OWNER)
attachments = [_stage_attachment(storage, b"caller-doc", "c.txt", "text/plain")]
agent = _agent(wf_id, attachments, owner=OWNER)
# Simulate a shared-agent invocation: caller identity differs from the owner.
agent.initial_user_id = RUNNER
agent.user = RUNNER
_patch_engine(monkeypatch)
list(agent._gen_inner("summarize", log_context=None))
engine = _RecordingEngine.instances[-1]
run_id = engine.workflow_run_id
with pg_engine.connect() as conn:
run = WorkflowRunsRepository(conn).get(run_id)
assert run is not None
# The run is owned by the caller, not the workflow owner.
assert run["user_id"] == RUNNER
refs = engine.captured_inputs["input_documents"]
assert len(refs) == 1
owner_row = conn.execute(
text("SELECT user_id FROM artifacts WHERE workflow_run_id = CAST(:r AS uuid)"),
{"r": run_id},
).fetchone()
assert owner_row[0] == RUNNER
# authz: the caller can reach the run's artifacts; the agent owner cannot.
# ``authorize_artifact`` uses the passed conn but reads ``request.args`` for a
# share token, so it needs a request context.
from flask import Flask
from application.api.user.artifacts.authz import Principal, authorize_artifact
app = Flask(__name__)
with app.test_request_context():
with pg_engine.connect() as conn:
artifact = ArtifactsRepository(conn).get_artifact(refs[0]["artifact_id"])
assert authorize_artifact(conn, artifact, Principal(user_id=RUNNER)) is True
assert authorize_artifact(conn, artifact, Principal(user_id=OWNER)) is False
def test_code_state_excludes_chat_history(pg_engine, tmp_path, monkeypatch):
"""A code node's state.json projection omits the caller's chat_history."""
_wire(pg_engine, tmp_path, monkeypatch)
wf_id = _make_workflow(pg_engine)
agent = _agent(wf_id, [], owner=OWNER)
agent.chat_history = [{"prompt": "secret question", "response": "secret answer"}]
_patch_engine(monkeypatch)
list(agent._gen_inner("do it", log_context=None))
engine = _RecordingEngine.instances[-1]
projected = engine._json_safe_state()
# chat_history is set in state but must never be staged for sandboxed code.
assert "chat_history" in engine.state
assert "chat_history" not in projected
# Legitimate state (the query, node inputs) is still exposed.
assert projected.get("query") == "do it"
def test_attachments_capped_per_run(pg_engine, tmp_path, monkeypatch):
"""More than the cap of attachments bridges only the cap; the rest are dropped."""
storage = _wire(pg_engine, tmp_path, monkeypatch)
wf_id = _make_workflow(pg_engine)
over = _MAX_INPUT_DOCUMENTS + 5
attachments = [
_stage_attachment(storage, f"doc-{i}".encode(), f"f{i}.txt", "text/plain")
for i in range(over)
]
agent = _agent(wf_id, attachments)
_patch_engine(monkeypatch)
list(agent._gen_inner("summarize", log_context=None))
engine = _RecordingEngine.instances[-1]
refs = engine.captured_inputs["input_documents"]
assert len(refs) == _MAX_INPUT_DOCUMENTS
run_id = engine.workflow_run_id
with pg_engine.connect() as conn:
n = conn.execute(
text(
"SELECT count(*) FROM artifacts WHERE workflow_run_id = CAST(:r AS uuid)"
),
{"r": run_id},
).scalar()
assert n == _MAX_INPUT_DOCUMENTS
def test_run_row_precreated_before_execute(pg_engine, tmp_path, monkeypatch):
"""An owned workflow pre-inserts the run row keyed by the engine run id."""
_wire(pg_engine, tmp_path, monkeypatch)
wf_id = _make_workflow(pg_engine)
agent = _agent(wf_id, [])
_patch_engine(monkeypatch)
list(agent._gen_inner("go", log_context=None))
engine = _RecordingEngine.instances[-1]
with pg_engine.connect() as conn:
run = WorkflowRunsRepository(conn).get(engine.workflow_run_id)
assert run is not None
assert run["user_id"] == OWNER
assert str(run["workflow_id"]) == wf_id
# Finalized to a terminal status after the run completes.
assert run["status"] == "completed"
assert run["ended_at"] is not None
def test_unowned_workflow_creates_no_run_row(pg_engine, tmp_path, monkeypatch):
"""A draft/unowned workflow id never persists a run row and skips the bridge."""
storage = _wire(pg_engine, tmp_path, monkeypatch)
# Embedded (draft) graph whose id is NOT an owned workflow row: the run
# executes but no run row is persisted and the bridge is skipped.
attachments = [_stage_attachment(storage, b"x", "f.txt", "text/plain")]
agent = _agent(str(uuid.uuid4()), attachments)
agent._workflow_data = _EMBEDDED_GRAPH
_patch_engine(monkeypatch)
list(agent._gen_inner("go", log_context=None))
engine = _RecordingEngine.instances[-1]
with pg_engine.connect() as conn:
run = WorkflowRunsRepository(conn).get(engine.workflow_run_id)
# No bridged artifacts either (would be orphaned without a parent row).
n = conn.execute(
text(
"SELECT count(*) FROM artifacts WHERE workflow_run_id = CAST(:r AS uuid)"
),
{"r": engine.workflow_run_id},
).scalar()
assert run is None
assert n == 0
assert engine.captured_inputs["input_documents"] == []
def test_no_attachments_run_still_works(pg_engine, tmp_path, monkeypatch):
"""A run with no attachments produces empty input_documents and no artifacts."""
_wire(pg_engine, tmp_path, monkeypatch)
wf_id = _make_workflow(pg_engine)
agent = _agent(wf_id, [])
_patch_engine(monkeypatch)
list(agent._gen_inner("go", log_context=None))
engine = _RecordingEngine.instances[-1]
assert engine.captured_inputs["input_documents"] == []
with pg_engine.connect() as conn:
run = WorkflowRunsRepository(conn).get(engine.workflow_run_id)
n = conn.execute(
text(
"SELECT count(*) FROM artifacts WHERE workflow_run_id = CAST(:r AS uuid)"
),
{"r": engine.workflow_run_id},
).scalar()
assert run is not None
assert n == 0
def test_quota_exceeded_fails_run_and_does_not_execute(pg_engine, tmp_path, monkeypatch):
"""Over quota: the bridge raises, an error is surfaced, the run is finalized FAILED,
and the engine never executes with silently-missing documents."""
storage = _wire(pg_engine, tmp_path, monkeypatch)
wf_id = _make_workflow(pg_engine)
attachments = [_stage_attachment(storage, b"doc", "d.txt", "text/plain")]
agent = _agent(wf_id, attachments)
_patch_engine(monkeypatch)
from application.sandbox.artifacts_capture import QuotaExceeded
def _raise_quota(**kwargs):
raise QuotaExceeded("artifact storage quota reached")
monkeypatch.setattr(
"application.sandbox.artifacts_capture.persist_new_artifact", _raise_quota
)
events = list(agent._gen_inner("summarize", log_context=None))
engine = _RecordingEngine.instances[-1]
# A fatal error was surfaced on the stream, flagged user_facing so the route's
# sanitize_api_error does not rewrite the "quota" wording into a rate-limit message.
errors = [e for e in events if e.get("type") == "error"]
assert errors and "quota" in errors[0]["error"].lower()
assert errors[0].get("user_facing") is True
# The engine never executed (execute was not reached -> no captured inputs).
assert engine.captured_inputs is None
# The pre-created RUNNING row was finalized FAILED (not left dangling), and no
# artifact rows were persisted for the run.
with pg_engine.connect() as conn:
run = WorkflowRunsRepository(conn).get(engine.workflow_run_id)
n = conn.execute(
text("SELECT count(*) FROM artifacts WHERE workflow_run_id = CAST(:r AS uuid)"),
{"r": engine.workflow_run_id},
).scalar()
assert run is not None
assert run["status"] == "failed"
assert n == 0
def test_oversize_declared_attachment_skipped_with_notice(pg_engine, tmp_path, monkeypatch):
"""A declared-oversize attachment is dropped with a surfaced notice; the run still proceeds."""
from application.core.settings import settings
storage = _wire(pg_engine, tmp_path, monkeypatch)
wf_id = _make_workflow(pg_engine)
att = _stage_attachment(storage, b"tiny", "big.txt", "text/plain")
att["size"] = int(settings.ARTIFACT_MAX_BYTES) + 1 # declared past the per-file cap
agent = _agent(wf_id, [att])
_patch_engine(monkeypatch)
events = list(agent._gen_inner("summarize", log_context=None))
engine = _RecordingEngine.instances[-1]
# The oversize doc was dropped -> no input documents bridged, but the run ran.
assert engine.captured_inputs is not None
assert engine.captured_inputs["input_documents"] == []
# A non-fatal notice naming the dropped document was surfaced as a ``notice``
# (NOT an ``error``, which is terminal client-side) so the run still completes.
notices = [e for e in events if e.get("type") == "notice"]
assert notices and "big.txt" in notices[0]["notice"]
# It must not be an error event (that would fail the turn and disable reconnect).
assert not [e for e in events if e.get("type") == "error"]
# Nothing was persisted for the oversize doc.
with pg_engine.connect() as conn:
n = conn.execute(
text("SELECT count(*) FROM artifacts WHERE workflow_run_id = CAST(:r AS uuid)"),
{"r": engine.workflow_run_id},
).scalar()
assert n == 0
def test_read_attachment_bytes_closes_handle_on_bounded_read():
"""The bounded read pulls at most max_bytes+1 and always closes the storage handle."""
class _Handle:
def __init__(self, data: bytes) -> None:
self._data = data
self.closed = False
def read(self, n: int = -1) -> bytes:
return self._data if n is None or n < 0 else self._data[:n]
def close(self) -> None:
self.closed = True
handle = _Handle(b"x" * 100)
class _Storage:
def get_file(self, _path):
return handle
data = WorkflowAgent._read_attachment_bytes(_Storage(), "p", max_bytes=10)
assert data == b"x" * 11 # bounded to max_bytes + 1 (backstops a lying size)
assert handle.closed is True # handle is never left open
def test_extract_parse_opts_out_of_sync_subtask_guard(monkeypatch):
"""_parse_document_text awaits with disable_sync_subtasks=False so it works inside a Celery worker."""
agent = _agent(str(uuid.uuid4()), [])
engine = WorkflowEngine.__new__(WorkflowEngine)
engine.agent = agent
engine.workflow_run_id = "run-extract"
import application.api.user.tasks as tasks
captured: dict = {}
class _FakeAsyncResult:
def __init__(self):
self.get_kwargs = None
def get(self, timeout=None, disable_sync_subtasks=True):
self.get_kwargs = {"timeout": timeout, "disable_sync_subtasks": disable_sync_subtasks}
return {"status": "ok", "content": "parsed markdown"}
def _apply_async(args=None, queue=None, **kw):
result = _FakeAsyncResult()
captured["result"] = result
captured["args"] = args
return result
monkeypatch.setattr(tasks.parse_document, "apply_async", _apply_async)
out = engine._parse_document_text("artifact-xyz")
assert out == "parsed markdown"
# A prefork worker's task_join_will_block() is process-wide, so the await must
# opt out of the guard or get() raises RuntimeError("Never call result.get()...").
assert captured["result"].get_kwargs["disable_sync_subtasks"] is False
# The run-scoped parent + resolved id reached the parsing task.
assert captured["args"][0] == "artifact-xyz"
assert captured["args"][1] == {"workflow_run_id": "run-extract"}
def test_node_extract_path_capped_with_truncation_note(pg_engine, tmp_path, monkeypatch):
"""A node referencing more docs than the extract cap parses only up to the cap and notes the rest."""
storage = _wire(pg_engine, tmp_path, monkeypatch)
wf_id = _make_workflow(pg_engine)
# docx is non-native (no vision) and not inline-text, so each routes through
# the blocking parsing worker -- the path the per-node cap must bound.
docx = "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
attachments = [
_stage_attachment(storage, f"doc-{i}".encode(), f"f{i}.docx", docx)
for i in range(4)
]
agent = _agent(wf_id, attachments)
_patch_engine(monkeypatch)
list(agent._gen_inner("summarize", log_context=None))
engine = _RecordingEngine.instances[-1]
# Cap the blocking-extract path below the doc count so the overflow truncates.
from application.core.settings import settings
monkeypatch.setattr(settings, "WORKFLOW_NODE_EXTRACT_MAX_FILES", 2, raising=False)
# Stub the parsing worker so each non-text doc "parses" without a broker, and
# count the blocking calls to prove the overflow docs are never enqueued.
import application.api.user.tasks as tasks
parse_calls = {"n": 0}
class _R:
def get(self, timeout=None, disable_sync_subtasks=True):
return {"status": "ok", "content": "PARSED"}
def _apply_async(args=None, queue=None, **kw):
parse_calls["n"] += 1
return _R()
monkeypatch.setattr(tasks.parse_document, "apply_async", _apply_async)
node_config = AgentNodeConfig(input_documents=["*"])
out = engine._materialize_node_attachments(node_config, "Reviewer", supported_types=[])
notes = [a for a in out if a.get("id") == _EXTRACT_TRUNCATION_ID]
extracted = [a for a in out if a.get("id") != _EXTRACT_TRUNCATION_ID]
# Only the cap was extracted; the remaining docs were never sent to the worker.
assert len(extracted) == 2
assert parse_calls["n"] == 2
# A single non-fatal truncation note is appended to the node's inlined text.
assert len(notes) == 1
assert notes[0]["mime_type"] == "text/plain"
assert "omitted" in notes[0]["content"].lower()
def test_node_extract_cap_bounds_parse_attempts_even_when_every_parse_times_out(
pg_engine, tmp_path, monkeypatch
):
"""The cap must bound parse ATTEMPTS, not successes: a degraded backend where every
parse times out (~120s each) must still issue at most the cap's worth of blocking calls."""
from celery.exceptions import TimeoutError as CeleryTimeoutError
storage = _wire(pg_engine, tmp_path, monkeypatch)
wf_id = _make_workflow(pg_engine)
docx = "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
attachments = [
_stage_attachment(storage, f"doc-{i}".encode(), f"f{i}.docx", docx)
for i in range(4)
]
agent = _agent(wf_id, attachments)
_patch_engine(monkeypatch)
list(agent._gen_inner("summarize", log_context=None))
engine = _RecordingEngine.instances[-1]
from application.core.settings import settings
monkeypatch.setattr(settings, "WORKFLOW_NODE_EXTRACT_MAX_FILES", 2, raising=False)
import application.api.user.tasks as tasks
parse_calls = {"n": 0}
class _R:
def get(self, timeout=None, disable_sync_subtasks=True):
raise CeleryTimeoutError() # the ~120s worst case the cap must bound
def _apply_async(args=None, queue=None, **kw):
parse_calls["n"] += 1
return _R()
monkeypatch.setattr(tasks.parse_document, "apply_async", _apply_async)
node_config = AgentNodeConfig(input_documents=["*"])
out = engine._materialize_node_attachments(node_config, "Reviewer", supported_types=[])
# Every parse timed out (nothing extracted), but blocking attempts were bounded.
extracted = [a for a in out if a.get("id") != _EXTRACT_TRUNCATION_ID]
assert extracted == []
assert parse_calls["n"] == 2 # not 4 -- failed parses still consume cap budget
notes = [a for a in out if a.get("id") == _EXTRACT_TRUNCATION_ID]
assert len(notes) == 1