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

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

@@ -0,0 +1,177 @@
+/**
+ * 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 { ACLRolesCheckProvider, createMockClient, 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';
+
+class TestAclPlugin extends Plugin {
+  async load() {
+    this.app.use(ACLRolesCheckProvider);
+  }
+}
+
+type MockClientApplication = ReturnType<typeof createMockClient>;
+
+const renderApp = (app: MockClientApplication) => {
+  const Root = app.getRootComponent();
+  render(<Root />);
+};
+
+const waitForGetRequests = async (app: MockClientApplication, urls: string[]) => {
+  await waitFor(
+    () => {
+      const history = app.apiMock.history.get.map((request) => request.url);
+      expect(history).toEqual(expect.arrayContaining(urls));
+    },
+    { timeout: 3000 },
+  );
+};
+
+const setupApp = (pmList: any[]) => {
+  const app = createMockClient({
+    plugins: [NocoBaseBuildInPlugin, TestAclPlugin],
+    router: { type: 'memory', initialEntries: ['/admin/settings/plugin-manager'] },
+  });
+
+  app.apiMock.onGet('/auth:check').reply(200, {
+    data: { id: 1, nickname: 'Super Admin' },
+  });
+  app.apiMock.onGet('app:getLang').reply(200, {
+    data: { lang: 'en-US', resources: { client: {} }, cron: {} },
+  });
+  app.apiMock.onGet('app:getInfo').reply(200, { data: { id: 'mock-app' } });
+  app.apiMock.onGet('roles:check').reply(200, {
+    data: { role: 'root', snippets: ['pm', 'pm.system-settings.system-settings'] },
+  });
+  app.apiMock.onGet('/desktopRoutes:listAccessible').reply(200, { data: [] });
+  app.apiMock.onGet('systemSettings:get').reply(200, {
+    data: {
+      id: 1,
+      title: 'NocoBase',
+      raw_title: 'NocoBase',
+      enabledLanguages: ['en-US'],
+      logo: null,
+    },
+  });
+  app.apiMock.onGet('pm:list').reply(200, { data: pmList });
+  app.apiMock.onGet('pm:listEnabledV2').reply(200, { data: [] });
+
+  // pm:* mutations default to GET in axios when called via api.request without method
+  app.apiMock.onGet('pm:enable').reply(200, { data: {} });
+  app.apiMock.onGet('pm:disable').reply(200, { data: {} });
+  app.apiMock.onGet('pm:remove').reply(200, { data: {} });
+
+  return app;
+};
+
+describe('plugin-manager page', () => {
+  it('fires pm:enable when toggling switch on a disabled plugin', async () => {
+    const app = setupApp([
+      {
+        name: 'demo-plugin',
+        packageName: '@nocobase/demo-plugin',
+        displayName: 'Demo plugin',
+        description: 'A demo',
+        enabled: false,
+        builtIn: false,
+        removable: true,
+        version: '0.1.0',
+        isCompatible: true,
+        keywords: [],
+      },
+    ]);
+
+    renderApp(app);
+    await waitForGetRequests(app, ['/auth:check', 'roles:check', 'pm:list']);
+
+    const card = await screen.findByRole('button', { name: 'Demo plugin' });
+    const switchControl = within(card.closest('.ant-card') as HTMLElement).getByRole('switch');
+    expect(switchControl).toHaveAttribute('aria-checked', 'false');
+
+    fireEvent.click(switchControl);
+
+    await waitFor(() => {
+      const enableCall = app.apiMock.history.get.find((req) => req.url === 'pm:enable');
+      expect(enableCall).toBeDefined();
+      expect(enableCall?.params).toMatchObject({ filterByTk: 'demo-plugin' });
+    });
+  });
+
+  it('fires pm:disable after confirm when toggling switch on an enabled plugin', async () => {
+    const app = setupApp([
+      {
+        name: 'demo-plugin',
+        packageName: '@nocobase/demo-plugin',
+        displayName: 'Demo plugin',
+        description: 'A demo',
+        enabled: true,
+        builtIn: false,
+        removable: true,
+        version: '0.1.0',
+        isCompatible: true,
+        keywords: [],
+      },
+    ]);
+
+    renderApp(app);
+    await waitForGetRequests(app, ['/auth:check', 'roles:check', 'pm:list']);
+
+    const card = await screen.findByRole('button', { name: 'Demo plugin' });
+    const switchControl = within(card.closest('.ant-card') as HTMLElement).getByRole('switch');
+    expect(switchControl).toHaveAttribute('aria-checked', 'true');
+
+    fireEvent.click(switchControl);
+
+    const confirmTitle = await screen.findByText('Are you sure to disable this plugin?');
+    const confirmDialog = confirmTitle.closest('.ant-modal-confirm') as HTMLElement;
+    expect(confirmDialog).not.toBeNull();
+    const okButton = within(confirmDialog).getByText('OK');
+    fireEvent.click(okButton);
+
+    await waitFor(() => {
+      const disableCall = app.apiMock.history.get.find((req) => req.url === 'pm:disable');
+      expect(disableCall).toBeDefined();
+      expect(disableCall?.params).toMatchObject({ filterByTk: 'demo-plugin' });
+    });
+  });
+
+  it('fires pm:remove after Popconfirm on a removable plugin', async () => {
+    const app = setupApp([
+      {
+        name: 'demo-plugin',
+        packageName: '@nocobase/demo-plugin',
+        displayName: 'Demo plugin',
+        description: 'A demo',
+        enabled: false,
+        builtIn: false,
+        removable: true,
+        version: '0.1.0',
+        isCompatible: true,
+        keywords: [],
+      },
+    ]);
+
+    renderApp(app);
+    await waitForGetRequests(app, ['/auth:check', 'roles:check', 'pm:list']);
+
+    const removeLink = await screen.findByText('Remove');
+    fireEvent.click(removeLink);
+
+    const yesButton = await screen.findByRole('button', { name: 'Yes' });
+    fireEvent.click(yesButton);
+
+    await waitFor(() => {
+      const removeCall = app.apiMock.history.get.find((req) => req.url === 'pm:remove');
+      expect(removeCall).toBeDefined();
+      expect(removeCall?.params).toMatchObject({ filterByTk: 'demo-plugin' });
+    });
+  });
+});

package/src/__tests__/plugin.test.ts

@@ -0,0 +1,61 @@
+/**
+ * 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';
+
+describe('PluginManager', () => {
+  it('should request remote plugins from pm:listEnabledV2', async () => {
+    const app = createMockClient({
+      loadRemotePlugins: true,
+    });
+    app.apiMock.onGet('pm:listEnabledV2').reply(200, { data: [] });
+
+    await app.load();
+
+    expect(app.apiMock.history.get).toHaveLength(1);
+    expect(app.apiMock.history.get[0]?.url).toBe('pm:listEnabledV2');
+  });
+
+  it('should not request remote plugins from pm:listEnabled', async () => {
+    const app = createMockClient({
+      loadRemotePlugins: true,
+    });
+    app.apiMock.onGet('pm:listEnabledV2').reply(200, { data: [] });
+
+    await app.load();
+
+    expect(app.apiMock.history.get.some((request) => request.url === 'pm:listEnabled')).toBe(false);
+  });
+
+  it('should define client-v2 module ids for dev plugins', async () => {
+    class DemoPlugin extends Plugin {}
+
+    const mockDefine: any = vi.fn();
+    window.define = mockDefine;
+
+    const app = createMockClient({
+      loadRemotePlugins: true,
+      devDynamicImport: vi.fn().mockResolvedValue({ default: DemoPlugin }) as any,
+    });
+    app.apiMock.onGet('pm:listEnabledV2').reply(200, {
+      data: [
+        {
+          name: '@nocobase/demo',
+          packageName: '@nocobase/demo',
+          url: 'https://demo.com/dist/client-v2/index.js',
+        },
+      ],
+    });
+
+    await app.load();
+
+    expect(mockDefine).toHaveBeenCalledWith('@nocobase/demo/client-v2', expect.any(Function));
+    expect(mockDefine).not.toHaveBeenCalledWith('@nocobase/demo/client', expect.any(Function));
+  });
+});

package/src/__tests__/remotePlugins.test.ts

@@ -0,0 +1,313 @@
+/**
+ * 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 { Plugin } from '../Plugin';
+import { getRequireJs } from '../utils/requirejs';
+import { configRequirejs, defineDevPlugins, getPlugins } from '../utils/remotePlugins';
+
+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 {}
+
+    const mockDefine: any = vi.fn();
+    window.define = mockDefine;
+
+    defineDevPlugins({
+      '@nocobase/demo': DemoPlugin,
+    });
+
+    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 {}
+
+    const requirejs: any = {
+      requirejs: vi.fn(),
+    };
+    requirejs.requirejs.config = vi.fn();
+    requirejs.requirejs.requirejs = 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 }) as any,
+    });
+
+    expect(plugins).toEqual([['@nocobase/demo', DemoPlugin]]);
+    expect(mockDefine).toHaveBeenCalledWith('@nocobase/demo/client-v2', expect.any(Function));
+    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: {
+        config: vi.fn(),
+      },
+    };
+
+    configRequirejs(requirejs, [
+      {
+        packageName: '@nocobase/demo',
+        url: '/static/plugins/@nocobase/demo/dist/client-v2/index.js',
+      },
+    ] as any);
+
+    expect(requirejs.requirejs.config).toHaveBeenCalledWith({
+      waitSeconds: 120,
+      paths: {
+        '@nocobase/demo/client-v2': '/static/plugins/@nocobase/demo/dist/client-v2/index.js',
+      },
+    });
+  });
+
+  it('should not append duplicate .js for plugin URLs without query strings', () => {
+    const requirejs = getRequireJs();
+
+    requirejs.requirejs.config({
+      paths: {
+        '@nocobase/demo/client-v2': '/static/plugins/@nocobase/demo/dist/client-v2/index.js',
+      },
+    });
+
+    expect(requirejs.requirejs.toUrl('@nocobase/demo/client-v2')).toBe(
+      '/static/plugins/@nocobase/demo/dist/client-v2/index.js',
+    );
+  });
+
+  it('should keep hashed plugin URLs unchanged', () => {
+    const requirejs = getRequireJs();
+
+    requirejs.requirejs.config({
+      paths: {
+        '@nocobase/demo/client-v2': '/static/plugins/@nocobase/demo/dist/client-v2/index.js?hash=12345678',
+      },
+    });
+
+    expect(requirejs.requirejs.toUrl('@nocobase/demo/client-v2')).toBe(
+      '/static/plugins/@nocobase/demo/dist/client-v2/index.js?hash=12345678',
+    );
+  });
+});