Fix 6310 Provide ability to sort/order branches and tags #8427

RussKie · 2020-08-29T14:03:08Z

Fixes #6310
Fixes #7456
Fixes #8301
Fixes #8427
Resolves #7472
Closes #4869
Closes #8309 as obsolete

Proposed changes

Provide ability to sort/order branches

Restore the functionality (albeit improved) removed in 9c7c76f.

Allow to either defer sorting to git (i.e. sort by Default) which is either implicit, or configured via git config branch.sort.

Alternatively expose the following sort by options:

authordate
committerdate
creatordate
taggerdate
refname
objectsize
upstream

For user-specified sort, allow to select ascending or descending order (default: desc).

Git v2.19+ is required to facilitate the above, hence bump in the min version.

The sort configuration applies to both the left panel and the branches dropdown in the toolstrip.

Screenshots

After

Settings:
The left panel:

Test methodology

manual
added few unit tests

✒️ I contribute this code under The Developer Certificate of Origin.

codecov · 2020-09-01T07:55:21Z

Codecov Report

Merging #8427 into master will increase coverage by 0.10%.
The diff coverage is 78.15%.

@@            Coverage Diff             @@
##           master    #8427      +/-   ##
==========================================
+ Coverage   53.00%   53.11%   +0.10%     
==========================================
  Files         877      881       +4     
  Lines       62128    62366     +238     
  Branches    11332    11351      +19     
==========================================
+ Hits        32934    33127     +193     
- Misses      26533    26567      +34     
- Partials     2661     2672      +11

Flag	Coverage Δ
#production	`41.02% <64.50%> (+0.04%)`	⬆️
#tests	`94.31% <100.00%> (+0.04%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

RussKie · 2020-09-01T08:01:21Z

@msftbot merge in 48 hours

gerhardol

Brief, review, brief testing. Some comments, considered blocking auto merge

GitCommands/Git/GitModule.cs

GitCommands/Git/GitVersion.cs

GitUI/BranchTreePanel/ContextMenu/GitRefsSortOrderContextMenuItem.cs

gerhardol

git show-ref do not have --sort option
I cannot trigger the use of --sort to GetRefsCmd() with sort though

gerhardol · 2020-09-02T20:07:40Z

@msftbot forget what I just told you

RussKie · 2020-09-07T01:57:59Z

Outstanding: resolution of the context menu placement for the Tags node. Judging by incoming PRs looks like @ivangrek has significantly better understanding of this part 😁.

ghost · 2020-09-09T14:53:58Z

Is this the correct state?

Plugins/GitUIPluginInterfaces/GitRefsOrder.cs

RussKie · 2020-09-10T03:59:39Z

Is this the correct state?

Champion! You're clearly a better tester than I am 🙇‍♂️ No, this is definitely something I didn't anticipate, and now I need to think of it more.
Though this should go into #8414, this PR is about sorting.

RussKie · 2020-09-11T12:53:30Z

@gerhardol I'd appreciate your re-review, I believe your points are addressed.

gerhardol

I mostly looked at GitModule changes, a few comments only.
Briefly looked at the rest, briefly tested.
I suggest it is merged, but not deep enough review to formally approve.

gerhardol · 2020-09-12T15:47:26Z

GitCommands/Git/Commands/GitCommandHelpers.cs

+                { sortBy != GitRefsSortBy.Default, GetSortCriteria(tags, sortBy, sortOrder), string.Empty },
+                format,
+                { branches, "refs/heads/", string.Empty },
+                { branches && tags, "refs/remotes/", string.Empty },


Related issue #6044, this PR shows more clearly the special handling for remotes.

Thank you for pointing me to this. This API can do with quite a bit of improvement, but I didn't want to change to much in the context of this PR. I will do a follow up improvement later.

gerhardol · 2020-09-12T15:47:54Z

GitCommands/Git/Commands/GitCommandHelpers.cs

+                //      Else
+                //          format = %(*objectname) %(*refname) // i.e. info from a referenced commit
+                //      End
+                format = @"--format=""%(if)%(authordate)%(then)%(objectname) %(refname)%(else)%(*objectname) %(*refname)%(end)""";


This fixes #8301 replacing PR #8309
This assumes the comment in #8301 (comment) is OK: non-dereferenced tags are not used in the application

