Merge pull request #768 from actiontech/feature/issue-2572-2

[feature](SqlOptimization): Add confirmation step and adjust permission

Author: LZS911

packages/shared/lib/features/usePermission/__tests__/__snapshots__/index.test.ts.snap

@@ -218,6 +218,9 @@ exports[`usePermission should match snapshot 1`] = `
         "DELETE": "action:delete_sql_management_exception",
         "EDIT": "action:edit_sql_management_exception",
       },
+      "SQL_OPTIMIZATION": {
+        "CREATE": "action:create_sql_optimization",
+      },
       "VERSION_MANAGEMENT": {
         "ADD": "action:version_management_add_operator",
         "DELETE": "action:version_management_delete_operator",
@@ -631,6 +634,19 @@ exports[`usePermission should match snapshot 2`] = `
     ],
     "type": "action",
   },
+  "action:create_sql_optimization": {
+    "dbServicePermission": {
+      "opType": "create_optimization",
+    },
+    "id": "action:create_sql_optimization",
+    "projectArchived": false,
+    "projectManager": true,
+    "role": [
+      "admin",
+      "systemAdministrator",
+    ],
+    "type": "action",
+  },
   "action:create_workflow": {
     "dbServicePermission": {
       "opType": "create_workflow",

packages/shared/lib/features/usePermission/permissionManifest.ts

@@ -1288,6 +1288,17 @@ export const PERMISSION_MANIFEST: Record<
       opType: OpPermissionItemOpPermissionTypeEnum.create_workflow
     }
   },
