This is an automated email from the ASF dual-hosted git repository.

klesh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake.git


The following commit(s) were added to refs/heads/main by this push:
     new fc10491d2 feat(config-ui): support dynamic plugins (#6327)
fc10491d2 is described below

commit fc10491d2ca20c3c1637f74fe64d176ea4d03b39
Author: 青湛 <[email protected]>
AuthorDate: Thu Oct 26 20:31:51 2023 +1300

    feat(config-ui): support dynamic plugins (#6327)
---
 config-ui/env.example                              |   3 +
 config-ui/src/api/plugin/webhook/index.ts          |   8 +-
 config-ui/src/{App.tsx => app/routrer.tsx}         |   7 +-
 config-ui/src/app/store.ts                         |   4 +-
 .../features/connections/{ => components}/index.ts |   1 -
 .../features/connections/{ => components}/name.tsx |   7 +-
 config-ui/src/features/connections/index.ts        |   2 +-
 config-ui/src/features/connections/slice.ts        |  47 +++++----
 config-ui/src/features/connections/utils.ts        |  12 +--
 config-ui/src/main.tsx                             |   7 +-
 .../pages/blueprint/connection-detail/index.tsx    |   4 +-
 config-ui/src/pages/connection/home/index.tsx      | 111 ++++++++++++---------
 .../plugins/components/connection-form/index.tsx   |   4 +-
 .../components/data-scope-remote/search-local.tsx  |   4 +-
 .../components/data-scope-remote/search-remote.tsx |   4 +-
 config-ui/src/plugins/index.ts                     |   5 +-
 config-ui/src/plugins/register/azure/config.tsx    |   4 +-
 config-ui/src/plugins/register/bamboo/config.ts    |   4 +-
 .../src/plugins/register/bitbucket/config.tsx      |   4 +-
 config-ui/src/plugins/register/github/config.tsx   |   4 +-
 config-ui/src/plugins/register/gitlab/config.tsx   |   4 +-
 .../src/plugins/{config.ts => register/index.ts}   |  29 +++---
 config-ui/src/plugins/register/jenkins/config.ts   |   4 +-
 config-ui/src/plugins/register/jira/config.tsx     |   4 +-
 .../src/plugins/register/pagerduty/config.tsx      |   4 +-
 config-ui/src/plugins/register/sonarqube/config.ts |   4 +-
 config-ui/src/plugins/register/tapd/config.tsx     |   6 +-
 config-ui/src/plugins/register/webhook/config.ts   |   4 +-
 config-ui/src/plugins/register/zentao/config.tsx   |   4 +-
 config-ui/src/plugins/utils.ts                     |  10 +-
 config-ui/src/routes/layout/layout.tsx             |   4 +-
 config-ui/src/routes/layout/loader.ts              |  22 +++-
 config-ui/src/types/connection.ts                  |  15 +++
 config-ui/src/types/index.ts                       |   1 +
 .../src/{plugins/types.ts => types/plugin.ts}      |   4 +-
 config-ui/src/types/webhook.ts                     |   2 +-
 config-ui/src/vite-env.d.ts                        |   8 ++
 config-ui/vite.config.ts                           |   2 +
 38 files changed, 203 insertions(+), 174 deletions(-)

diff --git a/config-ui/env.example b/config-ui/env.example
new file mode 100644
index 000000000..bf3d10d30
--- /dev/null
+++ b/config-ui/env.example
@@ -0,0 +1,3 @@
+# All plugins are loaded by default, optional plugins can be loaded
+# eg. DEVLAKE_PLUGINS=github,gitlab
+DEVLAKE_PLUGINS=
diff --git a/config-ui/src/api/plugin/webhook/index.ts 
b/config-ui/src/api/plugin/webhook/index.ts
index 18c5c6621..a89ac1392 100644
--- a/config-ui/src/api/plugin/webhook/index.ts
+++ b/config-ui/src/api/plugin/webhook/index.ts
@@ -18,13 +18,13 @@
 
 import * as connection from '../../connection';
 
-import { IApiWebhook } from '@/types';
+import { IWebhookAPI } from '@/types';
 
-export const list = (): Promise<IApiWebhook[]> => connection.list('webhook') 
as any;
+export const list = (): Promise<IWebhookAPI[]> => connection.list('webhook') 
as any;
 
-export const get = (id: ID): Promise<IApiWebhook> => connection.get('webhook', 
id) as any;
+export const get = (id: ID): Promise<IWebhookAPI> => connection.get('webhook', 
id) as any;
 
-export const create = (payload: any): Promise<IApiWebhook> => 
connection.create('webhook', payload) as any;
+export const create = (payload: any): Promise<IWebhookAPI> => 
connection.create('webhook', payload) as any;
 
 export const remove = (id: ID) => connection.remove('webhook', id);
 
diff --git a/config-ui/src/App.tsx b/config-ui/src/app/routrer.tsx
similarity index 90%
rename from config-ui/src/App.tsx
rename to config-ui/src/app/routrer.tsx
index 11757250e..c3e86021b 100644
--- a/config-ui/src/App.tsx
+++ b/config-ui/src/app/routrer.tsx
@@ -16,9 +16,8 @@
  *
  */
 
-import { createBrowserRouter, Navigate, RouterProvider, json } from 
'react-router-dom';
+import { createBrowserRouter, Navigate, json } from 'react-router-dom';
 
-import { PageLoading } from '@/components';
 import {
   ConnectionHomePage,
   ConnectionDetailPage,
@@ -33,7 +32,7 @@ import { Error, ErrorEnum } from '@/routes/error';
 import { Pipelines, Pipeline } from '@/routes/pipeline';
 import { ApiKeys } from '@/routes/api-keys';
 
-const router = createBrowserRouter([
+export const router = createBrowserRouter([
   {
     path: 'db-migrate',
     element: <></>,
@@ -99,5 +98,3 @@ const router = createBrowserRouter([
     ],
   },
 ]);
-
-export const App = () => <RouterProvider router={router} 
fallbackElement={<PageLoading />} />;
diff --git a/config-ui/src/app/store.ts b/config-ui/src/app/store.ts
index 4e27d7f1d..b838101b5 100644
--- a/config-ui/src/app/store.ts
+++ b/config-ui/src/app/store.ts
@@ -17,11 +17,11 @@
  */
 
 import { configureStore, ThunkAction, Action } from '@reduxjs/toolkit';
-import ConnectionSlice from '@/features/connections/slice';
+import connectionsSlice from '@/features/connections/slice';
 
 export const store = configureStore({
   reducer: {
-    connections: ConnectionSlice,
+    connections: connectionsSlice,
   },
 });
 
diff --git a/config-ui/src/features/connections/index.ts 
b/config-ui/src/features/connections/components/index.ts
similarity index 97%
copy from config-ui/src/features/connections/index.ts
copy to config-ui/src/features/connections/components/index.ts
index 51ef44992..113c17b4a 100644
--- a/config-ui/src/features/connections/index.ts
+++ b/config-ui/src/features/connections/components/index.ts
@@ -16,5 +16,4 @@
  *
  */
 
-export * from './slice';
 export * from './name';
diff --git a/config-ui/src/features/connections/name.tsx 
b/config-ui/src/features/connections/components/name.tsx
similarity index 81%
rename from config-ui/src/features/connections/name.tsx
rename to config-ui/src/features/connections/components/name.tsx
index ac819657a..b3b617f8e 100644
--- a/config-ui/src/features/connections/name.tsx
+++ b/config-ui/src/features/connections/components/name.tsx
@@ -18,8 +18,7 @@
 
 import { useAppSelector } from '@/app/hook';
 
-import { selectConnection } from './slice';
-import { IConnection } from '@/types';
+import { selectConnection } from '../slice';
 
 interface Props {
   plugin: string;
@@ -27,6 +26,6 @@ interface Props {
 }
 
 export const ConnectionName = ({ plugin, connectionId }: Props) => {
-  const connection = useAppSelector((state) => selectConnection(state, 
`${plugin}-${connectionId}`)) as IConnection;
-  return <span>{connection ? connection.name : 
`${plugin}/connections/${connectionId}`}</span>;
+  const connection = useAppSelector((state) => selectConnection(state, 
`${plugin}-${connectionId}`));
+  return <span>{connection?.name ?? 
`${plugin}/connections/${connectionId}`}</span>;
 };
diff --git a/config-ui/src/features/connections/index.ts 
b/config-ui/src/features/connections/index.ts
index 51ef44992..8cf36b476 100644
--- a/config-ui/src/features/connections/index.ts
+++ b/config-ui/src/features/connections/index.ts
@@ -16,5 +16,5 @@
  *
  */
 
+export * from './components';
 export * from './slice';
-export * from './name';
diff --git a/config-ui/src/features/connections/slice.ts 
b/config-ui/src/features/connections/slice.ts
index 60567509a..2908df406 100644
--- a/config-ui/src/features/connections/slice.ts
+++ b/config-ui/src/features/connections/slice.ts
@@ -21,45 +21,43 @@ import { flatten } from 'lodash';
 
 import API from '@/api';
 import { RootState } from '@/app/store';
-import { PluginConfig } from '@/plugins';
 import { IConnection, IConnectionStatus, IWebhook, IStatus } from '@/types';
 
 import { transformConnection, transformWebhook } from './utils';
 
 const initialState: {
+  status: IStatus;
+  plugins: string[];
   connections: IConnection[];
   webhooks: IWebhook[];
-  status: IStatus;
 } = {
+  status: 'idle',
+  plugins: [],
   connections: [],
   webhooks: [],
-  status: 'idle',
 };
 
-export const init = createAsyncThunk('connections/init', async () => {
-  const getConnections = async (plugin: string) => {
-    try {
-      return await API.connection.list(plugin);
-    } catch {
-      return [];
-    }
-  };
-
+export const init = createAsyncThunk('connections/init', async (plugins: 
string[]) => {
   const connections = await Promise.all(
-    PluginConfig.filter((p) => p.plugin !== 'webhook').map(async ({ plugin }) 
=> {
-      const connections = await getConnections(plugin);
-      return connections.map((connection) => transformConnection(plugin, 
connection));
-    }),
+    plugins
+      .filter((plugin) => plugin !== 'webhook')
+      .map(async (plugin) => {
+        const connections = await API.connection.list(plugin);
+        return connections.map((connection) => transformConnection(plugin, 
connection));
+      }),
   );
 
   const webhooks = await Promise.all(
-    PluginConfig.filter((p) => p.plugin === 'webhook').map(async () => {
-      const webhooks = await API.plugin.webhook.list();
-      return webhooks.map((webhook) => transformWebhook(webhook));
-    }),
+    plugins
+      .filter((plugin) => plugin === 'webhook')
+      .map(async () => {
+        const webhooks = await API.plugin.webhook.list();
+        return webhooks.map((webhook) => transformWebhook(webhook));
+      }),
   );
 
   return {
+    plugins,
     connections: flatten(connections),
     webhooks: flatten(webhooks),
   };
@@ -131,7 +129,7 @@ export const renewWebhookApiKey = 
createAsyncThunk('connections/renewWebhookApiK
   };
 });
 
-export const ConnectionsSlice = createSlice({
+export const connectionsSlice = createSlice({
   name: 'connections',
   initialState,
   reducers: {},
@@ -141,6 +139,7 @@ export const ConnectionsSlice = createSlice({
         state.status = 'loading';
       })
       .addCase(init.fulfilled, (state, action) => {
+        state.plugins = action.payload.plugins;
         state.connections = action.payload.connections;
         state.webhooks = action.payload.webhooks;
         state.status = 'success';
@@ -190,12 +189,12 @@ export const ConnectionsSlice = createSlice({
   },
 });
 
-export const {} = ConnectionsSlice.actions;
-
-export default ConnectionsSlice.reducer;
+export default connectionsSlice.reducer;
 
 export const selectStatus = (state: RootState) => state.connections.status;
 
+export const selectPlugins = (state: RootState) => state.connections.plugins;
+
 export const selectAllConnections = (state: RootState) => 
state.connections.connections;
 
 export const selectConnections = (state: RootState, plugin: string) =>
diff --git a/config-ui/src/features/connections/utils.ts 
b/config-ui/src/features/connections/utils.ts
index 1de94647d..a4c158aa7 100644
--- a/config-ui/src/features/connections/utils.ts
+++ b/config-ui/src/features/connections/utils.ts
@@ -16,14 +16,12 @@
  *
  */
 
-import * as T from '@/api/connection/types';
-import type { PluginConfigType } from '@/plugins';
-import { PluginConfig } from '@/plugins';
+import { getPluginConfig } from '@/plugins';
 
-import { IConnection, IConnectionStatus, IApiWebhook, IWebhook } from 
'@/types';
+import { IConnectionAPI, IConnection, IConnectionStatus, IWebhookAPI, IWebhook 
} from '@/types';
 
-export const transformConnection = (plugin: string, connection: T.Connection): 
IConnection => {
-  const config = PluginConfig.find((p) => p.plugin === plugin) as 
PluginConfigType;
+export const transformConnection = (plugin: string, connection: 
IConnectionAPI): IConnection => {
+  const config = getPluginConfig(plugin);
   return {
     unique: `${plugin}-${connection.id}`,
     plugin,
@@ -44,7 +42,7 @@ export const transformConnection = (plugin: string, 
connection: T.Connection): I
   };
 };
 
-export const transformWebhook = (connection: IApiWebhook): IWebhook => {
+export const transformWebhook = (connection: IWebhookAPI): IWebhook => {
   return {
     id: connection.id,
     name: connection.name,
diff --git a/config-ui/src/main.tsx b/config-ui/src/main.tsx
index 155d47978..e72bc3db5 100644
--- a/config-ui/src/main.tsx
+++ b/config-ui/src/main.tsx
@@ -18,14 +18,17 @@
 
 import ReactDOM from 'react-dom';
 import { Provider } from 'react-redux';
+import { RouterProvider } from 'react-router-dom';
+
+import { PageLoading } from '@/components';
 
-import { App } from './App';
 import { store } from './app/store';
+import { router } from './app/routrer';
 import './index.css';
 
 ReactDOM.render(
   <Provider store={store}>
-    <App />
+    <RouterProvider router={router} fallbackElement={<PageLoading />} />
   </Provider>,
   document.getElementById('root'),
 );
diff --git a/config-ui/src/pages/blueprint/connection-detail/index.tsx 
b/config-ui/src/pages/blueprint/connection-detail/index.tsx
index bb13c4b05..42b03b044 100644
--- a/config-ui/src/pages/blueprint/connection-detail/index.tsx
+++ b/config-ui/src/pages/blueprint/connection-detail/index.tsx
@@ -24,7 +24,7 @@ import { Popover2 } from '@blueprintjs/popover2';
 import API from '@/api';
 import { PageLoading, PageHeader, ExternalLink, Message, Buttons, Table, 
Dialog } from '@/components';
 import { useRefreshData, useTips } from '@/hooks';
-import { DataScopeSelect, getPluginScopeId, PluginConfig, PluginConfigType } 
from '@/plugins';
+import { DataScopeSelect, getPluginConfig, getPluginScopeId } from '@/plugins';
 import { operator } from '@/utils';
 
 import { encodeName } from '../../project/utils';
@@ -52,7 +52,7 @@ export const BlueprintConnectionDetailPage = () => {
 
   const [plugin, connectionId] = unique.split('-');
 
-  const pluginConfig = PluginConfig.find((p) => p.plugin === plugin) as 
PluginConfigType;
+  const pluginConfig = getPluginConfig(plugin);
 
   const { ready, data } = useRefreshData(async () => {
     const [blueprint, connection] = await Promise.all([
diff --git a/config-ui/src/pages/connection/home/index.tsx 
b/config-ui/src/pages/connection/home/index.tsx
index bbe948637..fbd3e7c58 100644
--- a/config-ui/src/pages/connection/home/index.tsx
+++ b/config-ui/src/pages/connection/home/index.tsx
@@ -16,29 +16,32 @@
  *
  */
 
-import { useState } from 'react';
+import { useState, useMemo } from 'react';
 import { useNavigate } from 'react-router-dom';
 import { Tag, Intent } from '@blueprintjs/core';
 
 import { useAppSelector } from '@/app/hook';
 import { Dialog } from '@/components';
-import { selectAllConnections, selectWebhooks } from '@/features/connections';
-import { PluginConfig, PluginConfigType, ConnectionList, ConnectionForm } from 
'@/plugins';
+import { selectPlugins, selectAllConnections, selectWebhooks } from 
'@/features/connections';
+import { getPluginConfig, ConnectionList, ConnectionForm } from '@/plugins';
 
 import * as S from './styled';
 
 export const ConnectionHomePage = () => {
   const [type, setType] = useState<'list' | 'form'>();
-  const [pluginConfig, setPluginConfig] = useState<PluginConfigType>();
+  const [plugin, setPlugin] = useState('');
 
+  const plugins = useAppSelector(selectPlugins);
   const connections = useAppSelector(selectAllConnections);
   const webhooks = useAppSelector(selectWebhooks);
 
   const navigate = useNavigate();
 
-  const handleShowListDialog = (pluginConfig: PluginConfigType) => {
+  const pluginConfig = useMemo(() => getPluginConfig(plugin), [plugin]);
+
+  const handleShowListDialog = (plugin: string) => {
     setType('list');
-    setPluginConfig(pluginConfig);
+    setPlugin(plugin);
   };
 
   const handleShowFormDialog = () => {
@@ -47,7 +50,7 @@ export const ConnectionHomePage = () => {
 
   const handleHideDialog = () => {
     setType(undefined);
-    setPluginConfig(undefined);
+    setPlugin('');
   };
 
   const handleSuccessAfter = async (plugin: string, id: ID) => {
@@ -63,48 +66,58 @@ export const ConnectionHomePage = () => {
           your Projects.
         </h5>
       </div>
-      <div className="block">
-        <h2>Data Connections</h2>
-        <h5>
-          You can create and manage data connections for the following data 
sources and use them in your Projects.
-        </h5>
-        <ul>
-          {PluginConfig.filter((p) => p.plugin !== 'webhook').map((p) => {
-            const connectionCount = connections.filter((cs) => cs.plugin === 
p.plugin).length;
-            return (
-              <li key={p.plugin} onClick={() => handleShowListDialog(p)}>
-                <img src={p.icon} alt="" />
-                <span className="name">{p.name}</span>
-                <S.Count>{connectionCount ? `${connectionCount} connections` : 
'No connection'}</S.Count>
-                {p.isBeta && (
-                  <Tag intent={Intent.WARNING} round>
-                    beta
-                  </Tag>
-                )}
-              </li>
-            );
-          })}
-        </ul>
-      </div>
-      <div className="block">
-        <h2>Webhooks</h2>
-        <h5>
-          You can use webhooks to import deployments and incidents from the 
unsupported data integrations to calculate
-          DORA metrics, etc.
-        </h5>
-        <ul>
-          {PluginConfig.filter((p) => p.plugin === 'webhook').map((p) => {
-            const webhookCount = webhooks.length;
-            return (
-              <li key={p.plugin} onClick={() => handleShowListDialog(p)}>
-                <img src={p.icon} alt="" />
-                <span className="name">{p.name}</span>
-                <S.Count>{webhookCount ? `${webhookCount} connections` : 'No 
connection'}</S.Count>
-              </li>
-            );
-          })}
-        </ul>
-      </div>
+      {!!plugins.filter((plugin) => plugin !== 'webhook').length && (
+        <div className="block">
+          <h2>Data Connections</h2>
+          <h5>
+            You can create and manage data connections for the following data 
sources and use them in your Projects.
+          </h5>
+          <ul>
+            {plugins
+              .filter((plugin) => plugin !== 'webhook')
+              .map((plugin) => {
+                const pluginConfig = getPluginConfig(plugin);
+                const connectionCount = connections.filter((cs) => cs.plugin 
=== plugin).length;
+                return (
+                  <li key={plugin} onClick={() => 
handleShowListDialog(plugin)}>
+                    <img src={pluginConfig.icon} alt="" />
+                    <span className="name">{pluginConfig.name}</span>
+                    <S.Count>{connectionCount ? `${connectionCount} 
connections` : 'No connection'}</S.Count>
+                    {pluginConfig.isBeta && (
+                      <Tag intent={Intent.WARNING} round>
+                        beta
+                      </Tag>
+                    )}
+                  </li>
+                );
+              })}
+          </ul>
+        </div>
+      )}
+      {plugins.includes('webhook') && (
+        <div className="block">
+          <h2>Webhooks</h2>
+          <h5>
+            You can use webhooks to import deployments and incidents from the 
unsupported data integrations to calculate
+            DORA metrics, etc.
+          </h5>
+          <ul>
+            {plugins
+              .filter((plugin) => plugin === 'webhook')
+              .map((plugin) => {
+                const pluginConfig = getPluginConfig(plugin);
+                const connectionCount = webhooks.length;
+                return (
+                  <li key={plugin} onClick={() => 
handleShowListDialog(plugin)}>
+                    <img src={pluginConfig.icon} alt="" />
+                    <span className="name">{pluginConfig.name}</span>
+                    <S.Count>{connectionCount ? `${connectionCount} 
connections` : 'No connection'}</S.Count>
+                  </li>
+                );
+              })}
+          </ul>
+        </div>
+      )}
       {type === 'list' && pluginConfig && (
         <Dialog
           style={{ width: 820 }}
diff --git a/config-ui/src/plugins/components/connection-form/index.tsx 
b/config-ui/src/plugins/components/connection-form/index.tsx
index 1a6d93a65..6a4ccd2d7 100644
--- a/config-ui/src/plugins/components/connection-form/index.tsx
+++ b/config-ui/src/plugins/components/connection-form/index.tsx
@@ -25,7 +25,7 @@ import { useAppDispatch, useAppSelector } from '@/app/hook';
 import { ExternalLink, Buttons } from '@/components';
 import { addConnection, updateConnection } from '@/features';
 import { selectConnection } from '@/features/connections';
-import { PluginConfig, PluginConfigType } from '@/plugins';
+import { getPluginConfig } from '@/plugins';
 import { operator } from '@/utils';
 
 import { Form } from './fields';
@@ -48,7 +48,7 @@ export const ConnectionForm = ({ plugin, connectionId, 
onSuccess }: Props) => {
   const {
     name,
     connection: { docLink, fields, initialValues },
-  } = useMemo(() => PluginConfig.find((p) => p.plugin === plugin) as 
PluginConfigType, [plugin]);
+  } = getPluginConfig(plugin);
 
   const disabled = useMemo(() => {
     return Object.values(errors).some((value) => value);
diff --git 
a/config-ui/src/plugins/components/data-scope-remote/search-local.tsx 
b/config-ui/src/plugins/components/data-scope-remote/search-local.tsx
index 938ece0a7..d87521931 100644
--- a/config-ui/src/plugins/components/data-scope-remote/search-local.tsx
+++ b/config-ui/src/plugins/components/data-scope-remote/search-local.tsx
@@ -24,7 +24,7 @@ import { useDebounce } from 'ahooks';
 
 import API from '@/api';
 import { FormItem, MultiSelector, Loading, Dialog, Message } from 
'@/components';
-import { PluginConfigType } from '@/plugins';
+import { IPluginConfig } from '@/types';
 
 import * as T from './types';
 import * as S from './styled';
@@ -32,7 +32,7 @@ import * as S from './styled';
 interface Props {
   plugin: string;
   connectionId: ID;
-  config: PluginConfigType['dataScope'];
+  config: IPluginConfig['dataScope'];
   disabledScope: any[];
   selectedScope: any[];
   onChange: (selectedScope: any[]) => void;
diff --git 
a/config-ui/src/plugins/components/data-scope-remote/search-remote.tsx 
b/config-ui/src/plugins/components/data-scope-remote/search-remote.tsx
index 4679ea6e8..eb5777c5f 100644
--- a/config-ui/src/plugins/components/data-scope-remote/search-remote.tsx
+++ b/config-ui/src/plugins/components/data-scope-remote/search-remote.tsx
@@ -25,7 +25,7 @@ import { uniqBy } from 'lodash';
 
 import API from '@/api';
 import { FormItem, MultiSelector, Loading } from '@/components';
-import { PluginConfigType } from '@/plugins';
+import { IPluginConfig } from '@/types';
 
 import * as T from './types';
 import * as S from './styled';
@@ -33,7 +33,7 @@ import * as S from './styled';
 interface Props {
   plugin: string;
   connectionId: ID;
-  config: PluginConfigType['dataScope'];
+  config: IPluginConfig['dataScope'];
   disabledScope: any[];
   selectedScope: any[];
   onChange: (selectedScope: any[]) => void;
diff --git a/config-ui/src/plugins/index.ts b/config-ui/src/plugins/index.ts
index 1bf045890..73d9d5575 100644
--- a/config-ui/src/plugins/index.ts
+++ b/config-ui/src/plugins/index.ts
@@ -16,7 +16,6 @@
  *
  */
 
-export * from './types';
-export * from './utils';
 export * from './components';
-export * from './config';
+export * from './register';
+export * from './utils';
diff --git a/config-ui/src/plugins/register/azure/config.tsx 
b/config-ui/src/plugins/register/azure/config.tsx
index 799d15a3e..35af2ad77 100644
--- a/config-ui/src/plugins/register/azure/config.tsx
+++ b/config-ui/src/plugins/register/azure/config.tsx
@@ -19,12 +19,10 @@
 import { ExternalLink } from '@/components';
 import { DOC_URL } from '@/release';
 
-import type { PluginConfigType } from '../../types';
-
 import Icon from './assets/icon.svg';
 import { BaseURL } from './connection-fields';
 
-export const AzureConfig: PluginConfigType = {
+export const AzureConfig = {
   plugin: 'azuredevops',
   name: 'Azure DevOps',
   icon: Icon,
diff --git a/config-ui/src/plugins/register/bamboo/config.ts 
b/config-ui/src/plugins/register/bamboo/config.ts
index b2c78850c..c3fe1fe8f 100644
--- a/config-ui/src/plugins/register/bamboo/config.ts
+++ b/config-ui/src/plugins/register/bamboo/config.ts
@@ -18,11 +18,9 @@
 
 import { DOC_URL } from '@/release';
 
-import type { PluginConfigType } from '../../types';
-
 import Icon from './assets/icon.svg';
 
-export const BambooConfig: PluginConfigType = {
+export const BambooConfig = {
   plugin: 'bamboo',
   name: 'Bamboo',
   icon: Icon,
diff --git a/config-ui/src/plugins/register/bitbucket/config.tsx 
b/config-ui/src/plugins/register/bitbucket/config.tsx
index 97840f382..77131b890 100644
--- a/config-ui/src/plugins/register/bitbucket/config.tsx
+++ b/config-ui/src/plugins/register/bitbucket/config.tsx
@@ -18,11 +18,9 @@
 
 import { DOC_URL } from '@/release';
 
-import type { PluginConfigType } from '../../types';
-
 import Icon from './assets/icon.svg';
 
-export const BitBucketConfig: PluginConfigType = {
+export const BitBucketConfig = {
   plugin: 'bitbucket',
   name: 'BitBucket',
   icon: Icon,
diff --git a/config-ui/src/plugins/register/github/config.tsx 
b/config-ui/src/plugins/register/github/config.tsx
index ecde8f1fe..1d67c9d74 100644
--- a/config-ui/src/plugins/register/github/config.tsx
+++ b/config-ui/src/plugins/register/github/config.tsx
@@ -20,12 +20,10 @@ import { pick } from 'lodash';
 
 import { DOC_URL } from '@/release';
 
-import type { PluginConfigType } from '../../types';
-
 import Icon from './assets/icon.svg';
 import { Token, Graphql, GithubApp, Authentication } from 
'./connection-fields';
 
-export const GitHubConfig: PluginConfigType = {
+export const GitHubConfig = {
   plugin: 'github',
   name: 'GitHub',
   icon: Icon,
diff --git a/config-ui/src/plugins/register/gitlab/config.tsx 
b/config-ui/src/plugins/register/gitlab/config.tsx
index a51a5f971..d9ab98283 100644
--- a/config-ui/src/plugins/register/gitlab/config.tsx
+++ b/config-ui/src/plugins/register/gitlab/config.tsx
@@ -19,11 +19,9 @@
 import { ExternalLink } from '@/components';
 import { DOC_URL } from '@/release';
 
-import type { PluginConfigType } from '../../types';
-
 import Icon from './assets/icon.svg';
 
-export const GitLabConfig: PluginConfigType = {
+export const GitLabConfig = {
   plugin: 'gitlab',
   name: 'GitLab',
   icon: Icon,
diff --git a/config-ui/src/plugins/config.ts 
b/config-ui/src/plugins/register/index.ts
similarity index 59%
rename from config-ui/src/plugins/config.ts
rename to config-ui/src/plugins/register/index.ts
index d840f84a8..ecbea7359 100644
--- a/config-ui/src/plugins/config.ts
+++ b/config-ui/src/plugins/register/index.ts
@@ -16,21 +16,22 @@
  *
  */
 
-import type { PluginConfigType } from './types';
-import { AzureConfig } from './register/azure';
-import { BambooConfig } from './register/bamboo';
-import { BitBucketConfig } from './register/bitbucket';
-import { GitHubConfig } from './register/github';
-import { GitLabConfig } from './register/gitlab';
-import { JenkinsConfig } from './register/jenkins';
-import { JiraConfig } from './register/jira';
-import { PagerDutyConfig } from './register/pagerduty';
-import { SonarQubeConfig } from './register/sonarqube';
-import { TAPDConfig } from './register/tapd';
-import { WebhookConfig } from './register/webhook';
-import { ZenTaoConfig } from './register/zentao';
+import { IPluginConfig } from '@/types';
 
-export const PluginConfig: PluginConfigType[] = [
+import { AzureConfig } from './azure';
+import { BambooConfig } from './bamboo';
+import { BitBucketConfig } from './bitbucket';
+import { GitHubConfig } from './github';
+import { GitLabConfig } from './gitlab';
+import { JenkinsConfig } from './jenkins';
+import { JiraConfig } from './jira';
+import { PagerDutyConfig } from './pagerduty';
+import { SonarQubeConfig } from './sonarqube';
+import { TAPDConfig } from './tapd';
+import { WebhookConfig } from './webhook';
+import { ZenTaoConfig } from './zentao';
+
+export const pluginConfigs: IPluginConfig[] = [
   AzureConfig,
   BambooConfig,
   BitBucketConfig,
diff --git a/config-ui/src/plugins/register/jenkins/config.ts 
b/config-ui/src/plugins/register/jenkins/config.ts
index fb08df4e7..400bbeb7c 100644
--- a/config-ui/src/plugins/register/jenkins/config.ts
+++ b/config-ui/src/plugins/register/jenkins/config.ts
@@ -18,11 +18,9 @@
 
 import { DOC_URL } from '@/release';
 
-import type { PluginConfigType } from '../../types';
-
 import Icon from './assets/icon.svg';
 
-export const JenkinsConfig: PluginConfigType = {
+export const JenkinsConfig = {
   plugin: 'jenkins',
   name: 'Jenkins',
   icon: Icon,
diff --git a/config-ui/src/plugins/register/jira/config.tsx 
b/config-ui/src/plugins/register/jira/config.tsx
index ce81ecd44..a49d7f4fd 100644
--- a/config-ui/src/plugins/register/jira/config.tsx
+++ b/config-ui/src/plugins/register/jira/config.tsx
@@ -18,12 +18,10 @@
 
 import { DOC_URL } from '@/release';
 
-import type { PluginConfigType } from '../../types';
-
 import Icon from './assets/icon.svg';
 import { Auth } from './connection-fields';
 
-export const JiraConfig: PluginConfigType = {
+export const JiraConfig = {
   plugin: 'jira',
   name: 'Jira',
   icon: Icon,
diff --git a/config-ui/src/plugins/register/pagerduty/config.tsx 
b/config-ui/src/plugins/register/pagerduty/config.tsx
index b7f7ab351..c246bdcaf 100644
--- a/config-ui/src/plugins/register/pagerduty/config.tsx
+++ b/config-ui/src/plugins/register/pagerduty/config.tsx
@@ -18,11 +18,9 @@
 
 import { DOC_URL } from '@/release';
 
-import type { PluginConfigType } from '../../types';
-
 import Icon from './assets/icon.svg';
 
-export const PagerDutyConfig: PluginConfigType = {
+export const PagerDutyConfig = {
   plugin: 'pagerduty',
   name: 'PagerDuty',
   icon: Icon,
diff --git a/config-ui/src/plugins/register/sonarqube/config.ts 
b/config-ui/src/plugins/register/sonarqube/config.ts
index c64db0837..25ce9f11a 100644
--- a/config-ui/src/plugins/register/sonarqube/config.ts
+++ b/config-ui/src/plugins/register/sonarqube/config.ts
@@ -18,11 +18,9 @@
 
 import { DOC_URL } from '@/release';
 
-import type { PluginConfigType } from '../../types';
-
 import Icon from './assets/icon.svg';
 
-export const SonarQubeConfig: PluginConfigType = {
+export const SonarQubeConfig = {
   plugin: 'sonarqube',
   name: 'SonarQube',
   icon: Icon,
diff --git a/config-ui/src/plugins/register/tapd/config.tsx 
b/config-ui/src/plugins/register/tapd/config.tsx
index a3a2026b3..4d63fd734 100644
--- a/config-ui/src/plugins/register/tapd/config.tsx
+++ b/config-ui/src/plugins/register/tapd/config.tsx
@@ -19,12 +19,10 @@
 import { ExternalLink } from '@/components';
 import { DOC_URL } from '@/release';
 
-import type { PluginConfigType } from '../../types';
-
 import { DataScope } from './data-scope';
 import Icon from './assets/icon.svg';
 
-export const TAPDConfig: PluginConfigType = {
+export const TAPDConfig = {
   plugin: 'tapd',
   name: 'TAPD',
   icon: Icon,
@@ -69,7 +67,7 @@ export const TAPDConfig: PluginConfigType = {
     ],
   },
   dataScope: {
-    render: ({ ...props }) => <DataScope {...props} />,
+    render: ({ ...props }: any) => <DataScope {...props} />,
   },
   scopeConfig: {
     entities: ['TICKET', 'CROSS'],
diff --git a/config-ui/src/plugins/register/webhook/config.ts 
b/config-ui/src/plugins/register/webhook/config.ts
index b0f74c680..fc37c52df 100644
--- a/config-ui/src/plugins/register/webhook/config.ts
+++ b/config-ui/src/plugins/register/webhook/config.ts
@@ -16,11 +16,9 @@
  *
  */
 
-import type { PluginConfigType } from '../../types';
-
 import Icon from './assets/icon.svg';
 
-export const WebhookConfig: PluginConfigType = {
+export const WebhookConfig = {
   plugin: 'webhook',
   name: 'Webhook',
   icon: Icon,
diff --git a/config-ui/src/plugins/register/zentao/config.tsx 
b/config-ui/src/plugins/register/zentao/config.tsx
index 705225dc7..dbbf1fd82 100644
--- a/config-ui/src/plugins/register/zentao/config.tsx
+++ b/config-ui/src/plugins/register/zentao/config.tsx
@@ -18,12 +18,10 @@
 
 import { DOC_URL } from '@/release';
 
-import type { PluginConfigType } from '../../types';
-
 import { DBUrl } from './connection-fields';
 import Icon from './assets/icon.svg';
 
-export const ZenTaoConfig: PluginConfigType = {
+export const ZenTaoConfig = {
   plugin: 'zentao',
   name: 'ZenTao',
   icon: Icon,
diff --git a/config-ui/src/plugins/utils.ts b/config-ui/src/plugins/utils.ts
index 23e7af5f4..03dc6fc95 100644
--- a/config-ui/src/plugins/utils.ts
+++ b/config-ui/src/plugins/utils.ts
@@ -18,8 +18,8 @@
 
 import PluginIcon from '@/images/plugin-icon.svg';
 
-import { PluginConfig } from './config';
-import { PluginConfigType } from './types';
+import { pluginConfigs } from './register';
+import { IPluginConfig } from '@/types';
 
 export const getPluginScopeId = (plugin: string, scope: any) => {
   switch (plugin) {
@@ -42,8 +42,10 @@ export const getPluginScopeId = (plugin: string, scope: any) 
=> {
   }
 };
 
-export const getPluginConfig = (name: string): PluginConfigType => {
-  let pluginConfig = PluginConfig.find((plugin) => plugin.plugin === name) as 
PluginConfigType;
+export const getRegisterPlugins = () => pluginConfigs.map((it) => it.plugin);
+
+export const getPluginConfig = (name: string): IPluginConfig => {
+  let pluginConfig = pluginConfigs.find((it) => it.plugin === name);
   if (!pluginConfig) {
     pluginConfig = {
       plugin: name,
diff --git a/config-ui/src/routes/layout/layout.tsx 
b/config-ui/src/routes/layout/layout.tsx
index b1c9a67a0..fc3fd222c 100644
--- a/config-ui/src/routes/layout/layout.tsx
+++ b/config-ui/src/routes/layout/layout.tsx
@@ -39,7 +39,7 @@ import * as S from './styled';
 import './tips-transition.css';
 
 export const Layout = () => {
-  const { version } = useLoaderData() as Awaited<ReturnType<typeof loader>>;
+  const { version, plugins } = useLoaderData() as Awaited<ReturnType<typeof 
loader>>;
 
   const navigate = useNavigate();
   const { pathname } = useLocation();
@@ -52,7 +52,7 @@ export const Layout = () => {
   const tipsRef = useRef(null);
 
   useEffect(() => {
-    dispatch(init());
+    dispatch(init(plugins));
   }, []);
 
   if (['idle', 'loading'].includes(status)) {
diff --git a/config-ui/src/routes/layout/loader.ts 
b/config-ui/src/routes/layout/loader.ts
index eb0f54205..7d0099080 100644
--- a/config-ui/src/routes/layout/loader.ts
+++ b/config-ui/src/routes/layout/loader.ts
@@ -20,6 +20,7 @@ import { AxiosError } from 'axios';
 import { json } from 'react-router-dom';
 
 import API from '@/api';
+import { getRegisterPlugins } from '@/plugins';
 import { ErrorEnum } from '@/routes/error';
 
 type Props = {
@@ -27,11 +28,19 @@ type Props = {
 };
 
 export const loader = async ({ request }: Props) => {
+  let version = 'unknow';
+  let plugins = [];
+
+  try {
+    const envPlugins = 
import.meta.env.DEVLAKE_PLUGINS.split(',').filter(Boolean);
+    plugins = getRegisterPlugins().filter((plugin) => !envPlugins.length || 
envPlugins.includes(plugin));
+  } catch {
+    throw json({ error: ErrorEnum.API_OFFLINE }, { status: 503 });
+  }
+
   try {
-    const version = await API.version(request.signal);
-    return {
-      version: version.version,
-    };
+    const res = await API.version(request.signal);
+    version = res.version;
   } catch (err) {
     const status = (err as AxiosError).response?.status;
     if (status === 428) {
@@ -39,4 +48,9 @@ export const loader = async ({ request }: Props) => {
     }
     throw json({ error: ErrorEnum.API_OFFLINE }, { status: 503 });
   }
+
+  return {
+    version,
+    plugins,
+  };
 };
diff --git a/config-ui/src/types/connection.ts 
b/config-ui/src/types/connection.ts
index 6225fd63b..5a4e3625d 100644
--- a/config-ui/src/types/connection.ts
+++ b/config-ui/src/types/connection.ts
@@ -16,6 +16,21 @@
  *
  */
 
+export interface IConnectionAPI {
+  id: ID;
+  name: string;
+  endpoint: string;
+  authMethod?: string;
+  token?: string;
+  username?: string;
+  password?: string;
+  proxy: string;
+  apiKey?: string;
+  dbUrl?: string;
+  appId?: string;
+  secretKey?: string;
+}
+
 export enum IConnectionStatus {
   IDLE = 'idle',
   TESTING = 'testing',
diff --git a/config-ui/src/types/index.ts b/config-ui/src/types/index.ts
index c51a9b914..beb1b9f0a 100644
--- a/config-ui/src/types/index.ts
+++ b/config-ui/src/types/index.ts
@@ -17,5 +17,6 @@
  */
 
 export * from './connection';
+export * from './plugin';
 export * from './status';
 export * from './webhook';
diff --git a/config-ui/src/plugins/types.ts b/config-ui/src/types/plugin.ts
similarity index 97%
rename from config-ui/src/plugins/types.ts
rename to config-ui/src/types/plugin.ts
index 941a4715e..e9153666e 100644
--- a/config-ui/src/plugins/types.ts
+++ b/config-ui/src/types/plugin.ts
@@ -16,7 +16,7 @@
  *
  */
 
-export type PluginConfigType = {
+export interface IPluginConfig {
   plugin: string;
   name: string;
   icon: string;
@@ -40,4 +40,4 @@ export type PluginConfigType = {
     entities: string[];
     transformation: any;
   };
-};
+}
diff --git a/config-ui/src/types/webhook.ts b/config-ui/src/types/webhook.ts
index 5255f1e6f..71b510ee6 100644
--- a/config-ui/src/types/webhook.ts
+++ b/config-ui/src/types/webhook.ts
@@ -16,7 +16,7 @@
  *
  */
 
-export interface IApiWebhook {
+export interface IWebhookAPI {
   id: number;
   name: string;
   postIssuesEndpoint: string;
diff --git a/config-ui/src/vite-env.d.ts b/config-ui/src/vite-env.d.ts
index 15e8af5ee..d52d9a2d7 100644
--- a/config-ui/src/vite-env.d.ts
+++ b/config-ui/src/vite-env.d.ts
@@ -17,3 +17,11 @@
  */
 
 /// <reference types="vite/client" />
+
+interface ImportMetaEnv {
+  readonly DEVLAKE_PLUGINS: string;
+}
+
+interface ImportMeta {
+  readonly env: ImportMetaEnv;
+}
diff --git a/config-ui/vite.config.ts b/config-ui/vite.config.ts
index 89f068d13..d8416b25e 100644
--- a/config-ui/vite.config.ts
+++ b/config-ui/vite.config.ts
@@ -24,6 +24,8 @@ import react from '@vitejs/plugin-react';
 export default defineConfig({
   plugins: [react()],
 
+  envPrefix: 'DEVLAKE_',
+
   server: {
     port: 4000,
     proxy: {


Reply via email to