Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add ValidateSubscription in gateway #351

Merged
merged 4 commits into from
Dec 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 56 additions & 1 deletion internal/gateway/proxy/proxy.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,26 @@ import (
"context"
"encoding/base64"
"encoding/binary"
"errors"
"fmt"
"net"
"runtime/debug"
"sync"

v2 "github.com/cloudevents/sdk-go/v2"
recovery "github.com/grpc-ecosystem/go-grpc-middleware/recovery"
eb "github.com/linkall-labs/vanus/client"
"github.com/linkall-labs/vanus/client/pkg/api"
"github.com/linkall-labs/vanus/client/pkg/option"
"github.com/linkall-labs/vanus/client/pkg/policy"
"github.com/linkall-labs/vanus/internal/convert"
"github.com/linkall-labs/vanus/internal/primitive/interceptor/errinterceptor"
"github.com/linkall-labs/vanus/internal/primitive/vanus"
"github.com/linkall-labs/vanus/internal/trigger/filter"
"github.com/linkall-labs/vanus/internal/trigger/transform"
"github.com/linkall-labs/vanus/observability/log"
"github.com/linkall-labs/vanus/observability/tracing"
"github.com/linkall-labs/vanus/pkg/cluster"
"github.com/linkall-labs/vanus/pkg/errors"
ctrlpb "github.com/linkall-labs/vanus/proto/pkg/controller"
proxypb "github.com/linkall-labs/vanus/proto/pkg/proxy"
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
Expand Down Expand Up @@ -231,6 +235,57 @@ func (cp *ControllerProxy) GetEvent(ctx context.Context,
}, nil
}

func (cp *ControllerProxy) ValidateSubscription(ctx context.Context,
req *proxypb.ValidateSubscriptionRequest) (*proxypb.ValidateSubscriptionResponse, error) {
if req.GetEvent() == nil {
res, err := cp.GetEvent(ctx, &proxypb.GetEventRequest{
Eventbus: req.Eventbus,
EventlogId: req.Eventlog,
Offset: req.Offset,
Number: 1,
})
if err != nil {
return nil, err
}
req.Event = res.GetEvents()[0].Value
}

e := v2.NewEvent()
if err := e.UnmarshalJSON(req.GetEvent()); err != nil {
return nil, errors.ErrInvalidRequest.WithMessage("failed to unmarshall event to CloudEvent").Wrap(err)
}

if req.GetSubscription() == nil {
sub, err := cp.GetSubscription(ctx, &ctrlpb.GetSubscriptionRequest{Id: req.SubscriptionId})
if err != nil {
return nil, err
}
req.Subscription = &ctrlpb.SubscriptionRequest{
Filters: sub.Filters,
Transformer: sub.Transformer,
}
}

sub := convert.FromPbSubscriptionRequest(req.Subscription)
res := &proxypb.ValidateSubscriptionResponse{}
f := filter.GetFilter(sub.Filters)
r := f.Filter(e)
if !r {
return res, nil
}

res.FilterResult = true
t := transform.NewTransformer(sub.Transformer)
if t != nil {
if err := t.Execute(&e); err != nil {
return nil, errors.ErrTransformInputParse.Wrap(err)
}
}
data, _ := e.MarshalJSON()
res.TransformerResult = data
return res, nil
}

