@nocobase/client-v2 2.1.0-beta.34 → 2.1.0-beta.36

package/src/__tests__/remotePlugins.test.ts

@@ -14,8 +14,11 @@ import { configRequirejs, defineDevPlugins, getPlugins } from '../utils/remotePl
 describe('client-v2 remotePlugins', () => {
   afterEach(() => {
     window.define = undefined;
+    window.__nocobase_app_dev_plugins__ = undefined;
   });
 
+  const createModuleUrl = (code: string) => `data:text/javascript;charset=utf-8,${encodeURIComponent(code)}`;
+
   it('should define dev plugins with /client-v2 module ids', () => {
     class DemoPlugin extends Plugin {}
 
@@ -29,6 +32,61 @@ describe('client-v2 remotePlugins', () => {
     expect(mockDefine).toHaveBeenCalledWith('@nocobase/demo/client-v2', expect.any(Function));
   });
 
+  it('should preserve named exports from dev plugin modules', () => {
+    class DemoPlugin extends Plugin {}
+    class DemoActionModel {}
+
+    const mockDefine: any = vi.fn();
+    window.define = mockDefine;
+
+    const pluginModule = {
+      default: DemoPlugin,
+      DemoActionModel,
+    };
+    defineDevPlugins({
+      '@nocobase/demo': pluginModule,
+    });
+
+    const moduleFactory = mockDefine.mock.calls[0]?.[1];
+    expect(mockDefine).toHaveBeenCalledWith('@nocobase/demo/client-v2', expect.any(Function));
+    expect(moduleFactory()).toBe(pluginModule);
+    expect(window.__nocobase_app_dev_plugins__['@nocobase/demo/client-v2']).toBe(pluginModule);
+  });
+
+  it('should expose named exports from devDynamicImport modules to RequireJS consumers', async () => {
+    class DemoPlugin extends Plugin {}
+    class DemoActionModel {}
+
+    const requirejs: any = {
+      requirejs: vi.fn(),
+    };
+    requirejs.requirejs.config = vi.fn();
+
+    const mockDefine: any = vi.fn();
+    window.define = mockDefine;
+
+    const plugins = await getPlugins({
+      requirejs,
+      pluginData: [
+        {
+          name: '@nocobase/demo',
+          packageName: '@nocobase/demo',
+          url: 'https://demo.com/dist/client-v2/index.js',
+        },
+      ] as any,
+      devDynamicImport: vi.fn().mockResolvedValue({ default: DemoPlugin, DemoActionModel }) as any,
+    });
+
+    const moduleFactory = mockDefine.mock.calls.find((call) => call[0] === '@nocobase/demo/client-v2')?.[1];
+
+    expect(plugins).toEqual([['@nocobase/demo', DemoPlugin]]);
+    expect(moduleFactory()).toEqual({ default: DemoPlugin, DemoActionModel });
+    expect(window.__nocobase_app_dev_plugins__['@nocobase/demo/client-v2']).toEqual({
+      default: DemoPlugin,
+      DemoActionModel,
+    });
+  });
+
   it('should not define /client aliases when loading v2 plugins', async () => {
     class DemoPlugin extends Plugin {}
 
@@ -58,6 +116,151 @@ describe('client-v2 remotePlugins', () => {
     expect(mockDefine).not.toHaveBeenCalledWith('@nocobase/demo/client', expect.any(Function));
   });
 
+  it('should request remote plugins when devDynamicImport only resolves some plugins', async () => {
+    class DemoPlugin extends Plugin {}
+
+    const remoteFn = vi.fn();
+    const requirejs: any = {
+      requirejs: (pluginData, resolve) => {
+        remoteFn();
+        resolve({ default: DemoPlugin });
+      },
+    };
+    requirejs.requirejs.config = vi.fn();
+
+    const mockDefine: any = vi.fn();
+    window.define = mockDefine;
+
+    const plugins = await getPlugins({
+      requirejs,
+      pluginData: [
+        {
+          name: '@nocobase/demo',
+          packageName: '@nocobase/demo',
+          url: 'https://demo.com/dist/client-v2/index.js',
+        },
+        {
+          name: '@nocobase/remote',
+          packageName: '@nocobase/remote',
+          url: 'https://remote.com/dist/client-v2/index.js',
+        },
+      ] as any,
+      devDynamicImport: ((packageName) => {
+        if (packageName === '@nocobase/demo') {
+          return Promise.resolve({ default: DemoPlugin });
+        }
+        return Promise.resolve(null);
+      }) as any,
+    });
+
+    expect(plugins).toEqual([
+      ['@nocobase/demo', DemoPlugin],
+      ['@nocobase/remote', DemoPlugin],
+    ]);
+    expect(remoteFn).toHaveBeenCalledTimes(1);
+    expect(mockDefine).toHaveBeenCalledTimes(1);
+    expect(requirejs.requirejs.config).toHaveBeenCalledWith({
+      waitSeconds: 120,
+      paths: {
+        '@nocobase/remote/client-v2': 'https://remote.com/dist/client-v2/index.js',
+      },
+    });
+  });
+
+  it('should register ESM dev plugins before importing dependent plugins', async () => {
+    const requirejs: any = {
+      requirejs: vi.fn(),
+    };
+    requirejs.requirejs.config = vi.fn();
+
+    const mockDefine: any = vi.fn();
+    window.define = mockDefine;
+
+    const plugins = await getPlugins({
+      requirejs,
+      pluginData: [
+        {
+          name: '@nocobase/dependent',
+          packageName: '@nocobase/dependent',
+          url: createModuleUrl(`
+              const dependency = window.__nocobase_app_dev_plugins__ && window.__nocobase_app_dev_plugins__['@nocobase/dependency/client-v2'];
+            export default class DependentPlugin extends dependency.default {
+              static SharedBase = dependency.SharedBase;
+            }
+          `),
+          devMode: 'esm',
+          appDevDependencies: ['@nocobase/dependency'],
+        },
+        {
+          name: '@nocobase/dependency',
+          packageName: '@nocobase/dependency',
+          url: createModuleUrl('export class SharedBase {}; export default class DependencyPlugin {}'),
+          devMode: 'esm',
+        },
+      ] as any,
+    });
+
+    const dependencyModule = window.__nocobase_app_dev_plugins__['@nocobase/dependency/client-v2'] as {
+      default?: unknown;
+      SharedBase?: unknown;
+    };
+    const dependentPlugin = plugins[1][1] as (typeof plugins)[number][1] & { SharedBase?: unknown };
+
+    expect(plugins.map(([name]) => name)).toEqual(['@nocobase/dependency', '@nocobase/dependent']);
+    expect(dependencyModule.SharedBase).toBeDefined();
+    expect(plugins[0][1]).toBe(dependencyModule.default);
+    expect(dependentPlugin.SharedBase).toBe(dependencyModule.SharedBase);
+    expect(mockDefine).toHaveBeenCalledWith('@nocobase/dependency/client-v2', expect.any(Function));
+    expect(requirejs.requirejs.config).not.toHaveBeenCalled();
+  });
+
+  it('should load RequireJS dependencies before ESM dev plugins', async () => {
+    class DependencyPlugin extends Plugin {}
+    const SharedBase = { source: 'remote' };
+    const dependencyModule = {
+      SharedBase,
+      default: DependencyPlugin,
+    };
+    const requirejs: any = {
+      requirejs: vi.fn((packageNames, resolve) => {
+        expect(packageNames).toEqual(['@nocobase/remote-dependency/client-v2']);
+        resolve(dependencyModule);
+      }),
+    };
+    requirejs.requirejs.config = vi.fn();
+
+    window.define = vi.fn();
+
+    const plugins = await getPlugins({
+      requirejs,
+      pluginData: [
+        {
+          name: '@nocobase/dependent',
+          packageName: '@nocobase/dependent',
+          url: createModuleUrl(`
+            const dependency = window.__nocobase_app_dev_plugins__ && window.__nocobase_app_dev_plugins__['@nocobase/remote-dependency/client-v2'];
+            export default class DependentPlugin extends dependency.default {
+              static SharedBase = dependency.SharedBase;
+            }
+          `),
+          devMode: 'esm',
+          appDevDependencies: ['@nocobase/remote-dependency'],
+        },
+        {
+          name: '@nocobase/remote-dependency',
+          packageName: '@nocobase/remote-dependency',
+          url: 'https://dependency.com',
+        },
+      ] as any,
+    });
+
+    const dependentPlugin = plugins[1][1] as (typeof plugins)[number][1] & { SharedBase?: unknown };
+
+    expect(plugins.map(([name]) => name)).toEqual(['@nocobase/remote-dependency', '@nocobase/dependent']);
+    expect(window.__nocobase_app_dev_plugins__['@nocobase/remote-dependency/client-v2']).toBe(dependencyModule);
+    expect(dependentPlugin.SharedBase).toBe(SharedBase);
+  });
+
   it('should configure remote plugin paths with /client-v2 module ids', () => {
     const requirejs: any = {
       requirejs: {

package/src/__tests__/useCurrentRoles.test.tsx

@@ -0,0 +1,100 @@
+/**
+ * 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 { FlowEngine, FlowEngineProvider } from '@nocobase/flow-engine';
+import { renderHook } from '@testing-library/react';
+import React from 'react';
+import { describe, expect, it } from 'vitest';
+import { ACLContext } from '../acl';
+import { useCurrentRoles } from '../nocobase-buildin-plugin';
+
+type AclContextValue = React.ContextType<typeof ACLContext>;
+
+function makeAclValue(allowAnonymous: boolean): AclContextValue {
+  return {
+    loading: false,
+    data: {
+      data: { allowAnonymous },
+      meta: {},
+    },
+    refresh: async () => undefined,
+  };
+}
+
+function makeEngineWithUser(user: { roles?: Array<{ name: string; title?: string }> } | null): FlowEngine {
+  const engine = new FlowEngine();
+  if (user != null) {
+    engine.context.defineProperty('user', { value: user });
+  }
+  return engine;
+}
+
+function makeWrapper(opts: { engine: FlowEngine; acl: AclContextValue }) {
+  const Wrapper: React.FC = ({ children }) => (
+    <FlowEngineProvider engine={opts.engine}>
+      <ACLContext.Provider value={opts.acl}>{children}</ACLContext.Provider>
+    </FlowEngineProvider>
+  );
+  return Wrapper;
+}
+
+describe('useCurrentRoles', () => {
+  it('returns roles from flowEngine.context.user, dropping the synthetic __union__ entry', () => {
+    // `__union__` is a server-side marker for the merged-roles pseudo role and
+    // must never appear in user-facing role pickers — guards against a regression
+    // that broke role assignment in API Keys / SwitchRole pages.
+    const wrapper = makeWrapper({
+      engine: makeEngineWithUser({
+        roles: [
+          { name: '__union__', title: 'Union' },
+          { name: 'root', title: 'Root' },
+          { name: 'member', title: 'Member' },
+        ],
+      }),
+      acl: makeAclValue(false),
+    });
+    const { result } = renderHook(() => useCurrentRoles(), { wrapper });
+    expect(result.current).toEqual([
+      { name: 'root', title: 'Root' },
+      { name: 'member', title: 'Member' },
+    ]);
+  });
+
+  it('appends an anonymous role when ACL allowAnonymous is true', () => {
+    const wrapper = makeWrapper({
+      engine: makeEngineWithUser({ roles: [{ name: 'root', title: 'Root' }] }),
+      acl: makeAclValue(true),
+    });
+    const { result } = renderHook(() => useCurrentRoles(), { wrapper });
+    expect(result.current).toEqual([
+      { name: 'root', title: 'Root' },
+      { name: 'anonymous', title: 'Anonymous' },
+    ]);
+  });
+
+  it('compiles {{t(...)}} templates in role.title via flowEngine.context.t', () => {
+    const engine = makeEngineWithUser({ roles: [{ name: 'admin', title: '{{t("Admin")}}' }] });
+    engine.context.defineProperty('t', { value: () => 'Compiled Title' });
+    const wrapper = makeWrapper({ engine, acl: makeAclValue(false) });
+    const { result } = renderHook(() => useCurrentRoles(), { wrapper });
+    expect(result.current).toEqual([{ name: 'admin', title: 'Compiled Title' }]);
+  });
+
+  it('returns an empty array when no user has been written to engine.context', () => {
+    const wrapper = makeWrapper({ engine: makeEngineWithUser(null), acl: makeAclValue(false) });
+    const { result } = renderHook(() => useCurrentRoles(), { wrapper });
+    expect(result.current).toEqual([]);
+  });
+
+  it('returns just anonymous when no user is set but allowAnonymous is true', () => {
+    const wrapper = makeWrapper({ engine: makeEngineWithUser(null), acl: makeAclValue(true) });
+    const { result } = renderHook(() => useCurrentRoles(), { wrapper });
+    expect(result.current).toEqual([{ name: 'anonymous', title: 'Anonymous' }]);
+  });
+});

package/src/components/PoweredBy.tsx

@@ -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 { css, cx } from '@emotion/css';
+import { parseHTML } from '@nocobase/utils/client';
+import { theme } from 'antd';
+import React from 'react';
+import { useTranslation } from 'react-i18next';
+import { useCurrentAppInfo } from '../hooks/useCurrentAppInfo';
+import { usePlugin } from '../hooks/usePlugin';
+import { getAppVersionHTML } from '../utils/appVersionHTML';
+
+const homePageUrls: Record<string, string> = {
+  'en-US': 'https://www.nocobase.com',
+  'zh-CN': 'https://www.nocobase.com/cn/',
+};
+
+/**
+ * Footer brand rendered on auth pages and other layout entry points. Falls
+ * back to "Powered by NocoBase" when `@nocobase/plugin-custom-brand` is not
+ * installed; otherwise renders the plugin's HTML template with the
+ * `{{appVersion}}` placeholder substituted. The version is escaped via
+ * `getAppVersionHTML` so a malicious app version cannot inject script tags.
+ */
+export function PoweredBy() {
+  const { i18n } = useTranslation();
+  const { token } = theme.useToken();
+  const customBrandPlugin: any = usePlugin('@nocobase/plugin-custom-brand');
+  const appInfo = useCurrentAppInfo();
+  const appVersion = getAppVersionHTML(appInfo?.version);
+  const homePage = homePageUrls[i18n.language] || homePageUrls['en-US'];
+  const brandStyle = css`
+    text-align: center;
+    color: ${token.colorTextDescription};
+    a {
+      color: ${token.colorTextDescription};
+      &:hover {
+        color: ${token.colorText};
+      }
+    }
+  `;
+  const customBrand = customBrandPlugin?.options?.options?.brand;
+
+  if (customBrand) {
+    return (
+      <div
+        className={cx(brandStyle, 'nb-brand')}
+        dangerouslySetInnerHTML={{
+          __html: parseHTML(customBrand, { appVersion }),
+        }}
+      />
+    );
+  }
+
+  return (
+    <div className={brandStyle}>
+      Powered by{' '}
+      <a href={homePage} target="_blank" rel="noreferrer">
+        NocoBase
+      </a>
+    </div>
+  );
+}
+
+export default PoweredBy;