Improve the readability and maintainability of the code which groups and sorts the reports in the sidebar #12558

tgolen · 2022-11-08T16:46:05Z

This uncovered a few other bugs:

Reports weren't properly sorted by name because the sorting is case sensitive, so reports with capital letters were sorted before lower case letters
Outstanding IOU reports weren't properly sorted because the IOU amount wasn't a property on the report object

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/229617

Tests

In NewDot, have an account with reports in the five various states (pinned, outstanding IOU, draft, archived, not archived)
Have your view preferences set to default mode (most recent)
Verify that each of the five groups is always ordered by pinned > IOU > draft > not archived > archived
Verify that pinned and draft groups are always sorted alphabetically by report title
Verify that the IOU group is always sorted by the outstanding IOU amount
Verify that the not archived and archived groups are sorted with the most recent activity at the top
Now switch your preferences to be in GSD mode (focus mode)
Verify the not archived and archived groups are sorted by report title. Note: they will need to be unread to show up in the sidebar. Second note: I don't think it's possible to have an archived report that is unread.

Verify that no errors appear in the JS console

QA Steps

Same as the test steps above

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

marcaaron · 2022-11-08T17:18:40Z

src/libs/SidebarUtils.js

+    // 5. Archived reports
+    //      - Sorted by lastMessageTimestamp in default (most recent) view mode
+    //      - Sorted by reportDisplayName in GSD (focus) view mode
+    const reportGroups = _.groupBy(reportsToDisplay, (report) => {


Grouping these into an object keyed with these strings is less clear than something like setting up a bunch of empty arrays:

const pinnedReports = []; const outstandingIOUReports = [];

I forgot what groupBy does, wasn't really sure what was happening here and had to look it up.

Could we just set up the arrays, then sort them, then concat them?

Yes, that is a good idea and hopefully it will be more clear that way. I've update the PR for that.

marcaaron · 2022-11-14T21:39:53Z

src/libs/ReportUtils.js

+            return iouReport.ownerEmail === currentUserLogin;
+        }
+    }
+    return null;


Could we return false here and keep the type consistent?

marcaaron · 2022-11-14T21:40:33Z

src/libs/ReportUtils.js

+ * @param {Object} report
+ * @param {String} report.iouReportID
+ * @param {Object} iouReports
+ * @returns {null|Number}


marcaaron · 2022-11-14T21:42:27Z

src/libs/ReportUtils.js

