support sqle audit

Author: sjjian

webapp/packages/plugin-sql-editor-navigation-tab/src/SqlEditorTabService.ts

@@ -281,6 +281,7 @@ export class SqlEditorTabService extends Bootstrap {
       !Array.isArray(tab.handlerState.modeState) ||
       !Array.isArray(tab.handlerState.tabs) ||
       !Array.isArray(tab.handlerState.executionPlanTabs) ||
+      !Array.isArray(tab.handlerState.auditTabs) ||
       !Array.isArray(tab.handlerState.resultGroups) ||
       !Array.isArray(tab.handlerState.resultTabs) ||
       !Array.isArray(tab.handlerState.statisticsTabs)
@@ -308,6 +309,7 @@ export class SqlEditorTabService extends Bootstrap {
     tab.handlerState.resultGroups = observable([]);
     tab.handlerState.resultTabs = observable([]);
     tab.handlerState.executionPlanTabs = observable([]);
+    tab.handlerState.auditTabs = observable([]);
     tab.handlerState.statisticsTabs = observable([]);
     tab.handlerState.outputLogsTab = undefined;
 

webapp/packages/plugin-sql-editor/package.json

@@ -39,7 +39,9 @@
     "@cloudbeaver/core-theming": "~0.1.0",
     "@cloudbeaver/core-ui": "~0.1.0",
     "@cloudbeaver/core-utils": "~0.1.0",
-    "@cloudbeaver/core-view": "~0.1.0"
+    "@cloudbeaver/core-view": "~0.1.0",
+    "@ant-design/icons": "^5.2.6",
+    "axios": "^1.5.1"
   },
   "peerDependencies": {
     "react": "~18.x.x",

webapp/packages/plugin-sql-editor/public/icons/sql_audit.svg

@@ -42,6 +42,12 @@ export interface IExecutionPlanTab {
   options?: Record<string, any>;
 }
 
+export interface IAuditTab {
+  tabId: string;
+  order: number;
+  query: string;
+}
+
 export interface IOutputLogsTab extends ISqlEditorResultTab {
   selectedLogTypes: IOutputLogType[];
 }
@@ -59,6 +65,7 @@ export interface ISqlEditorTabState {
   resultTabs: IResultTab[];
   statisticsTabs: IStatisticsTab[];
   executionPlanTabs: IExecutionPlanTab[];
+  auditTabs: IAuditTab[];
   outputLogsTab?: IOutputLogsTab;
 
   // mode

webapp/packages/plugin-sql-editor/src/ISqlEditorTabState.ts

@@ -22,12 +22,14 @@ import { ACTION_SQL_EDITOR_EXECUTE_NEW } from './actions/ACTION_SQL_EDITOR_EXECU
 import { ACTION_SQL_EDITOR_EXECUTE_SCRIPT } from './actions/ACTION_SQL_EDITOR_EXECUTE_SCRIPT';
 import { ACTION_SQL_EDITOR_FORMAT } from './actions/ACTION_SQL_EDITOR_FORMAT';
 import { ACTION_SQL_EDITOR_SHOW_EXECUTION_PLAN } from './actions/ACTION_SQL_EDITOR_SHOW_EXECUTION_PLAN';
+import { ACTION_SQL_EDITOR_AUDIT } from './actions/ACTION_SQL_EDITOR_AUDIT';
 import { ACTION_SQL_EDITOR_SHOW_OUTPUT } from './actions/ACTION_SQL_EDITOR_SHOW_OUTPUT';
 import { KEY_BINDING_SQL_EDITOR_EXECUTE } from './actions/bindings/KEY_BINDING_SQL_EDITOR_EXECUTE';
 import { KEY_BINDING_SQL_EDITOR_EXECUTE_NEW } from './actions/bindings/KEY_BINDING_SQL_EDITOR_EXECUTE_NEW';
 import { KEY_BINDING_SQL_EDITOR_EXECUTE_SCRIPT } from './actions/bindings/KEY_BINDING_SQL_EDITOR_EXECUTE_SCRIPT';
 import { KEY_BINDING_SQL_EDITOR_FORMAT } from './actions/bindings/KEY_BINDING_SQL_EDITOR_FORMAT';
 import { KEY_BINDING_SQL_EDITOR_SHOW_EXECUTION_PLAN } from './actions/bindings/KEY_BINDING_SQL_EDITOR_SHOW_EXECUTION_PLAN';
+import { KEY_BINDING_SQL_EDITOR_AUDIT } from './actions/bindings/KEY_BINDING_SQL_EDITOR_AUDIT'
 import { KEY_BINDING_SQL_EDITOR_SHOW_OUTPUT } from './actions/bindings/KEY_BINDING_SQL_EDITOR_SHOW_OUTPUT';
 import { ESqlDataSourceFeatures } from './SqlDataSource/ESqlDataSourceFeatures';
 import { DATA_CONTEXT_SQL_EDITOR_DATA } from './SqlEditor/DATA_CONTEXT_SQL_EDITOR_DATA';
@@ -81,6 +83,7 @@ export class MenuBootstrap extends Bootstrap {
           ACTION_REDO,
           ACTION_UNDO,
           ACTION_SQL_EDITOR_SHOW_EXECUTION_PLAN,
+          ACTION_SQL_EDITOR_AUDIT,
           ACTION_SQL_EDITOR_SHOW_OUTPUT,
         ].includes(action);
       },
@@ -140,6 +143,13 @@ export class MenuBootstrap extends Bootstrap {
       handler: this.sqlEditorActionHandler.bind(this),
     });
 
+    this.keyBindingService.addKeyBindingHandler({
+      id: 'sql-editor-audit',
+      binding: KEY_BINDING_SQL_EDITOR_AUDIT,
+      isBindingApplicable: (contexts, action) => action === ACTION_SQL_EDITOR_AUDIT,
+      handler: this.sqlEditorActionHandler.bind(this),
+    });
+
     // this.menuService.addCreator({
     //   isApplicable: context => (
     //     context.tryGet(DATA_CONTEXT_SQL_EDITOR_DATA) !== undefined
@@ -185,6 +195,9 @@ export class MenuBootstrap extends Bootstrap {
       case ACTION_SQL_EDITOR_SHOW_EXECUTION_PLAN:
         data.showExecutionPlan();
         break;
+      case ACTION_SQL_EDITOR_AUDIT:
+        data.audit();
+        break;
     }
   }
 

