@nocobase/client-v2 2.1.0-alpha.4 → 2.1.0-alpha.45

package/src/__tests__/authRedirect.test.ts

@@ -0,0 +1,287 @@
+/**
+ * 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 {
+  buildV2SigninHref,
+  getCurrentV2RedirectPath,
+  redirectToV2Signin,
+  resolveV2SigninRedirect,
+} from '../authRedirect';
+
+describe('auth redirect helpers', () => {
+  const originalLocation = globalThis.window.location;
+
+  afterEach(() => {
+    Object.defineProperty(globalThis.window, 'location', {
+      configurable: true,
+      value: originalLocation,
+    });
+    vi.restoreAllMocks();
+  });
+
+  it('should preserve search and hash when building current v2 redirect path', () => {
+    const app = {
+      getPublicPath: () => '/v2/',
+      router: {
+        getBasename: () => '/v2',
+      },
+    } as any;
+
+    expect(
+      getCurrentV2RedirectPath(app, {
+        pathname: '/v2/admin/7vu4c2sdk6h',
+        search: '?tab=overview',
+        hash: '#section-a',
+      }),
+    ).toBe('/v2/admin/7vu4c2sdk6h?tab=overview#section-a');
+  });
+
+  it('should remove basename before restoring root-relative v2 path', () => {
+    const app = {
+      getPublicPath: () => '/nocobase/v2/',
+      router: {
+        getBasename: () => '/nocobase/v2',
+      },
+    } as any;
+
+    expect(
+      getCurrentV2RedirectPath(app, {
+        pathname: '/nocobase/v2/admin/7vu4c2sdk6h',
+        search: '?from=menu',
+        hash: '#tab-1',
+      }),
+    ).toBe('/nocobase/v2/admin/7vu4c2sdk6h?from=menu#tab-1');
+  });
+
+  it('should derive v2 signin href from v2 public path', () => {
+    const app = {
+      getPublicPath: () => '/nocobase/v2/',
+      router: {
+        getBasename: () => '/nocobase/v2',
+      },
+    } as any;
+
+    expect(buildV2SigninHref(app, '/nocobase/v2/admin/7vu4c2sdk6h')).toBe(
+      '/nocobase/v2/signin?redirect=%2Fnocobase%2Fv2%2Fadmin%2F7vu4c2sdk6h',
+    );
+  });
+
+  it('should derive v2 signin href when root public path is "/"', () => {
+    const app = {
+      getPublicPath: () => '/v2/',
+      router: {
+        getBasename: () => '/v2',
+      },
+    } as any;
+
+    expect(buildV2SigninHref(app, '/v2/admin/7vu4c2sdk6h')).toBe('/v2/signin?redirect=%2Fv2%2Fadmin%2F7vu4c2sdk6h');
+  });
+
+  it('should redirect with window.location.replace by default', () => {
+    const replace = vi.fn();
+    Object.defineProperty(globalThis.window, 'location', {
+      configurable: true,
+      value: {
+        ...originalLocation,
+        replace,
+      },
+    });
+
+    const app = {
+      getPublicPath: () => '/v2/',
+      router: {
+        getBasename: () => '/v2',
+      },
+    } as any;
+
+    redirectToV2Signin(app, '/v2/admin/7vu4c2sdk6h');
+
+    expect(replace).toHaveBeenCalledWith('/v2/signin?redirect=%2Fv2%2Fadmin%2F7vu4c2sdk6h');
+  });
+
+  it('should accept same-origin v2 signin urls only', () => {
+    Object.defineProperty(globalThis.window, 'location', {
+      configurable: true,
+      value: {
+        ...originalLocation,
+        origin: 'http://localhost:20000',
+      },
+    });
+
+    const app = {
+      getPublicPath: () => '/nocobase/v2/',
+      router: {
+        getBasename: () => '/nocobase/v2',
+      },
+    } as any;
+
+    expect(resolveV2SigninRedirect('/nocobase/v2/signin?redirect=%2Fnocobase%2Fv2%2Fadmin#hash', app)).toBe(
+      'http://localhost:20000/nocobase/v2/signin?redirect=%2Fnocobase%2Fv2%2Fadmin#hash',
+    );
+    expect(resolveV2SigninRedirect('/signin?redirect=%2Fv2%2Fadmin', app)).toBe(
+      'http://localhost:20000/signin?redirect=%2Fv2%2Fadmin',
+    );
+    expect(resolveV2SigninRedirect('/nocobase/signin?redirect=%2Fnocobase%2Fv2%2Fadmin', app)).toBeNull();
+    expect(resolveV2SigninRedirect('https://evil.example.com/signin?redirect=%2Fv2%2Fadmin', app)).toBeNull();
+    expect(resolveV2SigninRedirect('/nocobase/admin', app)).toBeNull();
+  });
+
+  describe('v2 sub-app context (router basename contains /apps/<id>/)', () => {
+    it('should preserve sub-app segment when building current redirect path under simple public path', () => {
+      const app = {
+        getPublicPath: () => '/v2/',
+        router: {
+          getBasename: () => '/v2/apps/test-app/',
+        },
+      } as any;
+
+      expect(
+        getCurrentV2RedirectPath(app, {
+          pathname: '/v2/apps/test-app/admin/7vu4c2sdk6h',
+          search: '?tab=overview',
+          hash: '#section-a',
+        }),
+      ).toBe('/v2/apps/test-app/admin/7vu4c2sdk6h?tab=overview#section-a');
+    });
+
+    it('should preserve sub-app segment when building current redirect path under nested public path', () => {
+      const app = {
+        getPublicPath: () => '/nocobase/v2/',
+        router: {
+          getBasename: () => '/nocobase/v2/apps/test-app/',
+        },
+      } as any;
+
+      expect(
+        getCurrentV2RedirectPath(app, {
+          pathname: '/nocobase/v2/apps/test-app/admin/al5yj9t81of',
+          search: '?from=menu',
+          hash: '#tab-1',
+        }),
+      ).toBe('/nocobase/v2/apps/test-app/admin/al5yj9t81of?from=menu#tab-1');
+    });
+
+    it('should derive sub-app signin href under nested public path', () => {
+      const app = {
+        getPublicPath: () => '/nocobase/v2/',
+        router: {
+          getBasename: () => '/nocobase/v2/apps/test-app/',
+        },
+      } as any;
+
+      expect(buildV2SigninHref(app, '/nocobase/v2/apps/test-app/admin/al5yj9t81of')).toBe(
+        '/nocobase/v2/apps/test-app/signin?redirect=%2Fnocobase%2Fv2%2Fapps%2Ftest-app%2Fadmin%2Fal5yj9t81of',
+      );
+    });
+
+    it('should derive sub-app signin href under simple public path', () => {
+      const app = {
+        getPublicPath: () => '/v2/',
+        router: {
+          getBasename: () => '/v2/apps/test-app/',
+        },
+      } as any;
+
+      expect(buildV2SigninHref(app, '/v2/apps/test-app/admin/7vu4c2sdk6h')).toBe(
+        '/v2/apps/test-app/signin?redirect=%2Fv2%2Fapps%2Ftest-app%2Fadmin%2F7vu4c2sdk6h',
+      );
+    });
+
+    it('should redirect to sub-app signin with window.location.replace', () => {
+      const replace = vi.fn();
+      Object.defineProperty(globalThis.window, 'location', {
+        configurable: true,
+        value: {
+          ...originalLocation,
+          replace,
+        },
+      });
+
+      const app = {
+        getPublicPath: () => '/nocobase/v2/',
+        router: {
+          getBasename: () => '/nocobase/v2/apps/test-app/',
+        },
+      } as any;
+
+      redirectToV2Signin(app, '/nocobase/v2/apps/test-app/admin/al5yj9t81of');
+
+      expect(replace).toHaveBeenCalledWith(
+        '/nocobase/v2/apps/test-app/signin?redirect=%2Fnocobase%2Fv2%2Fapps%2Ftest-app%2Fadmin%2Fal5yj9t81of',
+      );
+    });
+
+    it('should whitelist sub-app signin only and reject main / other-app / v1 signin urls', () => {
+      Object.defineProperty(globalThis.window, 'location', {
+        configurable: true,
+        value: {
+          ...originalLocation,
+          origin: 'http://localhost:20000',
+        },
+      });
+
+      const app = {
+        getPublicPath: () => '/nocobase/v2/',
+        router: {
+          getBasename: () => '/nocobase/v2/apps/test-app/',
+        },
+      } as any;
+
+      // own sub-app signin: accepted
+      expect(
+        resolveV2SigninRedirect(
+          '/nocobase/v2/apps/test-app/signin?redirect=%2Fnocobase%2Fv2%2Fapps%2Ftest-app%2Fadmin',
+          app,
+        ),
+      ).toBe(
+        'http://localhost:20000/nocobase/v2/apps/test-app/signin?redirect=%2Fnocobase%2Fv2%2Fapps%2Ftest-app%2Fadmin',
+      );
+      // bare /signin: still accepted (universal fallback)
+      expect(resolveV2SigninRedirect('/signin?redirect=%2Fnocobase%2Fv2%2Fapps%2Ftest-app%2Fadmin', app)).toBe(
+        'http://localhost:20000/signin?redirect=%2Fnocobase%2Fv2%2Fapps%2Ftest-app%2Fadmin',
+      );
+      // main v2 signin: rejected (would lose sub-app context)
+      expect(resolveV2SigninRedirect('/nocobase/v2/signin?redirect=%2Fnocobase%2Fv2%2Fadmin', app)).toBeNull();
+      // another sub-app signin: rejected (cross-app injection)
+      expect(
+        resolveV2SigninRedirect('/nocobase/v2/apps/other-app/signin?redirect=%2Fnocobase%2Fv2%2Fapps%2Ftest-app', app),
+      ).toBeNull();
+      // v1 root signin: rejected
+      expect(resolveV2SigninRedirect('/nocobase/signin?redirect=%2Fnocobase%2Fv2', app)).toBeNull();
+      // cross-origin: rejected
+      expect(resolveV2SigninRedirect('https://evil.example.com/nocobase/v2/apps/test-app/signin', app)).toBeNull();
+    });
+  });
+
+  describe('fallback when router or basename is missing', () => {
+    it('should fall back to v2 public path when app.router is undefined', () => {
+      const app = {
+        getPublicPath: () => '/nocobase/v2/',
+        router: undefined,
+      } as any;
+
+      expect(buildV2SigninHref(app, '/nocobase/v2/admin/X')).toBe(
+        '/nocobase/v2/signin?redirect=%2Fnocobase%2Fv2%2Fadmin%2FX',
+      );
+    });
+
+    it('should fall back to v2 public path when router.getBasename returns undefined', () => {
+      const app = {
+        getPublicPath: () => '/nocobase/v2/',
+        router: {
+          getBasename: () => undefined,
+        },
+      } as any;
+
+      expect(buildV2SigninHref(app, '/nocobase/v2/admin/X')).toBe(
+        '/nocobase/v2/signin?redirect=%2Fnocobase%2Fv2%2Fadmin%2FX',
+      );
+    });
+  });
+});

package/src/__tests__/dataSourceRuntime.test.tsx

@@ -0,0 +1,34 @@
+/**
+ * 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 { createMockClient } from '@nocobase/client-v2';
+import { describe, expect, it } from 'vitest';
+
+class InputInterface {
+  name = 'input';
+  group = 'basic';
+  titleUsable = true;
+}
+
+describe('data source runtime', () => {
+  it('shares one dataSourceManager instance between app and flow context', () => {
+    const app = createMockClient();
+
+    expect(app.dataSourceManager).toBe(app.flowEngine.context.dataSourceManager);
+    expect(app.dataSourceManager.collectionFieldInterfaceManager).toBeTruthy();
+  });
+
+  it('supports registering field interfaces through app api', () => {
+    const app = createMockClient();
+
+    app.addFieldInterfaces([InputInterface as any]);
+
+    expect(app.dataSourceManager.collectionFieldInterfaceManager.getFieldInterface('input')?.titleUsable).toBe(true);
+  });
+});

package/src/__tests__/globalDeps.test.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 { defineGlobalDeps } from '../utils/globalDeps';
+
+vi.mock('../index', () => ({}));
+
+describe('client-v2 defineGlobalDeps', () => {
+  it('should register shared AMD dependencies for remote plugins', () => {
+    const define = vi.fn();
+
+    defineGlobalDeps({
+      define,
+    } as any);
+
+    expect(define).toHaveBeenCalledWith('react', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('react-router-dom', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('@formily/react', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('@nocobase/utils/client', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('@nocobase/client-v2', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('@nocobase/flow-engine', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('@nocobase/evaluators/client', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('@dnd-kit/core', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('@dnd-kit/sortable', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('@ctrl/tinycolor', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('ahooks', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('dayjs', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('lodash', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('@emotion/css', expect.any(Function));
+  });
+});

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

@@ -0,0 +1,216 @@
+/**
+ * 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 { createMockClient, Plugin } from '@nocobase/client-v2';
+import { act, render, screen, waitFor } from '@testing-library/react';
+import React from 'react';
+import { NocoBaseBuildInPlugin } from '../nocobase-buildin-plugin';
+
+class SkippedPublicRoutePlugin extends Plugin {
+  async load() {
+    this.router.add('public', {
+      path: '/public',
+      skipAuthCheck: true,
+      Component: () => <div>public page</div>,
+    });
+  }
+}
+
+describe('nocobase buildin plugin auth redirect', () => {
+  const originalLocation = globalThis.window.location;
+
+  beforeEach(() => {
+    Object.defineProperty(globalThis.window, 'matchMedia', {
+      configurable: true,
+      value: vi.fn().mockImplementation((query: string) => ({
+        matches: false,
+        media: query,
+        onchange: null,
+        addListener: vi.fn(),
+        removeListener: vi.fn(),
+        addEventListener: vi.fn(),
+        removeEventListener: vi.fn(),
+        dispatchEvent: vi.fn(),
+      })),
+    });
+  });
+
+  afterEach(() => {
+    Object.defineProperty(globalThis.window, 'location', {
+      configurable: true,
+      value: originalLocation,
+    });
+    vi.restoreAllMocks();
+  });
+
+  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
+    // (e.g. 2FA's `code:302` response interceptor) can commit instead of being
+    // overridden.
+    const app = createMockClient({
+      publicPath: '/v2/',
+      plugins: [NocoBaseBuildInPlugin as any],
+      router: { type: 'memory', initialEntries: ['/v2/admin/7vu4c2sdk6h'] },
+    });
+    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/signin');
+      expect(app.router.router.state.location.search).toBe('?redirect=%2Fv2%2Fadmin%2F7vu4c2sdk6h');
+    });
+  });
+
+  it('should short-circuit /auth:check when server returns code:302 instead of redirecting to signin', async () => {
+    // When the server signals an intermediate redirect (typically 2FA verify),
+    // CurrentUserProvider must NOT treat the missing `user.id` as "logged out"
+    // and race the 2FA response interceptor with its own signin redirect.
+    const app = createMockClient({
+      publicPath: '/v2/',
+      plugins: [NocoBaseBuildInPlugin as any],
+      router: { type: 'memory', initialEntries: ['/v2/admin'] },
+    });
+    app.apiMock.onGet('app:getLang').reply(200, {
+      data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+    });
+    app.apiMock.onGet('/auth:check').reply(200, {
+      data: { code: 302, redirect: '/2fa?redirect=/admin' },
+    });
+
+    const Root = app.getRootComponent();
+    render(<Root />);
+
+    // Give CurrentUserProvider time to process the response.
+    await new Promise((resolve) => setTimeout(resolve, 50));
+    expect(app.router.router.state.location.pathname).toBe('/v2/admin');
+    expect(app.router.router.state.location.search).toBe('');
+  });
+
+  it('should redirect unauthenticated v2 root access to v2 signin via <Navigate />', async () => {
+    const app = createMockClient({
+      publicPath: '/nocobase/v2/',
+      plugins: [NocoBaseBuildInPlugin as any],
+      router: { type: 'memory', initialEntries: ['/nocobase/v2/'] },
+    });
+    app.apiMock.onGet('app:getLang').reply(200, {
+      data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+    });
+
+    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');
+    });
+  });
+
+  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],
+      router: { type: 'memory', initialEntries: ['/v2/public'] },
+    });
+    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 />);
+
+    expect(await screen.findByText('public page')).toBeInTheDocument();
+    const authCheckRequestsBeforeNavigation = app.apiMock.history.get.filter(
+      (request) => request.url === '/auth:check',
+    ).length;
+    expect(authCheckRequestsBeforeNavigation).toBe(0);
+
+    await act(async () => {
+      await app.router.router.navigate('/v2/admin');
+    });
+
+    await waitFor(() => {
+      expect(app.apiMock.history.get.filter((request) => request.url === '/auth:check').length).toBeGreaterThan(
+        authCheckRequestsBeforeNavigation,
+      );
+      expect(app.router.router.state.location.pathname).toBe('/v2/signin');
+      expect(app.router.router.state.location.search).toBe('?redirect=%2Fv2%2Fadmin');
+    });
+  });
+
+  it('should render v2 admin root without redirecting away', async () => {
+    const app = createMockClient({
+      publicPath: '/v2/',
+      plugins: [NocoBaseBuildInPlugin as any],
+      router: { type: 'memory', initialEntries: ['/v2/admin'] },
+    });
+    app.apiMock.onGet('app:getLang').reply(200, {
+      data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+    });
+    app.apiMock.onGet('/auth:check').reply(200, { data: { id: 1 } });
+    app.apiMock.onGet('systemSettings:get').reply(200, { data: {} });
+    app.apiMock.onGet('/desktopRoutes:listAccessible').reply(200, {
+      data: [
+        {
+          id: 1,
+          title: 'Legacy page',
+          schemaUid: 'legacy-page',
+          type: 'page',
+        },
+      ],
+    });
+
+    const Root = app.getRootComponent();
+    const { container } = render(<Root />);
+
+    await waitFor(() => {
+      expect(container.innerHTML).toContain('No pages yet, please configure first');
+    });
+    expect(app.router.router.state.location.pathname).toBe('/v2/admin');
+    expect(container.innerHTML).not.toContain('Legacy page');
+  });
+
+  it.each(['/v2/admin/legacy-page/tab/tab-1', '/v2/admin/legacy-page/view/detail'])(
+    'should show 404 for authenticated direct v1-style v2 page access: %s',
+    async (pathname) => {
+      const app = createMockClient({
+        publicPath: '/v2/',
+        plugins: [NocoBaseBuildInPlugin as any],
+        router: { type: 'memory', initialEntries: [pathname] },
+      });
+      app.apiMock.onGet('app:getLang').reply(200, {
+        data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+      });
+      app.apiMock.onGet('/auth:check').reply(200, { data: { id: 1 } });
+      app.apiMock.onGet('systemSettings:get').reply(200, { data: {} });
+      app.apiMock.onGet('/desktopRoutes:listAccessible').reply(200, {
+        data: [
+          {
+            id: 1,
+            title: 'Legacy page',
+            schemaUid: 'legacy-page',
+            type: 'page',
+          },
+        ],
+      });
+
+      const Root = app.getRootComponent();
+      render(<Root />);
+
+      expect(await screen.findByText('404')).toBeInTheDocument();
+      expect(app.router.router.state.location.pathname).toBe(pathname);
+    },
+  );
+});