Sort participants in report participants and workspace invite page #17421

youssef-lr · 2023-04-13T22:39:34Z

To make things consistent with how we display members in the invite page, let's also sort participants of a report. The personalDetails we fetch from the backend happen to already be sorted, but when we grab the participants from a report they're not sorted.

The sorting added about 3ms in a chat report with about 6k participants, so I think performance wise this is negligible.

Details

Fixed Issues

$ #16509

Tests

Verify that no errors appear in the JS console

Make sure you have a workspace with a few members in it.
Open a workspace's room then navigate to Details => Members.
Make sure the members are sorted alphabetically by their display names.
Do the same in the workspace invite page, Workspace => Manage Members => Invite.

Offline tests

Same as the online tests above.

QA Steps

Verify that no errors appear in the JS console

Make sure you have a workspace with a few members in it.
Open a workspace's room then navigate to Details => Members.
Make sure the members are sorted alphabetically by their display names.
Do the same in the workspace invite page, Workspace => Manage Members => Invite.

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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 is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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 any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
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 code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
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.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

MelvinBot · 2023-04-28T04:36:27Z

@eVoloshchak @amyevans 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]

eVoloshchak · 2023-04-29T18:00:49Z

src/pages/ReportParticipantsPage.js

@@ -75,7 +75,7 @@ const getAllParticipants = (report, personalDetails) => {
            tooltipText: userLogin,
            participantsList: [{login, displayName: userPersonalDetail.displayName}],
        });
-    });
+    }).value();


Suggested change

}).value();

}).sortBy(participant => participant.displayName.toLowerCase()).value();

I think we should sort participants by displayName, that's how we do it on WorkspaceMembersPage

And .toLowerCase() to avoid issues similar to #16925

There is also no sorting on WorkspaceInvitePage, we can add it so it's consistent across the screens

Sounds good @eVoloshchak, I'll add these changes.

youssef-lr · 2023-05-11T09:12:40Z

Updated!

amyevans

Tests aren't passing still but otherwise looking good

eVoloshchak

Looks good and tests well on all platforms

As for the failing test, I think the problem is we're calling getMemberInviteOptions here to get the options, but it doesn't return displayName for each item (by design). It uses createOption under the hood.

I think we can resolve this by including displayName in the returned result, meaning add

result.displayName = personalDetail.displayName;

below this line

youssef-lr · 2023-05-16T13:03:37Z

@eVoloshchak @amyevans I just discovered a bug here https://github.com/Expensify/App/blob/main/src/pages/workspace/WorkspaceInvitePage.js#L116, when there is no pendingAction, this still evaluates to true:

policyMemberList[policyMember].pendingAction !== CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE

and we end up not showing the workspace members in the invite page, though I couldn't reproduce it live, it consistently happens for me locally.

This can be easily fixed this way (policyMemberList[policyMember].pendingAction && policyMemberList[policyMember].pendingAction !== CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE), should I go for it in this PR?

youssef-lr · 2023-05-16T13:08:26Z

Looks good and tests well on all platforms

As for the failing test, I think the problem is we're calling getMemberInviteOptions here to get the options, but it doesn't return displayName for each item (by design). It uses createOption under the hood.

I think we can resolve this by including displayName in the returned result, meaning add

result.displayName = personalDetail.displayName;
below this line

I'm not sure, I just had to re-order the items to get the test to pass now that we also sort members in the invite page, and brought back .text, I think my mistake was replacing it with displayName when I only had to reorder the results the assertion takes.

eVoloshchak · 2023-05-17T08:25:36Z

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:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is 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 any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
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 code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
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.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
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

Looks good and tests well

youssef-lr · 2023-05-17T19:26:56Z

bump @amyevans! :) Also curious about your thoughts here, I think it's a bug and we'll need to fix it in a separate PR.

amyevans · 2023-05-18T02:41:22Z

when there is no pendingAction, this still evaluates to true:
policyMemberList[policyMember].pendingAction !== CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE

Hmm, I think the logic is working as intended - essentially we should exclude users who are already on the policy from the list of people you could invite, unless it's pending delete, in which case perhaps you want to invite them back so we should show them. You can look at the commit where it was introduced (and also the PR/GH from there).

We could be more explicit by adding !policyMemberList[policyMember].pendingAction || to the check potentially, but it doesn't change the outcome.

Doing (policyMemberList[policyMember].pendingAction && policyMemberList[policyMember].pendingAction !== CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE) would change the logic in an unintended way.

OSBotify · 2023-05-18T02:49:04Z