webapp/packages/plugin-sql-editor/src/MenuBootstrap.ts

@@ -56,6 +56,7 @@ export interface ISQLEditorData {
   executeQuery(): Promise<void>;
   executeQueryNewTab(): Promise<void>;
   showExecutionPlan(): Promise<void>;
+  audit(): Promise<void>;
   executeScript(): Promise<void>;
   switchEditing(): Promise<void>;
   getHintProposals(position: number, simple: boolean): Promise<SQLProposal[]>;

webapp/packages/plugin-sql-editor/src/SqlEditor/ISQLEditorData.ts

@@ -185,6 +185,11 @@ export const SqlEditor = observer<ISqlEditorProps>(function SqlEditor({ state, c
                     <StaticImage icon="/icons/sql_execution_plan.svg" />
                   </button>
                 )}
+                {isQuery && (
+                  <button disabled={disabled} title={translate('sql_editor_audit_button_tooltip')} onClick={data.audit}>
+                    <StaticImage icon="/icons/sql_audit.svg" />
+                  </button>
+                )}
               </>
             )}
             <SqlEditorActionsMenu state={state} />

webapp/packages/plugin-sql-editor/src/SqlEditor/SqlEditor.tsx

@@ -25,6 +25,7 @@ import { SqlDialectInfoService } from '../SqlDialectInfoService';
 import { SqlEditorService } from '../SqlEditorService';
 import { ISQLScriptSegment, SQLParser } from '../SQLParser';
 import { SqlExecutionPlanService } from '../SqlResultTabs/ExecutionPlan/SqlExecutionPlanService';
+import { SqlAuditService } from '../SqlResultTabs/SqlAudit/SqlAuditService';
 import { OUTPUT_LOGS_TAB_ID } from '../SqlResultTabs/OutputLogs/OUTPUT_LOGS_TAB_ID';
 import { OutputLogsService } from '../SqlResultTabs/OutputLogs/OutputLogsService';
 import { SqlQueryService } from '../SqlResultTabs/SqlQueryService';