Nice, we can certainly look at this as a follow up 👍

GitCommands/Git/GitModule.cs

GitCommands/Git/Commands/GitCommandHelpers.cs

RussKie · 2020-09-13T02:31:13Z

I suggest it is merged, but not deep enough review to formally approve.

Taking this as an approval. Feel free to cancel the auto-merge, if it isn't so.

ghost · 2020-09-13T02:43:50Z

Hello @RussKie!

Because you've given me some instructions on how to help merge this pull request, I'll be modifying my merge approach. Here's how I understand your requirements for merging this pull request:

I'll only merge this pull request if it's approved by @gerhardol
I won't merge this pull request until after the UTC date Mon, 14 Sep 2020 02:43:49 GMT, which is in 1 day

If this doesn't seem right to you, you can tell me to cancel these instructions and use the auto-merge policy that has been configured for this repository. Try telling me "forget everything I just told you".

gerhardol

I suggest it is merged, but not deep enough review to formally approve.

Taking this as an approval. Feel free to cancel the auto-merge, if it isn't so.

Approval to merge, but incomplete review, focusing on GetRefs() that I found to be important.
More of browsing the remaining, I could understand what I looked at and no obvious problems.
There are a few discussion points still, can be discussed separately.

Approving with the limitations in the review stated above.

Restore the functionality (albeit improved) removed in 9c7c76f. Allow to either defer sorting to git (i.e. sort by Default) which is either implicit, or configured via `git config branch.sort`. Alternatively expose the following sort by options: - authordate - committerdate - creatordate - taggerdate - refname - objectsize - upstream For user-specified sort, allow to select ascending or descending order (default: desc). Git v2.19+ is required to facilitate sort by default, hence bump in the min version. Update the recommended version to 2.28.0 while we are at it. The sort configuration applies to both the left panel and the branches dropdown in the toolstrip. Fixes gitextensions#6310 Fixes gitextensions#8301 Resolves gitextensions#7472 Closes gitextensions#4869 Closes gitextensions#8309

Relates to gitextensions#8427

jrfnl · 2021-04-26T05:22:32Z

@RussKie Thank you!!!! ❤️ Been missing this a lot!

Only question I have is: is there a way to sort alphanumerically, but case insensitively ? Might be possible already, but I haven't figured out how to do it.

RussKie · 2021-04-26T09:44:21Z

I don't know. Git is a Linux tool, so it is generally case sensitive. And as you can see from the PR diff or command log (F12) the sort command can be quite intricate. That said, I haven't considered or investigated case sensitivity because for me it was never an issue...

RussKie · 2021-04-27T14:29:49Z

Related: #8508

ghost assigned RussKie Aug 29, 2020

RussKie force-pushed the fix_6310_sort_branches branch 4 times, most recently from b051ec4 to 1fa75cd Compare September 1, 2020 07:39

ghost added the status: auto merge label Sep 1, 2020

gitextensions deleted a comment Sep 1, 2020

gerhardol reviewed Sep 1, 2020

View reviewed changes

gerhardol removed the status: auto merge label Sep 2, 2020

gerhardol requested changes Sep 2, 2020

View reviewed changes

ghost added the 📭 needs: author feedback More info/confirmation awaited from OP; issues typically get closed after 30 days of inactivity label Sep 2, 2020

ghost removed the 📭 needs: author feedback More info/confirmation awaited from OP; issues typically get closed after 30 days of inactivity label Sep 4, 2020

RussKie marked this pull request as draft September 4, 2020 12:10

RussKie force-pushed the fix_6310_sort_branches branch from df6b42f to 8f1acd5 Compare September 6, 2020 13:23

RussKie mentioned this pull request Sep 7, 2020

Filter out hidden branches #8414

Merged

RussKie marked this pull request as ready for review September 7, 2020 01:55

RussKie changed the title ~~Fix 6310 Provide ability to sort/order branches~~ Fix 6310 Provide ability to sort/order branches and tags Sep 7, 2020

RussKie added the area: left-panel Issues related to the Left Panel label Sep 7, 2020

ghost reviewed Sep 9, 2020

View reviewed changes

Plugins/GitUIPluginInterfaces/GitRefsOrder.cs Show resolved Hide resolved

RussKie force-pushed the fix_6310_sort_branches branch from 8f1acd5 to e0dddf2 Compare September 10, 2020 03:42

