@nocobase/flow-engine 2.0.0-alpha.3 → 2.0.0-alpha.30

package/lib/executor/FlowExecutor.js

@@ -46,10 +46,38 @@ var import_flowEngine = require("../flowEngine");
 var import_utils = require("../utils");
 var import_exceptions = require("../utils/exceptions");
 var import_setupRuntimeContextSteps = require("../utils/setupRuntimeContextSteps");
+var import_createEphemeralContext = require("../utils/createEphemeralContext");
 const _FlowExecutor = class _FlowExecutor {
   constructor(engine) {
     this.engine = engine;
   }
+  /** Cache wrapper for applyFlow cache lifecycle */
+  async withApplyFlowCache(cacheKey, executor) {
+    if (!cacheKey || !this.engine) return await executor();
+    const cachedEntry = this.engine.applyFlowCache.get(cacheKey);
+    if (cachedEntry) {
+      if (cachedEntry.status === "resolved") return cachedEntry.data;
+      if (cachedEntry.status === "rejected") throw cachedEntry.error;
+      if (cachedEntry.status === "pending") return await cachedEntry.promise;
+    }
+    const promise = executor().then((result) => {
+      this.engine.applyFlowCache.set(cacheKey, {
+        status: "resolved",
+        data: result,
+        promise: Promise.resolve(result)
+      });
+      return result;
+    }).catch((err) => {
+      this.engine.applyFlowCache.set(cacheKey, {
+        status: "rejected",
+        error: err,
+        promise: Promise.reject(err)
+      });
+      throw err;
+    });
+    this.engine.applyFlowCache.set(cacheKey, { status: "pending", promise });
+    return await promise;
+  }
   /**
    * Execute a single flow on model.
    */
@@ -77,34 +105,40 @@ const _FlowExecutor = class _FlowExecutor {
     let eventStep = model.getEvent(typeof flow.on === "string" ? flow.on : (_a = flow.on) == null ? void 0 : _a.eventName);
     if (eventStep) {
       eventStep = { ...eventStep };
-      eventStep.defaultParams = { ...import_lodash.default.get(flow, "on.defaultParams", {}), ...eventStep.defaultParams };
+      eventStep.defaultParams = {
+        ...import_lodash.default.get(flow, "on.defaultParams", {}),
+        ...eventStep.defaultParams
+      };
     }
     const stepDefs = eventStep ? { eventStep, ...flow.steps } : flow.steps;
     (0, import_setupRuntimeContextSteps.setupRuntimeContextSteps)(flowContext, stepDefs, model, flowKey);
     const stepsRuntime = flowContext.steps;
-    for (const stepKey in stepDefs) {
-      if (!Object.prototype.hasOwnProperty.call(stepDefs, stepKey)) continue;
-      const step = stepDefs[stepKey];
+    for (const [stepKey, step] of Object.entries(stepDefs)) {
       let handler;
       let combinedParams = {};
-      let actionDefinition;
       let useRawParams = step.useRawParams;
+      let runtimeCtx;
       if (step.use) {
-        actionDefinition = model.getAction(step.use);
+        const actionDefinition = model.getAction(step.use);
         if (!actionDefinition) {
           flowContext.logger.error(
             `BaseModel.applyFlow: Action '${step.use}' not found for step '${stepKey}' in flow '${flowKey}'. Skipping.`
           );
           continue;
         }
+        runtimeCtx = await (0, import_createEphemeralContext.createEphemeralContext)(flowContext, {
+          ...actionDefinition,
+          ...step
+        });
         handler = step.handler || actionDefinition.handler;
         useRawParams = useRawParams ?? actionDefinition.useRawParams;
-        const actionDefaultParams = await (0, import_utils.resolveDefaultParams)(actionDefinition.defaultParams, flowContext);
-        const stepDefaultParams = await (0, import_utils.resolveDefaultParams)(step.defaultParams, flowContext);
+        const actionDefaultParams = await (0, import_utils.resolveDefaultParams)(actionDefinition.defaultParams, runtimeCtx);
+        const stepDefaultParams = await (0, import_utils.resolveDefaultParams)(step.defaultParams, runtimeCtx);
         combinedParams = { ...actionDefaultParams, ...stepDefaultParams };
       } else if (step.handler) {
+        runtimeCtx = await (0, import_createEphemeralContext.createEphemeralContext)(flowContext, step);
         handler = step.handler;
-        const stepDefaultParams = await (0, import_utils.resolveDefaultParams)(step.defaultParams, flowContext);
+        const stepDefaultParams = await (0, import_utils.resolveDefaultParams)(step.defaultParams, runtimeCtx);
         combinedParams = { ...stepDefaultParams };
       } else {
         flowContext.logger.error(
@@ -117,10 +151,10 @@ const _FlowExecutor = class _FlowExecutor {
         combinedParams = { ...combinedParams, ...modelStepParams };
       }
       if (typeof useRawParams === "function") {
-        useRawParams = await useRawParams(flowContext);
+        useRawParams = await useRawParams(runtimeCtx);
       }
       if (!useRawParams) {
-        combinedParams = await flowContext.resolveJsonTemplate(combinedParams);
+        combinedParams = await runtimeCtx.resolveJsonTemplate(combinedParams);
       }
       try {
         if (!handler) {
@@ -129,7 +163,7 @@ const _FlowExecutor = class _FlowExecutor {
           );
           continue;
         }
-        const currentStepResult = handler(flowContext, combinedParams);
+        const currentStepResult = handler(runtimeCtx, combinedParams);
         const isAwait = step.isAwait !== false;
         lastResult = isAwait ? await currentStepResult : currentStepResult;
         stepResults[stepKey] = lastResult;
@@ -152,106 +186,107 @@ const _FlowExecutor = class _FlowExecutor {
     }
     return Promise.resolve(stepResults);
   }
+  // runAutoFlows 已移除：统一通过 dispatchEvent('beforeRender') + useCache 控制
   /**
-   * Execute all auto-apply flows for model.
+   * Dispatch an event to flows bound via flow.on and execute them.
    */
-  async runAutoFlows(model, inputArgs, useCache = true) {
-    const autoApplyFlows = model.getAutoFlows();
-    if (autoApplyFlows.length === 0) {
-      model.context.logger.warn(`FlowModel: No auto-apply flows found for model '${model.uid}'`);
-      return [];
-    }
-    const cacheKey = useCache ? import_flowEngine.FlowEngine.generateApplyFlowCacheKey(model.getAutoFlowCacheScope(), "all", model.uid) : null;
-    if (cacheKey && this.engine) {
-      const cachedEntry = this.engine.applyFlowCache.get(cacheKey);
-      if (cachedEntry) {
-        if (cachedEntry.status === "resolved") {
-          model.context.logger.debug(`[FlowEngine.applyAutoFlows] Using cached result for model: ${model.uid}`);
-          return cachedEntry.data;
-        }
-        if (cachedEntry.status === "rejected") throw cachedEntry.error;
-        if (cachedEntry.status === "pending") return await cachedEntry.promise;
+  async dispatchEvent(model, eventName, inputArgs, options) {
+    var _a, _b, _c, _d;
+    const isBeforeRender = eventName === "beforeRender";
+    const sequential = !!(options == null ? void 0 : options.sequential);
+    const useCache = !!(options == null ? void 0 : options.useCache);
+    const throwOnError = isBeforeRender;
+    const runId = `${model.uid}-${eventName}-${Date.now()}`;
+    const logger = model.context.logger;
+    try {
+      await ((_a = model.onDispatchEventStart) == null ? void 0 : _a.call(model, eventName, options, inputArgs));
+    } catch (err) {
+      if (isBeforeRender && err instanceof import_utils.FlowExitException) {
+        logger.debug(`[FlowModel.dispatchEvent] ${err.message}`);
+        return [];
       }
-    }
-    const executeAutoFlows = /* @__PURE__ */ __name(async () => {
-      const results = [];
-      const runId = `${model.uid}-autoFlow-${Date.now()}-${Math.floor(Math.random() * 1e3)}`;
-      const logger = model.context.logger.child({ module: "flow-engine", component: "FlowExecutor", runId });
-      logger.debug(
-        `[FlowExecutor] runAutoFlows: uid=${model.uid}, isFork=${(model == null ? void 0 : model.isFork) === true}, useCache=${useCache}, runId=${runId}, flows=${autoApplyFlows.map((f) => f.key).join(",")}`
-      );
       try {
-        if (autoApplyFlows.length === 0) {
-          logger.warn(`FlowModel: No auto-apply flows found for model '${model.uid}'`);
-        } else {
-          for (const flow of autoApplyFlows) {
-            try {
-              logger.debug(`[FlowExecutor] runFlow: uid=${model.uid}, flowKey=${flow.key}`);
-              const result = await this.runFlow(model, flow.key, inputArgs, runId);
-              if (result instanceof import_exceptions.FlowExitAllException) {
-                logger.debug(`[FlowEngine.applyAutoFlows] ${result.message}`);
-                break;
-              }
-              results.push(result);
-            } catch (error) {
-              logger.error({ err: error }, `FlowModel.applyAutoFlows: Error executing auto-apply flow '${flow.key}':`);
-              throw error;
-            }
-          }
-        }
-        return results;
-      } catch (error) {
-        if (error instanceof import_utils.FlowExitException) {
-          logger.debug(`[FlowEngine.applyAutoFlows] ${error.message}`);
-          return results;
-        }
-        throw error;
+        await ((_b = model.onDispatchEventError) == null ? void 0 : _b.call(model, eventName, options, inputArgs, err));
+      } finally {
+        logger.error({ err }, `BaseModel.dispatchEvent: Start hook error for event '${eventName}'`);
       }
-    }, "executeAutoFlows");
-    if (!cacheKey || !this.engine) {
-      return await executeAutoFlows();
+      if (throwOnError) throw err;
+      return;
     }
-    const promise = executeAutoFlows().then((result) => {
-      this.engine.applyFlowCache.set(cacheKey, {
-        status: "resolved",
-        data: result,
-        promise: Promise.resolve(result)
-      });
-      return result;
-    }).catch((err) => {
-      this.engine.applyFlowCache.set(cacheKey, {
-        status: "rejected",
-        error: err,
-        promise: Promise.reject(err)
-      });
-      throw err;
-    });
-    this.engine.applyFlowCache.set(cacheKey, { status: "pending", promise });
-    return await promise;
-  }
-  /**
-   * Dispatch an event to flows bound via flow.on and execute them.
-   */
-  async dispatchEvent(model, eventName, inputArgs) {
-    const flows = Array.from(model.getFlows().values()).filter((flow) => {
+    const flows = isBeforeRender ? model.getEventFlows("beforeRender") : Array.from(model.getFlows().values()).filter((flow) => {
       const on = flow.on;
       if (!on) return false;
       if (typeof on === "string") return on === eventName;
       if (typeof on === "object") return on.eventName === eventName;
       return false;
     });
-    const runId = `${model.uid}-${eventName}-${Date.now()}`;
-    const logger = model.context.logger;
-    const promises = flows.map((flow) => {
-      logger.debug(`BaseModel '${model.uid}' dispatching event '${eventName}' to flow '${flow.key}'.`);
-      return this.runFlow(model, flow.key, inputArgs, runId).catch((error) => {
-        logger.error(
-          { err: error },
-          `BaseModel.dispatchEvent: Error executing event-triggered flow '${flow.key}' for event '${eventName}':`
-        );
-      });
-    });
-    await Promise.all(promises);
+    const execute = /* @__PURE__ */ __name(async () => {
+      if (sequential) {
+        const ordered = flows.slice().sort((a, b) => (a.sort ?? 0) - (b.sort ?? 0));
+        const results2 = [];
+        for (const flow of ordered) {
+          try {
+            logger.debug(
+              `BaseModel '${model.uid}' dispatching event '${eventName}' to flow '${flow.key}' (sequential).`
+            );
+            const result = await this.runFlow(model, flow.key, inputArgs, runId);
+            if (result instanceof import_exceptions.FlowExitAllException) {
+              logger.debug(`[FlowEngine.dispatchEvent] ${result.message}`);
+              break;
+            }
+            results2.push(result);
+          } catch (error) {
+            logger.error(
+              { err: error },
+              `BaseModel.dispatchEvent: Error executing event-triggered flow '${flow.key}' for event '${eventName}' (sequential):`
+            );
+            throw error;
+          }
+        }
+        return results2;
+      }
+      const results = await Promise.all(
+        flows.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);
+          } catch (error) {
+            logger.error(
+              { err: error },
+              `BaseModel.dispatchEvent: Error executing event-triggered flow '${flow.key}' for event '${eventName}':`
+            );
+            if (throwOnError) throw error;
+            return void 0;
+          }
+        })
+      );
+      return results.filter((x) => x !== void 0);
+    }, "execute");
+    const argsKey = useCache ? JSON.stringify(inputArgs ?? {}) : "";
+    const cacheKey = useCache ? import_flowEngine.FlowEngine.generateApplyFlowCacheKey(
+      `event:${model.getFlowCacheScope(eventName)}:${argsKey}`,
+      eventName,
+      model.uid
+    ) : null;
+    try {
+      const result = 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}'`);
+      }
+      return result;
+    } catch (error) {
+      try {
+        await ((_d = model.onDispatchEventError) == null ? void 0 : _d.call(model, eventName, options, inputArgs, error));
+      } catch (_2) {
+      }
+      model.context.logger.error(
+        { err: error },
+        `BaseModel.dispatchEvent: Error executing event '${eventName}' for model '${model.uid}':`
+      );
+      if (throwOnError) throw error;
+    }
   }
 };
 __name(_FlowExecutor, "FlowExecutor");

package/lib/flowContext.d.ts

@@ -18,7 +18,8 @@ import type { Location } from 'react-router-dom';
 import { DataSourceManager } from './data-source';
 import { FlowEngine } from './flowEngine';
 import { JSRunner, JSRunnerOptions } from './JSRunner';
-import { FlowModel, ForkFlowModel } from './models';
+import type { FlowModel } from './models/flowModel';
+import type { ForkFlowModel } from './models/forkFlowModel';
 import { FlowResource, FlowSQLRepository } from './resources';
 import type { ActionDefinition, EventDefinition, ResourceType } from './types';
 import { JSONValue } from './utils/params-resolvers';
@@ -138,13 +139,11 @@ export declare class FlowContext {
      */
     getPropertyOptions(key: string): PropertyOptions | undefined;
 }
-export declare class FlowRunjsContext extends FlowContext {
-    constructor(delegate: FlowContext);
-}
 declare class BaseFlowEngineContext extends FlowContext {
     router: Router;
     dataSourceManager: DataSourceManager;
     requireAsync: (url: string) => Promise<any>;
+    importAsync: (url: string) => Promise<any>;
     createJSRunner: (options?: JSRunnerOptions) => JSRunner;
     /**
      * @deprecated use `resolveJsonTemplate` instead
@@ -152,7 +151,6 @@ declare class BaseFlowEngineContext extends FlowContext {
     renderJson: (template: JSONValue) => Promise<any>;
     resolveJsonTemplate: (template: JSONValue) => Promise<any>;
     runjs: (code: string, variables?: Record<string, any>, options?: JSRunnerOptions) => Promise<any>;
-    copyToClipboard: (text: string) => Promise<void>;
     getAction: <TModel extends FlowModel = FlowModel, TCtx extends FlowContext = FlowContext>(name: string) => ActionDefinition<TModel, TCtx> | undefined;
     getActions: <TModel extends FlowModel = FlowModel, TCtx extends FlowContext = FlowContext>() => Map<string, ActionDefinition<TModel, TCtx>>;
     getEvents: <TModel extends FlowModel = FlowModel, TCtx extends FlowContext = FlowContext>() => Map<string, EventDefinition<TModel, TCtx>>;
@@ -212,4 +210,34 @@ export declare class FlowRuntimeContext<TModel extends FlowModel = FlowModel, TM
     get mode(): TMode;
 }
 export type FlowSettingsContext<TModel extends FlowModel = FlowModel> = FlowRuntimeContext<TModel, 'settings'>;
+export type RunJSDocCompletionDoc = {
+    insertText?: string;
+};
+export type RunJSDocPropertyDoc = string | {
+    description?: string;
+    detail?: string;
+    type?: string;
+    examples?: string[];
+    completion?: RunJSDocCompletionDoc;
+    properties?: Record<string, RunJSDocPropertyDoc>;
+};
+export type RunJSDocMethodDoc = string | {
+    description?: string;
+    detail?: string;
+    examples?: string[];
+    completion?: RunJSDocCompletionDoc;
+};
+export type RunJSDocMeta = {
+    label?: string;
+    properties?: Record<string, RunJSDocPropertyDoc>;
+    methods?: Record<string, RunJSDocMethodDoc>;
+    snippets?: Record<string, any>;
+};
+export declare class FlowRunJSContext extends FlowContext {
+    constructor(delegate: FlowContext);
+    static define(meta: RunJSDocMeta, options?: {
+        locale?: string;
+    }): void;
+    static getDoc(locale?: string): RunJSDocMeta;
+}
 export {};