kanshan/dify
1
0
Fork 0
mirror of https://github.com/langgenius/dify.git synced 2026-01-13 21:57:48 +08:00
Code Issues Actions 11 Packages Projects Releases Wiki Activity

refactor: split changes for api/controllers/console/workspace/trigger… (#30627)

Browse Source 
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
This commit is contained in:
Asuka Minato 2026-01-07 22:18:02 +09:00 committed by GitHub
parent a422908efd
commit 885f226f77
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 52 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

133
api/controllers/console/workspace/trigger_providers.py
View File

@ -1,14 +1,14 @@
import logging import logging
from collections.abc import Mapping
from typing import Any from typing import Any
from flask import make_response, redirect, request from flask import make_response, redirect, request
from flask_restx import Resource, reqparse from flask_restx import Resource
from pydantic import BaseModel, Field, model_validator from pydantic import BaseModel, model_validator
from sqlalchemy.orm import Session from sqlalchemy.orm import Session
from werkzeug.exceptions import BadRequest, Forbidden from werkzeug.exceptions import BadRequest, Forbidden
from configs import dify_config from configs import dify_config
from controllers.common.schema import register_schema_models
from controllers.web.error import NotFoundError from controllers.web.error import NotFoundError
from core.model_runtime.utils.encoders import jsonable_encoder from core.model_runtime.utils.encoders import jsonable_encoder
from core.plugin.entities.plugin_daemon import CredentialType from core.plugin.entities.plugin_daemon import CredentialType
@ -35,35 +35,38 @@ from ..wraps import (
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
class TriggerSubscriptionUpdateRequest(BaseModel): class TriggerSubscriptionBuilderCreatePayload(BaseModel):
"""Request payload for updating a trigger subscription""" credential_type: str = CredentialType.UNAUTHORIZED
name: str | None = Field(default=None, description="The name for the subscription")
credentials: Mapping[str, Any] | None = Field(default=None, description="The credentials for the subscription") class TriggerSubscriptionBuilderVerifyPayload(BaseModel):
parameters: Mapping[str, Any] | None = Field(default=None, description="The parameters for the subscription") credentials: dict[str, Any]
properties: Mapping[str, Any] | None = Field(default=None, description="The properties for the subscription")
class TriggerSubscriptionBuilderUpdatePayload(BaseModel):
name: str | None = None
parameters: dict[str, Any] | None = None
properties: dict[str, Any] | None = None
credentials: dict[str, Any] | None = None
@model_validator(mode="after") @model_validator(mode="after")
def check_at_least_one_field(self): def check_at_least_one_field(self):
if all(v is None for v in (self.name, self.credentials, self.parameters, self.properties)): if all(v is None for v in self.model_dump().values()):
raise ValueError("At least one of name, credentials, parameters, or properties must be provided") raise ValueError("At least one of name, credentials, parameters, or properties must be provided")
return self return self
class TriggerSubscriptionVerifyRequest(BaseModel): class TriggerOAuthClientPayload(BaseModel):
"""Request payload for verifying subscription credentials.""" client_params: dict[str, Any] | None = None
enabled: bool | None = None
credentials: Mapping[str, Any] = Field(description="The credentials to verify")
console_ns.schema_model( register_schema_models(
TriggerSubscriptionUpdateRequest.__name__, console_ns,
TriggerSubscriptionUpdateRequest.model_json_schema(ref_template="#/definitions/{model}"), TriggerSubscriptionBuilderCreatePayload,
) TriggerSubscriptionBuilderVerifyPayload,
TriggerSubscriptionBuilderUpdatePayload,
console_ns.schema_model( TriggerOAuthClientPayload,
TriggerSubscriptionVerifyRequest.__name__,
TriggerSubscriptionVerifyRequest.model_json_schema(ref_template="#/definitions/{model}"),
) )
@ -132,16 +135,11 @@ class TriggerSubscriptionListApi(Resource):
raise raise
parser = reqparse.RequestParser().add_argument(
"credential_type", type=str, required=False, nullable=True, location="json"
)
@console_ns.route( @console_ns.route(
"/workspaces/current/trigger-provider/<path:provider>/subscriptions/builder/create", "/workspaces/current/trigger-provider/<path:provider>/subscriptions/builder/create",
) )
class TriggerSubscriptionBuilderCreateApi(Resource): class TriggerSubscriptionBuilderCreateApi(Resource):
@console_ns.expect(parser) @console_ns.expect(console_ns.models[TriggerSubscriptionBuilderCreatePayload.__name__])
@setup_required @setup_required
@login_required @login_required
@edit_permission_required @edit_permission_required
@ -151,10 +149,10 @@ class TriggerSubscriptionBuilderCreateApi(Resource):
user = current_user user = current_user
assert user.current_tenant_id is not None assert user.current_tenant_id is not None
args = parser.parse_args() payload = TriggerSubscriptionBuilderCreatePayload.model_validate(console_ns.payload or {})
try: try:
credential_type = CredentialType.of(args.get("credential_type") or CredentialType.UNAUTHORIZED.value) credential_type = CredentialType.of(payload.credential_type)
subscription_builder = TriggerSubscriptionBuilderService.create_trigger_subscription_builder( subscription_builder = TriggerSubscriptionBuilderService.create_trigger_subscription_builder(
tenant_id=user.current_tenant_id, tenant_id=user.current_tenant_id,
user_id=user.id, user_id=user.id,
@ -182,18 +180,11 @@ class TriggerSubscriptionBuilderGetApi(Resource):
) )
parser_api = (
reqparse.RequestParser()
# The credentials of the subscription builder
.add_argument("credentials", type=dict, required=False, nullable=True, location="json")
)
@console_ns.route( @console_ns.route(
"/workspaces/current/trigger-provider/<path:provider>/subscriptions/builder/verify-and-update/<path:subscription_builder_id>", "/workspaces/current/trigger-provider/<path:provider>/subscriptions/builder/verify-and-update/<path:subscription_builder_id>",
) )
class TriggerSubscriptionBuilderVerifyAndUpdateApi(Resource): class TriggerSubscriptionBuilderVerifyApi(Resource):
@console_ns.expect(parser_api) @console_ns.expect(console_ns.models[TriggerSubscriptionBuilderVerifyPayload.__name__])
@setup_required @setup_required
@login_required @login_required
@edit_permission_required @edit_permission_required
@ -203,7 +194,7 @@ class TriggerSubscriptionBuilderVerifyAndUpdateApi(Resource):
user = current_user user = current_user
assert user.current_tenant_id is not None assert user.current_tenant_id is not None
args = parser_api.parse_args() payload = TriggerSubscriptionBuilderVerifyPayload.model_validate(console_ns.payload or {})
try: try:
# Use atomic update_and_verify to prevent race conditions # Use atomic update_and_verify to prevent race conditions
@ -213,7 +204,7 @@ class TriggerSubscriptionBuilderVerifyAndUpdateApi(Resource):
provider_id=TriggerProviderID(provider), provider_id=TriggerProviderID(provider),
subscription_builder_id=subscription_builder_id, subscription_builder_id=subscription_builder_id,
subscription_builder_updater=SubscriptionBuilderUpdater( subscription_builder_updater=SubscriptionBuilderUpdater(
credentials=args.get("credentials", None), credentials=payload.credentials,
), ),
) )
except Exception as e: except Exception as e:
@ -221,24 +212,11 @@ class TriggerSubscriptionBuilderVerifyAndUpdateApi(Resource):
raise ValueError(str(e)) from e raise ValueError(str(e)) from e
parser_update_api = (
reqparse.RequestParser()
# The name of the subscription builder
.add_argument("name", type=str, required=False, nullable=True, location="json")
# The parameters of the subscription builder
.add_argument("parameters", type=dict, required=False, nullable=True, location="json")
# The properties of the subscription builder
.add_argument("properties", type=dict, required=False, nullable=True, location="json")
# The credentials of the subscription builder
.add_argument("credentials", type=dict, required=False, nullable=True, location="json")
)
@console_ns.route( @console_ns.route(
"/workspaces/current/trigger-provider/<path:provider>/subscriptions/builder/update/<path:subscription_builder_id>", "/workspaces/current/trigger-provider/<path:provider>/subscriptions/builder/update/<path:subscription_builder_id>",
) )
class TriggerSubscriptionBuilderUpdateApi(Resource): class TriggerSubscriptionBuilderUpdateApi(Resource):
@console_ns.expect(parser_update_api) @console_ns.expect(console_ns.models[TriggerSubscriptionBuilderUpdatePayload.__name__])
@setup_required @setup_required
@login_required @login_required
@edit_permission_required @edit_permission_required
@ -249,7 +227,7 @@ class TriggerSubscriptionBuilderUpdateApi(Resource):
assert isinstance(user, Account) assert isinstance(user, Account)
assert user.current_tenant_id is not None assert user.current_tenant_id is not None
args = parser_update_api.parse_args() payload = TriggerSubscriptionBuilderUpdatePayload.model_validate(console_ns.payload or {})
try: try:
return jsonable_encoder( return jsonable_encoder(
TriggerSubscriptionBuilderService.update_trigger_subscription_builder( TriggerSubscriptionBuilderService.update_trigger_subscription_builder(
@ -257,10 +235,10 @@ class TriggerSubscriptionBuilderUpdateApi(Resource):
provider_id=TriggerProviderID(provider), provider_id=TriggerProviderID(provider),
subscription_builder_id=subscription_builder_id, subscription_builder_id=subscription_builder_id,
subscription_builder_updater=SubscriptionBuilderUpdater( subscription_builder_updater=SubscriptionBuilderUpdater(
name=args.get("name", None), name=payload.name,
parameters=args.get("parameters", None), parameters=payload.parameters,
properties=args.get("properties", None), properties=payload.properties,
credentials=args.get("credentials", None), credentials=payload.credentials,
), ),
) )
) )
@ -295,7 +273,7 @@ class TriggerSubscriptionBuilderLogsApi(Resource):
"/workspaces/current/trigger-provider/<path:provider>/subscriptions/builder/build/<path:subscription_builder_id>", "/workspaces/current/trigger-provider/<path:provider>/subscriptions/builder/build/<path:subscription_builder_id>",
) )
class TriggerSubscriptionBuilderBuildApi(Resource): class TriggerSubscriptionBuilderBuildApi(Resource):
@console_ns.expect(parser_update_api) @console_ns.expect(console_ns.models[TriggerSubscriptionBuilderUpdatePayload.__name__])
@setup_required @setup_required
@login_required @login_required
@edit_permission_required @edit_permission_required
@ -304,7 +282,7 @@ class TriggerSubscriptionBuilderBuildApi(Resource):
"""Build a subscription instance for a trigger provider""" """Build a subscription instance for a trigger provider"""
user = current_user user = current_user
assert user.current_tenant_id is not None assert user.current_tenant_id is not None
args = parser_update_api.parse_args() payload = TriggerSubscriptionBuilderUpdatePayload.model_validate(console_ns.payload or {})
try: try:
# Use atomic update_and_build to prevent race conditions # Use atomic update_and_build to prevent race conditions
TriggerSubscriptionBuilderService.update_and_build_builder( TriggerSubscriptionBuilderService.update_and_build_builder(
@ -313,9 +291,9 @@ class TriggerSubscriptionBuilderBuildApi(Resource):
provider_id=TriggerProviderID(provider), provider_id=TriggerProviderID(provider),
subscription_builder_id=subscription_builder_id, subscription_builder_id=subscription_builder_id,
subscription_builder_updater=SubscriptionBuilderUpdater( subscription_builder_updater=SubscriptionBuilderUpdater(
name=args.get("name", None), name=payload.name,
parameters=args.get("parameters", None), parameters=payload.parameters,
properties=args.get("properties", None), properties=payload.properties,
), ),
) )
return 200 return 200
@ -328,7 +306,7 @@ class TriggerSubscriptionBuilderBuildApi(Resource):
"/workspaces/current/trigger-provider/<path:subscription_id>/subscriptions/update", "/workspaces/current/trigger-provider/<path:subscription_id>/subscriptions/update",
) )
class TriggerSubscriptionUpdateApi(Resource): class TriggerSubscriptionUpdateApi(Resource):
@console_ns.expect(console_ns.models[TriggerSubscriptionUpdateRequest.__name__]) @console_ns.expect(console_ns.models[TriggerSubscriptionBuilderUpdatePayload.__name__])
@setup_required @setup_required
@login_required @login_required
@edit_permission_required @edit_permission_required
@ -338,7 +316,7 @@ class TriggerSubscriptionUpdateApi(Resource):
user = current_user user = current_user
assert user.current_tenant_id is not None assert user.current_tenant_id is not None
request = TriggerSubscriptionUpdateRequest.model_validate(console_ns.payload) request = TriggerSubscriptionBuilderUpdatePayload.model_validate(console_ns.payload or {})
subscription = TriggerProviderService.get_subscription_by_id( subscription = TriggerProviderService.get_subscription_by_id(
tenant_id=user.current_tenant_id, tenant_id=user.current_tenant_id,
@ -568,13 +546,6 @@ class TriggerOAuthCallbackApi(Resource):
return redirect(f"{dify_config.CONSOLE_WEB_URL}/oauth-callback") return redirect(f"{dify_config.CONSOLE_WEB_URL}/oauth-callback")
parser_oauth_client = (
reqparse.RequestParser()
.add_argument("client_params", type=dict, required=False, nullable=True, location="json")
.add_argument("enabled", type=bool, required=False, nullable=True, location="json")
)
@console_ns.route("/workspaces/current/trigger-provider/<path:provider>/oauth/client") @console_ns.route("/workspaces/current/trigger-provider/<path:provider>/oauth/client")
class TriggerOAuthClientManageApi(Resource): class TriggerOAuthClientManageApi(Resource):
@setup_required @setup_required
@ -622,7 +593,7 @@ class TriggerOAuthClientManageApi(Resource):
logger.exception("Error getting OAuth client", exc_info=e) logger.exception("Error getting OAuth client", exc_info=e)
raise raise
@console_ns.expect(parser_oauth_client) @console_ns.expect(console_ns.models[TriggerOAuthClientPayload.__name__])
@setup_required @setup_required
@login_required @login_required
@is_admin_or_owner_required @is_admin_or_owner_required
@ -632,15 +603,15 @@ class TriggerOAuthClientManageApi(Resource):
user = current_user user = current_user
assert user.current_tenant_id is not None assert user.current_tenant_id is not None
args = parser_oauth_client.parse_args() payload = TriggerOAuthClientPayload.model_validate(console_ns.payload or {})
try: try:
provider_id = TriggerProviderID(provider) provider_id = TriggerProviderID(provider)
return TriggerProviderService.save_custom_oauth_client_params( return TriggerProviderService.save_custom_oauth_client_params(
tenant_id=user.current_tenant_id, tenant_id=user.current_tenant_id,
provider_id=provider_id, provider_id=provider_id,
client_params=args.get("client_params"), client_params=payload.client_params,
enabled=args.get("enabled"), enabled=payload.enabled,
) )
except ValueError as e: except ValueError as e:
@ -676,7 +647,7 @@ class TriggerOAuthClientManageApi(Resource):
"/workspaces/current/trigger-provider/<path:provider>/subscriptions/verify/<path:subscription_id>", "/workspaces/current/trigger-provider/<path:provider>/subscriptions/verify/<path:subscription_id>",
) )
class TriggerSubscriptionVerifyApi(Resource): class TriggerSubscriptionVerifyApi(Resource):
@console_ns.expect(console_ns.models[TriggerSubscriptionVerifyRequest.__name__]) @console_ns.expect(console_ns.models[TriggerSubscriptionBuilderVerifyPayload.__name__])
@setup_required @setup_required
@login_required @login_required
@edit_permission_required @edit_permission_required
@ -686,9 +657,7 @@ class TriggerSubscriptionVerifyApi(Resource):
user = current_user user = current_user
assert user.current_tenant_id is not None assert user.current_tenant_id is not None
verify_request: TriggerSubscriptionVerifyRequest = TriggerSubscriptionVerifyRequest.model_validate( verify_request = TriggerSubscriptionBuilderVerifyPayload.model_validate(console_ns.payload or {})
console_ns.payload
)
try: try:
result = TriggerProviderService.verify_subscription_credentials( result = TriggerProviderService.verify_subscription_credentials(

2
api/services/trigger/trigger_provider_service.py
View File

@ -799,7 +799,7 @@ class TriggerProviderService:
user_id: str, user_id: str,
provider_id: TriggerProviderID, provider_id: TriggerProviderID,
subscription_id: str, subscription_id: str,
credentials: Mapping[str, Any], credentials: dict[str, Any],
) -> dict[str, Any]: ) -> dict[str, Any]:
""" """
Verify credentials for an existing subscription without updating it. Verify credentials for an existing subscription without updating it.