// getByEventID why added this? can it be deleted?
func (cp *ControllerProxy) getByEventID(ctx context.Context,
req *proxypb.GetEventRequest) (*proxypb.GetEventResponse, error) {
Expand Down
132 changes: 132 additions & 0 deletions internal/gateway/proxy/proxy_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import (
stdCtx "context"
"encoding/base64"
"encoding/binary"
stdJson "encoding/json"
"fmt"
"testing"

Expand All @@ -26,9 +27,14 @@ import (
"github.com/linkall-labs/vanus/client"
"github.com/linkall-labs/vanus/client/pkg/api"
"github.com/linkall-labs/vanus/client/pkg/policy"
"github.com/linkall-labs/vanus/internal/convert"
"github.com/linkall-labs/vanus/internal/primitive"
"github.com/linkall-labs/vanus/internal/primitive/vanus"
ctrlpb "github.com/linkall-labs/vanus/proto/pkg/controller"
metapb "github.com/linkall-labs/vanus/proto/pkg/meta"
proxypb "github.com/linkall-labs/vanus/proto/pkg/proxy"
. "github.com/smartystreets/goconvey/convey"
"github.com/tidwall/gjson"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/protobuf/types/known/emptypb"
Expand Down Expand Up @@ -250,3 +256,129 @@ func TestControllerProxy_LookLookupOffset(t *testing.T) {

})
}

func TestControllerProxy_ValidateSubscription(t *testing.T) {
Convey("test ValidateSubscription", t, func() {
cp := NewControllerProxy(Config{
Endpoints: []string{"127.0.0.1:20001",
"127.0.0.1:20002", "127.0.0.1:20003"},
CloudEventReceiverPort: 18080,
ProxyPort: 18082,
Credentials: insecure.NewCredentials(),
})

data := `{
"id":"13b719a4-ada9-436a-9fb1-fc2bc82dc647",
"source":"prometheus",
"specversion":"1.0",
"type":"naive-http-request",
"datacontenttype":"application/json",
"subject":"operator",
"time":"2022-12-12T08:31:54.936803649Z",
"data":{"body":{"alerts":[{"annotations":{"feishuUrls":[{"URL":"https://open.feishu.cn/open-apis/bot/v2/hook/xxxxx",
"signature":"yyyy"},{"URL":"https://open.feishu.cn/open-apis/bot/v2/hook/yyyyy","signature":""},
{"URL":"https://open.feishu.cn/open-apis/bot/v2/hook/zzzzz","signature":"zzzz"}]},
"labels":{"forward":"test-server","severity":"P1"},"startsAt":"2022-12-12T07:55:24.893471163Z","status":"resolved"}],
"commonLabels":{"cluster":"test","forward":"test-server","groups":"test-bot","severity":"P1"}},
"headers":{"Content-Type":"application/json","Host":"webhook-source.vanus:80","User-Agent":"Alertmanager/0.24.0"},
"method":"POST","query_args":{"source":"prometheus","subject":"operator"}}
}`
e := v2.NewEvent()
_ = e.UnmarshalJSON([]byte(data))

trans := `{"pipeline":[{"command":["create","$.xvfeishuservice","bot"]},{"command":["create",
"$.xvfeishumsgtype","interactive"]},{"command":["join","$.xvfeishuboturls",",",
"$.data.body.alerts[0].annotations.feishuUrls[:].URL"]},{"command":["join",
"$.xvfeishubotsigns",",","$.data.body.alerts[0].annotations.feishuUrls[:].signature"]}]}`
var _transformer *primitive.Transformer
_ = stdJson.Unmarshal([]byte(trans), &_transformer)
transPb := convert.ToPbTransformer(_transformer)
s := &ctrlpb.SubscriptionRequest{
Filters: []*metapb.Filter{
{
Exact: map[string]string{
"source": "test",
},
},
},
Transformer: transPb,
}
Convey("test with event and subscription", func() {
ctx := stdCtx.Background()
res, err := cp.ValidateSubscription(ctx, &proxypb.ValidateSubscriptionRequest{
Event: []byte(data),
Subscription: s,
})
So(err, ShouldBeNil)
So(res.FilterResult, ShouldBeFalse)

s.Filters = []*metapb.Filter{
{
Exact: map[string]string{
"source": "prometheus",
},
},
}
res, err = cp.ValidateSubscription(ctx, &proxypb.ValidateSubscriptionRequest{
Event: []byte(data),
Subscription: s,
})
So(err, ShouldBeNil)
So(res.FilterResult, ShouldBeTrue)
result := gjson.ParseBytes(res.TransformerResult)
urls := "https://open.feishu.cn/open-apis/bot/v2/hook/xxxxx,https://open" +
".feishu.cn/open-apis/bot/v2/hook/yyyyy,https://open.feishu.cn/open-apis/bot/v2/hook/zzzzz"
So(result.Get("xvfeishumsgtype").String(), ShouldEqual, "interactive")
So(result.Get("xvfeishuboturls").String(), ShouldEqual, urls)
So(result.Get("xvfeishubotsigns").String(), ShouldEqual, "yyyy,,zzzz")
So(result.Get("xvfeishuservice").String(), ShouldEqual, "bot")
})

ctrl := gomock.NewController(t)
cli := client.NewMockClient(ctrl)
cp.client = cli
eb := api.NewMockEventbus(ctrl)
mockTriggerCtrl := ctrlpb.NewMockTriggerControllerClient(ctrl)
cp.triggerCtrl = mockTriggerCtrl
Convey("test with eventlog, offset and subscriptionID", func() {
ctx := stdCtx.Background()

// mock eventbus
cli.EXPECT().Eventbus(gomock.Any(), gomock.Any()).Times(2).Return(eb)
eb.EXPECT().ListLog(gomock.Any()).Times(1).Return([]api.Eventlog{nil}, nil)
rd := api.NewMockBusReader(ctrl)
eb.EXPECT().Reader(gomock.Any(), gomock.Any(), gomock.Any()).Times(1).Return(rd)
rd.EXPECT().Read(gomock.Any()).Times(1).Return([]*v2.Event{&e}, int64(0), uint64(0), nil)

// mock subscription
pb := &metapb.Subscription{
Filters: []*metapb.Filter{
{
Exact: map[string]string{
"source": "prometheus",
},
},
},
Transformer: s.Transformer,
}
mockTriggerCtrl.EXPECT().GetSubscription(ctx, gomock.Any()).Times(1).Return(pb, nil)

res, err := cp.ValidateSubscription(ctx, &proxypb.ValidateSubscriptionRequest{
SubscriptionId: vanus.NewTestID().Uint64(),
Eventbus: "test",
Eventlog: vanus.NewTestID().Uint64(),
Offset: 123,
})

So(err, ShouldBeNil)
So(res.FilterResult, ShouldBeTrue)
result := gjson.ParseBytes(res.TransformerResult)
urls := "https://open.feishu.cn/open-apis/bot/v2/hook/xxxxx,https://open" +
".feishu.cn/open-apis/bot/v2/hook/yyyyy,https://open.feishu.cn/open-apis/bot/v2/hook/zzzzz"
So(result.Get("xvfeishumsgtype").String(), ShouldEqual, "interactive")
So(result.Get("xvfeishuboturls").String(), ShouldEqual, urls)
So(result.Get("xvfeishubotsigns").String(), ShouldEqual, "yyyy,,zzzz")
So(result.Get("xvfeishuservice").String(), ShouldEqual, "bot")
})
})
}
Loading