failproofai 1.0.1-beta.1 → 1.0.2-beta.0

package/.next/standalone/sdk/python/tests/test_site_docs.py

@@ -0,0 +1,371 @@
+"""The published docs site makes claims about this package, and nothing checked them.
+
+`docs/start/integrations/` on the site is a second copy of the integration guide,
+maintained by hand alongside `sdk/python/docs/`. Two copies of the same claims is
+exactly the shape that drifts, and it already had: the site named
+`capture_content` for CrewAI and `session_id` for LlamaIndex, neither of which
+those adapters read, and told readers to verify a Pydantic AI install by printing
+`agent.capabilities`, which raises `AttributeError`.
+
+None of that produced an error for a reader — `instrument()` drops unknown option
+keys by design — so only a test can catch it.
+
+Same shape as `test_spool_contract.py` and `fp-cloud-cli/tests/test_fp_home_contract.py`:
+read the other side's source, skip when it is genuinely absent (an installed
+sdist has no docs site), and fail when `FAILPROOFAI_SDK_REQUIRE_CONTRACT` says the
+repository should be there.
+"""
+from __future__ import annotations
+
+import ast
+import os
+import re
+import textwrap
+from pathlib import Path
+
+import pytest
+
+import failproofai_sdk
+from failproofai_sdk import _events as _events_module
+
+# sdk/python -> sdk -> repo root -> docs/
+_HERE = Path(failproofai_sdk.__file__).resolve().parent.parent
+SITE = _HERE.parent.parent / "docs" / "start" / "integrations"
+
+REQUIRE = os.environ.get("FAILPROOFAI_SDK_REQUIRE_CONTRACT", "").strip().lower() in {
+    "1",
+    "true",
+    "yes",
+    "on",
+}
+
+#: site page -> the adapter module it documents.
+PAGE_ADAPTER = {
+    "langchain.mdx": "langchain",
+    "crewai.mdx": "crewai",
+    "llamaindex.mdx": "llama_index",
+    "pydantic-ai.mdx": "pydantic_ai",
+}
+
+
+def _page(name: str) -> str:
+    path = SITE / name
+    if path.is_file():
+        return path.read_text(encoding="utf-8")
+    message = (
+        f"{path} is missing. In an installed sdist that is expected. In the "
+        f"repository it means the docs site moved and these claims are now "
+        f"unguarded — re-point this test rather than deleting it."
+    )
+    if REQUIRE:
+        pytest.fail(message)
+    pytest.skip(message)
+
+
+def _adapter_options(module_name: str) -> set[str]:
+    source = (
+        Path(failproofai_sdk.__file__).resolve().parent
+        / "integrations"
+        / f"{module_name}.py"
+    ).read_text(encoding="utf-8")
+    names = set(re.findall(r'options\.get\(\s*["\'](\w+)["\']', source))
+    for node in ast.walk(ast.parse(source)):
+        if isinstance(node, ast.ClassDef) and node.name == "_Options":
+            names |= {
+                stmt.target.id
+                for stmt in node.body
+                if isinstance(stmt, ast.AnnAssign) and isinstance(stmt.target, ast.Name)
+            }
+    return names
+
+
+def _documented_options(text: str, adapter: str) -> set[str]:
+    out: set[str] = set()
+    for block in re.findall(r"```python[^\n]*\n(.*?)```", text, re.S):
+        try:
+            tree = ast.parse(textwrap.dedent(block))
+        except SyntaxError:
+            continue
+        for node in ast.walk(tree):
+            if not (isinstance(node, ast.Call) and isinstance(node.func, ast.Attribute)):
+                continue
+            if node.func.attr != "instrument" or not node.args:
+                continue
+            first = node.args[0]
+            if isinstance(first, ast.Constant) and first.value == adapter:
+                out |= {kw.arg for kw in node.keywords if kw.arg}
+    return out
+
+
+@pytest.mark.parametrize("page,adapter", sorted(PAGE_ADAPTER.items()))
+def test_a_site_page_only_documents_options_the_adapter_reads(page, adapter):
+    documented = _documented_options(_page(page), adapter)
+    if not documented:
+        pytest.skip(f"{page} documents no instrument() options")
+    invented = documented - _adapter_options(adapter)
+    assert not invented, (
+        f"docs/start/integrations/{page} documents instrument({adapter!r}, ...) "
+        f"options {sorted(invented)} that the adapter never reads. Unknown keys "
+        f"are dropped silently, so a reader gets no error and no effect."
+    )
+
+
+@pytest.mark.parametrize("page", sorted(PAGE_ADAPTER))
+def test_a_site_page_only_names_event_methods_that_exist(page):
+    named = set(re.findall(r"failproofai_sdk\.event\.([a-z_]+)\s*\(", _page(page)))
+    missing = {n for n in named if not hasattr(failproofai_sdk.event, n)}
+    assert not missing, f"{page} names event.{sorted(missing)}, which does not exist"
+
+
+@pytest.mark.parametrize("page", sorted(PAGE_ADAPTER))
+def test_a_site_page_only_names_api_this_package_exports(page):
+    named = set(re.findall(r"failproofai_sdk\.([a-z_]+)\s*\(", _page(page))) - {"event"}
+    missing = {n for n in named if not hasattr(failproofai_sdk, n)}
+    assert not missing, f"{page} names failproofai_sdk.{sorted(missing)}, which does not exist"
+
+
+def test_the_pydantic_page_verifies_the_capability_the_way_that_works():
+    """`agent.capabilities` raises AttributeError.
+
+    Pydantic AI merges the list you pass into a single `root_capability`, so the
+    verification snippet the page tells a reader to run has to go through it.
+    """
+    text = _page("pydantic-ai.mdx")
+    assert "root_capability.capabilities" in text, (
+        "the pydantic page must verify through `agent.root_capability.capabilities`"
+    )
+    # Scoped to CODE, not prose: the page explains in words that
+    # `agent.capabilities` does not exist, and that sentence should stay.
+    code = "\n".join(re.findall(r"```python[^\n]*\n(.*?)```", text, re.S))
+    assert not re.search(r"(?<!root_capability\.)\bagent\.capabilities\b", code), (
+        "a code sample on the pydantic page reads `agent.capabilities`, "
+        "which raises AttributeError"
+    )
+
+
+# ─────────────────────────────────────────────────────────────────────────────
+# Structure
+# ─────────────────────────────────────────────────────────────────────────────
+#
+# Four framework pages written one at a time drifted into four different shapes:
+# LangGraph explained session control under "Control the session", CrewAI buried
+# the same thing as an H3 inside "Options", LlamaIndex had it in a callout, and
+# Pydantic AI did not mention it at all. A reader who learns one page should be
+# able to skim the next.
+
+#: The order every framework page follows. Pages may insert their own sections
+#: between these, but these must appear, in this order.
+SPINE = [
+    "Install",
+    "Instrument",
+    "What gets recorded",
+    "Example",
+    "Name your spans",
+    "Control the session",
+    "Options",
+    "Common problems",
+    "Next",
+]
+
+
+def _headings(page: str) -> list[str]:
+    return [h.strip() for h in re.findall(r"^## (.+)$", _page(page), re.M)]
+
+
+@pytest.mark.parametrize("page", sorted(PAGE_ADAPTER))
+def test_a_framework_page_follows_the_shared_spine(page):
+    headings = _headings(page)
+    missing = [h for h in SPINE if h not in headings]
+    assert not missing, f"{page} is missing sections {missing}; has {headings}"
+
+    positions = [headings.index(h) for h in SPINE]
+    assert positions == sorted(positions), (
+        f"{page} orders the shared sections differently: "
+        f"{[headings[i] for i in positions]}"
+    )
+
+
+@pytest.mark.parametrize("page", sorted(PAGE_ADAPTER))
+def test_a_framework_page_is_explicit_about_human_in_the_loop(page):
+    """Either it documents the pairs, or it says why there are none.
+
+    Silence reads as an oversight, and the reader cannot tell whether the
+    framework has no HITL surface or we simply did not map it.
+    """
+    text = _page(page)
+    assert "## Human in the loop" in text or "human-in-the-loop pair" in text, (
+        f"{page} neither documents human-in-the-loop nor states that the "
+        f"framework has none"
+    )
+
+
+# --- Keyword arguments, on every page in the directory ----------------------
+#
+# The tests above check that a method NAME exists. Nothing checked the keywords,
+# and `event.*` ends in `**fields` — so a wrong one is accepted, stored as a
+# custom field, and never populates the column the reader wanted. The docs told
+# people to call `model_response(response=...)` for a long time; the parameter is
+# `content`, so every reader who copied it got an event whose `content` column
+# was empty and a stray `response` field they never asked for. Nothing raised.
+#
+# These also widen the net: PAGE_ADAPTER covers only the four framework pages, so
+# `custom-agents.mdx` — which carries the most hand-written event calls on the
+# site — was scanned by nothing at all. That is where the bug survived.
+
+ALL_PAGES = sorted(p.name for p in SITE.glob("*.mdx")) if SITE.is_dir() else []
+
+# Custom fields are legal, and the adapters namespace theirs. A bare unknown
+# keyword on a documented call is the typo case.
+#
+# Two exemptions, both deliberate. `fw_*` is the documented namespace for a
+# framework's own metadata. And `_PROMOTED_NUMERIC` names the keys ingest lifts
+# into real columns — `duration_ms` on `model_response` is the one the docs
+# actively tell you to pass, and it travels through `**fields` by design, so the
+# SDK validates it there rather than declaring it a parameter. Reading the set
+# from the SDK keeps this from drifting the moment a fourth key is promoted.
+_CUSTOM_FIELD_PREFIX = "fw_"
+_PROMOTED = set(_events_module._PROMOTED_NUMERIC)
+
+
+def _event_calls(text: str):
+    """(method, {keywords}) for every failproofai_sdk.event.X(...) in a python block."""
+    for block in re.findall(r"```python[^\n]*\n(.*?)```", text, re.S):
+        try:
+            tree = ast.parse(textwrap.dedent(block))
+        except SyntaxError:
+            continue
+        for node in ast.walk(tree):
+            if not (isinstance(node, ast.Call) and isinstance(node.func, ast.Attribute)):
+                continue
+            value = node.func.value
+            if not (isinstance(value, ast.Attribute) and value.attr == "event"):
+                continue
+            yield node.func.attr, {kw.arg for kw in node.keywords if kw.arg}
+
+
+@pytest.mark.parametrize("page", ALL_PAGES)
+def test_every_documented_event_call_uses_real_keywords(page):
+    import inspect
+
+    bad = []
+    for method, keywords in _event_calls(_page(page)):
+        fn = getattr(failproofai_sdk.event, method, None)
+        if fn is None:
+            continue  # the name test above owns this failure
+        real = set(inspect.signature(fn).parameters) - {"fields"}
+        for kw in sorted(keywords - real):
+            if kw.startswith(_CUSTOM_FIELD_PREFIX) or kw in _PROMOTED:
+                continue
+            bad.append(f"event.{method}({kw}=...)")
+    assert not bad, (
+        f"docs/start/integrations/{page} passes keywords that are not parameters: "
+        f"{bad}. `event.*` ends in **fields, so these are accepted silently and "
+        f"stored as custom fields instead of filling the column the reader wanted."
+    )
+
+
+def test_the_keyword_scan_actually_finds_calls():
+    """Otherwise a change to the block format makes every page above pass vacuously."""
+    found = sum(len(list(_event_calls(_page(p)))) for p in ALL_PAGES)
+    assert found >= 10, f"only {found} event calls found across {len(ALL_PAGES)} pages"
+
+
+# ─────────────────────────────────────────────────────────────────────────────
+# Claims that are true of ONE adapter and were written as if universal
+# ─────────────────────────────────────────────────────────────────────────────
+
+#: The content-capture option each adapter actually reads. `None` means the
+#: adapter has no content switch at all, which is a fact worth stating rather
+#: than an omission — CrewAI's only option is `session_id`, so
+#: `instrument("crewai", capture_content=False)` raises nothing and records
+#: everything.
+CONTENT_OPTION = {
+    "langchain": "capture_content",
+    "pydantic_ai": "capture_content",
+    "llama_index": "capture_messages",
+    "crewai": None,
+}
+
+
+def _adapter_source(name: str) -> str:
+    return (
+        Path(failproofai_sdk.__file__).resolve().parent / "integrations" / f"{name}.py"
+    ).read_text(encoding="utf-8")
+
+
+@pytest.mark.parametrize("adapter,option", sorted(CONTENT_OPTION.items(), key=lambda kv: kv[0]))
+def test_the_content_option_map_matches_what_each_adapter_reads(adapter, option):
+    """The map above is what the cross-adapter pages are checked against.
+
+    Pinned to the source so the map cannot quietly become the stale thing.
+    """
+    source = _adapter_source(adapter)
+    for candidate in ("capture_content", "capture_messages"):
+        reads_it = f'options.get("{candidate}"' in source
+        assert reads_it == (candidate == option), (
+            f"{adapter}.py {'reads' if reads_it else 'does not read'} {candidate!r}, "
+            f"but CONTENT_OPTION says its switch is {option!r}"
+        )
+
+
+def test_no_cross_adapter_page_presents_one_adapters_option_as_universal():
+    """`how-it-works.mdx` told every reader `capture_content=False` was THE switch.
+
+    It is read by two adapters of four. LlamaIndex spells it `capture_messages`
+    and CrewAI has none — and `instrument()` drops options an adapter does not
+    read, so `instrument("crewai", capture_content=False)` raised nothing and
+    changed nothing. A reader on regulated data shipped believing prompts and
+    completions had stopped being recorded, and `collector.redact` explicitly
+    does not apply to SDK events, so nothing was behind it.
+
+    The four per-framework pages are checked elsewhere; these are the pages that
+    speak about all of them at once and so must name the difference.
+    """
+    root = SITE.parent.parent  # docs/
+    pages = [SITE / "how-it-works.mdx", SITE / "custom-agents.mdx"]
+    checked = 0
+    for page in pages:
+        if not page.is_file():
+            continue
+        checked += 1
+        text = page.read_text(encoding="utf-8")
+        if "capture_content" not in text:
+            continue
+        # If it names one adapter's option it must name the others, or a reader
+        # applies it to a framework that ignores it.
+        assert "capture_messages" in text, (
+            f"{page.name} names `capture_content` without `capture_messages`, so a "
+            "LlamaIndex reader is told to set an option that adapter does not read"
+        )
+        assert "crewai" in text.lower(), (
+            f"{page.name} presents a content switch without saying CrewAI has none"
+        )
+    if REQUIRE:
+        assert checked, "neither cross-adapter page was found; the guard checked nothing"
+
+
+def test_no_guide_still_says_a_float_duration_is_silently_dropped():
+    """It raises `ValueError`, and has since `_validate_promoted_numeric` landed.
+
+    The skill files were corrected when that changed and the site reference and
+    the manual guide were not, so a reader was told the worst case was an empty
+    column and got an exception out of `event.model_response()` on their first
+    instrumented model call — outside the SDK's own try/except, so it takes down
+    the agent turn.
+    """
+    bad = re.compile(r"(stored as null|silently nulls|silently drop\w*)", re.I)
+    roots = [
+        SITE.parent.parent / "reference" / "python-sdk.mdx",
+        Path(failproofai_sdk.__file__).resolve().parent.parent / "docs",
+    ]
+    hits = []
+    for root in roots:
+        files = [root] if root.is_file() else sorted(root.rglob("*.md*")) if root.is_dir() else []
+        for path in files:
+            for i, line in enumerate(path.read_text(encoding="utf-8").splitlines(), 1):
+                if "duration_ms" in line and bad.search(line):
+                    hits.append(f"{path.name}:{i}: {line.strip()[:110]}")
+    assert not hits, (
+        "these say a float `duration_ms` is dropped or nulled; it raises ValueError "
+        "at the call site:\n  " + "\n  ".join(hits)
+    )

