mirror of
https://github.com/langgenius/dify.git
synced 2026-05-19 08:17:14 +08:00
8be6665d22
- Remove response_mode from AppRunRequest; openapi /run always streams - Add POST /apps/<id>/tasks/<task_id>/stop (SIGINT hook target) - Add GET/POST /apps/<id>/form/human_input/<token> (HITL form fetch/submit) - Add GET /apps/<id>/tasks/<task_id>/events (SSE reconnect after resume) - Add HumanInputSurface.OPENAPI; map to STANDALONE_WEB_APP recipient type - Regenerate cli/src/types/data-contracts.ts via pnpm sync-models
108 lines
4.2 KiB
Python
108 lines
4.2 KiB
Python
"""
|
|
OpenAPI bearer-authed human input form endpoints.
|
|
|
|
GET /apps/<app_id>/form/human_input/<form_token> — fetch paused form definition
|
|
POST /apps/<app_id>/form/human_input/<form_token> — submit form response
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
import logging
|
|
|
|
from flask import Response, request
|
|
from flask_restx import Resource
|
|
from werkzeug.exceptions import BadRequest, NotFound
|
|
|
|
from controllers.common.human_input import HumanInputFormSubmitPayload, stringify_form_default_values
|
|
from controllers.common.schema import register_schema_models
|
|
from controllers.openapi import openapi_ns
|
|
from controllers.openapi.auth.composition import OAUTH_BEARER_PIPELINE
|
|
from core.workflow.human_input_policy import HumanInputSurface, is_recipient_type_allowed_for_surface
|
|
from extensions.ext_database import db
|
|
from libs.helper import to_timestamp
|
|
from libs.oauth_bearer import Scope
|
|
from models.model import App
|
|
from services.human_input_service import FormNotFoundError, HumanInputService
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
register_schema_models(openapi_ns, HumanInputFormSubmitPayload)
|
|
|
|
|
|
def _jsonify_form_definition(form) -> Response:
|
|
definition_payload = form.get_definition().model_dump()
|
|
payload = {
|
|
"form_content": definition_payload["rendered_content"],
|
|
"inputs": definition_payload["inputs"],
|
|
"resolved_default_values": stringify_form_default_values(definition_payload["default_values"]),
|
|
"user_actions": definition_payload["user_actions"],
|
|
"expiration_time": to_timestamp(form.expiration_time),
|
|
}
|
|
return Response(json.dumps(payload, ensure_ascii=False), mimetype="application/json")
|
|
|
|
|
|
def _ensure_form_belongs_to_app(form, app_model: App) -> None:
|
|
if form.app_id != app_model.id or form.tenant_id != app_model.tenant_id:
|
|
raise NotFound("Form not found")
|
|
|
|
|
|
def _ensure_form_is_allowed_for_openapi(form) -> None:
|
|
if not is_recipient_type_allowed_for_surface(form.recipient_type, HumanInputSurface.OPENAPI):
|
|
raise NotFound("Form not found")
|
|
|
|
|
|
@openapi_ns.route("/apps/<string:app_id>/form/human_input/<string:form_token>")
|
|
class OpenApiWorkflowHumanInputFormApi(Resource):
|
|
@openapi_ns.response(200, "Form definition")
|
|
@OAUTH_BEARER_PIPELINE.guard(scope=Scope.APPS_RUN)
|
|
def get(self, app_id: str, form_token: str, app_model: App, caller, caller_kind: str):
|
|
service = HumanInputService(db.engine)
|
|
form = service.get_form_by_token(form_token)
|
|
if form is None:
|
|
raise NotFound("Form not found")
|
|
|
|
_ensure_form_belongs_to_app(form, app_model)
|
|
_ensure_form_is_allowed_for_openapi(form)
|
|
service.ensure_form_active(form)
|
|
return _jsonify_form_definition(form)
|
|
|
|
@openapi_ns.expect(openapi_ns.models[HumanInputFormSubmitPayload.__name__])
|
|
@openapi_ns.response(200, "Form submitted")
|
|
@OAUTH_BEARER_PIPELINE.guard(scope=Scope.APPS_RUN)
|
|
def post(self, app_id: str, form_token: str, app_model: App, caller, caller_kind: str):
|
|
payload = HumanInputFormSubmitPayload.model_validate(request.get_json(silent=True) or {})
|
|
|
|
service = HumanInputService(db.engine)
|
|
form = service.get_form_by_token(form_token)
|
|
if form is None:
|
|
raise NotFound("Form not found")
|
|
|
|
_ensure_form_belongs_to_app(form, app_model)
|
|
_ensure_form_is_allowed_for_openapi(form)
|
|
|
|
submission_user_id: str | None = None
|
|
submission_end_user_id: str | None = None
|
|
if caller_kind == "account":
|
|
submission_user_id = caller.id
|
|
else:
|
|
submission_end_user_id = caller.id
|
|
|
|
if form.recipient_type is None:
|
|
logger.warning("Recipient type is None for form, form_token=%s", form_token)
|
|
raise BadRequest("Form recipient type is invalid")
|
|
|
|
try:
|
|
service.submit_form_by_token(
|
|
recipient_type=form.recipient_type,
|
|
form_token=form_token,
|
|
selected_action_id=payload.action,
|
|
form_data=payload.inputs,
|
|
submission_user_id=submission_user_id,
|
|
submission_end_user_id=submission_end_user_id,
|
|
)
|
|
except FormNotFoundError:
|
|
raise NotFound("Form not found")
|
|
|
|
return {}, 200
|