@nocobase/plugin-workflow 0.19.0-alpha.2 → 0.19.0-alpha.4

package/dist/server/Processor.js

@@ -29,6 +29,7 @@ class Processor {
     this.execution = execution;
     this.options = options;
     this.logger = options.plugin.getLogger(execution.workflowId);
+    this.transaction = options.transaction;
   }
   static StatusMap = {
     [import_constants.JOB_STATUS.PENDING]: import_constants.EXECUTION_STATUS.STARTED,
@@ -41,10 +42,12 @@ class Processor {
     [import_constants.JOB_STATUS.RETRY_NEEDED]: import_constants.EXECUTION_STATUS.RETRY_NEEDED
   };
   logger;
+  transaction;
   nodes = [];
   nodesMap = /* @__PURE__ */ new Map();
   jobsMap = /* @__PURE__ */ new Map();
   jobsMapByNodeKey = {};
+  lastSavedJob = null;
   // make dual linked nodes list then cache
   makeNodes(nodes = []) {
     this.nodes = nodes;
@@ -68,14 +71,15 @@ class Processor {
     });
   }
   async prepare() {
-    const { execution } = this;
+    const { execution, transaction } = this;
     if (!execution.workflow) {
-      execution.workflow = await execution.getWorkflow();
+      execution.workflow = await execution.getWorkflow({ transaction });
     }
-    const nodes = await execution.workflow.getNodes();
+    const nodes = await execution.workflow.getNodes({ transaction });
     this.makeNodes(nodes);
     const jobs = await execution.getJobs({
-      order: [["id", "ASC"]]
+      order: [["id", "ASC"]],
+      transaction
     });
     this.makeJobs(jobs);
   }
