fix: regressions related to workspace avatars #41485

nkdengineer · 2024-05-02T08:11:15Z

Details

Fixed Issues

$ #41385
#41387
PROPOSAL:

Tests

Go to FAB > Send invoice.
Enter amount and select a participant.
Click on the workspace.
Verify that: Each workspace avatar is displayed correctly.

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to FAB > Send invoice.
Enter amount and select a participant.
Click on the workspace.
Verify that: Each workspace avatar is displayed correctly.

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

android-mweb.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-mweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-05-02T08:23:33Z

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

ahmedGaber93 · 2024-05-02T10:46:14Z

@rushatgabhane this a regression from #39637, I don't think it is needed a new C+.

MonilBhavsar · 2024-05-07T09:05:49Z

src/components/MenuItem.tsx

@@ -259,6 +259,9 @@ type MenuItemBaseProps = {

    /** Handles what to do when the item is focused */
    onFocus?: () => void;
+
+    /** Optional account id if it's user avatar or policy id if it's workspace avatar */
+    accountId?: number | string;


Suggested change

accountId?: number | string;

accountID?: number | string;

rushatgabhane · 2024-05-08T23:05:27Z

we might be doing a revert of original PR - https://expensify.slack.com/archives/C01GTK53T8Q/p1715183132740789

MonilBhavsar · 2024-05-09T06:11:29Z

Thanks for linking this 👍

grgia · 2024-05-09T09:18:17Z

Running a test build

Kicu

Hey, I spent a lot of time with avatar code so I wanted to leave a few comments here.

After the previous PR there is also a bug in this line: https://github.com/Expensify/App/blob/main/src/components/MultipleAvatars.tsx#L147

Because we started to pass also policyID as icon id, and it can be string, then this parsing will generate NaN and Nan gets passed as accountID.
Previously only actual account ids were passed to icons so this didn't happen I believe.
It would be nice to handle this somehow.

Kicu · 2024-05-09T13:30:10Z

src/components/MenuItem.tsx

@@ -334,6 +337,7 @@ function MenuItem(
        isPaneMenu = false,
        shouldPutLeftPaddingWhenNoIcon = false,
        onFocus,
+        accountID = '',


Can you point to me where in the code this will actually be used? because in this PR your not passing accountID anywhere to MenuItem and I would like understand the flow of props better.

Also please don't default to '' - accountID makes no sense with empty value.

Thanks your comment
I missed adding props in MoneyRequestConfirmationList when resolving conflict

Kicu · 2024-05-09T13:45:52Z

src/pages/ReportAvatar.tsx

@@ -35,7 +35,7 @@ function ReportAvatar({report = {} as Report, policies, isLoadingApp = true}: Re
            }}
            isWorkspaceAvatar
            maybeIcon
-            originalFileName={policy?.originalFileName ?? policyName}
+            originalFileName={policy?.originalFileName ?? policy?.id}


Technically this will work, but the prop name is called originalFileName so passing policy.id will confuse people in future.

I added a comment to explain, please check again

Can we add why we need to do this?

// In the case of the default workspace avatar, we will use the policy id that will be originalFileName prop to get the color of the avatar.

@MonilBhavsar I added a comment.

grgia · 2024-05-09T16:00:52Z

please add test for tooltip when visiting a public workspace room on incognito

grgia · 2024-05-09T17:17:20Z

Tested the above case on adhoc, looks good

grgia · 2024-05-09T17:18:41Z

@nkdengineer please fix the multiple avatars/subscript avatar case

grgia

LGTM, but we need to fix the case I commented before me merge

rushatgabhane · 2024-05-13T06:00:19Z

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

MacOS: Chrome / Safari

MacOS: Desktop

MonilBhavsar · 2024-05-13T08:18:57Z

src/components/MenuItem.tsx

+    /** Optional account id if it's user avatar or policy id if it's workspace avatar */
+    accountID?: number | string;


Having a prop with name accountID and holding value of policyID is confusing IMO.
We can either have two props - policyID and accountID and use one that's provided - policyID ?? accountID
Or, we can have a prop avatarID that takes either policyID or accountID.

I think avatarID is fine.

@MonilBhavsar I updated with new prop name

MonilBhavsar · 2024-05-13T08:19:43Z

src/pages/ReportAvatar.tsx

@@ -35,7 +35,7 @@ function ReportAvatar({report = {} as Report, policies, isLoadingApp = true}: Re
            }}
            isWorkspaceAvatar
            maybeIcon
-            originalFileName={policy?.originalFileName ?? policyName}
+            originalFileName={policy?.originalFileName ?? policy?.id}


Can we add why we need to do this?

grgia · 2024-05-13T17:58:04Z

@nkdengineer could you merge main?

nkdengineer · 2024-05-14T02:52:32Z

@grgia please check again

grgia · 2024-05-14T10:21:44Z

@rushatgabhane could you please re-review

grgia · 2024-05-14T10:21:55Z

triggering final test build...

github-actions · 2024-05-14T10:54:02Z

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

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/41485/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/41485/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/41485/NewExpensify.dmg	https://41485.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

grgia

LGTM!

MonilBhavsar

Minor comment edit to explain it in a better way. Looks good overall!

src/pages/ReportAvatar.tsx

