@nocobase/client-v2 2.3.0-beta.9 → 2.4.0-alpha.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/client-v2",
-  "version": "2.3.0-beta.9",
+  "version": "2.4.0-alpha.10",
   "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.3.0-beta.9",
-    "@nocobase/flow-engine": "2.3.0-beta.9",
-    "@nocobase/sdk": "2.3.0-beta.9",
-    "@nocobase/shared": "2.3.0-beta.9",
-    "@nocobase/utils": "2.3.0-beta.9",
+    "@nocobase/evaluators": "2.4.0-alpha.10",
+    "@nocobase/flow-engine": "2.4.0-alpha.10",
+    "@nocobase/sdk": "2.4.0-alpha.10",
+    "@nocobase/shared": "2.4.0-alpha.10",
+    "@nocobase/utils": "2.4.0-alpha.10",
     "ahooks": "^3.7.2",
     "antd": "5.24.2",
     "antd-style": "3.7.1",
@@ -49,5 +49,5 @@
     "react-router-dom": "^6.30.1",
     "zxing-wasm": "^3.1.3"
   },
-  "gitHead": "c215e60ed704afe6c086bd96304f4b0d3b46d02e"
+  "gitHead": "c869865c0413fbe4ef85b26be1f2b8d7078c38df"
 }

package/src/BaseApplication.tsx

