@nocobase/flow-engine 2.0.0-beta.2 → 2.0.0-beta.20

package/lib/views/viewEvents.js

@@ -0,0 +1,90 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+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 viewEvents_exports = {};
+__export(viewEvents_exports, {
+  DATA_SOURCE_DIRTY_EVENT: () => DATA_SOURCE_DIRTY_EVENT,
+  ENGINE_SCOPE_KEY: () => ENGINE_SCOPE_KEY,
+  VIEW_ACTIVATED_EVENT: () => VIEW_ACTIVATED_EVENT,
+  VIEW_ACTIVATED_VERSION: () => VIEW_ACTIVATED_VERSION,
+  VIEW_ENGINE_SCOPE: () => VIEW_ENGINE_SCOPE,
+  bumpViewActivatedVersion: () => bumpViewActivatedVersion,
+  getEmitterViewActivatedVersion: () => getEmitterViewActivatedVersion,
+  resolveOpenerEngine: () => resolveOpenerEngine
+});
+module.exports = __toCommonJS(viewEvents_exports);
+const VIEW_ACTIVATED_VERSION = Symbol.for("__NOCOBASE_VIEW_ACTIVATED_VERSION__");
+const VIEW_ACTIVATED_EVENT = "view:activated";
+const DATA_SOURCE_DIRTY_EVENT = "dataSource:dirty";
+const ENGINE_SCOPE_KEY = "__NOCOBASE_ENGINE_SCOPE__";
+const VIEW_ENGINE_SCOPE = "view";
+function getEmitterViewActivatedVersion(emitter) {
+  const raw = Reflect.get(emitter, VIEW_ACTIVATED_VERSION);
+  const num = typeof raw === "number" ? raw : Number(raw);
+  return Number.isFinite(num) && num > 0 ? num : 0;
+}
+__name(getEmitterViewActivatedVersion, "getEmitterViewActivatedVersion");
+function bumpViewActivatedVersion(emitter) {
+  const current = getEmitterViewActivatedVersion(emitter);
+  if (!Object.isExtensible(emitter)) return current;
+  const next = current + 1;
+  Reflect.set(emitter, VIEW_ACTIVATED_VERSION, next);
+  return next;
+}
+__name(bumpViewActivatedVersion, "bumpViewActivatedVersion");
+function isViewEngine(engine) {
+  return Reflect.get(engine, ENGINE_SCOPE_KEY) === VIEW_ENGINE_SCOPE;
+}
+__name(isViewEngine, "isViewEngine");
+function findNearestViewEngine(engine) {
+  let cur = engine;
+  let guard = 0;
+  while (cur && guard++ < 50) {
+    if (isViewEngine(cur)) return cur;
+    cur = cur.previousEngine;
+  }
+}
+__name(findNearestViewEngine, "findNearestViewEngine");
+function resolveOpenerEngine(parentEngine, scopedEngine) {
+  if (!parentEngine) return void 0;
+  const parentViewEngine = findNearestViewEngine(parentEngine);
+  if (parentViewEngine) return parentViewEngine;
+  const previousEngine = scopedEngine == null ? void 0 : scopedEngine.previousEngine;
+  return findNearestViewEngine(previousEngine) || parentEngine;
+}
+__name(resolveOpenerEngine, "resolveOpenerEngine");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DATA_SOURCE_DIRTY_EVENT,
+  ENGINE_SCOPE_KEY,
+  VIEW_ACTIVATED_EVENT,
+  VIEW_ACTIVATED_VERSION,
+  VIEW_ENGINE_SCOPE,
+  bumpViewActivatedVersion,
+  getEmitterViewActivatedVersion,
+  resolveOpenerEngine
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/flow-engine",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.20",
   "private": false,
   "description": "A standalone flow engine for NocoBase, managing workflows, models, and actions.",
   "main": "lib/index.js",
