feat: support disable or enable apps (#1448)

* control overview whether show more metrics buttton * enable to disable apps * support enable or disable some apps * bump tidb-dashboard-for-clinic-cloud to 0.0.28
pingcap · Dec 5, 2022 · 5741300 · 5741300
1 parent d0228dd
commit 5741300
Show file tree

Hide file tree

Showing 9 changed files with 56 additions and 15 deletions.
diff --git a/ui/packages/tidb-dashboard-for-clinic-cloud/package.json b/ui/packages/tidb-dashboard-for-clinic-cloud/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@pingcap/tidb-dashboard-for-clinic-cloud",
-  "version": "0.0.27",
+  "version": "0.0.28",
   "main": "dist/dashboardApp.js",
   "module": "dist/dashboardApp.js",
   "files": [

diff --git a/ui/packages/tidb-dashboard-for-clinic-cloud/public/index.html b/ui/packages/tidb-dashboard-for-clinic-cloud/public/index.html
@@ -133,7 +133,14 @@
         clusterInfo: {
           orgId,
           clusterId
-        }
+        },
+
+        appsConfig: {
+          overview: {
+            showViewMoreMetrics: false
+          }
+        },
+        appsDisabled: ['monitoring', 'search_logs']
       })
     </script>
   </body>

diff --git a/ui/packages/tidb-dashboard-for-clinic-cloud/src/apps/Overview/context.ts b/ui/packages/tidb-dashboard-for-clinic-cloud/src/apps/Overview/context.ts
@@ -1,6 +1,7 @@
 import {
   IOverviewDataSource,
   IOverviewContext,
+  IOverviewConfig,
   ReqConfig
 } from '@pingcap/tidb-dashboard-lib'
 
@@ -60,14 +61,18 @@ const RECENT_SECONDS = [
   24 * 60 * 60
 ]
 
-export const ctx: IOverviewContext = {
+export const ctx: (cfg: Partial<IOverviewConfig>) => IOverviewContext = (
+  cfg
+) => ({
   ds,
   cfg: {
     apiPathBase: client.getBasePath(),
     metricsQueries: overviewMetrics,
     timeRangeSelector: {
       recent_seconds: RECENT_SECONDS,
       withAbsoluteRangePicker: false
-    }
+    },
+    showViewMoreMetrics: false,
+    ...cfg
   }
-}
+})
diff --git a/ui/packages/tidb-dashboard-for-clinic-cloud/src/apps/Overview/index.tsx b/ui/packages/tidb-dashboard-for-clinic-cloud/src/apps/Overview/index.tsx
@@ -1,10 +1,11 @@
 import React from 'react'
 import { OverviewApp, OverviewProvider } from '@pingcap/tidb-dashboard-lib'
+import { getGlobalConfig } from '~/uilts/globalConfig'
 import { ctx } from './context'
 
 export default function () {
   return (
-    <OverviewProvider value={ctx}>
+    <OverviewProvider value={ctx(getGlobalConfig().appsConfig?.overview || {})}>
       <OverviewApp />
     </OverviewProvider>
   )

diff --git a/ui/packages/tidb-dashboard-for-clinic-cloud/src/uilts/globalConfig.ts b/ui/packages/tidb-dashboard-for-clinic-cloud/src/uilts/globalConfig.ts
@@ -1,4 +1,8 @@
-import { ISlowQueryConfig, ITopSQLConfig } from '@pingcap/tidb-dashboard-lib'
+import {
+  IOverviewConfig,
+  ISlowQueryConfig,
+  ITopSQLConfig
+} from '@pingcap/tidb-dashboard-lib'
 
 export type AppOptions = {
   lang: string
@@ -33,6 +37,7 @@ export type ClusterInfo = {
 }
 
 export type AppsConfig = {
+  overview?: Partial<IOverviewConfig>
   slowQuery?: Partial<ISlowQueryConfig>
   topSQL?: Partial<ITopSQLConfig>
 }
@@ -41,7 +46,12 @@ export type GlobalConfig = {
   appOptions?: AppOptions
   clientOptions: ClientOptions
   clusterInfo: ClusterInfo
+
   appsConfig?: AppsConfig
+
+  // appsDisabled has a higher priority than appsEnabled
+  appsDisabled?: string[]
+  appsEnabled?: string[]
 }
 
 // export const GlobalConfigContext = createContext<IGlobalConfig | null>(null)

diff --git a/ui/packages/tidb-dashboard-for-clinic-cloud/src/uilts/registry.ts b/ui/packages/tidb-dashboard-for-clinic-cloud/src/uilts/registry.ts
@@ -5,7 +5,7 @@ import * as singleSpa from 'single-spa'
 
 import { i18n, routing } from '@pingcap/tidb-dashboard-lib'
 
-import { AppOptions } from './globalConfig'
+import { AppOptions, getGlobalConfig } from './globalConfig'
 
 export default class AppRegistry {
   public defaultRouter = ''
@@ -48,6 +48,16 @@ export default class AppRegistry {
    * }} app
    */
   register(app) {
+    // return if this app is disabled
+    const disabledApps = getGlobalConfig().appsDisabled
+    if (disabledApps && disabledApps.includes(app.id)) {
+      return this
+    }
+    const enabledApps = getGlobalConfig().appsEnabled
+    if (enabledApps && !enabledApps.includes(app.id)) {
+      return this
+    }
+
     if (app.translations) {
       i18n.addTranslations(app.translations)
     }

diff --git a/ui/packages/tidb-dashboard-for-op/src/apps/Overview/context.ts b/ui/packages/tidb-dashboard-for-op/src/apps/Overview/context.ts
@@ -54,6 +54,7 @@ export const ctx: IOverviewContext = {
   cfg: {
     apiPathBase: client.getBasePath(),
     metricsQueries: overviewMetrics,
-    promAddrConfigurable: true
+    promAddrConfigurable: true,
+    showViewMoreMetrics: true
   }
 }
diff --git a/ui/packages/tidb-dashboard-lib/src/apps/Overview/components/Metrics.tsx b/ui/packages/tidb-dashboard-lib/src/apps/Overview/components/Metrics.tsx
@@ -103,11 +103,13 @@ export default function Metrics() {
             {isSomeLoading && <LoadingOutlined />}
           </Space>
           <Space>
-            <Link to={`/monitoring`}>
-              <Button type="primary" onClick={telemetry.clickViewMoreMetrics}>
-                {t('overview.view_more_metrics')}
-              </Button>
-            </Link>
+            {ctx?.cfg.showViewMoreMetrics && (
+              <Link to={`/monitoring`}>
+                <Button type="primary" onClick={telemetry.clickViewMoreMetrics}>
+                  {t('overview.view_more_metrics')}
+                </Button>
+              </Link>
+            )}
           </Space>
         </Toolbar>
       </Card>

diff --git a/ui/packages/tidb-dashboard-lib/src/apps/Overview/context/index.ts b/ui/packages/tidb-dashboard-lib/src/apps/Overview/context/index.ts
@@ -57,9 +57,14 @@ export interface IOverviewDataSource {
   }): Promise<MetricsQueryResponse>
 }
 
+export type IOverviewConfig = IContextConfig &
+  IMetricConfig & {
+    showViewMoreMetrics: boolean
+  }
+
 export interface IOverviewContext {
   ds: IOverviewDataSource
-  cfg: IContextConfig & IMetricConfig
+  cfg: IOverviewConfig
 }
 
 export const OverviewContext = createContext<IOverviewContext | null>(null)