Spaces:
Running
Running
File size: 12,079 Bytes
9f1f79c eba8c2d 9f1f79c bb984d4 9f1f79c eba8c2d 9f1f79c eba8c2d 9f1f79c eba8c2d 9f1f79c eba8c2d 9f1f79c eba8c2d 9f1f79c 7b709e3 bb984d4 9f1f79c eba8c2d 9f1f79c | 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 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 | """Research Dispatch archive over a mounted Hugging Face Bucket."""
from __future__ import annotations
import json
import mimetypes
import os
import re
import shutil
from dataclasses import dataclass
from datetime import UTC, datetime
from pathlib import Path, PurePosixPath
from typing import Any
import bleach
import markdown
from fastapi import FastAPI, HTTPException, Query
from fastapi.responses import FileResponse, HTMLResponse
APP_ROOT = Path(__file__).parent
DEFAULT_RESEARCH_ROOT = Path(os.getenv("RESEARCH_ROOT", "/research"))
DEFAULT_READ_ONLY = os.getenv("RESEARCH_ARCHIVE_READ_ONLY", "").lower() in {
"1",
"true",
"yes",
}
TEMPLATE_MARKER = json.loads((APP_ROOT / "archive-template.json").read_text())
SAFE_SEGMENT = re.compile(r"^[A-Za-z0-9][A-Za-z0-9._-]*$")
DATE_PREFIX = re.compile(r"^(?P<date>\d{2}-\d{2}-\d{2})-(?P<slug>.+?)-[a-f0-9]{4}$")
HEADING = re.compile(r"^#\s+(.+?)\s*$", re.MULTILINE)
ARTIFACT_CSP = (
"default-src 'none'; "
"base-uri 'none'; "
"object-src 'none'; "
"script-src 'none'; "
"style-src 'unsafe-inline'; "
"img-src 'self' data:; "
"font-src 'none'; "
"connect-src 'none'; "
"media-src 'none'; "
"frame-src 'none'; "
"worker-src 'none'; "
"manifest-src 'none'; "
"form-action 'none'; "
"sandbox allow-popups allow-popups-to-escape-sandbox"
)
ALLOWED_TAGS = set(bleach.sanitizer.ALLOWED_TAGS) | {
"article",
"blockquote",
"br",
"code",
"div",
"h1",
"h2",
"h3",
"h4",
"hr",
"p",
"pre",
"span",
"table",
"tbody",
"td",
"th",
"thead",
"tr",
}
ALLOWED_ATTRIBUTES = {
"a": ["href", "title"],
"code": ["class"],
"td": ["align"],
"th": ["align"],
}
@dataclass(frozen=True, slots=True)
class RunSummary:
id: str
title: str
date: str
updated_at: str
status: str
has_markdown: bool
has_html: bool
asset_count: int
trace_count: int
def json(self) -> dict[str, Any]:
return {
"id": self.id,
"title": self.title,
"date": self.date,
"updated_at": self.updated_at,
"status": self.status,
"has_markdown": self.has_markdown,
"has_html": self.has_html,
"asset_count": self.asset_count,
"trace_count": self.trace_count,
}
class ResearchArchive:
"""Inspect one mounted research bucket without an external index."""
def __init__(self, root: Path) -> None:
self.root = root
def list_runs(self) -> list[RunSummary]:
if not self.root.is_dir():
return []
runs = [
self.summarize(path)
for path in self.root.iterdir()
if path.is_dir() and SAFE_SEGMENT.fullmatch(path.name)
]
return sorted(runs, key=lambda run: run.updated_at, reverse=True)
def summarize(self, run: Path) -> RunSummary:
markdown_path = run / "output" / "report.md"
html_path = run / "output" / "report.html"
has_markdown = markdown_path.is_file()
has_html = html_path.is_file()
status = (
"complete"
if has_markdown and has_html
else "markdown"
if has_markdown
else "incomplete"
)
files = [path for path in run.rglob("*") if path.is_file()]
updated = self._workspace_timestamp(run, files)
return RunSummary(
id=run.name,
title=self._title(run.name, markdown_path),
date=self._date(run.name, updated),
updated_at=datetime.fromtimestamp(updated, UTC).isoformat(),
status=status,
has_markdown=has_markdown,
has_html=has_html,
asset_count=sum("/assets/" in path.as_posix() for path in files),
trace_count=sum("/traces/" in path.as_posix() for path in files),
)
def describe(self, run_id: str) -> dict[str, Any]:
run = self.run_path(run_id)
if not run.is_dir():
raise FileNotFoundError(run_id)
summary = self.summarize(run)
markdown_path = run / "output" / "report.md"
markdown_text = (
markdown_path.read_text(errors="replace") if markdown_path.is_file() else ""
)
research_manifest = self._read_json(
run / "scratch" / "research" / "manifest.json"
)
presentation_manifests = [
self._read_json(path)
for path in sorted(
(run / "scratch" / "presentation" / "attempts").glob("*/manifest.json")
)
]
files = [
{
"path": path.relative_to(run).as_posix(),
"size": path.stat().st_size,
"kind": self._kind(path),
}
for path in sorted(run.rglob("*"))
if path.is_file() and path.name not in {".keep", ".workspace.json"}
]
return {
**summary.json(),
"markdown": markdown_text,
"markdown_html": render_markdown(markdown_text),
"research_manifest": research_manifest,
"presentation_manifests": presentation_manifests,
"files": files,
"markdown_url": (
f"/files/{run_id}/output/report.md" if summary.has_markdown else None
),
"html_url": (
f"/files/{run_id}/output/report.html" if summary.has_html else None
),
}
def run_path(self, run_id: str) -> Path:
if not SAFE_SEGMENT.fullmatch(run_id):
raise ValueError("Invalid run id")
return self.root / run_id
def file_path(self, run_id: str, relative: str) -> Path:
run = self.run_path(run_id)
candidate = PurePosixPath(relative)
if candidate.is_absolute() or ".." in candidate.parts:
raise ValueError("Invalid artifact path")
path = run.joinpath(*candidate.parts)
if not path.is_file():
raise FileNotFoundError(relative)
return path
def delete(self, run_id: str) -> None:
run = self.run_path(run_id)
if run.is_symlink() or not run.is_dir():
raise FileNotFoundError(run_id)
shutil.rmtree(run)
@staticmethod
def _read_json(path: Path) -> object | None:
if not path.is_file():
return None
try:
return json.loads(path.read_text())
except (OSError, json.JSONDecodeError):
return None
@classmethod
def _workspace_timestamp(cls, run: Path, files: list[Path]) -> float:
marker = cls._read_json(run / "scratch" / ".workspace.json")
if isinstance(marker, dict):
checked_at = marker.get("checked_at")
if isinstance(checked_at, str):
try:
return datetime.fromisoformat(checked_at).timestamp()
except ValueError:
pass
return max(
(path.stat().st_mtime for path in files),
default=run.stat().st_mtime,
)
@staticmethod
def _title(run_id: str, report: Path) -> str:
if report.is_file():
match = HEADING.search(report.read_text(errors="replace")[:8000])
if match:
return match.group(1).strip()
match = DATE_PREFIX.match(run_id)
slug = match.group("slug") if match else run_id.removeprefix("research-")
return slug.replace("-", " ").replace("_", " ").title()
@staticmethod
def _date(run_id: str, timestamp: float) -> str:
match = DATE_PREFIX.match(run_id)
if match:
try:
return (
datetime.strptime(match.group("date"), "%y-%m-%d")
.replace(tzinfo=UTC)
.date()
.isoformat()
)
except ValueError:
pass
return datetime.fromtimestamp(timestamp, UTC).date().isoformat()
@staticmethod
def _kind(path: Path) -> str:
suffix = path.suffix.lower()
if suffix in {".png", ".jpg", ".jpeg", ".webp", ".gif", ".svg", ".avif"}:
return "image"
if suffix == ".html":
return "html"
if suffix in {".md", ".txt"}:
return "text"
if suffix in {".json", ".jsonl", ".csv"}:
return "data"
if suffix == ".py":
return "code"
return "file"
def render_markdown(source: str) -> str:
if not source:
return ""
rendered = markdown.markdown(
source,
extensions=["extra", "sane_lists", "tables"],
output_format="html",
)
return bleach.clean(
rendered,
tags=ALLOWED_TAGS,
attributes=ALLOWED_ATTRIBUTES,
protocols={"http", "https", "hf", "mailto"},
strip=True,
)
def create_app(
root: Path = DEFAULT_RESEARCH_ROOT,
*,
read_only: bool = DEFAULT_READ_ONLY,
) -> FastAPI:
archive = ResearchArchive(root)
app = FastAPI(title="Research Archive", docs_url=None, redoc_url=None)
@app.get("/", response_class=HTMLResponse)
def index() -> str:
return (APP_ROOT / "index.html").read_text()
@app.get("/assets/huggingface-logo.svg")
def huggingface_logo() -> FileResponse:
return FileResponse(
APP_ROOT / "huggingface-logo.svg",
media_type="image/svg+xml",
headers={"Cache-Control": "public, max-age=86400"},
)
@app.get("/api/runs")
def runs() -> dict[str, object]:
entries = archive.list_runs()
return {
"runs": [entry.json() for entry in entries],
"count": len(entries),
"generated_at": datetime.now(UTC).isoformat(),
}
@app.get("/api/config")
def config() -> dict[str, bool]:
return {"read_only": read_only}
@app.get("/api/runs/{run_id}")
def run(run_id: str) -> dict[str, Any]:
try:
return archive.describe(run_id)
except (FileNotFoundError, ValueError) as exc:
raise HTTPException(status_code=404, detail="Run not found") from exc
@app.delete("/api/runs/{run_id}")
def delete_run(run_id: str) -> dict[str, str]:
if read_only:
raise HTTPException(status_code=403, detail="Archive is read-only")
try:
archive.delete(run_id)
except (FileNotFoundError, ValueError) as exc:
raise HTTPException(status_code=404, detail="Run not found") from exc
except OSError as exc:
raise HTTPException(status_code=500, detail="Could not delete run") from exc
return {"deleted": run_id}
@app.get("/files/{run_id}/{relative:path}")
def artifact(
run_id: str,
relative: str,
download: bool = Query(default=False),
) -> FileResponse:
try:
path = archive.file_path(run_id, relative)
except (FileNotFoundError, ValueError) as exc:
raise HTTPException(status_code=404, detail="Artifact not found") from exc
media_type = mimetypes.guess_type(path.name)[0] or "application/octet-stream"
return FileResponse(
path,
media_type=media_type,
headers={
"Content-Disposition": (
f'attachment; filename="{path.name}"'
if download
else f'inline; filename="{path.name}"'
),
"Cache-Control": "private, max-age=300",
"Content-Security-Policy": ARTIFACT_CSP,
"X-Content-Type-Options": "nosniff",
"Referrer-Policy": "no-referrer",
},
)
@app.get("/health")
def health() -> dict[str, object]:
return {
"ok": root.is_dir(),
"root": str(root),
"read_only": read_only,
"template_version": TEMPLATE_MARKER["template_version"],
}
return app
app = create_app()
|