@@ -39,6 +40,7 @@ interface ISQLEditorDataPrivate extends ISQLEditorData {
   readonly sqlEditorService: SqlEditorService;
   readonly notificationService: NotificationService;
   readonly sqlExecutionPlanService: SqlExecutionPlanService;
+  readonly sqlAuditService: SqlAuditService;
   readonly commonDialogService: CommonDialogService;
   readonly sqlResultTabsService: SqlResultTabsService;
   readonly dataSource: ISqlDataSource | undefined;
@@ -67,6 +69,7 @@ export function useSqlEditor(state: ISqlEditorTabState): ISQLEditorData {
   const sqlEditorService = useService(SqlEditorService);
   const notificationService = useService(NotificationService);
   const sqlExecutionPlanService = useService(SqlExecutionPlanService);
+  const sqlAuditService = useService(SqlAuditService);
   const sqlResultTabsService = useService(SqlResultTabsService);
   const commonDialogService = useService(CommonDialogService);
   const sqlDataSourceService = useService(SqlDataSourceService);
@@ -301,6 +304,23 @@ export function useSqlEditor(state: ISqlEditorTabState): ISQLEditorData {
         } catch {}
       },
 
+      async audit(): Promise<void> {
+        const isQuery = this.dataSource?.hasFeature(ESqlDataSourceFeatures.query);
+        const isExecutable = this.dataSource?.hasFeature(ESqlDataSourceFeatures.executable);
+
+        if (!isQuery || !isExecutable) {
+          return;
+        }
+
+        const query = this.getSubQuery();
+
+        try {
+          await this.executeQueryAction(await this.executeQueryAction(query, () => this.getResolvedSegment()), query =>
+            this.sqlAuditService.audit(this.state, query.query),
+          );
+        } catch {}
+      },
+
       async switchEditing(): Promise<void> {
         this.dataSource?.setEditing(!this.dataSource.isEditing());
       },
@@ -470,6 +490,7 @@ export function useSqlEditor(state: ISqlEditorTabState): ISQLEditorData {
       executeQuery: action.bound,
       executeQueryNewTab: action.bound,
       showExecutionPlan: action.bound,
+      audit: action.bound,
       executeScript: action.bound,
       switchEditing: action.bound,
       dialect: computed,
@@ -489,6 +510,7 @@ export function useSqlEditor(state: ISqlEditorTabState): ISQLEditorData {
       sqlDialectInfoService,
       sqlEditorService,
       sqlExecutionPlanService,
+      sqlAuditService,
       sqlResultTabsService,
       notificationService,
       commonDialogService,

webapp/packages/plugin-sql-editor/src/SqlEditor/useSqlEditor.ts

@@ -71,6 +71,7 @@ export class SqlEditorService {
       resultGroups: observable([]),
       resultTabs: observable([]),
       executionPlanTabs: observable([]),
+      auditTabs: observable([]),
       statisticsTabs: observable([]),
       outputLogsTab: undefined,
       currentModeId: undefined,

webapp/packages/plugin-sql-editor/src/SqlEditorService.ts

@@ -0,0 +1,51 @@
+import { observer } from 'mobx-react-lite';
+import styled, { css } from 'reshadow';
+
+import {
+  CheckCircleOutlined,
+  InfoCircleOutlined,
+  WarningOutlined,
+  CloseCircleOutlined
+} from '@ant-design/icons';
+
+import { splitStyles } from '@cloudbeaver/core-blocks';
+
+const styles = css`
+`;
+
+interface Props {
+  level: string;
+}
+
+export const SqlAuditLevel = observer<Props>(function SqlAuditLevel({ level }) {
+  switch (level) {
+    case "error":
+      return styled(
+        styles,
+        splitStyles,
+      )(
+        <CloseCircleOutlined  style={{ fontSize: 20, color: '#f00000' }}/>
+      );
+    case "notice":
+      return styled(
+        styles,
+        splitStyles,
+      )(
+        <InfoCircleOutlined style={{ fontSize: 20, color: '#3282e6' }}/>
+      );
+    case "warn":
+      return styled(
+        styles,
+        splitStyles,
+      )(
+        <WarningOutlined style={{ fontSize: 20, color: '#ff8c00' }} />
+      );
+    default: 
+      return styled(
+        styles,
+        splitStyles,
+      )(
+        <CheckCircleOutlined  style={{ fontSize: 20, color: '#52c41a' }} />
+    );  
+  }
+});