workflow.py 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805
  1. import json
  2. from collections.abc import Mapping, Sequence
  3. from datetime import UTC, datetime
  4. from enum import Enum, StrEnum
  5. from typing import Any, Optional, Union
  6. import sqlalchemy as sa
  7. from sqlalchemy import func
  8. from sqlalchemy.orm import Mapped, mapped_column
  9. import contexts
  10. from constants import HIDDEN_VALUE
  11. from core.helper import encrypter
  12. from core.variables import SecretVariable, Variable
  13. from extensions.ext_database import db
  14. from factories import variable_factory
  15. from libs import helper
  16. from models.enums import CreatedByRole
  17. from .account import Account
  18. from .types import StringUUID
  19. class WorkflowType(Enum):
  20. """
  21. Workflow Type Enum
  22. """
  23. WORKFLOW = "workflow"
  24. CHAT = "chat"
  25. @classmethod
  26. def value_of(cls, value: str) -> "WorkflowType":
  27. """
  28. Get value of given mode.
  29. :param value: mode value
  30. :return: mode
  31. """
  32. for mode in cls:
  33. if mode.value == value:
  34. return mode
  35. raise ValueError(f"invalid workflow type value {value}")
  36. @classmethod
  37. def from_app_mode(cls, app_mode: Union[str, "AppMode"]) -> "WorkflowType":
  38. """
  39. Get workflow type from app mode.
  40. :param app_mode: app mode
  41. :return: workflow type
  42. """
  43. from models.model import AppMode
  44. app_mode = app_mode if isinstance(app_mode, AppMode) else AppMode.value_of(app_mode)
  45. return cls.WORKFLOW if app_mode == AppMode.WORKFLOW else cls.CHAT
  46. class Workflow(db.Model):
  47. """
  48. Workflow, for `Workflow App` and `Chat App workflow mode`.
  49. Attributes:
  50. - id (uuid) Workflow ID, pk
  51. - tenant_id (uuid) Workspace ID
  52. - app_id (uuid) App ID
  53. - type (string) Workflow type
  54. `workflow` for `Workflow App`
  55. `chat` for `Chat App workflow mode`
  56. - version (string) Version
  57. `draft` for draft version (only one for each app), other for version number (redundant)
  58. - graph (text) Workflow canvas configuration (JSON)
  59. The entire canvas configuration JSON, including Node, Edge, and other configurations
  60. - nodes (array[object]) Node list, see Node Schema
  61. - edges (array[object]) Edge list, see Edge Schema
  62. - created_by (uuid) Creator ID
  63. - created_at (timestamp) Creation time
  64. - updated_by (uuid) `optional` Last updater ID
  65. - updated_at (timestamp) `optional` Last update time
  66. """
  67. __tablename__ = "workflows"
  68. __table_args__ = (
  69. db.PrimaryKeyConstraint("id", name="workflow_pkey"),
  70. db.Index("workflow_version_idx", "tenant_id", "app_id", "version"),
  71. )
  72. id: Mapped[str] = mapped_column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  73. tenant_id: Mapped[str] = mapped_column(StringUUID, nullable=False)
  74. app_id: Mapped[str] = mapped_column(StringUUID, nullable=False)
  75. type: Mapped[str] = mapped_column(db.String(255), nullable=False)
  76. version: Mapped[str] = mapped_column(db.String(255), nullable=False)
  77. graph: Mapped[str] = mapped_column(sa.Text)
  78. _features: Mapped[str] = mapped_column("features", sa.TEXT)
  79. created_by: Mapped[str] = mapped_column(StringUUID, nullable=False)
  80. created_at: Mapped[datetime] = mapped_column(
  81. db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)")
  82. )
  83. updated_by: Mapped[Optional[str]] = mapped_column(StringUUID)
  84. updated_at: Mapped[datetime] = mapped_column(
  85. sa.DateTime, nullable=False, default=datetime.now(tz=UTC), server_onupdate=func.current_timestamp()
  86. )
  87. _environment_variables: Mapped[str] = mapped_column(
  88. "environment_variables", db.Text, nullable=False, server_default="{}"
  89. )
  90. _conversation_variables: Mapped[str] = mapped_column(
  91. "conversation_variables", db.Text, nullable=False, server_default="{}"
  92. )
  93. def __init__(
  94. self,
  95. *,
  96. tenant_id: str,
  97. app_id: str,
  98. type: str,
  99. version: str,
  100. graph: str,
  101. features: str,
  102. created_by: str,
  103. environment_variables: Sequence[Variable],
  104. conversation_variables: Sequence[Variable],
  105. ):
  106. self.tenant_id = tenant_id
  107. self.app_id = app_id
  108. self.type = type
  109. self.version = version
  110. self.graph = graph
  111. self.features = features
  112. self.created_by = created_by
  113. self.environment_variables = environment_variables or []
  114. self.conversation_variables = conversation_variables or []
  115. @property
  116. def created_by_account(self):
  117. return db.session.get(Account, self.created_by)
  118. @property
  119. def updated_by_account(self):
  120. return db.session.get(Account, self.updated_by) if self.updated_by else None
  121. @property
  122. def graph_dict(self) -> Mapping[str, Any]:
  123. return json.loads(self.graph) if self.graph else {}
  124. @property
  125. def features(self) -> str:
  126. """
  127. Convert old features structure to new features structure.
  128. """
  129. if not self._features:
  130. return self._features
  131. features = json.loads(self._features)
  132. if features.get("file_upload", {}).get("image", {}).get("enabled", False):
  133. image_enabled = True
  134. image_number_limits = int(features["file_upload"]["image"].get("number_limits", 1))
  135. image_transfer_methods = features["file_upload"]["image"].get(
  136. "transfer_methods", ["remote_url", "local_file"]
  137. )
  138. features["file_upload"]["enabled"] = image_enabled
  139. features["file_upload"]["number_limits"] = image_number_limits
  140. features["file_upload"]["allowed_file_upload_methods"] = image_transfer_methods
  141. features["file_upload"]["allowed_file_types"] = ["image"]
  142. features["file_upload"]["allowed_file_extensions"] = []
  143. del features["file_upload"]["image"]
  144. self._features = json.dumps(features)
  145. return self._features
  146. @features.setter
  147. def features(self, value: str) -> None:
  148. self._features = value
  149. @property
  150. def features_dict(self) -> Mapping[str, Any]:
  151. return json.loads(self.features) if self.features else {}
  152. def user_input_form(self, to_old_structure: bool = False) -> list:
  153. # get start node from graph
  154. if not self.graph:
  155. return []
  156. graph_dict = self.graph_dict
  157. if "nodes" not in graph_dict:
  158. return []
  159. start_node = next((node for node in graph_dict["nodes"] if node["data"]["type"] == "start"), None)
  160. if not start_node:
  161. return []
  162. # get user_input_form from start node
  163. variables = start_node.get("data", {}).get("variables", [])
  164. if to_old_structure:
  165. old_structure_variables = []
  166. for variable in variables:
  167. old_structure_variables.append({variable["type"]: variable})
  168. return old_structure_variables
  169. return variables
  170. @property
  171. def unique_hash(self) -> str:
  172. """
  173. Get hash of workflow.
  174. :return: hash
  175. """
  176. entity = {"graph": self.graph_dict, "features": self.features_dict}
  177. return helper.generate_text_hash(json.dumps(entity, sort_keys=True))
  178. @property
  179. def tool_published(self) -> bool:
  180. from models.tools import WorkflowToolProvider
  181. return (
  182. db.session.query(WorkflowToolProvider)
  183. .filter(WorkflowToolProvider.tenant_id == self.tenant_id, WorkflowToolProvider.app_id == self.app_id)
  184. .count()
  185. > 0
  186. )
  187. @property
  188. def environment_variables(self) -> Sequence[Variable]:
  189. # TODO: find some way to init `self._environment_variables` when instance created.
  190. if self._environment_variables is None:
  191. self._environment_variables = "{}"
  192. tenant_id = contexts.tenant_id.get()
  193. environment_variables_dict: dict[str, Any] = json.loads(self._environment_variables)
  194. results = [
  195. variable_factory.build_environment_variable_from_mapping(v) for v in environment_variables_dict.values()
  196. ]
  197. # decrypt secret variables value
  198. decrypt_func = (
  199. lambda var: var.model_copy(update={"value": encrypter.decrypt_token(tenant_id=tenant_id, token=var.value)})
  200. if isinstance(var, SecretVariable)
  201. else var
  202. )
  203. results = list(map(decrypt_func, results))
  204. return results
  205. @environment_variables.setter
  206. def environment_variables(self, value: Sequence[Variable]):
  207. if not value:
  208. self._environment_variables = "{}"
  209. return
  210. tenant_id = contexts.tenant_id.get()
  211. value = list(value)
  212. if any(var for var in value if not var.id):
  213. raise ValueError("environment variable require a unique id")
  214. # Compare inputs and origin variables,
  215. # if the value is HIDDEN_VALUE, use the origin variable value (only update `name`).
  216. origin_variables_dictionary = {var.id: var for var in self.environment_variables}
  217. for i, variable in enumerate(value):
  218. if variable.id in origin_variables_dictionary and variable.value == HIDDEN_VALUE:
  219. value[i] = origin_variables_dictionary[variable.id].model_copy(update={"name": variable.name})
  220. # encrypt secret variables value
  221. encrypt_func = (
  222. lambda var: var.model_copy(update={"value": encrypter.encrypt_token(tenant_id=tenant_id, token=var.value)})
  223. if isinstance(var, SecretVariable)
  224. else var
  225. )
  226. encrypted_vars = list(map(encrypt_func, value))
  227. environment_variables_json = json.dumps(
  228. {var.name: var.model_dump() for var in encrypted_vars},
  229. ensure_ascii=False,
  230. )
  231. self._environment_variables = environment_variables_json
  232. def to_dict(self, *, include_secret: bool = False) -> Mapping[str, Any]:
  233. environment_variables = list(self.environment_variables)
  234. environment_variables = [
  235. v if not isinstance(v, SecretVariable) or include_secret else v.model_copy(update={"value": ""})
  236. for v in environment_variables
  237. ]
  238. result = {
  239. "graph": self.graph_dict,
  240. "features": self.features_dict,
  241. "environment_variables": [var.model_dump(mode="json") for var in environment_variables],
  242. "conversation_variables": [var.model_dump(mode="json") for var in self.conversation_variables],
  243. }
  244. return result
  245. @property
  246. def conversation_variables(self) -> Sequence[Variable]:
  247. # TODO: find some way to init `self._conversation_variables` when instance created.
  248. if self._conversation_variables is None:
  249. self._conversation_variables = "{}"
  250. variables_dict: dict[str, Any] = json.loads(self._conversation_variables)
  251. results = [variable_factory.build_conversation_variable_from_mapping(v) for v in variables_dict.values()]
  252. return results
  253. @conversation_variables.setter
  254. def conversation_variables(self, value: Sequence[Variable]) -> None:
  255. self._conversation_variables = json.dumps(
  256. {var.name: var.model_dump() for var in value},
  257. ensure_ascii=False,
  258. )
  259. class WorkflowRunStatus(StrEnum):
  260. """
  261. Workflow Run Status Enum
  262. """
  263. RUNNING = "running"
  264. SUCCEEDED = "succeeded"
  265. FAILED = "failed"
  266. STOPPED = "stopped"
  267. PARTIAL_SUCCESSED = "partial-succeeded"
  268. @classmethod
  269. def value_of(cls, value: str) -> "WorkflowRunStatus":
  270. """
  271. Get value of given mode.
  272. :param value: mode value
  273. :return: mode
  274. """
  275. for mode in cls:
  276. if mode.value == value:
  277. return mode
  278. raise ValueError(f"invalid workflow run status value {value}")
  279. class WorkflowRun(db.Model):
  280. """
  281. Workflow Run
  282. Attributes:
  283. - id (uuid) Run ID
  284. - tenant_id (uuid) Workspace ID
  285. - app_id (uuid) App ID
  286. - sequence_number (int) Auto-increment sequence number, incremented within the App, starting from 1
  287. - workflow_id (uuid) Workflow ID
  288. - type (string) Workflow type
  289. - triggered_from (string) Trigger source
  290. `debugging` for canvas debugging
  291. `app-run` for (published) app execution
  292. - version (string) Version
  293. - graph (text) Workflow canvas configuration (JSON)
  294. - inputs (text) Input parameters
  295. - status (string) Execution status, `running` / `succeeded` / `failed` / `stopped`
  296. - outputs (text) `optional` Output content
  297. - error (string) `optional` Error reason
  298. - elapsed_time (float) `optional` Time consumption (s)
  299. - total_tokens (int) `optional` Total tokens used
  300. - total_steps (int) Total steps (redundant), default 0
  301. - created_by_role (string) Creator role
  302. - `account` Console account
  303. - `end_user` End user
  304. - created_by (uuid) Runner ID
  305. - created_at (timestamp) Run time
  306. - finished_at (timestamp) End time
  307. """
  308. __tablename__ = "workflow_runs"
  309. __table_args__ = (
  310. db.PrimaryKeyConstraint("id", name="workflow_run_pkey"),
  311. db.Index("workflow_run_triggerd_from_idx", "tenant_id", "app_id", "triggered_from"),
  312. db.Index("workflow_run_tenant_app_sequence_idx", "tenant_id", "app_id", "sequence_number"),
  313. )
  314. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  315. tenant_id = db.Column(StringUUID, nullable=False)
  316. app_id = db.Column(StringUUID, nullable=False)
  317. sequence_number = db.Column(db.Integer, nullable=False)
  318. workflow_id = db.Column(StringUUID, nullable=False)
  319. type = db.Column(db.String(255), nullable=False)
  320. triggered_from = db.Column(db.String(255), nullable=False)
  321. version = db.Column(db.String(255), nullable=False)
  322. graph = db.Column(db.Text)
  323. inputs = db.Column(db.Text)
  324. status = db.Column(db.String(255), nullable=False) # running, succeeded, failed, stopped, partial-succeeded
  325. outputs: Mapped[str] = mapped_column(sa.Text, default="{}")
  326. error = db.Column(db.Text)
  327. elapsed_time = db.Column(db.Float, nullable=False, server_default=db.text("0"))
  328. total_tokens = db.Column(db.Integer, nullable=False, server_default=db.text("0"))
  329. total_steps = db.Column(db.Integer, server_default=db.text("0"))
  330. created_by_role = db.Column(db.String(255), nullable=False) # account, end_user
  331. created_by = db.Column(StringUUID, nullable=False)
  332. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  333. finished_at = db.Column(db.DateTime)
  334. exceptions_count = db.Column(db.Integer, server_default=db.text("0"))
  335. @property
  336. def created_by_account(self):
  337. created_by_role = CreatedByRole(self.created_by_role)
  338. return db.session.get(Account, self.created_by) if created_by_role == CreatedByRole.ACCOUNT else None
  339. @property
  340. def created_by_end_user(self):
  341. from models.model import EndUser
  342. created_by_role = CreatedByRole(self.created_by_role)
  343. return db.session.get(EndUser, self.created_by) if created_by_role == CreatedByRole.END_USER else None
  344. @property
  345. def graph_dict(self):
  346. return json.loads(self.graph) if self.graph else {}
  347. @property
  348. def inputs_dict(self) -> Mapping[str, Any]:
  349. return json.loads(self.inputs) if self.inputs else {}
  350. @property
  351. def outputs_dict(self) -> Mapping[str, Any]:
  352. return json.loads(self.outputs) if self.outputs else {}
  353. @property
  354. def message(self) -> Optional["Message"]:
  355. from models.model import Message
  356. return (
  357. db.session.query(Message).filter(Message.app_id == self.app_id, Message.workflow_run_id == self.id).first()
  358. )
  359. @property
  360. def workflow(self):
  361. return db.session.query(Workflow).filter(Workflow.id == self.workflow_id).first()
  362. def to_dict(self):
  363. return {
  364. "id": self.id,
  365. "tenant_id": self.tenant_id,
  366. "app_id": self.app_id,
  367. "sequence_number": self.sequence_number,
  368. "workflow_id": self.workflow_id,
  369. "type": self.type,
  370. "triggered_from": self.triggered_from,
  371. "version": self.version,
  372. "graph": self.graph_dict,
  373. "inputs": self.inputs_dict,
  374. "status": self.status,
  375. "outputs": self.outputs_dict,
  376. "error": self.error,
  377. "elapsed_time": self.elapsed_time,
  378. "total_tokens": self.total_tokens,
  379. "total_steps": self.total_steps,
  380. "created_by_role": self.created_by_role,
  381. "created_by": self.created_by,
  382. "created_at": self.created_at,
  383. "finished_at": self.finished_at,
  384. "exceptions_count": self.exceptions_count,
  385. }
  386. @classmethod
  387. def from_dict(cls, data: dict) -> "WorkflowRun":
  388. return cls(
  389. id=data.get("id"),
  390. tenant_id=data.get("tenant_id"),
  391. app_id=data.get("app_id"),
  392. sequence_number=data.get("sequence_number"),
  393. workflow_id=data.get("workflow_id"),
  394. type=data.get("type"),
  395. triggered_from=data.get("triggered_from"),
  396. version=data.get("version"),
  397. graph=json.dumps(data.get("graph")),
  398. inputs=json.dumps(data.get("inputs")),
  399. status=data.get("status"),
  400. outputs=json.dumps(data.get("outputs")),
  401. error=data.get("error"),
  402. elapsed_time=data.get("elapsed_time"),
  403. total_tokens=data.get("total_tokens"),
  404. total_steps=data.get("total_steps"),
  405. created_by_role=data.get("created_by_role"),
  406. created_by=data.get("created_by"),
  407. created_at=data.get("created_at"),
  408. finished_at=data.get("finished_at"),
  409. exceptions_count=data.get("exceptions_count"),
  410. )
  411. class WorkflowNodeExecutionTriggeredFrom(Enum):
  412. """
  413. Workflow Node Execution Triggered From Enum
  414. """
  415. SINGLE_STEP = "single-step"
  416. WORKFLOW_RUN = "workflow-run"
  417. @classmethod
  418. def value_of(cls, value: str) -> "WorkflowNodeExecutionTriggeredFrom":
  419. """
  420. Get value of given mode.
  421. :param value: mode value
  422. :return: mode
  423. """
  424. for mode in cls:
  425. if mode.value == value:
  426. return mode
  427. raise ValueError(f"invalid workflow node execution triggered from value {value}")
  428. class WorkflowNodeExecutionStatus(Enum):
  429. """
  430. Workflow Node Execution Status Enum
  431. """
  432. RUNNING = "running"
  433. SUCCEEDED = "succeeded"
  434. FAILED = "failed"
  435. EXCEPTION = "exception"
  436. @classmethod
  437. def value_of(cls, value: str) -> "WorkflowNodeExecutionStatus":
  438. """
  439. Get value of given mode.
  440. :param value: mode value
  441. :return: mode
  442. """
  443. for mode in cls:
  444. if mode.value == value:
  445. return mode
  446. raise ValueError(f"invalid workflow node execution status value {value}")
  447. class WorkflowNodeExecution(db.Model):
  448. """
  449. Workflow Node Execution
  450. - id (uuid) Execution ID
  451. - tenant_id (uuid) Workspace ID
  452. - app_id (uuid) App ID
  453. - workflow_id (uuid) Workflow ID
  454. - triggered_from (string) Trigger source
  455. `single-step` for single-step debugging
  456. `workflow-run` for workflow execution (debugging / user execution)
  457. - workflow_run_id (uuid) `optional` Workflow run ID
  458. Null for single-step debugging.
  459. - index (int) Execution sequence number, used for displaying Tracing Node order
  460. - predecessor_node_id (string) `optional` Predecessor node ID, used for displaying execution path
  461. - node_id (string) Node ID
  462. - node_type (string) Node type, such as `start`
  463. - title (string) Node title
  464. - inputs (json) All predecessor node variable content used in the node
  465. - process_data (json) Node process data
  466. - outputs (json) `optional` Node output variables
  467. - status (string) Execution status, `running` / `succeeded` / `failed`
  468. - error (string) `optional` Error reason
  469. - elapsed_time (float) `optional` Time consumption (s)
  470. - execution_metadata (text) Metadata
  471. - total_tokens (int) `optional` Total tokens used
  472. - total_price (decimal) `optional` Total cost
  473. - currency (string) `optional` Currency, such as USD / RMB
  474. - created_at (timestamp) Run time
  475. - created_by_role (string) Creator role
  476. - `account` Console account
  477. - `end_user` End user
  478. - created_by (uuid) Runner ID
  479. - finished_at (timestamp) End time
  480. """
  481. __tablename__ = "workflow_node_executions"
  482. __table_args__ = (
  483. db.PrimaryKeyConstraint("id", name="workflow_node_execution_pkey"),
  484. db.Index(
  485. "workflow_node_execution_workflow_run_idx",
  486. "tenant_id",
  487. "app_id",
  488. "workflow_id",
  489. "triggered_from",
  490. "workflow_run_id",
  491. ),
  492. db.Index(
  493. "workflow_node_execution_node_run_idx", "tenant_id", "app_id", "workflow_id", "triggered_from", "node_id"
  494. ),
  495. db.Index(
  496. "workflow_node_execution_id_idx",
  497. "tenant_id",
  498. "app_id",
  499. "workflow_id",
  500. "triggered_from",
  501. "node_execution_id",
  502. ),
  503. )
  504. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  505. tenant_id = db.Column(StringUUID, nullable=False)
  506. app_id = db.Column(StringUUID, nullable=False)
  507. workflow_id = db.Column(StringUUID, nullable=False)
  508. triggered_from = db.Column(db.String(255), nullable=False)
  509. workflow_run_id = db.Column(StringUUID)
  510. index = db.Column(db.Integer, nullable=False)
  511. predecessor_node_id = db.Column(db.String(255))
  512. node_execution_id = db.Column(db.String(255), nullable=True)
  513. node_id = db.Column(db.String(255), nullable=False)
  514. node_type = db.Column(db.String(255), nullable=False)
  515. title = db.Column(db.String(255), nullable=False)
  516. inputs = db.Column(db.Text)
  517. process_data = db.Column(db.Text)
  518. outputs = db.Column(db.Text)
  519. status = db.Column(db.String(255), nullable=False)
  520. error = db.Column(db.Text)
  521. elapsed_time = db.Column(db.Float, nullable=False, server_default=db.text("0"))
  522. execution_metadata = db.Column(db.Text)
  523. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  524. created_by_role = db.Column(db.String(255), nullable=False)
  525. created_by = db.Column(StringUUID, nullable=False)
  526. finished_at = db.Column(db.DateTime)
  527. @property
  528. def created_by_account(self):
  529. created_by_role = CreatedByRole(self.created_by_role)
  530. return db.session.get(Account, self.created_by) if created_by_role == CreatedByRole.ACCOUNT else None
  531. @property
  532. def created_by_end_user(self):
  533. from models.model import EndUser
  534. created_by_role = CreatedByRole(self.created_by_role)
  535. return db.session.get(EndUser, self.created_by) if created_by_role == CreatedByRole.END_USER else None
  536. @property
  537. def inputs_dict(self):
  538. return json.loads(self.inputs) if self.inputs else None
  539. @property
  540. def outputs_dict(self):
  541. return json.loads(self.outputs) if self.outputs else None
  542. @property
  543. def process_data_dict(self):
  544. return json.loads(self.process_data) if self.process_data else None
  545. @property
  546. def execution_metadata_dict(self):
  547. return json.loads(self.execution_metadata) if self.execution_metadata else None
  548. @property
  549. def extras(self):
  550. from core.tools.tool_manager import ToolManager
  551. extras = {}
  552. if self.execution_metadata_dict:
  553. from core.workflow.nodes import NodeType
  554. if self.node_type == NodeType.TOOL.value and "tool_info" in self.execution_metadata_dict:
  555. tool_info = self.execution_metadata_dict["tool_info"]
  556. extras["icon"] = ToolManager.get_tool_icon(
  557. tenant_id=self.tenant_id,
  558. provider_type=tool_info["provider_type"],
  559. provider_id=tool_info["provider_id"],
  560. )
  561. return extras
  562. class WorkflowAppLogCreatedFrom(Enum):
  563. """
  564. Workflow App Log Created From Enum
  565. """
  566. SERVICE_API = "service-api"
  567. WEB_APP = "web-app"
  568. INSTALLED_APP = "installed-app"
  569. @classmethod
  570. def value_of(cls, value: str) -> "WorkflowAppLogCreatedFrom":
  571. """
  572. Get value of given mode.
  573. :param value: mode value
  574. :return: mode
  575. """
  576. for mode in cls:
  577. if mode.value == value:
  578. return mode
  579. raise ValueError(f"invalid workflow app log created from value {value}")
  580. class WorkflowAppLog(db.Model):
  581. """
  582. Workflow App execution log, excluding workflow debugging records.
  583. Attributes:
  584. - id (uuid) run ID
  585. - tenant_id (uuid) Workspace ID
  586. - app_id (uuid) App ID
  587. - workflow_id (uuid) Associated Workflow ID
  588. - workflow_run_id (uuid) Associated Workflow Run ID
  589. - created_from (string) Creation source
  590. `service-api` App Execution OpenAPI
  591. `web-app` WebApp
  592. `installed-app` Installed App
  593. - created_by_role (string) Creator role
  594. - `account` Console account
  595. - `end_user` End user
  596. - created_by (uuid) Creator ID, depends on the user table according to created_by_role
  597. - created_at (timestamp) Creation time
  598. """
  599. __tablename__ = "workflow_app_logs"
  600. __table_args__ = (
  601. db.PrimaryKeyConstraint("id", name="workflow_app_log_pkey"),
  602. db.Index("workflow_app_log_app_idx", "tenant_id", "app_id"),
  603. )
  604. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  605. tenant_id = db.Column(StringUUID, nullable=False)
  606. app_id = db.Column(StringUUID, nullable=False)
  607. workflow_id = db.Column(StringUUID, nullable=False)
  608. workflow_run_id = db.Column(StringUUID, nullable=False)
  609. created_from = db.Column(db.String(255), nullable=False)
  610. created_by_role = db.Column(db.String(255), nullable=False)
  611. created_by = db.Column(StringUUID, nullable=False)
  612. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  613. @property
  614. def workflow_run(self):
  615. return db.session.get(WorkflowRun, self.workflow_run_id)
  616. @property
  617. def created_by_account(self):
  618. created_by_role = CreatedByRole(self.created_by_role)
  619. return db.session.get(Account, self.created_by) if created_by_role == CreatedByRole.ACCOUNT else None
  620. @property
  621. def created_by_end_user(self):
  622. from models.model import EndUser
  623. created_by_role = CreatedByRole(self.created_by_role)
  624. return db.session.get(EndUser, self.created_by) if created_by_role == CreatedByRole.END_USER else None
  625. class ConversationVariable(db.Model):
  626. __tablename__ = "workflow_conversation_variables"
  627. id: Mapped[str] = db.Column(StringUUID, primary_key=True)
  628. conversation_id: Mapped[str] = db.Column(StringUUID, nullable=False, primary_key=True)
  629. app_id: Mapped[str] = db.Column(StringUUID, nullable=False, index=True)
  630. data = db.Column(db.Text, nullable=False)
  631. created_at = db.Column(db.DateTime, nullable=False, index=True, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  632. updated_at = db.Column(
  633. db.DateTime, nullable=False, server_default=func.current_timestamp(), onupdate=func.current_timestamp()
  634. )
  635. def __init__(self, *, id: str, app_id: str, conversation_id: str, data: str) -> None:
  636. self.id = id
  637. self.app_id = app_id
  638. self.conversation_id = conversation_id
  639. self.data = data
  640. @classmethod
  641. def from_variable(cls, *, app_id: str, conversation_id: str, variable: Variable) -> "ConversationVariable":
  642. obj = cls(
  643. id=variable.id,
  644. app_id=app_id,
  645. conversation_id=conversation_id,
  646. data=variable.model_dump_json(),
  647. )
  648. return obj
  649. def to_variable(self) -> Variable:
  650. mapping = json.loads(self.data)
  651. return variable_factory.build_conversation_variable_from_mapping(mapping)