Skip to content

Add support for binary mode using NATS headers - #1016

Merged
duglin merged 3 commits into
cloudevents:mainfrom
bruth:nats-protocol-binding-headers
May 19, 2022
Merged

duglin merged 3 commits into
cloudevents:mainfrom
bruth:nats-protocol-binding-headers

Conversation

@bruth

@bruth bruth commented May 11, 2022 •

Copy link
Copy Markdown
Contributor

Fixes #975 #1006

Release Note

For users of NATS server 2.2 or above, the binary content mode is now available
which encodes required, optional, and extension event attributes in the message
header rather than encoded in the payload.

Reviewer Notes

  • I removed the trailing period for the numerical sections, apologies if that was intended and I will add them back
  • In terms of field and value encoding, NATS headers follow the HTTP spec. For the sections that talked about the names and values I copied the relevant sections from the HTTP protocol binding doc, however another option could be to link to them to remove the redundancy.

/cc @derekcollison @duglin

Headers were introduced in the NATS 2.2 release.

Signed-off-by: Byron Ruth <b@devel.io>
@bruth

bruth commented May 11, 2022

Copy link
Copy Markdown
Contributor Author

@ColinSullivan1 Totally missed seeing the discussion in #975. If you or your team has a draft in place already I can close this, otherwise happy for this to be a starting point for edits.

@@ -1,4 +1,4 @@
# NATS Protocol Binding for CloudEvents - Version 1.0.3-wip
# NATS Protocol Binding for CloudEvents - Version 1.0.4-wip

@duglin duglin May 11, 2022 •

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the version remains the same since we're still technically in the 1.0.3 cycle.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted.

@duglin

duglin commented May 11, 2022

Copy link
Copy Markdown
Collaborator

@bruth thanks! I don't know NATS but it looks pretty good (and thorough) to me. I think the href checker errors are real though.

Signed-off-by: Byron Ruth <b@devel.io>
@bruth

bruth commented May 11, 2022

Copy link
Copy Markdown
Contributor Author

@duglin Thanks for the quick review. I fixed the links.

Signed-off-by: Byron Ruth <b@devel.io>
@ColinSullivan1

Copy link
Copy Markdown
Contributor

@bruth, much appreciated - thank you! We had this on our list of TODO items but didn't get to this yet. LGTM!

@bruth

bruth commented May 12, 2022

Copy link
Copy Markdown
Contributor Author

@ColinSullivan1 happy to help, thanks for the review!

@bruth

bruth commented May 13, 2022

Copy link
Copy Markdown
Contributor Author

@duglin No rush, but is there anything remaining to do to get this merged?

@duglin

duglin commented May 13, 2022

Copy link
Copy Markdown
Collaborator

Nope - just need approval from the group. We normally approve PRs on the Thursday calls but we also allow for at least 3 days of review and this one just missed the deadline for this week's call. So unless something big shows up I expect it to be approved next Thursday. You can see it on the agenda here: https://docs.google.com/document/d/1OVF68rpuPK5shIHILK9JOqlZBbfe91RNzQ7u_P7YCDE/edit#

@bruth

bruth commented May 13, 2022 via email

Copy link
Copy Markdown
Contributor Author

@duglin

duglin commented May 17, 2022

Copy link
Copy Markdown
Collaborator

@cloudevents/notify please review in prep for Thursday's call.

@duglin

duglin commented May 19, 2022

Copy link
Copy Markdown
Collaborator

Approved on the 5/19 call
thanks @bruth

@duglin
duglin merged commit c71e4fe into cloudevents:main May 19, 2022
@bruth

bruth commented May 20, 2022

Copy link
Copy Markdown
Contributor Author

@duglin Great thanks!

@bruth
bruth deleted the nats-protocol-binding-headers branch May 20, 2022 14:03
clemensv pushed a commit to clemensv/spec that referenced this pull request Aug 19, 2022
* Add support for binary mode using NATS headers

Headers were introduced in the NATS 2.2 release.

Signed-off-by: Byron Ruth <b@devel.io>

* Address href errors and revert version bump

Signed-off-by: Byron Ruth <b@devel.io>

* Add missing href

Signed-off-by: Byron Ruth <b@devel.io>
shafqatevo pushed a commit to shafqatevo/spec that referenced this pull request Aug 7, 2026
* Add support for binary mode using NATS headers

Headers were introduced in the NATS 2.2 release.

Signed-off-by: Byron Ruth <b@devel.io>

* Address href errors and revert version bump

Signed-off-by: Byron Ruth <b@devel.io>

* Add missing href

Signed-off-by: Byron Ruth <b@devel.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants