proto: rename GetIDs to GetIds #51
Conversation
WalkthroughThe modifications involve standardizing the naming convention for the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #51 +/- ##
==========================================
+ Coverage 75.54% 79.55% +4.00%
==========================================
Files 5 5
Lines 274 225 -49
==========================================
- Hits 207 179 -28
+ Misses 52 33 -19
+ Partials 15 13 -2 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 2
Configuration used: CodeRabbit UI
Files ignored due to path filters (1)
types/pb/da/da.pb.gois excluded by:!**/*.pb.go
Files selected for processing (3)
- proto/da/da.proto (2 hunks)
- proxy/client.go (1 hunks)
- proxy/server.go (1 hunks)
Additional comments: 2
proto/da/da.proto (2)
- 12-13: The RPC method
GetIdshas been correctly renamed fromGetIDs, aligning with the PR objectives to improve naming convention consistency. This change is consistent and correctly implemented in theDAServiceservice definition.- 73-80: The message types
GetIdsRequestandGetIdsResponsehave been correctly renamed and defined, aligning with the renaming of theGetIdsRPC method. These changes are consistent and correctly implemented, ensuring compatibility and consistency in naming conventions across different programming languages and tools.
tzdybal
force-pushed
the
pep-rename-proto-ids
branch
from
c5a2e14
to
ae2e1fa
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
types/pb/da/da.pb.gois excluded by!**/*.pb.go
Files selected for processing (3)
- proto/da/da.proto (2 hunks)
- proxy/grpc/client.go (1 hunks)
- proxy/grpc/server.go (1 hunks)
Files skipped from review due to trivial changes (3)
- proto/da/da.proto
- proxy/grpc/client.go
- proxy/grpc/server.go
This changeset renames proto's GetIDs to GetIds.
The motivation behind this change lies in the fact, that protobuf (unlike the go part of the codebase) is a language agnostic tool: it generates concrete definitions in the target languages given a common .proto definition.
As such, it needs a way to convert between case conventions, automatically. Abbreviations and acronyms such as ID, HTTP or URL is a big contention point. Go seems to prefer URL. Java Url.
I have no intention here to wage holy war either one way or another.
Just want to point out that treating an abbrevation/acronym as a word plays nicely with
simple algorithms that convert between case conventions automatically. snake_case conversion makes a good example:
GetIDs -> get_i_ds
This is what you get in rust with tonic (no option to override there).
I can live with that of course, feel free to close this PR.
Also, I realize that this is a breaking change and may be not desirable. As such, feel free to close this PR or leave it dangling until the next time to change the proto comes.
Summary by CodeRabbit
Summary by CodeRabbit
GetIDstoGetIdsand corresponding request/response names to enhance readability and maintain best practices.