+  // 快捷审核
+  [PERMISSIONS.ACTIONS.SQLE.SQL_OPTIMIZATION.CREATE]: {
+    id: PERMISSIONS.ACTIONS.SQLE.SQL_OPTIMIZATION.CREATE,
+    type: 'action',
+    projectArchived: false,
+    projectManager: true,
+    role: [SystemRole.admin, SystemRole.systemAdministrator],
+    dbServicePermission: {
+      opType: OpPermissionItemOpPermissionTypeEnum.create_optimization
+    }
+  },
 
   // 流水线配置
   [PERMISSIONS.ACTIONS.SQLE.PIPELINE_CONFIGURATION.CREATE]: {

packages/shared/lib/features/usePermission/permissions.ts

@@ -255,6 +255,9 @@ export const PERMISSIONS = {
       SQL_AUDIT: {
         CREATE: 'action:create_sql_audit'
       },
+      SQL_OPTIMIZATION: {
+        CREATE: 'action:create_sql_optimization'
+      },
       PIPELINE_CONFIGURATION: {
         CREATE: 'action:create_pipeline_configuration',
         EDIT: 'action:edit_pipeline_configuration',

packages/sqle/src/locale/zh-CN/sqlAnalyze.ts

@@ -5,6 +5,14 @@ export default {
 
   sqlExplain: 'SQL解析',
   tableTitle: '{{tableName}}表',
+  optimize: 'SQL优化',
+  optimization: {
+    confirmTitle: '是否启用高精度索引推荐？',
+    confirmContent:
+      '高精度索引推荐将统计SQL中列的区分度，提供更准确的索引优化建议，但可能会产生较大的数据库性能开销。',
+    enableHighAnalysis: '是，启用高精度推荐',
+    useRegularAnalysis: '否，使用常规推荐'
+  },
   optimizationResultDrawer: {
     title: 'SQL调优结果详情',
     trackProgressTips: '也可进入 快捷诊断-SQL调优 页面追踪进度',

packages/sqle/src/locale/zh-CN/sqlOptimization.ts

@@ -45,8 +45,9 @@ export default {
       format: 'SQL美化',
       formatTips:
         '目前，支持 SQL 美化的数据库类型有 {{supportType}}。如果未选择数据源或选择的数据源类型尚未得到支持，进行 SQL 美化可能会导致 SQL 语句语法错误。',
-      enableHighAnalysis:
-        ' 启用高精度索引推荐（将统计SQL中列的区分度，可能会产生较大的数据库性能开销 ）',
+      enableHighAnalysis: '启用高精度索引推荐',
+      enableHighAnalysisTips:
+        '将统计SQL中列的区分度，可能会产生较大的数据库性能开销',
       form: {
         optimizationType: '调优类型',
         optimizationTypeDesc:

packages/sqle/src/page/SqlAnalyze/Drawer/SqlOptimizationResultDrawer.tsx

@@ -53,8 +53,10 @@ const SqlOptimizationResultDrawer = () => {
       open &&
       optimizationId &&
       (!optimizationResult?.status ||
-        optimizationResult?.status ===
-          OptimizationSQLDetailStatusEnum.optimizing)
+        ![
+          OptimizationSQLDetailStatusEnum.finish,
+          OptimizationSQLDetailStatusEnum.failed
+        ].includes(optimizationResult.status))
     ) {
       getOptimizationResult(optimizationId);
     }

packages/sqle/src/page/SqlAnalyze/Drawer/__tests__/SqlOptimizationResultDrawer.test.tsx

@@ -144,4 +144,36 @@ describe('SqlOptimizationResultDrawer', () => {
 
     expect(getOptimizationResultSpy).not.toHaveBeenCalled();
   });
+
+  it('should not call getOptimizationResult when optimization is failed', () => {
+    const getOptimizationResultSpy = jest.fn();
+    mockUseOptimizationResult.mockReturnValue({
+      ...defaultOptimizationResult,
+      getOptimizationResult: getOptimizationResultSpy,
+      optimizationResult: {
+        status: OptimizationSQLDetailStatusEnum.failed
+      }
+    });
+
+    superRender(<SqlOptimizationResultDrawer />);
+
+    expect(getOptimizationResultSpy).not.toHaveBeenCalled();
+  });
+
+  it('should call getOptimizationResult when optimization is optimizing', () => {
+    const getOptimizationResultSpy = jest.fn();
+    mockUseOptimizationResult.mockReturnValue({
+      ...defaultOptimizationResult,
+      getOptimizationResult: getOptimizationResultSpy,
+      optimizationResult: {
+        status: OptimizationSQLDetailStatusEnum.optimizing
+      }
+    });
+
+    superRender(<SqlOptimizationResultDrawer />);
+
+    expect(getOptimizationResultSpy).toHaveBeenCalledWith(
+      'test-optimization-id'
+    );
+  });
 });

packages/sqle/src/page/SqlAnalyze/ManagementConf/index.test.tsx

@@ -26,7 +26,6 @@ import {
 } from '@actiontech/shared/lib/testUtil';
 import { useSelector } from 'react-redux';
 import { ModalName } from '../../../data/ModalName';
-import sqlOptimization from '@actiontech/shared/lib/testUtil/mockApi/sqle/sqlOptimization';
 
 jest.mock('react-router', () => {
   return {
@@ -70,7 +69,8 @@ describe('SqlAnalyze/ManagementConfAnalyze', () => {
     getInstanceTipListSpy = sqleMockApi.instance.getInstanceTipList();
     mockUsePermission(
       {
-        checkPagePermission: jest.fn().mockReturnValue(true)
+        checkPagePermission: jest.fn().mockReturnValue(true),
+        checkActionPermission: jest.fn().mockReturnValue(true)
       },
       { useSpyOnMockHooks: true }
     );
@@ -211,7 +211,7 @@ describe('SqlAnalyze/ManagementConfAnalyze', () => {
     expect(container).toMatchSnapshot();
   });
 
-  it('should create sql optimization task', async () => {
+  it('should create sql optimization task with enable_high_analysis', async () => {
     const spy = mockGetAnalyzeData(true);
     superRender(<ManagementConfAnalyze />, undefined, {
       routerProps: {
@@ -227,9 +227,48 @@ describe('SqlAnalyze/ManagementConfAnalyze', () => {
     });
     await act(async () => jest.advanceTimersByTime(3000));
     expect(getInstanceTipListSpy).toHaveBeenCalledTimes(1);
+
     fireEvent.click(screen.getByText('SQL优化'));
     await act(async () => jest.advanceTimersByTime(0));
+
+    expect(screen.getByText('是，启用高精度推荐')).toBeInTheDocument();
+    expect(screen.getByText('否，使用常规推荐')).toBeInTheDocument();
+
+    fireEvent.click(screen.getByText('是，启用高精度推荐'));
+    await act(async () => jest.advanceTimersByTime(0));
+
     expect(sqlOptimizeSpy).toHaveBeenCalledTimes(1);
+    expect(sqlOptimizeSpy).toHaveBeenCalledWith(
+      expect.objectContaining({
+        enable_high_analysis: true,
+        instance_name: 'Mysql1',
+        schema_name: 'sqle'
+      })
+    );
+  });
+
+  it('should create sql optimization task without enable_high_analysis', async () => {
+    mockGetAnalyzeData(true);
+    superRender(<ManagementConfAnalyze />, undefined, {
+      routerProps: {
+        initialEntries: ['/analyze?instance_name=Mysql1&schema=sqle']
+      }
+    });
+    await act(async () => jest.advanceTimersByTime(3000));
+
+    fireEvent.click(screen.getByText('SQL优化'));
+    await act(async () => jest.advanceTimersByTime(0));
+
+    fireEvent.click(screen.getByText('否，使用常规推荐'));
+    await act(async () => jest.advanceTimersByTime(0));
+
+    expect(sqlOptimizeSpy).toHaveBeenCalledWith(
+      expect.objectContaining({
+        enable_high_analysis: false,
+        instance_name: 'Mysql1',
+        schema_name: 'sqle'
+      })
+    );
   });
 
   test('should render error result of type "error" when response code is not 8001', async () => {

packages/sqle/src/page/SqlAnalyze/ManagementConf/index.tsx

@@ -42,7 +42,9 @@ const ManagementConfAnalyze = () => {
 
   const {
     setOptimizationCreationParams,
-    onCreateSqlOptimizationOrview,
+    onCreateSqlOptimization,
+    onViewOptimizationResult,
+    optimizationRecordId,
     createSqlOptimizationLoading,
     allowSqlOptimization
   } = useSqlOptimization();
@@ -143,7 +145,9 @@ const ManagementConfAnalyze = () => {
         initTime={initTime}
         selectedPoint={selectedPoint}
         setSelectedPoint={setSelectedPoint}
-        onCreateSqlOptimizationOrview={onCreateSqlOptimizationOrview}
+        onCreateSqlOptimization={onCreateSqlOptimization}
+        onViewOptimizationResult={onViewOptimizationResult}
+        optimizationRecordId={optimizationRecordId}
         createSqlOptimizationLoading={createSqlOptimizationLoading}
         allowSqlOptimization={allowSqlOptimization}
         getPerformanceStatistics={getPerformanceStatistics}

packages/sqle/src/page/SqlAnalyze/SqlAnalyze/SqlAnalyze.tsx

@@ -29,7 +29,9 @@ const SqlAnalyze: React.FC<SqlAnalyzeProps> = (props) => {
     initTime,
     selectedPoint,
     setSelectedPoint,
-    onCreateSqlOptimizationOrview,
+    onCreateSqlOptimization,
+    onViewOptimizationResult,
+    optimizationRecordId,
     createSqlOptimizationLoading,
     allowSqlOptimization,
     getPerformanceStatistics,
@@ -45,7 +47,9 @@ const SqlAnalyze: React.FC<SqlAnalyzeProps> = (props) => {
     initTime,
     selectedPoint,
     setSelectedPoint,
-    onCreateSqlOptimizationOrview,
+    onCreateSqlOptimization,
+    onViewOptimizationResult,
+    optimizationRecordId,
     createSqlOptimizationLoading,
     allowSqlOptimization,
     getPerformanceStatistics,