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

Update Avatar Patterns for LHN #20512

Merged
merged 48 commits into from
Jul 7, 2023
Merged

Update Avatar Patterns for LHN #20512

merged 48 commits into from
Jul 7, 2023

Conversation

grgia
Copy link
Contributor

@grgia grgia commented Jun 9, 2023

Details

Remove the text pill, and update all avatar patterns to match:

image

image

Fixed Issues

$ #19264
$ https://github.com/Expensify/Expensify/issues/290271
#20486

Tests

  • Verify that no errors appear in the JS console

For each of the following chat types:

  • Ensure that the report avatar style matches the following photo.
  • Ensure that the report avatar is consistent in LHN, Header, and Search
  • Ensure Tooltips are correct
  • Ensure Tests pass with an account with a custom avatar.

Definitions for this QA

  • Subscript Avatar (2): Avatar Style with one large avatar, and one small avatar in the bottom right corner. (1) is the large main avatar and (2) is the bottom right.
    imageimage

  • Multiple Avatar (2): Avatar style with two avatars overlayed diagonally. (1) is the top left and (2) is the bottom right.
    imageimage

  • Single Avatar: Avatar style with single avatar
    imageimage

  • Workspace Chat - Create a workspace -> add a member

    • Type: Subscript Avatar (2)
    • (1) Workspace
    • (2) Member
    • Size: 40x20px
  • Expense Report

    • Type: Multiple Avatar (2)
    • (1) Member
    • (2) Workspace
    • Size: 24x24px
  • IOU Report - Create a $$ request in a DM

    • Type: Multiple Avatar (2)
    • (1) / (2) Payer / Payee
    • Size: 24x24px
  • Expense Request - Create a $$ request in a workspace chat, open the created request

    • Type: Subscript Avatar (2)
    • (1) Member
    • (2) Workspace
    • (1) Size: 32x32px
    • (2) Size: 20x20px
  • Thread (DM) - Create a thread in a DM

    • Type: Single Avatar
    • (1) Actor
  • Thread (Workspace) - Create a thread in a Workspace

    • Type: Subscript Avatar (2)
    • (1) Member
    • (2) Workspace
    • (1) Size: 40x40px
    • (2) Size: 20x20px
  • Group Chat - Create a group chat

    • Type: Multiple Avatar (2)
    • (1) / (2) Members (or member + number)
  • Rooms - create a workspace, note all room types. Create a custom room.

    • Type: Single Avatar
    • (1) Workspace Style
    • If domain room, should follow default workspace pattern with first letter of domain name.
  • Task (DM)

    • Type: Single Avatar
    • (1) Task Creator
  • Task (Workspace)

    • Type: Subscript Avatar (2)
    • (1) Task Creator
    • (2) Workspace

TO TEST COPILOT: follow these steps from #21246:

  • In www.expensify.com, login as a copilot for a policy admin
  • Go to a policy disable and enable some categories on behalf of the admin as copilot while in copilot mode
  • Go to new.expensify.com
  • Go to the #admins chat room for that same policy
  • Verify that the actions taken by the copilot show as from them, with their avatar, and the other user is referenced in a parenthetical (as copilot for XXXX)

Offline tests

QA Steps

Same as Tests

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 image image image
Mobile Web - Chrome image
Mobile Web - Safari image
Desktop image
iOS image
Android image

@grgia grgia self-assigned this Jun 9, 2023
@grgia

This comment was marked as outdated.

src/libs/ReportUtils.js Outdated Show resolved Hide resolved
@grgia grgia marked this pull request as ready for review June 12, 2023 14:20
@grgia grgia requested a review from a team as a code owner June 12, 2023 14:20
@grgia grgia requested a review from chiragsalian June 12, 2023 14:21
@melvin-bot melvin-bot bot requested review from 0xmiros and srikarparsi and removed request for a team June 12, 2023 14:21
@melvin-bot
Copy link

melvin-bot bot commented Jun 12, 2023

@0xmiroslav @srikarparsi 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]

Copy link
Contributor

@chiragsalian chiragsalian left a comment

Choose a reason for hiding this comment

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

haven't tested. main concern was just with a variable name but the rest looks good to me.

src/CONST.js Outdated Show resolved Hide resolved
src/styles/variables.js Outdated Show resolved Hide resolved
src/libs/ReportUtils.js Outdated Show resolved Hide resolved
@grgia grgia requested a review from chiragsalian June 15, 2023 09:13
@grgia
Copy link
Contributor Author

grgia commented Jul 7, 2023

Fixed merge conflicts, @0xmiroslav let's try to get this merged today?

@grgia
Copy link
Contributor Author

grgia commented Jul 7, 2023

@0xmiroslav bump on final review if possible

@0xmiros
Copy link
Contributor

0xmiros commented Jul 7, 2023

on it now

@0xmiros
Copy link
Contributor

0xmiros commented Jul 7, 2023

DM
IOU report
IOU request
DM thread
DM task
DM task thread
DM group
DM group task

Screen.Recording.2023-07-07.at.5.03.15.PM.mov

My workspace (no avatar)
Expense report
Expense request
My workspace (avatar)
Workspace thread

Screen.Recording.2023-07-07.at.5.05.09.PM.mov

Other workspace (no avatar)
Workspace task
Workspace subtask
Expense report
Expense request

Screen.Recording.2023-07-07.at.5.08.03.PM.mov

Copy link
Contributor

@0xmiros 0xmiros left a comment

Choose a reason for hiding this comment

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

Done full test

@melvin-bot melvin-bot bot requested a review from PauloGasparSv July 7, 2023 15:16
@melvin-bot
Copy link

melvin-bot bot commented Jul 7, 2023

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

@PauloGasparSv
Copy link
Contributor

Sorry, I'm still focusing and won't review this

@PauloGasparSv PauloGasparSv removed their request for review July 7, 2023 15:17
@0xmiros
Copy link
Contributor

0xmiros commented Jul 7, 2023

Also confirmed that this bug is fixed and was able to test all subscript avatars, either default avatar or user custom avatar.

@0xmiros
Copy link
Contributor

0xmiros commented Jul 7, 2023

As a follow-up, we can deprecate all these old icons:

  • AdminRoomAvatar
  • AnnounceRoomAvatar
  • DomainRoomAvatar
  • ActiveRoomAvatar (also remove usage from storybook)
  • DeletedRoomAvatar

Copy link
Contributor

@chiragsalian chiragsalian left a comment

Choose a reason for hiding this comment

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

LGTM

@chiragsalian chiragsalian merged commit 89a5759 into main Jul 7, 2023
11 checks passed
@chiragsalian chiragsalian deleted the georgia-updateAvatars branch July 7, 2023 17:58
@OSBotify
Copy link
Contributor

OSBotify commented Jul 7, 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.

@daordonez11
Copy link
Contributor

Hey guys this PR rolled back #21099 The default params can still be used in the first if, practically just copying the implementation of this PR. With the new refactor only "defaultAccountID" would be required.

cc @chiragsalian @grgia

Copy link
Contributor

@0xmiros 0xmiros left a comment

Choose a reason for hiding this comment

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

Oh, I thought I submitted this already.

Comment on lines -723 to -725
result.source = defaultIcon || Expensicons.FallbackAvatar;
result.name = defaultName || '';
result.id = defaultAccountID;
Copy link
Contributor

Choose a reason for hiding this comment

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

This was accidentally reverted while fixing conflict.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.3.39-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.39-11 🚀

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