Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sort group member avatar icons correctly to avoid avatar rearranging upon receiving backend response #25416

Merged
merged 8 commits into from
Sep 22, 2023

Conversation

honnamkuan
Copy link
Contributor

@honnamkuan honnamkuan commented Aug 17, 2023

Details

sort group member avatar icons correctly using displayName/login, then sub-sort with accountID to avoid avatar rearranging upon receiving backend response

Fixed Issues

$ #23364
PROPOSAL: #23364 (comment)

Tests

  1. Click on FAB > New Group
  2. Create a new group with several members
  3. Validate that when group get created, the member avatars are sorted by their display name / login, and the avatars does not get rearranged and remain in the same positions
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

  1. Click on FAB > New Group
  2. Create a new group with several members
  3. Validate that when group get created, the member avatars are sorted by their display name / login, and the avatars does not get rearranged and remain in the same positions
  • Verify that no errors appear in the JS console

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 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
      • 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • 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
Screen.Recording.2023-08-24.at.5.42.48.PM.mov
Mobile Web - Chrome
Screen.Recording.2023-08-24.at.5.55.08.PM.mov
Mobile Web - Safari
Screen.Recording.2023-08-24.at.6.05.28.PM.mov
Desktop
Screen.Recording.2023-08-24.at.6.07.25.PM.mov
iOS
Screen.Recording.2023-08-24.at.6.02.32.PM.mov
Android
Screen.Recording.2023-08-24.at.5.47.23.PM.mov

@honnamkuan honnamkuan requested a review from a team as a code owner August 17, 2023 15:53
@melvin-bot melvin-bot bot requested review from mananjadhav and removed request for a team August 17, 2023 15:53
@melvin-bot
Copy link

melvin-bot bot commented Aug 17, 2023

@mananjadhav Please 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]

Comment on lines 879 to 890
// if that still clashes, sub-sort by accountID (position 0 element in array)
const sortedParticipantDetails = _.chain(participantDetails)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@honnamkuan Can you confirm if chaining the sortBy won't have side effects? Also quick question, would it make sense to use this instead?

const sortedParticipantDetails = _.orderBy(participantDetails, [2, 1, 0]);

let me know your thoughts.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mananjadhav thanks for the feedbacks!
I definitely agree that _.orderBy(participantDetails, [2, 1, 0]); would looks cleaner, however _.orderBy is actually part of the Lodash utility function, it is not available within Underscore.js which Expensify App uses.

To confirm that, I tried out using orderBy and verified that I am getting Uncaught TypeError: underscore__WEBPACK_IMPORTED_MODULE_2__.default.orderBy is not a function in the console

Underscore sortBy produce stable sorted copy of array, hence no unintended side effects and can safely be included in chained processing.
I can confirm that chaining sortBy is working well, and the approach is also recommended in various SO threads when it comes to sorting using on multiple sub-elements/attributes
e.g. https://stackoverflow.com/a/35612266

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@honnamkuan Expensify App uses lodash.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mananjadhav you are right that Expensify App uses the lodash package.
However the contributing guides STYLE.md says

We have standardized on using underscore.js methods for objects and collections

Therefore, all _ imports in the project are coming from import _ from 'underscore';
e.g.

import _ from 'underscore';

Having said that, I am happy to change it to use lodash orderBy if you think that is the better approach here, your advice will be much appreciated.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No. Thanks this works. I just went through the SO thread. I will test this shortly.

Copy link
Collaborator

@mananjadhav mananjadhav left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code changes look good to me.

@melvin-bot melvin-bot bot requested a review from cead22 August 18, 2023 04:23
@mananjadhav
Copy link
Collaborator

mananjadhav commented Aug 18, 2023

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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • 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
web-group-avatar-order.mov
Mobile Web - Chrome
mweb-chrome-group-avatar-order.mov
Mobile Web - Safari
mweb-safari-group-avatar-order.mov
Desktop
desktop-group-avatar-order.mov
iOS
ios-group-avatar.mov
Android
android-group-avatar-order.mov

@mananjadhav
Copy link
Collaborator

Stuck on Android build.

@mananjadhav
Copy link
Collaborator

@cead22 Reviewed this. I had issues with the Android build.

🎀 👀 🎀 C+ reviewed.

@honnamkuan
Copy link
Contributor Author

@cead22 appreciate your review on this. Thanks

@honnamkuan
Copy link
Contributor Author

@mananjadhav I noticed the Reviewer Checklist doesn’t have “Android / native” checked although you have attached test video for it.
Wondering if that need to be updated to checked?

@mananjadhav
Copy link
Collaborator

I thought I had marked this explicitly. I don't know how this got missed.

cc - @cead22

@cead22 cead22 changed the title sort group member avatar icons correctly to avoid avatar rearranging upon receiving backend response Sort group member avatar icons correctly to avoid avatar rearranging upon receiving backend response Aug 23, 2023
Copy link
Contributor

@cead22 cead22 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code looks good, but I think it's inefficient because it'll go over the array of participants 3 times every time, so I think we should update it to only go over the array once

