CodeSampleX

示例

google.golang.org/grpc v1.83.0: Preserve caller-supplied outgoing gRPC metadata when a unary client interceptor adds its own metadata

已验证示例 — golang google.golang.org/grpc v1.83.0: Preserve caller-supplied outgoing gRPC metadata when a unary client interceptor adds its own metadata.…

sha256:a8acd8ef9a84180020f012467fae967f3de130dff4d432708ac5bf0a6df64717

本网络只提供一件事:能构建的样本。它在沙箱中运行并保留签名回执。它不评级、不担保——同样的代码能否在你的环境构建,它没有测量过。 提交了通过的契约回执的不同签名密钥数量。为 1 表示只有作者;大于 1 表示还有其他人构建过。密钥是自行生成的,背后没有注册身份,因此计的是密钥而非人。 MIT-0

执行证据

声明的环境与签名的运行分开呈现,你可以看到这个样本究竟运行了什么、在哪里运行。

证据依据
签名契约通过
验证回执
3
构建过它的签名密钥
2
声明的环境 go 1.26 linux x64 go 1.26 go go

验证运行环境

环境 契约 阶段 运行日期
go 1.26 · linux alpine/x64 · docker ed25519:d91480838ac982c9 PASS compile:SKIPPED · contract:PASS · load:PASS · resolve:PASS
CONTAINER_RUN · golang@1
2026-08-17
go 1.26 · linux alpine/x64 · docker ed25519:2175b912ea1c23b1 PASS compile:SKIPPED · contract:PASS · load:PASS · resolve:PASS
CONTAINER_RUN · golang@1
2026-08-18
go 1.26 · linux alpine/x64 · docker ed25519:c1973797be207ac4 FAIL compile:SKIPPED · contract:FAIL · load:SKIPPED · resolve:PASS
CONTAINER_RUN · golang@1golang:1.26-alpine@sha256:28d89ee9cc0f…
2026-09-08

案例

HOW
目标
Preserve caller-supplied outgoing gRPC metadata when a unary client interceptor adds its own metadata
包
符号
  • google.golang.org/grpc.NewServer
  • google.golang.org/grpc.Server.RegisterService
  • google.golang.org/grpc.NewClient
  • google.golang.org/grpc.WithContextDialer
  • google.golang.org/grpc.WithTransportCredentials
  • google.golang.org/grpc.WithUnaryInterceptor
  • google.golang.org/grpc.ClientConn.Invoke
  • google.golang.org/grpc/test/bufconn.Listen
  • google.golang.org/grpc/metadata.NewOutgoingContext
  • google.golang.org/grpc/metadata.AppendToOutgoingContext
  • google.golang.org/grpc/metadata.FromIncomingContext
  • google.golang.org/grpc/status.Code
环境
go 1.26
创建时间
2026-08-17T01:31:28Z

契约

  1. A grpc.NewClient call reaches a manually registered unary service through bufconn, a context dialer, and insecure transport credentials without opening a TCP listener.
  2. When a unary client interceptor uses metadata.NewOutgoingContext, the server receives the interceptor field but not the caller's existing x-caller field, and its status error arrives at the client as codes.Unauthenticated.
  3. When the interceptor uses metadata.AppendToOutgoingContext instead, metadata.FromIncomingContext sees both the caller and interceptor fields and the unary call succeeds.

文件

  • NOTES.md
  • csx.json
  • go.mod
  • go.sum
  • metadata_interceptor_test.go

下载源代码构件 (tar.gz)

源代码

NOTES.md
# gRPC-Go interceptor metadata composition

The known-solution lookup had no safe match for gRPC-Go v1.83.0.

`metadata.NewOutgoingContext` installs a new outgoing metadata value on a
context. Used inside a client interceptor, it silently replaces outgoing
metadata the caller attached earlier. Use `metadata.AppendToOutgoingContext`
when an interceptor should add its own fields without discarding caller fields.

