Order by name first and by id by default #337
Conversation
There was a problem hiding this comment.
The change looks good, but two more things are needed:
- Please unit test the
id(sortKey, as to be renamed to) functions on individual types, and the respective functions that sort their objects (infile/writer.go) - Please see the attached comment below
@hbagdi should we consider this a breaking change?
This is borderline but I feel this is NOT a breaking change:
Is that fair enough? |
Codecov Report
@@ Coverage Diff @@
## main #337 +/- ##
==========================================
+ Coverage 52.58% 53.66% +1.07%
==========================================
Files 60 60
Lines 4874 4877 +3
==========================================
+ Hits 2563 2617 +54
+ Misses 2013 1962 -51
Partials 298 298
Continue to review full report at Codecov.
|
| } | ||
| if p.Route != nil { | ||
| key += *p.Route.ID | ||
| if p.Name != nil { |
There was a problem hiding this comment.
non-blocker: you could simplify this. A plugin's name field can never be nil.
There was a problem hiding this comment.
I thought so too, but then I realized that even if it's impossible, the sortkey() shouldn't trigger an error for that situation as it's responsability is to sort and not to validate what it is sorting. That's why I wrote it this way.
| if s.Name != nil { | ||
| return *s.Name | ||
| } | ||
| if s.ID != nil { | ||
| return *s.ID | ||
| } | ||
| return "" | ||
| } |
There was a problem hiding this comment.
The sort key for FServiceVersion seems to be missing and we should add that.
It can be done separately or part of this PR - either is fine.
There was a problem hiding this comment.
There was neither any compareID() associated with this type, it seems like it was never sorted
There was a problem hiding this comment.
I've added #348 to track it.
If you are interested, please take that on once you this PR is merged in.
Thanks you!
|
This looks good from a product perspective. Let's merge once technical review is complete. |
No description provided.