Fix #2076: Two indistinguishable events for different cases of working set reordering

[TomMalbran]

I went back to the working set sort and managed to merge both events workingSetReoder and workingSetSort into one workingSetSort and leaving almost the same functionality as before fixing #2076.

[TomMalbran]

I added a few fixes here so that #3440 is still fixed after this request is merged.

[njx]

Reassigned to @redmunds

[redmunds]

@TomMalbran Sorry it's taken so long to get to this one. I started to review it, but there's a merge conflict. Can you merge the latest code? Thanks.

[TomMalbran]

Sure, I'll fix the merge issue. Thanks for looking into this.

[TomMalbran]

@redmunds Merged with master and fixed the conflict issue.

[redmunds]

The sortWorkingSet() function also calls $(exports).triggerHandler("workingSetSort") but the event does not seem to be handled anywhere. It should either be removed, or call triggerWorkingSetSort() directly.

[TomMalbran]

This function is used on the WorkingSetView.js#L249. It was initially used to save the working set state into the preferences, which isn't required so is now mainly used to disable the automatic sort and have both sort methods trigger 1 event.

[redmunds]

Done with initial review.

[TomMalbran]

@redmunds Fixed the comment issues. Check on my replies about the event to see what we can do next. Thanks.

[redmunds]

Done with second review.

[TomMalbran]

I updated a bit the comment on the workingSetSort event and added a new workingSetDisableAutoSorting called every time 2 files are swapped when dragging and dropping them. This added a new event, but works better than before by not unnecessarily redrawing the working set after a drag/drop action. There might be a smarter way of figuring out when doing an automatic sort if it was previously resorted via a drag/drop action and avoid having the new event, but it is easier to do it like this.

[redmunds]

Thanks! Looks good. Merging.

[peterflynn]

Note: I've reopened #2076 for more discussion since this doesn't appear to address the main confusion/pitfall I was concerned about (and in some sense the event name change may have made it worse).