Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

4.2 KB
Raw Blame
package oceanbase

import (
	"context"
	"database/sql"
	"fmt"

	"github.com/pkg/errors"

	"github.com/bytebase/omni/oceanbase/ast"

	storepb "github.com/bytebase/bytebase/backend/generated-go/store"
	"github.com/bytebase/bytebase/backend/plugin/advisor"
	"github.com/bytebase/bytebase/backend/plugin/advisor/code"
	"github.com/bytebase/bytebase/backend/plugin/parser/base"
	oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
)

var (
	_ advisor.Advisor = (*InsertRowLimitAdvisor)(nil)
)

func init() {
	advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_INSERT_ROW_LIMIT, &InsertRowLimitAdvisor{})
}

// InsertRowLimitAdvisor is the advisor checking for insert row limit.
type InsertRowLimitAdvisor struct {
}

// Check checks for insert row limit.
func (*InsertRowLimitAdvisor) Check(ctx context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
	level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
	if err != nil {
		return nil, err
	}

	numberPayload := checkCtx.Rule.GetNumberPayload()
	if numberPayload == nil {
		return nil, errors.New("number_payload is required for this rule")
	}

	checker := &insertRowLimitChecker{
		level:  level,
		title:  checkCtx.Rule.Type.String(),
		maxRow: int(numberPayload.Number),
		driver: checkCtx.Driver,
		ctx:    ctx,
	}

	for _, stmt := range checkCtx.ParsedStatements {
		if stmt.AST == nil {
			continue
		}
		node, ok := oceanbaseparser.GetOmniNode(stmt.AST)
		if !ok {
			continue
		}
		insert, ok := node.(*ast.InsertStmt)
		if !ok {
			continue
		}
		checker.checkInsert(stmt.Text, stmt.BaseLine(), insert)
	}
	return checker.explains.AppendSkippedAdvice(checker.adviceList, checker.title, code.InsertTooManyRows), nil
}

type insertRowLimitChecker struct {
	adviceList []*storepb.Advice
	level      storepb.Advice_Status
	title      string
	maxRow     int
	driver     *sql.DB
	ctx        context.Context
	explains   advisor.ExplainBudget
}

func (checker *insertRowLimitChecker) checkInsert(text string, baseLine int, stmt *ast.InsertStmt) {
	line := omniLine(baseLine, text, stmt.Loc)
	if stmt.Select != nil || stmt.TableSource != nil {
		checker.handleInsertQueryExpression(text, line)
	}
	checker.handleNoInsertQueryExpression(text, line, stmt)
}

func (checker *insertRowLimitChecker) handleInsertQueryExpression(text string, line int) {
	if checker.driver == nil {
		return
	}
	if !checker.explains.Spend(base.ConvertANTLRLineToPosition(line)) {
		return
	}

	res, err := advisor.Query(checker.ctx, advisor.QueryContext{}, checker.driver, storepb.Engine_OCEANBASE, fmt.Sprintf("EXPLAIN format=json %s", text))
	if err != nil {
		checker.adviceList = append(checker.adviceList, &storepb.Advice{
			Status:        checker.level,
			Code:          code.InsertTooManyRows.Int32(),
			Title:         checker.title,
			Content:       fmt.Sprintf("\"%s\" dry runs failed: %s", text, err.Error()),
			StartPosition: base.ConvertANTLRLineToPosition(line),
		})
		return
	}
	rowCount, err := getEstimatedRowsFromJSON(res)
	if err != nil {
		checker.adviceList = append(checker.adviceList, &storepb.Advice{
			Status:        checker.level,
			Code:          code.Internal.Int32(),
			Title:         checker.title,
			Content:       fmt.Sprintf("failed to get row count for \"%s\": %s", text, err.Error()),
			StartPosition: base.ConvertANTLRLineToPosition(line),
		})
	} else if rowCount > int64(checker.maxRow) {
		checker.adviceList = append(checker.adviceList, &storepb.Advice{
			Status:        checker.level,
			Code:          code.InsertTooManyRows.Int32(),
			Title:         checker.title,
			Content:       fmt.Sprintf("\"%s\" inserts %d rows. The count exceeds %d.", text, rowCount, checker.maxRow),
			StartPosition: base.ConvertANTLRLineToPosition(line),
		})
	}
}

func (checker *insertRowLimitChecker) handleNoInsertQueryExpression(text string, line int, stmt *ast.InsertStmt) {
	if len(stmt.Values) > checker.maxRow {
		checker.adviceList = append(checker.adviceList, &storepb.Advice{
			Status:        checker.level,
			Code:          code.InsertTooManyRows.Int32(),
			Title:         checker.title,
			Content:       fmt.Sprintf("\"%s\" inserts %d rows. The count exceeds %d.", text, len(stmt.Values), checker.maxRow),
			StartPosition: base.ConvertANTLRLineToPosition(line),
		})
	}
}