@@ -274,6 +274,8 @@ export abstract class BaseApplication<
     this.eventBus.addEventListener('auth:tokenChanged', (event: Event) => {
       const detail = (event as CustomEvent<AuthTokenPayload>).detail;
       if (!detail?.token) {
+        // 登录态已结束（退出登录或 token 失效），清空路由缓存，避免下一个用户沿用上一个用户的可访问路由。
+        this.context.routeRepository?.clear();
         return;
       }
       this.setTokenInWebSocket(detail);

package/src/RouteRepository.ts

@@ -153,6 +153,20 @@ export class RouteRepository {
     return loadingPromise;
   }
 
+  /**
+   * 清空所有布局的路由缓存，并丢弃清空前发起的请求结果。
+   *
+   * 用于登录态失效（如退出登录）时，避免下一个用户沿用上一个用户的可访问路由。
+   */
+  clear() {
+    this.routeCaches.clear();
+    this.accessibleLoadingPromises.clear();
+    this.refreshRequestIds.forEach((requestId, layoutUid) => {
+      this.refreshRequestIds.set(layoutUid, requestId + 1);
+    });
+    this.syncRoutesProperty();
+  }
+
   /**
    * 订阅路由缓存变化，用于驱动 React 上下文刷新。
    *

package/src/__tests__/RouteRepository.test.ts

@@ -193,6 +193,57 @@ describe('RouteRepository', () => {
     unsubscribeCustom();
   });
 
+  it('should drop cached routes of every layout when cleared', () => {
+    const { repository } = createRouteRepository();
+
+    repository.setRoutes([route('admin-page')], 'admin-layout-model');
+    repository.setRoutes([route('custom-page')], 'custom-desktop-layout-model');
+
+    repository.clear();
+
+    expect(repository.isAccessibleLoaded()).toBe(false);
+    expect(repository.listAccessible()).toEqual([]);
+    expect(repository.routes).toEqual([]);
+    const deactivateLayout = repository.activateLayout({
+      uid: 'custom-desktop-layout-model',
+    });
+    expect(repository.isAccessibleLoaded()).toBe(false);
+    expect(repository.listAccessible()).toEqual([]);
+    deactivateLayout();
+  });
+
+  it('should reload accessible routes after being cleared', async () => {
+    const { repository, request } = createRouteRepository();
+    request.mockResolvedValueOnce({ data: { data: [route('previous-user-page')] } });
+    await repository.ensureAccessibleLoaded();
+
+    repository.clear();
+    request.mockResolvedValueOnce({ data: { data: [route('next-user-page')] } });
+    const routes = await repository.ensureAccessibleLoaded();
+
+    expect(request).toHaveBeenCalledTimes(2);
+    expect(routes.map((item) => item.schemaUid)).toEqual(['next-user-page']);
+  });
+
+  it('should ignore refresh results requested before being cleared', async () => {
+    const { repository, request } = createRouteRepository();
+    let resolveStaleRequest: (value: unknown) => void = () => {};
+    request.mockImplementationOnce(
+      () =>
+        new Promise((resolve) => {
+          resolveStaleRequest = resolve;
+        }),
+    );
+
+    const staleRefresh = repository.refreshAccessible();
+    repository.clear();
+    resolveStaleRequest({ data: { data: [route('previous-user-page')] } });
+    await staleRefresh;
+
+    expect(repository.isAccessibleLoaded()).toBe(false);
+    expect(repository.listAccessible()).toEqual([]);
+  });
+
   it('should pass the default admin layout when creating a route', async () => {
     const { repository, create } = createRouteRepository();
 

package/src/__tests__/app.test.tsx

@@ -171,6 +171,19 @@ describe('app', () => {
       expect(document.documentElement.lang).toBe('ja-JP');
     });
 
+    it('should clear cached accessible routes when the auth token is cleared', () => {
+      const app = new Application({ router });
+      const routeRepository = app.flowEngine.context.routeRepository;
+      routeRepository.setRoutes([{ schemaUid: 'previous-user-page' }]);
+
+      app.apiClient.auth.setToken('renewed-token');
+      expect(routeRepository.listAccessible().map((route) => route.schemaUid)).toEqual(['previous-user-page']);
+
+      app.apiClient.auth.setToken(null);
+      expect(routeRepository.isAccessibleLoaded()).toBe(false);
+      expect(routeRepository.listAccessible()).toEqual([]);
+    });
+
     it('should escape app version html placeholder content', () => {
       expect(getAppVersionHTML('<script>alert(1)</script>&"')).toBe(
         '<span class="nb-app-version">v&lt;script&gt;alert(1)&lt;/script&gt;&amp;&quot;</span>',
@@ -379,7 +392,11 @@ describe('app', () => {
     expect(screen.getByText('maintaining dialog message')).toBeInTheDocument();
   });
 
-  it('should keep current content behind maintained dialog state', async () => {
+  it.each([
+    ['pm.enable', 'Enabling plugin'],
+    ['pm.disable', 'Disabling plugin'],
+    ['future.command', 'future.command'],
+  ])('should keep current content behind the default dialog while app commanding: %s', async (commandName, title) => {
     const CurrentPage = () => {
       const [count, setCount] = React.useState(0);
       return <button onClick={() => setCount((value) => value + 1)}>Current page count: {count}</button>;
@@ -398,12 +415,127 @@ describe('app', () => {
     act(() => {
       app.maintained = true;
       app.maintaining = true;
-      app.error = { code: 'APP_COMMANDING', command: { name: 'pm.enable' }, message: 'starting sub applications...' };
+      app.error = { code: 'APP_COMMANDING', command: { name: commandName }, message: 'starting sub applications...' };
     });
 
     expect(screen.getByRole('button', { name: 'Current page count: 1' })).toBeInTheDocument();
     expect(screen.getByRole('dialog')).toBeInTheDocument();
-    expect(screen.getByText('Enabling plugin')).toBeInTheDocument();
+    expect(screen.getByText(title)).toBeInTheDocument();
+  });
+
+  it('should keep current content without a dialog while app upgrading', async () => {
+    const CurrentPage = () => <div>Current page</div>;
+
+    class PluginHelloClient extends Plugin {
+      async load() {
+        this.router.add('root', { path: '/', Component: CurrentPage });
+      }
+    }
+
+    const app = createMockClient({ plugins: [PluginHelloClient] });
+    await renderApp(app);
+
+    act(() => {
+      app.maintained = true;
+      app.maintaining = true;
+      app.error = Object.assign(new Error('Loading data sources...'), {
+        code: 'APP_COMMANDING',
+        command: { name: 'upgrade' },
+      });
+    });
+
+    expect(screen.getByText('Current page')).toBeInTheDocument();
+    expect(screen.queryByRole('dialog')).not.toBeInTheDocument();
+  });
+
+  it.each([
+    ['upgrade', 'App upgrading'],
+    ['pm.enable', 'Enabling plugin'],
+    ['pm.disable', 'Disabling plugin'],
+    ['future.command', 'future.command'],
+  ])('should not show Try again for an app commanding error state: %s', async (commandName, title) => {
+    class PluginHelloClient extends Plugin {}
+    const app = createMockClient({ plugins: [PluginHelloClient] });
+    app.error = Object.assign(new Error('Loading data sources...'), {
+      code: 'APP_COMMANDING',
+      command: { name: commandName },
+    });
+
+    await renderApp(app);
+
+    expect(screen.getByText(title)).toBeInTheDocument();
+    expect(screen.queryByRole('button', { name: 'Try again' })).not.toBeInTheDocument();
+  });
+
+  it('should clear upgrade feedback after an existing page error', async () => {
+    const BrokenPage = () => {
+      throw new Error('page error');
+    };
+
+    class PluginHelloClient extends Plugin {
+      async load() {
+        this.router.add('root', { path: '/', Component: BrokenPage });
+      }
+    }
+
+    const app = createMockClient({
+      plugins: [PluginHelloClient],
+      ws: { url: 'ws://localhost:3000/ws' },
+    });
+    app.maintained = true;
+    const errorSpy = vi.spyOn(console, 'error').mockImplementation(() => {});
+    try {
+      await renderApp(app);
+      expect(screen.getByRole('button', { name: 'Try again' })).toBeInTheDocument();
+
+      act(() => {
+        app.ws.emit('message', {
+          type: 'maintaining',
+          payload: {
+            code: 'APP_COMMANDING',
+            command: { name: 'upgrade' },
+            message: 'Loading data sources...',
+          },
+        });
+      });
+
+      expect(screen.getByText('App upgrading')).toBeInTheDocument();
+      expect(screen.queryByRole('dialog')).not.toBeInTheDocument();
+      expect(screen.queryByRole('button', { name: 'Try again' })).not.toBeInTheDocument();
+    } finally {
+      errorSpy.mockRestore();
+    }
+  });
+
+  it('should keep a custom maintaining dialog while app upgrading', async () => {
+    class PluginHelloClient extends Plugin {}
+    const app = createMockClient({ plugins: [PluginHelloClient] });
+    app.addComponents({
+      CustomUpgradeStatus: () => <div>Custom upgrade status</div>,
+    });
+    app.maintained = true;
+    app.maintaining = true;
+    app.error = Object.assign(new Error('Loading data sources...'), {
+      code: 'APP_COMMANDING',
+      command: {
+        name: 'upgrade',
+        components: { maintainingDialog: 'CustomUpgradeStatus' },
+      },
+    });
+
+    await renderApp(app);
+
+    expect(screen.getByText('Custom upgrade status')).toBeInTheDocument();
+  });
+
+  it('should keep Try again for recoverable app errors', async () => {
+    class PluginHelloClient extends Plugin {}
+    const app = createMockClient({ plugins: [PluginHelloClient] });
+    app.error = Object.assign(new Error('load error'), { code: 'LOAD_ERROR' });
+
+    await renderApp(app);
+
+    expect(screen.getByRole('button', { name: 'Try again' })).toBeInTheDocument();
   });
 
   it('should handle long loading state gracefully', async () => {

package/src/__tests__/authRedirect.test.ts

@@ -17,12 +17,18 @@ import {
 
 describe('auth redirect helpers', () => {
   const originalLocation = globalThis.window.location;
+  const originalModernClientPrefix = window.__nocobase_modern_client_prefix__;
 
   afterEach(() => {
     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;
+    }
     vi.restoreAllMocks();
   });
 
@@ -84,6 +90,107 @@ describe('auth redirect helpers', () => {
     expect(buildV2SigninHref(app, '/v2/admin/7vu4c2sdk6h')).toBe('/v2/signin?redirect=%2Fv2%2Fadmin%2F7vu4c2sdk6h');
   });
 
+  it('should keep validated standalone settings redirects outside the v2 basename', () => {
+    const app = {
+      getPublicPath: () => '/nocobase/v2/',
+      router: {
+        getBasename: () => '/nocobase/v2',
+      },
+    } as any;
+
+    expect(normalizeV2RedirectPath(app, '/nocobase/settings/workflow?tab=list#recent')).toBe(
+      '/nocobase/settings/workflow?tab=list#recent',
+    );
+  });
+
+  it('should build the standalone settings signin URL for a standalone settings app', () => {
+    const app = {
+      name: 'main',
+      getPublicPath: () => '/nocobase/',
+      router: {
+        getBasename: () => '/nocobase',
+      },
+      pluginSettingsManager: {
+        getRouteName: () => 'settings.',
+        getRoutePath: () => '/settings/',
+      },
+    } satisfies Parameters<typeof buildV2SigninHref>[0];
+    expect(buildV2SigninHref(app, '/nocobase/settings/workflow?tab=list#recent')).toBe(
+      '/nocobase/settings/signin?redirect=%2Fnocobase%2Fsettings%2Fworkflow%3Ftab%3Dlist%23recent',
+    );
+  });
+
+  it('should keep an apps segment inside the main public path out of the Settings application scope', () => {
+    const app = {
+      name: 'main',
+      getPublicPath: () => '/tenant/apps/root/',
+      router: {
+        getBasename: () => '/tenant/apps/root/',
+      },
+      pluginSettingsManager: {
+        getRouteName: () => 'settings.',
+        getRoutePath: () => '/settings/',
+      },
+    } satisfies Parameters<typeof buildV2SigninHref>[0];
+
+    expect(buildV2SigninHref(app, '/tenant/apps/root/settings/workflow')).toBe(
+      '/tenant/apps/root/settings/signin?redirect=%2Ftenant%2Fapps%2Froot%2Fsettings%2Fworkflow',
+    );
+  });
+
+  it.each([
+    ['/nocobase/settings/apps/test-app/', '/nocobase/settings/apps/test-app/signin'],
+    ['/nocobase/settings/_app/test-app/', '/nocobase/settings/_app/test-app/signin'],
+  ])('should keep the standalone settings signin in the current sub-app scope: %s', (basename, signinPath) => {
+    const app = {
+      name: 'test-app',
+      getPublicPath: () => '/nocobase/',
+      router: {
+        getBasename: () => basename,
+      },
+      pluginSettingsManager: {
+        getRouteName: () => 'settings.',
+        getRoutePath: () => '/',
+      },
+    } as any;
+
+    expect(buildV2SigninHref(app, `${basename}workflow`)).toBe(
+      `${signinPath}?redirect=${encodeURIComponent(`${basename}workflow`)}`,
+    );
+  });
+
+  it('should accept the current standalone settings signin URL only', () => {
+    Object.defineProperty(globalThis.window, 'location', {
+      configurable: true,
+      value: {
+        ...originalLocation,
+        origin: 'http://localhost:20000',
+      },
+    });
+    const app = {
+      name: 'test-app',
+      getPublicPath: () => '/nocobase/',
+      router: {
+        getBasename: () => '/nocobase/settings/apps/test-app/',
+      },
+      pluginSettingsManager: {
+        getRouteName: () => 'settings.',
+        getRoutePath: () => '/',
+      },
+    } as any;
+
+    expect(
+      resolveV2SigninRedirect(
+        '/nocobase/settings/apps/test-app/signin?redirect=%2Fnocobase%2Fsettings%2Fapps%2Ftest-app',
+        app,
+      ),
+    ).toBe(
+      'http://localhost:20000/nocobase/settings/apps/test-app/signin?redirect=%2Fnocobase%2Fsettings%2Fapps%2Ftest-app',
+    );
+    expect(resolveV2SigninRedirect('/nocobase/v/apps/test-app/signin', app)).toBeNull();
+    expect(resolveV2SigninRedirect('/nocobase/settings/apps/other-app/signin', app)).toBeNull();
+  });
+
   it('should redirect with window.location.replace by default', () => {
     const replace = vi.fn();
     Object.defineProperty(globalThis.window, 'location', {
@@ -134,6 +241,36 @@ describe('auth redirect helpers', () => {
   });
 
   describe('v2 sub-app context (router basename contains /apps/<id>/)', () => {
+    it('should keep only the current sub-app standalone settings redirect', () => {
+      const app = {
+        getPublicPath: () => '/nocobase/v2/',
+        router: {
+          getBasename: () => '/nocobase/v2/apps/test-app/',
+        },
+      } as any;
+
+      expect(normalizeV2RedirectPath(app, '/nocobase/settings/apps/test-app/workflow')).toBe(
+        '/nocobase/settings/apps/test-app/workflow',
+      );
+      expect(normalizeV2RedirectPath(app, '/nocobase/settings/apps/other-app/workflow')).toBe(
+        '/nocobase/v2/apps/test-app/admin/',
+      );
+    });
+
+    it.each([
+      '/nocobase/settings/apps/test-app/../../other-app/settings',
+      '/nocobase/settings/apps/test-app/%2e%2e/%2E%2e/other-app/settings',
+    ])('should reject a standalone settings redirect that resolves outside the current sub-app: %s', (target) => {
+      const app = {
+        getPublicPath: () => '/nocobase/v2/',
+        router: {
+          getBasename: () => '/nocobase/v2/apps/test-app/',
+        },
+      } as any;
+
+      expect(normalizeV2RedirectPath(app, target)).toBe('/nocobase/v2/apps/test-app/admin/');
+    });
+
     it('should normalize signin redirect fallback under the current sub-app basename', () => {
       const app = {
         getPublicPath: () => '/v/',
@@ -210,6 +347,23 @@ describe('auth redirect helpers', () => {
       );
     });
 
+    it('should derive a scoped Portal signin href under the current sub-app basename', () => {
+      const app = {
+        getPublicPath: () => '/nocobase/v2/',
+        router: {
+          getBasename: () => '/nocobase/v2/apps/test-app/',
+        },
+      } satisfies Parameters<typeof buildV2SigninHref>[0];
+
+      expect(
+        buildV2SigninHref(app, '/nocobase/v2/apps/test-app/customer/orders', {
+          signInRoutePath: '/customer/signin',
+        }),
+      ).toBe(
+        '/nocobase/v2/apps/test-app/customer/signin?redirect=%2Fnocobase%2Fv2%2Fapps%2Ftest-app%2Fcustomer%2Forders',
+      );
+    });
+
     it('should redirect to sub-app signin with window.location.replace', () => {
       const replace = vi.fn();
       Object.defineProperty(globalThis.window, 'location', {