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

[Avatars] Revert PR #50557 If two avatars, use Name 1 & Name 2 pattern. #50697

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

grgia
Copy link
Contributor

@grgia grgia commented Oct 14, 2024

This PR reverts the changes from PR #50557

Original PR - #50341

Uses Manager Icon instead of Owner icon for report headers to match the expense preview logic.
Match the number of icons shown to the report preview.

Working on Fixing these cases:
#50553
#50547

Details

Fixed Issues

$ #49956
$ #50547
$ #50553

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • Verify that no errors appear in the JS console

  • Create or locate a report preview that displays two avatars

  • ✅ Verify that both names are displayed in Name 1 & Name 2 Format

  • Create or locate a report preview that displays a single avatar

  • ✅ Verify that single name is displayed i.e. Name 1

  • Open in Android and IOS

  • ✅ Verify that both names fit

  • Change both names to be very long

  • ✅ Verify that both names use ... pattern

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

…-heading"

This reverts commit b70ad57, reversing
changes made to ab5175c.
@grgia grgia requested a review from a team as a code owner October 14, 2024 03:47
@grgia grgia self-assigned this Oct 14, 2024
@melvin-bot melvin-bot bot requested review from blimpich and removed request for a team October 14, 2024 03:48
Copy link

melvin-bot bot commented Oct 14, 2024

@blimpich 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]

@grgia grgia changed the title Revert PR #50557 [WIP] Revert PR #50557 Oct 14, 2024
@grgia grgia changed the title [WIP] Revert PR #50557 [WIP] Revert PR #50557 - Avatar Header for 2 Avatars using Name 1 & Name 2 Oct 14, 2024
@grgia grgia requested a review from eh2077 October 14, 2024 05:42
@grgia
Copy link
Contributor Author

grgia commented Oct 14, 2024

Triggering a test build

This comment has been minimized.

@eh2077
Copy link
Contributor

eh2077 commented Oct 14, 2024

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari image image image image
MacOS: Chrome / Safari image image
MacOS: Desktop

@eh2077
Copy link
Contributor

eh2077 commented Oct 14, 2024

Screenshot 2024-10-14 at 9 17 32 PM

@grgia According to #49036 (comment), I think we should show Name 1.

At the meantime, the avatar should also be single right? As it's the case of DM: All requests are from a single user. I'm sorry this should be caught in the previous PR.

@eh2077
Copy link
Contributor

eh2077 commented Oct 14, 2024

Just to confirm, we'll handle Workspace: Report with 2+ expenses separately right?

Screenshot 2024-10-14 at 9 34 04 PM

@grgia
Copy link
Contributor Author

grgia commented Oct 15, 2024

@eh2077 I agree with those, but this PR doesn't update which avatars are displayed, it mainly shows both names if both avatars are present. Should we tackle the single expense avatar case in a separate PR or do you think that would cause a revert

@grgia
Copy link
Contributor Author

grgia commented Oct 15, 2024

@eh2077 I tested locally with #50424 and it looks good

@grgia
Copy link
Contributor Author

grgia commented Oct 15, 2024

I also updated the logic to only show one icon for those cases for now

@grgia grgia changed the title [WIP] Revert PR #50557 - Avatar Header for 2 Avatars using Name 1 & Name 2 [Avatars] Revert PR #50557 If two avatars, use Name 1 & Name 2 pattern. Oct 15, 2024
Copy link
Contributor

@eh2077
Copy link
Contributor

eh2077 commented Oct 15, 2024

@grgia Let's say, user Eric submits an expense to [email protected], the sender of the report preview should be Eric right?

Screenshot 2024-10-15 at 8 27 58 PM

@@ -2371,7 +2371,7 @@ function getIcons(

// For one transaction IOUs, display a simplified report icon
if (isOneTransactionReport(report?.reportID ?? '-1')) {
return [ownerIcon];
return [managerIcon];
Copy link
Contributor

Choose a reason for hiding this comment

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

Just to confirm - this change fixes the header avatar of Report expense page right?

Screenshot 2024-10-15 at 8 34 22 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This should match the IOU case. For IOUs we use managerIcon, for expense reports, ownerIcon

@eh2077
Copy link
Contributor

eh2077 commented Oct 23, 2024

@grgia Please take a moment to look into this when you're free. Thanks!

@grgia
Copy link
Contributor Author

grgia commented Oct 28, 2024

@eh2077 could you let me know if there's anything specific blocking this PR

@eh2077
Copy link
Contributor

eh2077 commented Oct 29, 2024

@grgia Let's say, user Eric submits an expense to [email protected], the sender of the report preview should be Eric right?

Screenshot 2024-10-15 at 8 27 58 PM

@grgia Should we fix this? Please also help resolve the conflicts.

@grgia
Copy link
Contributor Author

grgia commented Oct 30, 2024

@eh2077 I merged another PR into this one

@grgia
Copy link
Contributor Author

grgia commented Oct 30, 2024

I'll take a look at your comment, will also trigger a new build

@grgia
Copy link
Contributor Author

grgia commented Oct 30, 2024

Let's say, user Eric submits an expense to [email protected], the sender of the report preview should be Eric right?

@eh2077 okay I've caught up-

the answer is yes, but right now there's not a good way to do this for IOUs since the "pay someone" case flips the owner of the report. I fixed things for expense reports since there's no "pay workspace" option but didn't touch IOUs here

Rather than fixing that, I'm just trying to display two names if there are two avatars for this PR. Does that make sense?

@grgia
Copy link
Contributor Author

grgia commented Oct 30, 2024

triggered a new test build...

Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
❌ FAILED ❌ https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/50697/index.html
The QR code can't be generated, because the android build failed iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/50697/NewExpensify.dmg https://50697.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@eh2077
Copy link
Contributor

eh2077 commented Oct 30, 2024

@grgia I tested again and confirmed that the icon is working as expected. The following example - User A submitted an expense to Eric Han. From both ends of them, the sender icon is User A, which is expected. But now I found that the owes text seems wrong. The staging has the same issue and I also agree we don't touch IOU here, so I think it can be handled separately.

Screenshot 2024-10-30 at 8 50 57 PM image

The expected behaviour should be
image

@eh2077
Copy link
Contributor

eh2077 commented Nov 7, 2024

@grgia Please take a look at the comments when you get a chance, thank you

@grgia
Copy link
Contributor Author

grgia commented Nov 12, 2024

Going to take a look at these comments, thanks @eh2077

@grgia grgia requested a review from eh2077 November 12, 2024 13:00
@eh2077
Copy link
Contributor

eh2077 commented Nov 12, 2024

It's the end of the day for me, so I'll get to this tomorrow.

@eh2077
Copy link
Contributor

eh2077 commented Nov 13, 2024

@grgia Long user name overflow in iOS app.

image image

@grgia
Copy link
Contributor Author

grgia commented Nov 14, 2024

Thanks for testing @eh2077, I'll push a fix

@eh2077
Copy link
Contributor

eh2077 commented Nov 15, 2024

@grgia I pulled the latest changes and there's still text overflow in iOS app
image

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

Successfully merging this pull request may close these issues.

2 participants