Files
DocsGPT/docsgpt/api/v1/session_store.py
T
Alex 574f96341e refactor: rename the application package to docsgpt
The backend import package is now docsgpt, the name it will carry on PyPI;
application was far too generic to install into anyone's site-packages.
git mv plus a mechanical rewrite of every import, dotted string and path
reference: 734 Python files, the compose files, Dockerfile, workflows, docs,
setup scripts, devcontainer, k8s manifests, vscode config, pytest and coverage
config, .gitignore. Behaviour is unchanged.

Kept for one release:
- A top-level application package whose meta-path finder resolves
  application.x.y to the already-imported docsgpt.x.y object, so old imports
  and entry points (celery -A application.app.celery,
  uvicorn application.asgi:asgi_app) keep working with a FutureWarning.
- Celery registers every application.* task name as an alias of its
  docsgpt.* task on start-up, so messages queued by the previous release still
  run. The redbeat key prefix moves to redbeat:docsgpt:v2: so schedule entries
  the previous release wrote are left unread instead of firing twice.

The backend image builds from the repository root (docker build -f
docsgpt/Dockerfile .) so it can ship the alias package; a root .dockerignore
allow-lists docsgpt/ and application/ and keeps caches, local data, .env
files, the sample index files and the Dockerfile out. Compose and the image
workflows point at the new context.
2026-09-07 10:20:43 +01:00

100 lines
3.2 KiB
Python

"""Short-lived correlation for chat-completions clients.
OpenAI's chat-completions schema has no conversation id. Coding clients such
as OpenCode do send stable session headers, though, so map those opaque values
to DocsGPT conversations without storing or logging the raw client id.
"""
from __future__ import annotations
import hashlib
import json
import logging
from dataclasses import dataclass
from typing import Any, Mapping, Optional
from docsgpt.cache import get_redis_instance
from docsgpt.core.settings import settings
logger = logging.getLogger(__name__)
@dataclass(frozen=True)
class V1Session:
"""A hashed Redis key for one agent/client/prompt namespace."""
key: str
def _instruction_fingerprint(messages: list[dict[str, Any]]) -> str:
instructions = [
{"role": item.get("role"), "content": item.get("content")}
for item in messages
if item.get("role") in ("system", "developer")
]
encoded = json.dumps(instructions, sort_keys=True, separators=(",", ":"), default=str)
return hashlib.sha256(encoded.encode("utf-8")).hexdigest()
def identify_session(
headers: Mapping[str, str], data: dict[str, Any], agent_id: str
) -> Optional[V1Session]:
"""Build a privacy-preserving correlation key when the client supplies one."""
raw = (
headers.get("X-DocsGPT-Session-ID")
or (data.get("docsgpt") or {}).get("session_id")
or headers.get("X-Session-ID")
or headers.get("X-Session-Id")
or headers.get("X-Session-Affinity")
)
if not raw:
return None
prompt = _instruction_fingerprint(data.get("messages") or [])
digest = hashlib.sha256(f"{agent_id}\0{raw}\0{prompt}".encode("utf-8")).hexdigest()
return V1Session(key=f"v1:session:{digest}")
def load_conversation(session: Optional[V1Session]) -> Optional[str]:
"""Resolve a session key, degrading cleanly when Redis is unavailable."""
if session is None:
return None
client = get_redis_instance()
if client is None:
return None
try:
value = client.get(session.key)
return value.decode("utf-8") if isinstance(value, bytes) else value
except Exception:
logger.warning("Unable to load v1 session correlation", exc_info=True)
return None
def save_conversation(session: Optional[V1Session], conversation_id: Optional[str]) -> None:
"""Store a session mapping with a bounded lifetime."""
if session is None or not conversation_id or conversation_id == "None":
return
client = get_redis_instance()
if client is None:
return
try:
client.set(
session.key,
str(conversation_id),
ex=settings.V1_SESSION_TTL_SECONDS,
)
except Exception:
logger.warning("Unable to save v1 session correlation", exc_info=True)
def delete_conversation(session: Optional[V1Session]) -> None:
"""Delete a stale session mapping, degrading cleanly without Redis."""
if session is None:
return
client = get_redis_instance()
if client is None:
return
try:
client.delete(session.key)
except Exception:
logger.warning("Unable to delete v1 session correlation", exc_info=True)