Co-authored-by: Monil Bhavsar <monilbhavsar25@gmail.com>

nkdengineer · 2024-05-15T11:39:20Z

@MonilBhavsar I updated.

MonilBhavsar

Thank you!

OSBotify · 2024-05-15T12:09:39Z

✋ 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 · 2024-05-23T00:39:21Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.4.75-0 🚀

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

OSBotify · 2024-05-27T14:02:29Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.75-1 🚀

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

fix: Each workspace avatar in sender list has the same avatar

00dd36f

nkdengineer marked this pull request as ready for review May 2, 2024 08:23

nkdengineer requested a review from a team as a code owner May 2, 2024 08:23

melvin-bot bot requested review from ahmedGaber93 and removed request for a team May 2, 2024 08:23

fix: regression 41387

e8f3568

nkdengineer changed the title ~~fix: Each workspace avatar in sender list has the same avatar~~ fix: regression from 39637 May 2, 2024

remove useless code

89c652b

nkdengineer mentioned this pull request May 5, 2024

[Invoice Rooms] Avatar not matching from InvoiceRoom header to InvoiceRoom invoice preview #41473

Closed

cristipaval requested review from rushatgabhane and removed request for ahmedGaber93 May 6, 2024 12:43

resolve conflict

b3e8557

MonilBhavsar reviewed May 7, 2024

View reviewed changes

sakluger mentioned this pull request May 7, 2024

Workspace - Workspace avatar is different when viewed in full screen mode #41387

Closed

6 tasks

fix: typo

9ca04c6

grgia added the Ready To Build label May 9, 2024

This comment has been minimized.

Sign in to view

Kicu reviewed May 9, 2024

View reviewed changes

Kicu mentioned this pull request May 9, 2024

[HOLD for payment 2024-06-28] Clean up workspace avatars display logic #41912

Closed

Add comment to report avatar

afdc4a0

grgia self-requested a review May 9, 2024 15:32

grgia requested changes May 9, 2024

View reviewed changes

MonilBhavsar changed the title ~~fix: regression from 39637~~ fix: regressions related to workspace avatars May 13, 2024

rushatgabhane approved these changes May 13, 2024

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar May 13, 2024 07:52

MonilBhavsar reviewed May 13, 2024

View reviewed changes

nkdengineer added 2 commits May 13, 2024 15:25

Merge branch 'main' into fix/41385

18c70b4

rename accountID prop to avatarID prop

be0f122

grgia requested review from rushatgabhane and grgia May 13, 2024 17:57

shawnborton mentioned this pull request May 13, 2024

[HOLD for payment 2024-05-09] [$250] Generate Workspace Avatar Color based on PolicyID instead of Workspace Name #39478

Closed

nkdengineer added 2 commits May 14, 2024 09:45

merge main

ce7f3a4

resolve conflict

c911404

Kicu mentioned this pull request May 14, 2024

Use fallback user avatar in cases where the user is unknown to us #41846

Merged

49 tasks

grgia previously approved these changes May 15, 2024

View reviewed changes

MonilBhavsar reviewed May 15, 2024

View reviewed changes

src/pages/ReportAvatar.tsx Outdated Show resolved Hide resolved

Update src/pages/ReportAvatar.tsx

e602e57

Co-authored-by: Monil Bhavsar <monilbhavsar25@gmail.com>

nkdengineer dismissed grgia’s stale review via e602e57 May 15, 2024 11:39

MonilBhavsar approved these changes May 15, 2024

View reviewed changes

MonilBhavsar merged commit 1ee5d03 into Expensify:main May 15, 2024
16 checks passed

github-actions bot mentioned this pull request May 22, 2024

Deploy Checklist: New Expensify 2024-05-22 #42496

Closed

45 tasks

melvin-bot bot mentioned this pull request May 27, 2024

[HOLD for payment 2024-06-03] Send invoice - Each workspace avatar in sender list has the same avatar #41385

Closed

6 tasks

		/** Optional account id if it's user avatar or policy id if it's workspace avatar */
		accountID?: number \| string;

fix: regressions related to workspace avatars #41485

fix: regressions related to workspace avatars #41485

Conversation

nkdengineer commented May 2, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 2, 2024

ahmedGaber93 commented May 2, 2024

Choose a reason for hiding this comment

rushatgabhane commented May 8, 2024

MonilBhavsar commented May 9, 2024

grgia commented May 9, 2024

This comment has been minimized.

Kicu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

grgia commented May 9, 2024

grgia commented May 9, 2024

grgia commented May 9, 2024

grgia left a comment

Choose a reason for hiding this comment

rushatgabhane commented May 13, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

grgia commented May 13, 2024

nkdengineer commented May 14, 2024

grgia commented May 14, 2024

grgia commented May 14, 2024

github-actions bot commented May 14, 2024

grgia left a comment

Choose a reason for hiding this comment

MonilBhavsar left a comment

Choose a reason for hiding this comment

nkdengineer commented May 15, 2024

MonilBhavsar left a comment

Choose a reason for hiding this comment

OSBotify commented May 15, 2024

OSBotify commented May 23, 2024

OSBotify commented May 27, 2024

nkdengineer commented May 2, 2024 •

edited

Loading

rushatgabhane commented May 13, 2024 •

edited

Loading