Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
refactor(qb): worksheet (#17881)
p0ny63a161e22c76
diff --git a/backend/api/v1/worksheet_service.go b/backend/api/v1/worksheet_service.goindex f767754023..2ae1db6321 100644--- a/backend/api/v1/worksheet_service.go+++ b/backend/api/v1/worksheet_service.go@@ -3,7 +3,6 @@ package v1import ("context""fmt"- "strings""log/slog"@@ -12,10 +11,6 @@ import ("google.golang.org/protobuf/types/known/emptypb""google.golang.org/protobuf/types/known/timestamppb"- "github.com/google/cel-go/cel"- celast "github.com/google/cel-go/common/ast"- celoperators "github.com/google/cel-go/common/operators"-"github.com/bytebase/bytebase/backend/common""github.com/bytebase/bytebase/backend/common/log""github.com/bytebase/bytebase/backend/component/iam"@@ -138,127 +133,6 @@ func (s *WorksheetService) GetWorksheet(return connect.NewResponse(v1pbWorksheet), nil}-func (s *WorksheetService) getListSheetFilter(ctx context.Context, callerID int, filter string) (*store.ListResourceFilter, error) {- if filter == "" {- return nil, nil- }- e, err := cel.NewEnv()- if err != nil {- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to create cel env"))- }- ast, iss := e.Parse(filter)- if iss != nil {- return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("failed to parse filter %v, error: %v", filter, iss.String()))- }-- var getFilter func(expr celast.Expr) (string, error)- var positionalArgs []any-- getUserID := func(name string) (int, error) {- creatorEmail := strings.TrimPrefix(name, "users/")- if creatorEmail == "" {- return 0, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("invalid empty creator identifier"))- }- user, err := s.store.GetUserByEmail(ctx, creatorEmail)- if err != nil {- return 0, connect.NewError(connect.CodeInternal, errors.Errorf("failed to get user: %v", err))- }- if user == nil {- return 0, connect.NewError(connect.CodeNotFound, errors.Errorf("user with email %s not found", creatorEmail))- }- return user.ID, nil- }-- parseToSQL := func(variable, value any) (string, error) {- switch variable {- case "creator":- userID, err := getUserID(value.(string))- if err != nil {- return "", err- }- positionalArgs = append(positionalArgs, userID)- return fmt.Sprintf("worksheet.creator_id = $%d", len(positionalArgs)), nil- case "starred":- if starred, ok := value.(bool); ok {- positionalArgs = append(positionalArgs, callerID)- return fmt.Sprintf("worksheet.id IN (SELECT worksheet_id FROM worksheet_organizer WHERE principal_id = $%d AND starred = %v)", len(positionalArgs), starred), nil- }- return "TRUE", nil- case "visibility":- visibility, err := convertToStoreWorksheetVisibility(v1pb.Worksheet_Visibility(v1pb.Worksheet_Visibility_value[value.(string)]))- if err != nil {- return "", err- }- positionalArgs = append(positionalArgs, visibility)- return fmt.Sprintf("worksheet.visibility = $%d", len(positionalArgs)), nil- default:- return "", connect.NewError(connect.CodeInvalidArgument, errors.Errorf("unsupport variable %q", variable))- }- }-- getFilter = func(expr celast.Expr) (string, error) {- switch expr.Kind() {- case celast.CallKind:- functionName := expr.AsCall().FunctionName()- switch functionName {- case celoperators.LogicalOr:- return getSubConditionFromExpr(expr, getFilter, "OR")- case celoperators.LogicalAnd:- return getSubConditionFromExpr(expr, getFilter, "AND")- case celoperators.Equals:- variable, value := getVariableAndValueFromExpr(expr)- return parseToSQL(variable, value)- case celoperators.NotEquals:- variable, value := getVariableAndValueFromExpr(expr)- if variable != "creator" {- return "", connect.NewError(connect.CodeInvalidArgument, errors.Errorf(`only "creator" support "!=" operator`))- }- userID, err := getUserID(value.(string))- if err != nil {- return "", err- }- positionalArgs = append(positionalArgs, userID)- return fmt.Sprintf("worksheet.creator_id != $%d", len(positionalArgs)), nil- case celoperators.In:- variable, value := getVariableAndValueFromExpr(expr)- if variable != "visibility" {- return "", connect.NewError(connect.CodeInvalidArgument, errors.Errorf(`only "visibility" support "visibility in [xx]" filter`))- }- rawList, ok := value.([]any)- if !ok {- return "", connect.NewError(connect.CodeInvalidArgument, errors.Errorf("invalid visibility value %q", value))- }- if len(rawList) == 0 {- return "", connect.NewError(connect.CodeInvalidArgument, errors.Errorf("empty visibility filter"))- }- visibilityList := []string{}- for _, raw := range rawList {- visibility, err := convertToStoreWorksheetVisibility(v1pb.Worksheet_Visibility(v1pb.Worksheet_Visibility_value[raw.(string)]))- if err != nil {- return "", err- }- visibilityList = append(visibilityList, fmt.Sprintf(`'%s'`, visibility))- }- return fmt.Sprintf(`worksheet.visibility IN (%s)`, strings.Join(visibilityList, ",")), nil- default:- return "", connect.NewError(connect.CodeInvalidArgument, errors.Errorf("unexpected function %v", functionName))- }- default:- return "", connect.NewError(connect.CodeInvalidArgument, errors.Errorf("unexpected expr kind %v", expr.Kind()))- }- }-- where, err := getFilter(ast.NativeRep().Expr())- if err != nil {- return nil, err- }-- return &store.ListResourceFilter{- Args: positionalArgs,- Where: "(" + where + ")",- }, nil-}-// SearchWorksheets returns a list of worksheets based on the search filters.func (s *WorksheetService) SearchWorksheets(ctx context.Context,@@ -280,11 +154,11 @@ func (s *WorksheetService) SearchWorksheets(return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("filter should not be empty"))}- filter, err := s.getListSheetFilter(ctx, user.ID, request.Filter)+ filterQ, err := store.GetListSheetFilter(ctx, s.store, user.ID, request.Filter)if err != nil {- return nil, err+ return nil, connect.NewError(connect.CodeInvalidArgument, err)}- worksheetFind.Filter = filter+ worksheetFind.FilterQ = filterQworksheetList, err := s.store.ListWorkSheets(ctx, worksheetFind, user.ID)if err != nil {diff --git a/backend/store/worksheet.go b/backend/store/worksheet.goindex ad245a3925..99c0a617e8 100644--- a/backend/store/worksheet.go+++ b/backend/store/worksheet.go@@ -4,8 +4,12 @@ import ("context""database/sql""fmt"+ "strings""time"+ "github.com/google/cel-go/cel"+ celast "github.com/google/cel-go/common/ast"+ celoperators "github.com/google/cel-go/common/operators""github.com/pkg/errors""google.golang.org/protobuf/encoding/protojson"@@ -56,7 +60,7 @@ type FindWorkSheetMessage struct {// LoadFull is used if we want to load the full sheet.LoadFull bool- Filter *ListResourceFilter+ FilterQ *qb.Query}// PatchWorkSheetMessage is the message to patch a sheet.@@ -111,8 +115,8 @@ func (s *Store) ListWorkSheets(ctx context.Context, find *FindWorkSheetMessage,LEFT JOIN worksheet_organizer ON worksheet_organizer.worksheet_id = worksheet.id AND worksheet_organizer.principal_id = %dWHERE TRUE`, statementField, currentPrincipalID))- if filter := find.Filter; filter != nil {- q.And(ConvertDollarPlaceholders(filter.Where), filter.Args...)+ if filterQ := find.FilterQ; filterQ != nil {+ q.And("?", filterQ)}if v := find.UID; v != nil {@@ -348,3 +352,124 @@ func (s *Store) UpsertWorksheetOrganizer(ctx context.Context, organizer *Workshereturn &worksheetOrganizer, nil}++func GetListSheetFilter(ctx context.Context, s *Store, callerID int, filter string) (*qb.Query, error) {+ if filter == "" {+ return nil, nil+ }++ e, err := cel.NewEnv()+ if err != nil {+ return nil, errors.New("failed to create cel env")+ }+ ast, iss := e.Parse(filter)+ if iss != nil {+ return nil, errors.Errorf("failed to parse filter %v, error: %v", filter, iss.String())+ }++ var getFilter func(expr celast.Expr) (*qb.Query, error)++ getUserID := func(name string) (int, error) {+ creatorEmail := strings.TrimPrefix(name, "users/")+ if creatorEmail == "" {+ return 0, errors.New("invalid empty creator identifier")+ }+ user, err := s.GetUserByEmail(ctx, creatorEmail)+ if err != nil {+ return 0, errors.Errorf("failed to get user: %v", err)+ }+ if user == nil {+ return 0, errors.Errorf("user with email %s not found", creatorEmail)+ }+ return user.ID, nil+ }++ parseToSQL := func(variable, value any) (*qb.Query, error) {+ switch variable {+ case "creator":+ userID, err := getUserID(value.(string))+ if err != nil {+ return nil, err+ }+ return qb.Q().Space("worksheet.creator_id = ?", userID), nil+ case "starred":+ if starred, ok := value.(bool); ok {+ return qb.Q().Space("worksheet.id IN (SELECT worksheet_id FROM worksheet_organizer WHERE principal_id = ? AND starred = ?)", callerID, starred), nil+ }+ return qb.Q().Space("TRUE"), nil+ case "visibility":+ visibility := WorkSheetVisibility(value.(string))+ return qb.Q().Space("worksheet.visibility = ?", visibility), nil+ default:+ return nil, errors.Errorf("unsupport variable %q", variable)+ }+ }++ getFilter = func(expr celast.Expr) (*qb.Query, error) {+ q := qb.Q()+ switch expr.Kind() {+ case celast.CallKind:+ functionName := expr.AsCall().FunctionName()+ switch functionName {+ case celoperators.LogicalOr:+ for _, arg := range expr.AsCall().Args() {+ qq, err := getFilter(arg)+ if err != nil {+ return nil, err+ }+ q.Or("?", qq)+ }+ return qb.Q().Space("(?)", q), nil+ case celoperators.LogicalAnd:+ for _, arg := range expr.AsCall().Args() {+ qq, err := getFilter(arg)+ if err != nil {+ return nil, err+ }+ q.And("?", qq)+ }+ return qb.Q().Space("(?)", q), nil+ case celoperators.Equals:+ variable, value := getVariableAndValueFromExpr(expr)+ return parseToSQL(variable, value)+ case celoperators.NotEquals:+ variable, value := getVariableAndValueFromExpr(expr)+ if variable != "creator" {+ return nil, errors.Errorf(`only "creator" support "!=" operator`)+ }+ userID, err := getUserID(value.(string))+ if err != nil {+ return nil, err+ }+ return qb.Q().Space("worksheet.creator_id != ?", userID), nil+ case celoperators.In:+ variable, value := getVariableAndValueFromExpr(expr)+ if variable != "visibility" {+ return nil, errors.Errorf(`only "visibility" support "visibility in [xx]" filter`)+ }+ rawList, ok := value.([]any)+ if !ok {+ return nil, errors.Errorf("invalid visibility value %q", value)+ }+ if len(rawList) == 0 {+ return nil, errors.New("empty visibility filter")+ }+ visibilityList := []string{}+ for _, raw := range rawList {+ visibilityList = append(visibilityList, raw.(string))+ }+ return qb.Q().Space("worksheet.visibility = ANY(?)", visibilityList), nil+ default:+ return nil, errors.Errorf("unexpected function %v", functionName)+ }+ default:+ return nil, errors.Errorf("unexpected expr kind %v", expr.Kind())+ }+ }++ q, err := getFilter(ast.NativeRep().Expr())+ if err != nil {+ return nil, err+ }+ return qb.Q().Space("(?)", q), nil+}