workflow.py 28 KB

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