LHN order improvements #12978

chiragsalian · 2022-11-24T00:43:17Z

Details

The issue was that in the past we we're sorting to show the highest IOU bill at the top. But when there are multiple bills of the same amount there is no secondary sort. So the items can show up in different order on web and mobile based on how their onyx data is saved.

So i updated the code such while ordering with highest IOU bill at top, if two IOU amounts are the same then we use report.displayName as a fallback sort for consistency.

Fixed Issues

$ #11590
PROPOSAL: #livingOnTheEdge

Tests

Kinda hard to test. I added a log here with

console.log('over here: ' + _.pluck(outstandingIOUReports, 'reportID'));

Log into the same user on web and mobile.
Split expenses among 8 people on web.
Confirmed the log line on mobile and web were the same. Confirm in the UI the order of the IOU report items on the LHN look the same.
Then i added another log at the same spot with,

console.log('over here 2: ' + _.pluck(nonArchivedReports, 'reportID'));

And confirmed the first few are the same order. Up until admin rooms should they be a lot better than before. I didn't do more than first few - context here.
Send a message on a chat report that's not a pinned or IOU chat (one without an amount badge). Confirm the most recent message shows up on top (it should be right below pinned and IOUs)

Verify that no errors appear in the JS console

Offline tests

QA Steps

Log into the same user on mobile and web.
Split a bill among 8 people on web.
Confirm the order of people shown up on web and mobile are the same.
Send a message on a non pinned or IOU chat. Confirm the most recent shows up on top (it should be right below pinned and IOUs)

Verify that no errors appear in the JS console

PR Author Checklist

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

chiragsalian · 2022-11-24T00:46:18Z

src/libs/SidebarUtils.js

    draftReports = _.sortBy(draftReports, report => report.displayName.toLowerCase());
