@nocobase/client-v2 2.2.0-beta.1 → 2.2.0-beta.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/client-v2",
-  "version": "2.2.0-beta.1",
+  "version": "2.2.0-beta.3",
   "license": "Apache-2.0",
   "main": "lib/index.js",
   "module": "es/index.mjs",
@@ -27,11 +27,11 @@
     "@formily/antd-v5": "1.2.3",
     "@formily/react": "^2.2.27",
     "@formily/shared": "^2.2.27",
-    "@nocobase/evaluators": "2.2.0-beta.1",
-    "@nocobase/flow-engine": "2.2.0-beta.1",
-    "@nocobase/sdk": "2.2.0-beta.1",
-    "@nocobase/shared": "2.2.0-beta.1",
-    "@nocobase/utils": "2.2.0-beta.1",
+    "@nocobase/evaluators": "2.2.0-beta.3",
+    "@nocobase/flow-engine": "2.2.0-beta.3",
+    "@nocobase/sdk": "2.2.0-beta.3",
+    "@nocobase/shared": "2.2.0-beta.3",
+    "@nocobase/utils": "2.2.0-beta.3",
     "ahooks": "^3.7.2",
     "antd": "5.24.2",
     "antd-style": "3.7.1",
@@ -46,5 +46,5 @@
     "react-i18next": "^11.15.1",
     "react-router-dom": "^6.30.1"
   },
-  "gitHead": "f82fa9d0c3aa8e00e53dd94e404a312483b4866b"
+  "gitHead": "7b16bb2cfd427c110c6671252138cd85155723c5"
 }

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

@@ -12,6 +12,10 @@ import { act, render, screen, waitFor } from '@testing-library/react';
 import React from 'react';
 import { NocoBaseBuildInPlugin } from '../nocobase-buildin-plugin';
 
