Merge pull request #1466 rename experimental method

rekby · web-flow · commit e582517397b8 · 2024-09-17T12:42:59.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,5 @@
+* Renamed method at experimental API reader.PopBatchTx to reader.PopMessagesBatchTx
+
 ## v3.80.5
 * Fixed connections pool leak on failed `ydb.Open` call
 
diff --git a/examples/topic/topicreader/topic_reader_transaction.go b/examples/topic/topicreader/topic_reader_transaction.go
@@ -15,7 +15,7 @@ func CommitMessagesToTransaction(ctx context.Context, db *ydb.Driver, reader *to
 		}
 
 		err := db.Query().DoTx(ctx, func(ctx context.Context, tx query.TxActor) error {
-			batch, err := reader.PopBatchTx(ctx, tx) // the batch will be committed with commit the tx
+			batch, err := reader.PopMessagesBatchTx(ctx, tx) // the batch will be committed with commit the tx
 			if err != nil {
 				return err
 			}
@@ -51,7 +51,7 @@ func PopWithTransaction(ctx context.Context, db *ydb.Driver, reader *topicreader
 		}
 
 		err := db.Query().DoTx(ctx, func(ctx context.Context, tx query.TxActor) error {
-			batch, err := reader.PopBatchTx(ctx, tx)
+			batch, err := reader.PopMessagesBatchTx(ctx, tx)
 			if err != nil {
 				return err
 			}
@@ -102,7 +102,7 @@ func PopWithTransactionRecreateReader(
 				return err
 			}
 
-			batch, err := reader.PopBatchTx(ctx, tx)
+			batch, err := reader.PopMessagesBatchTx(ctx, tx)
 			if err != nil {
 				return err
 			}
diff --git a/internal/topic/topicreaderinternal/batched_stream_reader_interface.go b/internal/topic/topicreaderinternal/batched_stream_reader_interface.go
@@ -14,5 +14,5 @@ type batchedStreamReader interface {
 	ReadMessageBatch(ctx context.Context, opts ReadMessageBatchOptions) (*topicreadercommon.PublicBatch, error)
 	Commit(ctx context.Context, commitRange topicreadercommon.CommitRange) error
 	CloseWithError(ctx context.Context, err error) error
-	PopBatchTx(ctx context.Context, tx tx.Transaction, opts ReadMessageBatchOptions) (*topicreadercommon.PublicBatch, error) //nolint:lll
+	PopMessagesBatchTx(ctx context.Context, tx tx.Transaction, opts ReadMessageBatchOptions) (*topicreadercommon.PublicBatch, error) //nolint:lll
 }
diff --git a/internal/topic/topicreaderinternal/batched_stream_reader_mock_test.go b/internal/topic/topicreaderinternal/batched_stream_reader_mock_test.go
diff --git a/internal/topic/topicreaderinternal/reader.go b/internal/topic/topicreaderinternal/reader.go
@@ -128,7 +128,7 @@ func (r *Reader) PopBatchTx(
 ) (*topicreadercommon.PublicBatch, error) {
 	batchOptions := r.getBatchOptions(opts)
 
-	return r.reader.PopBatchTx(ctx, tx, batchOptions)
+	return r.reader.PopMessagesBatchTx(ctx, tx, batchOptions)
 }
 
 // ReadMessage read exactly one message
diff --git a/internal/topic/topicreaderinternal/stream_reader_impl.go b/internal/topic/topicreaderinternal/stream_reader_impl.go
@@ -185,7 +185,7 @@ func (r *topicStreamReaderImpl) WaitInit(_ context.Context) error {
 	return nil
 }
 
-func (r *topicStreamReaderImpl) PopBatchTx(
+func (r *topicStreamReaderImpl) PopMessagesBatchTx(
 	ctx context.Context,
 	tx tx.Transaction,
 	opts ReadMessageBatchOptions,
diff --git a/internal/topic/topicreaderinternal/stream_reconnector.go b/internal/topic/topicreaderinternal/stream_reconnector.go
@@ -78,7 +78,7 @@ func newReaderReconnector(
 	return res
 }
 
-func (r *readerReconnector) PopBatchTx(
+func (r *readerReconnector) PopMessagesBatchTx(
 	ctx context.Context,
 	tx tx.Transaction,
 	opts ReadMessageBatchOptions,
@@ -95,7 +95,7 @@ func (r *readerReconnector) PopBatchTx(
 			*topicreadercommon.PublicBatch,
 			error,
 		) {
-			return stream.PopBatchTx(ctx, tx, opts)
+			return stream.PopMessagesBatchTx(ctx, tx, opts)
 		},
 	)
 }
diff --git a/tests/integration/topic_transactions_test.go b/tests/integration/topic_transactions_test.go
@@ -30,7 +30,7 @@ func TestTopicReadInTransaction(t *testing.T) {
 	require.NoError(t, scope.Driver().Query().DoTx(ctx, func(ctx context.Context, tx query.TxActor) error {
 		reader := scope.TopicReaderNamed("first")
 		scope.Logf("trying to pop a batch")
-		batch, err := reader.PopBatchTx(ctx, tx)
+		batch, err := reader.PopMessagesBatchTx(ctx, tx)
 		scope.Logf("pop a batch result: %v", err)
 		if err != nil {
 			return err
@@ -55,7 +55,7 @@ func TestTopicReadInTransaction(t *testing.T) {
 		}
 
 		scope.Logf("trying second pop batch")
-		batch, err := reader.PopBatchTx(ctx, tx)
+		batch, err := reader.PopMessagesBatchTx(ctx, tx)
 		scope.Logf("second pop batch result: %v", err)
 		if err != nil {
 			return err
diff --git a/topic/topicreader/reader.go b/topic/topicreader/reader.go
@@ -74,7 +74,7 @@ func (r *Reader) Commit(ctx context.Context, obj CommitRangeGetter) error {
 	return r.reader.Commit(ctx, obj)
 }
 
-// PopBatchTx read messages batch and commit them within tx.
+// PopMessagesBatchTx read messages batch and commit them within tx.
 // If tx failed - the batch will be received again.
 //
 // Now it means reconnect to the server and re-read messages from the server to the readers buffer.
@@ -83,7 +83,7 @@ func (r *Reader) Commit(ctx context.Context, obj CommitRangeGetter) error {
 // The reconnect is implementation detail and may be changed in the future.
 //
 // Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental
-func (r *Reader) PopBatchTx(
+func (r *Reader) PopMessagesBatchTx(
 	ctx context.Context,
 	transaction tx.Identifier,
 	opts ...ReadBatchOption,

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+* Renamed method at experimental API reader.PopBatchTx to reader.PopMessagesBatchTx`
	`2`	`+`
`1`	`3`	`## v3.80.5`
`2`	`4`	* Fixed connections pool leak on failed `ydb.Open` call
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ func CommitMessagesToTransaction(ctx context.Context, db ydb.Driver, reader to`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`err := db.Query().DoTx(ctx, func(ctx context.Context, tx query.TxActor) error {`
`18`		`- batch, err := reader.PopBatchTx(ctx, tx) // the batch will be committed with commit the tx`
	`18`	`+ batch, err := reader.PopMessagesBatchTx(ctx, tx) // the batch will be committed with commit the tx`
`19`	`19`	`if err != nil {`
`20`	`20`	`return err`
`21`	`21`	`}`
`@@ -51,7 +51,7 @@ func PopWithTransaction(ctx context.Context, db ydb.Driver, reader topicreader`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`err := db.Query().DoTx(ctx, func(ctx context.Context, tx query.TxActor) error {`
`54`		`- batch, err := reader.PopBatchTx(ctx, tx)`
	`54`	`+ batch, err := reader.PopMessagesBatchTx(ctx, tx)`
`55`	`55`	`if err != nil {`
`56`	`56`	`return err`
`57`	`57`	`}`
`@@ -102,7 +102,7 @@ func PopWithTransactionRecreateReader(`
`102`	`102`	`return err`
`103`	`103`	`}`
`104`	`104`
`105`		`- batch, err := reader.PopBatchTx(ctx, tx)`
	`105`	`+ batch, err := reader.PopMessagesBatchTx(ctx, tx)`
`106`	`106`	`if err != nil {`
`107`	`107`	`return err`
`108`	`108`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,5 +14,5 @@ type batchedStreamReader interface {`
`14`	`14`	`ReadMessageBatch(ctx context.Context, opts ReadMessageBatchOptions) (*topicreadercommon.PublicBatch, error)`
`15`	`15`	`Commit(ctx context.Context, commitRange topicreadercommon.CommitRange) error`
`16`	`16`	`CloseWithError(ctx context.Context, err error) error`
`17`		`- PopBatchTx(ctx context.Context, tx tx.Transaction, opts ReadMessageBatchOptions) (*topicreadercommon.PublicBatch, error) //nolint:lll`
	`17`	`+ PopMessagesBatchTx(ctx context.Context, tx tx.Transaction, opts ReadMessageBatchOptions) (*topicreadercommon.PublicBatch, error) //nolint:lll`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ func (r *Reader) PopBatchTx(`
`128`	`128`	`) (*topicreadercommon.PublicBatch, error) {`
`129`	`129`	`batchOptions := r.getBatchOptions(opts)`
`130`	`130`
`131`		`- return r.reader.PopBatchTx(ctx, tx, batchOptions)`
	`131`	`+ return r.reader.PopMessagesBatchTx(ctx, tx, batchOptions)`
`132`	`132`	`}`
`133`	`133`
`134`	`134`	`// ReadMessage read exactly one message`
Original file line number	Diff line number	Diff line change
`@@ -185,7 +185,7 @@ func (r *topicStreamReaderImpl) WaitInit(_ context.Context) error {`
`185`	`185`	`return nil`
`186`	`186`	`}`
`187`	`187`
`188`		`-func (r *topicStreamReaderImpl) PopBatchTx(`
	`188`	`+func (r *topicStreamReaderImpl) PopMessagesBatchTx(`
`189`	`189`	`ctx context.Context,`
`190`	`190`	`tx tx.Transaction,`
`191`	`191`	`opts ReadMessageBatchOptions,`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ func newReaderReconnector(`
`78`	`78`	`return res`
`79`	`79`	`}`
`80`	`80`
`81`		`-func (r *readerReconnector) PopBatchTx(`
	`81`	`+func (r *readerReconnector) PopMessagesBatchTx(`
`82`	`82`	`ctx context.Context,`
`83`	`83`	`tx tx.Transaction,`
`84`	`84`	`opts ReadMessageBatchOptions,`
`@@ -95,7 +95,7 @@ func (r *readerReconnector) PopBatchTx(`
`95`	`95`	`*topicreadercommon.PublicBatch,`
`96`	`96`	`error,`
`97`	`97`	`) {`
`98`		`- return stream.PopBatchTx(ctx, tx, opts)`
	`98`	`+ return stream.PopMessagesBatchTx(ctx, tx, opts)`
`99`	`99`	`},`
`100`	`100`	`)`
`101`	`101`	`}`