@@ -116,7 +120,10 @@ class Processor {
         { error: err }
       );
       job = {
-        result: err instanceof Error ? { message: err.message, stack: process.env.NODE_ENV === "production" ? [] : err.stack } : err,
+        result: err instanceof Error ? {
+          message: err.message,
+          stack: process.env.NODE_ENV === "production" ? 'Error stack will not be shown under "production" environment, please check logs.' : err.stack
+        } : err,
         status: import_constants.JOB_STATUS.ERROR
       };
       if (prevJob && prevJob.nodeId === node.id) {
@@ -127,6 +134,7 @@ class Processor {
     if (!(job instanceof import_database.Model)) {
       job.upstreamId = prevJob instanceof import_database.Model ? prevJob.get("id") : null;
       job.nodeId = node.id;
+      job.nodeKey = node.key;
     }
     const savedJob = await this.saveJob(job);
     this.logger.info(
@@ -171,7 +179,7 @@ class Processor {
   async exit(s) {
     if (typeof s === "number") {
       const status = this.constructor.StatusMap[s] ?? Math.sign(s);
-      await this.execution.update({ status });
+      await this.execution.update({ status }, { transaction: this.transaction });
     }
     this.logger.info(`execution (${this.execution.id}) exiting with status ${this.execution.status}`);
     return null;
@@ -179,22 +187,26 @@ class Processor {
   // TODO(optimize)
   async saveJob(payload) {
     const { database } = this.execution.constructor;
+    const { transaction } = this;
     const { model } = database.getCollection("jobs");
     let job;
     if (payload instanceof model) {
-      job = await payload.save();
+      job = await payload.save({ transaction });
     } else if (payload.id) {
-      job = await model.findByPk(payload.id);
-      await job.update(payload);
+      job = await model.findByPk(payload.id, { transaction });
+      await job.update(payload, { transaction });
     } else {
-      job = await model.create({
-        ...payload,
-        executionId: this.execution.id
-      });
+      job = await model.create(
+        {
+          ...payload,
+          executionId: this.execution.id
+        },
+        { transaction }
+      );
     }
     this.jobsMap.set(job.id, job);
-    const node = this.nodesMap.get(job.nodeId);
-    this.jobsMapByNodeKey[node.key] = job.result;
+    this.lastSavedJob = job;
+    this.jobsMapByNodeKey[job.nodeKey] = job.result;
     return job;
   }
   getBranches(node) {

package/dist/server/actions/executions.d.ts

@@ -1,2 +1,3 @@
 import { Context } from '@nocobase/actions';
 export declare function destroy(context: Context, next: any): Promise<void>;
+export declare function cancel(context: Context, next: any): Promise<never>;

package/dist/server/actions/executions.js

@@ -27,6 +27,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var executions_exports = {};
 __export(executions_exports, {
+  cancel: () => cancel,
   destroy: () => destroy
 });
 module.exports = __toCommonJS(executions_exports);
@@ -43,7 +44,44 @@ async function destroy(context, next) {
   });
   await import_actions.default.destroy(context, next);
 }
+async function cancel(context, next) {
+  const { filterByTk } = context.action.params;
+  const ExecutionRepo = context.db.getRepository("executions");
+  const JobRepo = context.db.getRepository("jobs");
+  const execution = await ExecutionRepo.findOne({
+    filterByTk,
+    appends: ["jobs"]
+  });
+  if (!execution) {
+    return context.throw(404);
+  }
+  if (execution.status) {
+    return context.throw(400);
+  }
+  await context.db.sequelize.transaction(async (transaction) => {
+    await execution.update(
+      {
+        status: import_constants.EXECUTION_STATUS.CANCELED
+      },
+      { transaction }
+    );
+    const pendingJobs = execution.jobs.filter((job) => job.status === import_constants.JOB_STATUS.PENDING);
+    await JobRepo.update({
+      values: {
+        status: import_constants.JOB_STATUS.CANCELED
+      },
+      filter: {
+        id: pendingJobs.map((job) => job.id)
+      },
+      individualHooks: false,
+      transaction
+    });
+  });
+  context.body = execution;
+  await next();
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  cancel,
   destroy
 });

package/dist/server/collections/jobs.js

@@ -36,6 +36,10 @@ var jobs_default = {
       name: "node",
       target: "flow_nodes"
     },
+    {
+      type: "string",
+      name: "nodeKey"
+    },
     {
       type: "belongsTo",
       name: "upstream",

package/dist/server/collections/workflows.js

@@ -85,6 +85,11 @@ function workflows_default() {
         name: "current",
         defaultValue: false
       },
+      {
+        type: "boolean",
+        name: "sync",
+        defaultValue: false
+      },
       {
         type: "hasMany",
         name: "revisions",

package/dist/server/instructions/ConditionInstruction.d.ts

@@ -14,6 +14,7 @@ export declare class ConditionInstruction extends Instruction {
         status: 1;
         result: boolean;
         nodeId: number;
+        nodeKey: any;
         upstreamId: any;
     } | {
         result: any;

package/dist/server/instructions/ConditionInstruction.js

@@ -128,6 +128,7 @@ class ConditionInstruction extends import__.Instruction {
       result,
       // TODO(optimize): try unify the building of job
       nodeId: node.id,
+      nodeKey: node.key,
       upstreamId: prevJob && prevJob.id || null
     };
     const branchNode = processor.nodes.find(

package/dist/server/instructions/CreateInstruction.js

@@ -33,8 +33,8 @@ class CreateInstruction extends import__.Instruction {
       ...options,
       context: {
         executionId: processor.execution.id
-      }
-      // transaction: processor.transaction,
+      },
+      transaction: processor.transaction
     });
     let result = created;
     if (created && appends.length) {
@@ -45,8 +45,8 @@ class CreateInstruction extends import__.Instruction {
       }, /* @__PURE__ */ new Set());
       result = await repository.findOne({
         filterByTk: created[model.primaryKeyAttribute],
-        appends: Array.from(includeFields)
-        // transaction: processor.transaction,
+        appends: Array.from(includeFields),
+        transaction: processor.transaction
       });
     }
     return {

package/dist/server/instructions/DestroyInstruction.js

@@ -32,8 +32,8 @@ class DestroyInstruction extends import__.Instruction {
       ...options,
       context: {
         executionId: processor.execution.id
-      }
-      // transaction: processor.transaction,
+      },
+      transaction: processor.transaction
     });
     return {
       result,

package/dist/server/instructions/EndInstruction.d.ts

@@ -0,0 +1,8 @@
+import Instruction from '.';
+import Processor from '../Processor';
+import { FlowNodeModel } from '../types';
+export default class extends Instruction {
+    run(node: FlowNodeModel, prevJob: any, processor: Processor): Promise<{
+        status: number;
+    }>;
+}

package/dist/server/instructions/EndInstruction.js

@@ -0,0 +1,42 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var EndInstruction_exports = {};
+__export(EndInstruction_exports, {
+  default: () => EndInstruction_default
+});
+module.exports = __toCommonJS(EndInstruction_exports);
+var import__ = __toESM(require("."));
+var import_constants = require("../constants");
+class EndInstruction_default extends import__.default {
+  async run(node, prevJob, processor) {
+    const { endStatus } = node.config;
+    return {
+      status: endStatus ?? import_constants.JOB_STATUS.RESOLVED
+    };
+  }
+}

package/dist/server/instructions/QueryInstruction.js

@@ -49,8 +49,8 @@ class QueryInstruction extends import__.Instruction {
         var _a;
         return `${((_a = item.direction) == null ? void 0 : _a.toLowerCase()) === "desc" ? "-" : ""}${item.field}`;
       }),
-      appends
-      // transaction: processor.transaction,
+      appends,
+      transaction: processor.transaction
     });
     if (failOnEmpty && (multiple ? !result.length : !result)) {
       return {

package/dist/server/instructions/UpdateInstruction.js

@@ -32,8 +32,8 @@ class UpdateInstruction extends import__.Instruction {
       ...options,
       context: {
         executionId: processor.execution.id
-      }
-      // transaction: processor.transaction,
+      },
+      transaction: processor.transaction
     });
     return {
       result: result.length ?? result,

package/dist/server/migrations/20240115220721-add-node-key-to-job.d.ts

@@ -0,0 +1,6 @@
+import { Migration } from '@nocobase/server';
+export default class extends Migration {
+    appVersion: string;
+    on: string;
+    up(): Promise<void>;
+}

package/dist/server/migrations/20240115220721-add-node-key-to-job.js

@@ -0,0 +1,55 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var add_node_key_to_job_exports = {};
+__export(add_node_key_to_job_exports, {
+  default: () => add_node_key_to_job_default
+});
+module.exports = __toCommonJS(add_node_key_to_job_exports);
+var import_server = require("@nocobase/server");
+class add_node_key_to_job_default extends import_server.Migration {
+  appVersion = "<0.19.0-alpha.4";
+  on = "afterSync";
+  async up() {
+    const { db } = this.context;
+    const PluginModel = db.getModel("applicationPlugins");
+    const JobRepo = db.getRepository("jobs");
+    await db.sequelize.transaction(async (transaction) => {
+      const jobs = await JobRepo.find({
+        appends: ["node.key"]
+      });
+      await jobs.reduce(
+        (promise, job) => promise.then(() => {
+          var _a;
+          if (job.nodeKey) {
+            return;
+          }
+          return job.update(
+            {
+              nodeKey: (_a = job.node) == null ? void 0 : _a.key
+            },
+            {
+              silent: true,
+              transaction
+            }
+          );
+        }),
+        Promise.resolve()
+      );
+    });
+  }
+}

package/dist/server/triggers/CollectionTrigger.js

@@ -86,13 +86,24 @@ async function handler(workflow, data, options) {
     });
   }
   const json = (0, import_utils.toJSON)(result);
-  this.workflow.trigger(
-    workflow,
-    { data: json },
-    {
-      context
-    }
-  );
+  if (workflow.sync) {
+    await this.workflow.trigger(
+      workflow,
+      { data: json },
+      {
+        context,
+        transaction
+      }
+    );
+  } else {
+    this.workflow.trigger(
+      workflow,
+      { data: json },
+      {
+        context
+      }
+    );
+  }
 }
 class CollectionTrigger extends import__.default {
   events = /* @__PURE__ */ new Map();

package/dist/server/triggers/ScheduleTrigger.d.ts

@@ -18,6 +18,7 @@ export declare const SCHEDULE_MODE: {
 };
 declare function matchNext(this: ScheduleTrigger, workflow: any, now: Date, range?: number): boolean;
 export default class ScheduleTrigger extends Trigger {
+    sync: boolean;
     static CacheRules: (typeof matchNext | ((workflow: any, now: any) => any))[];
     static TriggerRules: ((workflow: any, now: any) => any)[];
     events: Map<any, any>;

package/dist/server/triggers/ScheduleTrigger.js

@@ -333,6 +333,7 @@ function matchNext(workflow, now, range = this.cacheCycle) {
   return false;
 }
 class ScheduleTrigger extends import__.default {
+  sync = false;
   static CacheRules = [
     ({ config, allExecuted }) => (config.limit ? allExecuted < config.limit : true) && config.startsOn,
     matchNext,

package/dist/server/triggers/index.d.ts

@@ -7,5 +7,6 @@ export declare abstract class Trigger {
     abstract on(workflow: WorkflowModel): void;
     abstract off(workflow: WorkflowModel): void;
     duplicateConfig?(workflow: WorkflowModel, options: Transactionable): object | Promise<object>;
+    sync?: boolean;
 }
 export default Trigger;

package/dist/server/triggers/index.js

@@ -25,6 +25,7 @@ class Trigger {
   constructor(workflow) {
     this.workflow = workflow;
   }
+  sync;
 }
 var triggers_default = Trigger;
 // Annotate the CommonJS export names for ESM import in node:

package/dist/server/types/Workflow.d.ts

@@ -11,13 +11,16 @@ export default class WorkflowModel extends Model {
     description?: string;
     type: string;
     config: any;
+    options: any;
     executed: number;
+    allExecuted: number;
+    sync: boolean;
     createdAt: Date;
     updatedAt: Date;
-    nodes: FlowNodeModel[];
+    nodes?: FlowNodeModel[];
     getNodes: HasManyGetAssociationsMixin<FlowNodeModel>;
     createNode: HasManyCreateAssociationMixin<FlowNodeModel>;
-    executions: ExecutionModel[];
+    executions?: ExecutionModel[];
     countExecutions: HasManyCountAssociationsMixin;
     getExecutions: HasManyGetAssociationsMixin<ExecutionModel>;
     createExecution: HasManyCreateAssociationMixin<ExecutionModel>;

package/package.json

@@ -4,11 +4,11 @@
   "displayName.zh-CN": "工作流",
   "description": "A powerful workflow plugin designed to support business process management and automation.",
   "description.zh-CN": "工作流插件，为业务流程管理和自动化提供支持。",
-  "version": "0.19.0-alpha.2",
+  "version": "0.19.0-alpha.4",
   "license": "AGPL-3.0",
   "main": "./dist/server/index.js",
   "dependencies": {
-    "@nocobase/plugin-workflow-test": "0.19.0-alpha.2"
+    "@nocobase/plugin-workflow-test": "0.19.0-alpha.4"
   },
   "devDependencies": {
     "@ant-design/icons": "5.x",
@@ -43,5 +43,5 @@
     "@nocobase/test": "0.x",
     "@nocobase/utils": "0.x"
   },
-  "gitHead": "cff5b77ecf12ccdb450d50d505b3aa44a68478c8"
+  "gitHead": "9583023f7bea828da5192384a5c002782c341b65"
 }