@nocobase/client-v2 2.3.0-beta.5 → 2.4.0-alpha.1

package/src/__tests__/nocobase-buildin-plugin-auth.test.tsx

@@ -51,6 +51,42 @@ class AuthBootstrapRoutePlugin extends Plugin {
   }
 }
 
+class TestAdminPortalPlugin extends Plugin {
+  async load() {
+    this.app.layoutManager.registerLayout({
+      routeName: 'admin',
+      routePath: '/admin',
+      uid: 'admin-layout-model',
+      layoutModelClass: 'AdminLayoutModel',
+    });
+  }
+}
+
+class TestRootPortalPlugin extends Plugin {
+  async load() {
+    this.router.add('root', {
+      path: '/',
+      authCheck: true,
+      Component: () => <div>portal landing</div>,
+    });
+  }
+}
+
+class TestScopedPortalPlugin extends Plugin {
+  async load() {
+    this.router.add('customer-portal', {
+      path: '/customer/*',
+      authCheck: true,
+      Component: () => <div>customer portal</div>,
+    });
+    this.router.add('customer-portal-signin', {
+      path: '/customer/signin',
+      skipAuthCheck: true,
+      Component: () => <div>customer portal signin</div>,
+    });
+  }
+}
+
 describe('nocobase buildin plugin auth redirect', () => {
   const originalLocation = globalThis.window.location;
 
@@ -85,6 +121,16 @@ describe('nocobase buildin plugin auth redirect', () => {
     vi.restoreAllMocks();
   });
 
+  it('should leave Admin portal registration to runtime plugins', async () => {
+    const app = createMockClient();
+    const plugin = new NocoBaseBuildInPlugin({}, app);
+
+    await plugin.load();
+
+    expect(app.layoutManager.hasLayout('admin')).toBe(false);
+    expect(app.router.has('root')).toBe(false);
+  });
+
   it('should navigate to v2 signin when /auth:check returns no user', async () => {
     // Aligns with v1: use react-router navigate (virtual) rather than
     // `window.location.replace`, so a `window.location.href` queued elsewhere
@@ -92,7 +138,7 @@ describe('nocobase buildin plugin auth redirect', () => {
     // overridden.
     const app = createMockClient({
       publicPath: '/v2/',
-      plugins: [NocoBaseBuildInPlugin as any],
+      plugins: [NocoBaseBuildInPlugin as any, TestAdminPortalPlugin as typeof Plugin],
       router: { type: 'memory', initialEntries: ['/v2/admin/7vu4c2sdk6h'] },
     });
     app.apiMock.onGet('app:getLang').reply(200, {
@@ -115,7 +161,7 @@ describe('nocobase buildin plugin auth redirect', () => {
     // and race the 2FA response interceptor with its own signin redirect.
     const app = createMockClient({
       publicPath: '/v2/',
-      plugins: [NocoBaseBuildInPlugin as any],
+      plugins: [NocoBaseBuildInPlugin as any, TestAdminPortalPlugin as typeof Plugin],
       router: { type: 'memory', initialEntries: ['/v2/admin'] },
     });
     app.apiClient.auth.setToken('test-token');
@@ -136,29 +182,56 @@ describe('nocobase buildin plugin auth redirect', () => {
     expect(app.apiMock.history.post.filter((request) => request.url === 'auth:syncCookies')).toHaveLength(0);
   });
 
-  it('should redirect unauthenticated v2 root access to v2 signin via <Navigate />', async () => {
+  it('should redirect an unauthenticated Portal root to v2 signin', async () => {
     const app = createMockClient({
       publicPath: '/nocobase/v2/',
-      plugins: [NocoBaseBuildInPlugin as any],
+      plugins: [NocoBaseBuildInPlugin as any, TestRootPortalPlugin as typeof Plugin],
       router: { type: 'memory', initialEntries: ['/nocobase/v2/'] },
     });
     app.apiMock.onGet('app:getLang').reply(200, {
       data: { lang: 'en-US', resources: { client: {} }, cron: {} },
     });
+    app.apiMock.onGet('/auth:check').reply(200, { data: {} });
 
     const Root = app.getRootComponent();
     render(<Root />);
 
     await waitFor(() => {
       expect(app.router.router.state.location.pathname).toBe('/nocobase/v2/signin');
-      expect(app.router.router.state.location.search).toBe('?redirect=%2Fnocobase%2Fv2%2Fadmin');
+      expect(app.router.router.state.location.search).toBe('?redirect=%2Fnocobase%2Fv2');
+    });
+  });
+
+  it('should use an explicitly registered Portal signin route when unauthenticated', async () => {
+    const app = createMockClient({
+      publicPath: '/v2/',
+      plugins: [NocoBaseBuildInPlugin as unknown as typeof Plugin, TestScopedPortalPlugin as typeof Plugin],
+      router: { type: 'memory', initialEntries: ['/v2/customer/dashboard?tab=overview#panel'] },
+    });
+    app.apiMock.onGet('app:getLang').reply(200, {
+      data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+    });
+    app.apiMock.onGet('/auth:check').reply(200, { data: {} });
+
+    const Root = app.getRootComponent();
+    render(<Root />);
+
+    await waitFor(() => {
+      expect(app.router.router.state.location.pathname).toBe('/v2/customer/signin');
+      expect(app.router.router.state.location.search).toBe(
+        '?redirect=%2Fv2%2Fcustomer%2Fdashboard%3Ftab%3Doverview%23panel',
+      );
     });
   });
 
   it('should check current user after navigating from skipped route to v2 admin', async () => {
     const app = createMockClient({
       publicPath: '/v2/',
-      plugins: [NocoBaseBuildInPlugin as any, SkippedPublicRoutePlugin as any],
+      plugins: [
+        NocoBaseBuildInPlugin as any,
+        TestAdminPortalPlugin as typeof Plugin,
+        SkippedPublicRoutePlugin as typeof Plugin,
+      ],
       router: { type: 'memory', initialEntries: ['/v2/public'] },
     });
     app.apiMock.onGet('app:getLang').reply(200, {
@@ -385,7 +458,7 @@ describe('nocobase buildin plugin auth redirect', () => {
   it('should render v2 admin root without redirecting away', async () => {
     const app = createMockClient({
       publicPath: '/v2/',
-      plugins: [NocoBaseBuildInPlugin as any],
+      plugins: [NocoBaseBuildInPlugin as any, TestAdminPortalPlugin as typeof Plugin],
       router: { type: 'memory', initialEntries: ['/v2/admin'] },
     });
     app.apiMock.onGet('app:getLang').reply(200, {
@@ -419,7 +492,7 @@ describe('nocobase buildin plugin auth redirect', () => {
     async (pathname) => {
       const app = createMockClient({
         publicPath: '/v2/',
-        plugins: [NocoBaseBuildInPlugin as any],
+        plugins: [NocoBaseBuildInPlugin as any, TestAdminPortalPlugin as typeof Plugin],
         router: { type: 'memory', initialEntries: [pathname] },
       });
       app.apiMock.onGet('app:getLang').reply(200, {

package/src/__tests__/plugin-manager.test.tsx

@@ -7,10 +7,11 @@
  * 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 { fireEvent, render, screen, waitFor, within } from '@testing-library/react';
 import React from 'react';
-import { NocoBaseBuildInPlugin } from '../nocobase-buildin-plugin';
+import { SettingsBuildInPlugin } from '../settings-app/SettingsBuildInPlugin';
+import { createMockSettingsClient } from './mockSettingsApplication';
 
 class TestAclPlugin extends Plugin {
   async load() {
@@ -31,7 +32,7 @@ class TestSettingsLinkPlugin extends Plugin {
   }
 }
 
-type MockClientApplication = ReturnType<typeof createMockClient>;
+type MockClientApplication = ReturnType<typeof createMockSettingsClient>;
 
 const renderApp = (app: MockClientApplication) => {
   const Root = app.getRootComponent();
@@ -49,9 +50,9 @@ const waitForGetRequests = async (app: MockClientApplication, urls: string[]) =>
 };
 
 const setupApp = (pmList: any[], plugins: Array<typeof Plugin> = []) => {
-  const app = createMockClient({
-    plugins: [NocoBaseBuildInPlugin, TestAclPlugin, ...plugins],
-    router: { type: 'memory', initialEntries: ['/admin/settings/plugin-manager'] },
+  const app = createMockSettingsClient({
+    plugins: [SettingsBuildInPlugin, TestAclPlugin, ...plugins],
+    router: { type: 'memory', initialEntries: ['/settings/plugin-manager'] },
   });
 
   app.apiMock.onGet('/auth:check').reply(200, {

package/src/__tests__/settings-application.test.ts

@@ -0,0 +1,164 @@
+/**
+ * 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 MockAdapter from 'axios-mock-adapter';
+import { describe, expect, it } from 'vitest';
+import { Application } from '../index';
+import { SettingsApplication } from '../settings-app/SettingsApplication';
+import { SettingsBuildInPlugin } from '../settings-app/SettingsBuildInPlugin';
+
+describe('SettingsApplication', () => {
+  it('uses the standalone settings route namespace', () => {
+    const adminApp = new Application({ router: { type: 'memory' }, ws: false });
+    const settingsApp = new SettingsApplication({ router: { type: 'memory' }, ws: false });
+
+    expect(adminApp.pluginSettingsManager.getRouteName('demo.index')).toBe('admin.settings.demo.index');
+    expect(adminApp.pluginSettingsManager.getRoutePath('demo.index')).toBe('/admin/settings/demo');
+
+    expect(settingsApp.pluginSettingsManager.getRouteName('demo.index')).toBe('settings.demo.index');
+    expect(settingsApp.pluginSettingsManager.getRoutePath('demo.index')).toBe('/settings/demo');
+    expect(settingsApp.pluginSettingsManager.getRoutePath('')).toBe('/settings/');
+  });
+
+  it.each(['apps', '_app'])('uses basename-relative paths for the %s sub-application Settings runtime', (scope) => {
+    const app = new SettingsApplication({
+      publicPath: '/nocobase/',
+      router: { type: 'memory', basename: `/nocobase/settings/${scope}/demo/` },
+      ws: false,
+    });
+
+    expect(app.pluginSettingsManager.getRouteName('demo.index')).toBe('settings.demo.index');
+    expect(app.pluginSettingsManager.getRoutePath('')).toBe('/');
+    expect(app.pluginSettingsManager.getRoutePath('demo.index')).toBe('/demo');
+
+    app.router.add('settings', { path: '/settings' });
+    app.router.add('settingsDetails.workflow.canvas', { path: '/settings/workflow/workflows/:id' });
+    app.router.add('settingsDetails.preview', { path: '/settings-preview/:id' });
+    app.router.add('auth.signin', { path: '/signin' });
+
+    expect(app.router.get('settings')).toMatchObject({ path: '/' });
+    expect(app.router.get('settingsDetails.workflow.canvas')).toMatchObject({
+      path: '/workflow/workflows/:id',
+      authCheck: true,
+    });
+    expect(
+      app.router
+        .matchRoutes(`/nocobase/settings/${scope}/demo/workflow/workflows/1`)
+        ?.some((match) => match.route.id === 'settingsDetails.workflow.canvas'),
+    ).toBe(true);
+    expect(
+      app.router
+        .matchRoutes(`/nocobase/settings/${scope}/demo/settings/workflow/workflows/1`)
+        ?.some((match) => match.route.id === 'settingsDetails.workflow.canvas'),
+    ).toBe(false);
+    expect(app.router.get('settingsDetails.preview')).toMatchObject({ path: '/settings-preview/:id' });
+    expect(app.router.get('auth.signin')).toMatchObject({ path: '/signin' });
+  });
+
+  it('does not treat an apps segment inside the main application public path as a sub-application scope', () => {
+    const app = new SettingsApplication({
+      router: { type: 'memory', basename: '/tenant/apps/root/' },
+      ws: false,
+    });
+
+    expect(app.pluginSettingsManager.getRoutePath('')).toBe('/settings/');
+    expect(app.pluginSettingsManager.getRoutePath('demo.index')).toBe('/settings/demo');
+
+    app.router.add('settingsDetails.workflow.canvas', { path: '/settings/workflow/workflows/:id' });
+    expect(app.router.get('settingsDetails.workflow.canvas')).toMatchObject({
+      path: '/settings/workflow/workflows/:id',
+    });
+  });
+
+  it.each(['apps', '_app'])(
+    'does not treat a scoped-looking %s suffix inside the main public path as a sub-application scope',
+    (scope) => {
+      const publicPath = `/tenant/settings/${scope}/root/`;
+      const app = new SettingsApplication({
+        publicPath,
+        router: { type: 'memory', basename: publicPath },
+        ws: false,
+      });
+
+      expect(app.pluginSettingsManager.getRoutePath('')).toBe('/settings/');
+      expect(app.pluginSettingsManager.getRoutePath('demo.index')).toBe('/settings/demo');
+
+      app.router.add('settingsDetails.workflow.canvas', { path: '/settings/workflow/workflows/:id' });
+      app.router.add('auth.signin', { path: '/signin' });
+
+      expect(app.router.get('settingsDetails.workflow.canvas')).toMatchObject({
+        path: '/settings/workflow/workflows/:id',
+      });
+      expect(app.router.get('auth.signin')).toMatchObject({ path: '/settings/signin' });
+    },
+  );
+
+  it('keeps only routes owned by the settings runtime', () => {
+    const app = new SettingsApplication({ router: { type: 'memory' }, ws: false });
+
+    app.router.add('settings', { path: '/settings' });
+    app.router.add('settings.demo', { path: 'demo' });
+    app.router.add('settingsDetails.workflow.canvas', { path: '/settings/workflow/workflows/:id' });
+    app.router.add('admin.demo', { path: '/admin/demo' });
+    app.router.add('public-forms', { path: '/public-forms/:key' });
+    app.router.add('mobile', { path: '/mobile' });
+
+    expect(app.router.has('settings')).toBe(true);
+    expect(app.router.has('settings.demo')).toBe(true);
+    expect(app.router.get('settingsDetails.workflow.canvas')).toMatchObject({
+      path: '/settings/workflow/workflows/:id',
+      authCheck: true,
+    });
+    expect(app.router.has('admin.demo')).toBe(false);
+    expect(app.router.has('public-forms')).toBe(false);
+    expect(app.router.has('mobile')).toBe(false);
+    expect(app.router.has('not-found')).toBe(true);
+  });
+
+  it('keeps hidden plugin detail pages in the normal Settings route tree', () => {
+    const app = new SettingsApplication({ router: { type: 'memory' }, ws: false });
+
+    app.pluginSettingsManager.addMenuItem({ key: 'public-forms', title: 'Public forms' });
+    app.pluginSettingsManager.addPageTabItem({
+      menuKey: 'public-forms',
+      key: ':name',
+      title: false,
+      hidden: true,
+      Component: () => null,
+    });
+
+    expect(app.pluginSettingsManager.get('public-forms.:name')).toMatchObject({
+      hidden: true,
+      path: '/settings/public-forms/:name',
+    });
+    expect(app.router.get('settings.public-forms.:name')).toMatchObject({ path: ':name' });
+  });
+
+  it('registers the authenticated settings shell without the admin layout', async () => {
+    const app = new SettingsApplication({ router: { type: 'memory' }, ws: false });
+    const apiMock = new MockAdapter(app.apiClient.axios);
+    apiMock.onGet('app:getLang').reply(200, { data: { lang: 'en-US', resources: { client: {} }, cron: {} } });
+    const plugin = new SettingsBuildInPlugin({ name: 'settings-buildin' }, app);
+
+    await plugin.afterAdd();
+    await plugin.load();
+    app.router.add('settingsDetails.workflow.canvas', { path: '/settings/workflow/workflows/:id' });
+
+    expect(app.router.get('settings')).toMatchObject({ path: '/settings', authCheck: true });
+    expect(app.router.get('settingsDetails')).toMatchObject({ path: '/settings', authCheck: true });
+    expect(
+      app.router.matchRoutes('/settings/workflow/workflows/1')?.some((match) => match.route.authCheck === true),
+    ).toBe(true);
+    expect(app.router.has('admin')).toBe(false);
+    expect(app.layoutManager.hasLayout('admin')).toBe(false);
+    expect(app.pluginSettingsManager.has('plugin-manager')).toBe(true);
+    expect(app.pluginSettingsManager.has('system-settings')).toBe(true);
+    expect(app.pluginSettingsManager.has('security')).toBe(true);
+  });
+});

package/src/__tests__/settings-auth-routes.test.ts

@@ -0,0 +1,71 @@
+/**
+ * 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 { Application } from '../index';
+import { SettingsApplication } from '../settings-app/SettingsApplication';
+
+describe('standalone settings authentication routes', () => {
+  it('keeps and rebases the auth and 2fa route families', () => {
+    const app = new SettingsApplication({ router: { type: 'memory' }, ws: false });
+
+    app.router.add('auth', { Component: () => null });
+    app.router.add('auth.signin', { path: '/signin', skipAuthCheck: true, Component: () => null });
+    app.router.add('auth.signup', { path: '/signup', skipAuthCheck: true, Component: () => null });
+    app.router.add('auth.forgotPassword', {
+      path: '/forgot-password',
+      skipAuthCheck: true,
+      Component: () => null,
+    });
+    app.router.add('auth.resetPassword', {
+      path: '/reset-password',
+      skipAuthCheck: true,
+      Component: () => null,
+    });
+    app.router.add('2fa', { Component: () => null });
+    app.router.add('2fa.verify', { path: '/2fa', skipAuthCheck: true, Component: () => null });
+
+    expect(app.router.get('auth.signin')).toMatchObject({ path: '/settings/signin', skipAuthCheck: true });
+    expect(app.router.get('auth.signup')).toMatchObject({ path: '/settings/signup', skipAuthCheck: true });
+    expect(app.router.get('auth.forgotPassword')).toMatchObject({
+      path: '/settings/forgot-password',
+      skipAuthCheck: true,
+    });
+    expect(app.router.get('auth.resetPassword')).toMatchObject({
+      path: '/settings/reset-password',
+      skipAuthCheck: true,
+    });
+    expect(app.router.get('2fa.verify')).toMatchObject({ path: '/settings/2fa', skipAuthCheck: true });
+    expect(app.router.matchRoutes('/settings/signin')?.map((match) => match.route.id)).toContain('auth.signin');
+    expect(app.router.isSkippedAuthCheckRoute('/settings/reset-password')).toBe(true);
+  });
+
+  it('does not change the default Client V2 authentication routes', () => {
+    const app = new Application({ router: { type: 'memory' }, ws: false });
+
+    app.router.add('auth', { Component: () => null });
+    app.router.add('auth.signin', { path: '/signin', skipAuthCheck: true, Component: () => null });
+    app.router.add('2fa', { Component: () => null });
+    app.router.add('2fa.verify', { path: '/2fa', skipAuthCheck: true, Component: () => null });
+
+    expect(app.router.get('auth.signin')).toMatchObject({ path: '/signin', skipAuthCheck: true });
+    expect(app.router.get('2fa.verify')).toMatchObject({ path: '/2fa', skipAuthCheck: true });
+  });
+
+  it('continues to reject unrelated routes from the shared plugin lane', () => {
+    const app = new SettingsApplication({ router: { type: 'memory' }, ws: false });
+
+    app.router.add('admin.demo', { path: '/admin/demo' });
+    app.router.add('public.demo', { path: '/public/demo' });
+    app.router.add('mobile.demo', { path: '/mobile/demo' });
+
+    expect(app.router.has('admin.demo')).toBe(false);
+    expect(app.router.has('public.demo')).toBe(false);
+    expect(app.router.has('mobile.demo')).toBe(false);
+  });
+});