-    nonArchivedReports = _.sortBy(nonArchivedReports, report => (isInDefaultMode ? report.lastMessageTimestamp : report.displayName.toLowerCase()));
+    nonArchivedReports = nonArchivedReports.sort((a, b) => {


i noticed that nonArchivedReports also showed up very differently between web and mobile. I made some improvements so that it sorts more consistently between mobile and web.

But its not perfect. There is a chance both messageTimestamp and displayNames are the same. For example i noticed for some #admin rooms the order would be off. We could further sort on policyID but i didn't want to go into a rabbit hole if it's not currently a problem and I'm content with the current improvement.

chiragsalian · 2022-11-24T01:52:27Z

PR works. It took me some time to figure out testing to confirm its working better than before.
Also took me some time to figure out how to jest test this. I'd like to add more jest tests for this before I put it out for review.

melvin-bot · 2022-12-03T20:56:43Z

@aimane-chnaif @srikarparsi One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

src/libs/SidebarUtils.js

aimane-chnaif · 2022-12-06T18:36:25Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

aimane-chnaif

Looks good to me and tests well

aimane-chnaif

running checklist

srikarparsi

@chiragsalian what if we use orderBy? That way it takes care of sorting with multiple keys, we can use lower case and can use ascending and descending. I think it could make the code a little simpler.

var outstandingIOUReport = [
  { iouReportAmount: 20, displayName: 'Barney'},
  { iouReportAmount: 20,  displayName: 'adam'},
  { iouReportAmount: 30, displayName: 'travis'}
];

result = _.orderBy(users, ['iouReportAmount', 'displayName.toLowerCase()'], ['asc', 'desc']);

chiragsalian · 2022-12-07T00:53:42Z

I didn't use orderBy at first since I thought conditions like toLowerCase and isInDefaultMode could not be added. But i just found out that we can add them so trying it out.

srikarparsi · 2022-12-07T01:02:03Z

cool yeah, also is there a reason you imported lodashOrderBy. underscore is already imported so I was thinking to just use _.orderBy(...)

chiragsalian · 2022-12-07T01:04:09Z

underscore does not have orderBy. Its only available in lodash.

chiragsalian · 2022-12-07T01:10:10Z

Updated, retested and ready for review.

srikarparsi

looks good to me :)

OSBotify · 2022-12-07T01:46:25Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2022-12-13T22:39:26Z

🚀 Deployed to production by @chiragsalian in version: 1.2.38-6 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

chiragsalian added 3 commits November 23, 2022 16:30

outstandingIOUReports order improvement

aaaa61d

nonArchivedReports improvments

3cecae9

removing a test debug

235f534

chiragsalian self-assigned this Nov 24, 2022

chiragsalian commented Nov 24, 2022

View reviewed changes

chiragsalian added 2 commits November 23, 2022 16:56

logic fix

36ffd32

logic fixes

e34f2d9

eVoloshchak mentioned this pull request Nov 28, 2022

[HOLD for payment 2022-12-20] [$250] BUG: Out of order LHN after split bill between web (staging.new.expensify) and IOS app reported by @chauchausoup #11590

Closed

chiragsalian added 6 commits December 3, 2022 12:06

Merge branch 'main' into chirag-order-improvements

386a6ee

adding a test

4648bf9

one more test

6b5bd58

test correction

d01f834

cleanup

a12be51

comment cleanup

4ec7052

chiragsalian marked this pull request as ready for review December 3, 2022 20:56

chiragsalian requested a review from a team as a code owner December 3, 2022 20:56

melvin-bot bot requested review from aimane-chnaif and srikarparsi and removed request for a team December 3, 2022 20:56

aimane-chnaif reviewed Dec 4, 2022

View reviewed changes

src/libs/SidebarUtils.js Outdated Show resolved Hide resolved

aimane-chnaif previously approved these changes Dec 6, 2022

View reviewed changes

aimane-chnaif reviewed Dec 6, 2022

View reviewed changes

srikarparsi reviewed Dec 7, 2022

View reviewed changes

using lodashOrderBy to clean up the logic here

ae0a7b6

chiragsalian dismissed aimane-chnaif’s stale review via ae0a7b6 December 7, 2022 00:54

srikarparsi approved these changes Dec 7, 2022

View reviewed changes

srikarparsi merged commit 736359b into main Dec 7, 2022

srikarparsi deleted the chirag-order-improvements branch December 7, 2022 01:41

francoisl mentioned this pull request Dec 8, 2022

Deploy Checklist: New Expensify 2022-12-07 #13431

Closed

72 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LHN order improvements #12978

LHN order improvements #12978

chiragsalian commented Nov 24, 2022 •

edited

Loading

chiragsalian Nov 24, 2022

chiragsalian commented Nov 24, 2022

melvin-bot bot commented Dec 3, 2022

aimane-chnaif commented Dec 6, 2022 •

edited

Loading

aimane-chnaif left a comment

aimane-chnaif left a comment

srikarparsi left a comment •

edited

Loading

chiragsalian commented Dec 7, 2022

srikarparsi commented Dec 7, 2022

chiragsalian commented Dec 7, 2022

chiragsalian commented Dec 7, 2022

srikarparsi left a comment

OSBotify commented Dec 7, 2022

OSBotify commented Dec 13, 2022

LHN order improvements #12978

LHN order improvements #12978

Conversation

chiragsalian commented Nov 24, 2022 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

PR Reviewer Checklist

Screenshots/Videos

chiragsalian Nov 24, 2022

Choose a reason for hiding this comment

chiragsalian commented Nov 24, 2022

melvin-bot bot commented Dec 3, 2022

aimane-chnaif commented Dec 6, 2022 • edited Loading

Reviewer Checklist

Screenshots/Videos

aimane-chnaif left a comment

Choose a reason for hiding this comment

aimane-chnaif left a comment

Choose a reason for hiding this comment

srikarparsi left a comment • edited Loading

Choose a reason for hiding this comment

chiragsalian commented Dec 7, 2022

srikarparsi commented Dec 7, 2022

chiragsalian commented Dec 7, 2022

chiragsalian commented Dec 7, 2022

srikarparsi left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 7, 2022

OSBotify commented Dec 13, 2022

chiragsalian commented Nov 24, 2022 •

edited

Loading

aimane-chnaif commented Dec 6, 2022 •

edited

Loading

srikarparsi left a comment •

edited

Loading