+ * @param {Object} iouReports
+ * @returns {null|Boolean}
+ */
+function isIOUOwnedByCurrentUser(report, currentUserLogin, iouReports) {


NAB but we can lose the iouReports && if we default to an object like this

Suggested change

function isIOUOwnedByCurrentUser(report, currentUserLogin, iouReports) {

function isIOUOwnedByCurrentUser(report, currentUserLogin, iouReports = {}) {

marcaaron · 2022-11-14T21:43:02Z

src/libs/ReportUtils.js

+ */
+function isIOUOwnedByCurrentUser(report, currentUserLogin, iouReports) {
+    if (report.hasOutstandingIOU) {
+        const iouReport = (iouReports && iouReports[`${ONYXKEYS.COLLECTION.REPORT_IOUS}${report.iouReportID}`]) || null;


nab, short circuit to null would also be unnecessary with the default argument as undefined is falsy.

tgolen · 2022-11-17T17:11:57Z

Updated!

AndrewGable

Much cleaner! @eVoloshchak - Can you test and review?

eVoloshchak · 2022-11-18T17:11:51Z

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

eVoloshchak

It's much better in terms of readability, cool!
Works well

tgolen · 2022-11-18T22:01:11Z

Looks like we are all good here and everything is approved, so I'll merge it.

melvin-bot · 2022-11-18T22:01:26Z

@tgolen looks like this was merged without the checklist test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

OSBotify · 2022-11-18T22:05:21Z

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

tgolen · 2022-11-18T22:46:24Z

Hm, they were definitely all passing when I clicked the button

OSBotify · 2022-11-22T16:37:00Z

🚀 Deployed to staging by @tgolen in version: 1.2.30-0 🚀

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

OSBotify · 2022-11-22T17:46:44Z

🚀 Deployed to staging by @tgolen in version: 1.2.30-0 🚀

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

OSBotify · 2022-11-24T00:05:06Z

🚀 Deployed to production by @luacmartins in version: 1.2.30-0 🚀

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

tgolen added 6 commits November 8, 2022 08:41

Refactor a few names to be more clear

94f978a

Add code to group and sort the report options

291cf65

Flatten all grouped reportIDs into a single array

9dedc71

Improve a few comments

5cad556

Improve a few comments

5806f58

Remove unused variables

863be99

tgolen self-assigned this Nov 8, 2022

marcaaron reviewed Nov 8, 2022

View reviewed changes

tgolen added 5 commits November 8, 2022 11:43

Remove groupBy and only use arrays

a961129

Ignore case when sorting by report name

945afdf

Merge branch 'main' into tgolen-improving-grouping-sorting-reports

0c4b705

Fix a bug with iou reports not sorting properly

85c6dc1

Remove extra debugging

0c09266

tgolen marked this pull request as ready for review November 8, 2022 22:02

tgolen requested a review from a team as a code owner November 8, 2022 22:02

melvin-bot bot requested review from AndrewGable and eVoloshchak and removed request for a team November 8, 2022 22:02

Protect against an empty IOU report collection

be6ebbf

marcaaron reviewed Nov 14, 2022

View reviewed changes

tgolen added 4 commits November 17, 2022 09:21

Merge branch 'main' into tgolen-improving-grouping-sorting-reports

1495687

Make return types more consistent

305eb3a

Simplify checking for IOU reports

f24a207

Prevent IOU reports from ever being null

dc9bc97

AndrewGable approved these changes Nov 17, 2022

View reviewed changes

eVoloshchak approved these changes Nov 18, 2022

View reviewed changes

AndrewGable requested a review from marcaaron November 18, 2022 17:35

marcaaron approved these changes Nov 18, 2022

View reviewed changes

tgolen merged commit 1ca61d8 into main Nov 18, 2022

tgolen deleted the tgolen-improving-grouping-sorting-reports branch November 18, 2022 22:01

melvin-bot bot added the Emergency label Nov 18, 2022

tgolen removed the Emergency label Nov 18, 2022

OSBotify mentioned this pull request Nov 22, 2022

Deploy Checklist: New Expensify 2022-11-22 #12934

Closed

40 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve the readability and maintainability of the code which groups and sorts the reports in the sidebar #12558

Improve the readability and maintainability of the code which groups and sorts the reports in the sidebar #12558

tgolen commented Nov 8, 2022 •

edited

Loading

marcaaron Nov 8, 2022

tgolen Nov 8, 2022

marcaaron Nov 14, 2022

marcaaron Nov 14, 2022

marcaaron Nov 14, 2022

marcaaron Nov 14, 2022

tgolen commented Nov 17, 2022

AndrewGable left a comment

eVoloshchak commented Nov 18, 2022

eVoloshchak left a comment

tgolen commented Nov 18, 2022

melvin-bot bot commented Nov 18, 2022

OSBotify commented Nov 18, 2022

tgolen commented Nov 18, 2022

OSBotify commented Nov 22, 2022

OSBotify commented Nov 22, 2022

OSBotify commented Nov 24, 2022

	function isIOUOwnedByCurrentUser(report, currentUserLogin, iouReports) {
	function isIOUOwnedByCurrentUser(report, currentUserLogin, iouReports = {}) {

Improve the readability and maintainability of the code which groups and sorts the reports in the sidebar #12558

Improve the readability and maintainability of the code which groups and sorts the reports in the sidebar #12558

Conversation

tgolen commented Nov 8, 2022 • edited Loading

Fixed Issues

Tests

QA Steps

PR Author Checklist

PR Reviewer Checklist

Screenshots/Videos

marcaaron Nov 8, 2022

Choose a reason for hiding this comment

tgolen Nov 8, 2022

Choose a reason for hiding this comment

marcaaron Nov 14, 2022

Choose a reason for hiding this comment

marcaaron Nov 14, 2022

Choose a reason for hiding this comment

marcaaron Nov 14, 2022

Choose a reason for hiding this comment

marcaaron Nov 14, 2022

Choose a reason for hiding this comment

tgolen commented Nov 17, 2022

AndrewGable left a comment

Choose a reason for hiding this comment

eVoloshchak commented Nov 18, 2022

Reviewer Checklist

Screenshots/Videos

eVoloshchak left a comment

Choose a reason for hiding this comment

tgolen commented Nov 18, 2022

melvin-bot bot commented Nov 18, 2022

OSBotify commented Nov 18, 2022

tgolen commented Nov 18, 2022

OSBotify commented Nov 22, 2022

OSBotify commented Nov 22, 2022

OSBotify commented Nov 24, 2022

tgolen commented Nov 8, 2022 •

edited

Loading