@nocobase/plugin-workflow 2.1.0-beta.9 → 2.2.0-alpha.1

package/dist/server/triggers/ScheduleTrigger/index.js

@@ -39,17 +39,32 @@ __export(ScheduleTrigger_exports, {
   default: () => ScheduleTrigger
 });
 module.exports = __toCommonJS(ScheduleTrigger_exports);
+var import_joi = __toESM(require("joi"));
 var import__ = __toESM(require(".."));
+var import_utils = require("../../utils");
 var import_DateFieldScheduleTrigger = __toESM(require("./DateFieldScheduleTrigger"));
 var import_StaticScheduleTrigger = __toESM(require("./StaticScheduleTrigger"));
-var import_utils = require("./utils");
+var import_utils2 = require("./utils");
 class ScheduleTrigger extends import__.default {
+  configSchema = import_joi.default.object({
+    mode: import_joi.default.number().valid(import_utils2.SCHEDULE_MODE.STATIC, import_utils2.SCHEDULE_MODE.DATE_FIELD)
+  });
+  validateConfig(config) {
+    const errors = super.validateConfig(config);
+    if (errors) {
+      return errors;
+    }
+    if (config.mode === import_utils2.SCHEDULE_MODE.DATE_FIELD && config.collection) {
+      return (0, import_utils.validateCollectionField)(config.collection, this.workflow.app.dataSourceManager);
+    }
+    return null;
+  }
   sync = false;
   modes = /* @__PURE__ */ new Map();
   constructor(workflow) {
     super(workflow);
-    this.modes.set(import_utils.SCHEDULE_MODE.STATIC, new import_StaticScheduleTrigger.default(workflow));
-    this.modes.set(import_utils.SCHEDULE_MODE.DATE_FIELD, new import_DateFieldScheduleTrigger.default(workflow));
+    this.modes.set(import_utils2.SCHEDULE_MODE.STATIC, new import_StaticScheduleTrigger.default(workflow));
+    this.modes.set(import_utils2.SCHEDULE_MODE.DATE_FIELD, new import_DateFieldScheduleTrigger.default(workflow));
   }
   getTrigger(mode) {
     return this.modes.get(mode);

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

@@ -6,12 +6,14 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
+import Joi from 'joi';
 import { Transactionable } from '@nocobase/database';
 import type Plugin from '../Plugin';
 import type { WorkflowModel } from '../types';
 import Processor from '../Processor';
 export declare abstract class Trigger {
     readonly workflow: Plugin;
+    configSchema?: Joi.ObjectSchema;
     constructor(workflow: Plugin);
     on(workflow: WorkflowModel): void;
     off(workflow: WorkflowModel): void;
@@ -19,6 +21,7 @@ export declare abstract class Trigger {
     duplicateConfig?(workflow: WorkflowModel, options: Transactionable & {
         origin?: WorkflowModel;
     }): object | Promise<object>;
+    validateConfig(config: Record<string, any>): Record<string, string> | null;
     validateContext?(values: any, workflow: WorkflowModel): null | void | {
         [key: string]: string;
     };

package/dist/server/triggers/index.js

@@ -34,6 +34,7 @@ class Trigger {
   constructor(workflow) {
     this.workflow = workflow;
   }
+  configSchema;
   on(workflow) {
   }
   off(workflow) {
@@ -41,6 +42,23 @@ class Trigger {
   validateEvent(workflow, context, options) {
     return true;
   }
+  validateConfig(config) {
+    if (!this.configSchema) {
+      return null;
+    }
+    const { error } = this.configSchema.validate(config, { abortEarly: false, allowUnknown: true });
+    if (!error) {
+      return null;
+    }
+    const errors = {};
+    for (const detail of error.details) {
+      const key = detail.path.join(".");
+      if (!errors[key]) {
+        errors[key] = detail.message;
+      }
+    }
+    return errors;
+  }
   sync;
 }
 var triggers_default = Trigger;

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

@@ -15,7 +15,13 @@ export default class ExecutionModel extends Model {
     title: string;
     context: any;
     status: number;
+    reason?: string | null;
     dispatched: boolean;
+    parentExecutionId?: number | null;
+    stack?: Array<number | string>;
+    startedAt?: Date | null;
+    expiresAt?: Date | null;
+    output?: any;
     createdAt: Date;
     updatedAt: Date;
     key: string;

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

@@ -11,12 +11,12 @@ import FlowNodeModel from './FlowNode';
 export default class JobModel extends Model {
     id: number;
     status: number;
-    result: any;
-    meta: any;
+    result?: any;
+    meta?: any;
     createdAt: Date;
     updatedAt: Date;
     upstreamId: number;
-    upstream: JobModel;
+    upstream?: JobModel;
     nodeId: number;
     node?: FlowNodeModel;
     getNode: BelongsToGetAssociationMixin<FlowNodeModel>;

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

@@ -19,7 +19,12 @@ export default class WorkflowModel extends Model {
     description?: string;
     type: string;
     config: any;
-    options: any;
+    options: {
+        timeout?: number;
+        stackLimit?: number;
+        deleteExecutionOnStatus?: number[];
+        [key: string]: any;
+    };
     sync: boolean;
     createdAt: Date;
     updatedAt: Date;

package/dist/server/utils.d.ts

@@ -6,4 +6,31 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
+import { Transactionable } from '@nocobase/database';
+import type { DataSourceManager } from '@nocobase/data-source-manager';
+import type PluginWorkflowServer from './Plugin';
+import { EXECUTION_REASON } from './constants';
+import type { ExecutionModel, WorkflowModel } from './types';
+import Processor from './Processor';
+type AbortOptions = Transactionable & {
+    reason?: (typeof EXECUTION_REASON)[keyof typeof EXECUTION_REASON];
+};
+export declare function getExecutionLockKey(executionId: number | string): string;
+export declare function isLockAcquireError(error: unknown): boolean;
+export declare function validateCollectionField(collection: string, dataSourceManager: DataSourceManager): Record<string, string> | null;
+export declare function getExecutionStatusName(status: number | null | undefined): string;
+export declare function getWorkflowExecutionLogMeta(workflow: WorkflowModel, processor?: Processor): {
+    workflowId: number;
+    workflowKey: string;
+    workflowTitle: string;
+    executionId: number;
+    executionStatus: number;
+    executionStatusName: string;
+    lastNodeId: number;
+    lastNodeType: string;
+    lastJobId: number;
+    lastJobStatus: number;
+};
+export declare function abortExecution(plugin: PluginWorkflowServer, execution: ExecutionModel, options?: AbortOptions): Promise<boolean>;
 export declare function toJSON(data: any): any;
+export {};

package/dist/server/utils.js

@@ -26,10 +26,144 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var utils_exports = {};
 __export(utils_exports, {
-  toJSON: () => toJSON
+  abortExecution: () => abortExecution,
+  getExecutionLockKey: () => getExecutionLockKey,
+  getExecutionStatusName: () => getExecutionStatusName,
+  getWorkflowExecutionLogMeta: () => getWorkflowExecutionLogMeta,
+  isLockAcquireError: () => isLockAcquireError,
+  toJSON: () => toJSON,
+  validateCollectionField: () => validateCollectionField
 });
 module.exports = __toCommonJS(utils_exports);
 var import_database = require("@nocobase/database");
+var import_data_source_manager = require("@nocobase/data-source-manager");
+var import_constants = require("./constants");
+function getExecutionLockKey(executionId) {
+  return `workflow:execution:${executionId}`;
+}
+function isLockAcquireError(error) {
+  return error instanceof Error && error.constructor.name === "LockAcquireError";
+}
+function afterTransactionCommit(transaction, callback) {
+  if (typeof transaction.afterCommit === "function") {
+    transaction.afterCommit(callback);
+    return;
+  }
+  callback();
+}
+function validateCollectionField(collection, dataSourceManager) {
+  const [dataSourceName, collectionName] = (0, import_data_source_manager.parseCollectionName)(collection);
+  if (!dataSourceName || !collectionName) {
+    return { collection: `"collection" must be in the format "dataSourceName:collectionName"` };
+  }
+  const dataSource = dataSourceManager.dataSources.get(dataSourceName);
+  if (!dataSource) {
+    return { collection: `Data source "${dataSourceName}" does not exist` };
+  }
+  if (!dataSource.collectionManager.getCollection(collectionName)) {
+    return { collection: `Collection "${collectionName}" does not exist in data source "${dataSourceName}"` };
+  }
+  return null;
+}
+const EXECUTION_STATUS_NAMES = new Map(Object.entries(import_constants.EXECUTION_STATUS).map(([name, value]) => [value, name]));
+function getExecutionStatusName(status) {
+  if (typeof status === "undefined") {
+    return "UNKNOWN";
+  }
+  return EXECUTION_STATUS_NAMES.get(status) ?? `${status}`;
+}
+function getWorkflowExecutionLogMeta(workflow, processor) {
+  var _a, _b, _c, _d;
+  const lastSavedJob = processor == null ? void 0 : processor.lastSavedJob;
+  const lastNode = (_a = processor == null ? void 0 : processor.nodesMap) == null ? void 0 : _a.get(lastSavedJob == null ? void 0 : lastSavedJob.nodeId);
+  return {
+    workflowId: workflow.id,
+    workflowKey: workflow.key,
+    workflowTitle: workflow.title,
+    executionId: ((_b = processor == null ? void 0 : processor.execution) == null ? void 0 : _b.id) ?? null,
+    executionStatus: ((_c = processor == null ? void 0 : processor.execution) == null ? void 0 : _c.status) ?? null,
+    executionStatusName: getExecutionStatusName((_d = processor == null ? void 0 : processor.execution) == null ? void 0 : _d.status),
+    lastNodeId: (lastNode == null ? void 0 : lastNode.id) ?? (lastSavedJob == null ? void 0 : lastSavedJob.nodeId) ?? null,
+    lastNodeType: (lastNode == null ? void 0 : lastNode.type) ?? null,
+    lastJobId: (lastSavedJob == null ? void 0 : lastSavedJob.id) ?? null,
+    lastJobStatus: (lastSavedJob == null ? void 0 : lastSavedJob.status) ?? null
+  };
+}
+async function abortExecution(plugin, execution, options = {}) {
+  const logger = plugin.getLogger(execution.workflowId);
+  const transaction = options.transaction ?? void 0;
+  const ExecutionRepo = plugin.db.getRepository("executions");
+  const JobRepo = plugin.db.getRepository("jobs");
+  try {
+    const abortValues = {
+      status: import_constants.EXECUTION_STATUS.ABORTED,
+      ...options.reason ? {
+        reason: options.reason
+      } : {}
+    };
+    if (transaction) {
+      const lockedExecution = await ExecutionRepo.findOne({
+        filterByTk: execution.id,
+        transaction,
+        lock: transaction.LOCK.UPDATE
+      });
+      if (!lockedExecution || lockedExecution.status !== import_constants.EXECUTION_STATUS.STARTED) {
+        return false;
+      }
+      await lockedExecution.update(abortValues, { transaction });
+    } else {
+      const [affected] = await ExecutionRepo.model.update(abortValues, {
+        where: {
+          id: execution.id,
+          status: import_constants.EXECUTION_STATUS.STARTED
+        },
+        individualHooks: true
+      });
+      if (!affected) {
+        return false;
+      }
+    }
+    const updated = await JobRepo.update({
+      values: {
+        status: import_constants.JOB_STATUS.ABORTED
+      },
+      filter: {
+        executionId: execution.id,
+        status: import_constants.JOB_STATUS.PENDING
+      },
+      individualHooks: false,
+      transaction
+    });
+    const childExecutions = await plugin.db.getRepository("executions").find({
+      filter: {
+        parentExecutionId: execution.id,
+        status: import_constants.EXECUTION_STATUS.STARTED
+      },
+      transaction
+    });
+    for (const child of childExecutions) {
+      await abortExecution(plugin, child, { transaction, reason: import_constants.EXECUTION_REASON.PARENT_ABORTED });
+    }
+    const updateLocalState = () => {
+      execution.set("status", import_constants.EXECUTION_STATUS.ABORTED);
+      execution.set("reason", options.reason ?? null);
+      plugin.timeoutManager.clear(execution.id);
+      plugin.abortRunningExecution(execution.id, options.reason);
+    };
+    if (transaction) {
+      afterTransactionCommit(transaction, updateLocalState);
+    } else {
+      updateLocalState();
+    }
+    logger.info(`execution (${execution.id}) aborted`, {
+      workflowId: execution.workflowId,
+      pendingJobs: Array.isArray(updated) ? updated.length : updated
+    });
+    return true;
+  } catch (error) {
+    throw error;
+  }
+}
 function toJSON(data) {
   if (Array.isArray(data)) {
     return data.map(toJSON);
@@ -47,5 +181,11 @@ function toJSON(data) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  toJSON
+  abortExecution,
+  getExecutionLockKey,
+  getExecutionStatusName,
+  getWorkflowExecutionLogMeta,
+  isLockAcquireError,
+  toJSON,
+  validateCollectionField
 });

package/dist/swagger/index.d.ts

@@ -329,24 +329,19 @@ declare const _default: {
                         'application/json': {
                             schema: {
                                 type: string;
+                                description: string;
                                 properties: {
-                                    values: {
+                                    title: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                    enabled: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                    current: {
                                         type: string;
                                         description: string;
-                                        properties: {
-                                            title: {
-                                                type: string;
-                                                description: string;
-                                            };
-                                            enabled: {
-                                                type: string;
-                                                description: string;
-                                            };
-                                            current: {
-                                                type: string;
-                                                description: string;
-                                            };
-                                        };
                                     };
                                 };
                             };
@@ -417,13 +412,8 @@ declare const _default: {
                         'application/json': {
                             schema: {
                                 type: string;
-                                required: string[];
-                                properties: {
-                                    values: {
-                                        type: string;
-                                        description: string;
-                                    };
-                                };
+                                description: string;
+                                additionalProperties: boolean;
                             };
                         };
                     };
@@ -704,21 +694,16 @@ declare const _default: {
                         'application/json': {
                             schema: {
                                 type: string;
+                                description: string;
                                 properties: {
-                                    values: {
-                                        type: string;
-                                        description: string;
-                                        properties: {
-                                            upstreamId: {
-                                                $ref: string;
-                                            };
-                                            branchIndex: {
-                                                $ref: string;
-                                            };
-                                            config: {
-                                                $ref: string;
-                                            };
-                                        };
+                                    upstreamId: {
+                                        $ref: string;
+                                    };
+                                    branchIndex: {
+                                        $ref: string;
+                                    };
+                                    config: {
+                                        $ref: string;
                                     };
                                 };
                             };
@@ -764,22 +749,17 @@ declare const _default: {
                         'application/json': {
                             schema: {
                                 type: string;
+                                description: string;
                                 properties: {
-                                    values: {
+                                    upstreamId: {
                                         type: string;
+                                        nullable: boolean;
+                                        description: string;
+                                    };
+                                    branchIndex: {
+                                        type: string;
+                                        nullable: boolean;
                                         description: string;
-                                        properties: {
-                                            upstreamId: {
-                                                type: string;
-                                                nullable: boolean;
-                                                description: string;
-                                            };
-                                            branchIndex: {
-                                                type: string;
-                                                nullable: boolean;
-                                                description: string;
-                                            };
-                                        };
                                     };
                                 };
                             };
@@ -820,17 +800,11 @@ declare const _default: {
                                 type: string;
                                 required: string[];
                                 properties: {
-                                    values: {
-                                        type: string;
-                                        required: string[];
-                                        properties: {
-                                            type: {
-                                                $ref: string;
-                                            };
-                                            config: {
-                                                $ref: string;
-                                            };
-                                        };
+                                    type: {
+                                        $ref: string;
+                                    };
+                                    config: {
+                                        $ref: string;
                                     };
                                 };
                             };
@@ -1116,24 +1090,19 @@ declare const _default: {
                         'application/json': {
                             schema: {
                                 type: string;
+                                description: string;
                                 properties: {
-                                    values: {
+                                    status: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                    result: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                    meta: {
                                         type: string;
                                         description: string;
-                                        properties: {
-                                            status: {
-                                                type: string;
-                                                description: string;
-                                            };
-                                            result: {
-                                                type: string;
-                                                description: string;
-                                            };
-                                            meta: {
-                                                type: string;
-                                                description: string;
-                                            };
-                                        };
                                     };
                                 };
                             };
@@ -1270,6 +1239,11 @@ declare const _default: {
                                     description: string;
                                     default: number;
                                 };
+                                timeout: {
+                                    type: string;
+                                    description: string;
+                                    default: number;
+                                };
                             };
                         };
                         categories: {
@@ -1417,6 +1391,23 @@ declare const _default: {
                         type: string;
                         description: string;
                     };
+                    parentExecutionId: {
+                        type: string;
+                        nullable: boolean;
+                        description: string;
+                    };
+                    startedAt: {
+                        type: string;
+                        format: string;
+                        nullable: boolean;
+                        description: string;
+                    };
+                    expiresAt: {
+                        type: string;
+                        format: string;
+                        nullable: boolean;
+                        description: string;
+                    };
                     jobs: {
                         type: string;
                         description: string;