dev: added sdk version header to any RPC call & fixes linter checks (#308)

Author: KirillKurdyukov

slo/src/TableService/SloTableContext.cs

@@ -14,9 +14,8 @@ public class SloTableContext : SloTableContext<TableClient>
 
     protected override async Task Create(TableClient client, string createTableSql, int operationTimeout)
     {
-        var response = await client.SessionExec(
-            async session => await session.ExecuteSchemeQuery(createTableSql,
-                new ExecuteSchemeQuerySettings { OperationTimeout = TimeSpan.FromSeconds(operationTimeout) }));
+        var response = await client.SessionExec(async session => await session.ExecuteSchemeQuery(createTableSql,
+            new ExecuteSchemeQuerySettings { OperationTimeout = TimeSpan.FromSeconds(operationTimeout) }));
 
         response.Status.EnsureSuccess();
     }
@@ -29,21 +28,20 @@ protected override async Task Create(TableClient client, string createTableSql,
 
         var attempts = 0;
 
-        var response = await tableClient.SessionExec(
-            async session =>
+        var response = await tableClient.SessionExec(async session =>
+        {
+            attempts++;
+            var response = await session.ExecuteDataQuery(upsertSql, _txControl, parameters, querySettings);
+            if (response.Status.IsSuccess)
             {
-                attempts++;
-                var response = await session.ExecuteDataQuery(upsertSql, _txControl, parameters, querySettings);
-                if (response.Status.IsSuccess)
-                {
-                    return response;
-                }
+                return response;
+            }
 
 
-                errorsGauge?.WithLabels(response.Status.StatusCode.ToString(), "retried").Inc();
+            errorsGauge?.WithLabels(response.Status.StatusCode.ToString(), "retried").Inc();
 
-                return response;
-            });
+            return response;
+        });
 
         return (attempts, response.Status.StatusCode);
     }
@@ -56,22 +54,21 @@ protected override async Task Create(TableClient client, string createTableSql,
 
         var attempts = 0;
 
-        var response = (ExecuteDataQueryResponse)await tableClient.SessionExec(
-            async session =>
+        var response = (ExecuteDataQueryResponse)await tableClient.SessionExec(async session =>
+        {
+            attempts++;
+            var response = await session.ExecuteDataQuery(selectSql, _txControl, parameters, querySettings);
+            if (response.Status.IsSuccess)
             {
-                attempts++;
-                var response = await session.ExecuteDataQuery(selectSql, _txControl, parameters, querySettings);
-                if (response.Status.IsSuccess)
-                {
-                    return response;
-                }
+                return response;
+            }
 
-                Logger.LogWarning("{}", response.Status.ToString());
+            Logger.LogWarning("{}", response.Status.ToString());
 
-                errorsGauge?.WithLabels(response.Status.StatusCode.StatusName(), "retried").Inc();
+            errorsGauge?.WithLabels(response.Status.StatusCode.StatusName(), "retried").Inc();
 
-                return response;
-            });
+            return response;
+        });
 
         return (attempts, response.Status.StatusCode,
             response.Status.IsSuccess ? response.Result.ResultSets[0].Rows[0][0].GetOptionalInt32() : null);

src/EFCore.Ydb/test/EntityFrameworkCore.Ydb.FunctionalTests/Migrations/YdbMigrationsSqlGeneratorTest.cs

