mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2026-08-20 17:53:20 +00:00
fix(search): complete the query error surface across every endpoint
Four pieces of the same surface: whoosh-compat's emit() documents a two-part host contract: both a parse diagnostic and the QueryEmitError/UnsupportedQueryError pair are user-input errors. Only the latter half was caught; QueryEmitError now maps to SearchQueryError too. Messages pass through a cleanup that strips the library's DIVERGENCES.md references and replaces the fast=True host-configuration advice with user language, so no library-internal vocabulary reaches a searching user. The bulk selection paths (bulk edit, the legacy bulk endpoint, bulk download) reached the backend with no SearchQueryError handler, so a bad date or number in a selection filter raised straight to a DRF 500. They now share the search list endpoint's exact mapping (a new search_query_error_messages helper flattens MultipleSearchQueryErrors in one place), returning the same 400 body for the same bad query. QueryParserError means a whoosh-compat parser bug, not user-fixable input, per its own contract; the list endpoint's blanket handler was converting it to a generic 400. It now re-raises and surfaces as a 500 that monitoring can see. All behavior is pinned test-first: bulk edit and bulk download API tests assert 400s naming the bad value (previously unhandled exceptions), a unit test pins the QueryEmitError mapping, three parametrized checks assert no internal vocabulary leaks for the unsupported query shapes, and a mocked parser-bug test asserts the 500. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WMsn6DgzbvSqh1pwy66VVF
This commit is contained in:
committed by
stumpylog
co-authored by
Claude Fable 5
parent
98edd75220
commit
efb6e4b0f1
@@ -11,6 +11,7 @@ import time_machine
|
||||
from documents.search._query import InvalidDateQuery
|
||||
from documents.search._query import InvalidNumberQuery
|
||||
from documents.search._query import MultipleSearchQueryErrors
|
||||
from documents.search._query import SearchQueryError
|
||||
from documents.search._query import build_permission_filter
|
||||
from documents.search._query import parse_simple_text_highlight_query
|
||||
from documents.search._query import parse_user_query
|
||||
@@ -333,3 +334,55 @@ class TestSearchQueryErrors:
|
||||
assert err.errors == tuple(sub_errors)
|
||||
assert "created" in str(err)
|
||||
assert "asn" in str(err)
|
||||
|
||||
|
||||
class TestEmitErrorContract:
|
||||
"""whoosh-compat's emit() documents a two-part host contract: BOTH a
|
||||
non-empty diagnostics list AND the QueryEmitError/UnsupportedQueryError
|
||||
pair raised by emit() itself are user-input errors. Every one must
|
||||
surface as SearchQueryError (HTTP 400), with library-internal
|
||||
vocabulary (DIVERGENCES.md references, fast=True host advice) kept out
|
||||
of the user-facing message."""
|
||||
|
||||
@pytest.fixture
|
||||
def query_index(self) -> tantivy.Index:
|
||||
schema = build_schema()
|
||||
idx = tantivy.Index(schema, path=None)
|
||||
register_tokenizers(idx, "")
|
||||
return idx
|
||||
|
||||
def test_query_emit_error_maps_to_search_query_error(
|
||||
self,
|
||||
query_index: tantivy.Index,
|
||||
monkeypatch: pytest.MonkeyPatch,
|
||||
) -> None:
|
||||
from whoosh_compat.errors import QueryEmitError
|
||||
|
||||
import documents.search._query as query_mod
|
||||
|
||||
def raise_emit_error(*args: object, **kwargs: object) -> None:
|
||||
raise QueryEmitError("synthetic emit failure")
|
||||
|
||||
monkeypatch.setattr(query_mod, "tantivy_emit", raise_emit_error)
|
||||
with pytest.raises(SearchQueryError):
|
||||
parse_user_query(query_index, "invoice", UTC)
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("query", "leaked_fragment"),
|
||||
[
|
||||
pytest.param("title:[a TO b]", "DIVERGENCES", id="text-range-doc-ref"),
|
||||
pytest.param("notes.note:wild*", "DIVERGENCES", id="json-wildcard-doc-ref"),
|
||||
pytest.param("notes.user:*", "fast=True", id="exists-host-advice"),
|
||||
],
|
||||
)
|
||||
def test_unsupported_messages_carry_no_internal_vocabulary(
|
||||
self,
|
||||
query_index: tantivy.Index,
|
||||
query: str,
|
||||
leaked_fragment: str,
|
||||
) -> None:
|
||||
with pytest.raises(SearchQueryError) as exc_info:
|
||||
parse_user_query(query_index, query, UTC)
|
||||
assert leaked_fragment not in str(exc_info.value)
|
||||
# The message must still say something useful, not be blanked.
|
||||
assert str(exc_info.value).strip()
|
||||
|
||||
Reference in New Issue
Block a user