+const TestingAppSpin = () => <div data-testid="app-spin">app spin</div>;
+
+const TestingAppError = ({ error }: { error: Error }) => <div role="alert">{error.message}</div>;
+
 class SkippedPublicRoutePlugin extends Plugin {
   async load() {
     this.router.add('public', {
@@ -22,6 +26,31 @@ class SkippedPublicRoutePlugin extends Plugin {
   }
 }
 
+class DummySigninRoutePlugin extends Plugin {
+  async load() {
+    this.router.add('signin-test', {
+      path: '/signin',
+      skipAuthCheck: true,
+      Component: () => <div>signin page</div>,
+    });
+  }
+}
+
+class AuthBootstrapRoutePlugin extends Plugin {
+  async load() {
+    this.router.add('secure', {
+      path: '/secure',
+      authCheck: true,
+      Component: () => <div>secure page</div>,
+    });
+    this.router.add('guest', {
+      path: '/guest',
+      authCheck: false,
+      Component: () => <div>guest page</div>,
+    });
+  }
+}
+
 describe('nocobase buildin plugin auth redirect', () => {
   const originalLocation = globalThis.window.location;
 
@@ -155,6 +184,176 @@ describe('nocobase buildin plugin auth redirect', () => {
     });
   });
 
+  it('should defer data source bootstrap until auth-required route is authenticated after signin redirect', async () => {
+    const app = createMockClient({
+      publicPath: '/v2/',
+      plugins: [NocoBaseBuildInPlugin as any, DummySigninRoutePlugin as any, AuthBootstrapRoutePlugin as any],
+      components: { AppSpin: TestingAppSpin },
+      router: { type: 'memory', initialEntries: ['/v2/secure'] },
+    });
+    app.apiMock.onGet('app:getLang').reply(200, {
+      data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+    });
+    const events: string[] = [];
+    app.apiMock.onGet('/auth:check').replyOnce(() => {
+      events.push('auth:first');
+      return [200, { data: {} }];
+    });
+    app.apiMock.onGet('/auth:check').reply(() => {
+      events.push('auth:second');
+      return [200, { data: { id: 1 } }];
+    });
+
+    const ensureLoaded = vi.spyOn(app.dataSourceManager, 'ensureLoaded').mockImplementation(() => {
+      if (!app.apiClient.auth.token) {
+        const pending = new Promise<void>(() => undefined);
+        app.dataSourceManager.loadingPromise = pending;
+        return pending;
+      }
+      events.push('bootstrap');
+      expect(events).toContain('auth:second');
+      return Promise.resolve();
+    });
+
+    const Root = app.getRootComponent();
+    render(<Root />);
+
+    await waitFor(() => {
+      expect(app.router.router.state.location.pathname).toBe('/v2/signin');
+      expect(app.router.router.state.location.search).toBe('?redirect=%2Fv2%2Fsecure');
+    });
+    expect(await screen.findByText('signin page')).toBeInTheDocument();
+    expect(screen.queryByTestId('app-spin')).not.toBeInTheDocument();
+    expect(ensureLoaded).not.toHaveBeenCalled();
+    expect(app.dataSourceManager.loadingPromise).toBeNull();
+    expect(events).toEqual(['auth:first']);
+
+    act(() => {
+      app.apiClient.auth.setToken('test-token');
+    });
+
+    await act(async () => {
+      await app.router.router.navigate('/secure');
+    });
+
+    expect(await screen.findByText('secure page')).toBeInTheDocument();
+    await waitFor(() => {
+      expect(document.querySelector('.ant-spin-spinning')).not.toBeInTheDocument();
+    });
+    expect(ensureLoaded).toHaveBeenCalledTimes(1);
+  });
+
+  it('should redirect on auth-required /auth:check 401 without bootstrapping data sources', async () => {
+    const app = createMockClient({
+      publicPath: '/v2/',
+      plugins: [NocoBaseBuildInPlugin as any, DummySigninRoutePlugin as any, AuthBootstrapRoutePlugin as any],
+      components: { AppSpin: TestingAppSpin },
+      router: { type: 'memory', initialEntries: ['/v2/secure'] },
+    });
+    app.apiMock.onGet('app:getLang').reply(200, {
+      data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+    });
+    app.apiMock.onGet('/auth:check').reply(401, { errors: [{ code: 'EMPTY_TOKEN' }] });
+    const ensureLoaded = vi.spyOn(app.dataSourceManager, 'ensureLoaded').mockImplementation(() => {
+      const pending = new Promise<void>(() => undefined);
+      app.dataSourceManager.loadingPromise = pending;
+      return pending;
+    });
+
+    const Root = app.getRootComponent();
+    render(<Root />);
+
+    await waitFor(() => {
+      expect(app.router.router.state.location.pathname).toBe('/v2/signin');
+      expect(app.router.router.state.location.search).toBe('?redirect=%2Fv2%2Fsecure');
+    });
+    expect(await screen.findByText('signin page')).toBeInTheDocument();
+    expect(screen.queryByTestId('app-spin')).not.toBeInTheDocument();
+    expect(ensureLoaded).not.toHaveBeenCalled();
+    expect(app.dataSourceManager.loadingPromise).toBeNull();
+  });
+
+  it('should surface non-auth /auth:check errors instead of leaving auth-required route spinning', async () => {
+    const app = createMockClient({
+      publicPath: '/v2/',
+      plugins: [NocoBaseBuildInPlugin as any, AuthBootstrapRoutePlugin as any],
+      components: { AppSpin: TestingAppSpin, AppError: TestingAppError },
+      router: { type: 'memory', initialEntries: ['/v2/secure'] },
+    });
+    app.apiMock.onGet('app:getLang').reply(200, {
+      data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+    });
+    app.apiMock.onGet('/auth:check').reply(500, { errors: [{ message: 'auth check failed' }] });
+    const ensureLoaded = vi.spyOn(app.dataSourceManager, 'ensureLoaded').mockResolvedValue(undefined);
+
+    const Root = app.getRootComponent();
+    render(<Root />);
+
+    expect(await screen.findByRole('alert')).toHaveTextContent('Request failed with status code 500');
+    expect(screen.queryByTestId('app-spin')).not.toBeInTheDocument();
+    expect(ensureLoaded).not.toHaveBeenCalled();
+  });
+
+  it.each(['/v2/signin', '/v2/public'])('should not bootstrap data sources on skipped auth route: %s', async (path) => {
+    const app = createMockClient({
+      publicPath: '/v2/',
+      plugins: [NocoBaseBuildInPlugin as any, DummySigninRoutePlugin as any, SkippedPublicRoutePlugin as any],
+      components: { AppSpin: TestingAppSpin },
+      router: { type: 'memory', initialEntries: [path] },
+    });
+    app.apiMock.onGet('app:getLang').reply(200, {
+      data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+    });
+    const ensureLoaded = vi.spyOn(app.dataSourceManager, 'ensureLoaded').mockResolvedValue(undefined);
+
+    const Root = app.getRootComponent();
+    render(<Root />);
+
+    expect(await screen.findByText(path === '/v2/signin' ? 'signin page' : 'public page')).toBeInTheDocument();
+    expect(screen.queryByTestId('app-spin')).not.toBeInTheDocument();
+    expect(ensureLoaded).not.toHaveBeenCalled();
+    expect(app.apiMock.history.get.filter((request) => request.url === '/auth:check')).toHaveLength(0);
+  });
+
+  it('should bootstrap data sources for authenticated auth-required route access', async () => {
+    const app = createMockClient({
+      publicPath: '/v2/',
+      plugins: [NocoBaseBuildInPlugin as any, AuthBootstrapRoutePlugin as any],
+      router: { type: 'memory', initialEntries: ['/v2/secure'] },
+    });
+    app.apiClient.auth.setToken('test-token');
+    app.apiMock.onGet('app:getLang').reply(200, {
+      data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+    });
+    app.apiMock.onGet('/auth:check').reply(200, { data: { id: 1 } });
+    const ensureLoaded = vi.spyOn(app.dataSourceManager, 'ensureLoaded').mockResolvedValue(undefined);
+
+    const Root = app.getRootComponent();
+    render(<Root />);
+
+    expect(await screen.findByText('secure page')).toBeInTheDocument();
+    expect(ensureLoaded).toHaveBeenCalledTimes(1);
+  });
+
+  it('should not auth-check or bootstrap authCheck false routes', async () => {
+    const app = createMockClient({
+      publicPath: '/v2/',
+      plugins: [NocoBaseBuildInPlugin as any, AuthBootstrapRoutePlugin as any],
+      router: { type: 'memory', initialEntries: ['/v2/guest'] },
+    });
+    app.apiMock.onGet('app:getLang').reply(200, {
+      data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+    });
+    const ensureLoaded = vi.spyOn(app.dataSourceManager, 'ensureLoaded').mockResolvedValue(undefined);
+
+    const Root = app.getRootComponent();
+    render(<Root />);
+
+    expect(await screen.findByText('guest page')).toBeInTheDocument();
+    expect(ensureLoaded).not.toHaveBeenCalled();
+    expect(app.apiMock.history.get.filter((request) => request.url === '/auth:check')).toHaveLength(0);
+  });
+
   it('should render v2 admin root without redirecting away', async () => {
     const app = createMockClient({
       publicPath: '/v2/',

package/src/components/AppComponents.tsx

@@ -21,7 +21,13 @@ import type { Application } from '../Application';
 interface AppErrorPayload {
   code?: string;
   message?: string;
-  command?: { name: string };
+  command?: {
+    name: string;
+    components?: {
+      maintaining?: string;
+      maintainingDialog?: string;
+    };
+  };
   [key: string]: any;
 }
 
@@ -188,7 +194,12 @@ export const AppError: FC<{ error: Error & { title?: string }; app: Application
 );
 
 export const AppMaintaining: FC<{ app: Application; error: Error }> = observer(
-  ({ app }) => {
+  ({ app, error }) => {
+    const component = (error as AppErrorPayload | undefined)?.command?.components?.maintaining;
+    if (component) {
+      return app.renderComponent(component, { app, error });
+    }
+
     const { icon, status, title, subTitle } = getProps(app);
     return (
       <div>
@@ -211,7 +222,12 @@ export const AppMaintaining: FC<{ app: Application; error: Error }> = observer(
 );
 
 export const AppMaintainingDialog: FC<{ app: Application; error: Error }> = observer(
-  ({ app }) => {
+  ({ app, error }) => {
+    const component = (error as AppErrorPayload | undefined)?.command?.components?.maintainingDialog;
+    if (component) {
+      return app.renderComponent(component, { app, error });
+    }
+
     const { icon, status, title, subTitle } = getProps(app);
     return (
       <Modal open={true} footer={null} closable={false}>