Skip to content

Commit

Permalink
server: implement UnaryServerInterceptor chaining.
Browse files Browse the repository at this point in the history
Add a WithChainUnaryServerInterceptor server option to allow
using more that one server side interceptor which will then
get chained and invoked in the order given.

Also, change WithUnaryServerInterceptor to implicitly chain
the given interceptors if the option is used more than once
among the server options.

This should allow us to implement opentelemetry instrumentation
as interceptors while allowing users to keep intercepting their
server side calls for other reasons at the same time.

Signed-off-by: Krisztian Litkey <[email protected]>
  • Loading branch information
klihub committed Jul 24, 2023
1 parent fcc223d commit 342716c
Show file tree
Hide file tree
Showing 2 changed files with 99 additions and 3 deletions.
38 changes: 35 additions & 3 deletions config.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@

package ttrpc

import "errors"
import (
"context"
"errors"
)

type serverConfig struct {
handshaker Handshaker
Expand All @@ -42,11 +45,40 @@ func WithServerHandshaker(handshaker Handshaker) ServerOpt {

// WithUnaryServerInterceptor sets the provided interceptor on the server
func WithUnaryServerInterceptor(i UnaryServerInterceptor) ServerOpt {
return func(c *serverConfig) error {
if c.interceptor == nil {
c.interceptor = i
} else {
WithChainUnaryServerInterceptor(i)(c)
}
return nil
}
}

// WithChainUnaryServerInterceptor sets the provided chain of server interceptors
func WithChainUnaryServerInterceptor(interceptors ...UnaryServerInterceptor) ServerOpt {
return func(c *serverConfig) error {
if c.interceptor != nil {
return errors.New("only one interceptor allowed per server")
interceptors = append([]UnaryServerInterceptor{c.interceptor}, interceptors...)
}
c.interceptor = func(
ctx context.Context,
unmarshal Unmarshaler,
info *UnaryServerInfo,
method Method) (interface{}, error) {
return interceptors[0](ctx, unmarshal, info,
chainUnaryServerInterceptors(info, method, interceptors[1:]))
}
c.interceptor = i
return nil
}
}

func chainUnaryServerInterceptors(info *UnaryServerInfo, method Method, interceptors []UnaryServerInterceptor) Method {
if len(interceptors) == 0 {
return method
}
return func(ctx context.Context, unmarshal func(interface{}) error) (interface{}, error) {
return interceptors[0](ctx, unmarshal, info,
chainUnaryServerInterceptors(info, method, interceptors[1:]))
}
}
64 changes: 64 additions & 0 deletions interceptor_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -278,3 +278,67 @@ func TestChainUnaryServerInterceptor(t *testing.T) {
strings.Join(recorded, " "), strings.Join(expected, " "))
}
}

func TestImplicitChainUnaryServerInterceptor(t *testing.T) {
var (
orderIdx = 0
recorded = []string{}
intercept = func(idx int, tag string) UnaryServerInterceptor {
return func(ctx context.Context, unmarshal Unmarshaler, _ *UnaryServerInfo, method Method) (interface{}, error) {
if orderIdx != idx {
t.Fatalf("unexpected interceptor invocation order (%d != %d)", orderIdx, idx)
}
recorded = append(recorded, tag)
orderIdx++
return method(ctx, unmarshal)
}
}

ctx = context.Background()
server = mustServer(t)(NewServer(
WithUnaryServerInterceptor(
intercept(0, "seen it"),
),
WithUnaryServerInterceptor(
intercept(1, "been"),
),
WithUnaryServerInterceptor(
intercept(2, "there"),
),
WithChainUnaryServerInterceptor(
intercept(3, "done"),
intercept(4, "that"),
),
))
expected = []string{
"seen it",
"been",
"there",
"done",
"that",
}
testImpl = &testingServer{}
addr, listener = newTestListener(t)
client, cleanup = newTestClient(t, addr)
)

defer listener.Close()
defer cleanup()

registerTestingService(server, testImpl)

go server.Serve(ctx, listener)
defer server.Shutdown(ctx)

tp := &internal.TestPayload{
Foo: strings.Repeat("a", 16),
}
if err := client.Call(ctx, serviceName, "Test", tp, tp); err != nil {
t.Fatalf("unexpected error: %v", err)
}

if !reflect.DeepEqual(recorded, expected) {
t.Fatalf("unexpected ttrpc chained server unary interceptor order (%s != %s)",
strings.Join(recorded, " "), strings.Join(expected, " "))
}
}

0 comments on commit 342716c

Please sign in to comment.