@@ -150,17 +150,16 @@ public override void InsertDataOperation_required_args_multiple_rows()
     public override void InsertDataOperation_throws_for_unsupported_column_types()
         => Assert.Equal(
             RelationalStrings.UnsupportedDataOperationStoreType("foo", "dbo.People.First Name"),
-            Assert.Throws<InvalidOperationException>(
-                () =>
-                    Generate(
-                        new InsertDataOperation
-                        {
-                            Table = "People",
-                            Schema = "dbo",
-                            Columns = ["First Name"],
-                            ColumnTypes = ["foo"],
-                            Values = new object?[,] { { null } }
-                        })).Message);
+            Assert.Throws<InvalidOperationException>(() =>
+                Generate(
+                    new InsertDataOperation
+                    {
+                        Table = "People",
+                        Schema = "dbo",
+                        Columns = ["First Name"],
+                        ColumnTypes = ["foo"],
+                        Values = new object?[,] { { null } }
+                    })).Message);
 
     public override void DeleteDataOperation_all_args()
     {

src/Ydb.Sdk/CHANGELOG.md

@@ -1,3 +1,5 @@
+- Added `x-ydb-sdk-build-info` header to any RPC call.
+
 ## v0.16.0
 
 - **Breaking Change**: `Ydb.Sdk.Yc.Auth` version <= 0.1.0 is not compatible with newer versions.

src/Ydb.Sdk/src/Driver.cs

@@ -1,5 +1,4 @@
 using System.Collections.Immutable;
-using System.Reflection;
 using Grpc.Core;
 using Grpc.Net.Client;
 using Microsoft.Extensions.Logging;
@@ -16,7 +15,6 @@ public sealed class Driver : BaseDriver
 {
     private const int AttemptDiscovery = 10;
 
-    private readonly string _sdkInfo;
     private readonly GrpcChannelFactory _grpcChannelFactory;
     private readonly EndpointPool _endpointPool;
     private readonly ChannelPool<GrpcChannel> _channelPool;
@@ -35,10 +33,6 @@ public Driver(DriverConfig config, ILoggerFactory? loggerFactory = null)
             _grpcChannelFactory
         );
 
-        var version = Assembly.GetExecutingAssembly().GetName().Version;
-        var versionStr = version is null ? "unknown" : version.ToString(3);
-        _sdkInfo = $"ydb-dotnet-sdk/{versionStr}";
-
         CredentialsProvider = Config.User != null
             ? new CachedCredentialsProvider(
                 new StaticCredentialsAuthClient(config, _grpcChannelFactory, LoggerFactory),
@@ -134,12 +128,10 @@ private async Task<Status> DiscoverEndpoints()
             TransportTimeout = Config.EndpointDiscoveryTimeout
         };
 
-        var options = await GetCallOptions(requestSettings);
-        options.Headers?.Add(Metadata.RpcSdkInfoHeader, _sdkInfo);
-
         var response = await client.ListEndpointsAsync(
             request: request,
-            options: options);
+            options: await GetCallOptions(requestSettings)
+        );
 
         if (!response.Operation.Ready)
         {
@@ -168,7 +160,8 @@ private async Task<Status> DiscoverEndpoints()
 
         Logger.LogDebug(
             "Successfully discovered endpoints: {EndpointsCount}, self location: {SelfLocation}, sdk info: {SdkInfo}",
-            resultProto.Endpoints.Count, resultProto.SelfLocation, _sdkInfo);
+            resultProto.Endpoints.Count, resultProto.SelfLocation, Config.SdkVersion
+        );
 
         _endpointPool.Reset(resultProto.Endpoints
             .Select(endpointSettings => new EndpointSettings(
@@ -189,15 +182,16 @@ private async Task PeriodicDiscovery()
             try
             {
                 await Task.Delay(Config.EndpointDiscoveryInterval);
+
                 _ = await DiscoverEndpoints();
             }
             catch (RpcException e)
             {
-                Logger.LogWarning($"RPC error during endpoint discovery: {e.Status}");
+                Logger.LogWarning("RPC error during endpoint discovery: {Status}", e.Status);
             }
             catch (Exception e)
             {
-                Logger.LogError($"Unexpected exception during session pool periodic check: {e}");
+                Logger.LogError(e, "Unexpected exception during session pool periodic check");
             }
         }
     }

src/Ydb.Sdk/src/DriverConfig.cs

@@ -1,4 +1,5 @@
-using System.Security.Cryptography.X509Certificates;
+using System.Reflection;
+using System.Security.Cryptography.X509Certificates;
 using Ydb.Sdk.Auth;
 
 namespace Ydb.Sdk;
@@ -21,6 +22,7 @@ public class DriverConfig
     internal X509Certificate2Collection CustomServerCertificates { get; } = new();
     internal TimeSpan EndpointDiscoveryInterval = TimeSpan.FromMinutes(1);
     internal TimeSpan EndpointDiscoveryTimeout = TimeSpan.FromSeconds(10);
+    internal string SdkVersion { get; }
 
     public DriverConfig(
         string endpoint,
@@ -42,6 +44,10 @@ public DriverConfig(
         {
             CustomServerCertificates.AddRange(customServerCertificates);
         }
+
+        var version = Assembly.GetExecutingAssembly().GetName().Version;
+        var versionStr = version is null ? "unknown" : version.ToString(3);
+        SdkVersion = $"ydb-dotnet-sdk/{versionStr}";
     }
 
     private static string FormatEndpoint(string endpoint)

src/Ydb.Sdk/src/IDriver.cs

@@ -138,7 +138,8 @@ protected async ValueTask<CallOptions> GetCallOptions(GrpcRequestSettings settin
     {
         var meta = new Grpc.Core.Metadata
         {
-            { Metadata.RpcDatabaseHeader, Config.Database }
+            { Metadata.RpcDatabaseHeader, Config.Database },
+            { Metadata.RpcSdkInfoHeader, Config.SdkVersion }
         };
 
         if (CredentialsProvider != null)

src/Ydb.Sdk/src/Services/Topic/Reader/Reader.cs

@@ -468,8 +468,8 @@ public async Task CommitOffsetRange(OffsetsRange offsetsRange, long partitionSes
     {
         var tcsCommit = new TaskCompletionSource();
 
-        await using var register = _lifecycleReaderSessionCts.Token.Register(
-            () => tcsCommit.TrySetException(new ReaderException($"ReaderSession[{SessionId}] was deactivated"))
+        await using var register = _lifecycleReaderSessionCts.Token.Register(() =>
+            tcsCommit.TrySetException(new ReaderException($"ReaderSession[{SessionId}] was deactivated"))
         );
 
         var commitSending = new CommitSending(offsetsRange, tcsCommit);

src/Ydb.Sdk/tests/Ado/YdbCommandTests.cs

@@ -283,18 +283,18 @@ public void GetChars_WhenSelectText_MoveCharsToBuffer()
         Assert.Equal($"dataOffset must be between 0 and {int.MaxValue}",
             Assert.Throws<IndexOutOfRangeException>(() => ydbDataReader.GetChars(0, -1, null, 0, 6)).Message);
         Assert.Equal($"dataOffset must be between 0 and {int.MaxValue}",
-            Assert.Throws<IndexOutOfRangeException>(
-                () => ydbDataReader.GetChars(0, long.MaxValue, null, 0, 6)).Message);
+            Assert.Throws<IndexOutOfRangeException>(() =>
+                ydbDataReader.GetChars(0, long.MaxValue, null, 0, 6)).Message);
 
-        Assert.Equal("bufferOffset must be between 0 and 10", Assert.Throws<IndexOutOfRangeException>(
-            () => ydbDataReader.GetChars(0, 0, bufferChars, -1, 6)).Message);
-        Assert.Equal("bufferOffset must be between 0 and 10", Assert.Throws<IndexOutOfRangeException>(
-            () => ydbDataReader.GetChars(0, 0, bufferChars, -1, 6)).Message);
+        Assert.Equal("bufferOffset must be between 0 and 10",
+            Assert.Throws<IndexOutOfRangeException>(() => ydbDataReader.GetChars(0, 0, bufferChars, -1, 6)).Message);
+        Assert.Equal("bufferOffset must be between 0 and 10",
+            Assert.Throws<IndexOutOfRangeException>(() => ydbDataReader.GetChars(0, 0, bufferChars, -1, 6)).Message);
 
-        Assert.Equal("length must be between 0 and 10", Assert.Throws<IndexOutOfRangeException>(
-            () => ydbDataReader.GetChars(0, 0, bufferChars, 3, -1)).Message);
-        Assert.Equal("bufferOffset must be between 0 and 5", Assert.Throws<IndexOutOfRangeException>(
-            () => ydbDataReader.GetChars(0, 0, bufferChars, 8, 5)).Message);
+        Assert.Equal("length must be between 0 and 10",
+            Assert.Throws<IndexOutOfRangeException>(() => ydbDataReader.GetChars(0, 0, bufferChars, 3, -1)).Message);
+        Assert.Equal("bufferOffset must be between 0 and 5",
+            Assert.Throws<IndexOutOfRangeException>(() => ydbDataReader.GetChars(0, 0, bufferChars, 8, 5)).Message);
 
         Assert.Equal(6, ydbDataReader.GetChars(0, 0, bufferChars, 4, 6));
         checkBuffer[4] = 'a';
@@ -330,19 +330,18 @@ public void GetBytes_WhenSelectBytes_MoveBytesToBuffer()
         Assert.Equal(7, ydbDataReader.GetBytes(0, 4, null, 0, 6));
         Assert.Equal($"dataOffset must be between 0 and {int.MaxValue}",
             Assert.Throws<IndexOutOfRangeException>(() => ydbDataReader.GetBytes(0, -1, null, 0, 6)).Message);
-        Assert.Equal($"dataOffset must be between 0 and {int.MaxValue}",
-            Assert.Throws<IndexOutOfRangeException>(
-                () => ydbDataReader.GetBytes(0, long.MaxValue, null, 0, 6)).Message);
-
-        Assert.Equal("bufferOffset must be between 0 and 10", Assert.Throws<IndexOutOfRangeException>(
-            () => ydbDataReader.GetBytes(0, 0, bufferChars, -1, 6)).Message);
-        Assert.Equal("bufferOffset must be between 0 and 10", Assert.Throws<IndexOutOfRangeException>(
-            () => ydbDataReader.GetBytes(0, 0, bufferChars, -1, 6)).Message);
-
-        Assert.Equal("length must be between 0 and 10", Assert.Throws<IndexOutOfRangeException>(
-            () => ydbDataReader.GetBytes(0, 0, bufferChars, 3, -1)).Message);
-        Assert.Equal("bufferOffset must be between 0 and 5", Assert.Throws<IndexOutOfRangeException>(
-            () => ydbDataReader.GetBytes(0, 0, bufferChars, 8, 5)).Message);
+        Assert.Equal($"dataOffset must be between 0 and {int.MaxValue}", Assert.Throws<IndexOutOfRangeException>(() =>
+            ydbDataReader.GetBytes(0, long.MaxValue, null, 0, 6)).Message);
+
+        Assert.Equal("bufferOffset must be between 0 and 10",
+            Assert.Throws<IndexOutOfRangeException>(() => ydbDataReader.GetBytes(0, 0, bufferChars, -1, 6)).Message);
+        Assert.Equal("bufferOffset must be between 0 and 10", Assert.Throws<IndexOutOfRangeException>(() =>
+            ydbDataReader.GetBytes(0, 0, bufferChars, -1, 6)).Message);
+
+        Assert.Equal("length must be between 0 and 10", Assert.Throws<IndexOutOfRangeException>(() =>
+            ydbDataReader.GetBytes(0, 0, bufferChars, 3, -1)).Message);
+        Assert.Equal("bufferOffset must be between 0 and 5", Assert.Throws<IndexOutOfRangeException>(() =>
+            ydbDataReader.GetBytes(0, 0, bufferChars, 8, 5)).Message);
 
         Assert.Equal(6, ydbDataReader.GetBytes(0, 0, bufferChars, 4, 6));
         checkBuffer[4] = (byte)'a';

src/Ydb.Sdk/tests/Ado/YdbConnectionStringBuilderTests.cs

@@ -24,11 +24,11 @@ public void InitDefaultValues_WhenEmptyConstructorInvoke_ReturnDefaultConnection
     [Fact]
     public void InitConnectionStringBuilder_WhenUnexpectedKey_ThrowException()
     {
-        Assert.Equal("Key doesn't support: unexpectedkey", Assert.Throws<ArgumentException>(
-            () => new YdbConnectionStringBuilder("UnexpectedKey=123;Port=2135;")).Message);
+        Assert.Equal("Key doesn't support: unexpectedkey", Assert.Throws<ArgumentException>(() =>
+            new YdbConnectionStringBuilder("UnexpectedKey=123;Port=2135;")).Message);
 
-        Assert.Equal("Key doesn't support: unexpectedkey", Assert.Throws<ArgumentException>(
-            () => new YdbConnectionStringBuilder { ConnectionString = "UnexpectedKey=123;Port=2135;" }).Message);
+        Assert.Equal("Key doesn't support: unexpectedkey", Assert.Throws<ArgumentException>(() =>
+            new YdbConnectionStringBuilder { ConnectionString = "UnexpectedKey=123;Port=2135;" }).Message);
     }
 
     [Fact]

src/Ydb.Sdk/tests/Ado/YdbDataReaderTests.cs

@@ -48,9 +48,8 @@ public async Task BasedIteration_WhenNotCallMethodRead_ThrowException()
     public async Task CreateYdbDataReader_WhenAbortedStatus_ThrowException()
     {
         var statuses = new List<Status>();
-        Assert.Equal("Status: Aborted", (await Assert.ThrowsAsync<YdbException>(
-                () => YdbDataReader.CreateYdbDataReader(SingleEnumeratorFailed, statuses.Add)))
-            .Message);
+        Assert.Equal("Status: Aborted", (await Assert.ThrowsAsync<YdbException>(() =>
+            YdbDataReader.CreateYdbDataReader(SingleEnumeratorFailed, statuses.Add))).Message);
         Assert.Single(statuses);
         Assert.Equal(StatusCode.Aborted, statuses[0].StatusCode);
     }