Merge branch 'master' into topic-adapters

rekby · rekby · commit d98028f33ce6 · 2022-08-05T12:57:44.000+03:00
# Conflicts:
#	topic/topicreader/reader_example_test.go
diff --git a/.github/workflows/check-codegen.yml b/.github/workflows/check-codegen.yml
@@ -10,7 +10,7 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest ]
-        go: [1.18.x]
+        go: [1.18.x, 1.19.x]
     runs-on: ${{ matrix.os }}
     steps:
     - name: Checkout
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -10,7 +10,7 @@ jobs:
     name: golangci-lint
     strategy:
       matrix:
-        go-version: [1.14.x, 1.15.x, 1.16.x, 1.17.x, 1.18.x]
+        go-version: [1.14.x, 1.18.x, 1.19.x]
         os: [ubuntu-latest]
     env:
       OS: ${{ matrix.os }}
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -9,7 +9,7 @@ jobs:
   unit:
     strategy:
       matrix:
-        go-version: [1.14.x, 1.15.x, 1.16.x, 1.17.x, 1.18.x]
+        go-version: [1.14.x, 1.18.x, 1.19.x]
         os: [ubuntu-latest, windows-latest, macOS-latest]
     env:
       OS: ${{ matrix.os }}
@@ -33,7 +33,7 @@ jobs:
   table:
     strategy:
       matrix:
-        go-version: [1.18.x]
+        go-version: [1.18.x, 1.19.x]
         os: [ubuntu-latest]
     services:
       ydb:
@@ -76,7 +76,7 @@ jobs:
   ratelimiter:
     strategy:
       matrix:
-        go-version: [1.18.x]
+        go-version: [1.18.x, 1.19.x]
         os: [ubuntu-latest]
     services:
       ydb:
@@ -118,7 +118,7 @@ jobs:
   scripting:
     strategy:
       matrix:
-        go-version: [1.18.x]
+        go-version: [1.18.x, 1.19.x]
         os: [ubuntu-latest]
     services:
       ydb:
@@ -159,7 +159,7 @@ jobs:
   topic:
     strategy:
       matrix:
-        go-version: [1.18.x]
+        go-version: [1.18.x, 1.19.x]
         os: [ubuntu-latest]
     services:
       ydb:
@@ -200,7 +200,7 @@ jobs:
   discovery:
     strategy:
       matrix:
-        go-version: [1.18.x]
+        go-version: [1.18.x, 1.19.x]
         os: [ubuntu-latest]
     services:
       ydb:
@@ -241,7 +241,7 @@ jobs:
   connection:
     strategy:
       matrix:
-        go-version: [1.18.x]
+        go-version: [1.18.x, 1.19.x]
         os: [ubuntu-latest]
     services:
       ydb:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,5 @@
-* Allow read and commit messages in parallel
+* Fixed signature/name of helpers in topic/topicsugar package 
+* Allowed read and commit messages in parallel
 
 ## v3.31.0
 * Extended the ydb.Connection interface with experimental db.Topic() client (control plane and reader API)
diff --git a/internal/topic/topicreaderinternal/batch.go b/internal/topic/topicreaderinternal/batch.go
@@ -94,7 +94,8 @@ func newBatchFromStream(decoders decoderMap, session *partitionSession, sb rawto
 	return newBatch(session, messages)
 }
 
-// Context is cancelled when partition of message will stop to read.
+// Context is cancelled when code should stop to process messages batch
+// for example - lost connection to server or receive stop partition signal without graceful flag
 //
 // Experimental
 //
diff --git a/topic/reader_e2e_test.go b/topic/reader_e2e_test.go
@@ -42,10 +42,10 @@ func TestReadMessages(t *testing.T) {
 	t.Logf("msg: %#v", msg)
 
 	require.NoError(t, err)
-	err = msg.UnmarshalTo(topicsugar.ConsumeWithCallback(func(data []byte) error {
+	err = topicsugar.ReadMessageDataWithCallback(msg, func(data []byte) error {
 		t.Log("Content:", string(data))
 		return nil
-	}))
+	})
 	require.NoError(t, err)
 
 	sendCDCMessage(ctx, t, db)
diff --git a/topic/topicoptions/topicoptions_reader.go b/topic/topicoptions/topicoptions_reader.go
@@ -101,6 +101,8 @@ func WithCommitCountTrigger(count int) ReaderOption {
 }
 
 // WithBatchReadMinCount
+// prefer min count messages in batch
+// sometimes batch can contain fewer messages, for example if local buffer is full and SDK can't receive more messages
 //
 // Experimental
 //
diff --git a/topic/topicreader/doc.go b/topic/topicreader/doc.go
@@ -0,0 +1,5 @@
+// Package topicreader provide Reader to receive messages from YDB topics
+// More examples in examples repository
+//
+// https://github.com/ydb-platform/ydb-go-examples/tree/master/topic/topicreader
+package topicreader
diff --git a/topic/topicreader/reader.go b/topic/topicreader/reader.go
@@ -68,6 +68,8 @@ type Message = topicreaderinternal.PublicMessage
 type MessageContentUnmarshaler = topicreaderinternal.PublicMessageContentUnmarshaler
 
 // Commit receive Message, Batch of single offset
+// It can be fast (by default) or sync and waite response from server
+// see topicoptions.CommitMode for details
 //
 // Experimental
 //
diff --git a/topic/topicreader/reader_exampl_own_type_unmarshal_test.go b/topic/topicreader/reader_exampl_own_type_unmarshal_test.go
diff --git a/topic/topicreader/reader_example_test.go b/topic/topicreader/reader_example_test.go
diff --git a/topic/topicsugar/topicreader.go b/topic/topicsugar/topicreader.go

Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,8 @@ func newBatchFromStream(decoders decoderMap, session *partitionSession, sb rawto`
`94`	`94`	`return newBatch(session, messages)`
`95`	`95`	`}`
`96`	`96`
`97`		`-// Context is cancelled when partition of message will stop to read.`
	`97`	`+// Context is cancelled when code should stop to process messages batch`
	`98`	`+// for example - lost connection to server or receive stop partition signal without graceful flag`
`98`	`99`	`//`
`99`	`100`	`// Experimental`
`100`	`101`	`//`
Original file line number	Diff line number	Diff line change
`@@ -101,6 +101,8 @@ func WithCommitCountTrigger(count int) ReaderOption {`
`101`	`101`	`}`
`102`	`102`
`103`	`103`	`// WithBatchReadMinCount`
	`104`	`+// prefer min count messages in batch`
	`105`	`+// sometimes batch can contain fewer messages, for example if local buffer is full and SDK can't receive more messages`
`104`	`106`	`//`
`105`	`107`	`// Experimental`
`106`	`108`	`//`