codecov:1.18.0

apiserver/grpcserver/discover/v1/client_access.go

@@ -163,6 +163,9 @@ func (g *DiscoverServer) Discover(server apiservice.PolarisGRPC_DiscoverServer)
 		case apiservice.DiscoverRequest_FAULT_DETECTOR:
 			action = metrics.ActionDiscoverFaultDetect
 			out = g.namingServer.GetFaultDetectWithCache(ctx, in.Service)
+		case apiservice.DiscoverRequest_SERVICE_CONTRACT:
+			action = metrics.ActionDiscoverServiceContract
+			out = g.namingServer.GetServiceContractWithCache(ctx, in.ServiceContract)
 		default:
 			out = api.NewDiscoverRoutingResponse(apimodel.Code_InvalidDiscoverResource, in.Service)
 		}

apiserver/xdsserverv3/resource/help.go

@@ -333,7 +333,7 @@ func BuildRateLimitDescriptors(rule *traffic_manage.Rule) ([]*route.RateLimit_Ac
 				Value: arg.GetValue().GetValue().GetValue(),
 			})
 		case apitraffic.MatchArgument_QUERY:
-			queryParameterValueMatch := BuildRateLimitActionQueryParameterValueMatch(descriptorKey, arg.Value)
+			queryParameterValueMatch := BuildRateLimitActionQueryParameterValueMatch(descriptorKey, arg)
 			actions = append(actions, &route.RateLimit_Action{
 				ActionSpecifier: &route.RateLimit_Action_QueryParameterValueMatch_{
 					QueryParameterValueMatch: queryParameterValueMatch,
@@ -425,22 +425,22 @@ func BuildRateLimitDescriptors(rule *traffic_manage.Rule) ([]*route.RateLimit_Ac
 }
 
 func BuildRateLimitActionQueryParameterValueMatch(key string,
-	value *apimodel.MatchString) *route.RateLimit_Action_QueryParameterValueMatch {
+	arg *apitraffic.MatchArgument) *route.RateLimit_Action_QueryParameterValueMatch {
 	queryParameterValueMatch := &route.RateLimit_Action_QueryParameterValueMatch{
 		DescriptorKey:   key,
-		DescriptorValue: value.GetValue().GetValue(),
+		DescriptorValue: arg.GetValue().GetValue().GetValue(),
 		ExpectMatch:     wrapperspb.Bool(true),
 		QueryParameters: []*route.QueryParameterMatcher{},
 	}
-	switch value.GetType() {
+	switch arg.GetValue().GetType() {
 	case apimodel.MatchString_EXACT:
 		queryParameterValueMatch.QueryParameters = []*route.QueryParameterMatcher{
 			{
-				Name: key,
+				Name: arg.GetKey(),
 				QueryParameterMatchSpecifier: &route.QueryParameterMatcher_StringMatch{
 					StringMatch: &v32.StringMatcher{
 						MatchPattern: &v32.StringMatcher_Exact{
-							Exact: value.GetValue().GetValue(),
+							Exact: arg.GetValue().GetValue().GetValue(),
 						},
 					},
 				},
@@ -449,13 +449,13 @@ func BuildRateLimitActionQueryParameterValueMatch(key string,
 	case apimodel.MatchString_REGEX:
 		queryParameterValueMatch.QueryParameters = []*route.QueryParameterMatcher{
 			{
-				Name: key,
+				Name: arg.GetKey(),
 				QueryParameterMatchSpecifier: &route.QueryParameterMatcher_StringMatch{
 					StringMatch: &v32.StringMatcher{
 						MatchPattern: &v32.StringMatcher_SafeRegex{
 							SafeRegex: &v32.RegexMatcher{
 								EngineType: &v32.RegexMatcher_GoogleRe2{},
-								Regex:      value.GetValue().GetValue(),
+								Regex:      arg.GetValue().GetValue().GetValue(),
 							},
 						},
 					},

common/metrics/types.go

@@ -116,16 +116,17 @@ func ResourceOfConfigFile(group, name string) string {
 }
 
 const (
-	ActionGetConfigFile          = "GET_CONFIG_FILE"
-	ActionListConfigFiles        = "LIST_CONFIG_FILES"
-	ActionListConfigGroups       = "LIST_CONFIG_GROUPS"
-	ActionPublishConfigFile      = "PUBLISH_CONFIG_FILE"
-	ActionDiscoverInstance       = "DISCOVER_INSTANCE"
-	ActionDiscoverServices       = "DISCOVER_SERVICES"
-	ActionDiscoverRouterRule     = "DISCOVER_ROUTER_RULE"
-	ActionDiscoverRateLimit      = "DISCOVER_RATE_LIMIT"
-	ActionDiscoverCircuitBreaker = "DISCOVER_CIRCUIT_BREAKER"
-	ActionDiscoverFaultDetect    = "DISCOVER_FAULT_DETECT"
+	ActionGetConfigFile           = "GET_CONFIG_FILE"
+	ActionListConfigFiles         = "LIST_CONFIG_FILES"
+	ActionListConfigGroups        = "LIST_CONFIG_GROUPS"
+	ActionPublishConfigFile       = "PUBLISH_CONFIG_FILE"
+	ActionDiscoverInstance        = "DISCOVER_INSTANCE"
+	ActionDiscoverServices        = "DISCOVER_SERVICES"
+	ActionDiscoverRouterRule      = "DISCOVER_ROUTER_RULE"
+	ActionDiscoverRateLimit       = "DISCOVER_RATE_LIMIT"
+	ActionDiscoverCircuitBreaker  = "DISCOVER_CIRCUIT_BREAKER"
+	ActionDiscoverFaultDetect     = "DISCOVER_FAULT_DETECT"
+	ActionDiscoverServiceContract = "DISCOVER_SERVICE_CONTRACT"
 )
 
 type ClientDiscoverMetric struct {

common/model/contract.go

@@ -21,6 +21,7 @@ import (
 	"fmt"
 	"time"
 
+	commontime "github.com/polarismesh/polaris/common/time"
 	apiservice "github.com/polarismesh/specification/source/go/api/v1/service_manage"
 )
 
@@ -89,12 +90,34 @@ func (e *EnrichServiceContract) Format() {
 	}
 }
 
-type ServiceContractView struct {
-	*ServiceContract
-	// 接口描述信息
-	Interfaces       []*InterfaceDescriptor
-	ClientInterfaces map[string]*InterfaceDescriptor
-	ManualInterfaces map[string]*InterfaceDescriptor
+func (e *EnrichServiceContract) ToSpec() *apiservice.ServiceContract {
+	interfaces := make([]*apiservice.InterfaceDescriptor, 0, len(e.Interfaces))
+	for i := range e.Interfaces {
+		item := e.Interfaces[i]
+		interfaces = append(interfaces, &apiservice.InterfaceDescriptor{
+			Id:       item.ID,
+			Path:     item.Path,
+			Method:   item.Method,
+			Source:   item.Source,
+			Content:  item.Content,
+			Revision: item.Revision,
+			Ctime:    commontime.Time2String(item.CreateTime),
+			Mtime:    commontime.Time2String(item.ModifyTime),
+		})
+	}
+	return &apiservice.ServiceContract{
+		Id:         e.ID,
+		Name:       e.Name,
+		Namespace:  e.Namespace,
+		Service:    e.Service,
+		Protocol:   e.Protocol,
+		Version:    e.Version,
+		Revision:   e.Revision,
+		Content:    e.Content,
+		Ctime:      commontime.Time2String(e.CreateTime),
+		Mtime:      commontime.Time2String(e.ModifyTime),
+		Interfaces: interfaces,
+	}
 }
 
 func (s *ServiceContract) GetResourceName() string {

go.mod

@@ -82,7 +82,7 @@ require (
 
 require (
 	github.com/DATA-DOG/go-sqlmock v1.5.0
-	github.com/polarismesh/specification v1.4.2-alpha.6
+	github.com/polarismesh/specification v1.4.2-alpha.7
 )
 
 require (

go.sum

@@ -323,8 +323,8 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/polarismesh/go-restful-openapi/v2 v2.0.0-20220928152401-083908d10219 h1:XnFyNUWnciM6zgXaz6tm+Egs35rhoD0KGMmKh4gCdi0=
 github.com/polarismesh/go-restful-openapi/v2 v2.0.0-20220928152401-083908d10219/go.mod h1:4WhwBysTom9Eoy0hQ4W69I0FmO+T0EpjEW9/5sgHoUk=
-github.com/polarismesh/specification v1.4.2-alpha.6 h1:EUhATwFjb4lGIrI/UEoaVdyLWpjZrOuDTQn4S12QE10=
-github.com/polarismesh/specification v1.4.2-alpha.6/go.mod h1:rDvMMtl5qebPmqiBLNa5Ps0XtwkP31ZLirbH4kXA0YU=
+github.com/polarismesh/specification v1.4.2-alpha.7 h1:4BhlGD/xJ/092cuu/T5BgwAMwlPFg8vIMfBNMRyEtak=
+github.com/polarismesh/specification v1.4.2-alpha.7/go.mod h1:rDvMMtl5qebPmqiBLNa5Ps0XtwkP31ZLirbH4kXA0YU=
 github.com/posener/complete v1.1.1/go.mod h1:em0nMJCgc9GFtwrmVmEMR/ZL6WyhyjMBndrE9hABlRI=
 github.com/prometheus/client_golang v0.9.1/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw=
 github.com/prometheus/client_golang v1.0.0/go.mod h1:db9x61etRT2tGnBNRi70OPL5FsnadC4Ky3P0J6CfImo=

service/api_v1.go

@@ -180,6 +180,8 @@ type ClientServer interface {
 	GetCircuitBreakerWithCache(ctx context.Context, req *apiservice.Service) *apiservice.DiscoverResponse
 	// GetFaultDetectWithCache User Client Get FaultDetect Rule Information
 	GetFaultDetectWithCache(ctx context.Context, req *apiservice.Service) *apiservice.DiscoverResponse
+	// GetServiceContractWithCache User Client Get ServiceContract Rule Information
+	GetServiceContractWithCache(ctx context.Context, req *apiservice.ServiceContract) *apiservice.DiscoverResponse
 	// UpdateInstance update one instance by client
 	UpdateInstance(ctx context.Context, req *apiservice.Instance) *apiservice.Response
 	// ReportServiceContract client report service_contract

service/client_v1.go

@@ -27,6 +27,7 @@ import (
 	apiservice "github.com/polarismesh/specification/source/go/api/v1/service_manage"
 	apitraffic "github.com/polarismesh/specification/source/go/api/v1/traffic_manage"
 	"go.uber.org/zap"
+	"google.golang.org/protobuf/types/known/wrapperspb"
 
 	cachetypes "github.com/polarismesh/polaris/cache/api"
 	api "github.com/polarismesh/polaris/common/api/v1"
@@ -493,6 +494,62 @@ func (s *Server) GetCircuitBreakerWithCache(ctx context.Context, req *apiservice
 	return resp
 }
 
+// GetServiceContractWithCache User Client Get ServiceContract Rule Information
+func (s *Server) GetServiceContractWithCache(ctx context.Context,
+	req *apiservice.ServiceContract) *apiservice.DiscoverResponse {
+	resp := &apiservice.DiscoverResponse{
+		Code: &wrappers.UInt32Value{Value: uint32(apimodel.Code_ExecuteSuccess)},
+		Info: &wrappers.StringValue{Value: api.Code2Info(uint32(apimodel.Code_ExecuteSuccess))},
+		Type: apiservice.DiscoverResponse_SERVICE_CONTRACT,
+		Service: &apiservice.Service{
+			Name:      wrapperspb.String(req.GetService()),
+			Namespace: wrapperspb.String(req.GetNamespace()),
+		},
+	}
+	if !s.serviceContractCheckDiscoverRequest(req, resp) {
+		return resp
+	}
+
+	// 服务名和request保持一致
+	resp.Service = &apiservice.Service{
+		Name:      wrapperspb.String(req.GetService()),
+		Namespace: wrapperspb.String(req.GetNamespace()),
+	}
+
+	// 获取源服务
+	aliasFor := s.getServiceCache(req.GetService(), req.GetNamespace())
+	if aliasFor == nil {
+		aliasFor = &model.Service{
+			Namespace: req.GetNamespace(),
+			Name:      req.GetService(),
+		}
+	}
+
+	out := s.caches.ServiceContract().Get(&model.ServiceContract{
+		Namespace: aliasFor.Namespace,
+		Service:   aliasFor.Name,
+		Version:   req.Version,
+		Name:      req.Name,
+		Protocol:  req.Protocol,
+	})
+	if out == nil {
+		resp.Code = wrapperspb.UInt32(uint32(apimodel.Code_NotFoundResource))
+		resp.Info = wrapperspb.String(api.Code2Info(uint32(apimodel.Code_NotFoundResource)))
+		return resp
+	}
+
+	// 获取熔断规则数据，并对比revision
+	if len(req.GetRevision()) > 0 && req.GetRevision() == out.Revision {
+		resp.Code = wrapperspb.UInt32(uint32(apimodel.Code_DataNoChange))
+		resp.Info = wrapperspb.String(api.Code2Info(uint32(apimodel.Code_DataNoChange)))
+		return resp
+	}
+
+	resp.Service.Revision = wrapperspb.String(out.Revision)
+	resp.ServiceContract = out.ToSpec()
+	return resp
+}
+
 func createCommonDiscoverResponse(req *apiservice.Service,
 	dT apiservice.DiscoverResponse_DiscoverResponseType) *apiservice.DiscoverResponse {
 	return &apiservice.DiscoverResponse{
@@ -578,3 +635,62 @@ func (s *Server) commonCheckDiscoverRequest(req *apiservice.Service, resp *apise
 
 	return true
 }
+
+func (s *Server) serviceContractCheckDiscoverRequest(req *apiservice.ServiceContract, resp *apiservice.DiscoverResponse) bool {
+	svc := &apiservice.Service{
+		Name:      wrapperspb.String(req.GetService()),
+		Namespace: wrapperspb.String(req.GetNamespace()),
+	}
+
+	if s.caches == nil {
+		resp.Code = utils.NewUInt32Value(uint32(apimodel.Code_ClientAPINotOpen))
+		resp.Info = utils.NewStringValue(api.Code2Info(resp.GetCode().GetValue()))
+		resp.Service = svc
+		resp.ServiceContract = req
+		return false
+	}
+	if req == nil {
+		resp.Code = utils.NewUInt32Value(uint32(apimodel.Code_EmptyRequest))
+		resp.Info = utils.NewStringValue(api.Code2Info(resp.GetCode().GetValue()))
+		resp.Service = svc
+		resp.ServiceContract = req
+		return false
+	}
+
+	if req.GetName() == "" {
+		resp.Code = utils.NewUInt32Value(uint32(apimodel.Code_InvalidParameter))
+		resp.Info = utils.NewStringValue(api.Code2Info(resp.GetCode().GetValue()))
+		resp.Service = svc
+		resp.ServiceContract = req
+		return false
+	}
+	if req.GetNamespace() == "" {
+		resp.Code = utils.NewUInt32Value(uint32(apimodel.Code_InvalidNamespaceName))
+		resp.Info = utils.NewStringValue(api.Code2Info(resp.GetCode().GetValue()))
+		resp.Service = svc
+		resp.ServiceContract = req
+		return false
+	}
+	if req.GetService() == "" {
+		resp.Code = utils.NewUInt32Value(uint32(apimodel.Code_InvalidServiceName))
+		resp.Info = utils.NewStringValue(api.Code2Info(resp.GetCode().GetValue()))
+		resp.Service = svc
+		resp.ServiceContract = req
+		return false
+	}
+	if req.GetProtocol() == "" {
+		resp.Code = utils.NewUInt32Value(uint32(apimodel.Code_InvalidParameter))
+		resp.Info = utils.NewStringValue(api.Code2Info(resp.GetCode().GetValue()))
+		resp.Service = svc
+		resp.ServiceContract = req
+		return false
+	}
+	if req.GetVersion() == "" {
+		resp.Code = utils.NewUInt32Value(uint32(apimodel.Code_InvalidParameter))
+		resp.Info = utils.NewStringValue(api.Code2Info(resp.GetCode().GetValue()))
+		resp.Service = svc
+		resp.ServiceContract = req
+		return false
+	}
+	return true
+}

service/interceptor/auth/client_v1_authability.go

@@ -216,3 +216,24 @@ func (svr *ServerAuthAbility) UpdateInstance(ctx context.Context, req *apiservic
 
 	return svr.targetServer.UpdateInstance(ctx, req)
 }
+
+// GetServiceContractWithCache User Client Get ServiceContract Rule Information
+func (svr *ServerAuthAbility) GetServiceContractWithCache(ctx context.Context, req *apiservice.ServiceContract) *apiservice.DiscoverResponse {
+	authCtx := svr.collectServiceAuthContext(
+		ctx, []*apiservice.Service{&apiservice.Service{
+			Namespace: wrapperspb.String(req.Namespace),
+			Name:      wrapperspb.String(req.Service),
+		}}, model.Read, "GetServiceContractWithCache")
+
+	_, err := svr.strategyMgn.GetAuthChecker().CheckClientPermission(authCtx)
+	if err != nil {
+		resp := api.NewDiscoverResponse(convertToErrCode(err))
+		resp.Info = utils.NewStringValue(err.Error())
+		return resp
+	}
+
+	ctx = authCtx.GetRequestContext()
+	ctx = context.WithValue(ctx, utils.ContextAuthContextKey, authCtx)
+
+	return svr.targetServer.GetServiceContractWithCache(ctx, req)
+}