package/.next/standalone/sdk/python/tests/test_skill_snippets.py

@@ -0,0 +1,165 @@
+"""The skill's code is instructions an agent executes, so it is code under test.
+
+An agent reading `SKILL.md` copies these blocks into someone's real agent loop.
+A bug in a documented snippet ships to every reader, and unlike the package it
+is never exercised by anything — which is why it gets a guard rather than a
+proofread.
+"""
+import ast
+import re
+import textwrap
+from pathlib import Path
+
+import pytest
+
+SKILL = Path(__file__).resolve().parents[1] / "skill"
+SNIPPET_FILES = sorted(SKILL.rglob("*.md"))
+
+
+def python_blocks(path):
+    """Every ```python fenced block in a markdown file, dedented.
+
+    Dedented because a fenced block nested inside a list item is indented in the
+    source and is still valid Python once that common prefix is removed. Without
+    this the only way to keep a snippet testable was to hoist it out of the list
+    it belongs to — so the guard was quietly shaping the prose. `test_site_docs.py`
+    already dedents; these two scans should not disagree about what a block is.
+    """
+    text = path.read_text(encoding="utf-8")
+    blocks = re.findall(r"```python[^\n]*\n(.*?)```", text, re.DOTALL)
+    return [textwrap.dedent(b) for b in blocks]
+
+
+def test_there_are_snippets_to_check():
+    """A path typo would otherwise make every test below pass vacuously."""
+    blocks = [b for p in SNIPPET_FILES for b in python_blocks(p)]
+    assert len(blocks) >= 5, f"found {len(blocks)} python blocks under {SKILL}"
+
+
+@pytest.mark.parametrize("path", SNIPPET_FILES, ids=lambda p: p.name)
+def test_every_documented_snippet_parses(path):
+    """A snippet that does not compile is worse than no snippet."""
+    for i, block in enumerate(python_blocks(path)):
+        try:
+            ast.parse(block)
+        except SyntaxError as exc:  # pragma: no cover - failure path
+            pytest.fail(f"{path.name} block {i} does not parse: {exc}")
+
+
+@pytest.mark.parametrize("path", SNIPPET_FILES, ids=lambda p: p.name)
+def test_lifecycle_brackets_catch_baseexception_not_exception(path):
+    """A cancelled tool or run must still emit its closing event.
+
+    `asyncio.CancelledError` inherits straight from `BaseException`, so
+    `except Exception` does not see it — and cancellation is the ordinary way an
+    async tool ends when a timeout fires or a caller gives up, not an exotic
+    one. The result is a `tool_use` with no `tool_result`, or an `agent_start`
+    with no `agent_end`: an orphaned event that also holds its correlation slot
+    until the cap evicts it.
+
+    Only handlers that EMIT are checked. A bare `except Exception` around the
+    emit call itself is correct and must stay — swallowing `KeyboardInterrupt`
+    there would make telemetry able to block a Ctrl-C.
+    """
+    for i, block in enumerate(python_blocks(path)):
+        try:
+            tree = ast.parse(block)
+        except SyntaxError:
+            continue
+        for node in ast.walk(tree):
+            if not isinstance(node, ast.ExceptHandler):
+                continue
+            body = ast.unparse(ast.Module(body=node.body, type_ignores=[]))
+            emits = re.search(r"\b(_emit|event\.\w+|failproofai_sdk\.event\.\w+)\s*\(", body)
+            if not emits:
+                continue
+            caught = ast.unparse(node.type) if node.type else "<bare>"
+            assert "BaseException" in caught, (
+                f"{path.name} block {i}: `except {caught}` wraps an emit — a cancelled "
+                "tool or run would skip its closing event. Use BaseException."
+            )
+
+
+# --- The prose is a contract too -------------------------------------------
+#
+# Everything above checks that snippets PARSE and handle cancellation. Nothing
+# checked that what the skill SAYS is true, and three claims had gone stale
+# undetected: a correlation bug described as current after it was fixed, a float
+# `duration_ms` described as silently dropped after it started raising, and a
+# verify step pointing at the pre-migration spool root. An agent following that
+# last one looks in an empty directory and reports the integration broken.
+#
+# These are the checks that would have caught each class.
+
+import failproofai_sdk
+from failproofai_sdk import _resolver
+
+SKILL_TEXT = {p.name: p.read_text(encoding="utf-8") for p in SNIPPET_FILES}
+
+
+def test_the_skill_only_names_event_methods_that_exist():
+    """A method renamed in the SDK leaves the skill teaching a call that raises."""
+    named = set()
+    for text in SKILL_TEXT.values():
+        named |= set(re.findall(r"(?:failproofai_sdk\.)?event\.([a-z_]+)\s*\(", text))
+    assert named, "no event.* calls found — the scan stopped working"
+    missing = sorted(n for n in named if not hasattr(failproofai_sdk.event, n))
+    assert not missing, f"the skill names event methods that do not exist: {missing}"
+
+
+def test_the_skill_only_names_public_api_that_exists():
+    """Same, for the top-level surface an agent is told to import and call."""
+    named = set(re.findall(r"failproofai_sdk\.([a-z_]+[a-z_0-9]*)\s*\(", "\n".join(SKILL_TEXT.values())))
+    named -= {"event"}  # a namespace, reached as failproofai_sdk.event.<method>
+    assert named, "no failproofai_sdk.* calls found — the scan stopped working"
+    missing = sorted(n for n in named if not hasattr(failproofai_sdk, n))
+    assert not missing, f"the skill names public API that does not exist: {missing}"
+
+
+def test_the_skill_verifies_against_the_current_spool_root(monkeypatch):
+    """The verify step must send a reader to the directory the SDK actually writes.
+
+    `~/.agenteye` is still allowed in the migration notes — that is what the
+    older `agenteye-collector` reads, and the skill has to say so. What is not
+    allowed is presenting it as the path to CHECK, which is what it did: a fresh
+    integration with no env vars writes to `~/.failproofai/custom-agents/events`,
+    so the documented `ls` found nothing and read as total failure.
+    """
+    # The suite sets FAILPROOFAI_HOME to a sandbox (conftest), and this
+    # assertion is about the SHAPE of the default rather than where this run
+    # happens to spool — so it resolves with that pointer removed.
+    monkeypatch.delenv("FAILPROOFAI_HOME", raising=False)
+    default = str(_resolver.failproofai_custom_agents_dir())
+    assert default.endswith("/.failproofai/custom-agents"), default
+
+    skill = SKILL_TEXT["SKILL.md"]
+    assert "~/.failproofai/custom-agents/events" in skill, (
+        "SKILL.md never names the current default spool directory"
+    )
+    offenders = [
+        line.strip()
+        for line in skill.splitlines()
+        if re.search(r"(ls|cat)\b[^\n]*~/\.agenteye/events", line)
+    ]
+    assert not offenders, (
+        "SKILL.md tells the reader to inspect the pre-migration spool root; "
+        f"that directory is empty on a default install: {offenders}"
+    )
+
+
+def test_the_skill_does_not_brand_the_product_with_the_retired_name():
+    """The H1 and the description are what an agent reads before anything else.
+
+    `agenteye` stays legal in migration notes and in the collector's own name;
+    naming the PRODUCT that is what this catches.
+    """
+    skill = SKILL_TEXT["SKILL.md"]
+    heading = next(line for line in skill.splitlines() if line.startswith("# "))
+    assert "agenteye" not in heading.lower(), f"retired product name in the H1: {heading}"
+
+    front = skill.split("---")[1] if skill.startswith("---") else ""
+    description = re.search(r"description:.*?(?=\n[a-z_]+:|\Z)", front, re.S)
+    assert description, "SKILL.md has no frontmatter description"
+    assert "to agenteye" not in description.group(0).lower(), (
+        "the frontmatter description still says events are reported to AgentEye"
+    )