sync upstream

Author: yandex-cloud-bot

pkg/idempotency/interceptor.go

@@ -0,0 +1,40 @@
+package idempotency
+
+import (
+	"context"
+
+	"github.com/google/uuid"
+	"google.golang.org/grpc"
+	"google.golang.org/grpc/metadata"
+)
+
+// Interceptor add idempotency key to context.
+func Interceptor() grpc.UnaryClientInterceptor {
+	return func(
+		ctx context.Context,
+		method string,
+		req, reply any,
+		cc *grpc.ClientConn,
+		invoker grpc.UnaryInvoker,
+		opts ...grpc.CallOption,
+	) error {
+		ctx = addIdempotencyToken(ctx)
+		return invoker(ctx, method, req, reply, cc, opts...)
+	}
+}
+
+func addIdempotencyToken(ctx context.Context) context.Context {
+	const idempotencyTokenMetadataKey = "idempotency-key"
+
+	idempotencyTokenPresent := false
+	md, ok := metadata.FromOutgoingContext(ctx)
+	if ok {
+		_, idempotencyTokenPresent = md[idempotencyTokenMetadataKey]
+	}
+
+	if !idempotencyTokenPresent {
+		ctx = metadata.AppendToOutgoingContext(ctx, idempotencyTokenMetadataKey, uuid.New().String())
+	}
+
+	return ctx
+}

pkg/idempotency/interceptor_test.go

@@ -0,0 +1,41 @@
+package idempotency
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"google.golang.org/grpc/metadata"
+)
+
+const idempotencyKey = "idempotency-key"
+
+func TestAddIdempotencyKey(t *testing.T) {
+	t.Run("have no idempotency key before", func(t *testing.T) {
+		ctx := context.Background()
+		actualContext := addIdempotencyToken(ctx)
+		actualMetadata, ok := metadata.FromOutgoingContext(actualContext)
+		require.True(t, ok)
+		require.NotNil(t, actualMetadata.Get(idempotencyKey))
+
+		_, ok = metadata.FromOutgoingContext(ctx)
+		require.False(t, ok)
+	})
+
+	t.Run("have idempotency key before", func(t *testing.T) {
+		expectedCtx := context.Background()
+		expectedCtx = metadata.AppendToOutgoingContext(expectedCtx, idempotencyKey, "somevalue")
+		actualContext := addIdempotencyToken(expectedCtx)
+
+		expectedMetadata, ok := metadata.FromOutgoingContext(expectedCtx)
+		require.True(t, ok)
+
+		actualMetadata, ok := metadata.FromOutgoingContext(actualContext)
+		require.True(t, ok)
+		require.EqualValues(
+			t,
+			expectedMetadata.Get(idempotencyKey),
+			actualMetadata.Get(idempotencyKey),
+		)
+	})
+}

pkg/retry/interceptor.go

@@ -16,7 +16,7 @@ import (
 // Without any option, it uses default options, that basically retries nothing.
 // Default retry quantity is 0, backoff function is nil, retry codes are DefaultRetriableCodes, AttemptHeader is false, and perCallTimeout is 0.
 //
-// Deprecated: RetryDialOption function to provide standard gRPC retries.
+// Deprecated: RetryDialOption function to provide standard gRPC retries. For idempotency keys use idempotency.Interceptor
 func Interceptor(callOpts ...grpc.CallOption) grpc.UnaryClientInterceptor {
 	i := unaryInterceptor{opts: *defaultOptions.applyOptions(callOpts)}
 	return i.InterceptUnary

pkg/retry/interceptor_test.go

@@ -16,7 +16,6 @@ import (
 	"google.golang.org/grpc/status"
 	"google.golang.org/protobuf/proto"
 
-	grpc_insight "bb.yandex-team.ru/cloud/cloud-go/api/pkg/grpc/middleware/insight"
 	"github.com/yandex-cloud/go-genproto/yandex/cloud/compute/v1"
 	"github.com/yandex-cloud/go-sdk/pkg/testutil"
 )
@@ -97,12 +96,7 @@ func initTestService(t *testing.T, handler ZoneServerHandler, interceptor grpc.D
 		testutil.Message("Test server failed to start."),
 	)
 
-	so.c, err = grpc_insight.CreateGRPCClient(so.l.Addr().String(),
-		grpc_insight.WithDialOptions(
-			grpc.WithTransportCredentials(insecure.NewCredentials()),
-			interceptor,
-		),
-	)
+	so.c, err = grpc.Dial(so.l.Addr().String(), grpc.WithTransportCredentials(insecure.NewCredentials()), interceptor)
 	require.NoError(t, err)
 	res = compute.NewZoneServiceClient(so.c)
 	return

pkg/retry/options.go

@@ -7,7 +7,7 @@ import (
 	"google.golang.org/grpc/codes"
 )
 
-// WithDefaultInterceptor returns interceptor that DOESN'T retry anything.
+// WithDefaultInterceptor returns interceptor that DOESN'T retrу anything.
 // Its possible to change its behaviour with call options.
 //
 // Deprecated: use retry/v1 package instead of this options