Generate Workspace Avatar Color based on PolicyID instead of Workspace Name #39637

nkdengineer · 2024-04-04T18:34:32Z

Details

Fixed Issues

$ #39478
PROPOSAL: #39478 (comment)

Tests

Open Workspace setting
Change workspace name
Verify that: Workspace icon don't change color

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open Workspace setting
Change workspace name
Verify that: Workspace icon don't change color

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

Android: mWeb Chrome

android-mweb.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-mweb.mov

MacOS: Chrome / Safari

web-resize.mp4

MacOS: Desktop

desktop-resize.mp4

…kspace Name

melvin-bot · 2024-04-04T18:44:48Z

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

shawnborton · 2024-04-04T19:08:00Z

Looks good from a design standpoint.

dannymcclain · 2024-04-04T19:09:45Z

Looks good from a design standpoint.

Dangit Shawn you beat me by ONE minute! 😂

nkdengineer · 2024-04-09T03:40:52Z

@rushatgabhane friendly bump

rushatgabhane · 2024-04-10T16:17:55Z

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

Screen.Recording.2024-04-15.at.21.56.33.mov

Android: mWeb Chrome

iOS: Native

https://github.com/Expensify/App/assets/29673073/68618c7f-2136-4ad9-962b-b25f791b6f12

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-04-11.at.04.31.46.mov

Screen.Recording.2024-04-15.at.21.50.34.mov

MacOS: Desktop

Screen.Recording.2024-04-11.at.04.30.00.mov

rushatgabhane

@nkdengineer bug: the workspace switcher has same color for all workspaces

On top left in LHN, click the Expensify icon to open workspace picker

rushatgabhane · 2024-04-13T15:49:02Z

@nkdengineer how's it looking?

nkdengineer · 2024-04-15T16:11:25Z

@rushatgabhane please check again

rushatgabhane

LGTM

grgia

Minor questions

grgia · 2024-04-16T08:17:11Z

src/components/Avatar.tsx

+    /** ID of the Icon */
+    iconID?: number | string;


Suggested change

/** ID of the Icon */

iconID?: number | string;

/** ID of the Icon */

policyID?: number | string;

Or are we passing the accountID otherwise?

@grgia i updated, please check again

grgia · 2024-04-16T08:17:26Z

src/components/Avatar.tsx

