Removed Produce() opaque arg in favour of Message.Opaque (issue confluentinc#4)

edenhill · edenhill · commit 79fa6efb6ef5 · 2016-10-16T10:54:15.000+02:00
diff --git a/examples/producer_example/producer_example.go b/examples/producer_example/producer_example.go
@@ -48,7 +48,7 @@ func main() {
 	deliveryChan := make(chan kafka.Event)
 
 	value := "Hello Go!"
-	err = p.Produce(&kafka.Message{TopicPartition: kafka.TopicPartition{Topic: &topic, Partition: kafka.PartitionAny}, Value: []byte(value)}, deliveryChan, nil)
+	err = p.Produce(&kafka.Message{TopicPartition: kafka.TopicPartition{Topic: &topic, Partition: kafka.PartitionAny}, Value: []byte(value)}, deliveryChan)
 
 	e := <-deliveryChan
 	m := e.(*kafka.Message)
diff --git a/kafka/producer.go b/kafka/producer.go
@@ -56,7 +56,7 @@ func (p *Producer) gethandle() *handle {
 	return &p.handle
 }
 
-func (p *Producer) produce(msg *Message, msgFlags int, deliveryChan chan Event, opaque interface{}) error {
+func (p *Producer) produce(msg *Message, msgFlags int, deliveryChan chan Event) error {
 	crkt := p.handle.getRkt(*msg.TopicPartition.Topic)
 
 	var valp *byte
@@ -91,8 +91,8 @@ func (p *Producer) produce(msg *Message, msgFlags int, deliveryChan chan Event,
 	// Since these cant be passed as opaque pointers to the C code,
 	// due to cgo constraints, we add them to a per-producer map for lookup
 	// when the C code triggers the callbacks or events.
-	if deliveryChan != nil || opaque != nil {
-		cgoid = p.handle.cgoPut(cgoDr{deliveryChan: deliveryChan, opaque: opaque})
+	if deliveryChan != nil || msg.Opaque != nil {
+		cgoid = p.handle.cgoPut(cgoDr{deliveryChan: deliveryChan, opaque: msg.Opaque})
 	}
 
 	r := int(C.do_produce(crkt, C.int32_t(msg.TopicPartition.Partition),
@@ -116,8 +116,8 @@ func (p *Producer) produce(msg *Message, msgFlags int, deliveryChan chan Event,
 // The delivery report will be sent on the provided deliveryChan if specified,
 // or on the Producer object's Events channel if not.
 // Returns an error if message could not be enqueued.
-func (p *Producer) Produce(msg *Message, deliveryChan chan Event, opaque interface{}) error {
-	return p.produce(msg, 0, deliveryChan, opaque)
+func (p *Producer) Produce(msg *Message, deliveryChan chan Event) error {
+	return p.produce(msg, 0, deliveryChan)
 }
 
 // Produce a batch of messages.
@@ -262,7 +262,7 @@ func NewProducer(conf *ConfigMap) (*Producer, error) {
 func channelProducer(p *Producer) {
 
 	for m := range p.ProduceChannel {
-		err := p.produce(m, C.RD_KAFKA_MSG_F_BLOCK, nil, nil)
+		err := p.produce(m, C.RD_KAFKA_MSG_F_BLOCK, nil)
 		if err != nil {
 			m.TopicPartition.Error = err
 			p.Events <- m
diff --git a/kafka/producer_performance_test.go b/kafka/producer_performance_test.go
@@ -149,7 +149,7 @@ func BenchmarkProducerFunc(b *testing.B) {
 	producerPerfTest(b, "Function producer (without DR)",
 		0, false, false, false,
 		func(p *Producer, m *Message, drChan chan Event) {
-			err := p.Produce(m, drChan, nil)
+			err := p.Produce(m, drChan)
 			if err != nil {
 				b.Errorf("Produce() failed: %v", err)
 			}
@@ -160,7 +160,7 @@ func BenchmarkProducerFuncDR(b *testing.B) {
 	producerPerfTest(b, "Function producer (with DR)",
 		0, true, false, false,
 		func(p *Producer, m *Message, drChan chan Event) {
-			err := p.Produce(m, drChan, nil)
+			err := p.Produce(m, drChan)
 			if err != nil {
 				b.Errorf("Produce() failed: %v", err)
 			}
diff --git a/kafka/producer_test.go b/kafka/producer_test.go
@@ -40,22 +40,25 @@ func TestProducerAPIs(t *testing.T) {
 	// Produce with function, DR on passed drChan
 	err = p.Produce(&Message{TopicPartition: TopicPartition{Topic: &topic1, Partition: 0},
 		Value: []byte("Own drChan"), Key: []byte("This is my key")},
-		drChan, nil)
+		drChan)
 	if err != nil {
 		t.Errorf("Produce failed: %s", err)
 	}
 
 	// Produce with function, use default DR channel (Events)
 	err = p.Produce(&Message{TopicPartition: TopicPartition{Topic: &topic2, Partition: 0},
 		Value: []byte("Events DR"), Key: []byte("This is my key")},
-		nil, nil)
+		nil)
 	if err != nil {
 		t.Errorf("Produce failed: %s", err)
 	}
 
-	// Produce through ProducerChannel, uses default DR channel (Events)
+	// Produce through ProducerChannel, uses default DR channel (Events),
+	// pass Opaque object.
+	myOpq := "My opaque"
 	p.ProduceChannel <- &Message{TopicPartition: TopicPartition{Topic: &topic2, Partition: 0},
-		Value: []byte("ProducerChannel"), Key: []byte("This is my key")}
+		Opaque: &myOpq,
+		Value:  []byte("ProducerChannel"), Key: []byte("This is my key")}
 
 	// Len() will not report messages on private delivery report chans (our drChan for example),
 	// so expect at least 2 messages, not 3.
@@ -86,6 +89,22 @@ func TestProducerAPIs(t *testing.T) {
 		switch e := ev.(type) {
 		case *Message:
 			msgCnt++
+			if (string)(e.Value) == "ProducerChannel" {
+				s := e.Opaque.(*string)
+				if s != &myOpq {
+					t.Errorf("Opaque should point to %v, not %v", &myOpq, s)
+				}
+				if *s != myOpq {
+					t.Errorf("Opaque should be \"%s\", not \"%v\"",
+						myOpq, *s)
+				}
+				t.Logf("Message \"%s\" with opaque \"%s\"\n",
+					(string)(e.Value), *s)
+			} else {
+				if e.Opaque != nil {
+					t.Errorf("Message opaque should be nil, not %v", e.Opaque)
+				}
+			}
 		default:
 			t.Logf("Ignored event %s", e)
 		}
diff --git a/kafkatest/go_verifiable_producer/go_verifiable_producer.go b/kafkatest/go_verifiable_producer/go_verifiable_producer.go
@@ -136,7 +136,7 @@ func runProducer(config *kafka.ConfigMap, topic string) {
 				TopicPartition: kafka.TopicPartition{
 					Topic:     &topic,
 					Partition: kafka.PartitionAny},
-				Value: []byte(value)}, nil, nil)
+				Value: []byte(value)}, nil)
 			if err != nil {
 				fmt.Fprintf(os.Stderr, "%% Produce failed: %v\n", err)
 				state.errCnt++
