Files
dify/api/controllers/console/explore/trial_app_admission.py
33b1c57f9d feat: document API errors per code and narrow them with oRPC defined errors (#44001)
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-10-14 08:25:50 +00:00

61 lines
2.5 KiB
Python

"""Trial execution admission for handlers using a detached app reference."""
from collections.abc import Callable
from functools import wraps
from typing import Concatenate
from controllers.console.explore.error import TrialAppFeatureDisabledError, TrialAppLimitExceeded, TrialAppNotAllowed
from extensions.ext_application_services import application_services
from libs.external_api import document_errors
from machinery.context import RequestContext
from services.trial_app_access_service import (
TrialAppRef,
TrialAppUnavailableError,
TrialAppUsageLimitExceededError,
)
def trial_feature_enable[**P, R](view: Callable[P, R]) -> Callable[P, R]:
"""Gate trial execution before resolving app membership or account usage."""
@wraps(view)
def decorated(*args: P.args, **kwargs: P.kwargs) -> R:
if not application_services().recommended_app_queries.is_trial_enabled():
raise TrialAppFeatureDisabledError()
return view(*args, **kwargs)
return document_errors(decorated, TrialAppFeatureDisabledError)
def get_trial_app[T, **P, R](
view: Callable[Concatenate[T, RequestContext, TrialAppRef, P], R],
*,
check_usage: bool = True,
) -> Callable[Concatenate[T, RequestContext, P], R]:
"""Admit the trial app, optionally skipping generation quota for task cancellation."""
@wraps(view)
def decorated(self: T, request_context: RequestContext, /, *args: P.args, **kwargs: P.kwargs) -> R:
app_id = kwargs.pop("app_id", None)
if app_id is None:
raise RuntimeError("The trial app admission route must provide app_id")
try:
trial_app = application_services().trial_apps.access.get_access(
app_id=str(app_id), account_id=request_context.account_id, check_usage=check_usage
)
except TrialAppUnavailableError as error:
raise TrialAppNotAllowed() from error
except TrialAppUsageLimitExceededError as error:
raise TrialAppLimitExceeded() from error
return view(self, request_context, trial_app, *args, **kwargs)
documented = (TrialAppNotAllowed, TrialAppLimitExceeded) if check_usage else (TrialAppNotAllowed,)
return trial_feature_enable(document_errors(decorated, *documented))
def get_trial_app_for_stop[T, **P, R](
view: Callable[Concatenate[T, RequestContext, TrialAppRef, P], R],
) -> Callable[Concatenate[T, RequestContext, P], R]:
"""Keep trial access checks without requiring remaining generation quota."""
return get_trial_app(view, check_usage=False)