@@ -49,6 +49,9 @@ type AvatarProps = {

    /** Owner of the avatar. If user, displayName. If workspace, policy name */
    name?: string;


Is this used anywhere now?

Oh I guess the first letter

grgia

Code LGTM!

grgia · 2024-04-19T12:47:20Z

Running a test build to do a quick QA

nkdengineer · 2024-04-19T15:27:24Z

@grgia Updated to fix this case.

grgia · 2024-04-24T12:33:19Z

@nkdengineer could you merge main?

grgia · 2024-04-24T12:33:27Z

Apologies for the delay

nkdengineer · 2024-04-25T01:32:17Z

@grgia I merged.

github-actions · 2024-04-25T13:25: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/39637/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/39637/index.html

Desktop 💻	Web 🕸️
❌ FAILED ❌	https://39637.pr-testing.expensify.com
The QR code can't be generated, because the Desktop build failed

👀 View the workflow run that generated this build 👀

grgia · 2024-04-29T11:47:12Z

@nkdengineer sorry one last merge main, please ping me!

nkdengineer · 2024-04-29T15:22:23Z

@grgia Merged main.

grgia

LGTM

OSBotify · 2024-05-01T03:01:13Z

🚀 Deployed to staging by https://github.com/grgia in version: 1.4.69-0 🚀

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

MonilBhavsar · 2024-05-01T11:00:28Z

@nkdengineer @grgia we have a regression from this PR #41385
Can anyone please take a look

shawnborton · 2024-05-01T12:07:12Z

I also noticed a few buggies.

Looks like the header is using a different color as the report preview, but it seems related to the regression above:

OSBotify · 2024-05-02T13:04:48Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.69-2 🚀

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

nkdengineer added 2 commits April 4, 2024 18:55

fix: Generate Workspace Avatar Color based on PolicyID instead of Wor…

18d1650

…kspace Name

change name props Avatar

b793c1c

nkdengineer marked this pull request as ready for review April 4, 2024 18:44

nkdengineer requested review from a team as code owners April 4, 2024 18:44

melvin-bot bot requested review from rushatgabhane and removed request for a team April 4, 2024 18:44

shawnborton requested review from shawnborton and removed request for a team April 4, 2024 19:07

merge main

42ea67d

rushatgabhane suggested changes Apr 10, 2024

View reviewed changes

nkdengineer added 2 commits April 15, 2024 17:47

relsove conflict

7b26731

fix: workspace icon color in workspace switcher

f7d00db

rushatgabhane approved these changes Apr 15, 2024

View reviewed changes

melvin-bot bot requested a review from grgia April 15, 2024 16:27

fix typescript

c4ec0f7

grgia reviewed Apr 16, 2024

View reviewed changes

nkdengineer added 3 commits April 17, 2024 11:44

resolve conflict

6a9620c

rename props Avatar

1044bad

resolve conflict

13b99de

grgia previously approved these changes Apr 19, 2024

View reviewed changes

grgia added the Ready To Build label Apr 19, 2024

nkdengineer dismissed grgia’s stale review via 4852a4e April 19, 2024 15:27

resolve conflict

56ef39e

nkdengineer added 5 commits April 25, 2024 01:33

Merge branch 'main' into fix/39478

022d43e

merge main

cec14bc

fix lint

db79f8e

fix typescript check

0ea1fb2

fix ts check

5948500

merge main

0629655

grgia approved these changes Apr 30, 2024

View reviewed changes

grgia merged commit dac5dfd into Expensify:main Apr 30, 2024

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

Deploy Checklist: New Expensify 2024-05-01 #41376

Closed

59 tasks

MonilBhavsar mentioned this pull request May 1, 2024

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

Closed

6 tasks

Nodebrute mentioned this pull request May 2, 2024

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

Closed

ahmedGaber93 mentioned this pull request May 2, 2024

fix: regressions related to workspace avatars #41485

Merged

50 tasks

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

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

Closed

This was referenced May 9, 2024

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

Closed

[HOLD for payment 2024-07-30][Simplified Collect] Workspaces - Display picture/Avatar isn't shown in Workspace share Code page #27288

Closed

Kicu mentioned this pull request May 17, 2024

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

Merged

49 tasks

Kicu mentioned this pull request Jun 10, 2024

Make <Avatar> related code more consistent #43366

Merged

49 tasks

		@@ -49,6 +49,9 @@ type AvatarProps = {

		/** Owner of the avatar. If user, displayName. If workspace, policy name */
		name?: string;

Generate Workspace Avatar Color based on PolicyID instead of Workspace Name #39637

Generate Workspace Avatar Color based on PolicyID instead of Workspace Name #39637

Uh oh!

Conversation

nkdengineer commented Apr 4, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Apr 4, 2024

Uh oh!

shawnborton commented Apr 4, 2024

Uh oh!

dannymcclain commented Apr 4, 2024

Uh oh!

nkdengineer commented Apr 9, 2024

Uh oh!

rushatgabhane commented Apr 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

rushatgabhane left a comment

Choose a reason for hiding this comment

Uh oh!

rushatgabhane commented Apr 13, 2024

Uh oh!

nkdengineer commented Apr 15, 2024

Uh oh!

rushatgabhane left a comment

Choose a reason for hiding this comment

Uh oh!

grgia left a comment

Choose a reason for hiding this comment

Uh oh!

grgia Apr 16, 2024

Choose a reason for hiding this comment

Uh oh!

grgia Apr 16, 2024

Choose a reason for hiding this comment

Uh oh!

nkdengineer Apr 17, 2024

Choose a reason for hiding this comment

Uh oh!

grgia Apr 16, 2024

Choose a reason for hiding this comment

Uh oh!

grgia Apr 16, 2024

Choose a reason for hiding this comment

Uh oh!

grgia left a comment

Choose a reason for hiding this comment

Uh oh!

grgia commented Apr 19, 2024

Uh oh!

nkdengineer commented Apr 19, 2024

Uh oh!

grgia commented Apr 24, 2024

Uh oh!

grgia commented Apr 24, 2024

Uh oh!

nkdengineer commented Apr 25, 2024

Uh oh!

github-actions bot commented Apr 25, 2024

Uh oh!

grgia commented Apr 29, 2024

Uh oh!

nkdengineer commented Apr 29, 2024

Uh oh!

grgia left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented May 1, 2024

Uh oh!

MonilBhavsar commented May 1, 2024

Uh oh!

rushatgabhane commented Apr 10, 2024 •

edited

Loading