✋ 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 · 2023-05-18T07:38:18Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.16-0 🚀

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

OSBotify · 2023-05-22T23:39:45Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.16-7 🚀

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

OSBotify · 2023-05-23T00:15:40Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.16-7 🚀

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

OSBotify · 2023-05-23T19:53:34Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.16-7 🚀

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

OSBotify · 2023-05-23T21:52:18Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.16-7 🚀

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

youssef-lr added 2 commits April 13, 2023 22:38

Sort participants in report participants page

d211ac5

Bug fix

c58bda7

youssef-lr self-assigned this Apr 28, 2023

Merge branch 'main' into youssef_sort_participants

2486919

youssef-lr marked this pull request as ready for review April 28, 2023 04:35

youssef-lr requested a review from a team as a code owner April 28, 2023 04:35

melvin-bot bot requested review from amyevans and eVoloshchak and removed request for a team April 28, 2023 04:36

eVoloshchak reviewed Apr 29, 2023

View reviewed changes

youssef-lr added 2 commits May 11, 2023 10:11

Merge branch 'main' into youssef_sort_participants

469d37a

Sort participants in workspace invite page alphabetically

4183a36

youssef-lr changed the title ~~Sort participants in report participants page~~ Sort participants in report participants and workspace invite page May 11, 2023

Fix test

02cee7f

amyevans reviewed May 11, 2023

View reviewed changes

eVoloshchak suggested changes May 15, 2023

View reviewed changes

youssef-lr added 2 commits May 16, 2023 13:15

Merge branch 'main' into youssef_sort_participants

f101fa0

Fix test

b25da6d

youssef-lr added 2 commits May 16, 2023 14:21

Fix test

63a4463

Prettier

314e24d

eVoloshchak approved these changes May 17, 2023

View reviewed changes

amyevans approved these changes May 18, 2023

View reviewed changes

amyevans merged commit 4fd9ffc into main May 18, 2023

amyevans deleted the youssef_sort_participants branch May 18, 2023 02:42

OSBotify mentioned this pull request May 18, 2023

Deploy Checklist: New Expensify 2023-05-18 #19175

Closed

39 tasks

melvin-bot bot mentioned this pull request May 22, 2023

[HOLD for payment 2023-05-29] Members in #announce are not sorted alphabetically as it is on manage member page #16509

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sort participants in report participants and workspace invite page #17421

Sort participants in report participants and workspace invite page #17421

youssef-lr commented Apr 13, 2023 •

edited

Loading

MelvinBot commented Apr 28, 2023

eVoloshchak Apr 29, 2023

eVoloshchak Apr 29, 2023

youssef-lr May 3, 2023

youssef-lr commented May 11, 2023

amyevans left a comment

eVoloshchak left a comment

youssef-lr commented May 16, 2023 •

edited

Loading

youssef-lr commented May 16, 2023

eVoloshchak commented May 17, 2023 •

edited

Loading

eVoloshchak left a comment

youssef-lr commented May 17, 2023

amyevans commented May 18, 2023

OSBotify commented May 18, 2023

OSBotify commented May 18, 2023

OSBotify commented May 22, 2023

OSBotify commented May 23, 2023

OSBotify commented May 23, 2023

OSBotify commented May 23, 2023

	}).value();
	}).sortBy(participant => participant.displayName.toLowerCase()).value();

Sort participants in report participants and workspace invite page #17421

Sort participants in report participants and workspace invite page #17421

Conversation

youssef-lr commented Apr 13, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 28, 2023

eVoloshchak Apr 29, 2023

Choose a reason for hiding this comment

eVoloshchak Apr 29, 2023

Choose a reason for hiding this comment

youssef-lr May 3, 2023

Choose a reason for hiding this comment

youssef-lr commented May 11, 2023

amyevans left a comment

Choose a reason for hiding this comment

eVoloshchak left a comment

Choose a reason for hiding this comment

youssef-lr commented May 16, 2023 • edited Loading

youssef-lr commented May 16, 2023

eVoloshchak commented May 17, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

eVoloshchak left a comment

Choose a reason for hiding this comment

youssef-lr commented May 17, 2023

amyevans commented May 18, 2023

OSBotify commented May 18, 2023

OSBotify commented May 18, 2023

OSBotify commented May 22, 2023

OSBotify commented May 23, 2023

OSBotify commented May 23, 2023

OSBotify commented May 23, 2023

youssef-lr commented Apr 13, 2023 •

edited

Loading

youssef-lr commented May 16, 2023 •

edited

Loading

eVoloshchak commented May 17, 2023 •

edited

Loading