Skip to content

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

refactor: use Config field in UpdatePlanMessage to follow store pattern (#18636)

Danny Xu4fdeee9fc709
diff --git a/backend/api/v1/plan_service.go b/backend/api/v1/plan_service.go
index 8131b03c73..78d0e4655e 100644
--- a/backend/api/v1/plan_service.go
+++ b/backend/api/v1/plan_service.go
@@ -7,6 +7,7 @@ import (
"connectrpc.com/connect"
"github.com/pkg/errors"
+ "google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/known/timestamppb"
"github.com/bytebase/bytebase/backend/common"
@@ -366,7 +367,9 @@ func (s *PlanService) UpdatePlan(ctx context.Context, request *connect.Request[v
// Convert and store new specs.
allSpecs := convertPlanSpecs(req.GetPlan().GetSpecs())
- planUpdate.Specs = &allSpecs
+ config := proto.CloneOf(oldPlan.Config)
+ config.Specs = allSpecs
+ planUpdate.Config = config
// Trigger plan check runs.
planCheckRunsTrigger = true
diff --git a/backend/api/v1/rollout_service.go b/backend/api/v1/rollout_service.go
index 00cf14a956..f04bb64305 100644
--- a/backend/api/v1/rollout_service.go
+++ b/backend/api/v1/rollout_service.go
@@ -10,6 +10,7 @@ import (
"connectrpc.com/connect"
"github.com/jackc/pgtype"
"github.com/pkg/errors"
+ "google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/known/timestamppb"
"github.com/bytebase/bytebase/backend/common"
@@ -304,10 +305,11 @@ func (s *RolloutService) CreateRollout(ctx context.Context, req *connect.Request
}
// Update plan to set hasRollout to true
- hasRollout := true
+ config := proto.CloneOf(plan.Config)
+ config.HasRollout = true
if err := s.store.UpdatePlan(ctx, &store.UpdatePlanMessage{
- UID: planID,
- HasRollout: &hasRollout,
+ UID: planID,
+ Config: config,
}); err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to update plan hasRollout, error: %v", err))
}
diff --git a/backend/store/plan.go b/backend/store/plan.go
index e97f617e06..f9f87d8c72 100644
--- a/backend/store/plan.go
+++ b/backend/store/plan.go
@@ -53,9 +53,11 @@ type UpdatePlanMessage struct {
UID int64
Name *string
Description *string
- Specs *[]*storepb.PlanConfig_Spec
- HasRollout *bool
- Deleted *bool
+ // Config replaces the entire plan config.
+ // Callers should clone the existing config and modify only the fields they want to change.
+ // Example: config := proto.CloneOf(plan.Config); config.HasRollout = true; patch.Config = config
+ Config *storepb.PlanConfig
+ Deleted *bool
}
// CreatePlan creates a new plan.
@@ -236,29 +238,14 @@ func (s *Store) UpdatePlan(ctx context.Context, patch *UpdatePlanMessage) error
set = append(set, "deleted = ?")
args = append(args, *v)
}
-
- var payloadSets []string
- if v := patch.Specs; v != nil {
- config, err := protojson.Marshal(&storepb.PlanConfig{
- Specs: *v,
- })
+ if v := patch.Config; v != nil {
+ config, err := protojson.Marshal(v)
if err != nil {
return errors.Wrapf(err, "failed to marshal plan config")
}
- payloadSets = append(payloadSets, "jsonb_build_object('specs', (?)::JSONB->'specs')")
+ set = append(set, "config = ?")
args = append(args, config)
}
- if v := patch.HasRollout; v != nil {
- boolStr := "false"
- if *v {
- boolStr = "true"
- }
- payloadSets = append(payloadSets, "jsonb_build_object('hasRollout', ?::jsonb)")
- args = append(args, boolStr)
- }
- if len(payloadSets) > 0 {
- set = append(set, fmt.Sprintf("config = config || %s", strings.Join(payloadSets, " || ")))
- }
args = append(args, patch.UID)
q := qb.Q().Space(fmt.Sprintf("UPDATE plan SET %s WHERE id = ?", strings.Join(set, ", ")), args...)