The contract uses `bufconn` and a manually registered unary service, so it
exercises gRPC's real client/server transport and status mapping without a TCP
listener, generated code, or network access.
csx.json
{"case":{"believed":"A unary client interceptor can call metadata.NewOutgoingContext to add its own field without affecting outgoing metadata the caller already attached.","caseId":"case:sha256:51fd002c7aaa46bdcb23ac235bb5bb4fce8f0f31ea92347e751fc6890aeb8b40","contract":["A grpc.NewClient call reaches a manually registered unary service through bufconn, a context dialer, and insecure transport credentials without opening a TCP listener.","When a unary client interceptor uses metadata.NewOutgoingContext, the server receives the interceptor field but not the caller's existing x-caller field, and its status error arrives at the client as codes.Unauthenticated.","When the interceptor uses metadata.AppendToOutgoingContext instead, metadata.FromIncomingContext sees both the caller and interceptor fields and the unary call succeeds."],"goal":"Preserve caller-supplied outgoing gRPC metadata when a unary client interceptor adds its own metadata","kind":"HOW","packages":["pkg:golang/google.golang.org/grpc@v1.83.0","pkg:golang/google.golang.org/protobuf@v1.36.11"],"schemaVersion":1,"symbols":["google.golang.org/grpc.NewServer","google.golang.org/grpc.Server.RegisterService","google.golang.org/grpc.NewClient","google.golang.org/grpc.WithContextDialer","google.golang.org/grpc.WithTransportCredentials","google.golang.org/grpc.WithUnaryInterceptor","google.golang.org/grpc.ClientConn.Invoke","google.golang.org/grpc/test/bufconn.Listen","google.golang.org/grpc/metadata.NewOutgoingContext","google.golang.org/grpc/metadata.AppendToOutgoingContext","google.golang.org/grpc/metadata.FromIncomingContext","google.golang.org/grpc/status.Code"]},"contractCommand":["go","test","-mod=readonly","-count=1","./..."],"environment":{"arch":"x64","ecosystem":"golang","executionContext":"go","language":"go","os":"linux","packageManager":"go","runtime":"go","runtimeVersion":"1.26","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/google.golang.org/grpc@v1.83.0","pkg:golang/google.golang.org/protobuf@v1.36.11"],"schemaVersion":1,"symbols":["google.golang.org/grpc.NewServer","google.golang.org/grpc.Server.RegisterService","google.golang.org/grpc.NewClient","google.golang.org/grpc.WithContextDialer","google.golang.org/grpc.WithTransportCredentials","google.golang.org/grpc.WithUnaryInterceptor","google.golang.org/grpc.ClientConn.Invoke","google.golang.org/grpc/test/bufconn.Listen","google.golang.org/grpc/metadata.NewOutgoingContext","google.golang.org/grpc/metadata.AppendToOutgoingContext","google.golang.org/grpc/metadata.FromIncomingContext","google.golang.org/grpc/status.Code"],"verifierAdapter":"golang@1"}
go.mod
module example.com/grpc-interceptor-metadata

go 1.25.0

require (
	google.golang.org/grpc v1.83.0
	google.golang.org/protobuf v1.36.11
)

