app_dsl_service.py 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496
  1. import logging
  2. import uuid
  3. from enum import StrEnum
  4. from typing import Optional, cast
  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.5"
  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: bytes | str = b""
  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. # tricky way to handle url from github to github raw url
  95. if yaml_url.startswith("https://github.com") and yaml_url.endswith((".yml", ".yaml")):
  96. yaml_url = yaml_url.replace("https://github.com", "https://raw.githubusercontent.com")
  97. yaml_url = yaml_url.replace("/blob/", "/")
  98. response = ssrf_proxy.get(yaml_url.strip(), follow_redirects=True, timeout=(10, 10))
  99. response.raise_for_status()
  100. content = response.content
  101. if len(content) > max_size:
  102. return Import(
  103. id=import_id,
  104. status=ImportStatus.FAILED,
  105. error="File size exceeds the limit of 10MB",
  106. )
  107. if not content:
  108. return Import(
  109. id=import_id,
  110. status=ImportStatus.FAILED,
  111. error="Empty content from url",
  112. )
  113. try:
  114. content = cast(bytes, content).decode("utf-8")
  115. except UnicodeDecodeError as e:
  116. return Import(
  117. id=import_id,
  118. status=ImportStatus.FAILED,
  119. error=f"Error decoding content: {e}",
  120. )
  121. except Exception as e:
  122. return Import(
  123. id=import_id,
  124. status=ImportStatus.FAILED,
  125. error=f"Error fetching YAML from URL: {str(e)}",
  126. )
  127. elif mode == ImportMode.YAML_CONTENT:
  128. if not yaml_content:
  129. return Import(
  130. id=import_id,
  131. status=ImportStatus.FAILED,
  132. error="yaml_content is required when import_mode is yaml-content",
  133. )
  134. content = yaml_content
  135. # Process YAML content
  136. try:
  137. # Parse YAML to validate format
  138. data = yaml.safe_load(content)
  139. if not isinstance(data, dict):
  140. return Import(
  141. id=import_id,
  142. status=ImportStatus.FAILED,
  143. error="Invalid YAML format: content must be a mapping",
  144. )
  145. # Validate and fix DSL version
  146. if not data.get("version"):
  147. data["version"] = "0.1.0"
  148. if not data.get("kind") or data.get("kind") != "app":
  149. data["kind"] = "app"
  150. imported_version = data.get("version", "0.1.0")
  151. status = _check_version_compatibility(imported_version)
  152. # Extract app data
  153. app_data = data.get("app")
  154. if not app_data:
  155. return Import(
  156. id=import_id,
  157. status=ImportStatus.FAILED,
  158. error="Missing app data in YAML content",
  159. )
  160. # If app_id is provided, check if it exists
  161. app = None
  162. if app_id:
  163. stmt = select(App).where(App.id == app_id, App.tenant_id == account.current_tenant_id)
  164. app = self._session.scalar(stmt)
  165. if not app:
  166. return Import(
  167. id=import_id,
  168. status=ImportStatus.FAILED,
  169. error="App not found",
  170. )
  171. if app.mode not in [AppMode.WORKFLOW.value, AppMode.ADVANCED_CHAT.value]:
  172. return Import(
  173. id=import_id,
  174. status=ImportStatus.FAILED,
  175. error="Only workflow or advanced chat apps can be overwritten",
  176. )
  177. # If major version mismatch, store import info in Redis
  178. if status == ImportStatus.PENDING:
  179. panding_data = PendingData(
  180. import_mode=import_mode,
  181. yaml_content=content,
  182. name=name,
  183. description=description,
  184. icon_type=icon_type,
  185. icon=icon,
  186. icon_background=icon_background,
  187. app_id=app_id,
  188. )
  189. redis_client.setex(
  190. f"{IMPORT_INFO_REDIS_KEY_PREFIX}{import_id}",
  191. IMPORT_INFO_REDIS_EXPIRY,
  192. panding_data.model_dump_json(),
  193. )
  194. return Import(
  195. id=import_id,
  196. status=status,
  197. app_id=app_id,
  198. imported_dsl_version=imported_version,
  199. )
  200. # Create or update app
  201. app = self._create_or_update_app(
  202. app=app,
  203. data=data,
  204. account=account,
  205. name=name,
  206. description=description,
  207. icon_type=icon_type,
  208. icon=icon,
  209. icon_background=icon_background,
  210. )
  211. return Import(
  212. id=import_id,
  213. status=status,
  214. app_id=app.id,
  215. imported_dsl_version=imported_version,
  216. )
  217. except yaml.YAMLError as e:
  218. return Import(
  219. id=import_id,
  220. status=ImportStatus.FAILED,
  221. error=f"Invalid YAML format: {str(e)}",
  222. )
  223. except Exception as e:
  224. logger.exception("Failed to import app")
  225. return Import(
  226. id=import_id,
  227. status=ImportStatus.FAILED,
  228. error=str(e),
  229. )
  230. def confirm_import(self, *, import_id: str, account: Account) -> Import:
  231. """
  232. Confirm an import that requires confirmation
  233. """
  234. redis_key = f"{IMPORT_INFO_REDIS_KEY_PREFIX}{import_id}"
  235. pending_data = redis_client.get(redis_key)
  236. if not pending_data:
  237. return Import(
  238. id=import_id,
  239. status=ImportStatus.FAILED,
  240. error="Import information expired or does not exist",
  241. )
  242. try:
  243. if not isinstance(pending_data, str | bytes):
  244. return Import(
  245. id=import_id,
  246. status=ImportStatus.FAILED,
  247. error="Invalid import information",
  248. )
  249. pending_data = PendingData.model_validate_json(pending_data)
  250. data = yaml.safe_load(pending_data.yaml_content)
  251. app = None
  252. if pending_data.app_id:
  253. stmt = select(App).where(App.id == pending_data.app_id, App.tenant_id == account.current_tenant_id)
  254. app = self._session.scalar(stmt)
  255. # Create or update app
  256. app = self._create_or_update_app(
  257. app=app,
  258. data=data,
  259. account=account,
  260. name=pending_data.name,
  261. description=pending_data.description,
  262. icon_type=pending_data.icon_type,
  263. icon=pending_data.icon,
  264. icon_background=pending_data.icon_background,
  265. )
  266. # Delete import info from Redis
  267. redis_client.delete(redis_key)
  268. return Import(
  269. id=import_id,
  270. status=ImportStatus.COMPLETED,
  271. app_id=app.id,
  272. current_dsl_version=CURRENT_DSL_VERSION,
  273. imported_dsl_version=data.get("version", "0.1.0"),
  274. )
  275. except Exception as e:
  276. logger.exception("Error confirming import")
  277. return Import(
  278. id=import_id,
  279. status=ImportStatus.FAILED,
  280. error=str(e),
  281. )
  282. def _create_or_update_app(
  283. self,
  284. *,
  285. app: Optional[App],
  286. data: dict,
  287. account: Account,
  288. name: Optional[str] = None,
  289. description: Optional[str] = None,
  290. icon_type: Optional[str] = None,
  291. icon: Optional[str] = None,
  292. icon_background: Optional[str] = None,
  293. ) -> App:
  294. """Create a new app or update an existing one."""
  295. app_data = data.get("app", {})
  296. app_mode = app_data.get("mode")
  297. if not app_mode:
  298. raise ValueError("loss app mode")
  299. app_mode = AppMode(app_mode)
  300. # Set icon type
  301. icon_type_value = icon_type or app_data.get("icon_type")
  302. if icon_type_value in ["emoji", "link"]:
  303. icon_type = icon_type_value
  304. else:
  305. icon_type = "emoji"
  306. icon = icon or str(app_data.get("icon", ""))
  307. if app:
  308. # Update existing app
  309. app.name = name or app_data.get("name", app.name)
  310. app.description = description or app_data.get("description", app.description)
  311. app.icon_type = icon_type
  312. app.icon = icon
  313. app.icon_background = icon_background or app_data.get("icon_background", app.icon_background)
  314. app.updated_by = account.id
  315. else:
  316. if account.current_tenant_id is None:
  317. raise ValueError("Current tenant is not set")
  318. # Create new app
  319. app = App()
  320. app.id = str(uuid4())
  321. app.tenant_id = account.current_tenant_id
  322. app.mode = app_mode.value
  323. app.name = name or app_data.get("name", "")
  324. app.description = description or app_data.get("description", "")
  325. app.icon_type = icon_type
  326. app.icon = icon
  327. app.icon_background = icon_background or app_data.get("icon_background", "#FFFFFF")
  328. app.enable_site = True
  329. app.enable_api = True
  330. app.use_icon_as_answer_icon = app_data.get("use_icon_as_answer_icon", False)
  331. app.created_by = account.id
  332. app.updated_by = account.id
  333. self._session.add(app)
  334. self._session.commit()
  335. app_was_created.send(app, account=account)
  336. # Initialize app based on mode
  337. if app_mode in {AppMode.ADVANCED_CHAT, AppMode.WORKFLOW}:
  338. workflow_data = data.get("workflow")
  339. if not workflow_data or not isinstance(workflow_data, dict):
  340. raise ValueError("Missing workflow data for workflow/advanced chat app")
  341. environment_variables_list = workflow_data.get("environment_variables", [])
  342. environment_variables = [
  343. variable_factory.build_environment_variable_from_mapping(obj) for obj in environment_variables_list
  344. ]
  345. conversation_variables_list = workflow_data.get("conversation_variables", [])
  346. conversation_variables = [
  347. variable_factory.build_conversation_variable_from_mapping(obj) for obj in conversation_variables_list
  348. ]
  349. workflow_service = WorkflowService()
  350. current_draft_workflow = workflow_service.get_draft_workflow(app_model=app)
  351. if current_draft_workflow:
  352. unique_hash = current_draft_workflow.unique_hash
  353. else:
  354. unique_hash = None
  355. workflow_service.sync_draft_workflow(
  356. app_model=app,
  357. graph=workflow_data.get("graph", {}),
  358. features=workflow_data.get("features", {}),
  359. unique_hash=unique_hash,
  360. account=account,
  361. environment_variables=environment_variables,
  362. conversation_variables=conversation_variables,
  363. )
  364. elif app_mode in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.COMPLETION}:
  365. # Initialize model config
  366. model_config = data.get("model_config")
  367. if not model_config or not isinstance(model_config, dict):
  368. raise ValueError("Missing model_config for chat/agent-chat/completion app")
  369. # Initialize or update model config
  370. if not app.app_model_config:
  371. app_model_config = AppModelConfig().from_model_config_dict(model_config)
  372. app_model_config.id = str(uuid4())
  373. app_model_config.app_id = app.id
  374. app_model_config.created_by = account.id
  375. app_model_config.updated_by = account.id
  376. app.app_model_config_id = app_model_config.id
  377. self._session.add(app_model_config)
  378. app_model_config_was_updated.send(app, app_model_config=app_model_config)
  379. else:
  380. raise ValueError("Invalid app mode")
  381. return app
  382. @classmethod
  383. def export_dsl(cls, app_model: App, include_secret: bool = False) -> str:
  384. """
  385. Export app
  386. :param app_model: App instance
  387. :return:
  388. """
  389. app_mode = AppMode.value_of(app_model.mode)
  390. export_data = {
  391. "version": CURRENT_DSL_VERSION,
  392. "kind": "app",
  393. "app": {
  394. "name": app_model.name,
  395. "mode": app_model.mode,
  396. "icon": "🤖" if app_model.icon_type == "image" else app_model.icon,
  397. "icon_background": "#FFEAD5" if app_model.icon_type == "image" else app_model.icon_background,
  398. "description": app_model.description,
  399. "use_icon_as_answer_icon": app_model.use_icon_as_answer_icon,
  400. },
  401. }
  402. if app_mode in {AppMode.ADVANCED_CHAT, AppMode.WORKFLOW}:
  403. cls._append_workflow_export_data(
  404. export_data=export_data, app_model=app_model, include_secret=include_secret
  405. )
  406. else:
  407. cls._append_model_config_export_data(export_data, app_model)
  408. return yaml.dump(export_data, allow_unicode=True)
  409. @classmethod
  410. def _append_workflow_export_data(cls, *, export_data: dict, app_model: App, include_secret: bool) -> None:
  411. """
  412. Append workflow export data
  413. :param export_data: export data
  414. :param app_model: App instance
  415. """
  416. workflow_service = WorkflowService()
  417. workflow = workflow_service.get_draft_workflow(app_model)
  418. if not workflow:
  419. raise ValueError("Missing draft workflow configuration, please check.")
  420. export_data["workflow"] = workflow.to_dict(include_secret=include_secret)
  421. @classmethod
  422. def _append_model_config_export_data(cls, export_data: dict, app_model: App) -> None:
  423. """
  424. Append model config export data
  425. :param export_data: export data
  426. :param app_model: App instance
  427. """
  428. app_model_config = app_model.app_model_config
  429. if not app_model_config:
  430. raise ValueError("Missing app configuration, please check.")
  431. export_data["model_config"] = app_model_config.to_dict()