Repository navigation
gorumsimpl: correct exported call API contracts - #430
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
A critical active issue remains because the template update leaves fixture golden outputs stale, causing TestGoldenProtoFiles to fail until the goldens are regenerated.
1 open issue
11 files not reviewed
benchkit/benchmark/benchmark_gorums.pb.go: Generated filebenchkit/control_gorums.pb.go: Generated filecmd/protoc-gen-gorums/dev/zorums_client_gorums.pb.go: Generated fileexamples/storage/proto/storage_gorums.pb.go: Generated fileinternal/tests/correctable/correctable_gorums.pb.go: Generated fileinternal/tests/metadata/metadata_gorums.pb.go: Generated fileinternal/tests/multiservice/multiservice_gorums.pb.go: Generated fileinternal/tests/oneway/oneway_gorums.pb.go: Generated fileinternal/tests/ordering/ordering_gorums.pb.go: Generated fileinternal/tests/tls/tls_gorums.pb.go: Generated fileinternal/tests/unresponsive/unresponsive_gorums.pb.go: Generated file
What changed in this PR
This PR corrects Gorums runtime and generated-client documentation to reflect lazy call dispatch and deferred error reporting for empty configurations and nil nodes. It also regenerates checked-in generated clients.
Changes:
- Clarifies lazy dispatch and
ErrEmptyConfigbehavior in runtime call comments. - Updates the client generator template to distinguish call handles from immediate errors.
- Refreshes generated client documentation across tests, examples, development output, and benchmarks.
- The generator golden fixtures still contain the previous comments, so
TestGoldenProtoFileswill fail until they are regenerated.
| File | Description |
|---|---|
runtime/gorumsimpl/call.go |
Documents lazy dispatch and empty-configuration error behavior. |
internal/tests/unresponsive/unresponsive_gorums.pb.go |
Updates generated node-client documentation. |
internal/tests/tls/tls_gorums.pb.go |
Updates generated node-client documentation. |
internal/tests/ordering/ordering_gorums.pb.go |
Updates generated configuration and node-client documentation. |
internal/tests/oneway/oneway_gorums.pb.go |
Updates generated multicast and unicast documentation. |
internal/tests/multiservice/multiservice_gorums.pb.go |
Updates generated documentation for both services. |
internal/tests/metadata/metadata_gorums.pb.go |
Updates generated node-client documentation. |
internal/tests/correctable/correctable_gorums.pb.go |
Updates generated configuration-client documentation. |
examples/storage/proto/storage_gorums.pb.go |
Updates generated storage client documentation. |
cmd/protoc-gen-gorums/gengorums/template_client.go |
Updates generated configuration and node-client interface comments. |
cmd/protoc-gen-gorums/dev/zorums_client_gorums.pb.go |
Updates generated development client documentation. |
benchkit/control_gorums.pb.go |
Updates generated control-client documentation. |
benchkit/benchmark/benchmark_gorums.pb.go |
Updates generated benchmark-client documentation. |
Review effort: Lite
meling
force-pushed
the
fix/425/call-api-contracts
branch
from
November 1, 2026 21:55
35a1706 to
92b7694
Compare
meling
force-pushed
the
fix/425/call-api-contracts
branch
from
November 2, 2026 15:55
92b7694 to
ff07329
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.

Closes #425.
Correct the runtime call comments to describe lazy dispatch and ErrEmptyConfig instead of a panic.
Update the generated client interface comments to distinguish handles from immediate errors, and regenerate the checked-in clients.
Validation: focused generator tests, make modernize, and make goplscheck pass.