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
examples: add new example to show updating metadata in interceptors #5788
Merged
Merged
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
f94a588
examples: add updating metadata in the interceptor
richzw cbcd56a
examples: fix go vet error
richzw 4a1b599
retrigger checks
richzw 1534296
examples: move update metadata in interceptor to one individual sample
richzw a4e7c89
Merge branch 'grpc:master' into master
richzw 47ee86e
examples: refactor codes of metadata_interceptor per review
richzw 9e03c85
examples: refactor codes of metadata_interceptor per review and updat…
richzw 2107776
Merge branch 'grpc:master' into master
richzw 95fe097
retrigger checks
richzw a3dabd3
Merge branch 'grpc:master' into master
richzw 56d9d52
document: update grpc metadata per review comment
richzw 2b34898
examples: corred import order
richzw fd94734
Merge branch 'grpc:master' into master
richzw 54af026
examples: update document per review comment
richzw 152132f
Merge branch 'grpc:master' into master
richzw 5108a19
examples: add features/metadata_interceptor to examples_test script
richzw File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# Metadata interceptor example | ||
|
||
This example shows how to update metadata from unary and streaming interceptors on the server. | ||
Please see | ||
[grpc-metadata.md](https://github.com/grpc/grpc-go/blob/master/Documentation/grpc-metadata.md) | ||
for more information. | ||
|
||
## Try it | ||
|
||
``` | ||
go run server/main.go | ||
``` | ||
|
||
``` | ||
go run client/main.go | ||
``` | ||
|
||
## Explanation | ||
|
||
#### Unary interceptor | ||
|
||
The interceptor can read existing metadata from the RPC context passed to it. | ||
Since Go contexts are immutable, the interceptor will have to create a new context | ||
with updated metadata and pass it to the provided handler. | ||
|
||
```go | ||
func SomeInterceptor(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error) { | ||
// Get the incoming metadata from the RPC context, and add a new | ||
// key-value pair to it. | ||
md, ok := metadata.FromIncomingContext(ctx) | ||
md.Append("key1", "value1") | ||
|
||
// Create a context with the new metadata and pass it to handler. | ||
ctx = metadata.NewIncomingContext(ctx, md) | ||
return handler(ctx, req) | ||
} | ||
``` | ||
|
||
#### Streaming interceptor | ||
|
||
`grpc.ServerStream` does not provide a way to modify its RPC context. The streaming | ||
interceptor therefore needs to implement the `grpc.ServerStream` interface and return | ||
a context with updated metadata. | ||
|
||
The easiest way to do this would be to create a type which embeds the `grpc.ServerStream` | ||
interface and overrides only the `Context()` method to return a context with updated | ||
metadata. The streaming interceptor would then pass this wrapped stream to the provided handler. | ||
|
||
```go | ||
type wrappedStream struct { | ||
grpc.ServerStream | ||
ctx context.Context | ||
} | ||
|
||
func (s *wrappedStream) Context() context.Context { | ||
return s.ctx | ||
} | ||
|
||
func SomeStreamInterceptor(srv interface{}, ss grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) error { | ||
// Get the incoming metadata from the RPC context, and add a new | ||
// key-value pair to it. | ||
md, ok := metadata.FromIncomingContext(ctx) | ||
md.Append("key1", "value1") | ||
|
||
// Create a context with the new metadata and pass it to handler. | ||
ctx = metadata.NewIncomingContext(ctx, md) | ||
|
||
return handler(srv, &wrappedStream{ss, ctx}) | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
/* | ||
* | ||
* Copyright 2022 gRPC 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. | ||
* | ||
*/ | ||
|
||
// Binary client is an example client. | ||
package main | ||
|
||
import ( | ||
"context" | ||
"flag" | ||
"fmt" | ||
"io" | ||
"log" | ||
"time" | ||
|
||
"google.golang.org/grpc" | ||
"google.golang.org/grpc/credentials/insecure" | ||
|
||
pb "google.golang.org/grpc/examples/features/proto/echo" | ||
) | ||
|
||
var addr = flag.String("addr", "localhost:50051", "the address to connect to") | ||
|
||
func callUnaryEcho(ctx context.Context, client pb.EchoClient) { | ||
resp, err := client.UnaryEcho(ctx, &pb.EchoRequest{Message: "hello world"}) | ||
if err != nil { | ||
log.Fatalf("UnaryEcho %v", err) | ||
} | ||
fmt.Println("UnaryEcho: ", resp.Message) | ||
} | ||
|
||
func callBidiStreamingEcho(ctx context.Context, client pb.EchoClient) { | ||
c, err := client.BidirectionalStreamingEcho(ctx) | ||
if err != nil { | ||
log.Fatalf("BidiStreamingEcho %v", err) | ||
} | ||
|
||
if err := c.Send(&pb.EchoRequest{Message: "hello world"}); err != nil { | ||
log.Fatalf("Sending echo request: %v", err) | ||
} | ||
c.CloseSend() | ||
|
||
for { | ||
resp, err := c.Recv() | ||
if err == io.EOF { | ||
break | ||
} | ||
if err != nil { | ||
log.Fatalf("Receiving echo response: %v", err) | ||
} | ||
fmt.Println("BidiStreaming Echo: ", resp.Message) | ||
} | ||
} | ||
|
||
func main() { | ||
flag.Parse() | ||
|
||
conn, err := grpc.Dial(*addr, grpc.WithTransportCredentials(insecure.NewCredentials())) | ||
if err != nil { | ||
log.Fatalf("grpc.Dial(%q): %v", *addr, err) | ||
} | ||
defer conn.Close() | ||
|
||
ec := pb.NewEchoClient(conn) | ||
|
||
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second) | ||
defer cancel() | ||
|
||
callUnaryEcho(ctx, ec) | ||
|
||
callBidiStreamingEcho(ctx, ec) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,140 @@ | ||
/* | ||
* | ||
* Copyright 2022 gRPC 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. | ||
* | ||
*/ | ||
|
||
// Binary server is an example server. | ||
package main | ||
|
||
import ( | ||
"context" | ||
"flag" | ||
"fmt" | ||
"io" | ||
"log" | ||
"net" | ||
|
||
"google.golang.org/grpc" | ||
"google.golang.org/grpc/codes" | ||
"google.golang.org/grpc/metadata" | ||
"google.golang.org/grpc/status" | ||
|
||
pb "google.golang.org/grpc/examples/features/proto/echo" | ||
) | ||
|
||
var port = flag.Int("port", 50051, "the port to serve on") | ||
|
||
var errMissingMetadata = status.Errorf(codes.InvalidArgument, "no incoming metadata in rpc context") | ||
|
||
type server struct { | ||
pb.UnimplementedEchoServer | ||
} | ||
|
||
func unaryInterceptor(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error) { | ||
md, ok := metadata.FromIncomingContext(ctx) | ||
if !ok { | ||
return nil, errMissingMetadata | ||
} | ||
|
||
md.Append("key1", "value1") | ||
ctx = metadata.NewIncomingContext(ctx, md) | ||
|
||
return handler(ctx, req) | ||
} | ||
|
||
func (s *server) UnaryEcho(ctx context.Context, in *pb.EchoRequest) (*pb.EchoResponse, error) { | ||
fmt.Printf("--- UnaryEcho ---\n") | ||
|
||
md, ok := metadata.FromIncomingContext(ctx) | ||
if !ok { | ||
return nil, status.Errorf(codes.Internal, "UnaryEcho: missing incoming metadata in rpc context") | ||
} | ||
|
||
// Read and print metadata added by the interceptor. | ||
if v, ok := md["key1"]; ok { | ||
fmt.Printf("key1 from metadata: \n") | ||
for i, e := range v { | ||
fmt.Printf(" %d. %s\n", i, e) | ||
} | ||
} | ||
|
||
return &pb.EchoResponse{Message: in.Message}, nil | ||
} | ||
|
||
type wrappedStream struct { | ||
grpc.ServerStream | ||
ctx context.Context | ||
} | ||
|
||
func (s *wrappedStream) Context() context.Context { | ||
return s.ctx | ||
} | ||
|
||
func streamInterceptor(srv interface{}, ss grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) error { | ||
md, ok := metadata.FromIncomingContext(ss.Context()) | ||
if !ok { | ||
return errMissingMetadata | ||
} | ||
|
||
md.Append("key1", "value1") | ||
ctx := metadata.NewIncomingContext(ss.Context(), md) | ||
|
||
return handler(srv, &wrappedStream{ss, ctx}) | ||
} | ||
|
||
func (s *server) BidirectionalStreamingEcho(stream pb.Echo_BidirectionalStreamingEchoServer) error { | ||
fmt.Printf("--- BidirectionalStreamingEcho ---\n") | ||
|
||
md, ok := metadata.FromIncomingContext(stream.Context()) | ||
if !ok { | ||
return status.Errorf(codes.Internal, "BidirectionalStreamingEcho: missing incoming metadata in rpc context") | ||
} | ||
|
||
// Read and print metadata added by the interceptor. | ||
if v, ok := md["key1"]; ok { | ||
fmt.Printf("key1 from metadata: \n") | ||
for i, e := range v { | ||
fmt.Printf(" %d. %s\n", i, e) | ||
} | ||
} | ||
|
||
// Read requests and send responses. | ||
for { | ||
in, err := stream.Recv() | ||
if err == io.EOF { | ||
return nil | ||
} | ||
if err != nil { | ||
return err | ||
} | ||
if err = stream.Send(&pb.EchoResponse{Message: in.Message}); err != nil { | ||
return err | ||
} | ||
} | ||
} | ||
|
||
func main() { | ||
flag.Parse() | ||
lis, err := net.Listen("tcp", fmt.Sprintf(":%d", *port)) | ||
if err != nil { | ||
log.Fatalf("net.Listen() failed: %v", err) | ||
} | ||
fmt.Printf("Server listening at %v\n", lis.Addr()) | ||
|
||
s := grpc.NewServer(grpc.UnaryInterceptor(unaryInterceptor), grpc.StreamInterceptor(streamInterceptor)) | ||
pb.RegisterEchoServer(s, &server{}) | ||
s.Serve(lis) | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems like we need some reordering of the imports here to pass
vet
tests. Tryto see how the file should look like
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@arvindbr8 , thank you very much for your response, I have updated the reordering of the imports through
goimports
.