app_dsl_service.py 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486
  1. import logging
  2. import uuid
  3. from enum import StrEnum
  4. from typing import Optional
  5. from uuid import uuid4
  6. import yaml
  7. from packaging import version
  8. from pydantic import BaseModel
  9. from sqlalchemy import select
  10. from sqlalchemy.orm import Session
  11. from core.helper import ssrf_proxy
  12. from events.app_event import app_model_config_was_updated, app_was_created
  13. from extensions.ext_redis import redis_client
  14. from factories import variable_factory
  15. from models import Account, App, AppMode
  16. from models.model import AppModelConfig
  17. from services.workflow_service import WorkflowService
  18. logger = logging.getLogger(__name__)
  19. IMPORT_INFO_REDIS_KEY_PREFIX = "app_import_info:"
  20. IMPORT_INFO_REDIS_EXPIRY = 180 # 3 minutes
  21. CURRENT_DSL_VERSION = "0.1.3"
  22. class ImportMode(StrEnum):
  23. YAML_CONTENT = "yaml-content"
  24. YAML_URL = "yaml-url"
  25. class ImportStatus(StrEnum):
  26. COMPLETED = "completed"
  27. COMPLETED_WITH_WARNINGS = "completed-with-warnings"
  28. PENDING = "pending"
  29. FAILED = "failed"
  30. class Import(BaseModel):
  31. id: str
  32. status: ImportStatus
  33. app_id: Optional[str] = None
  34. current_dsl_version: str = CURRENT_DSL_VERSION
  35. imported_dsl_version: str = ""
  36. error: str = ""
  37. def _check_version_compatibility(imported_version: str) -> ImportStatus:
  38. """Determine import status based on version comparison"""
  39. try:
  40. current_ver = version.parse(CURRENT_DSL_VERSION)
  41. imported_ver = version.parse(imported_version)
  42. except version.InvalidVersion:
  43. return ImportStatus.FAILED
  44. # Compare major version and minor version
  45. if current_ver.major != imported_ver.major or current_ver.minor != imported_ver.minor:
  46. return ImportStatus.PENDING
  47. if current_ver.micro != imported_ver.micro:
  48. return ImportStatus.COMPLETED_WITH_WARNINGS
  49. return ImportStatus.COMPLETED
  50. class PendingData(BaseModel):
  51. import_mode: str
  52. yaml_content: str
  53. name: str | None
  54. description: str | None
  55. icon_type: str | None
  56. icon: str | None
  57. icon_background: str | None
  58. app_id: str | None
  59. class AppDslService:
  60. def __init__(self, session: Session):
  61. self._session = session
  62. def import_app(
  63. self,
  64. *,
  65. account: Account,
  66. import_mode: str,
  67. yaml_content: Optional[str] = None,
  68. yaml_url: Optional[str] = None,
  69. name: Optional[str] = None,
  70. description: Optional[str] = None,
  71. icon_type: Optional[str] = None,
  72. icon: Optional[str] = None,
  73. icon_background: Optional[str] = None,
  74. app_id: Optional[str] = None,
  75. ) -> Import:
  76. """Import an app from YAML content or URL."""
  77. import_id = str(uuid.uuid4())
  78. # Validate import mode
  79. try:
  80. mode = ImportMode(import_mode)
  81. except ValueError:
  82. raise ValueError(f"Invalid import_mode: {import_mode}")
  83. # Get YAML content
  84. content = ""
  85. if mode == ImportMode.YAML_URL:
  86. if not yaml_url:
  87. return Import(
  88. id=import_id,
  89. status=ImportStatus.FAILED,
  90. error="yaml_url is required when import_mode is yaml-url",
  91. )
  92. try:
  93. max_size = 10 * 1024 * 1024 # 10MB
  94. response = ssrf_proxy.get(yaml_url.strip(), follow_redirects=True, timeout=(10, 10))
  95. response.raise_for_status()
  96. content = response.content
  97. if len(content) > max_size:
  98. return Import(
  99. id=import_id,
  100. status=ImportStatus.FAILED,
  101. error="File size exceeds the limit of 10MB",
  102. )
  103. if not content:
  104. return Import(
  105. id=import_id,
  106. status=ImportStatus.FAILED,
  107. error="Empty content from url",
  108. )
  109. try:
  110. content = content.decode("utf-8")
  111. except UnicodeDecodeError as e:
  112. return Import(
  113. id=import_id,
  114. status=ImportStatus.FAILED,
  115. error=f"Error decoding content: {e}",
  116. )
  117. except Exception as e:
  118. return Import(
  119. id=import_id,
  120. status=ImportStatus.FAILED,
  121. error=f"Error fetching YAML from URL: {str(e)}",
  122. )
  123. elif mode == ImportMode.YAML_CONTENT:
  124. if not yaml_content:
  125. return Import(
  126. id=import_id,
  127. status=ImportStatus.FAILED,
  128. error="yaml_content is required when import_mode is yaml-content",
  129. )
  130. content = yaml_content
  131. # Process YAML content
  132. try:
  133. # Parse YAML to validate format
  134. data = yaml.safe_load(content)
  135. if not isinstance(data, dict):
  136. return Import(
  137. id=import_id,
  138. status=ImportStatus.FAILED,
  139. error="Invalid YAML format: content must be a mapping",
  140. )
  141. # Validate and fix DSL version
  142. if not data.get("version"):
  143. data["version"] = "0.1.0"
  144. if not data.get("kind") or data.get("kind") != "app":
  145. data["kind"] = "app"
  146. imported_version = data.get("version", "0.1.0")
  147. status = _check_version_compatibility(imported_version)
  148. # Extract app data
  149. app_data = data.get("app")
  150. if not app_data:
  151. return Import(
  152. id=import_id,
  153. status=ImportStatus.FAILED,
  154. error="Missing app data in YAML content",
  155. )
  156. # If app_id is provided, check if it exists
  157. app = None
  158. if app_id:
  159. stmt = select(App).where(App.id == app_id, App.tenant_id == account.current_tenant_id)
  160. app = self._session.scalar(stmt)
  161. if not app:
  162. return Import(
  163. id=import_id,
  164. status=ImportStatus.FAILED,
  165. error="App not found",
  166. )
  167. if app.mode not in [AppMode.WORKFLOW.value, AppMode.ADVANCED_CHAT.value]:
  168. return Import(
  169. id=import_id,
  170. status=ImportStatus.FAILED,
  171. error="Only workflow or advanced chat apps can be overwritten",
  172. )
  173. # If major version mismatch, store import info in Redis
  174. if status == ImportStatus.PENDING:
  175. panding_data = PendingData(
  176. import_mode=import_mode,
  177. yaml_content=content,
  178. name=name,
  179. description=description,
  180. icon_type=icon_type,
  181. icon=icon,
  182. icon_background=icon_background,
  183. app_id=app_id,
  184. )
  185. redis_client.setex(
  186. f"{IMPORT_INFO_REDIS_KEY_PREFIX}{import_id}",
  187. IMPORT_INFO_REDIS_EXPIRY,
  188. panding_data.model_dump_json(),
  189. )
  190. return Import(
  191. id=import_id,
  192. status=status,
  193. app_id=app_id,
  194. imported_dsl_version=imported_version,
  195. )
  196. # Create or update app
  197. app = self._create_or_update_app(
  198. app=app,
  199. data=data,
  200. account=account,
  201. name=name,
  202. description=description,
  203. icon_type=icon_type,
  204. icon=icon,
  205. icon_background=icon_background,
  206. )
  207. return Import(
  208. id=import_id,
  209. status=status,
  210. app_id=app.id,
  211. imported_dsl_version=imported_version,
  212. )
  213. except yaml.YAMLError as e:
  214. return Import(
  215. id=import_id,
  216. status=ImportStatus.FAILED,
  217. error=f"Invalid YAML format: {str(e)}",
  218. )
  219. except Exception as e:
  220. logger.exception("Failed to import app")
  221. return Import(
  222. id=import_id,
  223. status=ImportStatus.FAILED,
  224. error=str(e),
  225. )
  226. def confirm_import(self, *, import_id: str, account: Account) -> Import:
  227. """
  228. Confirm an import that requires confirmation
  229. """
  230. redis_key = f"{IMPORT_INFO_REDIS_KEY_PREFIX}{import_id}"
  231. pending_data = redis_client.get(redis_key)
  232. if not pending_data:
  233. return Import(
  234. id=import_id,
  235. status=ImportStatus.FAILED,
  236. error="Import information expired or does not exist",
  237. )
  238. try:
  239. if not isinstance(pending_data, str | bytes):
  240. return Import(
  241. id=import_id,
  242. status=ImportStatus.FAILED,
  243. error="Invalid import information",
  244. )
  245. pending_data = PendingData.model_validate_json(pending_data)
  246. data = yaml.safe_load(pending_data.yaml_content)
  247. app = None
  248. if pending_data.app_id:
  249. stmt = select(App).where(App.id == pending_data.app_id, App.tenant_id == account.current_tenant_id)
  250. app = self._session.scalar(stmt)
  251. # Create or update app
  252. app = self._create_or_update_app(
  253. app=app,
  254. data=data,
  255. account=account,
  256. name=pending_data.name,
  257. description=pending_data.description,
  258. icon_type=pending_data.icon_type,
  259. icon=pending_data.icon,
  260. icon_background=pending_data.icon_background,
  261. )
  262. # Delete import info from Redis
  263. redis_client.delete(redis_key)
  264. return Import(
  265. id=import_id,
  266. status=ImportStatus.COMPLETED,
  267. app_id=app.id,
  268. current_dsl_version=CURRENT_DSL_VERSION,
  269. imported_dsl_version=data.get("version", "0.1.0"),
  270. )
  271. except Exception as e:
  272. logger.exception("Error confirming import")
  273. return Import(
  274. id=import_id,
  275. status=ImportStatus.FAILED,
  276. error=str(e),
  277. )
  278. def _create_or_update_app(
  279. self,
  280. *,
  281. app: Optional[App],
  282. data: dict,
  283. account: Account,
  284. name: Optional[str] = None,
  285. description: Optional[str] = None,
  286. icon_type: Optional[str] = None,
  287. icon: Optional[str] = None,
  288. icon_background: Optional[str] = None,
  289. ) -> App:
  290. """Create a new app or update an existing one."""
  291. app_data = data.get("app", {})
  292. app_mode = AppMode(app_data["mode"])
  293. # Set icon type
  294. icon_type_value = icon_type or app_data.get("icon_type")
  295. if icon_type_value in ["emoji", "link"]:
  296. icon_type = icon_type_value
  297. else:
  298. icon_type = "emoji"
  299. icon = icon or str(app_data.get("icon", ""))
  300. if app:
  301. # Update existing app
  302. app.name = name or app_data.get("name", app.name)
  303. app.description = description or app_data.get("description", app.description)
  304. app.icon_type = icon_type
  305. app.icon = icon
  306. app.icon_background = icon_background or app_data.get("icon_background", app.icon_background)
  307. app.updated_by = account.id
  308. else:
  309. # Create new app
  310. app = App()
  311. app.id = str(uuid4())
  312. app.tenant_id = account.current_tenant_id
  313. app.mode = app_mode.value
  314. app.name = name or app_data.get("name", "")
  315. app.description = description or app_data.get("description", "")
  316. app.icon_type = icon_type
  317. app.icon = icon
  318. app.icon_background = icon_background or app_data.get("icon_background", "#FFFFFF")
  319. app.enable_site = True
  320. app.enable_api = True
  321. app.use_icon_as_answer_icon = app_data.get("use_icon_as_answer_icon", False)
  322. app.created_by = account.id
  323. app.updated_by = account.id
  324. self._session.add(app)
  325. self._session.commit()
  326. app_was_created.send(app, account=account)
  327. # Initialize app based on mode
  328. if app_mode in {AppMode.ADVANCED_CHAT, AppMode.WORKFLOW}:
  329. workflow_data = data.get("workflow")
  330. if not workflow_data or not isinstance(workflow_data, dict):
  331. raise ValueError("Missing workflow data for workflow/advanced chat app")
  332. environment_variables_list = workflow_data.get("environment_variables", [])
  333. environment_variables = [
  334. variable_factory.build_variable_from_mapping(obj) for obj in environment_variables_list
  335. ]
  336. conversation_variables_list = workflow_data.get("conversation_variables", [])
  337. conversation_variables = [
  338. variable_factory.build_variable_from_mapping(obj) for obj in conversation_variables_list
  339. ]
  340. workflow_service = WorkflowService()
  341. current_draft_workflow = workflow_service.get_draft_workflow(app_model=app)
  342. if current_draft_workflow:
  343. unique_hash = current_draft_workflow.unique_hash
  344. else:
  345. unique_hash = None
  346. workflow_service.sync_draft_workflow(
  347. app_model=app,
  348. graph=workflow_data.get("graph", {}),
  349. features=workflow_data.get("features", {}),
  350. unique_hash=unique_hash,
  351. account=account,
  352. environment_variables=environment_variables,
  353. conversation_variables=conversation_variables,
  354. )
  355. elif app_mode in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.COMPLETION}:
  356. # Initialize model config
  357. model_config = data.get("model_config")
  358. if not model_config or not isinstance(model_config, dict):
  359. raise ValueError("Missing model_config for chat/agent-chat/completion app")
  360. # Initialize or update model config
  361. if not app.app_model_config:
  362. app_model_config = AppModelConfig().from_model_config_dict(model_config)
  363. app_model_config.id = str(uuid4())
  364. app_model_config.app_id = app.id
  365. app_model_config.created_by = account.id
  366. app_model_config.updated_by = account.id
  367. app.app_model_config_id = app_model_config.id
  368. self._session.add(app_model_config)
  369. app_model_config_was_updated.send(app, app_model_config=app_model_config)
  370. else:
  371. raise ValueError("Invalid app mode")
  372. return app
  373. @classmethod
  374. def export_dsl(cls, app_model: App, include_secret: bool = False) -> str:
  375. """
  376. Export app
  377. :param app_model: App instance
  378. :return:
  379. """
  380. app_mode = AppMode.value_of(app_model.mode)
  381. export_data = {
  382. "version": CURRENT_DSL_VERSION,
  383. "kind": "app",
  384. "app": {
  385. "name": app_model.name,
  386. "mode": app_model.mode,
  387. "icon": "🤖" if app_model.icon_type == "image" else app_model.icon,
  388. "icon_background": "#FFEAD5" if app_model.icon_type == "image" else app_model.icon_background,
  389. "description": app_model.description,
  390. "use_icon_as_answer_icon": app_model.use_icon_as_answer_icon,
  391. },
  392. }
  393. if app_mode in {AppMode.ADVANCED_CHAT, AppMode.WORKFLOW}:
  394. cls._append_workflow_export_data(
  395. export_data=export_data, app_model=app_model, include_secret=include_secret
  396. )
  397. else:
  398. cls._append_model_config_export_data(export_data, app_model)
  399. return yaml.dump(export_data, allow_unicode=True)
  400. @classmethod
  401. def _append_workflow_export_data(cls, *, export_data: dict, app_model: App, include_secret: bool) -> None:
  402. """
  403. Append workflow export data
  404. :param export_data: export data
  405. :param app_model: App instance
  406. """
  407. workflow_service = WorkflowService()
  408. workflow = workflow_service.get_draft_workflow(app_model)
  409. if not workflow:
  410. raise ValueError("Missing draft workflow configuration, please check.")
  411. export_data["workflow"] = workflow.to_dict(include_secret=include_secret)
  412. @classmethod
  413. def _append_model_config_export_data(cls, export_data: dict, app_model: App) -> None:
  414. """
  415. Append model config export data
  416. :param export_data: export data
  417. :param app_model: App instance
  418. """
  419. app_model_config = app_model.app_model_config
  420. if not app_model_config:
  421. raise ValueError("Missing app configuration, please check.")
  422. export_data["model_config"] = app_model_config.to_dict()