Skip to content

#1 PDF Application on GitHub that lets you edit PDFs on any device anywhere

5.3 KB
Raw Blame
from __future__ import annotations

import re
from types import SimpleNamespace
from unittest.mock import AsyncMock

import pytest

from stirling.agents.document_classifier import (
    MAX_ASSIGNED_LABELS,
    DocumentClassifierAgent,
    _ClassifierOutput,
    render_labels,
    select_window,
    validate_labels,
)
from stirling.contracts import (
    ClassifyDocumentRequest,
    DocumentClassificationResponse,
    LabelOption,
    PageText,
)
from stirling.services.runtime import AppRuntime


def _page(number: int, text: str = "x") -> PageText:
    return PageText(page_number=number, text=text)


def _slug(name: str) -> str:
    return re.sub(r"^-+|-+$", "", re.sub(r"[^a-z0-9]+", "-", name.lower()))


def _opts(*names: str) -> list[LabelOption]:
    """Allowed vocabulary from names, with slug ids (mirrors the frontend)."""
    return [LabelOption(id=_slug(name), name=name) for name in names]


# ── select_window ───────────────────────────────────────────────────────────


def test_select_window_returns_short_documents_whole() -> None:
    pages = [_page(1), _page(2), _page(3), _page(4)]
    assert select_window(pages, window=2) == pages


def test_select_window_takes_both_ends_without_overlap() -> None:
    pages = [_page(n) for n in range(1, 6)]  # 5 pages
    selected = select_window(pages, window=2)
    assert [p.page_number for p in selected] == [1, 2, 4, 5]


def test_select_window_handles_empty() -> None:
    assert select_window([], window=2) == []


def test_select_window_zero_returns_all() -> None:
    pages = [_page(1), _page(2), _page(3)]
    assert select_window(pages, window=0) == pages


# ── validate_labels ──────────────────────────────────────────────────────────


def test_valid_labels_are_preserved_in_order() -> None:
    # Model answers with names; the result is the matching label ids.
    output = _ClassifierOutput(labels=["Invoice", "Receipt"])
    result = validate_labels(output, _opts("Invoice", "Receipt", "Purchase order"))
    assert isinstance(result, DocumentClassificationResponse)
    assert result.labels == ["invoice", "receipt"]


def test_off_list_labels_are_dropped() -> None:
    output = _ClassifierOutput(labels=["Invoice", "Warp core", "Receipt"])
    result = validate_labels(output, _opts("Invoice", "Receipt"))
    assert result.labels == ["invoice", "receipt"]


def test_matching_is_case_insensitive_and_returns_ids() -> None:
    output = _ClassifierOutput(labels=["invoice", " CREDIT NOTE "])
    result = validate_labels(output, _opts("Invoice", "Credit note"))
    assert result.labels == ["invoice", "credit-note"]


def test_duplicates_collapse_to_first_occurrence() -> None:
    output = _ClassifierOutput(labels=["Invoice", "invoice", "Receipt", "INVOICE"])
    result = validate_labels(output, _opts("Invoice", "Receipt"))
    assert result.labels == ["invoice", "receipt"]


def test_result_is_capped_at_max_assigned_labels() -> None:
    allowed = _opts(*[f"Label {n}" for n in range(10)])
    output = _ClassifierOutput(labels=[label.name for label in allowed])
    result = validate_labels(output, allowed)
    assert result.labels == [label.id for label in allowed[:MAX_ASSIGNED_LABELS]]


def test_empty_answer_is_valid() -> None:
    result = validate_labels(_ClassifierOutput(labels=[]), _opts("Invoice"))
    assert result.labels == []


def test_entirely_off_list_answer_yields_empty_result() -> None:
    output = _ClassifierOutput(labels=["Spaceship", "Boarding pass"])
    result = validate_labels(output, _opts("Invoice", "Receipt"))
    assert result.labels == []


# ── render_labels ────────────────────────────────────────────────────────────


def test_render_labels_lists_the_vocabulary_names() -> None:
    rendered = render_labels(_opts("Invoice", "Receipt"))
    assert "Invoice" in rendered
    assert "Receipt" in rendered


def test_render_labels_handles_empty_vocabulary() -> None:
    assert "(none)" in render_labels([])


# ── DocumentClassifierAgent (inline page text) ───────────────────────────────


def _stub_model_answer(agent: DocumentClassifierAgent, labels: list[str]) -> AsyncMock:
    mock = AsyncMock(return_value=SimpleNamespace(output=_ClassifierOutput(labels=labels)))
    agent._agent.run = mock
    return mock


@pytest.mark.anyio
async def test_classify_respects_request_supplied_vocabulary(runtime: AppRuntime) -> None:
    agent = DocumentClassifierAgent(runtime)
    run_mock = _stub_model_answer(agent, ["board minutes", "Invoice"])

    result = await agent.classify(
        ClassifyDocumentRequest(
            file_name="minutes.pdf",
            pages=[PageText(page_number=1, text="Minutes of the board meeting")],
            labels=_opts("Board minutes", "Agenda"),
        )
    )

    # "Invoice" is off this request's vocabulary even though the default knows it.
    assert result.labels == ["board-minutes"]
    assert run_mock.await_args is not None
    prompt = run_mock.await_args.args[0]
    assert "Board minutes" in prompt
    assert "Agenda" in prompt