add grpc protocol. #984

morvencao · 2023-11-09T13:01:03Z

resolve: #980

morvencao · 2023-11-10T01:45:55Z

duglin · 2023-11-10T14:52:42Z

protocol/grpc/write_message.go

+		if value == nil {
+			delete(b.Attributes, contenttype)
+		}
+		b.Attributes[contenttype], _ = attributeFor(value)


Why do we delete the item from the map just to then re-add it here with nil ? Seems like this should be under an else or just remove the if+delete on lines 126-128. Same for below

good catch, added else to handle non-nil case.

duglin · 2023-11-10T15:01:27Z

protocol/grpc/message.go

+					return err
+				}
+			}
+		} else if name == contenttype {


what if there's both 'contenttype' and 'ce-datacontenttype' ?

'ce-datacontenttype' will be handled by:

sdk-go/protocol/grpc/message.go

Lines 122 to 128 in ab07228

if strings.HasPrefix(name, prefix) {

attr := m.version.Attribute(name)

if attr != nil {

err = encoder.SetAttribute(attr, attrVal)

if err != nil {

return err

}

yes but which one wins? Should we require them to be the same (if both are there)?

When both 'ce-datacontenttype' and 'contenttype' are set, 'ce-datacontenttype' takes precedence. In practical scenarios, only 'contenttype' is necessary. Check how the 'contenttype' attribute is configured here:

sdk-go/protocol/grpc/write_message.go

Lines 121 to 130 in 6523960

case spec.DataContentType:

if value == nil {

delete(b.Attributes, contenttype)

} else {

attrVal, err := attributeFor(value)

if err != nil {

return err

}

b.Attributes[contenttype] = attrVal

}

This follow the similar approach that the Kafka protocol and PubSub protocol take, refer to the implementations in the CloudEvents SDK for Kafka (https://github.com/cloudevents/sdk-go/blob/main/protocol/kafka_sarama/v2/write_producer_message.go#L103-L114) and PubSub (https://github.com/cloudevents/sdk-go/blob/main/protocol/pubsub/v2/write_pubsub_message.go#L70-L80).

duglin · 2023-11-10T15:15:23Z

protocol/grpc/write_message.go

+			delete(b.Attributes, prefix+time)
+		}
+		b.Attributes[prefix+time], _ = attributeFor(value)
+		return nil


Nit: you can remove all of these "return nil" lines since it'll happen due to the return on line 156

thanks, done.

duglin · 2023-11-10T15:16:02Z

protocol/grpc/write_message.go

+
+	b.Attributes[prefix+name], err = attributeFor(value)
+
+	return


Let's define 'err' in the func instead of in the return arg - just for consistency

duglin · 2023-11-10T15:18:01Z

I see we have a sample, but can we get some testcases too?

duglin · 2023-11-10T15:18:31Z

unit tests are failing

morvencao

Added some test cases, PTAL @duglin @lionelvillard

duglin · 2023-12-06T15:03:50Z

@morvencao can you take a look at the failing checks?

morvencao · 2023-12-07T07:07:25Z

@duglin I've resolved the issues with testing and successfully executed it on my local environment, passing all tests.
I kindly request your approval to proceed with running the tests once more.

yanmxa · 2023-12-07T08:07:19Z

binding/format/protobuf/v2/pb/cloudevent.pb.go

@@ -7,7 +7,8 @@
 package pb

 import (
-	any "github.com/golang/protobuf/ptypes/any"
+	any1 "github.com/golang/protobuf/ptypes/any"


Why replace any with any1? Is this intentional？

This code is generated by proto compiler, not manually altered.

I suspect it does this since any is now a data type in go

yanmxa · 2023-12-07T08:37:28Z

binding/format/protobuf/v2/pb/cloudevent_grpc.pb.go

+// CloudEventServiceClient is the client API for CloudEventService service.
+//
+// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
+type CloudEventServiceClient interface {


The Publish-subscribe model has the characteristics: The publisher sends events without specifically targeting any recipient. Subscribers express interest in certain types of messages and receive notifications or updates when messages of interest are published.

In my opinion, the gRPC does not explicitly refer to the publish-subscribe model. Instead, it resembles more of a request-response model, like the HTTP protocol. So I suggest aligning these interfaces with the http protocol.

duglin · 2023-12-07T13:40:33Z

protocol/kafka_sarama/v2/coverage.tmp

@@ -1 +0,0 @@
-mode: atomic


please delete this file?

I did delete the file. but I'm unsure if we should do that.
Based on the UT script at https://github.com/cloudevents/sdk-go/blob/main/hack/unit-test.sh#L20, it seems that coverage.tmp is produced as intermediate output by UT. Deleting it should pose no harm.

I can restore it if there are additional uses that I overlooked.

morvencao · 2023-12-11T03:08:44Z

fixed the testing and rebased the code.

duglin · 2024-01-30T14:39:24Z

rebase is needed

Signed-off-by: morvencao <[email protected]>

morvencao force-pushed the br_add_grpc_protocol branch from 44f145a to 8286859 Compare November 9, 2023 13:03

morvencao force-pushed the br_add_grpc_protocol branch from 376249c to ca8841e Compare November 10, 2023 07:33

duglin reviewed Nov 10, 2023

View reviewed changes

morvencao force-pushed the br_add_grpc_protocol branch from ca8841e to d4ad609 Compare November 13, 2023 06:00

morvencao requested a review from duglin November 13, 2023 08:44

morvencao commented Nov 13, 2023

View reviewed changes

morvencao force-pushed the br_add_grpc_protocol branch from ab07228 to f719045 Compare November 21, 2023 02:03

yanmxa reviewed Dec 7, 2023

View reviewed changes

duglin reviewed Dec 7, 2023

View reviewed changes

morvencao force-pushed the br_add_grpc_protocol branch 2 times, most recently from 4ea25db to 8f12cd7 Compare December 11, 2023 03:08

morvencao added 7 commits January 31, 2024 01:49

add grpc protocol.

6b2f72e

Signed-off-by: morvencao <[email protected]>

fix protobuf testing.

ffaf1ee

Signed-off-by: morvencao <[email protected]>

add gRPC sample.

f0f68fb

Signed-off-by: morvencao <[email protected]>

disable debug log.

f4164af

Signed-off-by: morvencao <[email protected]>

update publish interface.

7b9d505

Signed-off-by: morvencao <[email protected]>

fix ut.

33af376

Signed-off-by: morvencao <[email protected]>

fix testing.

9dcecb3

Signed-off-by: morvencao <[email protected]>

morvencao force-pushed the br_add_grpc_protocol branch from 8f12cd7 to 9dcecb3 Compare January 31, 2024 01:51

k1rill-dev approved these changes Sep 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add grpc protocol. #984

add grpc protocol. #984

morvencao commented Nov 9, 2023

morvencao commented Nov 10, 2023

duglin Nov 10, 2023

morvencao Nov 13, 2023

duglin Nov 10, 2023

morvencao Nov 13, 2023

duglin Dec 7, 2023

morvencao Dec 7, 2023

duglin Nov 10, 2023

morvencao Nov 13, 2023

duglin Nov 10, 2023

morvencao Nov 13, 2023

duglin commented Nov 10, 2023

duglin commented Nov 10, 2023

morvencao left a comment •

edited

Loading

duglin commented Dec 6, 2023

morvencao commented Dec 7, 2023

yanmxa Dec 7, 2023

morvencao Dec 7, 2023

duglin Dec 7, 2023

yanmxa Dec 7, 2023 •

edited

Loading

duglin Dec 7, 2023 •

edited

Loading

morvencao Dec 7, 2023 •

edited

Loading

morvencao Dec 7, 2023

morvencao commented Dec 11, 2023

duglin commented Jan 30, 2024

	if strings.HasPrefix(name, prefix) {
	attr := m.version.Attribute(name)
	if attr != nil {
	err = encoder.SetAttribute(attr, attrVal)
	if err != nil {
	return err
	}

	case spec.DataContentType:
	if value == nil {
	delete(b.Attributes, contenttype)
	} else {
	attrVal, err := attributeFor(value)
	if err != nil {
	return err
	}
	b.Attributes[contenttype] = attrVal
	}

add grpc protocol. #984

Are you sure you want to change the base?

add grpc protocol. #984

Conversation

morvencao commented Nov 9, 2023

morvencao commented Nov 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

duglin commented Nov 10, 2023

duglin commented Nov 10, 2023

morvencao left a comment • edited Loading

Choose a reason for hiding this comment

duglin commented Dec 6, 2023

morvencao commented Dec 7, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yanmxa Dec 7, 2023 • edited Loading

Choose a reason for hiding this comment

duglin Dec 7, 2023 • edited Loading

Choose a reason for hiding this comment

morvencao Dec 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

morvencao commented Dec 11, 2023

duglin commented Jan 30, 2024

morvencao left a comment •

edited

Loading

yanmxa Dec 7, 2023 •

edited

Loading

duglin Dec 7, 2023 •

edited

Loading

morvencao Dec 7, 2023 •

edited

Loading