proto: rename GetIDs to GetIds #51
Conversation
WalkthroughThe essence of the modifications revolves around 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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #51 +/- ##
=======================================
Coverage 78.01% 78.01%
=======================================
Files 3 3
Lines 191 191
=======================================
Hits 149 149
Misses 32 32
Partials 10 10 ☔ 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.
| func (p *proxySrv) GetIds(ctx context.Context, request *pbda.GetIdsRequest) (*pbda.GetIdsResponse, error) { | ||
| ids, err := p.target.GetIDs(ctx, request.Height, request.Namespace.GetValue()) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return &pbda.GetIDsResponse{Ids: idsDA2PB(ids)}, nil | ||
| return &pbda.GetIdsResponse{Ids: idsDA2PB(ids)}, nil |
There was a problem hiding this comment.
The method GetIds has been correctly renamed from GetIDs, and the request and response types have been updated to GetIdsRequest and GetIdsResponse, respectively. This change aligns with the PR objectives of improving compatibility and consistency in naming conventions. However, there's a minor oversight in the method implementation:
- The call to
p.target.GetIDswithin theGetIdsmethod has not been updated to reflect the new method name. This could lead to a compilation error or unexpected behavior if the corresponding method in theda.DAinterface has also been renamed to match the new naming convention.
- ids, err := p.target.GetIDs(ctx, request.Height, request.Namespace.GetValue())
+ ids, err := p.target.GetIds(ctx, request.Height, request.Namespace.GetValue())Ensure that the da.DA interface and its implementations are updated accordingly to avoid any issues.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| func (p *proxySrv) GetIds(ctx context.Context, request *pbda.GetIdsRequest) (*pbda.GetIdsResponse, error) { | |
| ids, err := p.target.GetIDs(ctx, request.Height, request.Namespace.GetValue()) | |
| if err != nil { | |
| return nil, err | |
| } | |
| return &pbda.GetIDsResponse{Ids: idsDA2PB(ids)}, nil | |
| return &pbda.GetIdsResponse{Ids: idsDA2PB(ids)}, nil | |
| func (p *proxySrv) GetIds(ctx context.Context, request *pbda.GetIdsRequest) (*pbda.GetIdsResponse, error) { | |
| ids, err := p.target.GetIds(ctx, request.Height, request.Namespace.GetValue()) | |
| if err != nil { | |
| return nil, err | |
| } | |
| return &pbda.GetIdsResponse{Ids: idsDA2PB(ids)}, nil |
| req := &pbda.GetIdsRequest{Height: height, Namespace: &pbda.Namespace{Value: namespace}} | ||
| resp, err := c.client.GetIds(ctx, req) |
There was a problem hiding this comment.
The function previously known as GetIDs has been correctly updated to use GetIdsRequest and call the GetIds method, aligning with the PR objectives. This change ensures consistency with the new naming convention and improves compatibility across different programming languages and tools. However, it's important to note that the function name itself should also be updated to reflect the new naming convention:
- func (c *Client) GetIDs(ctx context.Context, height uint64, namespace da.Namespace) ([]da.ID, error) {
+ func (c *Client) GetIds(ctx context.Context, height uint64, namespace da.Namespace) ([]da.ID, error) {Ensure that all calls to this function throughout the codebase have been updated to match the new name.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| req := &pbda.GetIdsRequest{Height: height, Namespace: &pbda.Namespace{Value: namespace}} | |
| resp, err := c.client.GetIds(ctx, req) | |
| req := &pbda.GetIdsRequest{Height: height, Namespace: &pbda.Namespace{Value: namespace}} | |
| resp, err := c.client.GetIds(ctx, req) |
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
GetIDstoGetIdsto align with best practices.