@nocobase/client-v2 2.1.0-beta.37 → 2.1.0-beta.38

package/src/flow/FlowPage.tsx

@@ -7,15 +7,33 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-import { FlowModelRenderer, useFlowEngine, useFlowModelById, useFlowViewContext } from '@nocobase/flow-engine';
-import type { FlowModel } from '@nocobase/flow-engine';
+import {
+  FlowModelRenderer,
+  isInheritedFrom,
+  useFlowEngine,
+  useFlowModelById,
+  useFlowViewContext,
+} from '@nocobase/flow-engine';
+import type { FlowModel, FlowModelRendererProps, ModelConstructor } from '@nocobase/flow-engine';
 import { useRequest } from 'ahooks';
 import React from 'react';
 import FlowRoute from './components/FlowRoute';
 import { SkeletonFallback } from './components/SkeletonFallback';
+import { ChildPageModel } from './models';
 
-function InternalFlowPage({ uid, ...props }) {
+const defaultPageFlowSettings: FlowModelRendererProps['showFlowSettings'] = {
+  showBackground: false,
+  showBorder: false,
+};
+
+function InternalFlowPage({
+  uid,
+  showFlowSettings,
+  ...props
+}: { uid: string; showFlowSettings?: FlowModelRendererProps['showFlowSettings'] } & Record<string, unknown>) {
   const model = useFlowModelById(uid);
+  const resolvedShowFlowSettings = showFlowSettings ?? model?.props?.showFlowSettings ?? defaultPageFlowSettings;
+
   return (
     <FlowModelRenderer
       model={model}
@@ -25,7 +43,7 @@ function InternalFlowPage({ uid, ...props }) {
         />
       }
       hideRemoveInSettings
-      showFlowSettings={{ showBackground: false, showBorder: false }}
+      showFlowSettings={resolvedShowFlowSettings}
       {...props}
     />
   );
@@ -36,14 +54,21 @@ type FlowPageProps = {
   parentId?: string;
   onModelLoaded?: (uid: string, model: FlowModel) => void;
   defaultTabTitle?: string;
+  showFlowSettings?: FlowModelRendererProps['showFlowSettings'];
 };
 
 export const FlowPage = React.memo((props: FlowPageProps & Record<string, unknown>) => {
   const { pageModelClass = 'ChildPageModel', parentId, onModelLoaded, defaultTabTitle, ...rest } = props;
   const flowEngine = useFlowEngine();
   const ctx = useFlowViewContext();
-  const { loading, data } = useRequest(
+  const { loading, data, error } = useRequest(
     async () => {
+      const ModelClass = await flowEngine.getModelClassAsync(pageModelClass);
+      if (!ModelClass) {
+        throw new Error(`[NocoBase] Page model class '${pageModelClass}' is not registered.`);
+      }
+      const shouldInjectDefaultChildTab =
+        ModelClass === ChildPageModel || isInheritedFrom(ModelClass as ModelConstructor, ChildPageModel);
       const options = {
         async: true,
         parentId,
@@ -51,7 +76,7 @@ export const FlowPage = React.memo((props: FlowPageProps & Record<string, unknow
         subType: 'object',
         use: pageModelClass,
       };
-      if (pageModelClass === 'ChildPageModel') {
+      if (shouldInjectDefaultChildTab) {
         const tabTitle = defaultTabTitle || flowEngine.translate?.('Details');
         options['subModels'] = {
           tabs: [
@@ -86,9 +111,12 @@ export const FlowPage = React.memo((props: FlowPageProps & Record<string, unknow
       return data;
     },
     {
-      refreshDeps: [parentId],
+      refreshDeps: [parentId, pageModelClass, defaultTabTitle],
     },
   );
+  if (error) {
+    throw error;
+  }
   if (loading || !data?.uid) {
     return <SkeletonFallback style={{ margin: ctx?.isMobileLayout ? 8 : ctx?.themeToken.marginBlock }} />;
   }

package/src/flow/__tests__/FlowPage.test.tsx

@@ -0,0 +1,79 @@
+/**
+ * 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 { render } from '@testing-library/react';
+import React from 'react';
+import { afterEach, describe, expect, it, vi } from 'vitest';
+import { FlowPage } from '../FlowPage';
+
+const mocks = vi.hoisted(() => ({
+  rendererProps: undefined as any,
+  model: {
+    uid: 'public-form-page',
+    props: {
+      showFlowSettings: false,
+    },
+    context: {
+      isMobileLayout: false,
+      themeToken: {
+        marginBlock: 16,
+      },
+    },
+  },
+}));
+
+vi.mock('@nocobase/flow-engine', async () => {
+  const actual = await vi.importActual<any>('@nocobase/flow-engine');
+  const ReactModule = await import('react');
+
+  return {
+    ...actual,
+    FlowModelRenderer: vi.fn((props: any) => {
+      mocks.rendererProps = props;
+      return ReactModule.createElement('div', { 'data-testid': 'flow-model-renderer' });
+    }),
+    useFlowEngine: vi.fn(() => ({
+      getModelClassAsync: vi.fn(),
+      loadOrCreateModel: vi.fn(),
+      context: {},
+    })),
+    useFlowModelById: vi.fn(() => mocks.model),
+    useFlowViewContext: vi.fn(() => ({
+      themeToken: {
+        marginBlock: 16,
+      },
+    })),
+  };
+});
+
+vi.mock('ahooks', async () => {
+  const actual = await vi.importActual<any>('ahooks');
+  return {
+    ...actual,
+    useRequest: vi.fn(() => ({
+      loading: false,
+      data: {
+        uid: 'public-form-page',
+      },
+      error: null,
+    })),
+  };
+});
+
+describe('FlowPage', () => {
+  afterEach(() => {
+    mocks.rendererProps = undefined;
+  });
+
+  it('uses showFlowSettings from page model props', () => {
+    render(<FlowPage />);
+
+    expect(mocks.rendererProps?.showFlowSettings).toBe(false);
+  });
+});