Add metadata to StreamConfig and ConsumerConfig #3797
Merged
+108
−0
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
wallyqs
reviewed
Jan 23, 2023
|
@wallyqs PR updated to include limits we agreed upon in ADR. |
Jarema
force-pushed
the
jarema/add-metadata-to-streams-and-consumers
branch
3 times, most recently
from
604f736
to
81c759d
Compare
wallyqs
reviewed
Jan 24, 2023
| metadataLen += len(k) + len(v) | ||
| } | ||
| if metadataLen > JSMaxMetadataLen { | ||
| return NewJSConsumerMetadataLengthError(fmt.Sprintf("%dKB", JSMaxMetadataLen/1024)) |
There was a problem hiding this comment.
I prefer to be as transparent as possible on the server side and add sanity checks on the client side (according to client).
There was a problem hiding this comment.
empty keys are persisted but seems benign to support that
There was a problem hiding this comment.
yeah, I think we can leave it as it is.
wallyqs
reviewed
Jan 24, 2023
server/jetstream_errors_generated.go
Outdated
| @@ -446,6 +449,7 @@ var ( | |||
| JSConsumerMaxRequestBatchNegativeErr: {Code: 400, ErrCode: 10114, Description: "consumer max request batch needs to be > 0"}, | |||
| JSConsumerMaxRequestExpiresToSmall: {Code: 400, ErrCode: 10115, Description: "consumer max request expires needs to be >= 1ms"}, | |||
| JSConsumerMaxWaitingNegativeErr: {Code: 400, ErrCode: 10087, Description: "consumer max waiting needs to be positive"}, | |||
| JSConsumerMetadataLengthErrF: {Code: 400, ErrCode: 10134, Description: "Consumer metadata exceeds maximum size of {limit}"}, | |||
There was a problem hiding this comment.
Suggested change
| JSConsumerMetadataLengthErrF: {Code: 400, ErrCode: 10134, Description: "Consumer metadata exceeds maximum size of {limit}"}, | |
| JSConsumerMetadataLengthErrF: {Code: 400, ErrCode: 10134, Description: "consumer metadata exceeds maximum size of {limit}"}, |
There was a problem hiding this comment.
casing issue here, the error below has the same issue though...
wallyqs
reviewed
Jan 24, 2023
| @@ -446,6 +449,7 @@ var ( | |||
| JSConsumerMaxRequestBatchNegativeErr: {Code: 400, ErrCode: 10114, Description: "consumer max request batch needs to be > 0"}, | |||
| JSConsumerMaxRequestExpiresToSmall: {Code: 400, ErrCode: 10115, Description: "consumer max request expires needs to be >= 1ms"}, | |||
| JSConsumerMaxWaitingNegativeErr: {Code: 400, ErrCode: 10087, Description: "consumer max waiting needs to be positive"}, | |||
| JSConsumerMetadataLengthErrF: {Code: 400, ErrCode: 10134, Description: "Consumer metadata exceeds maximum size of {limit}"}, | |||
| JSConsumerNameContainsPathSeparatorsErr: {Code: 400, ErrCode: 10127, Description: "Consumer name can not contain path separators"}, | |||
There was a problem hiding this comment.
Suggested change
| JSConsumerNameContainsPathSeparatorsErr: {Code: 400, ErrCode: 10127, Description: "Consumer name can not contain path separators"}, | |
| JSConsumerNameContainsPathSeparatorsErr: {Code: 400, ErrCode: 10127, Description: "consumer name can not contain path separators"}, |
wallyqs
reviewed
Jan 26, 2023
server/consumer.go
Outdated
| @@ -94,6 +94,9 @@ type ConsumerConfig struct { | |||
|
|
|||
| // Don't add to general clients. | |||
| Direct bool `json:"direct,omitempty"` | |||
|
|
|||
| // Additional metadata for the Consumer. | |||
There was a problem hiding this comment.
Suggested change
| // Additional metadata for the Consumer. | |
| // Metadata is additional metadata for the Consumer. |
wallyqs
reviewed
Jan 26, 2023
server/stream.go
Outdated
| @@ -80,6 +80,9 @@ type StreamConfig struct { | |||
| // AllowRollup allows messages to be placed into the system and purge | |||
| // all older messages using a special msg header. | |||
| AllowRollup bool `json:"allow_rollup_hdrs"` | |||
|
|
|||
| // Additional metadata for the Stream. | |||
There was a problem hiding this comment.
Suggested change
| // Additional metadata for the Stream. | |
| // Metadata is additional metadata for the Stream. |
There was a problem hiding this comment.
ah, good point. Fixed both.
We should do a sweep through comments and enable lint for that.
Jarema
force-pushed
the
jarema/add-metadata-to-streams-and-consumers
branch
3 times, most recently
from
ee0b82e
to
6d482a8
Compare
Signed-off-by: Tomasz Pietrek <tomasz@nats.io>
Jarema
force-pushed
the
jarema/add-metadata-to-streams-and-consumers
branch
from
6d482a8
to
9ab52d4
Compare
15 tasks
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
Metadatafield toConsumerConfigandStreamConfig, allowing for a convenient way of adding additional information to those, better than usingDescription.When merged, will follow up with ADR for clients.
Signed-off-by: Tomasz Pietrek tomasz@nats.io
/cc @nats-io/core