@nocobase/plugin-workflow 0.7.0-alpha.56 → 0.7.0-alpha.59

package/lib/actions/index.d.ts

@@ -1 +1,3 @@
-export default function (app: any): void;
+export default function ({ app }: {
+    app: any;
+}): void;

package/lib/actions/index.js

@@ -25,7 +25,9 @@ function make(name, mod) {
   }), {});
 }
 
-function _default(app) {
+function _default({
+  app
+}) {
   app.actions(_objectSpread(_objectSpread(_objectSpread({}, make('workflows', workflows)), make('workflows.nodes', {
     create: nodes.create,
     destroy: nodes.destroy

package/lib/collections/workflows.js

@@ -12,57 +12,49 @@ var _default = {
     name: 'key',
     type: 'uid'
   }, {
-    interface: 'string',
     type: 'string',
     name: 'title',
     title: '工作流名称',
     required: true
   }, {
-    interface: 'boolean',
     type: 'boolean',
     name: 'enabled',
     title: '启用',
     defaultValue: false
   }, {
-    interface: 'textarea',
     type: 'text',
     name: 'description',
     title: '描述'
   }, {
-    interface: 'select',
     type: 'string',
     title: '触发方式',
     name: 'type',
     required: true
   }, {
-    interface: 'json',
     type: 'jsonb',
     title: '触发配置',
     name: 'config',
     required: true,
     defaultValue: {}
   }, {
-    interface: 'boolean',
     type: 'boolean',
     title: '使用事务',
     name: 'useTransaction',
     defaultValue: true
   }, {
-    interface: 'linkTo',
     type: 'hasMany',
     name: 'nodes',
     target: 'flow_nodes',
     title: '流程节点'
   }, {
-    interface: 'linkTo',
     type: 'hasMany',
     name: 'executions',
     target: 'executions',
     title: '触发执行'
   }, {
-    type: 'boolean',
+    type: 'integer',
     name: 'executed',
-    defaultValue: false
+    defaultValue: 0
   }, {
     type: 'boolean',
     name: 'current',

package/lib/instructions/query.js

@@ -32,14 +32,13 @@ var _default = {
 
       const options = execution.getParsedValue(params);
       const result = yield (multiple ? repo.find : repo.findOne).call(repo, _objectSpread(_objectSpread({}, options), {}, {
-        // NOTE: `raw` to avoid getting undefined value from Proxied model instance (#380)
-        // e.g. Object.prototype.hasOwnProperty.call(result, 'id') // false
-        // so the properties can not be get by json-templates(object-path)
-        raw: true,
         transaction: execution.tx
-      }));
+      })); // NOTE: `toJSON()` to avoid getting undefined value from Proxied model instance (#380)
+      // e.g. Object.prototype.hasOwnProperty.call(result, 'id') // false
+      // so the properties can not be get by json-templates(object-path)
+
       return {
-        result,
+        result: multiple ? result.map(item => item.toJSON()) : result === null || result === void 0 ? void 0 : result.toJSON(),
         status: _constants.JOB_STATUS.RESOLVED
       };
     })();

package/lib/models/Workflow.d.ts

@@ -11,7 +11,7 @@ export default class WorkflowModel extends Model {
     type: string;
     config: any;
     useTransaction: boolean;
-    executed: boolean;
+    executed: number;
     createdAt: Date;
     updatedAt: Date;
     nodes: FlowNodeModel[];
@@ -21,9 +21,6 @@ export default class WorkflowModel extends Model {
     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

@@ -15,122 +15,84 @@ function _database() {
   return data;
 }
 
-var _triggers = _interopRequireDefault(require("../triggers"));
-
 var _constants = require("../constants");
 
-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 WorkflowModel extends _database().Model {
-  static mount() {
-    var _this = this;
+  constructor(...args) {
+    var _this;
 
-    return _asyncToGenerator(function* () {
-      const collection = _this.database.getCollection('workflows');
+    super(...args);
+    _this = this;
 
-      const workflows = yield collection.repository.find({
-        filter: {
-          enabled: true
+    this.trigger = /*#__PURE__*/function () {
+      var _ref = _asyncToGenerator(function* (context, options = {}) {
+        // `null` means not to trigger
+        if (context === null) {
+          return;
         }
-      });
-      workflows.forEach(workflow => {
-        workflow.toggle();
-      });
-
-      _this.addHook('afterCreate', model => model.toggle());
 
-      _this.addHook('afterUpdate', model => model.toggle());
+        const transaction = yield _this.getTransaction(options);
 
-      _this.addHook('afterDestroy', model => model.toggle(false));
-    })();
-  }
-
-  getHookId() {
-    return `workflow-${this.get('id')}`;
-  }
-
-  getTransaction(options) {
-    if (!this.useTransaction) {
-      return undefined;
-    }
-
-    return options.transaction && !options.transaction.finished ? options.transaction : this.constructor.database.sequelize.transaction();
-  }
-
-  toggle(enable) {
-    var _this2 = this;
-
-    return _asyncToGenerator(function* () {
-      const type = _this2.get('type');
-
-      const _triggers$get = _triggers.default.get(type),
-            on = _triggers$get.on,
-            off = _triggers$get.off;
-
-      if (typeof enable !== 'undefined' ? enable : _this2.get('enabled')) {
-        on.call(_this2, _this2.trigger.bind(_this2));
-      } else {
-        off.call(_this2);
-      }
-    })();
-  }
+        if (_this.useTransaction) {
+          const existed = yield _this.countExecutions({
+            where: {
+              transaction: transaction.id
+            },
+            transaction
+          });
 
-  trigger(context, options) {
-    var _this3 = this;
-
-    return _asyncToGenerator(function* () {
-      // `null` means not to trigger
-      if (context === null) {
-        return;
-      }
-
-      const transaction = yield _this3.getTransaction(options);
+          if (existed) {
+            console.warn(`workflow ${_this.id} has already been triggered in same execution (${transaction.id}), and newly triggering will be skipped.`);
+            return;
+          }
+        }
 
-      if (_this3.useTransaction) {
-        const existed = yield _this3.countExecutions({
-          where: {
-            transaction: transaction.id
-          },
+        const execution = yield _this.createExecution({
+          context,
+          status: _constants.EXECUTION_STATUS.STARTED,
+          useTransaction: _this.useTransaction,
+          transaction: transaction.id
+        }, {
+          transaction
+        });
+        const executed = yield _this.countExecutions({
           transaction
+        }); // NOTE: not to trigger afterUpdate hook here
+
+        yield _this.update({
+          executed
+        }, {
+          transaction,
+          hooks: false
         });
+        execution.workflow = _this;
+        yield execution.start({
+          transaction
+        }); // @ts-ignore
 
-        if (existed) {
-          console.warn(`workflow ${_this3.id} has already been triggered in same execution (${transaction.id}), and newly triggering will be skipped.`);
-          return;
+        if (transaction && (!options.transaction || options.transaction.finished)) {
+          yield transaction.commit();
         }
-      }
-
-      const execution = yield _this3.createExecution({
-        context,
-        status: _constants.EXECUTION_STATUS.STARTED,
-        useTransaction: _this3.useTransaction,
-        transaction: transaction.id
-      }, {
-        transaction
-      });
-      execution.workflow = _this3;
-      yield execution.start({
-        transaction
+
+        return execution;
       });
 
-      if (!_this3.executed) {
-        yield _this3.update({
-          executed: true
-        }, {
-          transaction
-        });
-      }
+      return function (_x) {
+        return _ref.apply(this, arguments);
+      };
+    }();
+  }
 
-      if (transaction && (!options.transaction || options.transaction.finished)) {
-        yield transaction.commit();
-      }
+  getTransaction(options) {
+    if (!this.useTransaction) {
+      return null;
+    }
 
-      return execution;
-    })();
+    return options.transaction && !options.transaction.finished ? options.transaction : this.constructor.database.sequelize.transaction();
   }
 
 }

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

@@ -31,13 +31,34 @@ 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 WorkflowPlugin extends _server().Plugin {
+class _default extends _server().Plugin {
+  constructor(...args) {
+    super(...args);
+    this.triggers = new (_utils().Registry)();
+  }
+
+  getName() {
+    return this.getPackageName(__dirname);
+  }
+
   load(options = {}) {
     var _this = this;
 
@@ -50,46 +71,47 @@ class WorkflowPlugin extends _server().Plugin {
       yield db.import({
         directory: _path().default.resolve(__dirname, 'collections')
       });
-      (0, _actions.default)(_this.app); // [Life Cycle]:
+      (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 _db$getCollection = db.getCollection('workflows'),
-              model = _db$getCollection.model;
-
-        yield model.mount();
+        const collection = db.getCollection('workflows');
+        const workflows = yield collection.repository.find({
+          filter: {
+            enabled: true
+          }
+        });
+        workflows.forEach(workflow => {
+          _this.toggle(workflow);
+        });
+        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', /*#__PURE__*/_asyncToGenerator(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();
-      // });
+      // this.app.on('db.init', async () => {});
 
     })();
   }
 
-  getName() {
-    return this.getPackageName(__dirname);
+  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;
+exports.default = _default;

package/lib/triggers/collection.d.ts

@@ -1,12 +1,16 @@
+import { Trigger } from ".";
 import WorkflowModel from "../models/Workflow";
-export interface ModelChangeTriggerConfig {
+export interface CollectionChangeTriggerConfig {
     collection: string;
     mode: number;
     condition: any;
 }
-declare const _default: {
-    name: string;
-    on(this: WorkflowModel, callback: Function): void;
-    off(this: WorkflowModel): void;
-};
-export default _default;
+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

@@ -19,46 +19,67 @@ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o =
 
 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, 'afterCreate');
-MODE_BITMAP_EVENTS.set(MODE_BITMAP.UPDATE, 'afterUpdate');
-MODE_BITMAP_EVENTS.set(MODE_BITMAP.DESTROY, 'afterDestroy'); // async function, should return promise
+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 bindHandler(callback) {
+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;
-  return (data, options) => {
-    // 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
+        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 callback({
-      data: data.get()
-    }, options);
-  };
+  if (condition && condition.$and.length) {// TODO: check all conditions in condition against data
+    // const calculation = toCalculation(condition);
+  }
+
+  return this.trigger({
+    data: data.get()
+  }, options);
 }
 
-var _default = {
-  name: 'collection',
+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));
+    }
 
-  on(callback) {
-    const database = this.constructor.database;
-    const _this$config2 = this.config,
-          collection = _this$config2.collection,
-          mode = _this$config2.mode;
-    const Collection = database.getCollection(collection);
+    const _workflow$config = workflow.config,
+          collection = _workflow$config.collection,
+          mode = _workflow$config.mode;
+    const Collection = this.db.getCollection(collection);
 
     if (!Collection) {
       return;
@@ -71,16 +92,24 @@ var _default = {
       for (_iterator.s(); !(_step = _iterator.n()).done;) {
         let _step$value = _slicedToArray(_step.value, 2),
             key = _step$value[0],
-            event = _step$value[1];
+            type = _step$value[1];
 
-        if (mode & key) {
-          var _Collection$model$opt;
+        const event = `${collection}.${type}`;
+        const name = getHookId(workflow, event);
 
-          if (!((_Collection$model$opt = Collection.model.options.hooks[event]) === null || _Collection$model$opt === void 0 ? void 0 : _Collection$model$opt.find(item => item.name && item.name === this.getHookId()))) {
-            Collection.model.addHook(event, this.getHookId(), bindHandler.call(this, callback));
+        if (mode & key) {
+          if (!this.events.has(name)) {
+            const listener = handler.bind(workflow);
+            this.events.set(name, listener);
+            this.db.on(event, listener);
           }
         } else {
-          Collection.model.removeHook(event, this.getHookId());
+          const listener = this.events.get(name);
+
+          if (listener) {
+            this.db.off(event, listener);
+            this.events.delete(name);
+          }
         }
       }
     } catch (err) {
@@ -88,14 +117,13 @@ var _default = {
     } finally {
       _iterator.f();
     }
-  },
+  }
 
-  off() {
-    const database = this.constructor.database;
-    const _this$config3 = this.config,
-          collection = _this$config3.collection,
-          mode = _this$config3.mode;
-    const Collection = database.getCollection(collection);
+  off(workflow) {
+    const _workflow$config2 = workflow.config,
+          collection = _workflow$config2.collection,
+          mode = _workflow$config2.mode;
+    const Collection = this.db.getCollection(collection);
 
     if (!Collection) {
       return;
@@ -108,10 +136,18 @@ var _default = {
       for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
         let _step2$value = _slicedToArray(_step2.value, 2),
             key = _step2$value[0],
-            event = _step2$value[1];
+            type = _step2$value[1];
+
+        const event = `${collection}.${type}`;
+        const name = getHookId(workflow, event);
 
         if (mode & key) {
-          Collection.model.removeHook(event, this.getHookId());
+          const listener = this.events.get(name);
+
+          if (listener) {
+            this.db.off(event, listener);
+            this.events.delete(name);
+          }
         }
       }
     } catch (err) {
@@ -121,5 +157,6 @@ var _default = {
     }
   }
 
-};
-exports.default = _default;
+}
+
+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;

package/lib/triggers/index.js

@@ -3,24 +3,13 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.triggers = exports.default = void 0;
-
-function _utils() {
-  const data = require("@nocobase/utils");
-
-  _utils = function _utils() {
-    return data;
-  };
-
-  return data;
-}
+exports.default = _default;
 
 var _collection = _interopRequireDefault(require("./collection"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-const triggers = new (_utils().Registry)();
-exports.triggers = triggers;
-var _default = triggers;
-exports.default = _default;
-triggers.register(_collection.default.name, _collection.default);
+function _default(plugin) {
+  const triggers = plugin.triggers;
+  triggers.register('collection', new _collection.default(plugin)); // triggers.register('schedule', new Schedule(plugin));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/plugin-workflow",
-  "version": "0.7.0-alpha.56",
+  "version": "0.7.0-alpha.59",
   "main": "lib/index.js",
   "license": "Apache-2.0",
   "licenses": [
@@ -10,14 +10,14 @@
     }
   ],
   "dependencies": {
-    "@nocobase/actions": "0.7.0-alpha.56",
-    "@nocobase/database": "0.7.0-alpha.56",
-    "@nocobase/server": "0.7.0-alpha.56",
-    "@nocobase/utils": "0.7.0-alpha.56",
+    "@nocobase/actions": "0.7.0-alpha.59",
+    "@nocobase/database": "0.7.0-alpha.59",
+    "@nocobase/server": "0.7.0-alpha.59",
+    "@nocobase/utils": "0.7.0-alpha.59",
     "json-templates": "^4.2.0"
   },
   "devDependencies": {
-    "@nocobase/test": "0.7.0-alpha.56"
+    "@nocobase/test": "0.7.0-alpha.59"
   },
-  "gitHead": "9a8c05e8fb26029f1d1ba68408a8bddac0e67a76"
+  "gitHead": "c90e5aee4c8257a3ab7ff492e69cb568cccff8b5"
 }