@nocobase/plugin-ai 2.2.0-beta.1 → 2.2.0-beta.3

package/dist/ai/docs/nocobase/workflow/nodes/transaction.md

@@ -0,0 +1,81 @@
+---
+pkg: '@nocobase/plugin-workflow-transaction'
+title: "Workflow node - Database transaction"
+description: "Database transaction node: run data operations from the same data source in one transaction, commit on success, and roll back on failure."
+keywords: "workflow,database transaction,Transaction,rollback,commit,data operation,NocoBase"
+---
+
+# Database Transaction
+
+## Introduction
+
+The database transaction node runs a group of database operations in the same transaction. It is suitable for scenarios where multiple data steps must either all succeed or all roll back, such as creating an order, deducting inventory, writing order details, and updating status.
+
+The transaction node currently supports database data sources only. Data operations from the same data source inside the node are automatically included in the transaction; other data sources do not use this transaction.
+
+This node has been supported since 2.2.0.
+
+## Create Node
+
+In the workflow configuration interface, click the plus ("+") button in the flow to add a "Database transaction" node.
+
+![20260610205146](https://static-docs.nocobase.com/20260610205146.png)
+
+After creation, two branches are generated:
+
+- **Run**: The main branch executed inside the transaction. If all nodes in this branch succeed, the transaction is committed automatically. If any node fails or throws an error, the transaction is rolled back automatically.
+- **After rollback**: The branch executed after rollback. This branch runs outside the transaction and can be used to record logs, send notifications, or perform compensation handling.
+
+![20260610205303](https://static-docs.nocobase.com/20260610205303.png)
+
+## Node Configuration
+
+![20260610205505](https://static-docs.nocobase.com/20260610205505.png)
+
+### Data Source
+
+Select the database data source controlled by this transaction. Only data operation nodes from the same data source are automatically included in the transaction.
+
+### Isolation Level
+
+Set the transaction isolation level. The default value is `READ UNCOMMITTED`. If your business requires stricter data consistency, choose another isolation level based on database capabilities and concurrency requirements.
+
+### Continue Workflow After Rollback
+
+When enabled, the workflow continues to the nodes after the transaction node after the `After rollback` branch finishes.
+
+When disabled, the workflow stops at the transaction node after the `After rollback` branch finishes, and subsequent nodes are not executed.
+
+## Usage
+
+### Constraints
+
+The `Run` branch does not support asynchronous nodes that suspend the workflow, such as manual handling and delay nodes. The transaction must be committed or rolled back during the current execution. If the `Run` branch enters a waiting state, the system rolls back the transaction and marks the workflow as failed.
+
+The `After rollback` branch runs outside the transaction, so it is not subject to the above restriction. You can use asynchronous nodes in this branch as needed, such as sending requests, waiting for manual confirmation, or delaying processing.
+
+:::warning Note
+Transactions occupy database connections until they are committed or rolled back. Avoid long-running operations in the `Run` branch and keep only the necessary data reads, writes, and checks there.
+:::
+
+### Nested Transactions
+
+Transaction nodes can be nested, but you need to pay attention to the data source scope:
+
+- If the inner and outer transactions use the same data source, the inner transaction is created within the outer transaction scope and is handled according to the database and Sequelize capabilities.
+- If the inner transaction uses a different data source, it does not reuse the outer transaction and creates an independent transaction for that data source.
+- If the workflow is triggered by a synchronous collection event, the trigger itself may already provide a top-level transaction for the same data source. The transaction node preferentially reuses the outer transaction of the same data source and does not reuse transactions from different data sources.
+
+Nested transactions increase the cost of understanding and troubleshooting. In general, use nested transactions only when you really need a local rollback boundary. Otherwise, prefer wrapping the complete data processing flow in a single transaction node.
+
+### Common Scenario
+
+A typical flow is as follows:
+
+1. Query or create related data in the `Run` branch.
+2. Continue updating inventory, status, details, and other data from the same data source in the `Run` branch.
+3. If all steps succeed, the transaction is committed automatically.
+4. If any node fails or throws an error, the transaction is rolled back automatically and the workflow enters the `After rollback` branch.
+5. Record the failure reason, send notifications, or perform compensation logic in the `After rollback` branch.
+
+If the workflow needs to continue after rollback, enable "Continue workflow after rollback".

package/dist/client/561.7ec804ef39ec7dcd.js

@@ -0,0 +1,10 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+"use strict";(self.webpackChunk_nocobase_plugin_ai=self.webpackChunk_nocobase_plugin_ai||[]).push([["561"],{3392:function(e,t,r){r.r(t),r.d(t,{Messages:function(){return v},MessagesSettings:function(){return g}});var o=r(3342),n=r(9155),a=r.n(n),s=r(3079),l=r(7768),c=r(418),p=r(166),i=r(5230),m=r(1990),u=r(2333),y=r(2059),d=(0,i.observer)(function(e){var t,r,o=(0,i.useField)(),n=(0,i.useFieldSchema)(),s=Array.isArray(o.value)?o.value:[],l=e.header,m=e.itemTitle;return a().createElement(c.ArrayBase,null,a().createElement(u.Ay,(t=function(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{},o=Object.keys(r);"function"==typeof Object.getOwnPropertySymbols&&(o=o.concat(Object.getOwnPropertySymbols(r).filter(function(e){return Object.getOwnPropertyDescriptor(r,e).enumerable}))),o.forEach(function(t){var o;o=r[t],t in e?Object.defineProperty(e,t,{value:o,enumerable:!0,configurable:!0,writable:!0}):e[t]=o})}return e}({},e),r=r={value:s,onChange:function(e){o.form.setValuesIn(o.path,e)},getDefaultValue:function(){return(0,p.clone)(e.defaultValue)},renderHeader:function(e,t){var r=o.form.queryFeedbacks({type:"error",address:"".concat(o.address.concat(t),".**")}),n=null!=l?l:m;return r.length?a().createElement(y.Badge,{size:"small",className:"errors-badge",count:r.length},n):n},renderItem:function(e,t){var r=Array.isArray(n.items)?n.items[t]||n.items[0]:n.items;return r?a().createElement(c.ArrayBase.Item,{index:t,record:e},a().createElement(i.RecursionField,{schema:r,name:t})):null}},Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(r)):(function(e){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t.push.apply(t,r)}return t})(Object(r)).forEach(function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(r,e))}),t)))}),b=(0,i.observer)(function(){var e=(0,s.kj)(),t=(0,i.useField)().query(".type").take();return(null==t?void 0:t.value)==="image_url"||(null==t?void 0:t.value)==="image_base64"?a().createElement(o.SchemaComponent,{components:{WorkflowVariableInput:m.WorkflowVariableInput},schema:{type:"void",properties:{image_url:{type:"object",properties:{url:{title:(0,l.tval)("Image",{ns:s.MF}),type:"string","x-decorator":"FormItem","x-component":"WorkflowVariableInput","x-component-props":{changeOnSelect:!0}}}}}}}):a().createElement(o.SchemaComponent,{components:{WorkflowVariableRawTextArea:m.WorkflowVariableRawTextArea},schema:{type:"void",properties:{content:{title:e("Content"),type:"string","x-decorator":"FormItem","x-component":"WorkflowVariableRawTextArea","x-component-props":{autoSize:{minRows:5}}}}}})}),f=(0,i.observer)(function(){var e=(0,s.kj)(),t=(0,i.useField)().query(".role").take();return t?"user"===t.value?a().createElement(o.SchemaComponent,{components:{FormLayout:c.FormLayout,ListCollapse:d,UserMessage:b},schema:{type:"void",properties:{content:{type:"array","x-component":"ListCollapse","x-component-props":{size:"small",bordered:!1,addText:(0,l.tval)("Add content",{ns:s.MF}),defaultValue:{type:"text"},header:e("Content"),itemTitle:e("Content")},default:[{type:"text"}],"x-decorator":"FormItem",items:{type:"object",properties:{form:{type:"void","x-component":"FormLayout","x-component-props":{layout:"vertical"},properties:{type:{title:e("Type"),type:"string","x-decorator":"FormItem","x-component":"Select",enum:[{label:e("Text"),value:"text"},{label:e("Image (send via URL)"),value:"image_url"},{label:e("Image (send via Base64)"),value:"image_base64"}],default:"text"},user:{type:"void","x-component":"UserMessage"}}}}}}}}}):a().createElement(o.SchemaComponent,{components:{WorkflowVariableRawTextArea:m.WorkflowVariableRawTextArea},schema:{type:"void",properties:{message:{title:(0,l.tval)("Content",{ns:s.MF}),type:"string","x-decorator":"FormItem","x-component":"WorkflowVariableRawTextArea"}}}}):null}),v=function(){var e=(0,s.kj)();return a().createElement(o.SchemaComponent,{components:{Content:f,FormLayout:c.FormLayout,ListCollapse:d},schema:{type:"void",properties:{messages:{type:"array","x-component":"ListCollapse","x-component-props":{size:"small",addText:(0,l.tval)("Add prompt",{ns:s.MF}),defaultValue:{role:"user",content:[{type:"text"}]},header:e("Message"),itemTitle:e("Message")},"x-decorator":"FormItem",default:[{role:"user",content:[{type:"text"}]}],items:{type:"object",properties:{form:{type:"void","x-component":"FormLayout","x-component-props":{layout:"vertical"},properties:{role:{title:(0,l.tval)("Role",{ns:s.MF}),type:"string","x-decorator":"FormItem","x-component":"Select",enum:[{label:"System",value:"system"},{label:"User",value:"user"},{label:"Assistant",value:"assistant"}],default:"user"},content:{type:"void","x-component":"Content"}}}}}}}}})},g=function(){return a().createElement(o.SchemaComponent,{components:{Messages:v},schema:{type:"void",properties:{messages:{type:"void","x-component":"Messages"}}}})}}}]);