@nocobase/plugin-workflow-sql 0.20.0-alpha.16 → 0.20.0-alpha.17

package/dist/client/SQLInstruction.d.ts

@@ -6,6 +6,19 @@ export default class extends Instruction {
     group: string;
     description: string;
     fieldset: {
+        dataSource: {
+            type: string;
+            required: boolean;
+            title: string;
+            description: string;
+            'x-decorator': string;
+            'x-component': string;
+            'x-component-props': {
+                className: string;
+                filter(item: any): any;
+            };
+            default: string;
+        };
         sql: {
             type: string;
             required: boolean;

package/dist/client/index.js

@@ -1,4 +1,4 @@
-(function(e,o){typeof exports=="object"&&typeof module!="undefined"?o(exports,require("@nocobase/client"),require("react/jsx-runtime"),require("@nocobase/plugin-workflow/client"),require("react-i18next")):typeof define=="function"&&define.amd?define(["exports","@nocobase/client","react/jsx-runtime","@nocobase/plugin-workflow/client","react-i18next"],o):(e=typeof globalThis!="undefined"?globalThis:e||self,o(e["@nocobase/plugin-workflow-sql"]={},e["@nocobase/client"],e.jsxRuntime,e["@nocobase/plugin-workflow"],e["react-i18next"]))})(this,function(e,o,n,s,c){"use strict";var b=Object.defineProperty;var x=(e,o,n)=>o in e?b(e,o,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[o]=n;var r=(e,o,n)=>(x(e,typeof o!="symbol"?o+"":o,n),n);var u=(e,o,n)=>new Promise((s,c)=>{var i=t=>{try{a(n.next(t))}catch(l){c(l)}},d=t=>{try{a(n.throw(t))}catch(l){c(l)}},a=t=>t.done?s(t.value):Promise.resolve(t.value).then(i,d);a((n=n.apply(e,o)).next())});const i="@nocobase/plugin-workflow-sql";class d extends s.Instruction{constructor(){super(...arguments);r(this,"title",`{{t("SQL action", { ns: "${i}" })}}`);r(this,"type","sql");r(this,"group","collection");r(this,"description",`{{t("Execute a SQL statement in database.", { ns: "${i}" })}}`);r(this,"fieldset",{sql:{type:"string",required:!0,title:"SQL",description:"{{sqlDescription()}}","x-decorator":"FormItem","x-component":"WorkflowVariableRawTextArea","x-component-props":{rows:20,className:o.css`
+(function(e,o){typeof exports=="object"&&typeof module!="undefined"?o(exports,require("@nocobase/client"),require("react/jsx-runtime"),require("@nocobase/plugin-workflow/client"),require("react-i18next")):typeof define=="function"&&define.amd?define(["exports","@nocobase/client","react/jsx-runtime","@nocobase/plugin-workflow/client","react-i18next"],o):(e=typeof globalThis!="undefined"?globalThis:e||self,o(e["@nocobase/plugin-workflow-sql"]={},e["@nocobase/client"],e.jsxRuntime,e["@nocobase/plugin-workflow"],e["react-i18next"]))})(this,function(e,o,t,a,l){"use strict";var m=Object.defineProperty;var x=(e,o,t)=>o in e?m(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t;var r=(e,o,t)=>(x(e,typeof o!="symbol"?o+"":o,t),t);var u=(e,o,t)=>new Promise((a,l)=>{var s=n=>{try{i(t.next(n))}catch(c){l(c)}},d=n=>{try{i(t.throw(n))}catch(c){l(c)}},i=n=>n.done?a(n.value):Promise.resolve(n.value).then(s,d);i((t=t.apply(e,o)).next())});const s="@nocobase/plugin-workflow-sql";class d extends a.Instruction{constructor(){super(...arguments);r(this,"title",`{{t("SQL action", { ns: "${s}" })}}`);r(this,"type","sql");r(this,"group","collection");r(this,"description",`{{t("Execute a SQL statement in database.", { ns: "${s}" })}}`);r(this,"fieldset",{dataSource:{type:"string",required:!0,title:'{{t("Data source")}}',description:`{{t("Select a data source to execute SQL.", { ns: "${s}" })}}`,"x-decorator":"FormItem","x-component":"DataSourceSelect","x-component-props":{className:"auto-width",filter(p){return p.options.isDBInstance}},default:"main"},sql:{type:"string",required:!0,title:"SQL",description:"{{sqlDescription()}}","x-decorator":"FormItem","x-component":"WorkflowVariableRawTextArea","x-component-props":{rows:20,className:o.css`
           font-size: 80%;
           font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
-        `}}});r(this,"scope",{sqlDescription(){return n.jsxs(c.Trans,{ns:i,children:["SQL query result could be used through ",n.jsx("a",{href:"https://docs-cn.nocobase.com/handbook/workflow-json-query",target:"_blank",rel:"noreferrer",children:"JSON query node"})," (Commercial plugin)."]})}});r(this,"components",{WorkflowVariableRawTextArea:s.WorkflowVariableRawTextArea})}useVariables({key:p,title:w},{types:m,fieldNames:f=s.defaultFieldNames}){return{[f.value]:p,[f.label]:w}}}class a extends o.Plugin{afterAdd(){return u(this,null,function*(){})}beforeLoad(){return u(this,null,function*(){})}load(){return u(this,null,function*(){this.app.pm.get("workflow").registerInstruction("sql",d)})}}e.default=a,Object.defineProperties(e,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});
+        `}}});r(this,"scope",{sqlDescription(){return t.jsxs(l.Trans,{ns:s,children:["SQL query result could be used through ",t.jsx("a",{href:"https://docs-cn.nocobase.com/handbook/workflow-json-query",target:"_blank",rel:"noreferrer",children:"JSON query node"})," (Commercial plugin)."]})}});r(this,"components",{WorkflowVariableRawTextArea:a.WorkflowVariableRawTextArea})}useVariables({key:p,title:w},{types:b,fieldNames:f=a.defaultFieldNames}){return{[f.value]:p,[f.label]:w}}}class i extends o.Plugin{afterAdd(){return u(this,null,function*(){})}beforeLoad(){return u(this,null,function*(){})}load(){return u(this,null,function*(){this.app.pm.get("workflow").registerInstruction("sql",d)})}}e.default=i,Object.defineProperties(e,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});

package/dist/externalVersion.js

@@ -1,10 +1,10 @@
 module.exports = {
-  "@nocobase/client": "0.20.0-alpha.16",
-  "@nocobase/plugin-workflow": "0.20.0-alpha.16",
+  "@nocobase/client": "0.20.0-alpha.17",
+  "@nocobase/plugin-workflow": "0.20.0-alpha.17",
   "react": "18.2.0",
   "react-i18next": "11.18.6",
-  "@nocobase/server": "0.20.0-alpha.16",
-  "@nocobase/plugin-workflow-test": "0.20.0-alpha.16",
-  "@nocobase/test": "0.20.0-alpha.16",
-  "@nocobase/utils": "0.20.0-alpha.16"
+  "@nocobase/server": "0.20.0-alpha.17",
+  "@nocobase/plugin-workflow-test": "0.20.0-alpha.17",
+  "@nocobase/test": "0.20.0-alpha.17",
+  "@nocobase/utils": "0.20.0-alpha.17"
 };

package/dist/locale/zh-CN.json

@@ -1,5 +1,6 @@
 {
   "SQL action": "SQL 操作",
   "Execute a SQL statement in database.": "在数据库中执行一个 SQL 语句",
+  "Select a data source to execute SQL.": "选择一个数据源来执行 SQL",
   "SQL query result could be used through <1>JSON query node</1> (Commercial plugin).": "SQL 执行的结果可在 <1>JSON 解析节点</1> 中使用（商业插件）。"
 }

package/dist/server/SQLInstruction.d.ts

@@ -4,7 +4,7 @@ export default class extends Instruction {
         status: 1;
         result?: undefined;
     } | {
-        result: [unknown[], unknown];
+        result: any;
         status: 1;
     }>;
 }

package/dist/server/SQLInstruction.js

@@ -23,14 +23,19 @@ module.exports = __toCommonJS(SQLInstruction_exports);
 var import_plugin_workflow = require("@nocobase/plugin-workflow");
 class SQLInstruction_default extends import_plugin_workflow.Instruction {
   async run(node, input, processor) {
-    const { sequelize } = node.constructor.database;
-    const sql = processor.getParsedValue(node.config.sql ?? "", node.id).trim();
+    const { db } = this.workflow.app.dataSourceManager.dataSources.get(
+      node.config.dataSource || "main"
+    ).collectionManager;
+    if (!db) {
+      throw new Error(`type of data source "${node.config.dataSource}" is not database`);
+    }
+    const sql = processor.getParsedValue(node.config.sql || "", node.id).trim();
     if (!sql) {
       return {
         status: import_plugin_workflow.JOB_STATUS.RESOLVED
       };
     }
-    const result = await sequelize.query(sql, {
+    const result = await db.sequelize.query(sql, {
       transaction: processor.transaction
       // plain: true,
       // model: db.getCollection(node.config.collection).model

package/package.json

@@ -4,7 +4,7 @@
   "displayName.zh-CN": "工作流：SQL 节点",
   "description": "Execute SQL statements in workflow.",
   "description.zh-CN": "可用于在工作流中对数据库执行任意 SQL 语句。",
-  "version": "0.20.0-alpha.16",
+  "version": "0.20.0-alpha.17",
   "license": "AGPL-3.0",
   "main": "./dist/server/index.js",
   "homepage": "https://docs.nocobase.com/handbook/workflow-sql",
@@ -21,7 +21,7 @@
     "@nocobase/server": "0.x",
     "@nocobase/test": "0.x"
   },
-  "gitHead": "b88be61ef9bc0edeacd6d62d9cd58d8498b98372",
+  "gitHead": "a2460c222bc0b8a3bcb783b5c856499d756efa82",
   "keywords": [
     "Workflow"
   ]

package/src/client/SQLInstruction.tsx

@@ -12,6 +12,21 @@ export default class extends Instruction {
   group = 'collection';
   description = `{{t("Execute a SQL statement in database.", { ns: "${NAMESPACE}" })}}`;
   fieldset = {
+    dataSource: {
+      type: 'string',
+      required: true,
+      title: `{{t("Data source")}}`,
+      description: `{{t("Select a data source to execute SQL.", { ns: "${NAMESPACE}" })}}`,
+      'x-decorator': 'FormItem',
+      'x-component': 'DataSourceSelect',
+      'x-component-props': {
+        className: 'auto-width',
+        filter(item) {
+          return item.options.isDBInstance;
+        },
+      },
+      default: 'main',
+    },
     sql: {
       type: 'string',
       required: true,

package/src/locale/zh-CN.json

@@ -1,5 +1,6 @@
 {
   "SQL action": "SQL 操作",
   "Execute a SQL statement in database.": "在数据库中执行一个 SQL 语句",
+  "Select a data source to execute SQL.": "选择一个数据源来执行 SQL",
   "SQL query result could be used through <1>JSON query node</1> (Commercial plugin).": "SQL 执行的结果可在 <1>JSON 解析节点</1> 中使用（商业插件）。"
 }

package/src/server/SQLInstruction.ts

@@ -2,15 +2,22 @@ import { Processor, Instruction, JOB_STATUS, FlowNodeModel } from '@nocobase/plu
 
 export default class extends Instruction {
   async run(node: FlowNodeModel, input, processor: Processor) {
-    const { sequelize } = (<typeof FlowNodeModel>node.constructor).database;
-    const sql = processor.getParsedValue(node.config.sql ?? '', node.id).trim();
+    // @ts-ignore
+    const { db } = this.workflow.app.dataSourceManager.dataSources.get(
+      node.config.dataSource || 'main',
+    ).collectionManager;
+    if (!db) {
+      throw new Error(`type of data source "${node.config.dataSource}" is not database`);
+    }
+    const sql = processor.getParsedValue(node.config.sql || '', node.id).trim();
     if (!sql) {
       return {
         status: JOB_STATUS.RESOLVED,
       };
     }
 
-    const result = await sequelize.query(sql, {
+    // @ts-ignore
+    const result = await db.sequelize.query(sql, {
       transaction: processor.transaction,
       // plain: true,
       // model: db.getCollection(node.config.collection).model

package/src/server/__tests__/instruction.test.ts

@@ -92,6 +92,26 @@ describe('workflow > instructions > sql', () => {
   });
 
   describe('sql with variables', () => {
+    it('$system.now', async () => {
+      const queryInterface = db.sequelize.getQueryInterface();
+      const n1 = await workflow.createNode({
+        type: 'sql',
+        config: {
+          sql: `select '{{$system.now}}' as a`,
+        },
+      });
+
+      const post = await PostRepo.create({ values: { title: 't1' } });
+
+      await sleep(500);
+
+      const [execution] = await workflow.getExecutions();
+      const [sqlJob] = await execution.getJobs({ order: [['id', 'ASC']] });
+      expect(sqlJob.status).toBe(JOB_STATUS.RESOLVED);
+      // expect(queryJob.status).toBe(JOB_STATUS.RESOLVED);
+      // expect(queryJob.result.read).toBe(post.id);
+    });
+
     it('update', async () => {
       const queryInterface = db.sequelize.getQueryInterface();
       const n1 = await workflow.createNode({
@@ -195,4 +215,35 @@ describe('workflow > instructions > sql', () => {
       expect(job.status).toBe(JOB_STATUS.RESOLVED);
     });
   });
+
+  describe('multiple data source', () => {
+    it('query on another data source', async () => {
+      const anotherSource = app.dataSourceManager.dataSources.get('another');
+      const PostCollection = anotherSource.collectionManager.getCollection('posts');
+      const { repository: AnotherPostRepo } = PostCollection;
+      const post = await AnotherPostRepo.create({ values: { title: 't1' } });
+      const p1s = await AnotherPostRepo.find();
+      expect(p1s.length).toBe(1);
+
+      const n1 = await workflow.createNode({
+        type: 'sql',
+        config: {
+          dataSource: 'another',
+          sql: `select * from ${PostCollection.quotedTableName()}`,
+        },
+      });
+
+      await PostRepo.create({ values: { title: 't1' } });
+
+      await sleep(500);
+
+      const [execution] = await workflow.getExecutions();
+      expect(execution.status).toBe(EXECUTION_STATUS.RESOLVED);
+      const [job] = await execution.getJobs();
+      expect(job.result.length).toBe(2);
+      expect(job.result[0].length).toBe(1);
+      // @ts-ignore
+      expect(job.result[0][0].id).toBe(post.id);
+    });
+  });
 });