Add EventStreamPosition envelope extension#148
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a canonical envelopepb.EventStreamPosition protobuf message for recording stream ID + offset as an envelope extension, and adds post-pack mutation/access helpers for Body extensions and baggage.
Changes:
- Added
EventStreamPositionmessage (plus generated Go/primo code) to standardize stream position encoding inBody.Extensions. - Added generic
SetExtension/GetExtensionandSetBaggage/GetBaggagehelpers, with accompanying tests. - Updated
CHANGELOG.mdto document the new APIs and message type.
Reviewed changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| protobuf/envelopepb/packer.go | Moves flattenAnyValues() into packer to support normalization logic. |
| protobuf/envelopepb/extensions.proto | Defines EventStreamPosition extension message. |
| protobuf/envelopepb/extensions.pb.go | Generated Go code for EventStreamPosition. |
| protobuf/envelopepb/extensions_primo.pb.go | Generated primo builder/helpers for EventStreamPosition. |
| protobuf/envelopepb/extensions.go | Adds SetExtension/GetExtension helpers for Body.Extensions. |
| protobuf/envelopepb/extensions_test.go | Tests for the new extension helpers. |
| protobuf/envelopepb/baggage.go | Adds SetBaggage/GetBaggage helpers for Body.Baggage. |
| protobuf/envelopepb/baggage_test.go | Tests for the new baggage helpers. |
| CHANGELOG.md | Documents the new helpers and EventStreamPosition. |
Files not reviewed (2)
- protobuf/envelopepb/extensions.pb.go: Language not supported
- protobuf/envelopepb/extensions_primo.pb.go: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jmalloc
added a commit
that referenced
this pull request
May 12, 2026
Changed the parameter type from proto.Message to the generic type argument T, so the runtime type and the type argument cannot disagree at compile time. Go can now infer T from the value at most call sites, removing the explicit type annotation. A direct nil check on the typed parameter now catches typed-nil pointers that previously slipped past marshalAsAny's interface-nil check. Updated GetExtension/GetBaggage doc comments to match the implementation: the bool return value indicates whether an extension/baggage value of the matching type was present; the error return value carries the unmarshal outcome separately. Addresses Copilot review feedback on #148. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Adds envelopepb.EventStreamPosition — a canonical extension message that identifies the stream from which an event was obtained and its offset within that stream — so event store implementations no longer have to invent ad-hoc encodings (e.g. wrapperspb.UInt64Value or fabricated anypb.Any TypeUrls) to attach the position to an envelope after recording. Adds generic envelopepb.SetExtension[T] / GetExtension[T] and the symmetric SetBaggage[T] / GetBaggage[T] for attaching and reading extensions and baggage values on an envelopepb.Body after packing. Previously only the pack-time WithExtension / WithBaggage options were exported. Closes #147. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Changed the parameter type from proto.Message to the generic type argument T, so the runtime type and the type argument cannot disagree at compile time. Go can now infer T from the value at most call sites, removing the explicit type annotation. A direct nil check on the typed parameter now catches typed-nil pointers that previously slipped past marshalAsAny's interface-nil check. Updated GetExtension/GetBaggage doc comments to match the implementation: the bool return value indicates whether an extension/baggage value of the matching type was present; the error return value carries the unmarshal outcome separately. Addresses Copilot review feedback on #148. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Use SetExtension[*Type](body, nil) instead of the more verbose SetExtension(body, (*Type)(nil)). With T specified explicitly the nil literal takes on the parameter's typed-nil interpretation, which is exactly the case the panic check is designed to catch. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
jmalloc
force-pushed
the
event-stream-position-extension
branch
from
a57f9bd to
33be67e
Compare
This file contains hidden or 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
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.
Summary
envelopepb.EventStreamPosition, a canonical extension message carryingstream_id+offset, so event store implementations no longer need ad-hoc encodings (e.g.wrapperspb.UInt64Valueor fabricatedanypb.Anytype URLs) to attach a stream position to an envelope after recording.envelopepb.SetExtension[T]/GetExtension[T]and symmetricSetBaggage[T]/GetBaggage[T]for post-pack mutation of extension/baggage values on anenvelopepb.Body. Previously only the pack-timeWithExtension/WithBaggageoptions were exported.Test plan