@nocobase/client-v2 2.1.0-beta.37 → 2.1.0-beta.38

package/src/nocobase-buildin-plugin/index.tsx

@@ -15,7 +15,7 @@ import type { Application } from '../Application';
 import { getCurrentV2RedirectPath, getDefaultV2AdminRedirectPath } from '../authRedirect';
 import { AppNotFound } from '../components';
 import { PluginFlowEngine } from '../flow';
-import { AdminLayoutMenuItemModel, AdminLayoutModel } from '../flow/admin-shell/admin-layout';
+import { ADMIN_LAYOUT_MODEL_UID, AdminLayoutMenuItemModel, AdminLayoutModel } from '../flow/admin-shell/admin-layout';
 import { useApp } from '../hooks/useApp';
 import { Plugin } from '../Plugin';
 import { AdminSettingsLayoutModel } from '../settings-center';
@@ -56,6 +56,30 @@ function isAdminRuntimeRoute(pathname: string, basename?: string) {
   return normalizedPathname === '/admin' || normalizedPathname.startsWith('/admin/');
 }
 
+function hasAuthCheckRoute(app: Application, pathname: string) {
+  const matchedRoutes = app.router.matchRoutes(pathname) || [];
+  return matchedRoutes.some((match) => match?.route?.authCheck === true);
+}
+
+function shouldCheckRuntimeRoute(app: Application, pathname: string) {
+  return isAdminRuntimeRoute(pathname, app.router.getBasename()) || hasAuthCheckRoute(app, pathname);
+}
+
+type CurrentUserAuthCheckRouteState = 'skipped' | 'unchecked' | 'required';
+
+function getCurrentUserAuthCheckRouteState(app: Application, pathname: string): CurrentUserAuthCheckRouteState {
+  const basename = app.router.getBasename();
+  if (isBuiltinAuthRoute(pathname, basename) || app.router.isSkippedAuthCheckRoute(pathname)) {
+    return 'skipped';
+  }
+
+  if (!shouldCheckRuntimeRoute(app, pathname)) {
+    return 'unchecked';
+  }
+
+  return 'required';
+}
+
 export const CurrentUserContext = createContext<CurrentUserState | null>(null);
 CurrentUserContext.displayName = 'CurrentUserContext';
 
