rework message options

Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>

README.md

@@ -1,2 +1,2 @@
 # micro-broker-kgo
-![Coverage](https://img.shields.io/badge/Coverage-65.1%25-yellow)
+![Coverage](https://img.shields.io/badge/Coverage-63.0%25-yellow)

go.mod

@@ -3,12 +3,12 @@ module go.unistack.org/micro-broker-kgo/v4
 go 1.23.8
 
 require (
-	github.com/twmb/franz-go v1.19.1
+	github.com/twmb/franz-go v1.19.5
 	github.com/twmb/franz-go/pkg/kadm v1.16.0
 	github.com/twmb/franz-go/pkg/kfake v0.0.0-20250508175730-72e1646135e3
 	github.com/twmb/franz-go/pkg/kmsg v1.11.2
-	go.opentelemetry.io/otel v1.35.0
-	go.unistack.org/micro/v4 v4.1.14
+	go.opentelemetry.io/otel v1.36.0
+	go.unistack.org/micro/v4 v4.1.17
 )
 
 require (
@@ -16,8 +16,8 @@ require (
 	github.com/klauspost/compress v1.18.0 // indirect
 	github.com/matoous/go-nanoid v1.5.1 // indirect
 	github.com/pierrec/lz4/v4 v4.1.22 // indirect
-	github.com/spf13/cast v1.8.0 // indirect
+	github.com/spf13/cast v1.9.2 // indirect
 	go.unistack.org/micro-proto/v4 v4.1.0 // indirect
-	golang.org/x/crypto v0.38.0 // indirect
+	golang.org/x/crypto v0.39.0 // indirect
 	google.golang.org/protobuf v1.36.6 // indirect
 )

go.sum

@@ -20,26 +20,26 @@ github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRI
 github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/rogpeppe/go-internal v1.13.1 h1:KvO1DLK/DRN07sQ1LQKScxyZJuNnedQ5/wKSR38lUII=
 github.com/rogpeppe/go-internal v1.13.1/go.mod h1:uMEvuHeurkdAXX61udpOXGD/AzZDWNMNyH2VO9fmH0o=
-github.com/spf13/cast v1.8.0 h1:gEN9K4b8Xws4EX0+a0reLmhq8moKn7ntRlQYgjPeCDk=
-github.com/spf13/cast v1.8.0/go.mod h1:ancEpBxwJDODSW/UG4rDrAqiKolqNNh2DX3mk86cAdo=
+github.com/spf13/cast v1.9.2 h1:SsGfm7M8QOFtEzumm7UZrZdLLquNdzFYfIbEXntcFbE=
+github.com/spf13/cast v1.9.2/go.mod h1:jNfB8QC9IA6ZuY2ZjDp0KtFO2LZZlg4S/7bzP6qqeHo=
 github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
 github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
-github.com/twmb/franz-go v1.19.1 h1:cOhDFUkGvUFHSQ7UYW6bO77BJa2fYEk5mA2AX+1NIdE=
-github.com/twmb/franz-go v1.19.1/go.mod h1:4kFJ5tmbbl7asgwAGVuyG1ZMx0NNpYk7EqflvWfPCpM=
+github.com/twmb/franz-go v1.19.5 h1:W7+o8D0RsQsedqib71OVlLeZ0zI6CbFra7yTYhZTs5Y=
+github.com/twmb/franz-go v1.19.5/go.mod h1:4kFJ5tmbbl7asgwAGVuyG1ZMx0NNpYk7EqflvWfPCpM=
 github.com/twmb/franz-go/pkg/kadm v1.16.0 h1:STMs1t5lYR5mR974PSiwNzE5TvsosByTp+rKXLOhAjE=
 github.com/twmb/franz-go/pkg/kadm v1.16.0/go.mod h1:MUdcUtnf9ph4SFBLLA/XxE29rvLhWYLM9Ygb8dfSCvw=
 github.com/twmb/franz-go/pkg/kfake v0.0.0-20250508175730-72e1646135e3 h1:p24opKWPySAy8xSl8NqRgOv7Q+bX7kdrQirBVRJzQfo=
 github.com/twmb/franz-go/pkg/kfake v0.0.0-20250508175730-72e1646135e3/go.mod h1:7uQs3Ae6HkWT1Y9elMbqtAcNFCI0y6+iS+Phw49L49U=
 github.com/twmb/franz-go/pkg/kmsg v1.11.2 h1:hIw75FpwcAjgeyfIGFqivAvwC5uNIOWRGvQgZhH4mhg=
 github.com/twmb/franz-go/pkg/kmsg v1.11.2/go.mod h1:CFfkkLysDNmukPYhGzuUcDtf46gQSqCZHMW1T4Z+wDE=
-go.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=
-go.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=
+go.opentelemetry.io/otel v1.36.0 h1:UumtzIklRBY6cI/lllNZlALOF5nNIzJVb16APdvgTXg=
+go.opentelemetry.io/otel v1.36.0/go.mod h1:/TcFMXYjyRNh8khOAO9ybYkqaDBb/70aVwkNML4pP8E=
 go.unistack.org/micro-proto/v4 v4.1.0 h1:qPwL2n/oqh9RE3RTTDgt28XK3QzV597VugQPaw9lKUk=
 go.unistack.org/micro-proto/v4 v4.1.0/go.mod h1:ArmK7o+uFvxSY3dbJhKBBX4Pm1rhWdLEFf3LxBrMtec=
-go.unistack.org/micro/v4 v4.1.14 h1:6EotPq9kz/gaFb5YulHdKuuUwmj/7Hk44DpOlzh/A6k=
-go.unistack.org/micro/v4 v4.1.14/go.mod h1:xleO2M5Yxh4s6I+RUcLrEpUjobefh+71ctrdIfn7TUs=
-golang.org/x/crypto v0.38.0 h1:jt+WWG8IZlBnVbomuhg2Mdq0+BBQaHbtqHEFEigjUV8=
-golang.org/x/crypto v0.38.0/go.mod h1:MvrbAqul58NNYPKnOra203SB9vpuZW0e+RRZV+Ggqjw=
+go.unistack.org/micro/v4 v4.1.17 h1:26QDtRSYVpozYuassyvLP4sEQRo3dxgD3sVILRXmIPo=
+go.unistack.org/micro/v4 v4.1.17/go.mod h1:xleO2M5Yxh4s6I+RUcLrEpUjobefh+71ctrdIfn7TUs=
+golang.org/x/crypto v0.39.0 h1:SHs+kF4LP+f+p14esP5jAoDpHU8Gu/v9lFRK6IT5imM=
+golang.org/x/crypto v0.39.0/go.mod h1:L+Xg3Wf6HoL4Bn4238Z6ft6KfEpN0tJGo53AAPC632U=
 google.golang.org/protobuf v1.36.6 h1:z1NpPI8ku2WgiWnf+t9wTPsn6eP1L7ksHUlkfLvd9xY=
 google.golang.org/protobuf v1.36.6/go.mod h1:jduwjTPXsFjZGTmRluh+L6NjiWu7pchiJ2/5YcXBHnY=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

kgo.go

@@ -108,7 +108,7 @@ type kgoMessage struct {
 	ctx   context.Context
 	body  []byte
 	hdr   metadata.Metadata
-	opts  broker.PublishOptions
+	opts  broker.MessageOptions
 	ack   bool
 }
 
@@ -150,8 +150,8 @@ func (b *Broker) newCodec(ct string) (codec.Codec, error) {
 	return nil, codec.ErrUnknownContentType
 }
 
-func (b *Broker) NewMessage(ctx context.Context, hdr metadata.Metadata, body interface{}, opts ...broker.PublishOption) (broker.Message, error) {
-	options := broker.NewPublishOptions(opts...)
+func (b *Broker) NewMessage(ctx context.Context, hdr metadata.Metadata, body interface{}, opts ...broker.MessageOption) (broker.Message, error) {
+	options := broker.NewMessageOptions(opts...)
 	if options.ContentType == "" {
 		options.ContentType = b.opts.ContentType
 	}
@@ -344,40 +344,31 @@ func (b *Broker) fnPublish(ctx context.Context, topic string, messages ...broker
 }
 
 func (b *Broker) publish(ctx context.Context, topic string, messages ...broker.Message) error {
-	records := make([]*kgo.Record, 0, len(messages))
-	var errs []string
-	var key []byte
-	var promise func(*kgo.Record, error)
+	var records []*kgo.Record
 
 	for _, msg := range messages {
-		if mctx := msg.Context(); mctx != nil {
-			if k, ok := mctx.Value(publishKey{}).([]byte); ok && k != nil {
-				key = k
-			}
-			if p, ok := mctx.Value(publishPromiseKey{}).(func(*kgo.Record, error)); ok && p != nil {
-				promise = p
-			}
-		}
 
 		rec := &kgo.Record{
-			Context: ctx,
-			Key:     key,
+			Context: msg.Context(),
 			Topic:   topic,
 			Value:   msg.Body(),
 		}
 
-		b.opts.Meter.Counter(semconv.PublishMessageInflight, "endpoint", rec.Topic, "topic", rec.Topic).Inc()
+		var promise func(*kgo.Record, error)
+		if rec.Context != nil {
+			if k, ok := rec.Context.Value(messageKey{}).([]byte); ok && k != nil {
+				rec.Key = k
+			}
+			if p, ok := rec.Context.Value(messagePromiseKey{}).(func(*kgo.Record, error)); ok && p != nil {
+				promise = p
+			}
+		}
 
 		setHeaders(rec, msg.Header())
 
-		records = append(records, rec)
-	}
-
-	ts := time.Now()
-
-	if promise != nil {
-
-		for _, rec := range records {
+		if promise != nil {
+			ts := time.Now()
+			b.opts.Meter.Counter(semconv.PublishMessageInflight, "endpoint", rec.Topic, "topic", rec.Topic).Inc()
 			b.c.Produce(ctx, rec, func(r *kgo.Record, err error) {
 				te := time.Since(ts)
 				b.opts.Meter.Counter(semconv.PublishMessageInflight, "endpoint", rec.Topic, "topic", rec.Topic).Dec()
@@ -390,27 +381,33 @@ func (b *Broker) publish(ctx context.Context, topic string, messages ...broker.M
 				}
 				promise(r, err)
 			})
-		}
-		return nil
-	}
-
-	results := b.c.ProduceSync(ctx, records...)
-
-	te := time.Since(ts)
-	for _, result := range results {
-		b.opts.Meter.Summary(semconv.PublishMessageLatencyMicroseconds, "endpoint", result.Record.Topic, "topic", result.Record.Topic).Update(te.Seconds())
-		b.opts.Meter.Histogram(semconv.PublishMessageDurationSeconds, "endpoint", result.Record.Topic, "topic", result.Record.Topic).Update(te.Seconds())
-		b.opts.Meter.Counter(semconv.PublishMessageInflight, "endpoint", result.Record.Topic, "topic", result.Record.Topic).Dec()
-		if result.Err != nil {
-			b.opts.Meter.Counter(semconv.PublishMessageTotal, "endpoint", result.Record.Topic, "topic", result.Record.Topic, "status", "failure").Inc()
-			errs = append(errs, result.Err.Error())
+			continue
 		} else {
-			b.opts.Meter.Counter(semconv.PublishMessageTotal, "endpoint", result.Record.Topic, "topic", result.Record.Topic, "status", "success").Inc()
+			records = append(records, rec)
 		}
 	}
 
-	if len(errs) > 0 {
-		return fmt.Errorf("publish error: %s", strings.Join(errs, "\n"))
+	if len(records) > 0 {
+		var errs []string
+		ts := time.Now()
+		b.opts.Meter.Counter(semconv.PublishMessageInflight, "endpoint", topic, "topic", topic).Set(uint64(len(records)))
+		results := b.c.ProduceSync(ctx, records...)
+		te := time.Since(ts)
+		for _, result := range results {
+			b.opts.Meter.Summary(semconv.PublishMessageLatencyMicroseconds, "endpoint", result.Record.Topic, "topic", result.Record.Topic).Update(te.Seconds())
+			b.opts.Meter.Histogram(semconv.PublishMessageDurationSeconds, "endpoint", result.Record.Topic, "topic", result.Record.Topic).Update(te.Seconds())
+			b.opts.Meter.Counter(semconv.PublishMessageInflight, "endpoint", result.Record.Topic, "topic", result.Record.Topic).Dec()
+			if result.Err != nil {
+				b.opts.Meter.Counter(semconv.PublishMessageTotal, "endpoint", result.Record.Topic, "topic", result.Record.Topic, "status", "failure").Inc()
+				errs = append(errs, result.Err.Error())
+			} else {
+				b.opts.Meter.Counter(semconv.PublishMessageTotal, "endpoint", result.Record.Topic, "topic", result.Record.Topic, "status", "success").Inc()
+			}
+		}
+
+		if len(errs) > 0 {
+			return fmt.Errorf("publish error: %s", strings.Join(errs, "\n"))
+		}
 	}
 
 	return nil

kgo_test.go

@@ -81,7 +81,7 @@ func TestFail(t *testing.T) {
 	go func() {
 		for _, msg := range msgs {
 			//		t.Logf("broker publish")
-			if err := b.Publish(ctx, "test", msg); err != nil {
+			if err := b.Publish(ctx, "test.fail", msg); err != nil {
 				t.Fatal(err)
 			}
 		}
@@ -96,7 +96,7 @@ func TestFail(t *testing.T) {
 		return msg.Ack()
 	}
 
-	sub, err := b.Subscribe(ctx, "test", fn,
+	sub, err := b.Subscribe(ctx, "test.fail", fn,
 		broker.SubscribeAutoAck(true),
 		broker.SubscribeGroup(group),
 		broker.SubscribeBodyOnly(true))
@@ -184,7 +184,7 @@ func TestPubSub(t *testing.T) {
 			msgs = append(msgs, m)
 		}
 
-		if err := b.Publish(ctx, "test", msgs...); err != nil {
+		if err := b.Publish(ctx, "test.pubsub", msgs...); err != nil {
 			t.Fatal(err)
 		}
 		//	t.Skip()
@@ -197,7 +197,7 @@ func TestPubSub(t *testing.T) {
 		return msg.Ack()
 	}
 
-	sub, err := b.Subscribe(ctx, "test", fn,
+	sub, err := b.Subscribe(ctx, "test.pubsub", fn,
 		broker.SubscribeAutoAck(true),
 		broker.SubscribeGroup(group),
 		broker.SubscribeBodyOnly(true))

options.go

@@ -27,11 +27,11 @@ func SubscribeContext(ctx context.Context) broker.SubscribeOption {
 	return broker.SetSubscribeOption(subscribeContextKey{}, ctx)
 }
 
-type publishKey struct{}
+type messageKey struct{}
 
-// PublishKey set the kafka message key (broker option)
-func PublishKey(key []byte) broker.PublishOption {
-	return broker.SetPublishOption(publishKey{}, key)
+// MessageKey set the kafka message key (broker option)
+func MessageKey(key []byte) broker.MessageOption {
+	return broker.SetMessageOption(messageKey{}, key)
 }
 
 type optionsKey struct{}
@@ -103,11 +103,11 @@ func SubscribeFatalOnError(b bool) broker.SubscribeOption {
 	return broker.SetSubscribeOption(fatalOnErrorKey{}, b)
 }
 
-type publishPromiseKey struct{}
+type messagePromiseKey struct{}
 
-// PublishPromise set the kafka promise func for Produce
-func PublishPromise(fn func(*kgo.Record, error)) broker.PublishOption {
-	return broker.SetPublishOption(publishPromiseKey{}, fn)
+// MessagePromise set the kafka promise func for Produce
+func MessagePromise(fn func(*kgo.Record, error)) broker.MessageOption {
+	return broker.SetMessageOption(messagePromiseKey{}, fn)
 }
 
 type subscribeMessagePoolKey struct{}

subscriber.go

@@ -39,16 +39,15 @@ type consumer struct {
 }
 
 type Subscriber struct {
-	consumers   map[tp]*consumer
-	c           *kgo.Client
-	htracer     *hookTracer
-	topic       string
-	messagePool bool
-	handler     interface{}
-	done        chan struct{}
-	kopts       broker.Options
-	opts        broker.SubscribeOptions
-
+	consumers    map[tp]*consumer
+	c            *kgo.Client
+	htracer      *hookTracer
+	topic        string
+	messagePool  bool
+	handler      interface{}
+	done         chan struct{}
+	kopts        broker.Options
+	opts         broker.SubscribeOptions
 	connected    *atomic.Uint32
 	mu           sync.RWMutex
 	closed       bool