Skip to content

gorumsimpl: correct exported call API contracts - #430

Merged
meling merged 3 commits into
masterfrom
fix/425/call-api-contracts
Nov 2, 2026
Merged

meling merged 3 commits into
masterfrom
fix/425/call-api-contracts

Conversation

@meling

@meling meling commented Nov 1, 2026

Copy link
Copy Markdown
Member

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.

Copilot AI lite review requested due to automatic review settings November 1, 2026 21:40

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 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 file
  • benchkit/control_gorums.pb.go: Generated file
  • cmd/protoc-gen-gorums/dev/zorums_client_gorums.pb.go: Generated file
  • examples/storage/proto/storage_gorums.pb.go: Generated file
  • internal/tests/correctable/correctable_gorums.pb.go: Generated file
  • internal/tests/metadata/metadata_gorums.pb.go: Generated file
  • internal/tests/multiservice/multiservice_gorums.pb.go: Generated file
  • internal/tests/oneway/oneway_gorums.pb.go: Generated file
  • internal/tests/ordering/ordering_gorums.pb.go: Generated file
  • internal/tests/tls/tls_gorums.pb.go: Generated file
  • internal/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 ErrEmptyConfig behavior 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 TestGoldenProtoFiles will 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
meling force-pushed the fix/425/call-api-contracts branch from 92b7694 to ff07329 Compare November 2, 2026 15:55
@meling
meling merged commit 2383c4a into master Nov 2, 2026
3 checks passed
@meling
meling deleted the fix/425/call-api-contracts branch November 2, 2026 16:48
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.

doc: correct exported call API contracts

2 participants