feat(history): add chronological runs and exact output inspection (#227)

* feat(history): add bounded chronological read projections (#209)

* fix(history): validate internal continuation positions (#209)

* feat(history): expose fenced history windows and run details (#209)

* fix(history): release retired projection connections (#209)

* feat(history): resolve reported outputs through current authorization (#209)

* fix(history): reject invalid inspection targets (#209)

* feat(history): add scoped history state and current-file adapter (#209)

* fix(history): preserve slideshow and clear stale reentry actions (#209)

* feat(history): render recorded executions and frozen run details (#209)

* fix(history): recover receipts and refresh capture evidence (#209)

* test(history): verify chronological history across restore and host modes (#209)

* fix(history): enforce chronological marker visual parity (#209)

* fix(history): resolve final chronological review findings

Address #209 recovery, bounded visit restoration, exact receipt availability, and portable regression coverage.

* test(history): repair Windows fixtures and review feedback

Address #209 and PR #227 native path, cleanup, media and review-comment expectations. Document Windows portability preflight without changing production behavior.

* ci: raise the viewerjs job budget for the larger browser suite

The cross-browser workflows suite grew from 396 to 496 tests on this
branch, which pushed the whole viewerjs job to about 25.5 minutes
against the 25 minute cap set in #181. Two exact-head runs on this
branch timed out without any test failing: run 39173019283 was killed
on test 474 of 496, and run 39175125474 printed "496 passed (12.8m)"
and was then cancelled during Playwright shutdown.

Raise only the job budget. Browser projects, workers and per-test
timeouts are unchanged. Splitting the browsers into parallel jobs is
tracked separately.
This commit is contained in:
Vito
2026-10-18 17:17:05 -07:00
committed by GitHub
parent 10197026be
commit ecd21165a7
54 changed files with 9929 additions and 232 deletions
+5
View File
@@ -24,6 +24,7 @@ from PIL import Image
from .prompts import PromptRoutesMixin
from .pairs import PairRoutesMixin
from .library import LibraryRoutesMixin
from .history import HistoryRoutesMixin
from .images import ImageRoutesMixin
from .admin import AdminRoutesMixin
from .logging_routes import LoggingRoutesMixin
@@ -245,6 +246,7 @@ async def _gzip_middleware(request, handler):
class PromptManagerAPI(
PairRoutesMixin,
LibraryRoutesMixin,
HistoryRoutesMixin,
PromptRoutesMixin,
ImageRoutesMixin,
AdminRoutesMixin,
@@ -273,6 +275,8 @@ class PromptManagerAPI(
self.logger.info("Initializing PromptManager API")
self.db = db if db is not None else PromptDatabase()
self._history_read_fence = None
self._history_reads_closed = False
self._cached_output_dir = None # Lazy-cached by _find_comfyui_output_dir()
self._html_cache = {} # Cached HTML file contents keyed by path
self._gallery_cache = {} # dict: path_str -> (files, timestamp)
@@ -402,6 +406,7 @@ class PromptManagerAPI(
self._register_pair_routes(routes)
self._register_library_routes(routes)
self._register_history_routes(routes)
self._register_prompt_routes(routes)
self._register_image_routes(routes)
self._register_admin_routes(routes)
+748
View File
@@ -0,0 +1,748 @@
"""Authenticated chronological windows and bounded frozen run details."""
import asyncio
import base64
import binascii
from functools import wraps
import json
import re
import sqlite3
from typing import Callable
from urllib.parse import urlencode
from aiohttp import web
from .library import _decode, _encode, _scope
from .history_current import (
CurrentLocationUnavailable,
CurrentOutputScope,
VIDEO_EXTENSIONS,
_OpenedCurrentMedia,
_current_media_response,
_prepare_current_media,
_reauthorize_current_target,
candidate_locator,
resolve_current_candidate,
snapshot_current_output_scope,
)
from .inspection_service import CurrentFileChanged, inspect_current_file
try:
from ...database.execution_history import HistoryEpochChanged
from ...database.history_gallery import read_history_gallery
from ...database.history_reads import (
HistoryCaptureChanged,
OutputPosition,
RunKey,
WindowPosition,
)
from ...utils.history_read_fence import HistoryReadFence
from ...utils.inspection_response import encode_history_inspection_response
except ImportError:
from database.execution_history import HistoryEpochChanged
from database.history_gallery import read_history_gallery
from database.history_reads import (
HistoryCaptureChanged,
OutputPosition,
RunKey,
WindowPosition,
)
from utils.history_read_fence import HistoryReadFence
from utils.inspection_response import encode_history_inspection_response
_RUN_MAX_BYTES = 8 * 1024 * 1024
_OUTPUTS_MAX_BYTES = 1024 * 1024
_UUID = re.compile(r"[0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}")
_DIGEST = re.compile(r"[0-9a-f]{64}")
_DECIMAL = re.compile(r"0|[1-9][0-9]{0,18}")
_RUN_DECIMALS = (
"queue_item_id",
"observed_dequeue_at",
"observed_callback_at",
"executor_started_at",
"terminal_event_at",
)
_MESSAGES = {
"invalid-request": "Invalid history request",
"invalid-cursor": "Invalid history cursor; refresh recorded history",
"not-found": "Recorded history target not found",
"history-changed": "Recorded history changed; reload recorded history",
"storage-unavailable": "Recorded history is temporarily unavailable",
"response-limit": "Recorded history response exceeds the response limit",
"capture-changed": "Reported output capture changed; reload reported outputs",
"candidate-stale": "Current output locations changed; reload reported outputs",
"not-authorized": "Current output media is unavailable or not authorized",
}
class HistoryReadError(Exception):
"""A bounded public failure without private storage or capture details."""
def __init__(self, status: int, code: str, recovery: dict | None = None) -> None:
self.status = status
self.code = code
self.recovery = recovery
super().__init__(_MESSAGES[code])
def _error_response(error: HistoryReadError) -> web.Response:
return web.json_response(
{
"success": False,
"history_version": 1,
"code": error.code,
"error": str(error),
"recovery": error.recovery,
},
status=error.status,
headers={"Cache-Control": "no-store"},
)
def _history_errors(handler: Callable) -> Callable:
@wraps(handler)
async def wrapped(self, request: web.Request) -> web.Response:
try:
return await handler(self, request)
except HistoryReadError as error:
return _error_response(error)
except HistoryEpochChanged:
return _error_response(
HistoryReadError(409, "history-changed", {"action": "refresh-history"})
)
except ValueError:
return _error_response(HistoryReadError(400, "invalid-request"))
except (sqlite3.Error, OSError) as error:
self.logger.warning("History read unavailable (%s)", type(error).__name__)
return _error_response(
HistoryReadError(503, "storage-unavailable", {"action": "retry-read"})
)
return wrapped
def _decimal(value: object, *, minimum: int = 0) -> int:
if type(value) is not str or _DECIMAL.fullmatch(value) is None:
raise ValueError("Invalid decimal history integer")
parsed = int(value)
if not minimum <= parsed <= 2**63 - 1:
raise ValueError("History integer outside supported range")
return parsed
def _uuid(value: object) -> str:
if type(value) is not str or _UUID.fullmatch(value) is None:
raise ValueError("Invalid history UUID")
return value
def _query(request: web.Request) -> None:
if any(len(request.query.getall(key)) != 1 for key in request.query):
raise ValueError("Duplicate history query parameter")
def _page_limit(request: web.Request) -> int:
limit = _decimal(request.query.get("limit", "40"), minimum=1)
if limit > 100:
raise ValueError("History limit outside supported range")
return limit
def _decode_run_key(value: object) -> RunKey:
if type(value) is not list or len(value) != 4:
raise ValueError("Invalid history run key")
return (_decimal(value[0]), _uuid(value[1]), _decimal(value[2]), _uuid(value[3]))
def _wire_run_key(key: RunKey) -> list[str]:
return [str(key[0]), key[1], str(key[2]), key[3]]
def _cursor_payload(token: str, kind: str) -> object:
"""Use Library authentication, allowing only inline, domain-bound keys."""
try:
if not 1 <= len(token.encode("ascii")) <= 4096:
raise ValueError
raw = base64.b64decode(
token + "=" * (-len(token) % 4), altchars=b"-_", validate=True
)
wrapper = json.loads(raw[32:])
if type(wrapper) is not dict or set(wrapper) != {"scope", "key"}:
raise ValueError
return _decode(token, _scope({"kind": kind}))
except (ValueError, TypeError, binascii.Error, UnicodeError, RecursionError):
raise HistoryReadError(400, "invalid-cursor") from None
def _decode_window_cursor(
token: str | None, positive_id: int, *, resume: bool = False
) -> tuple[str | None, WindowPosition | None]:
if token is None:
return None, None
try:
value = _cursor_payload(token, "history-resume" if resume else "history-window")
if type(value) is not dict or set(value) != {
"version",
"epoch",
"positive_id",
"raw_text_id",
"upper",
} | (set() if resume else {"direction", "before"}):
raise ValueError
if (
type(value["version"]) is not int
or value["version"] != 1
or _decimal(value["positive_id"], minimum=1) != positive_id
or (not resume and value["direction"] != "older")
or type(value["raw_text_id"]) is not str
or _DIGEST.fullmatch(value["raw_text_id"]) is None
):
raise ValueError
epoch = _uuid(value["epoch"])
upper = _decode_run_key(value["upper"])
before = upper if resume else _decode_run_key(value["before"])
if before > upper:
raise ValueError
return epoch, WindowPosition(value["raw_text_id"], upper, before)
except ValueError:
raise HistoryReadError(400, "invalid-cursor") from None
def _encode_window_cursor(
position: WindowPosition | None,
epoch: str,
positive_id: int,
*,
resume: bool = False,
) -> str | None:
if position is None:
return None
value = {
"version": 1,
"epoch": epoch,
"positive_id": str(positive_id),
"raw_text_id": position.raw_text_id,
"upper": _wire_run_key(position.upper),
}
if not resume:
value.update(direction="older", before=_wire_run_key(position.before))
return _encode(
value,
_scope({"kind": "history-resume" if resume else "history-window"}),
)
def _node(value: object) -> str:
if type(value) is not str or not 1 <= len(value) <= 128 or "\0" in value:
raise ValueError("Invalid output node")
if len(value.encode("utf-8")) > 512:
raise ValueError("Invalid output node size")
return value
def _decode_output_cursor(
token: str | None, run_id: str, epoch: str
) -> OutputPosition | None:
if token is None:
return None
try:
value = _cursor_payload(token, "history-outputs")
if type(value) is not dict or set(value) != {
"version",
"epoch",
"run_id",
"capture_fingerprint",
"after",
}:
raise ValueError
if (
type(value["version"]) is not int
or value["version"] != 1
or _uuid(value["run_id"]) != run_id
or type(value["capture_fingerprint"]) is not str
or _DIGEST.fullmatch(value["capture_fingerprint"]) is None
or type(value["after"]) is not list
or len(value["after"]) != 2
or type(value["after"][1]) is not int
or not 0 <= value["after"][1] <= 255
):
raise ValueError
node = _node(value["after"][0])
if _uuid(value["epoch"]) != epoch:
raise HistoryReadError(
409, "history-changed", {"action": "refresh-history"}
)
return OutputPosition(value["capture_fingerprint"], (node, value["after"][1]))
except (ValueError, UnicodeError):
raise HistoryReadError(400, "invalid-cursor") from None
def _encode_output_cursor(
position: OutputPosition | None, run_id: str, epoch: str
) -> str | None:
if position is None:
return None
return _encode(
{
"version": 1,
"epoch": epoch,
"run_id": run_id,
"capture_fingerprint": position.capture_fingerprint,
"after": list(position.after),
},
_scope({"kind": "history-outputs"}),
)
def _current_stale() -> HistoryReadError:
return HistoryReadError(409, "candidate-stale", {"action": "reload-outputs"})
def _current_unavailable(reason: str) -> HistoryReadError:
if reason == "temporary_unavailable":
return HistoryReadError(503, "storage-unavailable", {"action": "retry-read"})
if reason == "missing":
return HistoryReadError(404, "not-found", {"action": "retry-read"})
return HistoryReadError(403, "not-authorized", {"action": "retry-read"})
def _check_current(
scope: CurrentOutputScope,
api: object,
fence: HistoryReadFence,
epoch: str,
generation: int,
) -> None:
if snapshot_current_output_scope(api).current_scope != scope.current_scope:
raise _current_stale()
fence.validate(epoch, generation)
def _media_descriptor(receipt: dict, candidate: dict, epoch: str) -> dict:
occurrence = receipt["occurrence"]
query = urlencode(
{
"node": occurrence["output_node_id"],
"ordinal": occurrence["image_ordinal"],
"epoch": epoch,
"current_scope": candidate["current_scope"],
}
)
base = f"/prompt_manager/history/runs/{occurrence['run_id']}/output/current"
return {
"kind": "reported-location",
"occurrence": occurrence,
"history_epoch": epoch,
"current_scope": candidate["current_scope"],
"location_key": candidate["location_key"],
"reference": receipt["reference"],
"filename": receipt["reference"]["filename"],
"is_video": receipt["reference"]["filename"]
.lower()
.endswith(tuple(VIDEO_EXTENSIONS)),
"url": f"{base}/media?{query}",
"thumbnail_url": f"{base}/thumbnail?{query}",
"inspection_url": f"{base}/inspection?{query}",
}
def _close_prepared_result(task: asyncio.Task) -> None:
try:
result = task.result()
except (Exception, asyncio.CancelledError):
return
if not isinstance(result, bytes):
result.close()
def _wire_run(run: dict) -> None:
run["diagnostics_omitted"] = bool(run["diagnostics_omitted"])
for key in _RUN_DECIMALS:
if run[key] is not None:
run[key] = str(run[key])
def _serialize_history(payload: dict, *, max_bytes: int | None = None) -> bytes:
try:
encoded = json.dumps(
payload, ensure_ascii=False, allow_nan=False, separators=(",", ":")
).encode("utf-8")
except (ValueError, TypeError, UnicodeError):
raise sqlite3.DatabaseError("Invalid recorded history payload") from None
if max_bytes is not None and len(encoded) > max_bytes:
raise HistoryReadError(422, "response-limit")
return encoded
def _success_response(encoded: bytes) -> web.Response:
return web.Response(
body=encoded,
content_type="application/json",
headers={"Cache-Control": "no-store"},
)
class HistoryRoutesMixin:
def _register_history_routes(self, routes: web.RouteTableDef) -> None:
routes.get("/prompt_manager/library/{positive_id}/history")(
self.get_library_history
)
routes.get("/prompt_manager/history/runs/{run_id}")(self.get_history_run)
routes.get("/prompt_manager/history/runs/{run_id}/outputs")(
self.get_history_outputs
)
routes.get("/prompt_manager/history/runs/{run_id}/output/current/media")(
self.get_history_current_media
)
routes.get("/prompt_manager/history/runs/{run_id}/output/current/thumbnail")(
self.get_history_current_thumbnail
)
routes.get("/prompt_manager/history/runs/{run_id}/output/current/inspection")(
self.get_history_current_inspection
)
def _history_fence(self) -> HistoryReadFence:
# Called synchronously by the event-loop owner before scheduling work.
if self._history_reads_closed:
raise sqlite3.OperationalError("History reads are closed")
if self._history_read_fence is None:
self._history_read_fence = HistoryReadFence(self.db)
return self._history_read_fence
def close_history_reads(self) -> None:
self._history_reads_closed = True
if self._history_read_fence is not None:
self._history_read_fence.close()
async def cleanup_history_reads(self, app: web.Application) -> None:
self.close_history_reads()
@_history_errors
async def get_library_history(self, request: web.Request) -> web.Response:
_query(request)
if set(request.query) - {"limit", "cursor", "resume"} or (
"cursor" in request.query and "resume" in request.query
):
raise ValueError("Invalid history window query")
positive_id = _decimal(request.match_info["positive_id"], minimum=1)
limit = _page_limit(request)
resuming = "resume" in request.query
expected_epoch, position = _decode_window_cursor(
request.query.get("resume" if resuming else "cursor"),
positive_id,
resume=resuming,
)
fence = self._history_fence()
db = self.db
def project() -> bytes:
generation = fence.begin()
try:
with db.recorded_history_snapshot(expected_epoch) as epoch:
try:
result = db.list_history_window(
positive_id, limit=limit, after=position, restart=resuming
)
except ValueError:
raise HistoryReadError(400, "invalid-cursor") from None
finally:
# Restore may retire this owner before a queued read opens it.
db.model.close()
if result is None:
fence.validate(epoch, generation)
raise HistoryReadError(404, "not-found")
result["next_cursor"] = _encode_window_cursor(
result.pop("next_position"), epoch, positive_id
)
result["resume_cursor"] = _encode_window_cursor(
result.pop("resume_position"), epoch, positive_id, resume=True
)
for run in result["items"]:
_wire_run(run)
encoded = _serialize_history(
{
"success": True,
"history_version": 1,
"history_epoch": epoch,
**result,
}
)
fence.validate(epoch, generation)
return encoded
return _success_response(await self._run_in_executor(project))
@_history_errors
async def get_history_run(self, request: web.Request) -> web.Response:
_query(request)
run_id = _uuid(request.match_info["run_id"])
expected_epoch = request.query.get("epoch")
if expected_epoch is not None:
_uuid(expected_epoch)
fence = self._history_fence()
db = self.db
def project() -> bytes:
generation = fence.begin()
try:
with db.recorded_history_snapshot(expected_epoch) as epoch:
result = db.get_history_run(run_id)
finally:
db.model.close()
if result is None:
fence.validate(epoch, generation)
raise HistoryReadError(404, "not-found")
_wire_run(result["run"])
encoded = _serialize_history(
{
"success": True,
"history_version": 1,
"history_epoch": epoch,
**result,
},
max_bytes=_RUN_MAX_BYTES,
)
fence.validate(epoch, generation)
return encoded
return _success_response(await self._run_in_executor(project))
def _history_gallery(
self, conn: sqlite3.Connection, paths: tuple[str, ...]
) -> tuple[dict, bool]:
try:
return read_history_gallery(conn, paths), False
except Exception as error:
self.logger.warning(
"Saved history display unavailable (%s)", type(error).__name__
)
return {}, True
@_history_errors
async def get_history_outputs(self, request: web.Request) -> web.Response:
_query(request)
run_id = _uuid(request.match_info["run_id"])
expected_epoch = _uuid(request.query.get("epoch"))
limit = _page_limit(request)
position = _decode_output_cursor(
request.query.get("cursor"), run_id, expected_epoch
)
fence = self._history_fence()
db = self.db
def project() -> bytes:
generation = fence.begin()
scope = snapshot_current_output_scope(self)
try:
with db.recorded_history_snapshot(expected_epoch) as epoch:
try:
result = db.list_history_outputs(
run_id, limit=limit, after=position
)
except HistoryCaptureChanged:
raise HistoryReadError(
409, "capture-changed", {"action": "reload-outputs"}
) from None
if result is not None:
paths = tuple(
dict.fromkeys(
path
for item in result["items"]
if (path := candidate_locator(item["reference"], scope))
is not None
)
)
gallery, saved_unavailable = self._history_gallery(
db.model.get_connection(), paths
)
finally:
db.model.close()
if result is None:
_check_current(scope, self, fence, epoch, generation)
raise HistoryReadError(404, "not-found")
resolved = {}
for receipt in result["items"]:
reference = receipt["reference"]
locator = tuple(reference.items())
if locator not in resolved:
try:
if saved_unavailable:
raise sqlite3.OperationalError(
"Optional saved display unavailable"
)
resolved[locator] = resolve_current_candidate(
reference, scope, gallery
).public
except Exception:
resolved[locator] = {
"status": "error",
"reason": "temporary_unavailable",
"evidence_class": "locator_candidate",
}
candidate = dict(resolved[locator])
if candidate["status"] == "available":
candidate["media"] = _media_descriptor(receipt, candidate, epoch)
receipt["current_candidate"] = candidate
result["next_cursor"] = _encode_output_cursor(
result.pop("next_position"), run_id, epoch
)
encoded = _serialize_history(
{
"success": True,
"history_version": 1,
"history_epoch": epoch,
**result,
}
)
_check_current(scope, self, fence, epoch, generation)
if len(encoded) > _OUTPUTS_MAX_BYTES:
recovery = (
{"action": "smaller-limit", "limit": max(1, limit // 2)}
if limit > 1
else None
)
raise HistoryReadError(422, "response-limit", recovery)
return encoded
return _success_response(await self._run_in_executor(project))
@_history_errors
async def get_history_current_media(
self, request: web.Request
) -> web.StreamResponse:
return await self._history_current(request, "media")
@_history_errors
async def get_history_current_thumbnail(
self, request: web.Request
) -> web.StreamResponse:
return await self._history_current(request, "thumbnail")
@_history_errors
async def get_history_current_inspection(
self, request: web.Request
) -> web.Response:
return await self._history_current(request, "inspection")
async def _history_current(
self, request: web.Request, kind: str
) -> web.StreamResponse:
_query(request)
run_id = _uuid(request.match_info["run_id"])
node = _node(request.query.get("node"))
ordinal = _decimal(request.query.get("ordinal"))
if ordinal > 255:
raise ValueError("Invalid output ordinal")
expected_epoch = _uuid(request.query.get("epoch"))
current_scope = request.query.get("current_scope")
if current_scope is None or _DIGEST.fullmatch(current_scope) is None:
raise ValueError("Invalid current output scope")
fence = self._history_fence()
db = self.db
def project() -> bytes | _OpenedCurrentMedia:
generation = fence.begin()
scope = snapshot_current_output_scope(self)
try:
with db.recorded_history_snapshot(expected_epoch) as epoch:
if scope.current_scope != current_scope:
raise _current_stale()
result = db.get_history_occurrence(run_id, node, ordinal)
if result is not None:
receipt = result["receipt"]
path = candidate_locator(receipt["reference"], scope)
gallery, saved_unavailable = self._history_gallery(
db.model.get_connection(),
(path,) if path is not None else (),
)
finally:
db.model.close()
if result is None:
_check_current(scope, self, fence, epoch, generation)
raise HistoryReadError(404, "not-found")
resolved = resolve_current_candidate(receipt["reference"], scope, gallery)
if resolved.public["status"] != "available":
_check_current(scope, self, fence, epoch, generation)
raise _current_unavailable(resolved.public["reason"])
prepared = None
try:
if kind == "inspection":
saved = gallery.get(path, {})
_reauthorize_current_target(resolved, scope)
observed = inspect_current_file(
resolved.canonical_target,
source_label=resolved.public["source_label"],
saved=saved.get("saved"),
library=saved.get(
"library",
{"status": "unavailable" if saved_unavailable else "none"},
),
)
_reauthorize_current_target(resolved, scope)
identity = {
**receipt,
"history_epoch": epoch,
"current_scope": scope.current_scope,
"location_key": resolved.public["location_key"],
"evidence_class": "locator_candidate",
"observation": "current-file",
}
try:
prepared = encode_history_inspection_response(
current_output=identity, **observed
)
except ValueError:
_check_current(scope, self, fence, epoch, generation)
raise HistoryReadError(422, "response-limit") from None
else:
prepared = _prepare_current_media(
resolved, scope, thumbnail=kind == "thumbnail"
)
_check_current(scope, self, fence, epoch, generation)
return prepared
except CurrentFileChanged:
if prepared is not None and not isinstance(prepared, bytes):
prepared.close()
_check_current(scope, self, fence, epoch, generation)
raise _current_stale() from None
except CurrentLocationUnavailable as error:
if prepared is not None and not isinstance(prepared, bytes):
prepared.close()
_check_current(scope, self, fence, epoch, generation)
raise (
_current_stale()
if error.stale
else _current_unavailable(error.reason)
) from None
except BaseException as error:
if prepared is not None and not isinstance(prepared, bytes):
prepared.close()
if isinstance(error, Exception) and not isinstance(
error, (HistoryReadError, HistoryEpochChanged, sqlite3.Error)
):
_check_current(scope, self, fence, epoch, generation)
raise
pending = asyncio.create_task(self._run_in_executor(project))
try:
prepared = await asyncio.shield(pending)
except asyncio.CancelledError:
pending.add_done_callback(_close_prepared_result)
raise
except (
HistoryReadError,
HistoryEpochChanged,
sqlite3.Error,
OSError,
ValueError,
):
raise
except Exception as error:
self.logger.warning(
"Current history media unavailable (%s)", type(error).__name__
)
raise _current_unavailable("temporary_unavailable") from None
if isinstance(prepared, bytes):
return _success_response(prepared)
return await _current_media_response(request, prepared)
+399
View File
@@ -0,0 +1,399 @@
"""Native reported locations and already-opened current media, without ownership."""
import asyncio
from dataclasses import dataclass
import errno
import hashlib
import hmac
import json
import mimetypes
import os
from pathlib import Path
import stat
from typing import BinaryIO
from aiohttp import web
from .images import _canonical, _public_path, SERVABLE_EXTENSIONS, VIDEO_EXTENSIONS
try:
from ...utils.execution_outputs import (
OutputReference,
OutputRoots,
snapshot_output_roots,
validate_output_reference,
)
except ImportError:
from utils.execution_outputs import (
OutputReference,
OutputRoots,
snapshot_output_roots,
validate_output_reference,
)
_SECRET = os.urandom(32)
_READ_SIZE = 64 * 1024
def _opaque(value: object) -> str:
raw = json.dumps(value, ensure_ascii=True, separators=(",", ":")).encode("ascii")
return hmac.new(_SECRET, raw, hashlib.sha256).hexdigest()
@dataclass(frozen=True)
class CurrentOutputScope:
path_style: str
lexical_output: str | None
lexical_temp: str | None
roots: OutputRoots
canonical_output: Path | None
canonical_temp: Path | None
authorized_roots: tuple[Path, ...]
current_scope: str
@dataclass(frozen=True)
class ResolvedCurrentCandidate:
public: dict
canonical_target: Path | None = None
namespace: Path | None = None
gallery_root: Path | None = None
class CurrentLocationUnavailable(Exception):
"""A bounded current-file failure without the underlying private path."""
def __init__(self, reason: str, *, stale: bool = False) -> None:
self.reason = reason
self.stale = stale
super().__init__(reason)
def _host_directory(name: str) -> str | None:
try:
import folder_paths
value = getattr(folder_paths, name)()
except (ImportError, AttributeError, OSError):
return None
return value if type(value) is str else None
def snapshot_current_output_scope(api: object) -> CurrentOutputScope:
"""Bind host lexical namespaces independently of current gallery authority."""
from ..config import GalleryConfig
style = "windows" if os.name == "nt" else "posix"
output = _host_directory("get_output_directory")
temp = _host_directory("get_temp_directory")
roots = snapshot_output_roots(style, output, temp)
canonical_output = _canonical(output) if roots.output_key is not None else None
canonical_temp = _canonical(temp) if roots.temp_key is not None else None
authorized = tuple(
sorted({_canonical(path) for path in api._get_all_output_dirs()})
)
policy = []
for entry in GalleryConfig.MONITORING_DIRECTORIES:
valid, _ = GalleryConfig.validate_gallery_root(entry)
policy.append((entry if type(entry) is str else None, valid))
current_scope = _opaque(
[
"prompt-manager-current-output-v1",
style,
output,
temp,
roots.output_key,
roots.temp_key,
str(canonical_output) if canonical_output is not None else None,
str(canonical_temp) if canonical_temp is not None else None,
[str(path) for path in authorized],
sorted(
str(_canonical(path))
for path in GalleryConfig.allowed_gallery_parents()
),
sorted(policy, key=lambda item: (item[0] or "", item[1])),
sorted(str(_canonical(path)) for path in GalleryConfig.path_anchors()),
"gallery-validation-v1",
]
)
return CurrentOutputScope(
style,
output,
temp,
roots,
canonical_output,
canonical_temp,
authorized,
current_scope,
)
def _descriptor_reason(reference: dict, scope: CurrentOutputScope) -> str | None:
try:
validate_output_reference(OutputReference("current", 0, **reference))
except (TypeError, ValueError):
return "namespace_mismatch"
if reference["path_style"] != scope.path_style:
return "foreign_path_style"
folder = reference["folder_type"]
expected = scope.roots.output_key if folder == "output" else scope.roots.temp_key
if reference["root_key"] is None or expected is None:
return "root_unavailable"
if reference["root_key"] != expected:
return "namespace_mismatch"
return None
def candidate_locator(reference: dict, scope: CurrentOutputScope) -> str | None:
"""Validate the native namespace before constructing a lexical path; no IO."""
if _descriptor_reason(reference, scope) is not None:
return None
root = (
scope.lexical_output
if reference["folder_type"] == "output"
else scope.lexical_temp
)
return os.path.normcase(
os.path.normpath(
os.path.join(root, reference["subfolder"], reference["filename"])
)
)
def _authorized(target: Path, namespace: Path, scope: CurrentOutputScope) -> bool:
return target.is_relative_to(namespace) and any(
target.is_relative_to(root) for root in scope.authorized_roots
)
def _unavailable(reason: str, *, error: bool = False) -> ResolvedCurrentCandidate:
return ResolvedCurrentCandidate(
{
"status": "error" if error else "unavailable",
"reason": reason,
"evidence_class": "locator_candidate",
}
)
def resolve_current_candidate(
reference: dict, scope: CurrentOutputScope, gallery: dict
) -> ResolvedCurrentCandidate:
"""Observe only this exact current locator and its snapshot-owned association."""
reason = _descriptor_reason(reference, scope)
if reason is not None:
return _unavailable(reason)
lexical = candidate_locator(reference, scope)
namespace = (
scope.canonical_output
if reference["folder_type"] == "output"
else scope.canonical_temp
)
try:
if Path(reference["filename"]).suffix.lower() not in SERVABLE_EXTENSIONS:
return _unavailable("unsupported_media")
if namespace is None or not namespace.is_dir():
return _unavailable("root_unavailable")
target = _canonical(lexical)
if not _authorized(target, namespace, scope):
return _unavailable("not_authorized")
if target.suffix.lower() not in SERVABLE_EXTENSIONS:
return _unavailable("unsupported_media")
observed = target.stat()
if not stat.S_ISREG(observed.st_mode):
return _unavailable("not_regular_file")
if not os.access(target, os.R_OK) or not observed.st_mode & 0o444:
return _unavailable("unreadable")
matching = gallery.get(lexical, {})
root = max(
(root for root in scope.authorized_roots if target.is_relative_to(root)),
key=lambda root: len(root.parts),
)
return ResolvedCurrentCandidate(
{
"status": "available",
"reason": None,
"evidence_class": "locator_candidate",
"gallery_match": matching.get("gallery_match", "none"),
"gallery_image_id": matching.get("gallery_image_id"),
"source_label": _public_path(namespace),
"relative_path": Path(
reference["subfolder"], reference["filename"]
).as_posix(),
"current_scope": scope.current_scope,
"location_key": _opaque(
["current-location-v1", scope.current_scope, str(target)]
),
},
target,
namespace,
root,
)
except FileNotFoundError:
return _unavailable("missing")
except PermissionError:
return _unavailable("unreadable")
except (OSError, ValueError):
return _unavailable("temporary_unavailable", error=True)
def _open_current_target(
target: Path, namespace: Path, scope: CurrentOutputScope
) -> BinaryIO:
"""Open only the canonical target and verify authority against the actual handle."""
if _canonical(target) != target:
raise CurrentLocationUnavailable("not_authorized", stale=True)
if not _authorized(target, namespace, scope):
raise CurrentLocationUnavailable("not_authorized")
if target.suffix.lower() not in SERVABLE_EXTENSIONS:
raise CurrentLocationUnavailable("unsupported_media")
flags = (
os.O_RDONLY
| getattr(os, "O_BINARY", 0)
| getattr(os, "O_NOFOLLOW", 0)
| getattr(os, "O_NONBLOCK", 0)
)
try:
fd = os.open(target, flags)
except FileNotFoundError:
raise CurrentLocationUnavailable("missing") from None
except PermissionError:
raise CurrentLocationUnavailable("unreadable") from None
except OSError as error:
if error.errno in (errno.ELOOP, errno.ENOTDIR):
raise CurrentLocationUnavailable("not_authorized", stale=True) from None
raise CurrentLocationUnavailable("temporary_unavailable") from None
try:
observed = os.fstat(fd)
if not stat.S_ISREG(observed.st_mode):
raise CurrentLocationUnavailable("not_regular_file")
if not observed.st_mode & 0o444 or not os.access(target, os.R_OK):
raise CurrentLocationUnavailable("unreadable")
current = os.stat(target, follow_symlinks=False)
if (
_canonical(target) != target
or (observed.st_dev, observed.st_ino) != (current.st_dev, current.st_ino)
or not _authorized(target, namespace, scope)
):
raise CurrentLocationUnavailable("not_authorized", stale=True)
return os.fdopen(fd, "rb")
except FileNotFoundError:
os.close(fd)
raise CurrentLocationUnavailable("missing") from None
except PermissionError:
os.close(fd)
raise CurrentLocationUnavailable("unreadable") from None
except BaseException:
os.close(fd)
raise
def _reauthorize_current_target(
resolved: ResolvedCurrentCandidate, scope: CurrentOutputScope
) -> None:
if _canonical(
resolved.canonical_target
) != resolved.canonical_target or not _authorized(
resolved.canonical_target, resolved.namespace, scope
):
raise CurrentLocationUnavailable("not_authorized", stale=True)
@dataclass
class _OpenedCurrentMedia:
handle: BinaryIO
size: int
content_type: str
def close(self) -> None:
self.handle.close()
def _prepare_current_media(
resolved: ResolvedCurrentCandidate, scope: CurrentOutputScope, *, thumbnail: bool
) -> _OpenedCurrentMedia:
target = resolved.canonical_target
if thumbnail:
relative = target.relative_to(resolved.gallery_root)
extension = (
".jpg"
if target.suffix.lower() in VIDEO_EXTENSIONS
else target.suffix.lower()
)
preview = (
resolved.gallery_root
/ "thumbnails"
/ f"{relative.with_suffix('').as_posix()}_thumb{extension}"
)
try:
preview.stat()
except FileNotFoundError:
pass
else:
target = _canonical(preview)
handle = _open_current_target(target, resolved.namespace, scope)
try:
return _OpenedCurrentMedia(
handle,
os.fstat(handle.fileno()).st_size,
mimetypes.guess_type(target.name)[0] or "application/octet-stream",
)
except BaseException:
handle.close()
raise
async def _current_media_response(
request: web.Request, opened: _OpenedCurrentMedia
) -> web.StreamResponse:
"""Stream a bounded single range from a previously authorized handle."""
try:
try:
selected = request.http_range
start, stop = selected.start, selected.stop
partial = request.headers.get("Range") is not None
if (
partial
and request.headers["Range"].startswith("bytes=-")
and start == 0
):
raise ValueError("Empty suffix range")
if start is not None and start < 0:
start = max(0, opened.size + start)
start = start or 0
stop = min(opened.size, stop) if stop is not None else opened.size
if partial and (start >= stop or start >= opened.size):
raise ValueError("Unsatisfiable current media range")
except ValueError:
return web.Response(
status=416,
headers={
"Cache-Control": "no-store",
"Content-Range": f"bytes */{opened.size}",
},
)
headers = {
"Cache-Control": "no-store",
"Accept-Ranges": "bytes",
"Content-Type": opened.content_type,
"Content-Length": str(stop - start),
}
if partial:
headers["Content-Range"] = f"bytes {start}-{stop - 1}/{opened.size}"
response = web.StreamResponse(status=206 if partial else 200, headers=headers)
await response.prepare(request)
if request.method != "HEAD":
opened.handle.seek(start)
remaining = stop - start
while remaining:
chunk = await asyncio.get_running_loop().run_in_executor(
None, opened.handle.read, min(_READ_SIZE, remaining)
)
if not chunk:
break
remaining -= len(chunk)
await response.write(chunk)
await response.write_eof()
return response
finally:
opened.close()
+20 -80
View File
@@ -20,41 +20,23 @@ from PIL import Image, UnidentifiedImageError
from .prompts import bad_request, parse_page_params, publish_image_paths
from .prompts import thumbnail_url_for
from .prompts import safe_error_message as _safe_error
from .inspection_service import (
CurrentFileChanged,
IMAGE_EXTENSIONS as _IMAGE_EXTENSIONS,
SERVABLE_EXTENSIONS,
VIDEO_EXTENSIONS,
inspect_current_file,
)
try:
from ...utils.parallel import map_parallel
from ...utils.inspection_response import encode_inspection_response
from ...utils.prompt_inspector import (
MetadataReadError,
inspect_prompt_evidence,
read_inspection_file,
)
except ImportError:
from utils.parallel import map_parallel
from utils.inspection_response import encode_inspection_response
from utils.prompt_inspector import (
MetadataReadError,
inspect_prompt_evidence,
read_inspection_file,
)
# Only these file types are ever served by the image routes, regardless of
# what sits inside an allowed directory (defence in depth for the gallery).
IMAGE_EXTENSIONS = frozenset(
{
".png",
".jpg",
".jpeg",
".webp",
".gif",
".bmp",
".tiff",
".tif",
".mp4",
".webm",
".mov",
}
)
IMAGE_EXTENSIONS = _IMAGE_EXTENSIONS
def _public_path(path):
@@ -106,11 +88,7 @@ def _media_access_error(path, allowed_dirs):
# Media types the gallery scans and thumbnails (a superset is never served).
GALLERY_IMAGE_EXTENSIONS = frozenset({".png", ".jpg", ".jpeg", ".webp", ".gif"})
VIDEO_EXTENSIONS = frozenset({".mp4", ".webm", ".avi", ".mov", ".mkv", ".m4v", ".wmv"})
MEDIA_EXTENSIONS = GALLERY_IMAGE_EXTENSIONS | VIDEO_EXTENSIONS
# What the serve routes hand out: every image type above plus every video type
# the gallery lists, so a card never points at a 403.
SERVABLE_EXTENSIONS = IMAGE_EXTENSIONS | VIDEO_EXTENSIONS
# Caps on request-triggered filesystem work.
MAX_SCAN_DEPTH = 12
@@ -1732,18 +1710,6 @@ class ImageRoutesMixin:
try:
def inspect() -> bytes | None:
before = path.stat()
try:
inspection = read_inspection_file(path)
except MetadataReadError:
inspection = None
try:
after = path.stat()
except FileNotFoundError:
return None
fields = ("st_dev", "st_ino", "st_size", "st_mtime_ns", "st_ctime_ns")
if any(getattr(before, key) != getattr(after, key) for key in fields):
return None
saved, unavailable = None, False
try:
saved = self.db.get_image_prompt_info(
@@ -1752,25 +1718,17 @@ class ImageRoutesMixin:
except Exception:
unavailable = True
self.logger.warning("Saved inspection display could not be read")
if inspection is None:
evidence = {
"prompts": {
role: {"status": "unresolved", "text": None, "source": None}
for role in ("positive", "negative")
},
"resolution": {
"state": "unresolved",
"sampler_id": None,
"reason": "Media metadata could not be read",
},
}
else:
role_saved = (
None
if saved and saved.get("association_status") == "ambiguous"
else saved
try:
observed = inspect_current_file(
path,
source_label=_public_path(roots[index]),
saved=saved,
library=self._inspection_library(
saved, unavailable=unavailable
),
)
evidence = inspect_prompt_evidence(inspection.metadata, role_saved)
except CurrentFileChanged:
return None
return encode_inspection_response(
image={
"root_index": index,
@@ -1778,25 +1736,7 @@ class ImageRoutesMixin:
"filename": path.name,
},
root_scope=root_scope,
file={
"observation": "current-file",
"source_label": _public_path(roots[index]),
"media_type": (
"video"
if path.suffix.lower() in VIDEO_EXTENSIONS
else "image"
),
"extension": path.suffix.lower(),
"size": before.st_size,
"modified_time": before.st_mtime,
"format": None,
"width": None,
"height": None,
},
prompts=evidence["prompts"],
resolution=evidence["resolution"],
inspection=inspection,
library=self._inspection_library(saved, unavailable=unavailable),
**observed,
)
body = await self._run_in_executor(inspect)
+107
View File
@@ -0,0 +1,107 @@
"""One bounded current-file inspection worker shared by physical identities."""
import os
import stat
from pathlib import Path
try:
from ...utils.prompt_inspector import (
MetadataReadError,
inspect_prompt_evidence,
read_inspection_file,
)
from ...utils.video_metadata import is_video_path
except ImportError:
from utils.prompt_inspector import (
MetadataReadError,
inspect_prompt_evidence,
read_inspection_file,
)
from utils.video_metadata import is_video_path
# Only these file types are served or inspected within an authorized directory.
IMAGE_EXTENSIONS = frozenset(
{
".png",
".jpg",
".jpeg",
".webp",
".gif",
".bmp",
".tiff",
".tif",
".mp4",
".webm",
".mov",
}
)
VIDEO_EXTENSIONS = frozenset({".mp4", ".webm", ".avi", ".mov", ".mkv", ".m4v", ".wmv"})
SERVABLE_EXTENSIONS = IMAGE_EXTENSIONS | VIDEO_EXTENSIONS
class CurrentFileChanged(Exception):
"""File facts are invalid or changed across the bounded metadata observation."""
def _current_file_facts(path: Path) -> os.stat_result:
if path.suffix.lower() not in SERVABLE_EXTENSIONS:
raise CurrentFileChanged
try:
observed = path.stat()
except (FileNotFoundError, NotADirectoryError, PermissionError):
raise CurrentFileChanged from None
if (
not stat.S_ISREG(observed.st_mode)
or not observed.st_mode & 0o444
or not os.access(path, os.R_OK)
):
raise CurrentFileChanged
return observed
def inspect_current_file(
path: Path, *, source_label: str, saved: dict | None, library: dict
) -> dict:
before = _current_file_facts(path)
try:
inspection = read_inspection_file(path)
except MetadataReadError:
inspection = None
after = _current_file_facts(path)
fields = ("st_dev", "st_ino", "st_mode", "st_size", "st_mtime_ns", "st_ctime_ns")
if any(getattr(before, key) != getattr(after, key) for key in fields):
raise CurrentFileChanged
if inspection is None:
evidence = {
"prompts": {
role: {"status": "unresolved", "text": None, "source": None}
for role in ("positive", "negative")
},
"resolution": {
"state": "unresolved",
"sampler_id": None,
"reason": "Media metadata could not be read",
},
}
else:
role_saved = (
None if saved and saved.get("association_status") == "ambiguous" else saved
)
evidence = inspect_prompt_evidence(inspection.metadata, role_saved)
return {
"file": {
"observation": "current-file",
"source_label": source_label,
"media_type": "video" if is_video_path(path) else "image",
"extension": path.suffix.lower(),
"size": before.st_size,
"modified_time": before.st_mtime,
"format": None,
"width": None,
"height": None,
},
**evidence,
"inspection": inspection,
"library": library,
}