@nocobase/plugin-workflow 0.8.1-alpha.4 → 0.9.0-alpha.2

package/lib/client/WorkflowProvider.js

@@ -123,6 +123,7 @@ const WorkflowProvider = props => {
         title: (0, _locale.lang)('Workflow'),
         tabs: {
           workflows: {
+            isBookmark: true,
             title: (0, _locale.lang)('Workflow'),
             component: WorkflowPane
           }

package/lib/client/locale/en-US.d.ts

@@ -1,14 +1,21 @@
 declare const _default: {
     Workflow: string;
     "Execution history": string;
+    Executed: string;
     "Trigger type": string;
     Status: string;
     On: string;
     Off: string;
     Version: string;
     "Copy to new version": string;
+    Duplicate: string;
+    Loading: string;
     "Load failed": string;
     Trigger: string;
+    "Trigger variables": string;
+    "Trigger data": string;
+    "Trigger time": string;
+    "Triggered at": string;
     "Collection event": string;
     "Trigger on": string;
     "After record added": string;
@@ -24,6 +31,7 @@ declare const _default: {
     "Based on date field of collection": string;
     "Starts on": string;
     "Ends on": string;
+    "No end": string;
     "Exactly at": string;
     "Repeat mode": string;
     "Repeat limit": string;
@@ -45,36 +53,51 @@ declare const _default: {
     "By custom date": string;
     Advanced: string;
     End: string;
-    "Trigger variables": string;
     "Node result": string;
     Constant: string;
+    Null: string;
     Boolean: string;
     String: string;
+    Calculator: string;
     "Arithmetic calculation": string;
     "String operation": string;
+    "Executed at": string;
+    Queueing: string;
     "On going": string;
     Succeeded: string;
     Failed: string;
+    Pending: string;
     Canceled: string;
     "This node contains branches, deleting will also be preformed to them, are you sure?": string;
     Control: string;
     "Collection operations": string;
+    "Extended types": string;
     "Node type": string;
     Calculation: string;
     "Configure calculation": string;
     "Calculation result": string;
     True: string;
     False: string;
+    concat: string;
     Condition: string;
     Mode: string;
     "Continue when \"Yes\"": string;
     "Branch into \"Yes\" and \"No\"": string;
     Conditions: string;
     "Parallel branch": string;
+    "Add branch": string;
     "All succeeded": string;
     "Any succeeded": string;
+    "Any succeeded or failed": string;
     "Continue after all branches succeeded": string;
     "Continue after any branch succeeded": string;
+    "Continue after any branch succeeded, or exit after any branch failed": string;
+    Delay: string;
+    Duration: string;
+    "End Status": string;
+    "Select status": string;
+    "Succeed and continue": string;
+    "Fail and exit": string;
     "Create record": string;
     "Update record": string;
     "Query record": string;
@@ -84,22 +107,24 @@ declare const _default: {
     "Fields that are not assigned a value will be set to the default value, and those that do not have a default value are set to null.": string;
     "Trigger in executed workflow cannot be modified": string;
     "Node in executed workflow cannot be modified": string;
-    'HTTP request': string;
+    "Can not delete": string;
+    "The result of this node has been referenced by other nodes ({{nodes}}), please remove the usage before deleting.": string;
+    "HTTP request": string;
     URL: string;
-    'You can use the above available variables in URL.': string;
-    'Request headers': string;
-    'Name(e.g. Content-Type)': string;
-    'Value(e.g. Application/json)': string;
-    'Add request header': string;
-    'HTTP method': string;
-    'Request data': string;
-    'Input request data': string;
-    'You can use the above available variables in request data.': string;
-    'Copy success!': string;
-    'Copy variable output template statement': string;
-    'Default headers is Content-Type: application/json': string;
-    'Ignore fail request and continue workflow': string;
-    'Syntax see': string;
-    'Show available variable tool': string;
+    "You can use the above available variables in URL.": string;
+    "Request headers": string;
+    "Name(e.g. Content-Type)": string;
+    "Value(e.g. Application/json)": string;
+    "Add request header": string;
+    "HTTP method": string;
+    "Request data": string;
+    "Input request data": string;
+    "You can use the above available variables in request data.": string;
+    "Copy success!": string;
+    "Copy variable output template statement": string;
+    "Default headers is Content-Type: application/json": string;
+    "Ignore fail request and continue workflow": string;
+    "Syntax see": string;
+    "Show available variable tool": string;
 };
 export default _default;

package/lib/client/locale/en-US.js

@@ -7,14 +7,21 @@ exports.default = void 0;
 var _default = {
   "Workflow": "Workflow",
   "Execution history": "Execution history",
+  "Executed": "Executed",
   "Trigger type": "Trigger type",
   "Status": "Status",
   "On": "On",
   "Off": "Off",
   "Version": "Version",
   "Copy to new version": "Copy to new version",
+  "Duplicate": "Duplicate",
+  "Loading": "Loading",
   "Load failed": "Load failed",
   "Trigger": "Trigger",
+  "Trigger variables": "Trigger variables",
+  "Trigger data": "Trigger data",
+  "Trigger time": "Trigger time",
+  "Triggered at": "Triggered at",
   "Collection event": "Collection event",
   "Trigger on": "Trigger on",
   "After record added": "After record added",
@@ -30,6 +37,7 @@ var _default = {
   "Based on date field of collection": "Based on date field of collection",
   "Starts on": "Starts on",
   "Ends on": "Ends on",
+  "No end": "No end",
   "Exactly at": "Exactly at",
   "Repeat mode": "Repeat mode",
   "Repeat limit": "Repeat limit",
@@ -51,36 +59,51 @@ var _default = {
   "By custom date": "By custom date",
   "Advanced": "Advanced",
   "End": "End",
-  "Trigger variables": "Trigger variables",
   "Node result": "Node result",
   "Constant": "Constant",
+  "Null": "Null",
   "Boolean": "Boolean",
   "String": "String",
+  "Calculator": "Calculator",
   "Arithmetic calculation": "Arithmetic calculation",
   "String operation": "String operation",
+  "Executed at": "Executed at",
+  "Queueing": "Queueing",
   "On going": "On going",
   "Succeeded": "Succeeded",
   "Failed": "Failed",
+  "Pending": "Pending",
   "Canceled": "Canceled",
   "This node contains branches, deleting will also be preformed to them, are you sure?": "This node contains branches, deleting will also be preformed to them, are you sure?",
   "Control": "Control",
   "Collection operations": "Collection operations",
+  "Extended types": "Extended types",
   "Node type": "Node type",
   "Calculation": "Calculation",
   "Configure calculation": "Configure calculation",
   "Calculation result": "Calculation result",
   "True": "True",
   "False": "False",
+  "concat": "concat",
   "Condition": "Condition",
   "Mode": "Mode",
   "Continue when \"Yes\"": "Continue when \"Yes\"",
   "Branch into \"Yes\" and \"No\"": "Branch into \"Yes\" and \"No\"",
   "Conditions": "Conditions",
   "Parallel branch": "Parallel branch",
+  "Add branch": "Add branch",
   "All succeeded": "All succeeded",
   "Any succeeded": "Any succeeded",
+  "Any succeeded or failed": "Any succeeded or failed",
   "Continue after all branches succeeded": "Continue after all branches succeeded",
   "Continue after any branch succeeded": "Continue after any branch succeeded",
+  "Continue after any branch succeeded, or exit after any branch failed": "Continue after any branch succeeded, or exit after any branch failed",
+  "Delay": "Delay",
+  "Duration": "Duration",
+  "End Status": "End Status",
+  "Select status": "Select status",
+  "Succeed and continue": "Succeed and continue",
+  "Fail and exit": "Fail and exit",
   "Create record": "Create record",
   "Update record": "Update record",
   "Query record": "Query record",
@@ -90,22 +113,24 @@ var _default = {
   "Fields that are not assigned a value will be set to the default value, and those that do not have a default value are set to null.": "Fields that are not assigned a value will be set to the default value, and those that do not have a default value are set to null.",
   "Trigger in executed workflow cannot be modified": "Trigger in executed workflow cannot be modified",
   "Node in executed workflow cannot be modified": "Node in executed workflow cannot be modified",
-  'HTTP request': 'HTTP request',
-  'URL': 'URL',
-  'You can use the above available variables in URL.': 'You can use the above available variables in URL.',
-  'Request headers': 'Request headers',
-  'Name(e.g. Content-Type)': 'Name(e.g. Content-Type)',
-  'Value(e.g. Application/json)': 'Value(e.g. Application/json)',
-  'Add request header': 'Add request header',
-  'HTTP method': 'HTTP method',
-  'Request data': 'Request data',
-  'Input request data': 'Input request data',
-  'You can use the above available variables in request data.': 'You can use the above available variables in request data.',
-  'Copy success!': 'Copy success!',
-  'Copy variable output template statement': 'Copy variable output template statement',
-  'Default headers is Content-Type: application/json': 'Default headers is Content-Type: application/json',
-  'Ignore fail request and continue workflow': 'Ignore fail request and continue workflow',
-  'Syntax see': 'Syntax see',
-  'Show available variable tool': 'Show available variable tool'
+  "Can not delete": "Can not delete",
+  "The result of this node has been referenced by other nodes ({{nodes}}), please remove the usage before deleting.": "The result of this node has been referenced by other nodes ({{nodes}}), please remove the usage before deleting.",
+  "HTTP request": "HTTP request",
+  "URL": "URL",
+  "You can use the above available variables in URL.": "You can use the above available variables in URL.",
+  "Request headers": "Request headers",
+  "Name(e.g. Content-Type)": "Name(e.g. Content-Type)",
+  "Value(e.g. Application/json)": "Value(e.g. Application/json)",
+  "Add request header": "Add request header",
+  "HTTP method": "HTTP method",
+  "Request data": "Request data",
+  "Input request data": "Input request data",
+  "You can use the above available variables in request data.": "You can use the above available variables in request data.",
+  "Copy success!": "Copy success!",
+  "Copy variable output template statement": "Copy variable output template statement",
+  "Default headers is Content-Type: application/json": "Default headers is Content-Type: application/json",
+  "Ignore fail request and continue workflow": "Ignore fail request and continue workflow",
+  "Syntax see": "Syntax see",
+  "Show available variable tool": "Show available variable tool"
 };
 exports.default = _default;

package/lib/client/locale/index.js

@@ -7,56 +7,39 @@ exports.NAMESPACE = void 0;
 exports.lang = lang;
 exports.useWorkflowTranslation = useWorkflowTranslation;
 
-function _reactI18next() {
-  const data = require("react-i18next");
+function _client() {
+  const data = require("@nocobase/client");
 
-  _reactI18next = function _reactI18next() {
+  _client = function _client() {
     return data;
   };
 
   return data;
 }
 
-function _client() {
-  const data = require("@nocobase/client");
+function _reactI18next() {
+  const data = require("react-i18next");
 
-  _client = function _client() {
+  _reactI18next = function _reactI18next() {
     return data;
   };
 
   return data;
 }
 
-var _zhCN = _interopRequireDefault(require("./zh-CN"));
-
-var _enUS = _interopRequireDefault(require("./en-US"));
-
-var _jaJP = _interopRequireDefault(require("./ja-JP"));
-
-var _ruRU = _interopRequireDefault(require("./ru-RU"));
-
-var _trTR = _interopRequireDefault(require("./tr-TR"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-const NAMESPACE = 'workflow';
-exports.NAMESPACE = NAMESPACE;
-
-_client().i18n.addResources('zh-CN', NAMESPACE, _zhCN.default);
-
-_client().i18n.addResources('en-US', NAMESPACE, _enUS.default);
+const NAMESPACE = 'workflow'; // i18n.addResources('zh-CN', NAMESPACE, zhCN);
+// i18n.addResources('en-US', NAMESPACE, enUS);
+// i18n.addResources('ja-JP', NAMESPACE, jaJP);
+// i18n.addResources('ru-RU', NAMESPACE, ruRU);
+// i18n.addResources('tr-TR', NAMESPACE, trTR);
 
-_client().i18n.addResources('ja-JP', NAMESPACE, _jaJP.default);
-
-_client().i18n.addResources('ru-RU', NAMESPACE, _ruRU.default);
-
-_client().i18n.addResources('tr-TR', NAMESPACE, _trTR.default);
+exports.NAMESPACE = NAMESPACE;
 
 function lang(key, options = {}) {
   return _client().i18n.t(key, _objectSpread(_objectSpread({}, options), {}, {

package/lib/server/Plugin.d.ts

@@ -2,9 +2,9 @@ import { Plugin } from '@nocobase/server';
 import { Registry } from '@nocobase/utils';
 import { Instruction } from './instructions';
 import ExecutionModel from './models/Execution';
+import JobModel from './models/Job';
 import WorkflowModel from './models/Workflow';
 import { Trigger } from './triggers';
-import JobModel from './models/Job';
 declare type Pending = [ExecutionModel, JobModel?];
 export default class WorkflowPlugin extends Plugin {
     instructions: Registry<Instruction>;

package/lib/server/Plugin.js

@@ -164,6 +164,8 @@ class WorkflowPlugin extends _server().Plugin {
             context = _event[1],
             options = _event[2];
 
+      let valid = true;
+
       if ((_options$context = options.context) === null || _options$context === void 0 ? void 0 : _options$context.executionId) {
         // NOTE: no transaction here for read-uncommitted execution
         const existed = yield workflow.countExecutions({
@@ -173,57 +175,63 @@ class WorkflowPlugin extends _server().Plugin {
         });
 
         if (existed) {
-          console.warn(`workflow ${workflow.id} has already been triggered in same execution (${options.context.executionId}), and newly triggering will be skipped.`);
-          return;
+          _this.app.logger.warn(`[Workflow] workflow ${workflow.id} has already been triggered in same execution (${options.context.executionId}), and newly triggering will be skipped.`);
+
+          valid = false;
         }
       }
 
-      const execution = yield _this.db.sequelize.transaction( /*#__PURE__*/function () {
-        var _ref3 = _asyncToGenerator(function* (transaction) {
-          const execution = yield workflow.createExecution({
-            context,
-            key: workflow.key,
-            status: _constants.EXECUTION_STATUS.CREATED,
-            useTransaction: workflow.useTransaction
-          }, {
-            transaction
+      if (valid) {
+        const execution = yield _this.db.sequelize.transaction( /*#__PURE__*/function () {
+          var _ref3 = _asyncToGenerator(function* (transaction) {
+            const execution = yield workflow.createExecution({
+              context,
+              key: workflow.key,
+              status: _constants.EXECUTION_STATUS.CREATED,
+              useTransaction: workflow.useTransaction
+            }, {
+              transaction
+            });
+            const executed = yield workflow.countExecutions({
+              transaction
+            }); // NOTE: not to trigger afterUpdate hook here
+
+            yield workflow.update({
+              executed
+            }, {
+              transaction,
+              hooks: false
+            });
+            const allExecuted = yield execution.constructor.count({
+              where: {
+                key: workflow.key
+              },
+              transaction
+            });
+            yield workflow.constructor.update({
+              allExecuted
+            }, {
+              where: {
+                key: workflow.key
+              },
+              individualHooks: true,
+              transaction
+            });
+            execution.workflow = workflow;
+            return execution;
           });
-          const executed = yield workflow.countExecutions({
-            transaction
-          }); // NOTE: not to trigger afterUpdate hook here
 
-          yield workflow.update({
-            executed
-          }, {
-            transaction,
-            hooks: false
-          });
-          const allExecuted = yield execution.constructor.count({
-            where: {
-              key: workflow.key
-            },
-            transaction
-          });
-          yield workflow.constructor.update({
-            allExecuted
-          }, {
-            where: {
-              key: workflow.key
-            },
-            individualHooks: true,
-            transaction
-          });
-          execution.workflow = workflow;
-          return execution;
-        });
+          return function (_x3) {
+            return _ref3.apply(this, arguments);
+          };
+        }());
 
-        return function (_x3) {
-          return _ref3.apply(this, arguments);
-        };
-      }()); // NOTE: cache first execution for most cases
+        _this.app.logger.debug(`[Workflow] execution of workflow ${workflow.id} created as ${execution.id}`); // NOTE: cache first execution for most cases
 
-      if (!_this.executing && !_this.pending.length) {
-        _this.pending.push([execution]);
+
+        if (!_this.executing && !_this.pending.length) {
+          _this.pending.push([execution]);
+        }
       }
 
       if (_this.events.length) {
@@ -240,6 +248,14 @@ class WorkflowPlugin extends _server().Plugin {
     return _asyncToGenerator(function* () {
       const db = _this2.db,
             options = _this2.options;
+
+      _this2.app.acl.registerSnippet({
+        name: `pm.${_this2.name}.workflows`,
+        actions: ['workflows:*', 'workflows.nodes:*', 'executions:list', 'executions:get', 'flow_nodes:update', 'flow_nodes:destroy']
+      });
+
+      _this2.app.acl.allow('users_jobs', ['list', 'get', 'submit'], 'loggedIn');
+
       yield db.import({
         directory: _path().default.resolve(__dirname, 'collections')
       });
@@ -320,6 +336,7 @@ class WorkflowPlugin extends _server().Plugin {
     }
 
     this.events.push([workflow, context, options]);
+    this.app.logger.debug(`[Workflow] new event triggered, now events: ${this.events.length}`);
 
     if (this.events.length > 1) {
       return;
@@ -390,8 +407,14 @@ class WorkflowPlugin extends _server().Plugin {
 
       const processor = _this5.createProcessor(execution);
 
-      console.log('workflow processing:', new Date(), execution.workflowId, execution.id);
-      yield job ? processor.resume(job) : processor.start();
+      _this5.app.logger.info(`[Workflow] execution ${execution.id} ${job ? 'resuming' : 'starting'} ...`);
+
+      try {
+        yield job ? processor.resume(job) : processor.start();
+      } catch (err) {
+        _this5.app.logger.error(`[Workflow] ${err.message}`, err);
+      }
+
       _this5.executing = null;
 
       _this5.dispatch();

package/lib/server/Processor.js

@@ -250,15 +250,13 @@ class Processor {
 
     return _asyncToGenerator(function* () {
       const instructions = _this7.options.plugin.instructions;
+      const instruction = instructions.get(node.type);
 
-      const _instructions$get = instructions.get(node.type),
-            run = _instructions$get.run;
-
-      if (typeof run !== 'function') {
+      if (typeof instruction.run !== 'function') {
         return Promise.reject(new Error('`run` should be implemented for customized execution of the node'));
       }
 
-      return _this7.exec(run, node, input);
+      return _this7.exec(instruction.run.bind(instruction), node, input);
     })();
   } // parent node should take over the control
 
@@ -286,15 +284,13 @@ class Processor {
 
     return _asyncToGenerator(function* () {
       const instructions = _this9.options.plugin.instructions;
+      const instruction = instructions.get(node.type);
 
-      const _instructions$get2 = instructions.get(node.type),
-            resume = _instructions$get2.resume;
-
-      if (typeof resume !== 'function') {
+      if (typeof instruction.resume !== 'function') {
         return Promise.reject(new Error('`resume` should be implemented'));
       }
 
-      return _this9.exec(resume, node, job);
+      return _this9.exec(instruction.resume.bind(instruction), node, job);
     })();
   }
 

package/lib/server/instructions/request.d.ts

@@ -2,13 +2,16 @@ import { AxiosRequestConfig } from 'axios';
 import { Instruction } from './index';
 export interface Header {
     name: string;
-    value: any;
+    value: string;
 }
 export declare type RequestConfig = Pick<AxiosRequestConfig, 'url' | 'method' | 'data' | 'timeout'> & {
     headers: Array<Header>;
     ignoreFail: boolean;
 };
 export default class implements Instruction {
+    plugin: any;
+    constructor(plugin: any);
+    request: (node: any, job: any, processor: any) => Promise<any>;
     run(node: any, input: any, processor: any): Promise<any>;
     resume(node: any, job: any, processor: any): Promise<any>;
 }