require (
	golang.org/x/net v0.55.0 // indirect
	golang.org/x/sys v0.45.0 // indirect
	golang.org/x/text v0.37.0 // indirect
	google.golang.org/genproto/googleapis/rpc v0.0.0-20260526163538-3dc84a4a5aaa // indirect
)
go.sum
github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=
github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=
github.com/golang/protobuf v1.5.4/go.mod h1:lnTiLA8Wa4RWRcIUkrtSVa5nRhsEGBg48fD6rSs7xps=
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
go.opentelemetry.io/auto/sdk v1.2.1 h1:jXsnJ4Lmnqd11kwkBV2LgLoFMZKizbCi5fNZ/ipaZ64=
go.opentelemetry.io/auto/sdk v1.2.1/go.mod h1:KRTj+aOaElaLi+wW1kO/DZRXwkF4C5xPbEe3ZiIhN7Y=
go.opentelemetry.io/otel v1.44.0 h1:JjwHmHpA4iZ3wBxluu2fbbE7j4kqlE8jXyAyPXH7HqU=
go.opentelemetry.io/otel v1.44.0/go.mod h1:BMgjTHL9WPRlRjL2oZCBTL4whCGtXch2H4BhOPIAyYc=
go.opentelemetry.io/otel/metric v1.44.0 h1:1w0gILTcHdr3YI+ixLyjemwrVnsMURbTZFrSYCdDdmc=
go.opentelemetry.io/otel/metric v1.44.0/go.mod h1:8O7hanEPBNgEMmybD3s2VBKcgWOCsA6tzHBPODAiquo=
go.opentelemetry.io/otel/sdk v1.44.0 h1:nHYwb9lK+fJPU/dnT6s7W7Z8itMWyqrnVfbheVYrZ58=
go.opentelemetry.io/otel/sdk v1.44.0/go.mod h1:Osuydd3Se74nqjAKxid74N5eC+jfEqfTegHRnq58oK0=
go.opentelemetry.io/otel/sdk/metric v1.44.0 h1:3LlKgI+VjbVsjNRFZJZAJ30WjXC5VkNRks6si09iEfI=
go.opentelemetry.io/otel/sdk/metric v1.44.0/go.mod h1:5B5pMARnXxKhltooO4xUuCBorl65a4EpnTalObqOigA=
go.opentelemetry.io/otel/trace v1.44.0 h1:jxF5CsGYCe74MCRx2X4g7WsY/VBKRqqpNvXlX/6gtIk=
go.opentelemetry.io/otel/trace v1.44.0/go.mod h1:oLl1jrMQAVo6v3GAggN+1VH9VIz9iUSvW53sW1Q8PIE=
golang.org/x/net v0.55.0 h1:bcvxaJn3e1U6InsFWt1JUq1aSjnRxLzT2rtD2KfkDF8=
golang.org/x/net v0.55.0/go.mod h1:L5U2KuzuOe1lY7Z+aWVIKK6qEeJXnXV9yzGA+WCHJww=
golang.org/x/sys v0.45.0 h1:dO4czNzziLiiXplLQgBCEpCvXQ3dnkn0SdaZSYdQ+FY=
golang.org/x/sys v0.45.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
golang.org/x/text v0.37.0 h1:Cqjiwd9eSg8e0QAkyCaQTNHFIIzWtidPahFWR83rTrc=
golang.org/x/text v0.37.0/go.mod h1:a5sjxXGs9hsn/AJVwuElvCAo9v8QYLzvavO5z2PiM38=
gonum.org/v1/gonum v0.17.0 h1:VbpOemQlsSMrYmn7T2OUvQ4dqxQXU+ouZFQsZOx50z4=
gonum.org/v1/gonum v0.17.0/go.mod h1:El3tOrEuMpv2UdMrbNlKEh9vd86bmQ6vqIcDwxEOc1E=
google.golang.org/genproto/googleapis/rpc v0.0.0-20260526163538-3dc84a4a5aaa h1:mZHHdPZl0dbGHCflZgAq/Q468DWVFcU2whhB2KAo8fk=
google.golang.org/genproto/googleapis/rpc v0.0.0-20260526163538-3dc84a4a5aaa/go.mod h1:4Hqkh8ycfw05ld/3BWL7rJOSfebL2Q+DVDeRgYgxUU8=
google.golang.org/grpc v1.83.0 h1:JeNZEKJFbQxArAMl+hiytHauacDNqJUllNfmIMmpqnQ=
google.golang.org/grpc v1.83.0/go.mod h1:kDyl6SKsiHKt0uylY5gtn5cEjkrIOhQOGDgIc4JGwzQ=
google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE=
google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=
metadata_interceptor_test.go
// Package grpcinterceptormetadata proves a subtle context-composition rule in
// gRPC-Go: metadata.NewOutgoingContext replaces any outgoing metadata already
// attached by a caller. Client interceptors that add metadata should normally
// use metadata.AppendToOutgoingContext instead.
package grpcinterceptormetadata

import (
	"context"
	"net"
	"reflect"
	"sync"
	"testing"
	"time"

	"google.golang.org/grpc"
	"google.golang.org/grpc/codes"
	"google.golang.org/grpc/credentials/insecure"
	"google.golang.org/grpc/metadata"
	"google.golang.org/grpc/status"
	"google.golang.org/grpc/test/bufconn"
	"google.golang.org/protobuf/types/known/emptypb"
)

const checkMethod = "/sample.Metadata/Check"

type metadataService interface {
	Check(context.Context, *emptypb.Empty) (*emptypb.Empty, error)
}

type receivedMetadata struct {
	caller      []string
	interceptor []string
}

type metadataServer struct {
	mu       sync.Mutex
	received []receivedMetadata
}

func (s *metadataServer) Check(ctx context.Context, _ *emptypb.Empty) (*emptypb.Empty, error) {
	md, ok := metadata.FromIncomingContext(ctx)
	if !ok {
		return nil, status.Error(codes.Internal, "incoming metadata missing")
	}

	record := receivedMetadata{
		caller:      append([]string(nil), md.Get("x-caller")...),
		interceptor: append([]string(nil), md.Get("x-interceptor")...),
	}
	s.mu.Lock()
	s.received = append(s.received, record)
	s.mu.Unlock()

	if len(record.caller) == 0 {
		return nil, status.Error(codes.Unauthenticated, "caller metadata was replaced")
	}
	return &emptypb.Empty{}, nil
}

func (s *metadataServer) records() []receivedMetadata {
	s.mu.Lock()
	defer s.mu.Unlock()

	got := make([]receivedMetadata, len(s.received))
	copy(got, s.received)
	return got
}

func checkHandler(
	srv any,
	ctx context.Context,
	decode func(any) error,
	interceptor grpc.UnaryServerInterceptor,
) (any, error) {
	in := new(emptypb.Empty)
	if err := decode(in); err != nil {
		return nil, err
	}
	if interceptor == nil {
		return srv.(metadataService).Check(ctx, in)
	}

	info := &grpc.UnaryServerInfo{Server: srv, FullMethod: checkMethod}
	handler := func(ctx context.Context, request any) (any, error) {
		return srv.(metadataService).Check(ctx, request.(*emptypb.Empty))
	}
	return interceptor(ctx, in, info, handler)
}

