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

Add client and server unary interceptors #41

Merged
merged 3 commits into from Jun 12, 2019
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
37 changes: 24 additions & 13 deletions client.go
Expand Up @@ -42,11 +42,12 @@ type Client struct {
channel *channel
calls chan *callRequest

closed chan struct{}
closeOnce sync.Once
closeFunc func()
done chan struct{}
err error
closed chan struct{}
closeOnce sync.Once
closeFunc func()
done chan struct{}
err error
interceptor UnaryClientInterceptor
}

type ClientOpts func(c *Client)
Expand All @@ -57,15 +58,22 @@ func WithOnClose(onClose func()) ClientOpts {
}
}

func WithUnaryClientInterceptor(i UnaryClientInterceptor) ClientOpts {
return func(c *Client) {
c.interceptor = i
}
}

func NewClient(conn net.Conn, opts ...ClientOpts) *Client {
c := &Client{
codec: codec{},
conn: conn,
channel: newChannel(conn),
calls: make(chan *callRequest),
closed: make(chan struct{}),
done: make(chan struct{}),
closeFunc: func() {},
codec: codec{},
conn: conn,
channel: newChannel(conn),
calls: make(chan *callRequest),
closed: make(chan struct{}),
done: make(chan struct{}),
closeFunc: func() {},
interceptor: defaultClientInterceptor,
}

for _, o := range opts {
Expand Down Expand Up @@ -107,7 +115,10 @@ func (c *Client) Call(ctx context.Context, service, method string, req, resp int
creq.TimeoutNano = dl.Sub(time.Now()).Nanoseconds()
}

if err := c.dispatch(ctx, creq, cresp); err != nil {
info := &UnaryClientInfo{
FullMethod: fullPath(service, method),
}
if err := c.interceptor(ctx, creq, cresp, info, c.dispatch); err != nil {
return err
}

Expand Down
13 changes: 12 additions & 1 deletion config.go
Expand Up @@ -19,7 +19,8 @@ package ttrpc
import "github.com/pkg/errors"

type serverConfig struct {
handshaker Handshaker
handshaker Handshaker
interceptor UnaryServerInterceptor
}

type ServerOpt func(*serverConfig) error
Expand All @@ -37,3 +38,13 @@ func WithServerHandshaker(handshaker Handshaker) ServerOpt {
return nil
}
}

func WithUnaryServerInterceptor(i UnaryServerInterceptor) ServerOpt {
return func(c *serverConfig) error {
if c.interceptor != nil {
return errors.New("only one interceptor allowed per server")
}
c.interceptor = i
return nil
}
}
135 changes: 135 additions & 0 deletions example/cmd/main.go
@@ -0,0 +1,135 @@
/*
Copyright The containerd Authors.

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 main

import (
context "context"
"encoding/json"
"errors"
"log"
"net"
"os"

ttrpc "github.com/containerd/ttrpc"
"github.com/containerd/ttrpc/example"
"github.com/gogo/protobuf/types"
)

const socket = "example-ttrpc-server"

func main() {
if err := handle(); err != nil {
log.Fatal(err)
}
}

func handle() error {
command := os.Args[1]
switch command {
case "server":
return server()
case "client":
return client()
default:
return errors.New("invalid command")
}
}

func serverIntercept(ctx context.Context, um ttrpc.Unmarshaler, i *ttrpc.UnaryServerInfo, m ttrpc.Method) (interface{}, error) {
log.Println("server interceptor")
dumpMetadata(ctx)
return m(ctx, um)
}

func clientIntercept(ctx context.Context, req *ttrpc.Request, resp *ttrpc.Response, i *ttrpc.UnaryClientInfo, invoker ttrpc.Invoker) error {
log.Println("client interceptor")
dumpMetadata(ctx)
return invoker(ctx, req, resp)
}

func dumpMetadata(ctx context.Context) {
md, ok := ttrpc.GetMetadata(ctx)
if !ok {
panic("no metadata")
}
if err := json.NewEncoder(os.Stdout).Encode(md); err != nil {
panic(err)
}
}

func server() error {
s, err := ttrpc.NewServer(
ttrpc.WithServerHandshaker(ttrpc.UnixSocketRequireSameUser()),
ttrpc.WithUnaryServerInterceptor(serverIntercept),
)
if err != nil {
return err
}
defer s.Close()
example.RegisterExampleService(s, &exampleServer{})

l, err := net.Listen("unix", socket)
if err != nil {
return err
}
defer func() {
l.Close()
os.Remove(socket)
}()
return s.Serve(context.Background(), l)
}

func client() error {
conn, err := net.Dial("unix", socket)
if err != nil {
return err
}
defer conn.Close()

tc := ttrpc.NewClient(conn, ttrpc.WithUnaryClientInterceptor(clientIntercept))
client := example.NewExampleClient(tc)

r := &example.Method1Request{
Foo: os.Args[2],
Bar: os.Args[3],
}

ctx := context.Background()
md := ttrpc.Metadata{}
md.Set("name", "koye")
ctx = ttrpc.WithMetadata(ctx, md)

resp, err := client.Method1(ctx, r)
if err != nil {
return err
}
return json.NewEncoder(os.Stdout).Encode(resp)
}

type exampleServer struct {
}

func (s *exampleServer) Method1(ctx context.Context, r *example.Method1Request) (*example.Method1Response, error) {
return &example.Method1Response{
Foo: r.Foo,
Bar: r.Bar,
}, nil
}

func (s *exampleServer) Method2(ctx context.Context, r *example.Method1Request) (*types.Empty, error) {
return &types.Empty{}, nil
}
43 changes: 43 additions & 0 deletions interceptor.go
@@ -0,0 +1,43 @@
/*
Copyright The containerd Authors.

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 ttrpc

import "context"

type UnaryServerInfo struct {
FullMethod string
}

type UnaryClientInfo struct {
FullMethod string
}

type Unmarshaler func(interface{}) error

type Invoker func(context.Context, *Request, *Response) error

type UnaryServerInterceptor func(context.Context, Unmarshaler, *UnaryServerInfo, Method) (interface{}, error)

type UnaryClientInterceptor func(context.Context, *Request, *Response, *UnaryClientInfo, Invoker) error

func defaultServerInterceptor(ctx context.Context, unmarshal Unmarshaler, info *UnaryServerInfo, method Method) (interface{}, error) {
return method(ctx, unmarshal)
}

func defaultClientInterceptor(ctx context.Context, req *Request, resp *Response, _ *UnaryClientInfo, invoker Invoker) error {
return invoker(ctx, req, resp)
}
5 changes: 4 additions & 1 deletion server.go
Expand Up @@ -53,10 +53,13 @@ func NewServer(opts ...ServerOpt) (*Server, error) {
return nil, err
}
}
if config.interceptor == nil {
config.interceptor = defaultServerInterceptor
}

return &Server{
config: config,
services: newServiceSet(),
services: newServiceSet(config.interceptor),
done: make(chan struct{}),
listeners: make(map[net.Listener]struct{}),
connections: make(map[*serverConn]struct{}),
Expand Down
14 changes: 10 additions & 4 deletions services.go
Expand Up @@ -37,12 +37,14 @@ type ServiceDesc struct {
}

type serviceSet struct {
services map[string]ServiceDesc
services map[string]ServiceDesc
interceptor UnaryServerInterceptor
}

func newServiceSet() *serviceSet {
func newServiceSet(interceptor UnaryServerInterceptor) *serviceSet {
return &serviceSet{
services: make(map[string]ServiceDesc),
services: make(map[string]ServiceDesc),
interceptor: interceptor,
}
}

Expand Down Expand Up @@ -84,7 +86,11 @@ func (s *serviceSet) dispatch(ctx context.Context, serviceName, methodName strin
return nil
}

resp, err := method(ctx, unmarshal)
info := &UnaryServerInfo{
FullMethod: fullPath(serviceName, methodName),
}

resp, err := s.interceptor(ctx, unmarshal, info, method)
if err != nil {
return nil, err
}
Expand Down