f3b56d8793
PR #1837's new `_kanban_unknown_endpoint` wrapper was triggered for any falsy bridge return — but `handle_kanban_*` returns `None` (not `True`) when an inner handler calls `bad(...)` to send an error response. The wrapper then sent a SECOND 404 on top of the bridge's response, producing concatenated JSON bodies on the wire. Concrete reproducer (caught by behavioural harness, not the merged tests): GET /api/kanban/tasks/<missing-id>/log → '{"error":"task not found"}{"error":"unknown Kanban endpoint: GET ..."}' This affected every `bad(...)`-shaped error path in the bridge: - task-not-found returns from `_task_log_payload` / `_task_detail_payload` - exception handlers for ImportError (503), LookupError (404), ValueError (400), RuntimeError (409) across all four method handlers - the `_handle_events_sse_stream` board-resolution failure path The fix: distinguish an explicit `False` (truly unmatched path) from `None` (handled, response already sent). Only `False` should trigger the unknown-endpoint diagnostic. Adds a regression test that exercises the task-not-found path through `routes.handle_get` and asserts only one JSON body is on the wire. Follow-on to #1837 (already merged into master at v0.51.20). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
101 lines
3.7 KiB
Python
101 lines
3.7 KiB
Python
"""Regression coverage for #1823 Kanban stale-client/board-pointer failures."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import io
|
|
import json
|
|
from types import SimpleNamespace
|
|
from urllib.parse import urlparse
|
|
|
|
from api import routes
|
|
|
|
ROOT = __import__("pathlib").Path(__file__).resolve().parents[1]
|
|
PANELS = (ROOT / "static" / "panels.js").read_text(encoding="utf-8")
|
|
ROUTES = (ROOT / "api" / "routes.py").read_text(encoding="utf-8")
|
|
|
|
|
|
class _FakeHandler:
|
|
def __init__(self):
|
|
self.status = None
|
|
self.headers = {}
|
|
self.response_headers = []
|
|
self.wfile = io.BytesIO()
|
|
|
|
def send_response(self, status):
|
|
self.status = status
|
|
|
|
def send_header(self, key, value):
|
|
self.response_headers.append((key, value))
|
|
|
|
def end_headers(self):
|
|
pass
|
|
|
|
def body_json(self):
|
|
return json.loads(self.wfile.getvalue().decode("utf-8"))
|
|
|
|
|
|
def test_unknown_kanban_endpoint_get_returns_stale_client_diagnostic():
|
|
"""Obsolete/stale JS should not collapse to a bare `not found` 404."""
|
|
handler = _FakeHandler()
|
|
handled = routes.handle_get(handler, urlparse("/api/kanban/obsolete-shape"))
|
|
|
|
assert handled is True
|
|
assert handler.status == 404
|
|
error = handler.body_json()["error"]
|
|
assert error != "not found"
|
|
assert "unknown Kanban endpoint: GET /api/kanban/obsolete-shape" in error
|
|
assert "stale cached bundle" in error
|
|
assert "Hard refresh now" in error
|
|
|
|
|
|
def test_unknown_kanban_endpoint_routes_are_wrapped_for_all_methods():
|
|
assert 'return _kanban_unknown_endpoint(handler, parsed, "GET")' in ROUTES
|
|
assert 'return _kanban_unknown_endpoint(handler, parsed, "POST")' in ROUTES
|
|
assert 'return _kanban_unknown_endpoint(handler, parsed, "PATCH")' in ROUTES
|
|
assert 'return _kanban_unknown_endpoint(handler, parsed, "DELETE")' in ROUTES
|
|
|
|
|
|
def test_kanban_stale_client_error_renders_hard_refresh_escape_hatch():
|
|
assert "function _kanbanLooksLikeStaleClientError(err)" in PANELS
|
|
assert "err.status === 404" in PANELS
|
|
assert "msg === 'not found'" in PANELS
|
|
assert "msg.includes('unknown kanban endpoint')" in PANELS
|
|
assert "Kanban needs a hard refresh" in PANELS
|
|
assert "Hard refresh now" in PANELS
|
|
assert "navigator.serviceWorker.getRegistrations()" in PANELS
|
|
assert "caches.keys()" in PANELS
|
|
assert "window.location.reload()" in PANELS
|
|
|
|
|
|
def test_inner_handler_bad_response_does_not_emit_double_404(monkeypatch):
|
|
"""Regression: when the kanban bridge already sent a response via bad()
|
|
(returns None), the unknown-endpoint wrapper must not concatenate a second
|
|
404 body on the wire. Only an explicit `False` from the bridge means the
|
|
path was unmatched.
|
|
"""
|
|
from api import kanban_bridge
|
|
|
|
# Force the task-log payload helper to report "not found" so the bridge
|
|
# calls bad() and returns None.
|
|
monkeypatch.setattr(kanban_bridge, "_task_log_payload", lambda *a, **kw: None)
|
|
|
|
handler = _FakeHandler()
|
|
handled = routes.handle_get(handler, urlparse("/api/kanban/tasks/abc/log"))
|
|
|
|
assert handled is True
|
|
assert handler.status == 404
|
|
body = handler.wfile.getvalue().decode("utf-8")
|
|
# Exactly one JSON object should have been written. Two concatenated
|
|
# objects would produce something like `}{` between them.
|
|
assert body.count("}{") == 0, f"double response detected: {body!r}"
|
|
payload = json.loads(body)
|
|
assert payload["error"] == "task not found"
|
|
|
|
|
|
def test_kanban_load_resolves_board_before_board_scoped_requests():
|
|
boards_pos = PANELS.find("await loadKanbanBoards();")
|
|
config_pos = PANELS.find("api('/api/kanban/config' + _kanbanBoardQuery())")
|
|
assert boards_pos != -1
|
|
assert config_pos != -1
|
|
assert boards_pos < config_pos
|
|
assert "_kanbanSetSavedBoard('default');" in PANELS
|