@nocobase/client-v2 2.2.0-beta.9 → 3.0.0-alpha.1

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

@@ -7,14 +7,15 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-import { ACLRolesCheckProvider, createMockClient, Plugin } from '@nocobase/client-v2';
+import { ACLRolesCheckProvider, Plugin } from '@nocobase/client-v2';
 import { render, screen, waitFor, fireEvent } from '@testing-library/react';
 import React from 'react';
 import { message } from 'antd';
 import { AdminSettingsLayoutModel as ClientV2AdminSettingsLayoutModel } from '../settings-center';
 import { AdminSettingsLayoutModel as ClientV1AdminSettingsLayoutModel } from '../../../client/src/pm/AdminSettingsLayoutModel';
-import { NocoBaseBuildInPlugin } from '../nocobase-buildin-plugin';
+import { SettingsBuildInPlugin } from '../settings-app/SettingsBuildInPlugin';
 import { matchSettingsRoute, sortTopLevelSettings } from '../settings-center/utils';
+import { createMockSettingsClient } from './mockSettingsApplication';
 
 class TestAclPlugin extends Plugin {
   async load() {
@@ -22,7 +23,7 @@ class TestAclPlugin extends Plugin {
   }
 }
 
-type MockClientApplication = ReturnType<typeof createMockClient>;
+type MockClientApplication = ReturnType<typeof createMockSettingsClient>;
 
 const renderApp = async (app: MockClientApplication) => {
   const Root = app.getRootComponent();
@@ -174,10 +175,10 @@ describe('settings center', () => {
     expect(sortTopLevelSettings(settings).map((item) => item.name)).toEqual(['api-keys', 'backups', 'system-settings']);
   });
 
-  it('should redirect /admin/settings to system-settings by default', async () => {
-    const app = createMockClient({
-      plugins: [NocoBaseBuildInPlugin, TestAclPlugin],
-      router: { type: 'memory', initialEntries: ['/admin/settings'] },
+  it('should redirect /settings to system-settings by default', async () => {
+    const app = createMockSettingsClient({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin],
+      router: { type: 'memory', initialEntries: ['/settings'] },
     });
     mockAdminRuntime(app);
 
@@ -188,9 +189,9 @@ describe('settings center', () => {
   });
 
   it('should expose current language variable as enabled-language selector', async () => {
-    const app = createMockClient({
-      plugins: [NocoBaseBuildInPlugin, TestAclPlugin],
-      router: { type: 'memory', initialEntries: ['/admin/settings/system-settings'] },
+    const app = createMockSettingsClient({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin],
+      router: { type: 'memory', initialEntries: ['/settings/system-settings'] },
     });
     mockAdminRuntime(app, {
       systemSettings: {
@@ -218,9 +219,9 @@ describe('settings center', () => {
   });
 
   it('should fallback to plugin-manager when system-settings is not allowed', async () => {
-    const app = createMockClient({
-      plugins: [NocoBaseBuildInPlugin, TestAclPlugin],
-      router: { type: 'memory', initialEntries: ['/admin/settings'] },
+    const app = createMockSettingsClient({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin],
+      router: { type: 'memory', initialEntries: ['/settings'] },
     });
     mockAdminRuntime(app, {
       snippets: ['pm', '!pm.system-settings.system-settings'],
@@ -244,9 +245,9 @@ describe('settings center', () => {
   });
 
   it('should hide plugin-manager menu item when pm snippet is missing', async () => {
-    const app = createMockClient({
-      plugins: [NocoBaseBuildInPlugin, TestAclPlugin],
-      router: { type: 'memory', initialEntries: ['/admin/settings/system-settings'] },
+    const app = createMockSettingsClient({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin],
+      router: { type: 'memory', initialEntries: ['/settings/system-settings'] },
     });
     mockAdminRuntime(app, {
       snippets: ['pm.system-settings.system-settings'],
@@ -260,9 +261,9 @@ describe('settings center', () => {
   });
 
   it('should show route empty state for unknown settings routes', async () => {
-    const app = createMockClient({
-      plugins: [NocoBaseBuildInPlugin, TestAclPlugin],
-      router: { type: 'memory', initialEntries: ['/admin/settings/unknown'] },
+    const app = createMockSettingsClient({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin],
+      router: { type: 'memory', initialEntries: ['/settings/unknown'] },
     });
     mockAdminRuntime(app);
 
@@ -286,9 +287,9 @@ describe('settings center', () => {
       }
     }
 
-    const app = createMockClient({
-      plugins: [NocoBaseBuildInPlugin, TestAclPlugin, HiddenSettingsPlugin],
-      router: { type: 'memory', initialEntries: ['/admin/settings/hidden-demo'] },
+    const app = createMockSettingsClient({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin, HiddenSettingsPlugin],
+      router: { type: 'memory', initialEntries: ['/settings/hidden-demo'] },
     });
     mockAdminRuntime(app);
 
@@ -313,9 +314,9 @@ describe('settings center', () => {
       }
     }
 
-    const app = createMockClient({
-      plugins: [NocoBaseBuildInPlugin, TestAclPlugin, ProtectedSettingsPlugin],
-      router: { type: 'memory', initialEntries: ['/admin/settings/secure-demo'] },
+    const app = createMockSettingsClient({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin, ProtectedSettingsPlugin],
+      router: { type: 'memory', initialEntries: ['/settings/secure-demo'] },
     });
     mockAdminRuntime(app, {
       snippets: ['pm', 'pm.system-settings.system-settings', '!pm.secure-demo.index'],
@@ -345,9 +346,9 @@ describe('settings center', () => {
       }
     }
 
-    const app = createMockClient({
-      plugins: [NocoBaseBuildInPlugin, TestAclPlugin, MenuAclPlugin],
-      router: { type: 'memory', initialEntries: ['/admin/settings/menu-acl-demo'] },
+    const app = createMockSettingsClient({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin, MenuAclPlugin],
+      router: { type: 'memory', initialEntries: ['/settings/menu-acl-demo'] },
     });
     mockAdminRuntime(app, {
       snippets: ['pm', 'pm.system-settings.system-settings', '!pm.menu-acl-demo.menu'],
@@ -378,9 +379,9 @@ describe('settings center', () => {
       }
     }
 
-    const app = createMockClient({
-      plugins: [NocoBaseBuildInPlugin, TestAclPlugin, ManySettingsPlugin],
-      router: { type: 'memory', initialEntries: ['/admin/settings/scroll-demo-29'] },
+    const app = createMockSettingsClient({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin, ManySettingsPlugin],
+      router: { type: 'memory', initialEntries: ['/settings/scroll-demo-29'] },
     });
     mockAdminRuntime(app);
 
@@ -394,9 +395,9 @@ describe('settings center', () => {
   });
 
   it('should save system settings through systemSettings:put', async () => {
-    const app = createMockClient({
-      plugins: [NocoBaseBuildInPlugin, TestAclPlugin],
-      router: { type: 'memory', initialEntries: ['/admin/settings/system-settings'] },
+    const app = createMockSettingsClient({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin],
+      router: { type: 'memory', initialEntries: ['/settings/system-settings'] },
     });
     mockAdminRuntime(app);
 
@@ -413,9 +414,9 @@ describe('settings center', () => {
   });
 
   it('should block invalid logo uploads by storage rules', async () => {
-    const app = createMockClient({
-      plugins: [NocoBaseBuildInPlugin, TestAclPlugin],
-      router: { type: 'memory', initialEntries: ['/admin/settings/system-settings'] },
+    const app = createMockSettingsClient({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin],
+      router: { type: 'memory', initialEntries: ['/settings/system-settings'] },
     });
     const messageErrorSpy = vi.spyOn(message, 'error').mockImplementation(() => {
       return undefined as any;

package/src/__tests__/settings-layout-root.test.tsx

@@ -0,0 +1,260 @@
+/**
+ * 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, waitFor } from '@testing-library/react';
+import MockAdapter from 'axios-mock-adapter';
+import React from 'react';
+import { afterEach, describe, expect, it, vi } from 'vitest';
+import { ACLRolesCheckProvider } from '../acl';
+import { Plugin } from '../Plugin';
+import { SettingsApplication } from '../settings-app/SettingsApplication';
+import { SettingsBuildInPlugin } from '../settings-app/SettingsBuildInPlugin';
+
+class TestAclPlugin extends Plugin {
+  async load() {
+    this.app.use(ACLRolesCheckProvider);
+  }
+}
+
+class StandaloneSettingsPlugin extends Plugin {
+  async load() {
+    this.pluginSettingsManager.addMenuItem({ key: 'standalone', title: 'Standalone' });
+    this.pluginSettingsManager.addPageTabItem({
+      menuKey: 'standalone',
+      key: 'index',
+      title: 'Standalone',
+      Component: () => <div>Standalone settings page</div>,
+      sort: -1000,
+    });
+  }
+}
+
+class MultiPortalSettingsPlugin extends Plugin {
+  async load() {
+    this.pluginSettingsManager.addMenuItem({
+      key: 'multi-portal',
+      title: 'Portal manager',
+      aclSnippet: 'pm.multi-portal',
+      sort: -300,
+    });
+    this.pluginSettingsManager.addPageTabItem({
+      menuKey: 'multi-portal',
+      key: 'index',
+      title: 'Portal manager',
+      aclSnippet: 'pm.multi-portal',
+      Component: () => <div>Portal manager page</div>,
+    });
+  }
+}
+
+class PrimarySettingsPlugin extends Plugin {
+  async load() {
+    this.pluginSettingsManager.addMenuItem({
+      key: 'portal-manager',
+      title: 'Portal manager',
+      sort: -300,
+    });
+    this.pluginSettingsManager.addPageTabItem({
+      menuKey: 'portal-manager',
+      key: 'index',
+      title: 'Portal manager',
+      Component: () => <div>Portal manager page</div>,
+    });
+  }
+}
+
+describe('standalone settings layout root', () => {
+  const originalLocation = window.location;
+  const originalModernClientPrefix = window.__nocobase_modern_client_prefix__;
+
+  afterEach(() => {
+    Object.defineProperty(window, 'location', { configurable: true, value: originalLocation });
+    if (originalModernClientPrefix === undefined) {
+      delete window.__nocobase_modern_client_prefix__;
+    } else {
+      window.__nocobase_modern_client_prefix__ = originalModernClientPrefix;
+    }
+  });
+
+  it.each(['/settings', '/settings/', '/settings/index'])(
+    'redirects %s to multi-portal when it is accessible',
+    async (initialEntry) => {
+      const app = new SettingsApplication({
+        plugins: [SettingsBuildInPlugin, MultiPortalSettingsPlugin],
+        router: { type: 'memory', initialEntries: [initialEntry] },
+        ws: false,
+      });
+      const apiMock = new MockAdapter(app.apiClient.axios);
+      app.dataSourceManager.ensureLoaded = async () => {};
+      apiMock.onGet('app:getLang').reply(200, {
+        data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+      });
+      apiMock.onGet('/auth:check').reply(200, { data: { id: 1, nickname: 'Admin' } });
+      apiMock.onGet('app:getInfo').reply(200, { data: { id: 'mock-app', version: 'test' } });
+      apiMock.onGet('systemSettings:get').reply(200, {
+        data: { id: 1, title: 'NocoBase', raw_title: 'NocoBase', logo: null },
+      });
+
+      const Root = app.getRootComponent();
+      render(<Root />);
+
+      await waitFor(() => {
+        expect(app.router.state.location.pathname).toBe('/settings/multi-portal');
+      });
+    },
+  );
+
+  it('falls back to system-settings when multi-portal is not registered', async () => {
+    const app = new SettingsApplication({
+      plugins: [SettingsBuildInPlugin, StandaloneSettingsPlugin],
+      router: { type: 'memory', initialEntries: ['/settings'] },
+      ws: false,
+    });
+    const apiMock = new MockAdapter(app.apiClient.axios);
+    app.dataSourceManager.ensureLoaded = async () => {};
+    apiMock.onGet('app:getLang').reply(200, {
+      data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+    });
+    apiMock.onGet('/auth:check').reply(200, { data: { id: 1, nickname: 'Admin' } });
+    apiMock.onGet('app:getInfo').reply(200, { data: { id: 'mock-app', version: 'test' } });
+    apiMock.onGet('systemSettings:get').reply(200, {
+      data: { id: 1, title: 'NocoBase', raw_title: 'NocoBase', logo: null },
+    });
+
+    const Root = app.getRootComponent();
+    render(<Root />);
+
+    await waitFor(() => {
+      expect(app.router.state.location.pathname).toBe('/settings/system-settings');
+    });
+  });
+
+  it('falls back to system-settings when multi-portal is not accessible', async () => {
+    const app = new SettingsApplication({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin, MultiPortalSettingsPlugin],
+      router: { type: 'memory', initialEntries: ['/settings'] },
+      ws: false,
+    });
+    const apiMock = new MockAdapter(app.apiClient.axios);
+    app.dataSourceManager.ensureLoaded = async () => {};
+    apiMock.onGet('app:getLang').reply(200, {
+      data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+    });
+    apiMock.onGet('/auth:check').reply(200, { data: { id: 1, nickname: 'Admin' } });
+    apiMock.onGet('app:getInfo').reply(200, { data: { id: 'mock-app', version: 'test' } });
+    apiMock.onGet('roles:check').reply(200, {
+      data: { role: 'member', snippets: ['!pm.multi-portal'] },
+    });
+    apiMock.onGet('systemSettings:get').reply(200, {
+      data: { id: 1, title: 'NocoBase', raw_title: 'NocoBase', logo: null },
+    });
+
+    const Root = app.getRootComponent();
+    render(<Root />);
+
+    await waitFor(() => {
+      expect(app.router.state.location.pathname).toBe('/settings/system-settings');
+    });
+  });
+
+  it('keeps ordinary negative-sort settings in the active Settings group sidebar', async () => {
+    const app = new SettingsApplication({
+      plugins: [SettingsBuildInPlugin, TestAclPlugin, PrimarySettingsPlugin],
+      router: { type: 'memory', initialEntries: ['/settings/portal-manager'] },
+      ws: false,
+    });
+    const apiMock = new MockAdapter(app.apiClient.axios);
+    app.dataSourceManager.ensureLoaded = async () => {};
+    apiMock.onGet('app:getLang').reply(200, {
+      data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+    });
+    apiMock.onGet('/auth:check').reply(200, { data: { id: 1, nickname: 'Admin' } });
+    apiMock.onGet('app:getInfo').reply(200, { data: { id: 'mock-app', version: 'test' } });
+    apiMock.onGet('roles:check').reply(200, {
+      data: { role: 'root', snippets: ['pm'] },
+    });
+    apiMock.onGet('systemSettings:get').reply(200, {
+      data: { id: 1, title: 'NocoBase', raw_title: 'NocoBase', logo: null },
+    });
+
+    const Root = app.getRootComponent();
+    render(<Root />);
+
+    expect(await screen.findByText('Portal manager page')).toBeInTheDocument();
+
+    const portalManagerItem = screen.getByRole('menuitem', { name: 'Portal manager' });
+    expect(portalManagerItem.closest('aside')).toBeInTheDocument();
+    expect(screen.queryByRole('menuitem', { name: /Plugin manager$/ })).not.toBeInTheDocument();
+  });
+
+  it('uses document navigation to the standalone Settings signin page when unauthenticated', async () => {
+    const replace = vi.fn();
+    Object.defineProperty(window, 'location', {
+      configurable: true,
+      value: { ...originalLocation, replace },
+    });
+    window.__nocobase_modern_client_prefix__ = 'v';
+    const app = new SettingsApplication({
+      plugins: [SettingsBuildInPlugin],
+      router: { type: 'memory', initialEntries: ['/settings/workflow?tab=list#recent'] },
+      ws: false,
+    });
+    const apiMock = new MockAdapter(app.apiClient.axios);
+    apiMock.onGet('app:getLang').reply(200, {
+      data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+    });
+    apiMock.onGet('app:getInfo').reply(200, { data: { id: 'mock-app', version: 'test' } });
+    apiMock.onGet('systemSettings:get').reply(200, {
+      data: { id: 1, title: 'NocoBase', raw_title: 'NocoBase', logo: null },
+    });
+    apiMock.onGet('/auth:check').reply(200, { data: {} });
+
+    const Root = app.getRootComponent();
+    render(<Root />);
+
+    await waitFor(() => {
+      expect(replace).toHaveBeenCalledWith('/settings/signin?redirect=%2Fsettings%2Fworkflow%3Ftab%3Dlist%23recent');
+    });
+  });
+
+  it('does not render the Settings header before the initial auth check completes', async () => {
+    let resolveAuthCheck: (response: [number, { data: { id: number } }]) => void = () => {
+      throw new Error('Auth check resolver is not initialized');
+    };
+    const authCheckResponse = new Promise<[number, { data: { id: number } }]>((resolve) => {
+      resolveAuthCheck = resolve;
+    });
+    const app = new SettingsApplication({
+      plugins: [SettingsBuildInPlugin],
+      router: { type: 'memory', initialEntries: ['/settings'] },
+      ws: false,
+    });
+    const apiMock = new MockAdapter(app.apiClient.axios);
+    app.dataSourceManager.ensureLoaded = async () => {};
+    apiMock.onGet('app:getLang').reply(200, {
+      data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+    });
+    apiMock.onGet('/auth:check').reply(() => authCheckResponse);
+    apiMock.onGet('app:getInfo').reply(200, { data: { id: 'mock-app', version: 'test' } });
+    apiMock.onGet('systemSettings:get').reply(200, {
+      data: { id: 1, title: 'NocoBase', raw_title: 'NocoBase', logo: null },
+    });
+
+    const Root = app.getRootComponent();
+    render(<Root />);
+
+    await waitFor(() => {
+      expect(apiMock.history.get.some((request) => request.url === '/auth:check')).toBe(true);
+    });
+    expect(screen.queryByRole('banner')).not.toBeInTheDocument();
+
+    resolveAuthCheck([200, { data: { id: 1 } }]);
+    expect(await screen.findByRole('banner')).toBeInTheDocument();
+  });
+});

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',
+    );
+  });
+});