workflow.py 28 KB

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