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

package/src/__tests__/settings-runtime-paths.test.ts

@@ -0,0 +1,99 @@
+/**
+ * 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 { afterEach, describe, expect, it } from 'vitest';
+import { resolveStandaloneSettingsPath } from '../settings-app/runtimePaths';
+
+const originalModernPrefix = window.__nocobase_modern_client_prefix__;
+
+const createApp = (publicPath: string, basename: string, name = 'main') =>
+  ({
+    name,
+    getPublicPath: () => publicPath,
+    router: {
+      getBasename: () => basename,
+    },
+  }) as any;
+
+describe('standalone settings runtime paths', () => {
+  afterEach(() => {
+    window.__nocobase_modern_client_prefix__ = originalModernPrefix;
+  });
+
+  it('maps legacy v2 settings paths to the root-public standalone SPA', () => {
+    const app = createApp('/nocobase/v/', '/nocobase/v');
+
+    expect(resolveStandaloneSettingsPath(app, '/nocobase/v/admin/settings/system-settings?tab=mail#smtp')).toBe(
+      '/nocobase/settings/system-settings?tab=mail#smtp',
+    );
+    expect(resolveStandaloneSettingsPath(app, '/nocobase/v/admin/workflow/workflows/42?tab=nodes#canvas')).toBe(
+      '/nocobase/settings/workflow/workflows/42?tab=nodes#canvas',
+    );
+    expect(resolveStandaloneSettingsPath(app, '/nocobase/v/admin/workflow/executions/88')).toBe(
+      '/nocobase/settings/workflow/executions/88',
+    );
+    expect(resolveStandaloneSettingsPath(app, '/nocobase/v/admin/ai/knowledge-base/detail/k1/documents')).toBe(
+      '/nocobase/settings/ai/knowledge-base/detail/k1/documents',
+    );
+  });
+
+  it('preserves both supported sub-application scopes', () => {
+    const appsApp = createApp('/nocobase/v/', '/nocobase/v/apps/demo');
+    const newApp = createApp('/nocobase/v/', '/nocobase/v/_app/demo');
+
+    expect(resolveStandaloneSettingsPath(appsApp, '/nocobase/v/apps/demo/admin/settings/routes')).toBe(
+      '/nocobase/settings/apps/demo/routes',
+    );
+    expect(resolveStandaloneSettingsPath(newApp, '/nocobase/v/_app/demo/admin/settings/routes')).toBe(
+      '/nocobase/settings/_app/demo/routes',
+    );
+  });
+
+  it('supports a custom modern prefix without leaking it into settings URLs', () => {
+    window.__nocobase_modern_client_prefix__ = 'modern';
+    const app = createApp('/base/modern/', '/base/modern');
+
+    expect(resolveStandaloneSettingsPath(app, '/base/modern/admin/settings/security')).toBe('/base/settings/security');
+  });
+
+  it('does not treat an apps segment inside the main application public path as a sub-application scope', () => {
+    window.__nocobase_modern_client_prefix__ = 'modern';
+    const app = createApp('/tenant/apps/root/modern/', '/tenant/apps/root/modern');
+
+    expect(resolveStandaloneSettingsPath(app, '/tenant/apps/root/modern/admin/settings/security')).toBe(
+      '/tenant/apps/root/settings/security',
+    );
+  });
+
+  it.each(['apps', '_app'])(
+    'does not remove a matching %s segment from the root public path for a real sub-application',
+    (scope) => {
+      window.__nocobase_modern_client_prefix__ = 'modern';
+      const app = createApp(`/tenant/${scope}/demo/modern/`, `/tenant/${scope}/demo/modern/${scope}/demo`, 'demo');
+
+      expect(
+        resolveStandaloneSettingsPath(app, `/tenant/${scope}/demo/modern/${scope}/demo/admin/settings/security`),
+      ).toBe(`/tenant/${scope}/demo/settings/${scope}/demo/security`);
+      expect(
+        resolveStandaloneSettingsPath(
+          app,
+          `/tenant/${scope}/demo/modern/${scope}/demo/admin/settings/mail/oauth2?code=abc#done`,
+        ),
+      ).toBe(`/tenant/${scope}/demo/${scope}/demo/admin/settings/mail/oauth2?code=abc#done`);
+    },
+  );
+
+  it('returns the legacy V1 callback for Email OAuth', () => {
+    const app = createApp('/nocobase/v/', '/nocobase/v/apps/demo');
+
+    expect(resolveStandaloneSettingsPath(app, '/nocobase/v/apps/demo/admin/settings/mail/oauth2?code=abc#done')).toBe(
+      '/nocobase/apps/demo/admin/settings/mail/oauth2?code=abc#done',
+    );
+  });
+});

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

@@ -0,0 +1,200 @@
+/**
+ * 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, screen } from '@testing-library/react';
+import { ConfigProvider } from 'antd';
+import React from 'react';
+import { MemoryRouter } from 'react-router-dom';
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+import { setCurrentUserAuthStatus } from '../nocobase-buildin-plugin/currentUserAuthStatus';
+import { SettingsShell } from '../settings-app/SettingsShell';
+import type { ThemeConfig } from '../theme';
+
+const userCenterModel = { uid: 'settings-user-center' };
+const createModel = vi.fn(() => userCenterModel);
+const matchRoutes = vi.fn(() => [{ route: { id: 'settings' } }]);
+const mockApp = {
+  flowEngine: {
+    createModel,
+    getModel: vi.fn(() => null),
+    getModelClass: vi.fn(() => true),
+  },
+  router: {
+    matchRoutes,
+  },
+};
+
+vi.mock('../hooks/useApp', () => ({
+  useApp: () => mockApp,
+}));
+
+vi.mock('../settings-app/SettingsBrand', () => ({
+  SettingsBrand: () => <div data-testid="settings-logo">logo</div>,
+}));
+
+vi.mock('../settings-app/SettingsGroupNav', () => ({
+  SettingsGroupNav: () => <div data-testid="settings-group-nav">groups</div>,
+}));
+
+vi.mock('../settings-app/SettingsSearch', () => ({
+  SettingsSearch: () => <div data-testid="settings-search">search</div>,
+}));
+
+vi.mock('../flow/admin-shell/admin-layout/HelpLite', () => ({
+  HelpLite: () => <div data-testid="settings-help">help</div>,
+}));
+
+vi.mock('@nocobase/flow-engine', async (importOriginal) => {
+  const actual = await importOriginal<typeof import('@nocobase/flow-engine')>();
+  return {
+    ...actual,
+    FlowModelRenderer: ({ model }: { model: { uid: string } }) => (
+      <div data-testid="settings-user-center">{model.uid}</div>
+    ),
+  };
+});
+
+describe('SettingsShell', () => {
+  beforeEach(() => {
+    createModel.mockClear();
+    matchRoutes.mockReset();
+    matchRoutes.mockReturnValue([{ route: { id: 'settings' } }]);
+    setCurrentUserAuthStatus(mockApp, 'authenticated');
+  });
+
+  it('renders only the settings brand, group nav, help and user center around its content', () => {
+    render(
+      <MemoryRouter initialEntries={['/settings/system-settings']}>
+        <SettingsShell>
+          <div>settings content</div>
+        </SettingsShell>
+      </MemoryRouter>,
+    );
+
+    expect(screen.getByTestId('settings-logo')).toBeInTheDocument();
+    expect(screen.getByTestId('settings-group-nav')).toBeInTheDocument();
+    expect(screen.getByTestId('settings-search')).toBeInTheDocument();
+    expect(screen.getByTestId('settings-help')).toBeInTheDocument();
+    expect(screen.getByTestId('settings-user-center')).toHaveTextContent('settings-user-center');
+    expect(screen.getByText('settings content')).toBeInTheDocument();
+    expect(screen.queryByTestId('plugin-settings-button')).not.toBeInTheDocument();
+    expect(screen.queryByTestId('notifications-button')).not.toBeInTheDocument();
+  });
+
+  it('keeps its neutral header instead of following the business-side header color', () => {
+    render(
+      <ConfigProvider
+        theme={
+          {
+            token: {
+              colorBgHeader: '#001529',
+              colorPrimary: '#1777FF',
+            },
+          } as ThemeConfig
+        }
+      >
+        <MemoryRouter initialEntries={['/settings/system-settings']}>
+          <SettingsShell>
+            <div>settings content</div>
+          </SettingsShell>
+        </MemoryRouter>
+      </ConfigProvider>,
+    );
+
+    // 主题编辑器里的深色顶栏只作用于业务端；设置中心固定用容器底色。
+    expect(screen.getByRole('banner')).toHaveStyle({ background: '#ffffff' });
+  });
+
+  it('places the settings content and embed container side by side below the header', () => {
+    const { container } = render(
+      <MemoryRouter initialEntries={['/settings/theme-editor']}>
+        <SettingsShell>
+          <div>settings content</div>
+        </SettingsShell>
+      </MemoryRouter>,
+    );
+
+    const header = screen.getByRole('banner');
+    const content = screen.getByRole('main');
+    const embedContainer = container.querySelector<HTMLElement>('#nocobase-embed-container');
+    const workspace = content.parentElement;
+
+    expect(embedContainer).not.toBeNull();
+    if (!embedContainer) {
+      throw new Error('Expected the Settings shell to render the global embed container');
+    }
+    expect(header.nextElementSibling).toBe(workspace);
+    expect(workspace).toHaveStyle({
+      display: 'flex',
+      flex: '1',
+      minWidth: '0',
+      minHeight: '0',
+      overflow: 'hidden',
+    });
+    expect(workspace?.children).toHaveLength(2);
+    expect(workspace?.firstElementChild).toBe(content);
+    expect(workspace?.lastElementChild).toBe(embedContainer);
+    expect(content).toHaveStyle({
+      flex: '1',
+      minWidth: '0',
+      minHeight: '0',
+      overflow: 'hidden',
+    });
+    expect(embedContainer).toHaveStyle({
+      flexShrink: '0',
+      height: '100%',
+      position: 'relative',
+    });
+
+    embedContainer.style.width = '33.3%';
+    embedContainer.style.maxWidth = '800px';
+    expect(workspace?.lastElementChild).toBe(embedContainer);
+    expect(embedContainer).toHaveStyle({ width: '33.3%', maxWidth: '800px' });
+
+    embedContainer.style.width = 'auto';
+    embedContainer.style.maxWidth = 'none';
+    expect(content).toHaveStyle({ flex: '1' });
+    expect(embedContainer).toHaveStyle({ width: 'auto', maxWidth: 'none' });
+  });
+
+  it.each(['auth.signin', '2fa.verify'])('does not render the settings shell for %s', (routeId) => {
+    matchRoutes.mockReturnValue([{ route: { id: routeId } }]);
+
+    render(
+      <MemoryRouter initialEntries={[routeId === 'auth.signin' ? '/settings/signin' : '/settings/2fa']}>
+        <SettingsShell>
+          <div>authentication content</div>
+        </SettingsShell>
+      </MemoryRouter>,
+    );
+
+    expect(screen.getByText('authentication content')).toBeInTheDocument();
+    expect(screen.queryByRole('banner')).not.toBeInTheDocument();
+    expect(screen.queryByTestId('settings-logo')).not.toBeInTheDocument();
+    expect(screen.queryByTestId('settings-help')).not.toBeInTheDocument();
+    expect(screen.queryByTestId('settings-user-center')).not.toBeInTheDocument();
+    expect(document.querySelector('#nocobase-embed-container')).not.toBeInTheDocument();
+  });
+
+  it('does not render the Settings header before authentication completes', () => {
+    setCurrentUserAuthStatus(mockApp, 'unknown');
+
+    render(
+      <MemoryRouter initialEntries={['/settings/system-settings']}>
+        <SettingsShell>
+          <div>settings content</div>
+        </SettingsShell>
+      </MemoryRouter>,
+    );
+
+    expect(screen.getByText('settings content')).toBeInTheDocument();
+    expect(document.querySelector('header')).toHaveStyle({ display: 'none' });
+    expect(screen.queryByTestId('settings-logo')).not.toBeVisible();
+  });
+});

package/src/acl/ACLProvider.tsx

@@ -167,6 +167,27 @@ export const useACLContext = () => {
   return useContext(ACLContext);
 };
 
+/**
+ * 读取当前角色的 snippets，且不要求调用方位于 `ACLRolesCheckProvider` 之内。
+ *
+ * 设置中心顶栏导航挂在 app 级 provider 上，位置比 `ACLRolesCheckProvider` 更外层，
+ * 这种情况下退回到 app context 上的 ACL observable store。
+ * 调用方需要用 `observer` 包裹，store 更新后才会重新渲染。
+ *
+ * @returns {string[]} 当前角色的 snippets
+ */
+export const useACLSnippets = (): string[] => {
+  const app = useApp();
+  const ctx = useACLContext();
+  const contextSnippets = ctx?.data?.data?.snippets;
+  // 必须走 ensureACLStore：调用方可能位于 `ACLRolesCheckProvider` 之外，此时 store 还没建，
+  // 直接读 `app.context.acl` 拿到的是 undefined，observer 就订阅不到后续的权限写入，
+  // 会一直停在首帧的空 snippets 上。
+  const storeSnippets = ensureACLStore(app)?.data?.snippets;
+
+  return contextSnippets?.length ? contextSnippets : storeSnippets || [];
+};
+
 /**
  * 触发当前角色权限重新检查。
  */

