feat: invoke ReadAsync() on CloseAsync & dev: refactoring CHANGELOG.md (ydb-platform#275)

Author: KirillKurdyukov

CHANGELOG.md

@@ -1,57 +1,68 @@
+- Fixed: YdbDataReader does not throw YdbException when CloseAsync is called for UPDATE/INSERT statements with no
+  result.
+
 ## v0.14.0
-* Reader client for YDB topics
-* Fixed: send PartitionIds in InitRequest.
-* Do a committed offset on StopPartitionSessionRequest event anyway.
-* Added log info on StopPartitionSessionRequest event.
-* PartitioningSettings were changed to change the PartitionCountLimit to MaxActivePartitions.
-* Dev: updated System.IdentityModel.Tokens.Jwt from version 0.7.0 to version 8.5.0.
-* PartitionSession.Stop uses committedOffset to complete commit tasks.
-* Changed batch type: IReadOnlyCollection<Message<TValue>> -> IReadOnlyList<Message<TValue>>.
-* Invoking TryReadRequestBytes before deserializing message.
-* Updated Ydb.Protos 1.0.6 -> 1.1.1: Updated version of the Grpc.Net.Client library to 2.67.0 and proto messages.
-* Fixed: YdbDataReader.GetDataTypeName for optional values.
-* Added support for "Columns" collectionName in YdbConnection.GetSchema(Async).
+
+- Reader client for YDB topics
+- Fixed: send PartitionIds in InitRequest.
+- Do a committed offset on StopPartitionSessionRequest event anyway.
+- Added log info on StopPartitionSessionRequest event.
+- PartitioningSettings were changed to change the PartitionCountLimit to MaxActivePartitions.
+- Dev: updated System.IdentityModel.Tokens.Jwt from version 0.7.0 to version 8.5.0.
+- PartitionSession.Stop uses committedOffset to complete commit tasks.
+- Changed batch type: IReadOnlyCollection<Message<TValue>> -> IReadOnlyList<Message<TValue>>.
+- Invoking TryReadRequestBytes before deserializing message.
+- Updated Ydb.Protos 1.0.6 -> 1.1.1: Updated version of the Grpc.Net.Client library to 2.67.0 and proto messages.
+- Fixed: YdbDataReader.GetDataTypeName for optional values.
+- Added support for "Columns" collectionName in YdbConnection.GetSchema(Async).
 
 ## v0.12.0
-* GetUint64(int ordinal) returns a ulong for Uint8, Uint16, Uint32, Uint64 YDB types.
-* GetInt64(int ordinal) returns a int for Int8, Int16, Int32, Int64, Uint8, Uint16, Uint32 YDB types.
-* GetUint32(int ordinal) returns a uint for Uint8, Uint16, Uint32 YDB types.
-* GetInt32(int ordinal) returns a int for Int8, Int16, Int32, Uint8, Uint16 YDB types.
-* GetUint16(int ordinal) returns a ushort for Uint8, Uint16 YDB types.
-* GetInt16(int ordinal) returns a short for Int8, Int16, Uint8 YDB types.
-* GetDouble(int ordinal) returns a double for Float and Double YDB types.
-* Throw InvalidCastException on string.Empty in `GetChar(int ordinal)`.
-* Changed Ydb.Sdk.Value.InvalidTypeException to InvalidCastException in YdbValueParser.
-* Changed InvalidCastException to InvalidOperationException in YdbParameter.
-* Added specification tests: YdbCommandTests and YdbParameterTests.
-* YdbConnection.Database returns string.Empty if ConnectionStringBuilder is null.
-* Propagated cancellationToken in Execute[.*]Async methods.
-* When YdbCommand has an open data reader, it throws InvalidOperationException on the setters: CommandText, DbConnection.
-* Added checkers to YdbCommand.Prepare().
-* CommandText getter doesn't throw an exception if the CommandText property has not been initialized.
+
+- GetUint64(int ordinal) returns a ulong for Uint8, Uint16, Uint32, Uint64 YDB types.
+- GetInt64(int ordinal) returns a int for Int8, Int16, Int32, Int64, Uint8, Uint16, Uint32 YDB types.
+- GetUint32(int ordinal) returns a uint for Uint8, Uint16, Uint32 YDB types.
+- GetInt32(int ordinal) returns a int for Int8, Int16, Int32, Uint8, Uint16 YDB types.
+- GetUint16(int ordinal) returns a ushort for Uint8, Uint16 YDB types.
+- GetInt16(int ordinal) returns a short for Int8, Int16, Uint8 YDB types.
+- GetDouble(int ordinal) returns a double for Float and Double YDB types.
+- Throw InvalidCastException on string.Empty in `GetChar(int ordinal)`.
+- Changed Ydb.Sdk.Value.InvalidTypeException to InvalidCastException in YdbValueParser.
+- Changed InvalidCastException to InvalidOperationException in YdbParameter.
+- Added specification tests: YdbCommandTests and YdbParameterTests.
+- YdbConnection.Database returns string.Empty if ConnectionStringBuilder is null.
+- Propagated cancellationToken in Execute[.*]Async methods.
+- When YdbCommand has an open data reader, it throws InvalidOperationException on the setters: CommandText,
+  DbConnection.
+- Added checkers to YdbCommand.Prepare().
+- CommandText getter doesn't throw an exception if the CommandText property has not been initialized.
 
 ## v0.11.0
-* Fix bug: GetValue(int ordinal) return DBNull.Value if fetched NULL value.
-* Fix: NextResult() moves to the next result and skip the first ResultSet.
-* Added specification DbDataReaderTests.
-* If dataOffset is larger than the length of data, GetChars and GetBytes methods will return 0.
-* If YdbDataReader is closed: `throw new InvalidOperationException("The reader is closed")`.
-* InvalidOperationException on ConnectionString property has not been initialized.
-* One YdbTransaction per YdbConnection. Otherwise, throw an exception: InvalidOperationException("A transaction is already in progress; nested/concurrent transactions aren't supported.").
-* ConnectionString returns an empty.String when it is not set.
-* When a YdbDataReader is closed, if stream is not empty, a YdbTransaction fails if it is not null. A session also fails due to a possible error SessionBusy race condition with the server.
-* Fixed bug: Fetch txId from the last result set.
-* YdbTransaction CheckDisposed() (invoke rollback if transaction hasn't been committed).
-* Dev: Added specification tests for YdbTransaction.
+
+- Fix bug: GetValue(int ordinal) return DBNull.Value if fetched NULL value.
+- Fix: NextResult() moves to the next result and skip the first ResultSet.
+- Added specification DbDataReaderTests.
+- If dataOffset is larger than the length of data, GetChars and GetBytes methods will return 0.
+- If YdbDataReader is closed: `throw new InvalidOperationException("The reader is closed")`.
+- InvalidOperationException on ConnectionString property has not been initialized.
+- One YdbTransaction per YdbConnection. Otherwise, throw an exception: InvalidOperationException("A transaction is
+  already in progress; nested/concurrent transactions aren't supported.").
+- ConnectionString returns an empty.String when it is not set.
+- When a YdbDataReader is closed, if stream is not empty, a YdbTransaction fails if it is not null. A session also fails
+  due to a possible error SessionBusy race condition with the server.
+- Fixed bug: Fetch txId from the last result set.
+- YdbTransaction CheckDisposed() (invoke rollback if transaction hasn't been committed).
+- Dev: Added specification tests for YdbTransaction.
 
 ## v0.10.0
-- Fixed bug in Topic Writer: race condition when session fails, then write operation starts on previous session and new session is created. Messages may be lost. 
-- Supported in ADO.NET GetSchema(Async). CollectionNames: 
-   * Tables
-   * TablesWithCollections
-   * DataSourceInformation
-   * MetaDataCollections
-   * Restrictions
+
+- Fixed bug in Topic Writer: race condition when session fails, then write operation starts on previous session and new
+  session is created. Messages may be lost.
+- Supported in ADO.NET GetSchema(Async). CollectionNames:
+    * Tables
+    * TablesWithCollections
+    * DataSourceInformation
+    * MetaDataCollections
+    * Restrictions
 - Rename field _onStatus -> _onNotSuccessStatus in YdbDataReader
 - If session is not active, do not invoke DeleteNotActiveSession(session)
 - AttachStream: connect stream using NodeId
@@ -60,6 +71,7 @@
 - DbConnection.Session.OnStatus(status) in YdbTransaction
 
 ## v0.9.4
+
 - Do not pessimize the node on Grpc.Core.StatusCode.Cancelled and Grpc.Core.StatusCode.DeadlineExceeded.
 - Dispose of WriterSession using dispose CancellationToken.
 - BidirectionalStream is internal class.
@@ -68,124 +80,159 @@
 - Cancel writing tasks after disposing of Writer.
 
 ## v0.9.3
+
 - Fixed bug in Topic Writer: worker is stopped by disposeCts
-- Fixed bug in sql parser ADO.NET: deduplication declare param in YQL query 
+- Fixed bug in sql parser ADO.NET: deduplication declare param in YQL query
 - Deleted property BufferOverflowRetryTimeoutMs
 
 ## v0.9.2
+
 - Fixed bug: delete deadline grpc timeout on AttachStream
 
 ## v0.9.1
+
 - Update log level on AttachStream
 
 ## v0.9.0
+
 - Writer client for YDB topics
-- Fixed bug: delete default timeout grpc.deadline 
+- Fixed bug: delete default timeout grpc.deadline
 
 ## v0.9.0-rc1
+
 - Topic Writer updated release candidate:
-  * Do not send messages that have a timeout by cancelToken.
-  * If your value serializer throws an exception, this will be wrapped in a WriterException with unspecified status.
-  * Added BufferOverflowRetryTimeoutMs to the next try write.
-  * Rename _disposeTokenSource -> _disposeCts.
-  * Optimize write worker: if (_toSendBuffer.IsEmpty) continue.
-  * On RPC errors create DummyWriterSession.
-  * Message has been skipped because its sequence number is less than or equal to the last processed server's SeqNo.
-  * Calculate the next sequence number from the calculated previous messages.
+    * Do not send messages that have a timeout by cancelToken.
+    * If your value serializer throws an exception, this will be wrapped in a WriterException with unspecified status.
+    * Added BufferOverflowRetryTimeoutMs to the next try write.
+    * Rename _disposeTokenSource -> _disposeCts.
+    * Optimize write worker: if (_toSendBuffer.IsEmpty) continue.
+    * On RPC errors create DummyWriterSession.
+    * Message has been skipped because its sequence number is less than or equal to the last processed server's SeqNo.
+    * Calculate the next sequence number from the calculated previous messages.
 
 ## v0.9.0-rc0
+
 - Topic Writer release candidate:
-  * Updated CAS semantics for enqueuing in the buffer.
-  * Processed buffer overflow on WriteAsync.
-  * Setting NotStartedWriterSession with a fail reason on RPC and more errors.
-  * New initialization strategy for WriterSession (background task).
-  * Supported cancellation token for sending tasks.
-  * Fixed setting the SeqNo field in the message (in-flight buffer already has a seqNo) and added a check on canceled TCS.
-  * Using BitConverter for Serializer / Deserializer.
-- Fixed: grpc requests go via proxy on Grpc.NET.Client >= 2.44 
+    * Updated CAS semantics for enqueuing in the buffer.
+    * Processed buffer overflow on WriteAsync.
+    * Setting NotStartedWriterSession with a fail reason on RPC and more errors.
+    * New initialization strategy for WriterSession (background task).
+    * Supported cancellation token for sending tasks.
+    * Fixed setting the SeqNo field in the message (in-flight buffer already has a seqNo) and added a check on canceled
+      TCS.
+    * Using BitConverter for Serializer / Deserializer.
+- Fixed: grpc requests go via proxy on Grpc.NET.Client >= 2.44
 
 ## v0.8.0
-- Fixed bug on commit with fail, no set failed flag for rollback invocation 
+
+- Fixed bug on commit with fail, no set failed flag for rollback invocation
 - Supported UUID (Guid)
 
 ## v0.7.3
+
 - Fixed YdbDataReader: extract Json / Yson types
 
 ## v0.7.2
+
 - Fixed YdbDataReader: `GetValue()` returns `DbNull.Value` if field is null
 - YdbOperationInProgressException extends YdbException
 
 ## v0.7.1
+
 - If an error happened in the transaction, allow one empty rollback
 
 ## v0.7.0
+
 - Parsed @param then prepared for use with $ prefix (@p -> $p)
 - Fully integrated with Dapper
 
 ## v0.6.3
+
 - Fixed bug: parameter type mismatch, when setting optional with null
 
 ## v0.6.2
+
 - Fixed bug: adding correct placeholders to all logging calls with parameters
 
 ## v0.6.1
+
 - Check status of the transport or server for an invalidated session
 - Fixed NPE in DescribeTable
 
 ## v0.6.0
+
 - ADO.NET over query-service
 - Add EndpointPool
 - Add SessionPool 2.0
 
 ## v0.4.0
+
 - Fix bug: rounding down when inserting a Timestamp YDB type
 - ChannelCache has been implemented using ChannelPool and EndpointPool
 
 ## v0.3.2
+
 - Make KeepAlive method public for TableClient
 
 ## v0.3.1
+
 - Fix error: Access denied without user token
 
 ## v0.3.0
+
 - Add rollback transaction API
 
 ## v0.2.2
+
 - Passed logger to TxControl.ToProto
 
 ## v0.2.1
+
 - Retry discovery on driver initialize
 
 ## v0.2.0
+
 - Added MakeTablePath, CopyTable, CopyTables, DescribeTable methods for TableClient
 - Add logging for transactions
 
 ## v0.1.5
+
 - Fix timeout error on create session
 - Fix transport error on delete session
 
 ## v0.1.4
+
 - Add exception throwing when results truncated
 - lint: add line feed at file end
 
 ## v0.1.3
+
 - Add static auth
+
 ## v0.1.1
+
 - Add static code analysis
 - Add CodeQL analysis
 - Add linter
 - Apply uniform code style and fix all warnings
+
 ## v0.1.0
+
 - Add support of decimal type
+
 ## v0.0.9
+
 - Remove support for .NET Core 3.1
 - Add support for .NET 7.0
-- 
+-
+
 ## v0.0.8
+
 - Fixed version number
 
 ## v0.0.6
-- Add methods for castion to c# nullable to YQL Optional 
+
+- Add methods for castion to c# nullable to YQL Optional
 - Add explicit cast operator for some types
 - Tests refactoring
 - Add Bool type support

src/Ydb.Sdk/src/Ado/YdbDataReader.cs

@@ -561,8 +561,8 @@ public override async Task CloseAsync()
             return;
         }
 
+        var isConsumed = ReaderState == State.IsConsumed || (!await ReadAsync() && ReaderState == State.IsConsumed);
         ReaderMetadata = CloseMetadata.Instance;
-        var isConsumed = ReaderState == State.IsConsumed;
         ReaderState = State.Close;
 
         if (isConsumed)
@@ -595,7 +595,7 @@ private YdbValue GetFieldYdbValue(int ordinal)
             : ydbValue;
     }
 
-    private async Task<State> NextExecPart()
+    private async ValueTask<State> NextExecPart()
     {
         try
         {

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

@@ -42,6 +42,26 @@ public void Rollback_WhenUpsertThenRollback_ReturnPrevRow()
         Assert.Equal(new DateTime(2008, 11, 21), ydbCommand.ExecuteScalar());
     }
 
+    [Fact]
+    public void Commit_WhenUpdateWithYdbDataReader_ReturnUpdatedRow()
+    {
+        using var connection = CreateOpenConnection();
+        var ydbTransaction = connection.BeginTransaction();
+        var ydbCommand = new YdbCommand(connection)
+        {
+            CommandText = $@"UPDATE {Tables.Episodes} SET title=""test Episode 2"" 
+                                     WHERE series_id = 2 AND season_id = 5 AND episode_id = 1;"
+        };
+        var executeReaderAsync = ydbCommand.ExecuteReader();
+        executeReaderAsync.Close();
+        ydbTransaction.Commit();
+        Assert.Equal("test Episode 2", new YdbCommand(connection)
+        {
+            CommandText = $@"SELECT title FROM {Tables.Episodes} 
+                                     WHERE series_id = 2 AND season_id = 5 AND episode_id = 1;"
+        }.ExecuteScalar());
+    }
+
     [Fact]
     public void Commit_WhenMakeTwoUpsertOperation_ReturnUpdatedTables()
     {