@nocobase/plugin-workflow 0.7.0-alpha.4 → 0.7.0-alpha.58

package/lib/models/FlowNode.js

@@ -1,7 +1,20 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const database_1 = require("@nocobase/database");
-class FlowNodeModel extends database_1.Model {
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+function _database() {
+  const data = require("@nocobase/database");
+
+  _database = function _database() {
+    return data;
+  };
+
+  return data;
 }
-exports.default = FlowNodeModel;
-//# sourceMappingURL=FlowNode.js.map
+
+class FlowNodeModel extends _database().Model {}
+
+exports.default = FlowNodeModel;

package/lib/models/Job.js

@@ -1,7 +1,20 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const database_1 = require("@nocobase/database");
-class JobModel extends database_1.Model {
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+function _database() {
+  const data = require("@nocobase/database");
+
+  _database = function _database() {
+    return data;
+  };
+
+  return data;
 }
-exports.default = JobModel;
-//# sourceMappingURL=Job.js.map
+
+class JobModel extends _database().Model {}
+
+exports.default = JobModel;

package/lib/models/Workflow.d.ts

@@ -1,5 +1,5 @@
 import { Database, Model } from '@nocobase/database';
-import { HasManyCreateAssociationMixin, HasManyGetAssociationsMixin } from 'sequelize';
+import { HasManyCountAssociationsMixin, HasManyCreateAssociationMixin, HasManyGetAssociationsMixin } from 'sequelize';
 import ExecutionModel from './Execution';
 import FlowNodeModel from './FlowNode';
 export default class WorkflowModel extends Model {
@@ -11,17 +11,16 @@ export default class WorkflowModel extends Model {
     type: string;
     config: any;
     useTransaction: boolean;
+    executed: boolean;
     createdAt: Date;
     updatedAt: Date;
     nodes: FlowNodeModel[];
     getNodes: HasManyGetAssociationsMixin<FlowNodeModel>;
     createNode: HasManyCreateAssociationMixin<FlowNodeModel>;
     executions: ExecutionModel[];
+    countExecutions: HasManyCountAssociationsMixin;
     getExecutions: HasManyGetAssociationsMixin<ExecutionModel>;
     createExecution: HasManyCreateAssociationMixin<ExecutionModel>;
-    static mount(): Promise<void>;
-    getHookId(): string;
     getTransaction(options: any): any;
-    toggle(enable?: boolean): Promise<void>;
-    trigger(context: Object, options: any): Promise<ExecutionModel>;
+    trigger: (context: Object, options?: {}) => Promise<ExecutionModel>;
 }

package/lib/models/Workflow.js

@@ -1,78 +1,101 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const database_1 = require("@nocobase/database");
-const triggers_1 = __importDefault(require("../triggers"));
-const constants_1 = require("../constants");
-class WorkflowModel extends database_1.Model {
-    static mount() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const collection = this.database.getCollection('workflows');
-            const workflows = yield collection.repository.find({
-                filter: { enabled: true },
-            });
-            workflows.forEach((workflow) => {
-                workflow.toggle();
-            });
-            this.addHook('afterCreate', (model) => model.toggle());
-            this.addHook('afterUpdate', (model) => model.toggle());
-            this.addHook('afterDestroy', (model) => model.toggle(false));
-        });
-    }
-    getHookId() {
-        return `workflow-${this.get('id')}`;
-    }
-    getTransaction(options) {
-        if (!this.useTransaction) {
-            return undefined;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+function _database() {
+  const data = require("@nocobase/database");
+
+  _database = function _database() {
+    return data;
+  };
+
+  return data;
+}
+
+var _constants = require("../constants");
+
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
+
+class WorkflowModel extends _database().Model {
+  constructor(...args) {
+    var _this;
+
+    super(...args);
+    _this = this;
+
+    this.trigger = /*#__PURE__*/function () {
+      var _ref = _asyncToGenerator(function* (context, options = {}) {
+        // `null` means not to trigger
+        if (context === null) {
+          return;
         }
-        return options.transaction && !options.transaction.finished
-            ? options.transaction
-            : this.constructor.database.sequelize.transaction();
-    }
-    toggle(enable) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const type = this.get('type');
-            const { on, off } = triggers_1.default.get(type);
-            if (typeof enable !== 'undefined' ? enable : this.get('enabled')) {
-                on.call(this, this.trigger.bind(this));
-            }
-            else {
-                off.call(this);
-            }
+
+        const transaction = yield _this.getTransaction(options);
+
+        if (_this.useTransaction) {
+          const existed = yield _this.countExecutions({
+            where: {
+              transaction: transaction.id
+            },
+            transaction
+          });
+
+          if (existed) {
+            console.warn(`workflow ${_this.id} has already been triggered in same execution (${transaction.id}), and newly triggering will be skipped.`);
+            return;
+          }
+        }
+
+        const execution = yield _this.createExecution({
+          context,
+          status: _constants.EXECUTION_STATUS.STARTED,
+          useTransaction: _this.useTransaction,
+          transaction: transaction.id
+        }, {
+          transaction
         });
-    }
-    trigger(context, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // `null` means not to trigger
-            if (context === null) {
-                return;
-            }
-            const transaction = yield this.getTransaction(options);
-            const execution = yield this.createExecution({
-                context,
-                status: constants_1.EXECUTION_STATUS.STARTED,
-                useTransaction: this.useTransaction
-            }, { transaction });
-            execution.workflow = this;
-            yield execution.start({ transaction });
-            if (transaction && (!options.transaction || options.transaction.finished)) {
-                yield transaction.commit();
-            }
-            return execution;
+        execution.workflow = _this;
+        yield execution.start({
+          transaction
         });
+
+        if (!_this.executed) {
+          // NOTE: not to trigger afterUpdate hook here
+          yield _this.update({
+            executed: true
+          }, {
+            transaction,
+            hooks: false
+          });
+        } // @ts-ignore
+
+
+        if (transaction && (!options.transaction || options.transaction.finished)) {
+          yield transaction.commit();
+        }
+
+        return execution;
+      });
+
+      return function (_x) {
+        return _ref.apply(this, arguments);
+      };
+    }();
+  }
+
+  getTransaction(options) {
+    if (!this.useTransaction) {
+      return null;
     }
+
+    return options.transaction && !options.transaction.finished ? options.transaction : this.constructor.database.sequelize.transaction();
+  }
+
 }
-exports.default = WorkflowModel;
-//# sourceMappingURL=Workflow.js.map
+
+exports.default = WorkflowModel;

package/lib/server.d.ts

@@ -1,5 +1,10 @@
 import { Plugin } from '@nocobase/server';
-export default class WorkflowPlugin extends Plugin {
-    load(options?: {}): Promise<void>;
+import WorkflowModel from './models/Workflow';
+import { Trigger } from './triggers';
+import { Registry } from '@nocobase/utils';
+export default class extends Plugin {
+    triggers: Registry<Trigger>;
     getName(): string;
+    load(options?: {}): Promise<void>;
+    toggle(workflow: WorkflowModel, enable?: boolean): Promise<void>;
 }

package/lib/server.js

@@ -1,68 +1,117 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const server_1 = require("@nocobase/server");
-const Workflow_1 = __importDefault(require("./models/Workflow"));
-const Execution_1 = __importDefault(require("./models/Execution"));
-const actions_1 = __importDefault(require("./actions"));
-class WorkflowPlugin extends server_1.Plugin {
-    load(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { db } = this.app;
-            db.registerModels({
-                WorkflowModel: Workflow_1.default,
-                ExecutionModel: Execution_1.default,
-            });
-            yield db.import({
-                directory: path_1.default.resolve(__dirname, 'collections'),
-            });
-            (0, actions_1.default)(this.app);
-            // [Life Cycle]:
-            //   * load all workflows in db
-            //   * add all hooks for enabled workflows
-            //   * add hooks for create/update[enabled]/delete workflow to add/remove specific hooks
-            this.app.on('beforeStart', () => __awaiter(this, void 0, void 0, function* () {
-                const { model } = db.getCollection('workflows');
-                yield model.mount();
-            }));
-            // [Life Cycle]: initialize all necessary seed data
-            this.app.on('db.init', () => __awaiter(this, void 0, void 0, function* () { }));
-            // const [Automation, AutomationJob] = database.getModels(['automations', 'automations_jobs']);
-            // Automation.addHook('afterCreate', async (model: AutomationModel) => {
-            //   model.get('enabled') && await model.loadJobs();
-            // });
-            // Automation.addHook('afterUpdate', async (model: AutomationModel) => {
-            //   if (!model.changed('enabled' as any)) {
-            //     return;
-            //   }
-            //   model.get('enabled') ? await model.loadJobs() : await model.cancelJobs();
-            // });
-            // Automation.addHook('beforeDestroy', async (model: AutomationModel) => {
-            //   await model.cancelJobs();
-            // });
-            // AutomationJob.addHook('afterCreate', async (model: AutomationJobModel) => {
-            //   await model.bootstrap();
-            // });
-            // AutomationJob.addHook('beforeDestroy', async (model: AutomationJobModel) => {
-            //   await model.cancel();
-            // });
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+function _path() {
+  const data = _interopRequireDefault(require("path"));
+
+  _path = function _path() {
+    return data;
+  };
+
+  return data;
+}
+
+function _server() {
+  const data = require("@nocobase/server");
+
+  _server = function _server() {
+    return data;
+  };
+
+  return data;
+}
+
+var _Workflow = _interopRequireDefault(require("./models/Workflow"));
+
+var _Execution = _interopRequireDefault(require("./models/Execution"));
+
+var _actions = _interopRequireDefault(require("./actions"));
+
+var _triggers = _interopRequireDefault(require("./triggers"));
+
+function _utils() {
+  const data = require("@nocobase/utils");
+
+  _utils = function _utils() {
+    return data;
+  };
+
+  return data;
+}
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
+
+class _default extends _server().Plugin {
+  constructor(...args) {
+    super(...args);
+    this.triggers = new (_utils().Registry)();
+  }
+
+  getName() {
+    return this.getPackageName(__dirname);
+  }
+
+  load(options = {}) {
+    var _this = this;
+
+    return _asyncToGenerator(function* () {
+      const db = _this.app.db;
+      db.registerModels({
+        WorkflowModel: _Workflow.default,
+        ExecutionModel: _Execution.default
+      });
+      yield db.import({
+        directory: _path().default.resolve(__dirname, 'collections')
+      });
+      (0, _actions.default)(_this);
+      (0, _triggers.default)(_this); // [Life Cycle]:
+      //   * load all workflows in db
+      //   * add all hooks for enabled workflows
+      //   * add hooks for create/update[enabled]/delete workflow to add/remove specific hooks
+
+      _this.app.on('beforeStart', /*#__PURE__*/_asyncToGenerator(function* () {
+        const collection = db.getCollection('workflows');
+        const workflows = yield collection.repository.find({
+          filter: {
+            enabled: true
+          }
+        });
+        workflows.forEach(workflow => {
+          _this.toggle(workflow);
         });
-    }
-    getName() {
-        return this.getPackageName(__dirname);
-    }
+        db.on('workflows.afterCreate', model => _this.toggle(model));
+        db.on('workflows.afterUpdate', model => _this.toggle(model));
+        db.on('workflows.afterDestroy', model => _this.toggle(model, false));
+      })); // [Life Cycle]: initialize all necessary seed data
+      // this.app.on('db.init', async () => {});
+
+    })();
+  }
+
+  toggle(workflow, enable) {
+    var _this2 = this;
+
+    return _asyncToGenerator(function* () {
+      const type = workflow.get('type');
+
+      const trigger = _this2.triggers.get(type);
+
+      if (typeof enable !== 'undefined' ? enable : workflow.get('enabled')) {
+        yield trigger.on(workflow);
+      } else {
+        yield trigger.off(workflow);
+      }
+    })();
+  }
+
 }
-exports.default = WorkflowPlugin;
-//# sourceMappingURL=server.js.map
+
+exports.default = _default;

package/lib/triggers/collection.d.ts

@@ -0,0 +1,16 @@
+import { Trigger } from ".";
+import WorkflowModel from "../models/Workflow";
+export interface CollectionChangeTriggerConfig {
+    collection: string;
+    mode: number;
+    condition: any;
+}
+export default class CollectionTrigger implements Trigger {
+    db: any;
+    events: Map<any, any>;
+    constructor({ app }: {
+        app: any;
+    });
+    on(workflow: WorkflowModel): void;
+    off(workflow: WorkflowModel): void;
+}

package/lib/triggers/collection.js

@@ -0,0 +1,162 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e2) { throw _e2; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e3) { didErr = true; err = _e3; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+
+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 MODE_BITMAP = {
+  CREATE: 1,
+  UPDATE: 2,
+  DESTROY: 4
+};
+const MODE_BITMAP_EVENTS = new Map();
+MODE_BITMAP_EVENTS.set(MODE_BITMAP.CREATE, 'afterCreateWithAssociations');
+MODE_BITMAP_EVENTS.set(MODE_BITMAP.UPDATE, 'afterUpdateWithAssociations');
+MODE_BITMAP_EVENTS.set(MODE_BITMAP.DESTROY, 'afterDestroy');
+
+function getHookId(workflow, type) {
+  return `${type}#${workflow.id}`;
+} // async function, should return promise
+
+
+function handler(data, options) {
+  const _this$config = this.config,
+        condition = _this$config.condition,
+        changed = _this$config.changed; // NOTE: if no configured fields changed, do not trigger
+
+  if (changed && changed.length && changed.every(name => !data.changed(name))) {
+    return;
+  } // NOTE: if no configured condition match, do not trigger
+
+
+  if (condition && condition.$and.length) {// TODO: check all conditions in condition against data
+    // const calculation = toCalculation(condition);
+  }
+
+  return this.trigger({
+    data: data.get()
+  }, options);
+}
+
+class CollectionTrigger {
+  constructor({
+    app
+  }) {
+    this.db = void 0;
+    this.events = new Map();
+    this.db = app.db;
+  }
+
+  on(workflow) {
+    // NOTE: remove previous listener if config updated
+    const prev = workflow.previous();
+
+    if (prev.config) {
+      this.off(_objectSpread(_objectSpread({}, workflow.get()), prev));
+    }
+
+    const _workflow$config = workflow.config,
+          collection = _workflow$config.collection,
+          mode = _workflow$config.mode;
+    const Collection = this.db.getCollection(collection);
+
+    if (!Collection) {
+      return;
+    }
+
+    var _iterator = _createForOfIteratorHelper(MODE_BITMAP_EVENTS.entries()),
+        _step;
+
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        let _step$value = _slicedToArray(_step.value, 2),
+            key = _step$value[0],
+            type = _step$value[1];
+
+        const event = `${collection}.${type}`;
+        const name = getHookId(workflow, event);
+
+        if (mode & key) {
+          if (!this.events.has(name)) {
+            const listener = handler.bind(workflow);
+            this.events.set(name, listener);
+            this.db.on(event, listener);
+          }
+        } else {
+          const listener = this.events.get(name);
+
+          if (listener) {
+            this.db.off(event, listener);
+            this.events.delete(name);
+          }
+        }
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+  }
+
+  off(workflow) {
+    const _workflow$config2 = workflow.config,
+          collection = _workflow$config2.collection,
+          mode = _workflow$config2.mode;
+    const Collection = this.db.getCollection(collection);
+
+    if (!Collection) {
+      return;
+    }
+
+    var _iterator2 = _createForOfIteratorHelper(MODE_BITMAP_EVENTS.entries()),
+        _step2;
+
+    try {
+      for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+        let _step2$value = _slicedToArray(_step2.value, 2),
+            key = _step2$value[0],
+            type = _step2$value[1];
+
+        const event = `${collection}.${type}`;
+        const name = getHookId(workflow, event);
+
+        if (mode & key) {
+          const listener = this.events.get(name);
+
+          if (listener) {
+            this.db.off(event, listener);
+            this.events.delete(name);
+          }
+        }
+      }
+    } catch (err) {
+      _iterator2.e(err);
+    } finally {
+      _iterator2.f();
+    }
+  }
+
+}
+
+exports.default = CollectionTrigger;

package/lib/triggers/index.d.ts

@@ -1,9 +1,6 @@
-import { Registry } from '@nocobase/utils';
 import WorkflowModel from '../models/Workflow';
 export interface Trigger {
-    name: string;
-    on(this: WorkflowModel, callback: Function): void;
-    off(this: WorkflowModel): void;
+    on(workflow: WorkflowModel): void;
+    off(workflow: WorkflowModel): void;
 }
-export declare const triggers: Registry<Trigger>;
-export default triggers;
+export default function (plugin: any): void;