@@ -8,8 +8,8 @@
   "dependencies": {
     "@formily/antd-v5": "1.x",
     "@formily/reactive": "2.x",
-    "@nocobase/sdk": "2.0.0-beta.2",
-    "@nocobase/shared": "2.0.0-beta.2",
+    "@nocobase/sdk": "2.0.0-beta.20",
+    "@nocobase/shared": "2.0.0-beta.20",
     "ahooks": "^3.7.2",
     "dayjs": "^1.11.9",
     "dompurify": "^3.0.2",
@@ -36,5 +36,5 @@
   ],
   "author": "NocoBase Team",
   "license": "AGPL-3.0",
-  "gitHead": "b77a33ee933ae6e09d2d5dce017ca15d8552d57b"
+  "gitHead": "f4ab788fc6c17915157617026dfbba6f0d78eaac"
 }

package/src/BlockScopedFlowEngine.ts

@@ -31,16 +31,13 @@ export function createBlockScopedEngine(parent: FlowEngine): FlowEngine {
   local.context.addDelegate(parent.context);
 
   // 覆盖 unlinkFromStack：BlockScoped 引擎被移除时，修复前后指针，避免“截断”后续视图/作用域
-  const originalUnlink = local.unlinkFromStack.bind(local);
   local.unlinkFromStack = function () {
-    // 修复指针：prev -> next，next -> prev，然后清理自身指针
-    // 若不这么做，移除位于中间的 block 引擎会导致后续整段链丢失
     const prev = (local as any)._previousEngine as FlowEngine | undefined;
     const next = (local as any)._nextEngine as FlowEngine | undefined;
     if (prev) (prev as any)._nextEngine = next;
     if (next) (next as any)._previousEngine = prev;
-    (local as any)._previousEngine = undefined as any;
-    (local as any)._nextEngine = undefined as any;
+    (local as any)._previousEngine = undefined;
+    (local as any)._nextEngine = undefined;
   };
 
   // 默认全部代理到父引擎，只有少数字段（实例/缓存/执行器/上下文/链表指针）使用本地值

package/src/JSRunner.ts

@@ -13,6 +13,12 @@ export interface JSRunnerOptions {
   timeoutMs?: number;
   globals?: Record<string, any>;
   version?: string;
+  /**
+   * Enable RunJS template compatibility preprocessing for `{{ ... }}`.
+   * When enabled via `ctx.runjs(code, vars, { preprocessTemplates: true })` (default),
+   * the code will be rewritten to call `ctx.resolveJsonTemplate(...)` at runtime.
+   */
+  preprocessTemplates?: boolean;
 }
 
 export class JSRunner {
@@ -55,7 +61,8 @@ export class JSRunner {
     error?: any;
     timeout?: boolean;
   }> {
-    if (location?.search.includes('skipRunJs=true')) {
+    const search = typeof location !== 'undefined' ? location.search : undefined;
+    if (typeof search === 'string' && search.includes('skipRunJs=true')) {
       return { success: true, value: null };
     }
     const wrapped = `(async () => {

package/src/ViewScopedFlowEngine.ts

@@ -8,6 +8,7 @@
  */
 
 import { FlowEngine } from './flowEngine';
+import { ENGINE_SCOPE_KEY, VIEW_ENGINE_SCOPE } from './views/viewEvents';
 
 /**
  * ViewScopedFlowEngine（视图作用域引擎）
@@ -24,6 +25,8 @@ import { FlowEngine } from './flowEngine';
  */
 export function createViewScopedEngine(parent: FlowEngine): FlowEngine {
   const local = new FlowEngine();
+  // Mark for view-stack traversal (used by view activation events).
+  Object.defineProperty(local, ENGINE_SCOPE_KEY, { value: VIEW_ENGINE_SCOPE, configurable: true });
   if (parent.modelRepository) {
     local.setModelRepository(parent.modelRepository);
   }
@@ -43,6 +46,7 @@ export function createViewScopedEngine(parent: FlowEngine): FlowEngine {
     '_applyFlowCache',
     'executor',
     'context',
+    ENGINE_SCOPE_KEY,
     'previousEngine',
     'nextEngine',
     // 调度器与事件总线局部化

package/src/__tests__/createViewMeta.popup.test.ts

@@ -13,7 +13,7 @@ import { FlowEngine } from '../flowEngine';
 import type { FlowView } from '../views/FlowView';
 import { createPopupMeta } from '../views/createViewMeta';
 
-describe('createViewMeta - popup variables', () => {
+describe('createPopupMeta - popup variables', () => {
   function makeCtx() {
     const engine = new FlowEngine();
     const ctx = new FlowContext();
@@ -139,4 +139,65 @@ describe('createViewMeta - popup variables', () => {
     expect((props.record as any).title).toBe('Current popup record');
     expect((props.record as any).hasChildren).toBe(true);
   });
+
+  it('treats views with openerUids as popup (meta visible)', async () => {
+    const { ctx } = makeCtx();
+
+    // openerUids 作为路由栈缺失时的兜底标记：即使没有 navigation.viewStack，也应展示 ctx.popup 元信息
+    const anchorView: FlowView = {
+      type: 'dialog',
+      inputArgs: {
+        openerUids: ['opener-uid-1'],
+        viewUid: 'popup-uid',
+        dataSourceKey: 'main',
+        collectionName: 'posts',
+        filterByTk: 1,
+      },
+      Header: null,
+      Footer: null,
+      close: () => void 0,
+      update: () => void 0,
+    } as any;
+
+    const meta = (await createPopupMeta(ctx, anchorView)())!;
+    expect(typeof meta.hidden).toBe('function');
+    expect((meta.hidden as any)()).toBe(false);
+    expect(typeof meta.disabled).toBe('function');
+    expect((meta.disabled as any)()).toBe(false);
+
+    const vars = (await meta.buildVariablesParams!(ctx)) as any;
+    expect(vars).toBeTruthy();
+    expect(vars.record).toEqual({
+      collection: 'posts',
+      dataSourceKey: 'main',
+      filterByTk: 1,
+      associationName: undefined,
+      sourceId: undefined,
+    });
+  });
+
+  it('does not expose popup.record without filterByTk', async () => {
+    const { ctx } = makeCtx();
+
+    const anchorView: FlowView = {
+      type: 'dialog',
+      inputArgs: {
+        openerUids: ['opener-uid-1'],
+        viewUid: 'popup-uid',
+        dataSourceKey: 'main',
+        collectionName: 'posts',
+        // filterByTk 缺失：不应展示“当前弹窗记录”变量
+      },
+      Header: null,
+      Footer: null,
+      close: () => void 0,
+      update: () => void 0,
+    } as any;
+
+    ctx.defineProperty('view', { value: anchorView });
+
+    const meta = (await createPopupMeta(ctx, anchorView)())!;
+    const props = typeof meta.properties === 'function' ? await (meta.properties as any)() : meta.properties || {};
+    expect(props.record).toBeUndefined();
+  });
 });

package/src/__tests__/flowEngine.dataSourceDirty.test.ts

@@ -0,0 +1,63 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * 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 { describe, expect, it, vi } from 'vitest';
+import { FlowEngine } from '../flowEngine';
+import { MultiRecordResource } from '../resources/multiRecordResource';
+import { SingleRecordResource } from '../resources/singleRecordResource';
+
+describe('FlowEngine dataSource dirty registry', () => {
+  it('tracks versions per dataSourceKey + resourceName', () => {
+    const engine = new FlowEngine();
+
+    expect(engine.getDataSourceDirtyVersion('main', 'posts')).toBe(0);
+    expect(engine.markDataSourceDirty('main', 'posts')).toBe(1);
+    expect(engine.getDataSourceDirtyVersion('main', 'posts')).toBe(1);
+
+    expect(engine.markDataSourceDirty('main', 'posts')).toBe(2);
+    expect(engine.getDataSourceDirtyVersion('main', 'posts')).toBe(2);
+
+    // different resource
+    expect(engine.getDataSourceDirtyVersion('main', 'users')).toBe(0);
+    expect(engine.markDataSourceDirty('main', 'users')).toBe(1);
+    expect(engine.getDataSourceDirtyVersion('main', 'users')).toBe(1);
+
+    // different data source
+    expect(engine.getDataSourceDirtyVersion('ds2', 'posts')).toBe(0);
+    expect(engine.markDataSourceDirty('ds2', 'posts')).toBe(1);
+    expect(engine.getDataSourceDirtyVersion('ds2', 'posts')).toBe(1);
+    // main unchanged
+    expect(engine.getDataSourceDirtyVersion('main', 'posts')).toBe(2);
+  });
+
+  it('marks dirty on record write operations (single & multi)', async () => {
+    const engine = new FlowEngine();
+    const markSpy = vi.spyOn(engine, 'markDataSourceDirty');
+
+    const single = engine.createResource(SingleRecordResource);
+    single.setDataSourceKey('main');
+    single.setResourceName('posts');
+    // avoid network: stub runAction + refresh
+    (single as any).runAction = vi.fn().mockResolvedValue({ data: {}, meta: {} });
+    (single as any).refresh = vi.fn().mockResolvedValue(undefined);
+    await single.save({ title: 't' } as any, { refresh: false });
+    expect(markSpy).toHaveBeenCalledWith('main', 'posts');
+
+    const multi = engine.createResource(MultiRecordResource);
+    multi.setDataSourceKey('main');
+    multi.setResourceName('users.profile');
+    (multi as any).runAction = vi.fn().mockResolvedValue({ data: [], meta: {} });
+    (multi as any).refresh = vi.fn().mockResolvedValue(undefined);
+    await multi.create({ name: 'n' } as any, { refresh: false });
+    // exact association
+    expect(markSpy).toHaveBeenCalledWith('main', 'users.profile');
+    // plus root collection (safety)
+    expect(markSpy).toHaveBeenCalledWith('main', 'users');
+  });
+});

package/src/__tests__/flowSettings.open.test.tsx

@@ -12,6 +12,7 @@ import { screen } from '@testing-library/react';
 import { FlowSettings } from '../flowSettings';
 import { FlowModel } from '../models';
 import { FlowEngine } from '../flowEngine';
+import { GLOBAL_EMBED_CONTAINER_ID } from '../views';
 
 // We will stub viewer directly on model.context in tests
 
@@ -1087,18 +1088,18 @@ describe('FlowSettings.open rendering behavior', () => {
 
     // Create mock DOM element for embed target
     const mockTarget = document.createElement('div');
-    mockTarget.id = 'nocobase-embed-container';
+    mockTarget.id = GLOBAL_EMBED_CONTAINER_ID;
     mockTarget.style.width = 'auto';
     mockTarget.style.maxWidth = 'none';
     document.body.appendChild(mockTarget);
 
     // Mock querySelector to return our mock element
-    const originalQuerySelector = document.querySelector;
-    document.querySelector = vi.fn((selector) => {
-      if (selector === '#nocobase-embed-container') {
+    const originalQuerySelector = document.querySelector.bind(document);
+    const querySelectorSpy = vi.spyOn(document, 'querySelector').mockImplementation((selector: string) => {
+      if (selector === `#${GLOBAL_EMBED_CONTAINER_ID}`) {
         return mockTarget;
       }
-      return originalQuerySelector.call(document, selector);
+      return originalQuerySelector(selector);
     });
 
     const M = model.constructor as any;
@@ -1164,7 +1165,61 @@ describe('FlowSettings.open rendering behavior', () => {
 
     // Cleanup
     document.body.removeChild(mockTarget);
-    document.querySelector = originalQuerySelector;
+    querySelectorSpy.mockRestore();
+  });
+
+  it('does not clear embed target DOM before opening (avoids portal unmount errors)', async () => {
+    const engine = new FlowEngine();
+    const flowSettings = new FlowSettings(engine);
+    const model = new FlowModel({ uid: 'm-embed-no-clear', flowEngine: engine });
+
+    const mockTarget = document.createElement('div');
+    mockTarget.id = GLOBAL_EMBED_CONTAINER_ID;
+    mockTarget.innerHTML = '<div data-testid="existing">Existing</div>';
+    document.body.appendChild(mockTarget);
+
+    const originalQuerySelector = document.querySelector.bind(document);
+    const querySelectorSpy = vi.spyOn(document, 'querySelector').mockImplementation((selector: string) => {
+      if (selector === `#${GLOBAL_EMBED_CONTAINER_ID}`) {
+        return mockTarget;
+      }
+      return originalQuerySelector(selector);
+    });
+
+    const M = model.constructor as any;
+    M.registerFlow({
+      key: 'embedNoClearFlow',
+      steps: {
+        step: {
+          title: 'Step',
+          uiSchema: { f: { type: 'string', 'x-component': 'Input' } },
+        },
+      },
+    });
+
+    const embed = vi.fn((opts: any) => {
+      // The existing DOM should not be wiped out before opening the embed view.
+      expect(mockTarget.querySelector('[data-testid="existing"]')).toBeTruthy();
+      const dlg = { close: vi.fn(), Footer: (p: any) => null } as any;
+      if (typeof opts.content === 'function') opts.content(dlg, { defineMethod: vi.fn() });
+      return dlg;
+    });
+
+    model.context.defineProperty('viewer', { value: { embed } });
+    model.context.defineProperty('message', { value: { info: vi.fn(), error: vi.fn(), success: vi.fn() } });
+
+    await flowSettings.open({
+      model,
+      flowKey: 'embedNoClearFlow',
+      stepKey: 'step',
+      uiMode: 'embed',
+    } as any);
+
+    expect(embed).toHaveBeenCalledTimes(1);
+    expect(mockTarget.querySelector('[data-testid="existing"]')).toBeTruthy();
+
+    document.body.removeChild(mockTarget);
+    querySelectorSpy.mockRestore();
   });
 
   it('uses embed uiMode with default props when target element exists', async () => {
@@ -1174,16 +1229,16 @@ describe('FlowSettings.open rendering behavior', () => {
 
     // Create mock DOM element for embed target
     const mockTarget = document.createElement('div');
-    mockTarget.id = 'nocobase-embed-container';
+    mockTarget.id = GLOBAL_EMBED_CONTAINER_ID;
     document.body.appendChild(mockTarget);
 
     // Mock querySelector
-    const originalQuerySelector = document.querySelector;
-    document.querySelector = vi.fn((selector) => {
-      if (selector === '#nocobase-embed-container') {
+    const originalQuerySelector = document.querySelector.bind(document);
+    const querySelectorSpy = vi.spyOn(document, 'querySelector').mockImplementation((selector: string) => {
+      if (selector === `#${GLOBAL_EMBED_CONTAINER_ID}`) {
         return mockTarget;
       }
-      return originalQuerySelector.call(document, selector);
+      return originalQuerySelector(selector);
     });
 
     const M = model.constructor as any;
@@ -1223,7 +1278,7 @@ describe('FlowSettings.open rendering behavior', () => {
 
     // Cleanup
     document.body.removeChild(mockTarget);
-    document.querySelector = originalQuerySelector;
+    querySelectorSpy.mockRestore();
   });
 
   it('handles embed uiMode when target element is not found', async () => {
@@ -1232,8 +1287,7 @@ describe('FlowSettings.open rendering behavior', () => {
     const model = new FlowModel({ uid: 'm-embed-no-target', flowEngine: engine });
 
     // Mock querySelector to return null (target not found)
-    const originalQuerySelector = document.querySelector;
-    document.querySelector = vi.fn(() => null);
+    const querySelectorSpy = vi.spyOn(document, 'querySelector').mockReturnValue(null);
 
     const M = model.constructor as any;
     M.registerFlow({
@@ -1266,7 +1320,7 @@ describe('FlowSettings.open rendering behavior', () => {
     expect(embed).toHaveBeenCalledTimes(1);
 
     // Restore querySelector
-    document.querySelector = originalQuerySelector;
+    querySelectorSpy.mockRestore();
   });
 
   it('handles error in function-based step uiMode gracefully', async () => {

package/src/__tests__/provider.test.tsx

@@ -14,11 +14,6 @@ import { FlowEngine } from '../flowEngine';
 import { FlowEngineProvider, useFlowEngine } from '../provider';
 
 describe('FlowEngineProvider/useFlowEngine', () => {
-  it('throws without provider', () => {
-    const run = () => renderHook(() => useFlowEngine());
-    expect(run).toThrow(/FlowEngineProvider/);
-  });
-
   it('returns engine within provider', () => {
     const engine = new FlowEngine();
     const wrapper = ({ children }: any) => <FlowEngineProvider engine={engine}>{children}</FlowEngineProvider>;