Add an underscore between generated service name and component #2072
Conversation
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
Motivation:
A 'bar' package defining a 'FooService' service will have a number of types
generateed for it, for example, `Bar_FooServiceServiceProtocol`, or
`Bar_FooServiceClient`. The protocol buffers style guide reccomends that
services are suffixed with "Service" (e.g. "FooService", not "Foo")
which results in some strange protocol names (like
`Bar_FooServiceServiceProtocol`).
There should be a clearer differentiation between the qualified service
name ("bar.FooServce") and the type being generated. The code generator
already replaces "." with "_" in fully qualified names, so "_" is a
natural choice as a separator.
Modifications:
- Add an "_" between the generated fully qualified service name and the
gRPC component being generated
- Update tests
Result:
Better names in generated code.
The `Bar_FooServiceServiceProtocol` example above becomes
`Bar_FooService_ServiceProtocol`, while `Bar_FooServiceClient` becomes
`Bar_FooService_Client`.
gjcairo
approved these changes
Sep 25, 2024
There was a problem hiding this comment.
LGTM - thanks George! This reads much more clearly.
A super nit for posterity, not really about the change itself: the underscore in the PR description is being rendered as markdown/italics 😅 can you escape it so it reads better if someone comes looking in the future?
glbrntt
added a commit
to glbrntt/grpc-swift
that referenced
this pull request
Sep 25, 2024
Motivation: In grpc#2072 the code gen was changed to add an underscore to the generated names. This wasn't picked up in CI because the examples depend on "main" at the moment. Modifications: - Update examples Result: CI passes
Merged
glbrntt
added a commit
that referenced
this pull request
Sep 25, 2024
Motivation: In #2072 the code gen was changed to add an underscore to the generated names. This wasn't picked up in CI because the examples depend on "main" at the moment. Modifications: - Update examples Result: CI passes
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Motivation:
A 'bar' package defining a 'FooService' service will have a number of types generateed for it, for example,
Bar_FooServiceServiceProtocol, orBar_FooServiceClient. The protocol buffers style guide reccomends that services are suffixed with "Service" (e.g. "FooService", not "Foo") which results in some strange protocol names (likeBar_FooServiceServiceProtocol).There should be a clearer differentiation between the qualified service name ("bar.FooServce") and the type being generated. The code generator already replaces "." with "" in fully qualified names, so "" is a natural choice as a separator.
Modifications:
Result:
Better names in generated code.
The
Bar_FooServiceServiceProtocolexample above becomesBar_FooService_ServiceProtocol, whileBar_FooServiceClientbecomesBar_FooService_Client.