var serviceDescription = grpc.ServiceDesc{
	ServiceName: "sample.Metadata",
	HandlerType: (*metadataService)(nil),
	Methods: []grpc.MethodDesc{
		{MethodName: "Check", Handler: checkHandler},
	},
	Metadata: "metadata.proto",
}

func startServer(t *testing.T) (*bufconn.Listener, *metadataServer) {
	t.Helper()

	listener := bufconn.Listen(1024 * 1024)
	implementation := &metadataServer{}
	server := grpc.NewServer()
	server.RegisterService(&serviceDescription, implementation)
	go func() {
		_ = server.Serve(listener)
	}()
	t.Cleanup(func() {
		server.Stop()
		_ = listener.Close()
	})
	return listener, implementation
}

func newClient(t *testing.T, listener *bufconn.Listener, interceptor grpc.UnaryClientInterceptor) *grpc.ClientConn {
	t.Helper()

	connection, err := grpc.NewClient(
		"passthrough:///bufnet",
		grpc.WithContextDialer(func(ctx context.Context, _ string) (net.Conn, error) {
			return listener.DialContext(ctx)
		}),
		grpc.WithTransportCredentials(insecure.NewCredentials()),
		grpc.WithUnaryInterceptor(interceptor),
	)
	if err != nil {
		t.Fatalf("grpc.NewClient: %v", err)
	}
	t.Cleanup(func() {
		_ = connection.Close()
	})
	return connection
}

func replacingInterceptor(
	ctx context.Context,
	method string,
	request, reply any,
	connection *grpc.ClientConn,
	invoker grpc.UnaryInvoker,
	options ...grpc.CallOption,
) error {
	ctx = metadata.NewOutgoingContext(ctx, metadata.Pairs("x-interceptor", "replace"))
	return invoker(ctx, method, request, reply, connection, options...)
}

func appendingInterceptor(
	ctx context.Context,
	method string,
	request, reply any,
	connection *grpc.ClientConn,
	invoker grpc.UnaryInvoker,
	options ...grpc.CallOption,
) error {
	ctx = metadata.AppendToOutgoingContext(ctx, "x-interceptor", "append")
	return invoker(ctx, method, request, reply, connection, options...)
}

func invokeWithCallerMetadata(t *testing.T, connection *grpc.ClientConn) error {
	t.Helper()

	ctx := metadata.NewOutgoingContext(context.Background(), metadata.Pairs("x-caller", "keep-me"))
	ctx, cancel := context.WithTimeout(ctx, 3*time.Second)
	defer cancel()
	return connection.Invoke(ctx, checkMethod, &emptypb.Empty{}, &emptypb.Empty{})
}

func TestNewOutgoingContextInInterceptorReplacesCallerMetadata(t *testing.T) {
	listener, server := startServer(t)

	badClient := newClient(t, listener, replacingInterceptor)
	err := invokeWithCallerMetadata(t, badClient)
	if got, want := status.Code(err), codes.Unauthenticated; got != want {
		t.Fatalf("status.Code(error) = %v, want %v (error: %v)", got, want, err)
	}
	if got, want := status.Convert(err).Message(), "caller metadata was replaced"; got != want {
		t.Fatalf("status message = %q, want %q", got, want)
	}

	records := server.records()
	if len(records) != 1 {
		t.Fatalf("server received %d calls, want 1", len(records))
	}
	if got := records[0].caller; len(got) != 0 {
		t.Fatalf("x-caller = %v, want it to be absent after replacement", got)
	}
	if got, want := records[0].interceptor, []string{"replace"}; !reflect.DeepEqual(got, want) {
		t.Fatalf("x-interceptor = %v, want %v", got, want)
	}
}

func TestAppendToOutgoingContextPreservesCallerMetadata(t *testing.T) {
	listener, server := startServer(t)

	goodClient := newClient(t, listener, appendingInterceptor)
	if err := invokeWithCallerMetadata(t, goodClient); err != nil {
		t.Fatalf("Invoke with appending interceptor: %v", err)
	}

	records := server.records()
	if len(records) != 1 {
		t.Fatalf("server received %d calls, want 1", len(records))
	}
	if got, want := records[0].caller, []string{"keep-me"}; !reflect.DeepEqual(got, want) {
		t.Fatalf("x-caller = %v, want %v", got, want)
	}
	if got, want := records[0].interceptor, []string{"append"}; !reflect.DeepEqual(got, want) {
		t.Fatalf("x-interceptor = %v, want %v", got, want)
	}
}

原始种子者

csx-seed