@nocobase/client-v2 3.0.0-alpha.1 → 3.0.0-alpha.11

package/src/__tests__/settings-center.test.tsx

@@ -8,11 +8,13 @@
  */
 
 import { ACLRolesCheckProvider, Plugin } from '@nocobase/client-v2';
-import { render, screen, waitFor, fireEvent } from '@testing-library/react';
+import { act, fireEvent, render, screen, waitFor, within } from '@testing-library/react';
 import React from 'react';
 import { message } from 'antd';
+import { vi } from 'vitest';
 import { AdminSettingsLayoutModel as ClientV2AdminSettingsLayoutModel } from '../settings-center';
 import { AdminSettingsLayoutModel as ClientV1AdminSettingsLayoutModel } from '../../../client/src/pm/AdminSettingsLayoutModel';
+import zhCN from '../../../client/src/locale/zh-CN.json';
 import { SettingsBuildInPlugin } from '../settings-app/SettingsBuildInPlugin';
 import { matchSettingsRoute, sortTopLevelSettings } from '../settings-center/utils';
 import { createMockSettingsClient } from './mockSettingsApplication';
@@ -44,12 +46,20 @@ const waitForGetRequests = async (app: MockClientApplication, urls: string[]) =>
 const mockAdminRuntime = (
   app: MockClientApplication,
   options: {
+    lang?: string;
     snippets?: string[];
     pmList?: any[];
+    resources?: Record<string, string>;
     systemSettings?: Record<string, any>;
   } = {},
 ) => {
-  const { snippets = ['pm', 'pm.system-settings.system-settings'], pmList = [], systemSettings = {} } = options;
+  const {
+    lang = 'en-US',
+    snippets = ['pm', 'pm.system-settings.system-settings'],
+    pmList = [],
+    resources = {},
+    systemSettings = {},
+  } = options;
 
   app.dataSourceManager.getCollection = ((name: string, collectionName: string) => {
     if (name === 'main' && collectionName === 'attachments') {
@@ -74,9 +84,9 @@ const mockAdminRuntime = (
   });
   app.apiMock.onGet('app:getLang').reply(200, {
     data: {
-      lang: 'en-US',
+      lang,
       resources: {
-        client: {},
+        client: resources,
       },
       cron: {},
     },
@@ -244,6 +254,50 @@ describe('settings center', () => {
     expect(await screen.findByText('Demo plugin')).toBeInTheDocument();
   });
 
+  it('should redirect to the admin app when the role cannot access settings', async () => {
+    const originalLocation = globalThis.window.location;
+    const originalModernClientPrefix = window.__nocobase_modern_client_prefix__;
+    const replace = vi.fn();
+    Object.defineProperty(globalThis.window, 'location', {
+      configurable: true,
+      value: {
+        ...originalLocation,
+        replace,
+      },
+    });
+    window.__nocobase_modern_client_prefix__ = 'v';
+
+    try {
+      const app = createMockSettingsClient({
+        plugins: [SettingsBuildInPlugin, TestAclPlugin],
+        router: { type: 'memory', initialEntries: ['/settings/system-settings'] },
+      });
+      mockAdminRuntime(app, {
+        snippets: ['!pm', '!pm.system-settings.system-settings'],
+      });
+
+      await renderApp(app);
+      await waitForGetRequests(app, ['/auth:check', 'roles:check']);
+
+      await waitFor(() => {
+        expect(replace).toHaveBeenCalledWith('/v/admin');
+      });
+      expect(
+        screen.queryByRole('heading', { name: 'Your current role cannot access Settings' }),
+      ).not.toBeInTheDocument();
+    } finally {
+      Object.defineProperty(globalThis.window, 'location', {
+        configurable: true,
+        value: originalLocation,
+      });
+      if (originalModernClientPrefix === undefined) {
+        delete window.__nocobase_modern_client_prefix__;
+      } else {
+        window.__nocobase_modern_client_prefix__ = originalModernClientPrefix;
+      }
+    }
+  });
+
   it('should hide plugin-manager menu item when pm snippet is missing', async () => {
     const app = createMockSettingsClient({
       plugins: [SettingsBuildInPlugin, TestAclPlugin],
@@ -265,12 +319,19 @@ describe('settings center', () => {
       plugins: [SettingsBuildInPlugin, TestAclPlugin],
       router: { type: 'memory', initialEntries: ['/settings/unknown'] },
     });
-    mockAdminRuntime(app);
+    mockAdminRuntime(app, {
+      snippets: ['!pm', '!pm.system-settings.system-settings'],
+    });
 
     await renderApp(app);
     await waitForGetRequests(app, ['/auth:check', 'roles:check']);
 
-    expect(await screen.findByText('Current settings page is unavailable')).toBeInTheDocument();
+    const result = await screen.findByRole('status');
+    expect(within(result).getByRole('heading', { name: 'Settings page not found' })).toBeInTheDocument();
+    expect(
+      within(result).getByText('The settings page you requested does not exist or has been removed.'),
+    ).toBeInTheDocument();
+    expect(app.router.state.location.pathname).toBe('/settings/unknown');
   });
 
   it('should allow direct access to hidden page without showing menu entry', async () => {
@@ -298,6 +359,7 @@ describe('settings center', () => {
 
     expect(await screen.findByText('Hidden settings page')).toBeInTheDocument();
     expect(screen.queryByRole('menuitem', { name: 'Hidden demo' })).not.toBeInTheDocument();
+    expect(app.router.state.location.pathname).toBe('/settings/hidden-demo');
   });
 
   it('should show route empty state when direct access page has no permission', async () => {
@@ -319,14 +381,248 @@ describe('settings center', () => {
       router: { type: 'memory', initialEntries: ['/settings/secure-demo'] },
     });
     mockAdminRuntime(app, {
+      lang: 'zh-CN',
+      resources: zhCN,
       snippets: ['pm', 'pm.system-settings.system-settings', '!pm.secure-demo.index'],
     });
 
     await renderApp(app);
     await waitForGetRequests(app, ['/auth:check', 'roles:check']);
 
-    expect(await screen.findByText('Current settings page is unavailable')).toBeInTheDocument();
+    const result = await screen.findByRole('status');
+    expect(within(result).getByRole('heading', { name: '当前角色无权访问设置中心' })).toBeInTheDocument();
+    expect(within(result).getByText('请切换至有权限的角色，或联系管理员获取访问权限。')).toBeInTheDocument();
     expect(screen.queryByText('Secure settings page')).not.toBeInTheDocument();
+    expect(app.router.state.location.pathname).toBe('/settings/secure-demo');
+  });
+
+  it('should redirect a denied settings tab to the first accessible tab', async () => {
+    const renderDeniedTab = vi.fn(() => <div>Denied tab content</div>);
+
+    class ProtectedSettingsTabsPlugin extends Plugin {
+      async load() {
+        this.pluginSettingsManager.addMenuItem({ key: 'protected-tabs', title: 'Protected tabs' });
+        this.pluginSettingsManager.addPageTabItem({
+          menuKey: 'protected-tabs',
+          key: 'a-second',
+          title: 'Second accessible tab',
+          aclSnippet: 'pm.protected-tabs.second',
+          sort: 20,
+          Component: () => <div>Second accessible tab content</div>,
+        });
+        this.pluginSettingsManager.addPageTabItem({
+          menuKey: 'protected-tabs',
+          key: 'z-first',
+          title: 'First accessible tab',
+          aclSnippet: 'pm.protected-tabs.first',
+          sort: 10,
+          Component: () => <div>First accessible tab content</div>,
+        });
+        this.pluginSettingsManager.addPageTabItem({
+          menuKey: 'protected-tabs',
+          key: 'denied',
+          title: 'Denied tab',
+          aclSnippet: 'pm.protected-tabs.denied',
+          sort: 30,
+          Component: renderDeniedTab,
+        });
+      }
+    }
+
+    const app = createMockSettingsClient({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin, ProtectedSettingsTabsPlugin],
+      router: { type: 'memory', initialEntries: ['/settings/protected-tabs/denied'] },
+    });
+    mockAdminRuntime(app, {
+      snippets: ['pm', '!pm.protected-tabs.denied'],
+    });
+
+    await renderApp(app);
+    await waitForGetRequests(app, ['/auth:check', 'roles:check']);
+
+    await waitFor(() => {
+      expect(app.router.router.state.location.pathname).toBe('/settings/protected-tabs/z-first');
+    });
+    expect(app.router.router.state.historyAction).toBe('REPLACE');
+    expect(await screen.findByText('First accessible tab content')).toBeInTheDocument();
+    expect(screen.queryByText('Denied tab content')).not.toBeInTheDocument();
+    expect(renderDeniedTab).not.toHaveBeenCalled();
+
+    await act(async () => {
+      await app.router.router.navigate('/settings/protected-tabs/a-second');
+    });
+
+    expect(await screen.findByText('Second accessible tab content')).toBeInTheDocument();
+    expect(app.router.router.state.location.pathname).toBe('/settings/protected-tabs/a-second');
+  });
+
+  it.each(['/settings/fallback-access', '/settings/fallback-access/'])(
+    'should redirect a denied index page to an accessible sibling from %s',
+    async (initialEntry) => {
+      class FallbackAccessSettingsPlugin extends Plugin {
+        async load() {
+          this.pluginSettingsManager.addMenuItem({ key: 'fallback-access', title: 'Fallback access' });
+          this.pluginSettingsManager.addPageTabItem({
+            menuKey: 'fallback-access',
+            key: 'index',
+            title: 'Restricted index settings',
+            aclSnippet: 'pm.fallback-access.index',
+            Component: () => <div>Restricted index settings page</div>,
+          });
+          this.pluginSettingsManager.addPageTabItem({
+            menuKey: 'fallback-access',
+            key: 'allowed',
+            title: 'Allowed fallback settings',
+            Component: () => <div>Allowed fallback settings page</div>,
+          });
+        }
+      }
+
+      const app = createMockSettingsClient({
+        plugins: [SettingsBuildInPlugin, TestAclPlugin, FallbackAccessSettingsPlugin],
+        router: { type: 'memory', initialEntries: [initialEntry] },
+      });
+      mockAdminRuntime(app, {
+        snippets: ['pm', 'pm.system-settings.system-settings', '!pm.fallback-access.index'],
+      });
+
+      await renderApp(app);
+      await waitForGetRequests(app, ['/auth:check', 'roles:check']);
+
+      expect(await screen.findByText('Allowed fallback settings page')).toBeInTheDocument();
+      expect(
+        screen.queryByRole('heading', { name: 'Your current role cannot access Settings' }),
+      ).not.toBeInTheDocument();
+      expect(screen.queryByText('Restricted index settings page')).not.toBeInTheDocument();
+    },
+  );
+
+  it('should skip an accessible dynamic tab when its route params cannot be resolved', async () => {
+    class DynamicSettingsTabsPlugin extends Plugin {
+      async load() {
+        this.pluginSettingsManager.addMenuItem({ key: 'dynamic-tabs', title: 'Dynamic tabs' });
+        this.pluginSettingsManager.addPageTabItem({
+          menuKey: 'dynamic-tabs',
+          key: ':name',
+          title: 'Dynamic tab',
+          aclSnippet: 'pm.dynamic-tabs.dynamic',
+          sort: 1,
+          Component: () => <div>Dynamic tab content</div>,
+        });
+        this.pluginSettingsManager.addPageTabItem({
+          menuKey: 'dynamic-tabs',
+          key: 'fallback',
+          title: 'Static fallback tab',
+          aclSnippet: 'pm.dynamic-tabs.fallback',
+          sort: 2,
+          Component: () => <div>Static fallback tab content</div>,
+        });
+        this.pluginSettingsManager.addPageTabItem({
+          menuKey: 'dynamic-tabs',
+          key: 'denied',
+          title: 'Denied tab',
+          aclSnippet: 'pm.dynamic-tabs.denied',
+          sort: 3,
+          Component: () => <div>Denied dynamic tab content</div>,
+        });
+      }
+    }
+
+    const app = createMockSettingsClient({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin, DynamicSettingsTabsPlugin],
+      router: { type: 'memory', initialEntries: ['/settings/dynamic-tabs/denied'] },
+    });
+    mockAdminRuntime(app, {
+      snippets: ['pm', '!pm.dynamic-tabs.denied'],
+    });
+
+    await renderApp(app);
+    await waitForGetRequests(app, ['/auth:check', 'roles:check']);
+
+    await waitFor(() => {
+      expect(app.router.router.state.location.pathname).toBe('/settings/dynamic-tabs/fallback');
+    });
+    expect(await screen.findByText('Static fallback tab content')).toBeInTheDocument();
+  });
+
+  it('should preserve resolved route params when redirecting between dynamic tabs', async () => {
+    class DynamicSiblingTabsPlugin extends Plugin {
+      async load() {
+        this.pluginSettingsManager.addMenuItem({ key: 'dynamic-siblings', title: 'Dynamic sibling tabs' });
+        this.pluginSettingsManager.addPageTabItem({
+          menuKey: 'dynamic-siblings',
+          key: ':name/channels',
+          title: 'Dynamic channels tab',
+          aclSnippet: 'pm.dynamic-siblings.channels',
+          sort: 1,
+          Component: () => <div>Dynamic channels tab content</div>,
+        });
+        this.pluginSettingsManager.addPageTabItem({
+          menuKey: 'dynamic-siblings',
+          key: ':name/logs',
+          title: 'Dynamic logs tab',
+          aclSnippet: 'pm.dynamic-siblings.logs',
+          sort: 2,
+          Component: () => <div>Dynamic logs tab content</div>,
+        });
+      }
+    }
+
+    const app = createMockSettingsClient({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin, DynamicSiblingTabsPlugin],
+      router: { type: 'memory', initialEntries: ['/settings/dynamic-siblings/email:primary/logs'] },
+    });
+    mockAdminRuntime(app, {
+      snippets: ['pm', '!pm.dynamic-siblings.logs'],
+    });
+
+    await renderApp(app);
+    await waitForGetRequests(app, ['/auth:check', 'roles:check']);
+
+    await waitFor(() => {
+      expect(app.router.router.state.location.pathname).toBe('/settings/dynamic-siblings/email:primary/channels');
+    });
+    expect(await screen.findByText('Dynamic channels tab content')).toBeInTheDocument();
+  });
+
+  it('should resolve hyphenated route param names when redirecting between dynamic tabs', async () => {
+    class HyphenatedParamTabsPlugin extends Plugin {
+      async load() {
+        this.pluginSettingsManager.addMenuItem({ key: 'hyphenated-params', title: 'Hyphenated param tabs' });
+        this.pluginSettingsManager.addPageTabItem({
+          menuKey: 'hyphenated-params',
+          key: ':data-source/channels',
+          title: 'Hyphenated channels tab',
+          aclSnippet: 'pm.hyphenated-params.channels',
+          sort: 1,
+          Component: () => <div>Hyphenated channels tab content</div>,
+        });
+        this.pluginSettingsManager.addPageTabItem({
+          menuKey: 'hyphenated-params',
+          key: ':data-source/logs',
+          title: 'Hyphenated logs tab',
+          aclSnippet: 'pm.hyphenated-params.logs',
+          sort: 2,
+          Component: () => <div>Hyphenated logs tab content</div>,
+        });
+      }
+    }
+
+    const app = createMockSettingsClient({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin, HyphenatedParamTabsPlugin],
+      router: { type: 'memory', initialEntries: ['/settings/hyphenated-params/email/logs'] },
+    });
+    mockAdminRuntime(app, {
+      snippets: ['pm', '!pm.hyphenated-params.logs'],
+    });
+
+    await renderApp(app);
+    await waitForGetRequests(app, ['/auth:check', 'roles:check']);
+
+    await waitFor(() => {
+      expect(app.router.router.state.location.pathname).toBe('/settings/hyphenated-params/email/channels');
+    });
+    expect(await screen.findByText('Hyphenated channels tab content')).toBeInTheDocument();
   });
 
   it('should keep menu visible when menu acl is denied but child page is visible', async () => {
@@ -358,10 +654,13 @@ describe('settings center', () => {
     await waitForGetRequests(app, ['/auth:check', 'roles:check']);
 
     expect(await screen.findByText('Menu ACL child page')).toBeInTheDocument();
-    expect(screen.getByRole('menuitem', { name: 'Menu ACL Demo' })).toBeInTheDocument();
+    // The sidebar is gone; this group is reached from the "other settings" hover
+    // dropdown in the top bar. The dropdown only renders on hover, so this just
+    // checks the group entry survived (ACL did not drop the whole menu).
+    expect(screen.getByRole('menuitem', { name: 'Other settings' })).toBeInTheDocument();
   });
 
-  it('should allow the settings sidebar menu to scroll independently', async () => {
+  it('should keep rendering the active page when a group has many settings', async () => {
     class ManySettingsPlugin extends Plugin {
       async load() {
         for (let index = 0; index < 30; index += 1) {
@@ -390,8 +689,10 @@ describe('settings center', () => {
 
     expect(await screen.findByText('Scroll demo page 29')).toBeInTheDocument();
 
-    const sidebar = screen.getByRole('menuitem', { name: 'Scroll demo 29' }).closest('.ant-layout-sider');
-    expect(sidebar).toHaveStyle({ overflowY: 'auto' });
+    // Without the sidebar there is no separate scroll area: all 30 settings live in
+    // the top bar dropdown and the page renders only the active one, so this just
+    // checks it still holds up.
+    expect(document.querySelector('.ant-layout-sider')).toBeNull();
   });
 
   it('should save system settings through systemSettings:put', async () => {