robocanic commented on code in PR #1477:
URL: https://github.com/apache/dubbo-admin/pull/1477#discussion_r3565950016
##########
pkg/config/app/admin.go:
##########
@@ -51,24 +52,28 @@ type AdminConfig struct {
Engine *engine.Config `json:"engine" yaml:"engine"`
// EventBus configuration
EventBus *eventbus.Config `json:"eventBus,omitempty"
yaml:"eventBus,omitempty"`
+ // RuleVersioning records lightweight audit history for
governor-managed traffic rules.
+ // Live rule state remains in ResourceManager/registry.
+ RuleVersioning *versioning.Config `json:"ruleVersioning,omitempty"
yaml:"ruleVersioning,omitempty"`
}
var _ = &AdminConfig{}
var DefaultAdminConfig = func() AdminConfig {
eventBusCfg := eventbus.Default()
return AdminConfig{
- Log: log.DefaultLogConfig(),
- Store: store.DefaultStoreConfig(),
- Engine: engine.DefaultResourceEngineConfig(),
- Observability: observability.DefaultObservabilityConfig(),
- Diagnostics: diagnostics.DefaultDiagnosticsConfig(),
- Console: console.DefaultConsoleConfig(),
- EventBus: &eventBusCfg,
+ Log: log.DefaultLogConfig(),
+ Store: store.DefaultStoreConfig(),
+ Engine: engine.DefaultResourceEngineConfig(),
+ Observability: observability.DefaultObservabilityConfig(),
+ Diagnostics: diagnostics.DefaultDiagnosticsConfig(),
+ Console: console.DefaultConsoleConfig(),
+ EventBus: &eventBusCfg,
+ RuleVersioning: versioning.Default(),
}
}
-func (c AdminConfig) Sanitize() {
+func (c *AdminConfig) Sanitize() {
Review Comment:
Question: 为什么这里要加`*`？，对于同一个结构体，不应该同时使用了值接收者和指针接收者
##########
pkg/store/memory/store.go:
##########
Review Comment:
Correct：这里面加的锁操作看起来都有点多余，因为这里只是一个代理，真正执行操作的是底层的cache这个结构体方法
##########
pkg/core/versioning/resource_store_version.go:
##########
Review Comment:
Discussion：目前这个id是对外暴露的唯一标识，这也就造成了ruleVersion目前和其他Resource增删改查有较大差异的地方。如果是为了保证唯一，完全可以用“父规则
+ VersionNo”定位，少了很多id的工作。且用ID也还有哈希碰撞的概率；
具体可以：
1. 用 RuleKind + ResourceKey + VersionNo 定位版本。
2. 保留当前基于 VersionNo 的 ResourceKey。
3. 删除随机 ID generator、ID annotation 和 ByRuleVersionID 索引。
4/ 将 RolledBackFromID 改成 RolledBackFromVersionNo。
这样唯一性直接由 Store 的 ResourceKey 唯一约束原子保证，模型也只剩一套版本编号。前后端交互的协议的唯一标识也需要改变
##########
pkg/console/handler/rule_version.go:
##########
@@ -0,0 +1,320 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package handler
+
+import (
+ "errors"
+ "fmt"
+ "net/http"
+ "strconv"
+ "strings"
+ "time"
+
+ "github.com/gin-contrib/sessions"
+ "github.com/gin-gonic/gin"
+
+ "github.com/apache/dubbo-admin/pkg/common/bizerror"
+ consolectx "github.com/apache/dubbo-admin/pkg/console/context"
+ "github.com/apache/dubbo-admin/pkg/console/model"
+ "github.com/apache/dubbo-admin/pkg/console/service"
+ "github.com/apache/dubbo-admin/pkg/console/util"
+ coremodel "github.com/apache/dubbo-admin/pkg/core/resource/model"
+ "github.com/apache/dubbo-admin/pkg/core/versioning"
+)
+
+type rollbackReq struct {
+ Reason string `json:"reason"`
+}
+
+const maxRuleVersionReasonLength = 1024
+
+func ListRuleVersions(cs consolectx.Context, kind coremodel.ResourceKind)
gin.HandlerFunc {
+ return func(c *gin.Context) {
+ if !ensureVersioningAvailable(c, cs) {
+ return
+ }
+ resp, err := service.ListRuleVersions(cs,
service.RuleKindName{Kind: kind, Mesh: c.Query("mesh"), Name:
c.Param("ruleName")})
+ writeVersioningResp(c, resp, err)
+ }
+}
+
+func GetRuleVersion(cs consolectx.Context, kind coremodel.ResourceKind)
gin.HandlerFunc {
+ return func(c *gin.Context) {
+ if !ensureVersioningAvailable(c, cs) {
+ return
+ }
+ id, ok := parseVersionID(c)
+ if !ok {
+ return
+ }
+ resp, err := service.GetRuleVersion(cs,
service.RuleKindName{Kind: kind, Mesh: c.Query("mesh"), Name:
c.Param("ruleName")}, id)
+ writeVersioningResp(c, resp, err)
+ }
+}
+
+func DiffRuleVersion(cs consolectx.Context, kind coremodel.ResourceKind)
gin.HandlerFunc {
+ return func(c *gin.Context) {
+ if !ensureVersioningAvailable(c, cs) {
+ return
+ }
+ id, ok := parseVersionID(c)
+ if !ok {
+ return
+ }
+ resp, err := service.DiffRuleVersion(cs,
service.RuleKindName{Kind: kind, Mesh: c.Query("mesh"), Name:
c.Param("ruleName")}, id, c.Query("against"))
+ writeVersioningResp(c, resp, err)
+ }
+}
+
+func RollbackRuleVersion(cs consolectx.Context, kind coremodel.ResourceKind)
gin.HandlerFunc {
+ return func(c *gin.Context) {
+ if !ensureVersioningAvailable(c, cs) {
+ return
+ }
+ id, ok := parseVersionID(c)
+ if !ok {
+ return
+ }
+ req := rollbackReq{}
+ if err := c.ShouldBindJSON(&req); err != nil {
+ writeVersioningInvalidArgument(c, err.Error())
+ return
+ }
+ if !validateRuleVersionReasonLength(c, req.Reason) {
+ return
+ }
+ resp, err := service.RollbackRuleVersion(cs,
service.RuleKindName{Kind: kind, Mesh: c.Query("mesh"), Name:
c.Param("ruleName")}, id, req.Reason, currentUser(c))
+ writeVersioningResp(c, resp, err)
+ }
+}
+
+func validateRuleVersionReasonLength(c *gin.Context, reason string) bool {
+ if len(strings.TrimSpace(reason)) <= maxRuleVersionReasonLength {
+ return true
+ }
+ writeVersioningResp(c, nil, bizerror.New(bizerror.InvalidArgument,
"reason must be at most 1024 characters"))
+ return false
+}
+
+func mutationOptions(c *gin.Context) service.RuleMutationOptions {
+ return service.RuleMutationOptions{Author: currentUser(c)}
+}
+
+func parseVersionID(c *gin.Context) (int64, bool) {
+ id, err := parseProtocolInt64(c.Param("versionId"))
+ if err != nil {
+ writeVersioningInvalidArgument(c, "versionId must be a positive
decimal string")
+ return 0, false
+ }
+ return id, true
+}
+
+func parseProtocolInt64(raw string) (int64, error) {
+ if raw == "" {
+ return 0, fmt.Errorf("empty id")
+ }
+ for i := range raw {
+ if raw[i] < '0' || raw[i] > '9' {
+ return 0, fmt.Errorf("invalid decimal id")
+ }
+ }
+ if len(raw) > 1 && raw[0] == '0' {
+ return 0, fmt.Errorf("invalid leading zero")
+ }
+ id, err := strconv.ParseInt(raw, 10, 64)
+ if err != nil {
+ return 0, err
+ }
+ if id <= 0 {
+ return 0, fmt.Errorf("id must be positive")
+ }
+ return id, nil
+}
+
+func currentUser(c *gin.Context) string {
+ session := sessions.Default(c)
+ if user, ok := session.Get("user").(string); ok &&
strings.TrimSpace(user) != "" {
+ return user
+ }
+ return "system:unknown"
+}
+
+func ensureVersioningAvailable(c *gin.Context, cs consolectx.Context) bool {
+ if cs.RuleVersioning() != nil {
+ return true
+ }
+ util.HandleServiceError(c, bizerror.New(bizerror.InternalError, "rule
history service is unavailable"))
+ return false
+}
+
+func writeVersioningResp(c *gin.Context, data any, err error) {
+ if err == nil {
+ c.JSON(http.StatusOK,
model.NewSuccessResp(versioningAPIData(data)))
+ return
+ }
+ util.HandleServiceError(c, versioningServiceError(err))
+}
+
+func versioningServiceError(err error) error {
+ var bizErr bizerror.Error
+ switch {
+ case errors.Is(err, versioning.ErrVersionNotFound):
+ return bizerror.New(bizerror.NotFoundError, err.Error())
+ case errors.Is(err, versioning.ErrRollbackToDelete), errors.Is(err,
versioning.ErrRollbackToCurrent):
+ return bizerror.New(bizerror.InvalidArgument, err.Error())
+ case errors.As(err, &bizErr):
+ return bizErr
+ default:
+ return err
+ }
+}
+
+type ruleVersionAPI struct {
Review Comment:
Question：这几个接口入参/出参的命名都很奇怪
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
