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

package/src/views/__tests__/useDialog.closeDestroy.test.tsx

@@ -26,6 +26,7 @@ vi.mock('../../ViewScopedFlowEngine', () => ({
   createViewScopedEngine: (engine) => ({
     context: new FlowContext(),
     unlinkFromStack: vi.fn(),
+    setDestroyView: vi.fn(),
     // mimic real view stack linkage: previousEngine points to the last engine in chain
     previousEngine: (engine as any)?.nextEngine || engine,
   }),
@@ -75,40 +76,40 @@ describe('useDialog - close/destroy logic', () => {
     return api;
   };
 
-  it('should call destroy (and thus closeFunc) when close is called without preventClose', () => {
+  it('should call destroy (and thus closeFunc) when close is called without preventClose', async () => {
     const api = renderUseDialog();
     const flowContext = createMockFlowContext();
 
     const dialog = api.open({}, flowContext);
 
-    dialog.close();
+    await dialog.close();
 
     expect(mockCloseFunc).toHaveBeenCalled();
   });
 
-  it('should not call destroy (and thus closeFunc) when close is called with preventClose=true', () => {
+  it('should not call destroy (and thus closeFunc) when close is called with preventClose=true', async () => {
     const api = renderUseDialog();
     const flowContext = createMockFlowContext();
 
     const dialog = api.open({ preventClose: true }, flowContext);
 
-    dialog.close();
+    await dialog.close();
 
     expect(mockCloseFunc).not.toHaveBeenCalled();
   });
 
-  it('should call destroy (and thus closeFunc) when close is called with preventClose=true but force=true', () => {
+  it('should call destroy (and thus closeFunc) when close is called with preventClose=true but force=true', async () => {
     const api = renderUseDialog();
     const flowContext = createMockFlowContext();
 
     const dialog = api.open({ preventClose: true }, flowContext);
 
-    dialog.close(undefined, true);
+    await dialog.close(undefined, true);
 
     expect(mockCloseFunc).toHaveBeenCalled();
   });
 
-  it('should delegate to navigation.back when triggerByRouter is true', () => {
+  it('should delegate to navigation.back when triggerByRouter is true', async () => {
     const api = renderUseDialog();
     const flowContext = createMockFlowContext();
     const backMock = vi.fn();
@@ -125,25 +126,25 @@ describe('useDialog - close/destroy logic', () => {
       flowContext,
     );
 
-    dialog.close();
+    await dialog.close();
 
     expect(backMock).toHaveBeenCalled();
     // Should not call destroy directly, let router handle it
     expect(mockCloseFunc).not.toHaveBeenCalled();
   });
 
-  it('should emit view activated event on opener engine', () => {
+  it('should emit view activated event on opener engine', async () => {
     const api = renderUseDialog();
     const flowContext = createMockFlowContext();
     const emitSpy = flowContext.engine.emitter.emit;
 
     const dialog = api.open({ inputArgs: { viewUid: 'child-view' } }, flowContext);
 
-    dialog.close();
+    await dialog.close();
     expect(emitSpy).toHaveBeenCalledWith('view:activated', expect.anything());
   });
 
-  it('should emit view events on immediate opener engine (previousEngine) when present', () => {
+  it('should emit view events on immediate opener engine (previousEngine) when present', async () => {
     const api = renderUseDialog();
     const flowContext = createMockFlowContext();
     const rootEmitSpy = flowContext.engine.emitter.emit;
@@ -152,7 +153,7 @@ describe('useDialog - close/destroy logic', () => {
 
     const dialog = api.open({ inputArgs: { viewUid: 'child-view' } }, flowContext);
 
-    dialog.close();
+    await dialog.close();
     expect(openerEmitSpy).toHaveBeenCalledWith('view:activated', expect.anything());
     expect(rootEmitSpy).not.toHaveBeenCalledWith('view:activated', expect.anything());
   });

package/src/views/runViewBeforeClose.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 type { FlowView, FlowViewBeforeClosePayload } from './FlowView';
+
+export async function runViewBeforeClose(view: FlowView, payload: FlowViewBeforeClosePayload): Promise<boolean> {
+  if (payload.force) {
+    return true;
+  }
+
+  const result = await view.beforeClose?.(payload);
+  return result !== false;
+}

package/src/views/useDialog.tsx

@@ -19,6 +19,7 @@ import { VIEW_ACTIVATED_EVENT, bumpViewActivatedVersion, resolveOpenerEngine } f
 import { FlowEngineProvider } from '../provider';
 import { createViewScopedEngine } from '../ViewScopedFlowEngine';
 import { createViewRecordResolveOnServer, getViewRecordFromParent } from '../utils/variablesParams';
+import { runViewBeforeClose } from './runViewBeforeClose';
 
 let uuid = 0;
 
@@ -89,12 +90,18 @@ export function useDialog() {
       ctx.addDelegate(flowContext.engine.context);
     }
 
+    // 幂等保护：防止 FlowPage 路由清理时二次调用 destroy
+    let destroyed = false;
+
     // 构造 currentDialog 实例
     const currentDialog = {
       type: 'dialog' as const,
       inputArgs: config.inputArgs || {},
       preventClose: !!config.preventClose,
+      beforeClose: undefined,
       destroy: (result?: any) => {
+        if (destroyed) return;
+        destroyed = true;
         config.onClose?.();
         dialogRef.current?.destroy();
         closeFunc?.();
@@ -107,18 +114,24 @@ export function useDialog() {
         scopedEngine.unlinkFromStack();
       },
       update: (newConfig) => dialogRef.current?.update(newConfig),
-      close: (result?: any, force?: boolean) => {
+      close: async (result?: any, force?: boolean) => {
         if (config.preventClose && !force) {
-          return;
+          return false;
+        }
+
+        const shouldClose = await runViewBeforeClose(currentDialog, { result, force });
+        if (!shouldClose) {
+          return false;
         }
 
         if (config.triggerByRouter && config.inputArgs?.navigation?.back) {
           // 交由路由系统来销毁当前视图
           config.inputArgs.navigation.back();
-          return;
+          return true;
         }
 
         currentDialog.destroy(result);
+        return true;
       },
       Footer: FooterComponent,
       Header: HeaderComponent,
@@ -140,6 +153,15 @@ export function useDialog() {
       get: () => currentDialog,
       resolveOnServer: createViewRecordResolveOnServer(ctx, () => getViewRecordFromParent(flowContext, ctx)),
     });
+    // 注册视图销毁回调，供外部（如 afterSuccess）通过引擎栈遍历来关闭多层弹窗。
+    // 对路由触发的弹窗：先 navigation.back() 清理 URL（replace 方式），再 destroy() 立即移除元素；
+    // 对非路由弹窗：直接 destroy()。destroy() 已做幂等保护，FlowPage 后续清理不会重复执行。
+    scopedEngine.setDestroyView(() => {
+      if (config.triggerByRouter && config.inputArgs?.navigation?.back) {
+        config.inputArgs.navigation.back();
+      }
+      currentDialog.destroy();
+    });
     // 顶层 popup 变量：弹窗记录/数据源/上级弹窗链（去重封装）
     registerPopupVariable(ctx, currentDialog);
     // 内部组件，在 Provider 内部计算 content

package/src/views/useDrawer.tsx

@@ -19,6 +19,7 @@ import { VIEW_ACTIVATED_EVENT, bumpViewActivatedVersion, resolveOpenerEngine } f
 import { FlowEngineProvider } from '../provider';
 import { createViewScopedEngine } from '../ViewScopedFlowEngine';
 import { createViewRecordResolveOnServer, getViewRecordFromParent } from '../utils/variablesParams';
+import { runViewBeforeClose } from './runViewBeforeClose';
 
 export function useDrawer() {
   const holderRef = React.useRef(null);
@@ -118,12 +119,18 @@ export function useDrawer() {
       ctx.addDelegate(flowContext.engine.context);
     }
 
+    // 幂等保护：防止 FlowPage 路由清理时二次调用 destroy
+    let destroyed = false;
+
     // 构造 currentDrawer 实例
     const currentDrawer = {
       type: 'drawer' as const,
       inputArgs: config.inputArgs || {},
       preventClose: !!config.preventClose,
+      beforeClose: undefined,
       destroy: (result?: any) => {
+        if (destroyed) return;
+        destroyed = true;
         config.onClose?.();
         drawerRef.current?.destroy();
         closeFunc?.();
@@ -136,18 +143,24 @@ export function useDrawer() {
         scopedEngine.unlinkFromStack();
       },
       update: (newConfig) => drawerRef.current?.update(newConfig),
-      close: (result?: any, force?: boolean) => {
+      close: async (result?: any, force?: boolean) => {
         if (config.preventClose && !force) {
-          return;
+          return false;
+        }
+
+        const shouldClose = await runViewBeforeClose(currentDrawer, { result, force });
+        if (!shouldClose) {
+          return false;
         }
 
         if (config.triggerByRouter && config.inputArgs?.navigation?.back) {
           // 交由路由系统来销毁当前视图
           config.inputArgs.navigation.back();
-          return;
+          return true;
         }
 
         currentDrawer.destroy(result);
+        return true;
       },
       Footer: FooterComponent,
       Header: HeaderComponent,
@@ -169,6 +182,15 @@ export function useDrawer() {
       get: () => currentDrawer,
       resolveOnServer: createViewRecordResolveOnServer(ctx, () => getViewRecordFromParent(flowContext, ctx)),
     });
+    // 注册视图销毁回调，供外部（如 afterSuccess）通过引擎栈遍历来关闭多层弹窗。
+    // 对路由触发的弹窗：先 navigation.back() 清理 URL（replace 方式），再 destroy() 立即移除元素；
+    // 对非路由弹窗：直接 destroy()。destroy() 已做幂等保护，FlowPage 后续清理不会重复执行。
+    scopedEngine.setDestroyView(() => {
+      if (config.triggerByRouter && config.inputArgs?.navigation?.back) {
+        config.inputArgs.navigation.back();
+      }
+      currentDrawer.destroy();
+    });
     // 顶层 popup 变量：弹窗记录/数据源/上级弹窗链（去重封装）
     registerPopupVariable(ctx, currentDrawer);
 

package/src/views/usePage.tsx

@@ -19,6 +19,7 @@ import { VIEW_ACTIVATED_EVENT, bumpViewActivatedVersion, resolveOpenerEngine } f
 import { FlowEngineProvider } from '../provider';
 import { createViewScopedEngine } from '../ViewScopedFlowEngine';
 import { createViewRecordResolveOnServer, getViewRecordFromParent } from '../utils/variablesParams';
+import { runViewBeforeClose } from './runViewBeforeClose';
 
 let uuid = 0;
 
@@ -122,6 +123,7 @@ export function usePage() {
       type: 'embed' as const,
       inputArgs: viewInputArgs,
       preventClose: !!config.preventClose,
+      beforeClose: undefined,
       destroy: (result?: any) => {
         config.onClose?.();
         resolvePromise?.(result);
@@ -145,18 +147,24 @@ export function usePage() {
         scopedEngine.unlinkFromStack();
       },
       update: (newConfig) => pageRef.current?.update(newConfig),
-      close: (result?: any, force?: boolean) => {
+      close: async (result?: any, force?: boolean) => {
         if (preventClose && !force) {
-          return;
+          return false;
+        }
+
+        const shouldClose = await runViewBeforeClose(currentPage, { result, force });
+        if (!shouldClose) {
+          return false;
         }
 
         if (config.triggerByRouter && config.inputArgs?.navigation?.back) {
           // 交由路由系统来销毁当前视图
           config.inputArgs.navigation.back();
-          return;
+          return true;
         }
 
         currentPage.destroy(result);
+        return true;
       },
       Header: HeaderComponent,
       Footer: FooterComponent,
@@ -178,6 +186,7 @@ export function usePage() {
       // 仅当访问关联字段或前端无本地记录数据时，才交给服务端解析
       resolveOnServer: createViewRecordResolveOnServer(ctx, () => getViewRecordFromParent(flowContext, ctx)),
     });
+    // embed 视图不注册 destroyView，afterSuccess 关闭弹窗时自然跳过
     // 顶层 popup 变量：弹窗记录/数据源/上级弹窗链（去重封装）
     registerPopupVariable(ctx, currentPage);