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

[No QA] Implement the SubScript avatar for workspace money requests #18085

Merged
merged 15 commits into from
May 2, 2023

Conversation

tgolen
Copy link
Contributor

@tgolen tgolen commented Apr 27, 2023

Sorry, I did a refactoring that ended up being much larger than I had intended when I moved the policy collection to be inside of ReportUtils. That's really going to speed up all those components that no longer are connected to the collection though.

Fixed Issues

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

Tests

  1. Update ReportActionsList.js to set shouldShowSubscriptAvatar={true}
  2. Open a chat with a workspace and send a message
  3. Verify that the avatar shows with the workspace avatar as a subscript (all we're doing here is verify that the subscript avatar is displayed and it's the correct workspace avatar)
  • Verify that no errors appear in the JS console

Offline tests

None

QA Steps

None. This can't be QA'ed yet because there is no way to request money from a workspace at this point.

  • 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
    • 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

2023-04-28_11-18-05

Mobile Web - Chrome

2023-04-28_11-32-56

Mobile Web - Safari

2023-04-28_11-29-30

Desktop

2023-04-28_11-22-57

iOS

2023-04-28_11-28-38

Android

2023-04-28_11-36-33

@tgolen tgolen self-assigned this Apr 27, 2023
@tgolen tgolen marked this pull request as ready for review April 28, 2023 18:16
@tgolen tgolen requested a review from a team as a code owner April 28, 2023 18:16
@tgolen tgolen changed the title Implement the SubScript avatar for workspace money requests [No QA] Implement the SubScript avatar for workspace money requests Apr 28, 2023
@melvin-bot melvin-bot bot requested review from aimane-chnaif and deetergp and removed request for a team April 28, 2023 18:17
@MelvinBot
Copy link

@aimane-chnaif @deetergp 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]

deetergp
deetergp previously approved these changes Apr 28, 2023
@deetergp
Copy link
Contributor

Code looks good and tests well on web.

@aimane-chnaif
Copy link
Contributor

reviewing shortly

@luacmartins luacmartins self-requested a review April 28, 2023 20:17
luacmartins
luacmartins previously approved these changes Apr 29, 2023
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM and tests well! Thanks for the quick work!

@aimane-chnaif
Copy link
Contributor

All look good but 2 things to confirm:

  • Is it correct that subscript avatar should be member's avatar in policy expense 1:1 chat?

web1

  • I think we should show tooltip when hover subscript avatar. This already works on LHN
web3.mov

@luacmartins
Copy link
Contributor

@aimane-chnaif the subscript avatar should only show when requesting money, but that functionality is not yet available so we are hardcoding test steps. As for the tooltip, I agree that we should add it for the workspace avatar

@aimane-chnaif
Copy link
Contributor

the subscript avatar should only show when requesting money

ok so you mean that request money won't available at all in policy expense 1:1 chat?
It seems correct from this condition:

return (!isPolicyExpenseChat(report) || report.isOwnPolicyExpenseChat);

@luacmartins
Copy link
Contributor

ok so you mean that request money won't available at all in policy expense 1:1 chat?

It will be, but the feature is not ready yet.

@tgolen
Copy link
Contributor Author

tgolen commented May 1, 2023

Regarding the tooltip, I can add it, but we weren't using tooltip on the normal <Avatar> in that component either. So, it seems weird to use tooltips on <SubscriptAvatar> but not <Avatar>. I think we should add the tooltips to both or to neither of them, and since they didn't exist previously on <Avatar> I would probably choose to leave them off of <SubscriptAvatar> for now.

@aimane-chnaif
Copy link
Contributor

aimane-chnaif commented May 1, 2023

As SubscriptAvatar already supports tooltip, it makes sense to have structure like this, removing parent Tooltip:

  • if shouldShowSubscriptAvatar = true
                    <SubscriptAvatar
                        mainAvatar={{source: avatarSource, type: CONST.ICON_TYPE_AVATAR}}
                        secondaryAvatar={ReportUtils.getIcons(props.report, {})[0]}
                        mainTooltip={xxx}
                        secondaryTooltip={xxx}
                    />
  • if false
                    <Tooltip text={actorEmail}>
                        <Avatar
                            containerStyles={[styles.actionAvatar]}
                            source={avatarSource}
                        />
                    </Tooltip>

This is how it's done in OptionRowLHN: (MultipleAvatars has Tooltip>Avatar structure)

