@nocobase/flow-engine 2.1.0-alpha.1 → 2.1.0-alpha.10

package/lib/executor/FlowExecutor.js

@@ -51,6 +51,10 @@ const _FlowExecutor = class _FlowExecutor {
   constructor(engine) {
     this.engine = engine;
   }
+  async emitModelEventIf(eventName, topic, payload) {
+    if (!eventName) return;
+    await this.engine.emitter.emitAsync(`model:event:${eventName}:${topic}`, payload);
+  }
   /** Cache wrapper for applyFlow cache lifecycle */
   async withApplyFlowCache(cacheKey, executor) {
     if (!cacheKey || !this.engine) return await executor();
@@ -81,7 +85,7 @@ const _FlowExecutor = class _FlowExecutor {
   /**
    * Execute a single flow on model.
    */
-  async runFlow(model, flowKey, inputArgs, runId) {
+  async runFlow(model, flowKey, inputArgs, runId, eventName) {
     var _a;
     const flow = model.getFlow(flowKey);
     if (!flow) {
@@ -113,6 +117,14 @@ const _FlowExecutor = class _FlowExecutor {
     const stepDefs = eventStep ? { eventStep, ...flow.steps } : flow.steps;
     (0, import_setupRuntimeContextSteps.setupRuntimeContextSteps)(flowContext, stepDefs, model, flowKey);
     const stepsRuntime = flowContext.steps;
+    const flowEventBasePayload = {
+      uid: model.uid,
+      model,
+      runId: flowContext.runId,
+      inputArgs,
+      flowKey
+    };
+    await this.emitModelEventIf(eventName, `flow:${flowKey}:start`, flowEventBasePayload);
     for (const [stepKey, step] of Object.entries(stepDefs)) {
       let handler;
       let combinedParams = {};
@@ -163,20 +175,58 @@ const _FlowExecutor = class _FlowExecutor {
           );
           continue;
         }
+        await this.emitModelEventIf(eventName, `flow:${flowKey}:step:${stepKey}:start`, {
+          ...flowEventBasePayload,
+          stepKey
+        });
         const currentStepResult = handler(runtimeCtx, combinedParams);
         const isAwait = step.isAwait !== false;
         lastResult = isAwait ? await currentStepResult : currentStepResult;
         stepResults[stepKey] = lastResult;
         stepsRuntime[stepKey].result = stepResults[stepKey];
+        await this.emitModelEventIf(eventName, `flow:${flowKey}:step:${stepKey}:end`, {
+          ...flowEventBasePayload,
+          result: lastResult,
+          stepKey
+        });
       } catch (error) {
+        if (!(error instanceof import_utils.FlowExitException) && !(error instanceof import_exceptions.FlowExitAllException)) {
+          await this.emitModelEventIf(eventName, `flow:${flowKey}:step:${stepKey}:error`, {
+            ...flowEventBasePayload,
+            error,
+            stepKey
+          });
+        }
         if (error instanceof import_utils.FlowExitException) {
           flowContext.logger.info(`[FlowEngine] ${error.message}`);
+          await this.emitModelEventIf(eventName, `flow:${flowKey}:step:${stepKey}:end`, {
+            ...flowEventBasePayload,
+            stepKey
+          });
+          await this.emitModelEventIf(eventName, `flow:${flowKey}:end`, {
+            ...flowEventBasePayload,
+            result: stepResults
+          });
           return Promise.resolve(stepResults);
         }
         if (error instanceof import_exceptions.FlowExitAllException) {
           flowContext.logger.info(`[FlowEngine] ${error.message}`);
+          await this.emitModelEventIf(eventName, `flow:${flowKey}:step:${stepKey}:end`, {
+            ...flowEventBasePayload,
+            stepKey,
+            aborted: true
+          });
+          await this.emitModelEventIf(eventName, `flow:${flowKey}:end`, {
+            ...flowEventBasePayload,
+            result: error,
+            aborted: true
+          });
           return Promise.resolve(error);
         }
+        await this.emitModelEventIf(eventName, `flow:${flowKey}:error`, {
+          ...flowEventBasePayload,
+          error
+        });
         flowContext.logger.error(
           { err: error },
           `BaseModel.applyFlow: Error executing step '${stepKey}' in flow '${flowKey}':`
@@ -184,9 +234,12 @@ const _FlowExecutor = class _FlowExecutor {
         return Promise.reject(error);
       }
     }
+    await this.emitModelEventIf(eventName, `flow:${flowKey}:end`, {
+      ...flowEventBasePayload,
+      result: stepResults
+    });
     return Promise.resolve(stepResults);
   }
-  // runAutoFlows 已移除：统一通过 dispatchEvent('beforeRender') + useCache 控制
   /**
    * Dispatch an event to flows bound via flow.on and execute them.
    */
@@ -198,13 +251,14 @@ const _FlowExecutor = class _FlowExecutor {
     const throwOnError = isBeforeRender;
     const runId = `${model.uid}-${eventName}-${Date.now()}`;
     const logger = model.context.logger;
+    const eventBasePayload = {
+      uid: model.uid,
+      model,
+      runId,
+      inputArgs
+    };
     try {
-      await this.engine.emitter.emitAsync(`model:event:${eventName}:start`, {
-        uid: model.uid,
-        model,
-        runId,
-        inputArgs
-      });
+      await this.emitModelEventIf(eventName, "start", eventBasePayload);
       await ((_a = model.onDispatchEventStart) == null ? void 0 : _a.call(model, eventName, options, inputArgs));
     } catch (err) {
       if (isBeforeRender && err instanceof import_utils.FlowExitException) {
@@ -226,9 +280,18 @@ const _FlowExecutor = class _FlowExecutor {
       if (typeof on === "object") return on.eventName === eventName;
       return false;
     });
+    const isRouterReplayClick = eventName === "click" && (inputArgs == null ? void 0 : inputArgs.triggerByRouter) === true;
+    const flowsToRun = isRouterReplayClick ? flows.filter((flow) => {
+      var _a2;
+      const reg = flow["flowRegistry"];
+      const type = (_a2 = reg == null ? void 0 : reg.constructor) == null ? void 0 : _a2._type;
+      return type !== "instance";
+    }) : flows;
+    const scheduledCancels = [];
     const execute = /* @__PURE__ */ __name(async () => {
+      let abortedByExitAll = false;
       if (sequential) {
-        const flowsWithIndex = flows.map((f, i) => ({ f, i }));
+        const flowsWithIndex = flowsToRun.map((f, i) => ({ f, i }));
         const ordered = flowsWithIndex.slice().sort((a, b) => {
           var _a2, _b2;
           const regA = a.f["flowRegistry"];
@@ -244,18 +307,110 @@ const _FlowExecutor = class _FlowExecutor {
           return a.i - b.i;
         }).map((x) => x.f);
         const results2 = [];
+        const staticFlowsByKey = new Map(
+          ordered.filter((f) => {
+            var _a2;
+            const reg = f["flowRegistry"];
+            const type = (_a2 = reg == null ? void 0 : reg.constructor) == null ? void 0 : _a2._type;
+            return type !== "instance";
+          }).map((f) => [f.key, f])
+        );
+        const scheduled = /* @__PURE__ */ new Set();
+        const scheduleGroups = /* @__PURE__ */ new Map();
+        ordered.forEach((flow, indexInOrdered) => {
+          var _a2;
+          const on = flow.on;
+          const onObj = typeof on === "object" ? on : void 0;
+          if (!onObj) return;
+          const phase = onObj.phase;
+          const flowKey = onObj.flowKey;
+          const stepKey = onObj.stepKey;
+          if (!phase || phase === "beforeAllFlows") return;
+          let whenKey = null;
+          if (phase === "afterAllFlows") {
+            whenKey = `event:${eventName}:end`;
+          } else if (phase === "beforeFlow" || phase === "afterFlow") {
+            if (!flowKey) {
+              whenKey = `event:${eventName}:end`;
+            } else {
+              const anchorFlow = staticFlowsByKey.get(String(flowKey));
+              if (anchorFlow) {
+                const anchorPhase = phase === "beforeFlow" ? "start" : "end";
+                whenKey = `event:${eventName}:flow:${String(flowKey)}:${anchorPhase}`;
+              } else {
+                whenKey = `event:${eventName}:end`;
+              }
+            }
+          } else if (phase === "beforeStep" || phase === "afterStep") {
+            if (!flowKey || !stepKey) {
+              whenKey = `event:${eventName}:end`;
+            } else {
+              const anchorFlow = staticFlowsByKey.get(String(flowKey));
+              const anchorStepExists = !!((_a2 = anchorFlow == null ? void 0 : anchorFlow.hasStep) == null ? void 0 : _a2.call(anchorFlow, String(stepKey)));
+              if (anchorFlow && anchorStepExists) {
+                const anchorPhase = phase === "beforeStep" ? "start" : "end";
+                whenKey = `event:${eventName}:flow:${String(flowKey)}:step:${String(stepKey)}:${anchorPhase}`;
+              } else {
+                whenKey = `event:${eventName}:end`;
+              }
+            }
+          } else {
+            return;
+          }
+          if (!whenKey) return;
+          const shouldSkipOnAborted = whenKey === `event:${eventName}:end` || phase === "afterFlow" || phase === "afterStep";
+          scheduled.add(flow.key);
+          const list = scheduleGroups.get(whenKey) || [];
+          list.push({ flow, order: indexInOrdered, shouldSkipOnAborted });
+          scheduleGroups.set(whenKey, list);
+        });
+        for (const [whenKey, list] of scheduleGroups.entries()) {
+          const sorted = list.slice().sort((a, b) => {
+            const sa = a.flow.sort ?? 0;
+            const sb = b.flow.sort ?? 0;
+            if (sa !== sb) return sa - sb;
+            return a.order - b.order;
+          });
+          for (const it of sorted) {
+            const when = it.shouldSkipOnAborted ? Object.assign(
+              (event) => event.type === whenKey && event.aborted !== true,
+              {
+                __eventType: whenKey
+              }
+            ) : whenKey;
+            const cancel = model.scheduleModelOperation(
+              model.uid,
+              async (m) => {
+                const res = await this.runFlow(m, it.flow.key, inputArgs, runId, eventName);
+                if (res instanceof import_exceptions.FlowExitAllException) {
+                  throw res;
+                }
+                results2.push(res);
+              },
+              { when }
+            );
+            scheduledCancels.push(cancel);
+          }
+        }
         for (const flow of ordered) {
+          if (scheduled.has(flow.key)) continue;
           try {
             logger.debug(
               `BaseModel '${model.uid}' dispatching event '${eventName}' to flow '${flow.key}' (sequential).`
             );
-            const result = await this.runFlow(model, flow.key, inputArgs, runId);
+            const result = await this.runFlow(model, flow.key, inputArgs, runId, eventName);
             if (result instanceof import_exceptions.FlowExitAllException) {
               logger.debug(`[FlowEngine.dispatchEvent] ${result.message}`);
+              abortedByExitAll = true;
               break;
             }
             results2.push(result);
           } catch (error) {
+            if (error instanceof import_exceptions.FlowExitAllException) {
+              logger.debug(`[FlowEngine.dispatchEvent] ${error.message}`);
+              abortedByExitAll = true;
+              break;
+            }
             logger.error(
               { err: error },
               `BaseModel.dispatchEvent: Error executing event-triggered flow '${flow.key}' for event '${eventName}' (sequential):`
@@ -263,13 +418,13 @@ const _FlowExecutor = class _FlowExecutor {
             throw error;
           }
         }
-        return results2;
+        return { result: results2, abortedByExitAll };
       }
       const results = await Promise.all(
-        flows.map(async (flow) => {
+        flowsToRun.map(async (flow) => {
           logger.debug(`BaseModel '${model.uid}' dispatching event '${eventName}' to flow '${flow.key}'.`);
           try {
-            return await this.runFlow(model, flow.key, inputArgs, runId);
+            return await this.runFlow(model, flow.key, inputArgs, runId, eventName);
           } catch (error) {
             logger.error(
               { err: error },
@@ -280,7 +435,11 @@ const _FlowExecutor = class _FlowExecutor {
           }
         })
       );
-      return results.filter((x) => x !== void 0);
+      const filteredResults = results.filter((x) => x !== void 0);
+      if (filteredResults.some((x) => x instanceof import_exceptions.FlowExitAllException)) {
+        abortedByExitAll = true;
+      }
+      return { result: filteredResults, abortedByExitAll };
     }, "execute");
     const argsKey = useCache ? JSON.stringify(inputArgs ?? {}) : "";
     const cacheKey = useCache ? import_flowEngine.FlowEngine.generateApplyFlowCacheKey(
@@ -289,19 +448,23 @@ const _FlowExecutor = class _FlowExecutor {
       model.uid
     ) : null;
     try {
-      const result = await this.withApplyFlowCache(cacheKey, execute);
+      const { result, abortedByExitAll } = await this.withApplyFlowCache(cacheKey, execute);
       try {
         await ((_c = model.onDispatchEventEnd) == null ? void 0 : _c.call(model, eventName, options, inputArgs, result));
       } catch (hookErr) {
         logger.error({ err: hookErr }, `BaseModel.dispatchEvent: End hook error for event '${eventName}'`);
       }
-      await this.engine.emitter.emitAsync(`model:event:${eventName}:end`, {
-        uid: model.uid,
-        model,
-        runId,
-        inputArgs,
-        result
+      await this.emitModelEventIf(eventName, "end", {
+        ...eventBasePayload,
+        result,
+        ...abortedByExitAll ? { aborted: true } : {}
       });
+      if (result && typeof result === "object") {
+        Object.defineProperty(result, "__abortedByExitAll", {
+          value: abortedByExitAll,
+          configurable: true
+        });
+      }
       return result;
     } catch (error) {
       try {
@@ -312,14 +475,15 @@ const _FlowExecutor = class _FlowExecutor {
         { err: error },
         `BaseModel.dispatchEvent: Error executing event '${eventName}' for model '${model.uid}':`
       );
-      await this.engine.emitter.emitAsync(`model:event:${eventName}:error`, {
-        uid: model.uid,
-        model,
-        runId,
-        inputArgs,
+      await this.emitModelEventIf(eventName, "error", {
+        ...eventBasePayload,
         error
       });
       if (throwOnError) throw error;
+    } finally {
+      for (const cancel of scheduledCancels) {
+        cancel();
+      }
     }
   }
 };