File size: 12,569 Bytes
3fc8e60 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 | #!/usr/bin/env python3
"""Pre-flight the deployed stack, the way `make demo` pre-flights the local one.
`make demo` proves the eight states against a local API. Nothing proved them against the
deployment, so every hosted failure so far was found by opening the page and looking β
including a UI that redirected every visitor to a Vercel login, and a CSP that pinned
`connect-src` to localhost and blocked every call from inside the browser. Neither leaves
a trace in the API's logs, because in both cases no request ever reaches the API.
Run it before a demo. It also warms the Space, which sleeps after 48 hours idle and takes
roughly 30 seconds to wake β so the first question of the call is not the slow one.
make verify-hosted
Standard library only, deliberately: this checks a deployment, and should not itself
depend on a working install.
"""
from __future__ import annotations
import argparse
import json
import sys
import time
import urllib.error
import urllib.request
from pathlib import Path
from typing import Any, Final
REPO_ROOT = Path(__file__).resolve().parents[1]
UI_DEFAULT: Final = "https://uselexora.vercel.app"
API_DEFAULT: Final = "https://Abdr007-lexora.hf.space"
# A cold Space wakes in ~30 s and then loads two ONNX sessions.
TIMEOUT_S: Final = 120
HTTP_OK: Final = 200
HTTP_CREATED: Final = 201
HTTP_NO_CONTENT: Final = 204
HTTP_FOUND: Final = 302
class CheckError(Exception):
"""A check that did not hold. The message is what the presenter needs to read."""
def _lower_keys(headers: Any) -> dict[str, str]:
"""Header names, lower-cased.
``dict(response.headers)`` keeps the wire casing and loses the case-insensitive
lookup the underlying ``Message`` provides. Over HTTP/2 the names arrive lower-cased
anyway, so a lower-cased lookup against that dict works β and then silently stops
working over HTTP/1.1, where Vercel sends ``Content-Security-Policy``. This checker
reported the CSP as absent for exactly that reason.
"""
return {str(key).lower(): str(value) for key, value in headers.items()}
def _request(
url: str, *, method: str = "GET", body: bytes | None = None, headers: dict[str, str]
) -> tuple[int, dict[str, str], bytes]:
request = urllib.request.Request(url, data=body, method=method) # noqa: S310
for key, value in headers.items():
request.add_header(key, value)
try:
with urllib.request.urlopen(request, timeout=TIMEOUT_S) as response: # noqa: S310
return int(response.status), _lower_keys(response.headers), response.read()
except urllib.error.HTTPError as exc:
return int(exc.code), _lower_keys(exc.headers), exc.read()
def _json(
url: str, *, body: dict[str, Any] | None = None, origin: str, session: str | None = None
) -> Any:
headers = {"Origin": origin}
if session:
headers["X-Lexora-Session"] = session
payload = None
if body is not None:
headers["Content-Type"] = "application/json"
payload = json.dumps(body).encode()
status, _, raw = _request(url, method="POST" if body else "GET", body=payload, headers=headers)
if status != HTTP_OK:
raise CheckError(f"{url} returned HTTP {status}")
return json.loads(raw)
def check_ui_is_public(ui: str) -> str:
"""A 302 here means deployment protection is on and visitors hit a login page."""
status, headers, _ = _request(ui, headers={})
if status == HTTP_FOUND:
location = headers.get("location", "")
if "vercel.com" in location:
raise CheckError(
"the UI redirects to Vercel login β deployment protection is enabled. "
"Project β Settings β Deployment Protection β disable Vercel Authentication"
)
raise CheckError(f"the UI redirects to {location}")
if status != HTTP_OK:
raise CheckError(f"the UI returned HTTP {status}")
return f"HTTP 200 at {ui}"
def check_csp_points_at_the_api(ui: str, api: str) -> str:
"""The CSP is baked at build time; a stale one blocks every call inside the browser."""
_, headers, _ = _request(ui, headers={})
csp = headers.get("content-security-policy", "")
if not csp:
raise CheckError("the UI sends no Content-Security-Policy")
connect = next((part for part in csp.split(";") if part.strip().startswith("connect-src")), "")
host = api.split("://", 1)[-1]
if host.lower() not in connect.lower():
raise CheckError(
f"CSP connect-src does not name {host} β it reads '{connect.strip()}'. "
"NEXT_PUBLIC_API_URL was not set at BUILD time; redeploy after setting it"
)
return f"connect-src names {host}"
def check_api_health(api: str, origin: str) -> str:
data = _json(f"{api}/api/health", origin=origin)
if data.get("status") != "ok":
raise CheckError(f"health is '{data.get('status')}': {data.get('detail')}")
chunks, points = data.get("chunks_indexed", 0), data.get("vector_points", 0)
if chunks == 0:
raise CheckError("no chunks indexed β the image shipped without the index")
if chunks != points:
raise CheckError(
f"{chunks} chunks but {points} vector points β the collection is incomplete"
)
return f"{chunks} chunks, {points} vectors, engine={data.get('engine')}"
def check_cors_allows_the_ui(api: str, ui: str) -> str:
status, headers, _ = _request(
f"{api}/api/ask",
method="OPTIONS",
headers={
"Origin": ui,
"Access-Control-Request-Method": "POST",
"Access-Control-Request-Headers": "content-type",
},
)
allowed = headers.get("access-control-allow-origin", "")
if status != HTTP_OK or ui not in allowed:
raise CheckError(
f"pre-flight from {ui} returned HTTP {status} allow-origin='{allowed}'. "
"Set LEXORA_CORS_ALLOW_ORIGINS on the Space to include the UI origin"
)
return f"pre-flight allows {ui}"
def check_refuses(api: str, origin: str, question: str, label: str) -> str:
data = _json(f"{api}/api/ask", body={"question": question}, origin=origin)
if data.get("kind") != "refusal":
raise CheckError(f"{label}: expected a refusal, got '{data.get('kind')}'")
return f"{label} β refusal"
def check_workspace_round_trip(api: str, origin: str, sample: Path) -> str:
"""Upload a real document, ask it a question, then delete it.
The upload path is the newest and least watched surface, and every one of its failure
modes is quiet: an ingest that loses text still answers, a session that leaks still
answers, a citation regex that stops matching still answers. Only a round trip against
the live service catches those, so this does the whole loop and then removes what it
added rather than leaving a document in a stranger-facing demo.
"""
if not sample.exists():
raise CheckError(f"{sample} is missing; run `make corpus`")
status, headers, _ = _request(f"{api}/api/workspace", headers={"Origin": origin})
session = headers.get("x-lexora-session", "")
if status != HTTP_OK or not session:
raise CheckError(f"no workspace session issued (HTTP {status})")
boundary = "----lexoraverify0000"
body = (
(
f"--{boundary}\r\n"
'Content-Disposition: form-data; name="file"; filename="verify.pdf"\r\n'
"Content-Type: application/pdf\r\n\r\n"
).encode()
+ sample.read_bytes()
+ f"\r\n--{boundary}--\r\n".encode()
)
status, _, raw = _request(
f"{api}/api/workspace/upload",
method="POST",
body=body,
headers={
"Content-Type": f"multipart/form-data; boundary={boundary}",
"X-Lexora-Session": session,
"Origin": origin,
},
)
if status != HTTP_CREATED:
raise CheckError(f"upload returned HTTP {status}: {raw[:200].decode('utf-8', 'replace')}")
workspace = json.loads(raw)
document = workspace["documents"][0]
if workspace.get("calibrated") is not False:
raise CheckError("workspace did not report calibrated=false")
if document["coverage"] < 1.0:
raise CheckError(
f"only {document['coverage']:.2%} of the document reached the index β "
"chunking is losing text"
)
answer = _json(
f"{api}/api/ask",
body={"question": "Can a landlord increase the rent?", "scope": "workspace"},
origin=origin,
session=session,
)
cited = [c for c in answer.get("citations", []) if c.get("status") == "verified"]
if answer.get("kind") != "answer" or not cited:
raise CheckError(
f"asked the uploaded document and got '{answer.get('kind')}' with "
f"{len(cited)} verified citations"
)
refusal = _json(
f"{api}/api/ask",
body={"question": "What is the capital gains tax rate in Singapore?", "scope": "workspace"},
origin=origin,
session=session,
)
if refusal.get("kind") != "refusal":
raise CheckError(f"off-topic question returned '{refusal.get('kind')}', not a refusal")
status, _, _ = _request(
f"{api}/api/workspace",
method="DELETE",
headers={"X-Lexora-Session": session, "Origin": origin},
)
if status != HTTP_NO_CONTENT:
raise CheckError(f"delete returned HTTP {status}; the demo document was left behind")
return (
f"{document['pages']}p β {document['chunks']} chunks, coverage "
f"{document['coverage']:.0%}, {len(cited)} verified citations, deleted"
)
def check_answers(api: str, origin: str, question: str) -> str:
data = _json(f"{api}/api/ask", body={"question": question}, origin=origin)
if data.get("kind") != "answer":
raise CheckError(f"expected an answer, got '{data.get('kind')}'")
citations = data.get("citations") or []
if not citations:
raise CheckError("answered with no citations β the whole point is the citation")
articles = [c.get("article_no") for c in citations]
return f"answer citing articles {articles}"
def main(argv: list[str] | None = None) -> int:
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument("--ui", default=UI_DEFAULT)
parser.add_argument("--api", default=API_DEFAULT)
args = parser.parse_args(argv)
ui, api = args.ui.rstrip("/"), args.api.rstrip("/")
checks: list[tuple[str, Any]] = [
("UI is public", lambda: check_ui_is_public(ui)),
("CSP points at the API", lambda: check_csp_points_at_the_api(ui, api)),
("API health", lambda: check_api_health(api, ui)),
("CORS allows the UI", lambda: check_cors_allows_the_ui(api, ui)),
(
"refusal Β· out of corpus",
lambda: check_refuses(
api, ui, "What is the capital gains tax rate in Singapore?", "Singapore"
),
),
(
"refusal Β· wrong jurisdiction",
lambda: check_refuses(
api,
ui,
"What is the notice period under Saudi Arabian labour law?",
"Saudi Arabia",
),
),
(
"answers with citations",
lambda: check_answers(api, ui, "How much end-of-service money do I get after 6 years?"),
),
(
"upload Β· ask Β· delete",
lambda: check_workspace_round_trip(
api, ui, REPO_ROOT / "corpus" / "pdf" / "dubai-rent-increase-decree-43-2013.pdf"
),
),
]
print(f" UI {ui}\n API {api}\n")
failures: list[str] = []
for name, run in checks:
started = time.perf_counter()
try:
detail = run()
elapsed = time.perf_counter() - started
print(f" PASS {name:28} {detail} [{elapsed:.1f}s]")
except CheckError as exc:
failures.append(f"{name}: {exc}")
print(f" FAIL {name:28} {exc}")
except (urllib.error.URLError, TimeoutError, json.JSONDecodeError) as exc:
failures.append(f"{name}: {exc}")
print(f" FAIL {name:28} unreachable: {exc}")
if failures:
print(f"\n {len(failures)} of {len(checks)} checks failed β do not present\n")
return 1
print(f"\n all {len(checks)} checks passed Β· the Space is warm Β· ready to present\n")
return 0
if __name__ == "__main__":
sys.exit(main())
|