optionItem.shouldShowSubscript ? (
<SubscriptAvatar
backgroundColor={props.isFocused ? themeColors.activeComponentBG : themeColors.sidebar}
mainAvatar={optionItem.icons[0]}
secondaryAvatar={optionItem.icons[1]}
mainTooltip={optionItem.ownerEmail}
secondaryTooltip={optionItem.subtitle}
size={props.viewMode === CONST.OPTION_MODE.COMPACT ? CONST.AVATAR_SIZE.SMALL : CONST.AVATAR_SIZE.DEFAULT}
/>
) : (
<MultipleAvatars
icons={optionItem.icons}
isFocusMode={props.viewMode === CONST.OPTION_MODE.COMPACT}
size={props.viewMode === CONST.OPTION_MODE.COMPACT ? CONST.AVATAR_SIZE.SMALL : CONST.AVATAR_SIZE.DEFAULT}
secondAvatarStyle={[
StyleUtils.getBackgroundAndBorderStyle(themeColors.sidebar),
props.isFocused
? StyleUtils.getBackgroundAndBorderStyle(focusedBackgroundColor)
: undefined,
hovered && !props.isFocused
? StyleUtils.getBackgroundAndBorderStyle(hoveredBackgroundColor)
: undefined,
]}
avatarTooltips={optionItem.isPolicyExpenseChat ? [optionItem.subtitle] : avatarTooltips}
/>
)

@tgolen
Copy link
Contributor Author

tgolen commented May 1, 2023

Right, Thanks. I'm saying, we should NOT add tooltips because we aren't displaying tooltips here in the first place.

@tgolen
Copy link
Contributor Author

tgolen commented May 1, 2023

because we aren't displaying tooltips here in the first place.

OK, I totally missed that we ARE using tooltips now (I missed the <Tooltip> component because I only looked inside the <OfflineWithFeedback>. So, I'll add the tooltips to the subscript too

@tgolen tgolen dismissed stale reviews from luacmartins and deetergp via de66bd1 May 1, 2023 20:16
@tgolen
Copy link
Contributor Author

tgolen commented May 1, 2023

OK, updated with tooltips:

2023-05-01_14-16-14.mp4

<SubscriptAvatar
mainAvatar={{source: avatarSource, type: CONST.ICON_TYPE_AVATAR}}
secondaryAvatar={ReportUtils.getIcons(props.report, {})[0]}
mainTooltip={props.report.ownerEmail}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
mainTooltip={props.report.ownerEmail}
mainTooltip={actorEmail}

Copy link
Contributor

Choose a reason for hiding this comment

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

Agree that actorEmail is more accurate here (although they might overlap often)

Copy link
Contributor

@aimane-chnaif aimane-chnaif left a comment

Choose a reason for hiding this comment

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

Confirmed from slack discussion that current logic we have in the PR is correct.

@MelvinBot
Copy link

🎯 @aimane-chnaif, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #18260.

@aimane-chnaif
Copy link
Contributor

checklisting shortly

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

One question from me though is that we will also have the transaction edited report action which afaik is also IOU action type, same as deleted are we fine with whose showing the subscript too? I assume yes, but just wanted to ask that.

<SubscriptAvatar
mainAvatar={{source: avatarSource, type: CONST.ICON_TYPE_AVATAR}}
secondaryAvatar={ReportUtils.getIcons(props.report, {})[0]}
mainTooltip={props.report.ownerEmail}
Copy link
Contributor

Choose a reason for hiding this comment

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

Agree that actorEmail is more accurate here (although they might overlap often)

@aimane-chnaif
Copy link
Contributor

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
web.mov
Mobile Web - Chrome mchrome
Mobile Web - Safari msafari
Desktop
desktop.mov
iOS ios
Android android

@luacmartins
Copy link
Contributor

luacmartins commented May 2, 2023

Yes, it seems like all system messages will use this avatar. I think we should add them to this conditional once we introduce them in App.

Screenshot 2023-05-02 at 12 21 45 PM

@luacmartins luacmartins merged commit ac3f3c4 into main May 2, 2023
@luacmartins luacmartins deleted the tgolen-manualrequests-subscriptavatar branch May 2, 2023 10:22
@OSBotify
Copy link
Contributor

OSBotify commented May 2, 2023

✋ 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

OSBotify commented May 3, 2023

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.9-12 🚀

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

Comment on lines +332 to +333
shouldShowSubscriptAvatar={this.props.shouldShowSubscriptAvatar}
report={this.props.report}
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 sure to pass these values in ReportTransaction to show subscript avatar on IOUDetailsModal after we implement money request in workspace chat

<ReportActionItemSingle
action={this.props.action}
wrapperStyles={[styles.reportTransactionWrapper]}
>

cc: @tgolen @luacmartins @mountiny

Copy link
Contributor

Choose a reason for hiding this comment

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

@aimane-chnaif can you submit a screenshot of where you think the SubscriptAvatar should be displayed as well? Just trying to keep things consistent since a lot of these screens will be updated/removed.

Copy link
Contributor

Choose a reason for hiding this comment

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

I can't have correct screenshot as money request is not implement yet in workspace chat.
But this is just example:
Screenshot 2023-05-08 at 12 44 40 PM

Copy link
Contributor

@aimane-chnaif aimane-chnaif May 8, 2023

Choose a reason for hiding this comment

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

Right now, shows console error on this page because report is required prop but not passed

Screenshot 2023-05-08 at 12 46 15 PM

Copy link
Contributor

Choose a reason for hiding this comment

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

Yea, I think that page will be removed since now we'll show the report in ReportScreen and render the reportActions for each of them.

@OSBotify
Copy link
Contributor

OSBotify commented May 9, 2023

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.12-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 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.

7 participants