Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change Namespace data map to contain bytes #361

Closed
wants to merge 1 commit into from

Conversation

tdeebswihart
Copy link
Contributor

What changed?
The namespace data map now has bytes values rather than string.

Why?

We embed binary data (cast to strings) here in a few places, and that can cause google/protobuf to yell at us for having string data that's invalid UTF-8. Protobuf strings and bytes are wire-compatible

Breaking changes

This will change all code generated by protoc plugins to use the language's type for raw bytes. I have paired Go API and server PRs that will go along with this change

@tdeebswihart tdeebswihart requested review from a team as code owners March 5, 2024 19:33
Copy link
Member

@cretz cretz left a comment

Choose a reason for hiding this comment

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

Not the biggest fan of breaking API compat even for these rarely used APIs, but I understand the reasoning.

You'll have to disable the buf compat detector.

@yycptt
Copy link
Member

yycptt commented Mar 6, 2024

we are ok with the breaking change for customer when they upgrade sdk?

@yycptt
Copy link
Member

yycptt commented Mar 6, 2024

Is there a reason we are just fixing this specific field? I think the same thing could happen to, for example, the memo field.

@tdeebswihart
Copy link
Contributor Author

We've decided to axe this and migrate the relevant fields internally

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.

4 participants