fix: use localeCompare to sort in mention list#45324
Merged
Merged
Conversation
Signed-off-by: dominictb <tb-dominic@outlook.com>
situchan
suggested changes
Jul 16, 2024
situchan
left a comment
Contributor
There was a problem hiding this comment.
Please make utils and add unit test
Contributor
Author
|
on it now! |
Contributor
Author
|
@situchan done! |
Contributor
Reviewer Checklist
Screenshots/VideosAndroid: Nativeandroid.mp4Android: mWeb Chromemchrome.mp4iOS: Nativeios.moviOS: mWeb Safarimsafari.movMacOS: Chrome / SafariBefore: After: MacOS: Desktopdesktop.mov |
situchan
suggested changes
Jul 17, 2024
Contributor
Author
|
waiting for @situchan's review. |
Contributor
|
@dominictb please merge main |
Contributor
Author
|
done! |
Contributor
|
Please also add Tests Step in OP |
Contributor
|
@dominictb @situchan please add screenshots/video for all platforms |
Contributor
|
@dominictb also, QA Step is a bit confusing.
As a result, you should add:
|
Contributor
Author
|
@cead22 done! |
cead22
requested changes
Jul 29, 2024
cead22
requested changes
Jul 30, 2024
Comment on lines
+60
to
+66
| function getDisplayName(p: PersonalDetails) { | ||
| const displayNameFromAccountID = ReportUtils.getDisplayNameForParticipant(p.accountID); | ||
| if (!displayNameFromAccountID) { | ||
| return p.login?.length ? p.login : ''; | ||
| } | ||
| return displayNameFromAccountID; | ||
| } |
Contributor
There was a problem hiding this comment.
Suggested change
| function getDisplayName(p: PersonalDetails) { | |
| const displayNameFromAccountID = ReportUtils.getDisplayNameForParticipant(p.accountID); | |
| if (!displayNameFromAccountID) { | |
| return p.login?.length ? p.login : ''; | |
| } | |
| return displayNameFromAccountID; | |
| } | |
| function getDisplayName(details: PersonalDetails) { | |
| const displayNameFromAccountID = ReportUtils.getDisplayNameForParticipant(details.accountID); | |
| if (!displayNameFromAccountID) { | |
| return details.login?.length ? details.login : ''; | |
| } | |
| return displayNameFromAccountID; | |
| } |
Comment on lines
+69
to
+70
| * the comparison function used to determine which user will come first in the sorted list | ||
| * generally, smaller weight means will come first, and if the weight is the same, we'll sort based on displayName/login and accountID |
Contributor
There was a problem hiding this comment.
Suggested change
| * the comparison function used to determine which user will come first in the sorted list | |
| * generally, smaller weight means will come first, and if the weight is the same, we'll sort based on displayName/login and accountID | |
| * Comparison function to sort users. It compares weights, display names, and accountIDs in that order |
Comment on lines
+73
to
+83
| // first, we should sort by weight | ||
| if (first.weight !== second.weight) { | ||
| return first.weight - second.weight; | ||
| } | ||
|
|
||
| // next we sort by display name | ||
| const displayNameLoginOrder = localeCompare(getDisplayName(first), getDisplayName(second)); | ||
| if (displayNameLoginOrder !== 0) { | ||
| return displayNameLoginOrder; | ||
| } | ||
| // then fallback on accountID as the final sorting criteria. |
Contributor
There was a problem hiding this comment.
The jsdoc already explains this, and this says what the code is doing, which is obvious from reading the code. Since these comments don't follow our style guide (should use capital letters on the first word), I suggest removing them
Suggested change
| // first, we should sort by weight | |
| if (first.weight !== second.weight) { | |
| return first.weight - second.weight; | |
| } | |
| // next we sort by display name | |
| const displayNameLoginOrder = localeCompare(getDisplayName(first), getDisplayName(second)); | |
| if (displayNameLoginOrder !== 0) { | |
| return displayNameLoginOrder; | |
| } | |
| // then fallback on accountID as the final sorting criteria. | |
| if (first.weight !== second.weight) { | |
| return first.weight - second.weight; | |
| } | |
| const displayNameLoginOrder = localeCompare(getDisplayName(first), getDisplayName(second)); | |
| if (displayNameLoginOrder !== 0) { | |
| return displayNameLoginOrder; | |
| } |
| }); | ||
| }) as Array<PersonalDetails & {weight: number}>; | ||
|
|
||
| // at this point we are sure that the details are not null, since empty user details have been filtered in the previous step |
Contributor
There was a problem hiding this comment.
Suggested change
| // at this point we are sure that the details are not null, since empty user details have been filtered in the previous step | |
| // At this point we are sure that the details are not null, since empty user details have been filtered in the previous step |
Contributor
Author
|
@cead22 updated. |
cead22
approved these changes
Jul 31, 2024
Contributor
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
Contributor
|
🚀 Deployed to staging by https://github.com/cead22 in version: 9.0.15-0 🚀
|
Closed
6 tasks
Contributor
|
🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.15-9 🚀
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Details
Fixed Issues
$ #43845
PROPOSAL: #43845 (comment)
Tests
Pre-requisite: Create 4 account with name
águero,Bronn,Carol,Daniel.@Verify that the order in the mention list is
here,águero,Bronn,Carol,Daniel(or if you invite the above 4 accounts, should beaName,B,Bname,Workspace member)Offline tests
QA Steps
Pre-requisite: Create 4 account with name
águero,Bronn,Carol,Daniel(or any other equivalent names which highlight the alphabetical order). Or can invite the following account:natnael.expensify+idf6yd@gmail.com,
natnael.expensify+lajf088b@gmail.com,
natnael.expensify+ldjf66vd@gmail.com,
natnael.expensify+3@gmail.com
@Verify that the order in the mention list is
here,águero,Bronn,Carol,Daniel(or if you invite the above 4 accounts, should beaName,B,Bname,Workspace member)PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop