feat: add protons extension #14505
Closed
feat: add protons extension #14505
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds an extension id to the registry for use by the [protons](https://www.npmjs.com/package/protons) protobuf encoder/decoder.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
achingbrain
added a commit
to ipfs/protons
that referenced
this pull request
Oct 23, 2023
Adds the capability to define protons-specific custom options that
control decoding behaviour initially around limiting the sizes of
maps and lists.
```protobuf
// import the options definition - it will work without this but some
// code editor plugins may report an error if the def can't be found
import "protons-rutime/options.proto";
message MessageWithSizeLimitedRepeatedField {
// define the size limit - here more than 10 repeated items will
// cause decoding to fail
repeated string repeatedField = 1 [(protons.limit) = 10];
}
```
The defintion is shipped with the `protons-runtime` module. There is
a [pending PR](protocolbuffers/protobuf#14505)
to reserve the `1186` field ID. This should be merged first and/or
the field ID updated here if it changes due to that PR.
Fixes #113
esrauchg
added
the
🅰️ safe for tests
github-actions
bot
removed
the
🅰️ safe for tests
|
@acozzette @fowles sorry to ping you directly but it looks like you've recently merged PRs that add extension number reservations - what needs to happen for this to be merged? |
acozzette
approved these changes
Oct 27, 2023
|
@acozzette thanks for approving! It looks like there's an internal check that failed so it wasn't merged? I can't access the "Details" link, it must be some internal Google thing? |
|
@achingbrain Sorry for the delay, I was able to get it unstuck so that it has now been submitted. |
|
That's great, thanks so much |
achingbrain
added a commit
to ipfs/protons
that referenced
this pull request
Nov 1, 2023
Adds the capability to define protons-specific custom options that control decoding behaviour initially around limiting the sizes of maps and lists.
```protobuf
// import the options definition - it will work without this but some
// code editor plugins may report an error if the def can't be found
import "protons.proto";
message Message {
// define the size limit - here more than 10 repeated items will
// cause decoding to fail
repeated string repeatedField = 1 [(protons.options).limit = 10];
}
```
The definition is shipped with the `protons-runtime` module. There is a [pending PR](protocolbuffers/protobuf#14505) to reserve the `1186` field ID. This should be merged first and/or the field ID updated here if it changes due to that PR.
Fixes #113
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds an extension id to the registry for use by the protons protobuf encoder/decoder.