@@ -87,7 +111,7 @@ export function useCurrentRoles(): CurrentRoleOption[] {
 }
 
 const DataSourceBootstrapProvider: FC = ({ children }) => {
-  const app = useApp();
+  const app = useApp<Application>();
   const location = useLocation();
   const [loading, setLoading] = useState(true);
   const [error, setError] = useState<Error | null>(null);
@@ -98,7 +122,7 @@ const DataSourceBootstrapProvider: FC = ({ children }) => {
     const basename = app.router.getBasename();
     const isSkippedAuthCheckRoute =
       isBuiltinAuthRoute(location.pathname, basename) || app.router.isSkippedAuthCheckRoute(location.pathname);
-    const shouldBootstrap = isAdminRuntimeRoute(location.pathname, basename);
+    const shouldBootstrap = shouldCheckRuntimeRoute(app, location.pathname);
 
     if (isSkippedAuthCheckRoute || !shouldBootstrap) {
       setLoading(false);
@@ -146,28 +170,25 @@ const DataSourceBootstrapProvider: FC = ({ children }) => {
 };
 
 const CurrentUserProvider: FC = ({ children }) => {
-  const app = useApp();
+  const app = useApp<Application>();
   const location = useLocation();
   const navigate = useNavigate();
   const [state, setState] = useState<CurrentUserState>({ loading: true });
-  const pathnameRef = useRef(location.pathname);
-  pathnameRef.current = location.pathname;
   const locationRef = useRef(location);
   locationRef.current = location;
+  const authCheckRouteState = getCurrentUserAuthCheckRouteState(app, location.pathname);
 
   useEffect(() => {
     let mounted = true;
-    const isSkippedAuthCheckRoute =
-      isBuiltinAuthRoute(pathnameRef.current, app.router.getBasename()) ||
-      app.router.isSkippedAuthCheckRoute(pathnameRef.current);
-    const shouldCheckCurrentUser = isAdminRuntimeRoute(pathnameRef.current, app.router.getBasename());
 
-    if (isSkippedAuthCheckRoute || !shouldCheckCurrentUser) {
+    if (authCheckRouteState !== 'required') {
       // 认证页等免鉴权路由不应再执行 `/auth:check`，否则未登录时会重复鉴权并触发重定向抖动。
       setState({ loading: false });
       return;
     }
 
+    setState((previous) => (previous.loading ? previous : { ...previous, loading: true }));
+
     const run = async () => {
       try {
         const res = await app.apiClient.request({
@@ -176,12 +197,14 @@ const CurrentUserProvider: FC = ({ children }) => {
           skipAuth: true,
         });
 
+        if (!mounted) {
+          return;
+        }
+
         const user = res?.data?.data;
         // 服务端通过 `{ code: 302, redirect }` 通知客户端先去某个中间页(例如 2FA 验证页)。这类响应没有 user.id,但也不能视为未登录——否则会和处理 302 的全局响应拦截器 (例如 plugin-two-factor-authentication 注册的那一个)竞态,而 `window.location.replace` 会覆盖更早发出的 `window.location.href`,把用户错误地弹回登录页。让响应拦截器接管跳转。
         if (user?.code === 302) {
-          if (mounted) {
-            setState({ loading: false });
-          }
+          setState({ loading: false });
           return;
         }
         if (user?.id == null) {
@@ -204,13 +227,15 @@ const CurrentUserProvider: FC = ({ children }) => {
           meta: userMeta,
         });
 
-        if (mounted) {
-          setState({
-            data: res?.data,
-            loading: false,
-          });
-        }
+        setState({
+          data: res?.data,
+          loading: false,
+        });
       } catch (error: any) {
+        if (!mounted) {
+          return;
+        }
+
         const isAuthError = error?.response?.status === 401 || error?.status === 401;
         if (isAuthError) {
           navigate(`/signin?redirect=${encodeURIComponent(getCurrentV2RedirectPath(app, locationRef.current))}`, {
@@ -218,19 +243,17 @@ const CurrentUserProvider: FC = ({ children }) => {
           });
           return;
         }
-        if (mounted) {
-          setState({ loading: false });
-        }
+        setState({ loading: false });
         throw error;
       }
     };
 
-    void run();
+    run();
 
     return () => {
       mounted = false;
     };
-  }, [app, navigate]);
+  }, [app, authCheckRouteState, navigate]);
 
   if (state.loading) {
     return app.renderComponent('AppSpin');
@@ -240,7 +263,7 @@ const CurrentUserProvider: FC = ({ children }) => {
 };
 
 const RootRedirect: FC = () => {
-  const app = useApp();
+  const app = useApp<Application>();
   const hasToken = !!app?.apiClient?.auth?.token;
   const targetPath = getDefaultV2AdminRedirectPath(app);
 
@@ -273,6 +296,12 @@ export class NocoBaseBuildInPlugin extends Plugin<any, Application> {
       AdminLayoutMenuItemModel,
       AdminSettingsLayoutModel,
     });
+    this.app.layoutManager.registerLayout({
+      routeName: 'admin',
+      routePath: '/admin',
+      uid: ADMIN_LAYOUT_MODEL_UID,
+      layoutModelClass: 'AdminLayoutModel',
+    });
 
     this.app.pluginSettingsManager.addMenuItem({
       key: 'plugin-manager',
@@ -285,7 +314,7 @@ export class NocoBaseBuildInPlugin extends Plugin<any, Application> {
       menuKey: 'plugin-manager',
       key: 'index',
       title: this.app.i18n.t('Plugin manager'),
-      componentLoader: () => import('../settings-center/PluginManagerPage'),
+      componentLoader: () => import('../settings-center/plugin-manager'),
       aclSnippet: 'pm',
       sort: -200,
     });
@@ -324,10 +353,6 @@ export class NocoBaseBuildInPlugin extends Plugin<any, Application> {
       Component: AppNotFound,
     });
 
-    this.router.add('admin', {
-      path: '/admin',
-      componentLoader: () => import('../flow/components/AdminLayout'),
-    });
     this.router.add('admin.settings', {
       path: '/admin/settings',
       componentLoader: () => import('../settings-center/AdminSettingsLayout'),
@@ -336,23 +361,6 @@ export class NocoBaseBuildInPlugin extends Plugin<any, Application> {
       path: '*',
       Component: Outlet,
     });
-    this.router.add('admin.page', {
-      path: '/admin/:name',
-      componentLoader: () => import('../flow/components/FlowRoute'),
-    });
-
-    this.router.add('admin.page.tab', {
-      path: '/admin/:name/tab/:tabUid',
-      componentLoader: () => import('../flow/components/FlowRoute'),
-    });
-    this.router.add('admin.page.view', {
-      path: '/admin/:name/view/*',
-      componentLoader: () => import('../flow/components/FlowRoute'),
-    });
-    this.router.add('admin.page.tab.view', {
-      path: '/admin/:name/tab/:tabUid/view/*',
-      componentLoader: () => import('../flow/components/FlowRoute'),
-    });
   }
 
   addComponents() {}

package/src/settings-center/index.ts

@@ -9,6 +9,6 @@
 
 export * from './AdminSettingsLayout';
 export * from './AdminSettingsLayoutModel';
-export * from './PluginManagerPage';
+export * from './plugin-manager';
 export * from './SystemSettingsPage';
 export * from './utils';

package/src/settings-center/plugin-manager/BulkEnableButton.tsx

@@ -0,0 +1,111 @@
+/**
+ * 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 { useMemoizedFn } from 'ahooks';
+import { Button, Input, Modal, Table } from 'antd';
+import type { TableProps } from 'antd';
+import _ from 'lodash';
+import React, { useMemo, useState } from 'react';
+import { useTranslation } from 'react-i18next';
+import { useApp } from '../../hooks/useApp';
+import type { IPluginData } from './types';
+
+interface BulkEnableButtonProps {
+  plugins: IPluginData[];
+}
+
+export const BulkEnableButton: React.FC<BulkEnableButtonProps> = ({ plugins }) => {
+  const { t } = useTranslation();
+  const app = useApp();
+  const [isModalOpen, setIsModalOpen] = useState(false);
+  const [searchValue, setSearchValue] = useState('');
+  const [selectedRowKeys, setSelectedRowKeys] = useState<React.Key[]>([]);
+
+  const disabledPlugins = useMemo(() => plugins.filter((plugin) => !plugin.enabled), [plugins]);
+
+  const items = useMemo(() => {
+    const value = searchValue.toLowerCase().trim();
+    if (!value) return disabledPlugins;
+    return disabledPlugins.filter(
+      (plugin) =>
+        (plugin.displayName || '').toLowerCase().includes(value) ||
+        (plugin.description || '').toLowerCase().includes(value),
+    );
+  }, [disabledPlugins, searchValue]);
+
+  const handleOpen = useMemoizedFn(() => setIsModalOpen(true));
+
+  const handleCancel = useMemoizedFn(() => {
+    setSelectedRowKeys([]);
+    setIsModalOpen(false);
+  });
+
+  const handleOk = useMemoizedFn(async () => {
+    await app.apiClient.request({
+      url: 'pm:enable',
+      params: { filterByTk: selectedRowKeys },
+    });
+    setIsModalOpen(false);
+  });
+
+  const columns: TableProps<IPluginData>['columns'] = useMemo(
+    () => [
+      { title: t('Plugin'), dataIndex: 'displayName', ellipsis: true },
+      { title: t('Description'), dataIndex: 'description', ellipsis: true, width: 300 },
+      { title: t('Package name'), dataIndex: 'packageName', width: 300, ellipsis: true },
+    ],
+    [t],
+  );
+
+  return (
+    <>
+      <Button onClick={handleOpen}>{t('Bulk enable')}</Button>
+      <Modal width={1000} title={t('Bulk enable')} open={isModalOpen} onOk={handleOk} onCancel={handleCancel}>
+        <Input
+          style={{ marginBottom: '1em' }}
+          placeholder={t('Search plugin...')}
+          allowClear
+          onChange={(e) => setSearchValue(e.target.value)}
+        />
+        <Table<IPluginData>
+          rowSelection={{
+            type: 'checkbox',
+            selectedRowKeys,
+            onChange(selectedKeys) {
+              const names = items.map((item) => item.name);
+              setSelectedRowKeys((preSelectedRowKeys) => {
+                if (selectedKeys.length === 0) {
+                  return preSelectedRowKeys.filter((key) => !names.includes(String(key)));
+                }
+                if (selectedKeys.length === names.length) {
+                  return _.uniq([...preSelectedRowKeys, ...selectedKeys]);
+                }
+                return preSelectedRowKeys;
+              });
+            },
+            onSelect(record) {
+              setSelectedRowKeys((preSelectedRowKeys) => {
+                if (preSelectedRowKeys.includes(record.name)) {
+                  return preSelectedRowKeys.filter((key) => key !== record.name);
+                }
+                return preSelectedRowKeys.concat(record.name);
+              });
+            },
+          }}
+          rowKey="name"
+          scroll={{ y: '60vh' }}
+          size="small"
+          pagination={false}
+          columns={columns}
+          dataSource={items}
+        />
+      </Modal>
+    </>
+  );
+};

package/src/settings-center/plugin-manager/PluginCard.tsx

@@ -0,0 +1,270 @@
+/**
+ * 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 {
+  CloseCircleFilled,
+  DeleteOutlined,
+  LoadingOutlined,
+  ReadOutlined,
+  SettingOutlined,
+  WarningFilled,
+} from '@ant-design/icons';
+import { css } from '@emotion/css';
+import { useMemoizedFn } from 'ahooks';
+import { App, Card, Divider, Modal, Popconfirm, Result, Space, Switch, Tooltip, Typography, theme } from 'antd';
+import React, { FC, useMemo, useState } from 'react';
+import { useTranslation } from 'react-i18next';
+import { useNavigate } from 'react-router-dom';
+import { useApp } from '../../hooks/useApp';
+import { PluginDetail } from './PluginDetail';
+import type { IPluginData } from './types';
+
+interface PluginCardProps {
+  data: IPluginData;
+}
+
+export const PluginCard: FC<PluginCardProps> = ({ data }) => {
+  const { token } = theme.useToken();
+  const { t } = useTranslation();
+  const navigate = useNavigate();
+  const app = useApp();
+  const { modal } = App.useApp();
+  const [detailOpen, setDetailOpen] = useState(false);
+
+  const { name, displayName, isCompatible, packageName, builtIn, enabled, removable, description, error, homepage } =
+    data;
+
+  const title = displayName || name || packageName;
+
+  const openDetail = useMemoizedFn(() => {
+    if (!error) {
+      setDetailOpen(true);
+    }
+  });
+
+  const handleEnable = useMemoizedFn(async () => {
+    await app.apiClient.request({
+      url: 'pm:enable',
+      params: { filterByTk: name },
+    });
+  });
+
+  const handleDisable = useMemoizedFn(async () => {
+    await app.apiClient.request({
+      url: 'pm:disable',
+      params: { filterByTk: name },
+    });
+  });
+
+  const handleRemove = useMemoizedFn(async () => {
+    await app.apiClient.request({
+      url: 'pm:remove',
+      params: { filterByTk: name },
+    });
+    modal.info({
+      icon: null,
+      width: 520,
+      content: (
+        <Result
+          icon={<LoadingOutlined />}
+          title={t('Plugin removing')}
+          subTitle={t('Plugin is removing, please wait...')}
+        />
+      ),
+      footer: null,
+    });
+    const checkHealth = () => {
+      app.apiClient
+        .request({ url: '__health_check', method: 'get', skipNotify: true })
+        .then((response) => {
+          if (response?.data === 'ok') {
+            window.location.reload();
+          }
+        })
+        .catch(() => {
+          // health check still failing, keep polling
+        });
+    };
+    setInterval(checkHealth, 1000);
+  });
+
+  const handleSwitchChange = useMemoizedFn(async (checked: boolean) => {
+    if (!isCompatible && checked) {
+      modal.confirm({
+        title: t('Plugin dependency version mismatch'),
+        content: t(
+          'The current dependency version of the plugin does not match the version of the application and may not work properly. Are you sure you want to continue enabling the plugin?',
+        ),
+        onOk: handleEnable,
+      });
+      return;
+    }
+    if (!checked) {
+      modal.confirm({
+        title: t('Are you sure to disable this plugin?'),
+        onOk: handleDisable,
+      });
+      return;
+    }
+    await handleEnable();
+  });
+
+  const openSettings = useMemoizedFn(() => {
+    navigate(app.pluginSettingsManager.getRoutePath(name));
+  });
+
+  const cardClassName = useMemo(
+    () => css`
+      display: flex;
+      flex-direction: column;
+      height: 100%;
+
+      .ant-card-body {
+        flex-grow: 1;
+      }
+
+      .ant-card-actions {
+        li .ant-space {
+          gap: ${token.marginXXS}px !important;
+        }
+        li:first-child {
+          width: 80% !important;
+          border-inline-end: 0;
+          text-align: left;
+          padding-inline-start: ${token.padding}px;
+        }
+        li:last-child {
+          width: 20% !important;
+        }
+      }
+    `,
+    [token.marginXXS, token.padding],
+  );
+
+  const cardTitle = (
+    <Space>
+      {error ? (
+        <Tooltip title={t('Plugin loading failed. Please check the server logs.')}>
+          <Typography.Text type="danger">
+            <CloseCircleFilled />
+          </Typography.Text>
+        </Tooltip>
+      ) : null}
+      {!isCompatible ? (
+        <Tooltip title={t('Plugin dependencies check failed')}>
+          <Typography.Text type="warning">
+            <WarningFilled />
+          </Typography.Text>
+        </Tooltip>
+      ) : null}
+      <span>{title}</span>
+    </Space>
+  );
+
+  const linksAction = (
+    <Space split={<Divider type="vertical" />} key="links" size={token.marginXXS}>
+      {homepage && (
+        <a
+          href={homepage}
+          target="_blank"
+          rel="noreferrer"
+          onClick={(event) => event.stopPropagation()}
+          aria-label={t('Docs')}
+        >
+          <ReadOutlined /> {t('Docs')}
+        </a>
+      )}
+      {enabled && app.pluginSettingsManager.has(name) && (
+        <a
+          onClick={(e) => {
+            e.stopPropagation();
+            openSettings();
+          }}
+          aria-label={t('Settings')}
+        >
+          <SettingOutlined /> {t('Settings')}
+        </a>
+      )}
+      {removable && (
+        <Popconfirm
+          key="delete"
+          disabled={builtIn}
+          title={t('Are you sure to delete this plugin?')}
+          onConfirm={(e) => {
+            e?.stopPropagation();
+            handleRemove();
+          }}
+          onCancel={(e) => e?.stopPropagation()}
+          okText={t('Yes')}
+          cancelText={t('No')}
+        >
+          <a
+            onClick={(e) => e.stopPropagation()}
+            aria-label={t('Remove')}
+            style={builtIn ? { color: token.colorTextDisabled, cursor: 'not-allowed' } : undefined}
+          >
+            <DeleteOutlined /> {t('Remove')}
+          </a>
+        </Popconfirm>
+      )}
+    </Space>
+  );
+
+  const switchAction = (
+    <Switch
+      aria-label={t('Enable')}
+      key="enable"
+      size="small"
+      disabled={builtIn || error}
+      onChange={(checked, e) => {
+        e.stopPropagation();
+        handleSwitchChange(checked);
+      }}
+      checked={!!enabled}
+    />
+  );
+
+  return (
+    <>
+      {detailOpen && <PluginDetail plugin={data} onCancel={() => setDetailOpen(false)} />}
+      <Card
+        role="button"
+        aria-label={title}
+        size="small"
+        variant="borderless"
+        hoverable
+        onClick={openDetail}
+        styles={{
+          body: { paddingTop: token.paddingSM },
+          header: { border: 'none', minHeight: 'inherit', paddingTop: token.padding },
+        }}
+        className={cardClassName}
+        title={cardTitle}
+        actions={[linksAction, switchAction]}
+      >
+        <Card.Meta
+          description={
+            <Typography.Paragraph
+              type="secondary"
+              className={css`
+                display: -webkit-box;
+                -webkit-box-orient: vertical;
+                -webkit-line-clamp: 2;
+                overflow: hidden;
+                margin-bottom: 0;
+              `}
+            >
+              {description}
+            </Typography.Paragraph>
+          }
+        />
+      </Card>
+    </>
+  );
+};