dify/api/machinery/context.py

"""Stable values passed from API admission into application services."""

from dataclasses import dataclass
from typing import NamedTuple


@dataclass(frozen=True, slots=True, kw_only=True)
class AppRequestContext:
    """Tenant and app scope established by API admission."""

    tenant_id: str
    app_id: str


class RequestContext(NamedTuple):
    """Framework-neutral request metadata and admitted identity.

    Anonymous admission uses empty ``account_id`` and ``active_workspace_id`` values.
    ``resource_app_ids`` is absent for account callers; an empty set admits no apps.
    ``personal_app_ids`` limits account visibility to PAT selections; None adds no restriction.
    """

    request_id: str
    trace_id: str | None
    account_id: str
    active_workspace_id: str
    remote_ip: str | None = None
    resource_app_ids: frozenset[str] | None = None
    personal_app_ids: frozenset[str] | None = None


@dataclass(frozen=True, slots=True, kw_only=True)
class ServiceApiEndUserContext(AppRequestContext):
    """Validated application mode and end-user identity for a Service API request."""

    app_mode: str
    end_user_id: str


@dataclass(frozen=True, slots=True, kw_only=True)
class ServiceApiAccountRequestContext(AppRequestContext):
    """App scope and its workspace owner admitted for account-backed Service APIs."""

    account_id: str


class AccountRequestContext(NamedTuple):
    """Stable identity for account-scoped use cases that do not require a workspace."""

    request_id: str
    trace_id: str | None
    account_id: str
    access_token_id: str | None = None