[Feature]: Sort results of getTablets for consistency in output/readability #17771
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
Review ChecklistHello reviewers! 👋 Please follow this checklist when reviewing this Pull Request. General
Tests
Documentation
New flags
If a workflow is added or modified:
Backward compatibility
|
vitess-bot
bot
added
NeedsBackportReason
|
Woops, looks like my commit signing was off. Will fix. |
Signed-off-by: Lucas Morduchowicz <[email protected]>
lmorduch
force-pushed
the
sort-get-tablets
branch
from
b6cea9e to
fd13c20
Compare
mattlord
added
Type: Enhancement
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #17771 +/- ##
==========================================
- Coverage 67.95% 67.95% -0.01%
==========================================
Files 1585 1585
Lines 255162 255160 -2
==========================================
- Hits 173408 173390 -18
- Misses 81754 81770 +16 ☔ View full report in Codecov by Sentry. |
mattlord
reviewed
Feb 12, 2025
There was a problem hiding this comment.
LGTM. Thanks, @lmorduch ! I thought that we had already done this but it appears that the reality was that I was always thinking we should do this (whenever I noticed output changes in successive GetTablets commands) but I never actually did. 🙂
Do you mind doing one more thing? I think that we should get rid of the AssertSameTablets() function and use utils.MustMatch() instead in the other call sites as well.
❯ git grep AssertSameTablets | cat
go/vt/vtctl/grpcvtctldserver/server_test.go: testutil.AssertSameTablets(t, tt.expectedRemainingTablets, resp.Tablets)
go/vt/vtctl/grpcvtctldserver/server_test.go: testutil.AssertSameTablets(t, tt.expected, resp.Tablets)
go/vt/vtctl/grpcvtctldserver/server_test.go: testutil.AssertSameTablets(t, tt.expectedTopo, resp.Tablets)
go/vt/vtctl/grpcvtctldserver/testutil/proto_compare.go:func AssertSameTablets(t *testing.T, expected, actual []*topodatapb.Tablet) {
…ed for getTablets now Signed-off-by: Lucas Morduchowicz <[email protected]>
Thanks a ton for the review and the feedback! My bad re the test function, I should have checked the other calls to assertSameTablets- they all are checking results from getTablets. Updated to remove the helper function and just call Full output below. |
Thanks for the help and feedback! Really appreciate the assistance. |
notfelineit
approved these changes
Feb 13, 2025
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.
Description
This sorts the results of GetTablets (which for my current use case, will sort the output of ListShardTablets) and allow it to be consistently grokkable due to it's deterministic ordering.
To test this change, I first modified the
TestGetTabletsunit test under server_test.go from callingtestutil.AssertSameTablets(t, tt.expected, resp.Tablets), which first sorts the expected and actual, toutils.MustMatch(t, tt.expected, resp.Tablets), the call made under the hood after sorting inAssertSameTablets. I got the following runninggo testwith just that test change:After implementing the actual code changes in
server.go, I get:Related Issue(s)
This is the related issue: #17744
Checklist
Deployment Notes
I don't believe this has any special properties with regards to deployments