feat: add annotation for mirror svc (#1121)

pkg/ingress/kube/annotations/annotations.go

@@ -69,6 +69,8 @@ type Ingress struct {
 
  Auth *AuthConfig
 
+ Mirror *MirrorConfig
+
  Destination *DestinationConfig
 
  IgnoreCase *IgnoreCaseConfig
@@ -161,6 +163,7 @@ func NewAnnotationHandlerManager() AnnotationHandler {
  localRateLimit{},
  fallback{},
  auth{},
+ mirror{},
  destination{},
  ignoreCaseMatching{},
  match{},
@@ -182,6 +185,7 @@ func NewAnnotationHandlerManager() AnnotationHandler {
  retry{},
  localRateLimit{},
  fallback{},
+ mirror{},
  ignoreCaseMatching{},
  match{},
  headerControl{},

pkg/ingress/kube/annotations/mirror.go

@@ -0,0 +1,118 @@
+// Copyright (c) 2023 Alibaba Group Holding Ltd.
+//
+// Licensed 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 annotations
+
+import (
+ "github.com/alibaba/higress/pkg/ingress/kube/util"
+ . "github.com/alibaba/higress/pkg/ingress/log"
+ wrappers "google.golang.org/protobuf/types/known/wrapperspb"
+ networking "istio.io/api/networking/v1alpha3"
+)
+
+const (
+ mirrorTargetService = "mirror-target-service"
+ mirrorPercentage = "mirror-percentage"
+)
+
+var (
+ _ Parser = &mirror{}
+ _ RouteHandler = &mirror{}
+)
+
+type MirrorConfig struct {
+ util.ServiceInfo
+ Percentage *wrappers.DoubleValue
+}
+
+type mirror struct{}
+
+func (m mirror) Parse(annotations Annotations, config *Ingress, globalContext *GlobalContext) error {
+ if !needMirror(annotations) {
+ return nil
+ }
+
+ target, err := annotations.ParseStringASAP(mirrorTargetService)
+ if err != nil {
+ IngressLog.Errorf("Get mirror target service fail, err: %v", err)
+ return nil
+ }
+
+ serviceInfo, err := util.ParseServiceInfo(target, config.Namespace)
+ if err != nil {
+ IngressLog.Errorf("Get mirror target service fail, err: %v", err)
+ return nil
+ }
+
+ serviceLister, exist := globalContext.ClusterServiceList[config.ClusterId]
+ if !exist {
+ IngressLog.Errorf("service lister of cluster %s doesn't exist", config.ClusterId)
+ return nil
+ }
+
+ service, err := serviceLister.Services(serviceInfo.Namespace).Get(serviceInfo.Name)
+ if err != nil {
+ IngressLog.Errorf("Mirror service %s/%s within ingress %s/%s is not found, with err: %v",
+ serviceInfo.Namespace, serviceInfo.Name, config.Namespace, config.Name, err)
+ return nil
+ }
+ if service == nil {
+ IngressLog.Errorf("service %s/%s within ingress %s/%s is empty value",
+ serviceInfo.Namespace, serviceInfo.Name, config.Namespace, config.Name)
+ return nil
+ }
+
+ if serviceInfo.Port == 0 {
+ // Use the first port
+ serviceInfo.Port = uint32(service.Spec.Ports[0].Port)
+ }
+
+ var percentage *wrappers.DoubleValue
+ if value, err := annotations.ParseIntASAP(mirrorPercentage); err == nil {
+ if value < 100 {
+ percentage = &wrappers.DoubleValue{
+ Value: float64(value),
+ }
+ }
+ }
+
+ config.Mirror = &MirrorConfig{
+ ServiceInfo: serviceInfo,
+ Percentage: percentage,
+ }
+ return nil
+}
+
+func (m mirror) ApplyRoute(route *networking.HTTPRoute, config *Ingress) {
+ if config.Mirror == nil {
+ return
+ }
+
+ route.Mirror = &networking.Destination{
+ Host: util.CreateServiceFQDN(config.Mirror.Namespace, config.Mirror.Name),
+ Port: &networking.PortSelector{
+ Number: config.Mirror.Port,
+ },
+ }
+
+ if config.Mirror.Percentage != nil {
+ route.MirrorPercentage = &networking.Percent{
+ Value: config.Mirror.Percentage.GetValue(),
+ }
+ }
+}
+
+func needMirror(annotations Annotations) bool {
+ return annotations.HasASAP(mirrorTargetService)
+}

pkg/ingress/kube/annotations/mirror_test.go

@@ -0,0 +1,163 @@
+// Copyright (c) 2022 Alibaba Group Holding Ltd.
+//
+// Licensed 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 annotations
+
+import (
+ "github.com/alibaba/higress/pkg/ingress/kube/util"
+ "github.com/golang/protobuf/proto"
+ networking "istio.io/api/networking/v1alpha3"
+ "istio.io/istio/pilot/pkg/model"
+ "reflect"
+ "testing"
+)
+
+func TestParseMirror(t *testing.T) {
+ testCases := []struct {
+ input []map[string]string
+ expect *MirrorConfig
+ }{
+ {},
+ {
+ input: []map[string]string{
+ {buildHigressAnnotationKey(mirrorTargetService): "test/app"},
+ {buildNginxAnnotationKey(mirrorTargetService): "test/app"},
+ },
+ expect: &MirrorConfig{
+ ServiceInfo: util.ServiceInfo{
+ NamespacedName: model.NamespacedName{
+ Namespace: "test",
+ Name: "app",
+ },
+ Port: 80,
+ },
+ },
+ },
+ {
+ input: []map[string]string{
+ {buildHigressAnnotationKey(mirrorTargetService): "test/app:8080"},
+ {buildNginxAnnotationKey(mirrorTargetService): "test/app:8080"},
+ },
+ expect: &MirrorConfig{
+ ServiceInfo: util.ServiceInfo{
+ NamespacedName: model.NamespacedName{
+ Namespace: "test",
+ Name: "app",
+ },
+ Port: 8080,
+ },
+ },
+ },
+ {
+ input: []map[string]string{
+ {buildHigressAnnotationKey(mirrorTargetService): "test/app:hi"},
+ {buildNginxAnnotationKey(mirrorTargetService): "test/app:hi"},
+ },
+ expect: &MirrorConfig{
+ ServiceInfo: util.ServiceInfo{
+ NamespacedName: model.NamespacedName{
+ Namespace: "test",
+ Name: "app",
+ },
+ Port: 80,
+ },
+ },
+ },
+ {
+ input: []map[string]string{
+ {buildHigressAnnotationKey(mirrorTargetService): "test/app"},
+ {buildNginxAnnotationKey(mirrorTargetService): "test/app"},
+ },
+ expect: &MirrorConfig{
+ ServiceInfo: util.ServiceInfo{
+ NamespacedName: model.NamespacedName{
+ Namespace: "test",
+ Name: "app",
+ },
+ Port: 80,
+ },
+ },
+ },
+ }
+
+ mirror := mirror{}
+
+ for _, testCase := range testCases {
+ t.Run("", func(t *testing.T) {
+ config := &Ingress{
+ Meta: Meta{
+ Namespace: "test",
+ ClusterId: "cluster",
+ },
+ }
+ globalContext, cancel := initGlobalContextForService()
+ defer cancel()
+
+ for _, in := range testCase.input {
+ _ = mirror.Parse(in, config, globalContext)
+ if !reflect.DeepEqual(testCase.expect, config.Mirror) {
+ t.Log("expect:", *testCase.expect)
+ t.Log("actual:", *config.Mirror)
+ t.Fatal("Should be equal")
+ }
+ }
+ })
+ }
+}
+
+func TestMirror_ApplyRoute(t *testing.T) {
+ testCases := []struct {
+ config *Ingress
+ input *networking.HTTPRoute
+ expect *networking.HTTPRoute
+ }{
+ {
+ config: &Ingress{},
+ input: &networking.HTTPRoute{},
+ expect: &networking.HTTPRoute{},
+ },
+ {
+ config: &Ingress{
+ Mirror: &MirrorConfig{
+ ServiceInfo: util.ServiceInfo{
+ NamespacedName: model.NamespacedName{
+ Namespace: "default",
+ Name: "test",
+ },
+ Port: 8080,
+ },
+ },
+ },
+ input: &networking.HTTPRoute{},
+ expect: &networking.HTTPRoute{
+ Mirror: &networking.Destination{
+ Host: "test.default.svc.cluster.local",
+ Port: &networking.PortSelector{
+ Number: 8080,
+ },
+ },
+ },
+ },
+ }
+
+ mirror := mirror{}
+ for _, testCase := range testCases {
+ t.Run("", func(t *testing.T) {
+ mirror.ApplyRoute(testCase.input, testCase.config)
+ if !proto.Equal(testCase.input, testCase.expect) {
+ t.Fatal("Must be equal.")
+ }
+ })
+ }
+}

pkg/ingress/kube/util/util.go

@@ -20,8 +20,10 @@ import (
  "encoding/hex"
  "errors"
  "fmt"
+ "istio.io/istio/pilot/pkg/model"
  "os"
  "path"
+ "strconv"
  "strings"
 
  "github.com/golang/protobuf/jsonpb"
@@ -113,3 +115,44 @@ func BuildPatchStruct(config string) *_struct.Struct {
  }
  return val
 }
+
+type ServiceInfo struct {
+ model.NamespacedName
+ Port uint32
+}
+
+// convertToPort converts a port string to a uint32.
+func convertToPort(v string) (uint32, error) {
+ p, err := strconv.ParseUint(v, 10, 32)
+ if err != nil || p > 65535 {
+ return 0, fmt.Errorf("invalid port %s: %v", v, err)
+ }
+ return uint32(p), nil
+}
+
+func ParseServiceInfo(service string, ingressNamespace string) (ServiceInfo, error) {
+ parts := strings.Split(service, ":")
+ namespacedName := SplitNamespacedName(parts[0])
+
+ if namespacedName.Name == "" {
+ return ServiceInfo{}, errors.New("service name can not be empty")
+ }
+
+ if namespacedName.Namespace == "" {
+ namespacedName.Namespace = ingressNamespace
+ }
+
+ var port uint32
+ if len(parts) == 2 {
+ // If port parse fail, we ignore port and pick the first one.
+ port, _ = convertToPort(parts[1])
+ }
+
+ return ServiceInfo{
+ NamespacedName: model.NamespacedName{
+ Name: namespacedName.Name,
+ Namespace: namespacedName.Namespace,
+ },
+ Port: port,
+ }, nil
+}

plugins/wasm-go/extensions/oidc/go.mod

@@ -1,6 +1,8 @@
 module github.com/alibaba/higress/plugins/wasm-go/extensions/oidc
 
-go 1.19
+go 1.21
+
+toolchain go1.22.5
 
 replace github.com/alibaba/higress/plugins/wasm-go => ../..