Merge pull request #672 from actiontech/feature/rewrite-sql-progress

[feature](SqlRewrittenDrawer): add rewrite progress display during SQL rewriting pending state

Author: Rain-1214

package.json

@@ -32,7 +32,8 @@
     "icon:build": "pnpm --filter @actiontech/icons build",
     "dms:g": "pnpm --filter @actiontech/cli-create-dms-page build && create-dms-page",
     "api_client:g": "npm_config_registry=http://10.186.18.19:4873 pnpx @actiontech/cli api-client -y",
-    "api_mocks:g": "npm_config_registry=http://10.186.18.19:4873 pnpx @actiontech/cli api-mocks -y"
+    "api_mocks:g": "npm_config_registry=http://10.186.18.19:4873 pnpx @actiontech/cli api-mocks -y",
+    "ai-doc": "npm_config_registry=http://10.186.18.19:4873 pnpx @actiontech/cli ai-doc"
   },
   "keywords": [],
   "author": "",

packages/shared/lib/api/sqle/service/common.d.ts

@@ -1,6 +1,7 @@
 import {
   RuleCategoryStatisticCategoryEnum,
   AssociateWorkflowsStatusEnum,
+  AsyncRewriteTaskStatusEnum,
   AuditPlanParamResV1TypeEnum,
   AuditPlanReportResV1AuditLevelEnum,
   AuditPlanSQLHeadV1TypeEnum,
@@ -44,6 +45,7 @@ import {
   ReportPushConfigListPushUserTypeEnum,
   ReportPushConfigListTriggerTypeEnum,
   RewriteSuggestionAuditLevelEnum,
+  RewriteSuggestionStatusEnum,
   RewriteSuggestionTypeEnum,
   RuleParamResV1TypeEnum,
   RuleResV1LevelEnum,
@@ -154,6 +156,30 @@ export interface IAssociateWorkflows {
   workflow_name?: string;
 }
 
+export interface IAsyncRewriteTask {
+  end_time?: string;
+
+  error_message?: string;
+
+  result?: IRewriteSQLData;
+
+  sql_number?: string;
+
+  start_time?: string;
+
+  status?: AsyncRewriteTaskStatusEnum;
+
+  task_id?: string;
+}
+
+export interface IAsyncRewriteTaskStatusRes {
+  code?: number;
+
+  data?: IAsyncRewriteTask;
+
+  message?: string;
+}
+
 export interface IAuditFileResp {
   file_name?: string;
 }
@@ -2710,14 +2736,6 @@ export interface IRewriteSQLReq {
   enable_structure_type?: boolean;
 }
 
-export interface IRewriteSQLRes {
-  code?: number;
-
-  data?: IRewriteSQLData;
-
-  message?: string;
-}
-
 export interface IRewriteSuggestion {
   audit_level?: RewriteSuggestionAuditLevelEnum;
 
@@ -2731,6 +2749,8 @@ export interface IRewriteSuggestion {
 
   rule_name?: string;
 
+  status?: RewriteSuggestionStatusEnum;
+
   type?: RewriteSuggestionTypeEnum;
 }
 

packages/shared/lib/api/sqle/service/common.enum.ts

@@ -24,6 +24,16 @@ export enum AssociateWorkflowsStatusEnum {
   'finished' = 'finished'
 }
 
+export enum AsyncRewriteTaskStatusEnum {
+  'pending' = 'pending',
+
+  'running' = 'running',
+
+  'completed' = 'completed',
+
+  'failed' = 'failed'
+}
+
 export enum AuditPlanParamResV1TypeEnum {
   'string' = 'string',
 
@@ -412,6 +422,12 @@ export enum RewriteSuggestionAuditLevelEnum {
   'error' = 'error'
 }
 
+export enum RewriteSuggestionStatusEnum {
+  'initial' = 'initial',
+
+  'processed' = 'processed'
+}
+
 export enum RewriteSuggestionTypeEnum {
   'statement' = 'statement',
 

packages/shared/lib/api/sqle/service/task/index.d.ts

@@ -12,7 +12,7 @@ import {
   IUpdateAuditTaskSQLsReqV1,
   IGetTaskAnalysisDataResV1,
   IRewriteSQLReq,
-  IRewriteSQLRes,
+  IAsyncRewriteTaskStatusRes,
   IGetAuditFileListRes,
   IGetAuditFileExecStatisticRes,
   IGetAuditTaskSQLsResV2,
@@ -170,7 +170,16 @@ export interface IRewriteSQLParams extends IRewriteSQLReq {
   number: number;
 }
 
-export interface IRewriteSQLReturn extends IRewriteSQLRes {}
+export interface IRewriteSQLReturn extends IAsyncRewriteTaskStatusRes {}
+
+export interface IGetAsyncRewriteTaskStatusParams {
+  task_id: string;
+
+  number: number;
+}
+
+export interface IGetAsyncRewriteTaskStatusReturn
+  extends IAsyncRewriteTaskStatusRes {}
 
 export interface IGetSqlFileOrderMethodV1Return
   extends IGetSqlFileOrderMethodResV1 {}

packages/shared/lib/api/sqle/service/task/index.ts

@@ -32,6 +32,8 @@ import {
   IGetTaskAnalysisDataReturn,
   IRewriteSQLParams,
   IRewriteSQLReturn,
+  IGetAsyncRewriteTaskStatusParams,
+  IGetAsyncRewriteTaskStatusReturn,
   IGetSqlFileOrderMethodV1Return,
   IGetAuditFileListParams,
   IGetAuditFileListReturn,
@@ -364,6 +366,24 @@ class TaskService extends ServiceBase {
     );
   }
 
+  public GetAsyncRewriteTaskStatus(
+    params: IGetAsyncRewriteTaskStatusParams,
+    options?: AxiosRequestConfig
+  ) {
+    const paramsData = this.cloneDeep(params);
+    const task_id = paramsData.task_id;
+    delete paramsData.task_id;
+
+    const number = paramsData.number;
+    delete paramsData.number;
+
+    return this.get<IGetAsyncRewriteTaskStatusReturn>(
+      `/v1/tasks/audits/${task_id}/sqls/${number}/rewrite/status`,
+      paramsData,
+      options
+    );
+  }
+
   public getSqlFileOrderMethodV1(options?: AxiosRequestConfig) {
     return this.get<IGetSqlFileOrderMethodV1Return>(
       '/v1/tasks/file_order_methods',

packages/shared/lib/testUtil/mockApi/sqle/task/data.ts

@@ -4,7 +4,8 @@ import {
 } from '../../../../api/sqle/service/common';
 import {
   AuditTaskSQLResV2BackupStrategyEnum,
-  AuditTaskSQLResV2BackupStatusEnum
+  AuditTaskSQLResV2BackupStatusEnum,
+  RewriteSuggestionStatusEnum
 } from '../../../../api/sqle/service/common.enum';
 
 export const AuditTaskSQLsMockData: IAuditTaskSQLResV2[] = [
@@ -745,3 +746,58 @@ export const SqlRewrittenMockDataWithNotRewriter = {
   business_non_equivalent_desc:
     '- **记录数的不确定性**: 原始 SQL 使用 `ORDER BY RAND()` 可能会导致记录数的不确定性，因为随机排序可能导致不同的记录被选中。而优化后的 SQL 使用 `u.id IN (SELECT id FROM random_ids)`，虽然也实现了随机选择，但具体的记录选择可能会不同，导致记录数的不确定性。\n- **数据内容的差异**: 由于记录的选择可能不同，因此数据内容也可能不同。\n- **数据顺序的差异**: 虽然两种方法都实现了随机选择，但具体的选择顺序可能会不同，导致数据顺序的差异。'
 } as IRewriteSQLData;
+
+export const AsyncRewriteTaskStatusMockData = {
+  task_id: 'mock_task_123',
+  sql_number: '1',
+  status: 'running',
+  start_time: '2023-12-01T10:00:00.000Z',
+  end_time: undefined,
+  error_message: undefined,
+  result: {
+    ...SqlRewrittenMockDataNoDDL,
+    suggestions: SqlRewrittenMockDataNoDDL.suggestions!.map((item, index) => ({
+      ...item,
+      status:
+        index % 2 === 0
+          ? RewriteSuggestionStatusEnum.processed
+          : RewriteSuggestionStatusEnum.initial
+    }))
+  }
+};
+
+export const AsyncRewriteTaskStatusCompletedMockData = {
+  task_id: 'mock_task_123',
+  sql_number: '1',
+  status: 'completed',
+  start_time: '2023-12-01T10:00:00.000Z',
+  end_time: '2023-12-01T10:05:30.000Z',
+  error_message: undefined,
+  result: {
+    ...SqlRewrittenMockDataNoDDL,
+    suggestions: SqlRewrittenMockDataNoDDL.suggestions!.map((item) => ({
+      ...item,
+      status: RewriteSuggestionStatusEnum.processed
+    }))
+  }
+};
+
+export const AsyncRewriteTaskStatusFailedMockData = {
+  task_id: 'mock_task_123',
+  sql_number: '1',
+  status: 'failed',
+  start_time: '2023-12-01T10:00:00.000Z',
+  end_time: '2023-12-01T10:02:15.000Z',
+  error_message: 'SQL rewrite failed due to syntax error',
+  result: undefined
+};
+
+export const AsyncRewriteTaskStatusPendingMockData = {
+  task_id: 'mock_task_123',
+  sql_number: '1',
+  status: 'pending',
+  start_time: undefined,
+  end_time: undefined,
+  error_message: undefined,
+  result: undefined
+};

packages/shared/lib/testUtil/mockApi/sqle/task/index.ts

@@ -4,7 +4,11 @@ import {
   AuditTaskSQLsMockData,
   SqlRewrittenMockDataNoDDL,
   TaskFileListMockData,
-  workflowTaskDetailMockData
+  workflowTaskDetailMockData,
+  AsyncRewriteTaskStatusMockData,
+  AsyncRewriteTaskStatusCompletedMockData,
+  AsyncRewriteTaskStatusFailedMockData,
+  AsyncRewriteTaskStatusPendingMockData
 } from './data';
 
 class TaskMockApi implements MockSpyApy {
@@ -14,6 +18,9 @@ class TaskMockApi implements MockSpyApy {
     this.getAuditTask();
     this.getAuditFileList();
     this.getSqlFileOrderMethod();
+    this.updateSqlFileOrder();
+    this.getTaskSQLRewritten();
+    this.getAsyncRewriteTaskStatus();
   }
 
   public getAuditTaskSQLs() {
@@ -84,7 +91,41 @@ class TaskMockApi implements MockSpyApy {
   public getTaskSQLRewritten() {
     const spy = jest.spyOn(task, 'RewriteSQL');
     spy.mockImplementation(() =>
-      createSpySuccessResponse({ data: SqlRewrittenMockDataNoDDL })
+      createSpySuccessResponse({ data: AsyncRewriteTaskStatusMockData })
+    );
+    return spy;
+  }
+
+  public getAsyncRewriteTaskStatus() {
+    const spy = jest.spyOn(task, 'GetAsyncRewriteTaskStatus');
+    spy.mockImplementation(() =>
+      createSpySuccessResponse({ data: AsyncRewriteTaskStatusMockData })
+    );
+    return spy;
+  }
+
+  public getAsyncRewriteTaskStatusCompleted() {
+    const spy = jest.spyOn(task, 'GetAsyncRewriteTaskStatus');
+    spy.mockImplementation(() =>
+      createSpySuccessResponse({
+        data: AsyncRewriteTaskStatusCompletedMockData
+      })
+    );
+    return spy;
+  }
+
+  public getAsyncRewriteTaskStatusFailed() {
+    const spy = jest.spyOn(task, 'GetAsyncRewriteTaskStatus');
+    spy.mockImplementation(() =>
+      createSpySuccessResponse({ data: AsyncRewriteTaskStatusFailedMockData })
+    );
+    return spy;
+  }
+
+  public getAsyncRewriteTaskStatusPending() {
+    const spy = jest.spyOn(task, 'GetAsyncRewriteTaskStatus');
+    spy.mockImplementation(() =>
+      createSpySuccessResponse({ data: AsyncRewriteTaskStatusPendingMockData })
     );
     return spy;
   }

packages/sqle/src/components/SqlRewrittenDrawer/__tests__/__snapshots__/index.test.tsx.snap

@@ -3,7 +3,7 @@
 exports[`SqlRewrittenDrawer should match snapshot 1`] = `
 <Fragment>
   <SqlRewrittenDrawerEE
-    maskClosable={true}
+    maskClosable={false}
     onClose={[MockFunction]}
     open={true}
     originSqlInfo={

packages/sqle/src/components/SqlRewrittenDrawer/__tests__/components/OverallRewrittenSuggestion.test.tsx

@@ -27,7 +27,8 @@ describe('OverallRewrittenSuggestion', () => {
     businessDesc: SqlRewrittenMockDataNoDDL.business_desc!,
     sqlLogicDesc: SqlRewrittenMockDataWithLogic.logic_desc!,
     rewrittenSqlLogicDesc:
-      SqlRewrittenMockDataWithLogic.rewritten_sql_logic_desc!
+      SqlRewrittenMockDataWithLogic.rewritten_sql_logic_desc!,
+    isRewriting: false
   };
 
   ignoreConsoleErrors([
@@ -56,6 +57,25 @@ describe('OverallRewrittenSuggestion', () => {
     expect(screen.getByText(mockProps.businessDesc)).toBeInTheDocument();
   });
 
+  it('should render rewriting in progress message when isRewriting is true', () => {
+    sqleSuperRender(
+      <OverallRewrittenSuggestion {...mockProps} isRewriting={true} />
+    );
+
+    expect(screen.getByText('总结')).toBeInTheDocument();
+    expect(
+      screen.getByText(
+        'SQL重写过程进行中，系统将逐步应用优化规则并展示每个步骤的详细信息...'
+      )
+    ).toBeInTheDocument();
+    expect(
+      screen.queryByText(
+        `本次 SQL 重写基于 ${mockProps.optimizedCount} 条规则进行了优化，目前还有 ${mockProps.remainingCount} 条规则有待进一步优化。此外，有 ${mockProps.businessCount} 条规则需要人工处理。`
+      )
+    ).not.toBeInTheDocument();
+    expect(screen.queryByText(mockProps.businessDesc)).not.toBeInTheDocument();
+  });
+
   it('should render database structure change statement section when overallDDL exists', () => {
     sqleSuperRender(
       <OverallRewrittenSuggestion
@@ -165,7 +185,8 @@ describe('OverallRewrittenSuggestion', () => {
       ...mockProps,
       suggestions: [],
       rewrittenSql: undefined,
-      businessNonEquivalentDesc: ''
+      businessNonEquivalentDesc: '',
+      isRewriting: false
     };
 
     sqleSuperRender(<OverallRewrittenSuggestion {...mockEmptyProps} />);