Update generated service and client class names to better handle well-named services #6
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
Protobuf services should end in "Service". This is a buf lint rule - https://github.com/bufbuild/buf-examples/blob/main/linting/bad/acme/weather/v1/weather.proto#L39 - and recommended via the protobuf style guide - https://protobuf.dev/programming-guides/style/#services
``` ./spec/support/create_fixture -b -f well_named_service_code_gen_request_pb.bin ./spec/fixtures/well_named_service.proto ```
This makes room for us to add additional `context`s, while keeping the spec file organized and separating the main `process` specs from the other helper methods.
Only append "Service" to the generated service class name when services are not properly named. This change avoids generating class names such as `MessagesServiceService`. Strip a trailing "Service" from the service for better readability of the generated client class name. This avoids generating class names such as `HelloWorldServiceClient`.
```bash protoc --plugin=protoc-gen-twirp_ruby=./exe/protoc-gen-twirp_ruby --ruby_out=. --twirp_ruby_out=. ./example/hello_world.proto ``` This further demonstrates that the "ServiceService" issue is fixed.
darronschall
force-pushed
the
improve-naming-for-well-named-services
branch
from
b33e12b
to
56f03a6
Compare
danielmorrison
approved these changes
May 10, 2024
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.
This changes mirrors the change I submitted to the original go twirp protoc plugin at arthurnn/twirp-ruby#97
Only append "Service" to the generated service class name when services are not properly named. This change avoids generating class names such as
MessagesServiceService.Strip a trailing "Service" from the service for better readability of the generated client class name. This avoids generating class names such as
HelloWorldServiceClient.