@nocobase/plugin-workflow 2.1.0-alpha.1 → 2.1.0-alpha.11

package/dist/server/Dispatcher.js

@@ -29,22 +29,22 @@ __export(Dispatcher_exports, {
   default: () => Dispatcher
 });
 module.exports = __toCommonJS(Dispatcher_exports);
-var import_crypto = require("crypto");
+var import_node_crypto = require("node:crypto");
 var import_sequelize = require("sequelize");
 var import_constants = require("./constants");
 var import_Plugin = require("./Plugin");
 class Dispatcher {
   constructor(plugin) {
     this.plugin = plugin;
-    this.prepare = this.prepare.bind(this);
   }
   ready = false;
   executing = null;
+  preparing = null;
   pending = [];
   events = [];
   eventsCount = 0;
   get idle() {
-    return this.ready && !this.executing && !this.pending.length && !this.events.length;
+    return this.ready && !this.executing && !this.preparing && !this.pending.length && !this.events.length;
   }
   onQueueExecution = async (event) => {
     const ExecutionRepo = this.plugin.db.getRepository("executions");
@@ -96,11 +96,55 @@ class Dispatcher {
     this.eventsCount = this.events.length;
     logger.info(`new event triggered, now events: ${this.events.length}`);
     logger.debug(`event data:`, { context });
-    if (this.events.length > 1) {
-      logger.info(`new event is pending to be prepared after previous preparation is finished`);
+    this.prepare();
+  }
+  prepare() {
+    if (this.preparing) {
       return;
     }
-    setImmediate(this.prepare);
+    this.preparing = (async () => {
+      try {
+        while (this.events.length) {
+          if (this.executing && this.plugin.db.options.dialect === "sqlite") {
+            await this.executing;
+          }
+          const event = this.events.shift();
+          this.eventsCount = this.events.length;
+          if (!event) continue;
+          const logger = this.plugin.getLogger(event[0].id);
+          logger.info(`preparing execution for event`);
+          try {
+            const execution = await this.createExecution(...event);
+            if (!(execution == null ? void 0 : execution.dispatched)) {
+              if (this.plugin.serving() && !this.executing && !this.pending.length) {
+                logger.info(`local pending list is empty, adding execution (${execution.id}) to pending list`);
+                this.pending.push({ execution });
+              } else {
+                logger.info(
+                  `instance is not serving as worker or local pending list is not empty, sending execution (${execution.id}) to queue`
+                );
+                try {
+                  await this.plugin.app.eventQueue.publish(this.plugin.channelPendingExecution, {
+                    executionId: execution.id
+                  });
+                } catch (qErr) {
+                  logger.error(`publishing execution (${execution.id}) to queue failed:`, { error: qErr });
+                }
+              }
+            }
+          } catch (error) {
+            logger.error(`failed to create execution:`, { error });
+          }
+        }
+      } finally {
+        this.preparing = null;
+        if (this.events.length) {
+          this.prepare();
+        } else {
+          this.dispatch();
+        }
+      }
+    })();
   }
   async resume(job) {
     let { execution } = job;
@@ -119,16 +163,26 @@ class Dispatcher {
   }
   async beforeStop() {
     this.ready = false;
-    if (this.events.length) {
-      await this.prepare();
-    }
-    if (this.executing) {
-      await this.executing;
+    this.plugin.getLogger("dispatcher").info("app is stopping, draining local queues...");
+    while (this.preparing || this.executing || this.events.length || this.pending.length) {
+      if (this.preparing) {
+        await this.preparing;
+      }
+      if (this.executing) {
+        await this.executing;
+      }
+      if (this.events.length && !this.preparing) {
+        this.prepare();
+      }
+      if (this.pending.length && !this.executing) {
+        this.dispatch();
+      }
+      await new Promise((resolve) => setImmediate(resolve));
     }
+    this.plugin.getLogger("dispatcher").info("local queues drained");
   }
   dispatch() {
-    if (!this.ready) {
-      this.plugin.getLogger("dispatcher").warn(`app is not ready, new dispatching will be ignored`);
+    if (!this.ready && !this.pending.length && !this.events.length) {
       return;
     }
     if (this.executing) {
@@ -136,7 +190,8 @@ class Dispatcher {
       return;
     }
     if (this.events.length) {
-      return this.prepare();
+      this.prepare();
+      return;
     }
     this.executing = (async () => {
       let next = null;
@@ -149,13 +204,15 @@ class Dispatcher {
           this.plugin.getLogger(next[0].workflowId).info(`pending execution (${next[0].id}) ready to process`);
         }
       } else {
-        if (this.plugin.serving()) {
+        if (this.ready && this.plugin.serving()) {
           execution = await this.acquireQueueingExecution();
           if (execution) {
             next = [execution];
           }
         } else {
-          this.plugin.getLogger("dispatcher").warn(`${import_Plugin.WORKER_JOB_WORKFLOW_PROCESS} is not serving on this instance, new dispatching will be ignored`);
+          this.plugin.getLogger("dispatcher").warn(
+            `${import_Plugin.WORKER_JOB_WORKFLOW_PROCESS} is not serving on this instance or app not ready, new dispatching will be ignored`
+          );
         }
       }
       if (next) {
@@ -233,7 +290,7 @@ class Dispatcher {
         {
           context,
           key: workflow.key,
-          eventKey: options.eventKey ?? (0, import_crypto.randomUUID)(),
+          eventKey: options.eventKey ?? (0, import_node_crypto.randomUUID)(),
           stack: options.stack,
           dispatched: deferred ?? false,
           status: deferred ? import_constants.EXECUTION_STATUS.STARTED : import_constants.EXECUTION_STATUS.QUEUEING,
@@ -268,50 +325,6 @@ class Dispatcher {
     execution.workflow = workflow;
     return execution;
   }
-  prepare = async () => {
-    if (this.executing && this.plugin.db.options.dialect === "sqlite") {
-      await this.executing;
-    }
-    const event = this.events.shift();
-    this.eventsCount = this.events.length;
-    if (!event) {
-      this.plugin.getLogger("dispatcher").info(`events queue is empty, no need to prepare`);
-      return;
-    }
-    const logger = this.plugin.getLogger(event[0].id);
-    logger.info(`preparing execution for event`);
-    try {
-      const execution = await this.createExecution(...event);
-      if (!(execution == null ? void 0 : execution.dispatched)) {
-        if (this.plugin.serving() && !this.executing && !this.pending.length) {
-          logger.info(`local pending list is empty, adding execution (${execution.id}) to pending list`);
-          this.pending.push({ execution });
-        } else {
-          logger.info(
-            `instance is not serving as worker or local pending list is not empty, sending execution (${execution.id}) to queue`
-          );
-          try {
-            await this.plugin.app.eventQueue.publish(this.plugin.channelPendingExecution, {
-              executionId: execution.id
-            });
-          } catch (qErr) {
-            logger.error(`publishing execution (${execution.id}) to queue failed:`, { error: qErr });
-          }
-        }
-      }
-    } catch (error) {
-      logger.error(`failed to create execution:`, { error });
-    }
-    if (this.events.length) {
-      await this.prepare();
-    } else {
-      this.plugin.getLogger("dispatcher").info("no more events need to be prepared, dispatching...");
-      if (this.executing) {
-        await this.executing;
-      }
-      this.dispatch();
-    }
-  };
   async acquirePendingExecution(execution) {
     const logger = this.plugin.getLogger(execution.workflowId);
     const isolationLevel = this.plugin.db.options.dialect === "sqlite" ? [][0] : import_sequelize.Transaction.ISOLATION_LEVELS.REPEATABLE_READ;
@@ -390,7 +403,8 @@ class Dispatcher {
     logger.info(`execution (${execution.id}) ${job ? "resuming" : "starting"}...`);
     try {
       await (job ? processor.resume(job) : processor.start());
-      logger.info(`execution (${execution.id}) finished with status: ${execution.status}`, { execution });
+      logger.info(`execution (${execution.id}) finished with status: ${execution.status}`);
+      logger.debug(`execution (${execution.id}) details:`, { execution });
       if (execution.status && ((_b = (_a = execution.workflow.options) == null ? void 0 : _a.deleteExecutionOnStatus) == null ? void 0 : _b.includes(execution.status))) {
         await execution.destroy({ transaction: processor.mainTransaction });
       }

package/dist/server/Plugin.d.ts

@@ -56,6 +56,7 @@ export default class PluginWorkflowServer extends Plugin {
     }): void;
     private initTriggers;
     private initInstructions;
+    private registerErrorHandlers;
     beforeLoad(): Promise<void>;
     /**
      * @internal

package/dist/server/Plugin.js

@@ -49,12 +49,15 @@ var import_utils = require("@nocobase/utils");
 var import_Dispatcher = __toESM(require("./Dispatcher"));
 var import_Processor = __toESM(require("./Processor"));
 var import_actions = __toESM(require("./actions"));
+var import_nodes = require("./actions/nodes");
+var import_workflows = require("./actions/workflows");
 var import_functions = __toESM(require("./functions"));
 var import_CollectionTrigger = __toESM(require("./triggers/CollectionTrigger"));
 var import_ScheduleTrigger = __toESM(require("./triggers/ScheduleTrigger"));
 var import_CalculationInstruction = __toESM(require("./instructions/CalculationInstruction"));
 var import_ConditionInstruction = __toESM(require("./instructions/ConditionInstruction"));
 var import_EndInstruction = __toESM(require("./instructions/EndInstruction"));
+var import_OutputInstruction = __toESM(require("./instructions/OutputInstruction"));
 var import_CreateInstruction = __toESM(require("./instructions/CreateInstruction"));
 var import_DestroyInstruction = __toESM(require("./instructions/DestroyInstruction"));
 var import_QueryInstruction = __toESM(require("./instructions/QueryInstruction"));
@@ -270,6 +273,7 @@ class PluginWorkflowServer extends import_server.Plugin {
     this.registerInstruction("condition", import_ConditionInstruction.default);
     this.registerInstruction("multi-conditions", import_MultiConditionsInstruction.default);
     this.registerInstruction("end", import_EndInstruction.default);
+    this.registerInstruction("output", import_OutputInstruction.default);
     this.registerInstruction("create", import_CreateInstruction.default);
     this.registerInstruction("destroy", import_DestroyInstruction.default);
     this.registerInstruction("query", import_QueryInstruction.default);
@@ -278,6 +282,29 @@ class PluginWorkflowServer extends import_server.Plugin {
       this.registerInstruction(name, instruction);
     }
   }
+  registerErrorHandlers() {
+    const PluginErrorHandler = this.app.pm.get("error-handler");
+    if (PluginErrorHandler == null ? void 0 : PluginErrorHandler.errorHandler) {
+      PluginErrorHandler.errorHandler.register(
+        (err) => err instanceof import_nodes.NodeValidationError || err.name === "NodeValidationError",
+        (err, ctx) => {
+          ctx.status = err.status;
+          ctx.body = {
+            errors: Object.values(err.errors).map((message) => ({ message }))
+          };
+        }
+      );
+      PluginErrorHandler.errorHandler.register(
+        (err) => err instanceof import_workflows.WorkflowValidationError || err.name === "WorkflowValidationError",
+        (err, ctx) => {
+          ctx.status = err.status;
+          ctx.body = {
+            errors: Object.values(err.errors).map((message) => ({ message }))
+          };
+        }
+      );
+    }
+  }
   async beforeLoad() {
     this.db.registerRepositories({
       WorkflowRepository: import_WorkflowRepository.default
@@ -287,7 +314,8 @@ class PluginWorkflowServer extends import_server.Plugin {
       filter: { name: this.name }
     });
     this.snowflake = new import_nodejs_snowflake.Snowflake({
-      custom_epoch: pluginRecord == null ? void 0 : pluginRecord.createdAt.getTime()
+      custom_epoch: pluginRecord == null ? void 0 : pluginRecord.createdAt.getTime(),
+      instance_id: this.app.instanceId
     });
   }
   /**
@@ -299,6 +327,7 @@ class PluginWorkflowServer extends import_server.Plugin {
     this.initTriggers(options.triggers);
     this.initInstructions(options.instructions);
     (0, import_functions.default)(this, options.functions);
+    this.registerErrorHandlers();
     this.functions.register("instanceId", () => this.app.instanceId);
     this.functions.register("epoch", () => 1605024e3);
     this.functions.register("genSnowflakeId", () => this.app.snowflakeIdGenerator.generate());
@@ -335,6 +364,8 @@ class PluginWorkflowServer extends import_server.Plugin {
         "flow_nodes:update",
         "flow_nodes:destroy",
         "flow_nodes:destroyBranch",
+        "flow_nodes:duplicate",
+        "flow_nodes:move",
         "flow_nodes:test",
         "jobs:get",
         "workflowCategories:*"

package/dist/server/Processor.d.ts

@@ -96,6 +96,15 @@ export default class Processor {
      * @experimental
      */
     getScope(sourceNodeId?: number | string, includeSelfScope?: boolean): {
+        ctx: {
+            $context: any;
+            $jobsMapByNodeKey: {
+                [key: string]: any;
+            };
+            $system: {};
+            $scopes: {};
+            $env: {};
+        };
         $context: any;
         $jobsMapByNodeKey: {
             [key: string]: any;

package/dist/server/Processor.js

@@ -439,13 +439,18 @@ class Processor {
         $scopes[n.id] = $scopes[n.key] = instruction.getScope(n, this.jobResultsMapByNodeKey[n.key], this);
       }
     }
-    return {
+    const scopes = {
       $context: this.execution.context,
       $jobsMapByNodeKey: this.jobResultsMapByNodeKey,
       $system: systemFns,
       $scopes,
       $env: this.options.plugin.app.environment.getVariables()
     };
+    return {
+      ...scopes,
+      ctx: scopes
+      // 2.0
+    };
   }
   /**
    * @experimental

package/dist/server/actions/index.js

@@ -63,6 +63,8 @@ function actions_default({ app }) {
       update: nodes.update,
       destroy: nodes.destroy,
       destroyBranch: nodes.destroyBranch,
+      duplicate: nodes.duplicate,
+      move: nodes.move,
       test: nodes.test
     }),
     ...make("jobs", jobs),

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

@@ -7,8 +7,15 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import { Context } from '@nocobase/actions';
+export declare class NodeValidationError extends Error {
+    status: number;
+    errors: Record<string, string>;
+    constructor(errors: Record<string, string>);
+}
 export declare function create(context: Context, next: any): Promise<void>;
+export declare function duplicate(context: Context, next: any): Promise<void>;
 export declare function destroy(context: Context, next: any): Promise<void>;
 export declare function destroyBranch(context: Context, next: any): Promise<void>;
+export declare function move(context: Context, next: any): Promise<void>;
 export declare function update(context: Context, next: any): Promise<void>;
 export declare function test(context: Context, next: any): Promise<void>;