package/src/authRedirect.ts

@@ -8,8 +8,19 @@
  */
 
 import type { BaseApplication } from './BaseApplication';
+import {
+  resolveSettingsAppScope,
+  resolveSettingsAppScopeWithinPublicPath,
+  resolveSettingsDocumentPath,
+  type SettingsAppScope,
+} from './settings-app/settingsDocumentPath';
 
 type AppLike = Pick<BaseApplication<any>, 'getPublicPath'> & {
+  name?: string;
+  pluginSettingsManager?: {
+    getRouteName?: (name: string) => string;
+    getRoutePath?: (name: string) => string;
+  };
   router?: {
     getBasename?: () => string | undefined;
   };
@@ -52,7 +63,8 @@ function normalizePublicPath(value?: string) {
 }
 
 function normalizePathname(value?: string) {
-  const normalized = ensureLeadingSlash(String(value || '/').trim() || '/').replace(/\/{2,}/g, '/');
+  const pathname = ensureLeadingSlash(String(value || '/').trim() || '/');
+  const normalized = new URL(pathname, 'http://nocobase.local').pathname.replace(/\/{2,}/g, '/');
   if (normalized !== '/' && normalized.endsWith('/')) {
     return trimTrailingSlashes(normalized);
   }
@@ -179,7 +191,53 @@ function joinRootRelativePath(basePath: string, pathname: string) {
   return normalizePathname(`/${trimLeadingSlashes(normalizedBasePath)}/${trimLeadingSlashes(normalizedPathname)}`);
 }
 
+function isStandaloneSettingsApp(app: AppLike) {
+  return app.pluginSettingsManager?.getRouteName?.('') === 'settings.';
+}
+
+function getSettingsRootPublicPath(app: AppLike) {
+  const publicPath = normalizePublicPath(app.getPublicPath());
+  if (isStandaloneSettingsApp(app)) {
+    return publicPath;
+  }
+
+  const segments = trimTrailingSlashes(publicPath).split('/');
+  segments.pop();
+  return normalizePublicPath(segments.join('/') || '/');
+}
+
+function getSettingsAppScope(app: AppLike): SettingsAppScope {
+  const publicPath = app.getPublicPath();
+  return (
+    resolveSettingsAppScopeWithinPublicPath(publicPath, app.router?.getBasename?.()) ||
+    (app.name && app.name !== 'main' ? resolveSettingsAppScope(`/apps/${app.name}`) : '')
+  );
+}
+
+function getStandaloneSettingsBasePath(app: AppLike) {
+  return resolveSettingsDocumentPath(getSettingsRootPublicPath(app), getSettingsAppScope(app), '/settings');
+}
+
+function isStandaloneSettingsTarget(app: AppLike, pathname: string) {
+  const normalizedPathname = normalizePathname(pathname);
+  const settingsBasePath = normalizePathname(getStandaloneSettingsBasePath(app));
+  return normalizedPathname === settingsBasePath || normalizedPathname.startsWith(`${settingsBasePath}/`);
+}
+
+function isSettingsTargetForAnotherApp(app: AppLike, pathname: string) {
+  const normalizedPathname = normalizePathname(pathname);
+  const rootPublicPath = trimTrailingSlashes(getSettingsRootPublicPath(app)) || '';
+  const pathWithinRoot =
+    rootPublicPath && normalizedPathname.startsWith(`${rootPublicPath}/`)
+      ? normalizedPathname.slice(rootPublicPath.length)
+      : normalizedPathname;
+  return /^\/settings(?:\/|$)/.test(pathWithinRoot);
+}
+
 function getV2SigninPath(app: AppLike) {
+  if (isStandaloneSettingsApp(app)) {
+    return joinRootRelativePath(getStandaloneSettingsBasePath(app), '/signin');
+  }
   return joinRootRelativePath(getV2EffectiveBasePath(app), '/signin');
 }
 
@@ -204,7 +262,7 @@ function getDefaultV2AdminRedirectPath(app: AppLike) {
   return joinRootRelativePath(getV2EffectiveBasePath(app), '/admin');
 }
 
-function isSafeRootRelativePath(value?: string | null) {
+function isSafeRootRelativePath(value?: string | null): value is string {
   return !!value && value.startsWith('/') && !value.startsWith('//') && !value.startsWith('/\\');
 }
 
@@ -224,6 +282,10 @@ export function normalizeV2RedirectPath(app: AppLike, target?: string | null, fa
   let { pathname, search, hash } = splitPathLike(rawTarget);
   let normalizedPathname = normalizePathname(pathname);
 
+  if (isStandaloneSettingsTarget(app, normalizedPathname)) {
+    return `${preserveTrailingSlash(pathname, normalizedPathname)}${normalizeSearch(search)}${normalizeHash(hash)}`;
+  }
+
   // Already under the current v2 runtime, e.g. `/v/apps/a/admin/`.
   if (basePath === '/' || normalizedPathname === basePath || normalizedPathname.startsWith(`${basePath}/`)) {
     return `${preserveTrailingSlash(pathname, normalizedPathname)}${normalizeSearch(search)}${normalizeHash(hash)}`;
@@ -237,6 +299,11 @@ export function normalizeV2RedirectPath(app: AppLike, target?: string | null, fa
     normalizedPathname = normalizePathname(pathname);
   }
 
+  if (isSettingsTargetForAnotherApp(app, normalizedPathname)) {
+    ({ pathname, search, hash } = splitPathLike(fallbackTarget));
+    normalizedPathname = normalizePathname(pathname);
+  }
+
   // Basename-relative target, e.g. `/admin/`, becomes `/v/apps/a/admin/`.
   const joinedPathname = preserveTrailingSlash(pathname, joinRootRelativePath(basePath, normalizedPathname));
   return `${joinedPathname}${normalizeSearch(search)}${normalizeHash(hash)}`;
@@ -306,7 +373,9 @@ export function resolveV2SigninRedirect(value: string | undefined | null, app: A
     return null;
   }
 
-  const validPathnames = new Set(['/signin', getV2SigninPath(app)]);
+  const validPathnames = new Set(
+    isStandaloneSettingsApp(app) ? [getV2SigninPath(app)] : ['/signin', getV2SigninPath(app)],
+  );
   if (!validPathnames.has(url.pathname)) {
     return null;
   }