RussKie force-pushed the fix_6310_sort_branches branch 4 times, most recently from 6a00136 to 04617c5 Compare September 11, 2020 12:15

RussKie force-pushed the fix_6310_sort_branches branch from 04617c5 to e7e35a2 Compare September 12, 2020 14:38

gerhardol reviewed Sep 12, 2020

View reviewed changes

RussKie mentioned this pull request Sep 13, 2020

GitModule.GetRefs(tags: false, branches: true) does not return remote branches #6044

Closed

RussKie force-pushed the fix_6310_sort_branches branch 3 times, most recently from 8b67585 to cc22182 Compare September 13, 2020 02:11

ghost added the status: auto merge label Sep 13, 2020

gitextensions deleted a comment Sep 13, 2020

gerhardol approved these changes Sep 13, 2020

View reviewed changes

RussKie added 2 commits September 13, 2020 20:22

Expose sort by/order in the left panel

a0f8eea

RussKie force-pushed the fix_6310_sort_branches branch from cc22182 to a0f8eea Compare September 13, 2020 10:23

RussKie merged commit 2d52621 into gitextensions:master Sep 13, 2020

RussKie deleted the fix_6310_sort_branches branch September 13, 2020 10:39

ghost added this to the 4.0 milestone Sep 13, 2020

RussKie added a commit to RussKie/gitextensions that referenced this pull request Oct 2, 2020

Correct Sort context menu placement

57d404e

Relates to gitextensions#8427

RussKie mentioned this pull request Oct 2, 2020

Correct Sort context menu placement #8503

Merged

This was referenced Oct 19, 2020

Sort branches alphabethical/lastAccess (#6310) #7456

Closed

Left panel: sort branches alphabetically #8001

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix 6310 Provide ability to sort/order branches and tags #8427

Fix 6310 Provide ability to sort/order branches and tags #8427

RussKie commented Aug 29, 2020 •

edited

codecov bot commented Sep 1, 2020 •

edited

RussKie commented Sep 1, 2020

gerhardol left a comment

gerhardol left a comment

gerhardol commented Sep 2, 2020

RussKie commented Sep 7, 2020

ghost commented Sep 9, 2020

RussKie commented Sep 10, 2020

RussKie commented Sep 11, 2020

gerhardol left a comment

gerhardol Sep 12, 2020

RussKie Sep 13, 2020

gerhardol Sep 12, 2020

RussKie Sep 13, 2020

RussKie commented Sep 13, 2020

ghost commented Sep 13, 2020

gerhardol left a comment

jrfnl commented Apr 26, 2021 •

edited

RussKie commented Apr 26, 2021 via email •

edited by ghost

RussKie commented Apr 27, 2021

Fix 6310 Provide ability to sort/order branches and tags #8427

Fix 6310 Provide ability to sort/order branches and tags #8427

Conversation

RussKie commented Aug 29, 2020 • edited

Proposed changes

Screenshots

After

Test methodology

codecov bot commented Sep 1, 2020 • edited

Codecov Report

RussKie commented Sep 1, 2020

gerhardol left a comment

Choose a reason for hiding this comment

gerhardol left a comment

Choose a reason for hiding this comment

gerhardol commented Sep 2, 2020

RussKie commented Sep 7, 2020

ghost commented Sep 9, 2020

RussKie commented Sep 10, 2020

RussKie commented Sep 11, 2020

gerhardol left a comment

Choose a reason for hiding this comment

gerhardol Sep 12, 2020

Choose a reason for hiding this comment

RussKie Sep 13, 2020

Choose a reason for hiding this comment

gerhardol Sep 12, 2020

Choose a reason for hiding this comment

RussKie Sep 13, 2020

Choose a reason for hiding this comment

RussKie commented Sep 13, 2020

ghost commented Sep 13, 2020

gerhardol left a comment

Choose a reason for hiding this comment

jrfnl commented Apr 26, 2021 • edited

RussKie commented Apr 26, 2021 via email • edited by ghost

RussKie commented Apr 27, 2021

RussKie commented Aug 29, 2020 •

edited

codecov bot commented Sep 1, 2020 •

edited

jrfnl commented Apr 26, 2021 •

edited

RussKie commented Apr 26, 2021 via email •

edited by ghost