Also, can you add a unit test for getIconsForParticipants?

@honnamkuan
Copy link
Contributor Author

@cead22 Sure, I will update the PR and add unit test for the function

lodashGet(personalDetails, [accountID, 'firstName'], ''),
avatarSource,
]);
participantDetails.push([accountID, lodashGet(personalDetails, [accountID, 'displayName']) || lodashGet(personalDetails, [accountID, 'login'], ''), avatarSource]);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Upon reviewing this again, I found that the original firstName element (index 2) is only used for sorting.

The thing is, when a user has firstName configured, his displayName/login is going to be a string that starts with his firstName.

e.g.

firstName: 'Lagertha',
displayName: 'Lagertha Lothbrok',
lastName: 'Lothbrok'

So it is actually redundant to first sort using firstName, then sub-sort using displayName/login.
Because we will get the exact same results if we just skip sorting using firstName, and start initial sorting using displayName/login.

With that reasoning, I have updated the code to remove firstName element from the array, because not using it for sorting means we do not need it at all.


// Now that things are sorted, gather only the avatars (third element in the array) and return those
const avatars = [];
for (let i = 0; i < sortedParticipantDetails.length; i++) {
const userIcon = {
id: sortedParticipantDetails[i][0],
source: sortedParticipantDetails[i][3],
source: sortedParticipantDetails[i][2],
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated from index 3 to 2 for avatar source, because the original index 2 element (firstName) is deemed unnecessary and removed.

@honnamkuan
Copy link
Contributor Author

Updated the PR, there are some changes made to sort more efficiently, and just perform the sorting using displayName/login and accountID, removing the initial sorting using firstName as that is found to be redundant, more details in the code inline #25416 (comment).

Also add unit tests to validate the results.

I will execute UI verification tests again and update Screenshots/Videos above

@cead22
Copy link
Contributor

cead22 commented Aug 24, 2023

@mananjadhav can you please re-review and merge if it all looks good? Thanks!

@honnamkuan
Copy link
Contributor Author

honnamkuan commented Aug 24, 2023

Merged latest from main branch, rerun tests on all platforms, verified everything works well and updated Screenshots/Videos test evidences.

@mananjadhav all yours to review and merge. Thanks.

@honnamkuan
Copy link
Contributor Author

@mananjadhav can we get the PR reviewed and merged soon?

Copy link
Collaborator

@mananjadhav mananjadhav left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code change looks good to me.

@mananjadhav
Copy link
Collaborator

Quick bump @cead22, but I am not sure if this is important enough to be merged during the merge-freeze.

@cead22
Copy link
Contributor

cead22 commented Sep 6, 2023

Sorry I was OOO last week, let me do another review and confirm whether we should hold this for the feature freeze

@cead22 cead22 changed the title Sort group member avatar icons correctly to avoid avatar rearranging upon receiving backend response [HOLD] Sort group member avatar icons correctly to avoid avatar rearranging upon receiving backend response Sep 6, 2023
cead22
cead22 previously approved these changes Sep 6, 2023
Copy link
Contributor

@cead22 cead22 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving so it's ready to merge, but holding due to feature freeze (slack thread)

@mananjadhav
Copy link
Collaborator

@honnamkuan Can you merge the latest main?

@honnamkuan
Copy link
Contributor Author

@mananjadhav unfortunately I am currently abroad and have no access to my laptop and commit signing key. Tried merge latest earlier but the checks didn’t pass due to signed commit verification, so I have reverted that.

I see the PR is mergeable without conflict now, if merge latest main is needed then I will only be able to do next Thursday.

@mananjadhav
Copy link
Collaborator

@cead22 I've checked with the latest main locally and it works as expected. @cead22 do you want to wait until we merge the latest main? or we can merge it right now?

@cead22 cead22 changed the title [HOLD] Sort group member avatar icons correctly to avoid avatar rearranging upon receiving backend response Sort group member avatar icons correctly to avoid avatar rearranging upon receiving backend response Sep 18, 2023
Copy link
Contributor

@cead22 cead22 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for testing with the latest main locally, I think we can merge, but let's make this small change to make the code more readable before merging

lodashGet(personalDetails, [accountID, 'firstName'], ''),
avatarSource,
]);
participantDetails.push([accountID, lodashGet(personalDetails, [accountID, 'displayName']) || lodashGet(personalDetails, [accountID, 'login'], ''), avatarSource]);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's make this a little more readable by pulling lodashGet(personalDetails, [accountID, 'displayName']) || lodashGet(personalDetails, [accountID, 'login'], '') into its own variable like we're doing with avatarSource

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedbacks, I am back :)
Have added the const refactoring and merge latest main to my branch, done some testing and verified codes work well.

Appreciate your review again.

@mananjadhav
Copy link
Collaborator

Tested again, works okay. @cead22 All yours.

@cead22 cead22 merged commit f2405de into Expensify:main Sep 22, 2023
12 checks passed
@OSBotify
Copy link
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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/cead22 in version: 1.3.73-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/cead22 in version: 1.3.74-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants