Fix custom workspace avatar border radius is different #24088

bernhardoj · 2023-08-03T04:42:58Z

Details

This is a regression of #23707 where we want to fix the workspace icon border radius. However, we forget to test the case when the workspace avatar is a custom image.

Fixed Issues

$ #24069
$ #23426
PROPOSAL:

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Prerequisite:
a. have more than 4 workspaces
b. the 4th workspace avatar should be a custom image
c. one of the 1st to 3rd workspace avatars should be a custom image

Open Settings
Hover/Long press over the Workspaces menu
Verify the border radius of all the workspace icons and the overlay (+1, +2, etc.) is the same

You can zoom in to notice it easier

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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-08-03T04:43:03Z

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

bernhardoj · 2023-08-03T04:43:47Z

~~Having trouble running the app on Android and iOS. Will add the screenshot once it is working.~~

Solved. Screenshots added!

bernhardoj · 2023-08-03T04:52:51Z

src/components/Avatar.js

-            ? [StyleUtils.getAvatarStyle(props.size), ...props.imageStyles, StyleUtils.getAvatarBorderRadius(props.size, props.type)]
-            : [StyleUtils.getAvatarStyle(props.size), StyleUtils.getAvatarBorderStyle(props.size, props.type)];
+            ? [StyleUtils.getAvatarStyle(props.size), ...props.imageStyles, styles.noBorderRadius]
+            : [StyleUtils.getAvatarStyle(props.size), styles.noBorderRadius];



Explanation of the problem:

In our previous PR, we are removing multiple border radius that is applied on both parent and child view. However, we forget to cover the case where the workspace avatar is a custom image because it is rendered differently.

App/src/components/Avatar.js

Lines 91 to 114 in 2f750ad

{_.isFunction(props.source) || imageError ? (

<View style={iconStyle}>

<Icon

src={imageError ? fallbackAvatar : props.source}

height={iconSize}

width={iconSize}

fill={imageError ? themeColors.offline : iconFillColor}

additionalStyles={[

StyleUtils.getAvatarBorderStyle(props.size, props.type),

isWorkspace ? StyleUtils.getDefaultWorkspaceAvatarColor(props.name) : {},

imageError ? StyleUtils.getBackgroundColorStyle(themeColors.fallbackIconColor) : {},

...props.iconAdditionalStyles,

]}

/>

</View>

) : (

<View style={[iconStyle, StyleUtils.getAvatarBorderStyle(props.size, props.type), ...props.iconAdditionalStyles]}>

<Image

source={{uri: props.source}}

style={imageStyle}

onError={() => setImageError(true)}

/>

</View>

)}

So, in this PR, I removed the border radius from the image style.

The reason StyleUtils.getAvatarBorderStyle(props.size, props.type) is added is because StyleUtils.getAvatarStyle(props.size) set the border-radius value to be the same as the width and height of the avatar. This makes the avatar will always completely rounded, which is wrong for workspace avatar.

Actually, I found that we have a previous commit that is trying to remove the redundant border-radius, but because there are lot of changes to the avatar, the redundant border-radius happen again.

bernhardoj · 2023-08-03T05:01:13Z

Additional screenshots:

AvatarWithImagePicker

AvatarWithIndicator

MentionSuggestion

MenuItem

RoomHeaderAvatar

WorkspaceInitialPage

InitialSettingsPage

ReportActionItemSingle, UserDetailsTooltip

ProfilePage

MultipleAvatars, SubscriptAvatar

thesahindia · 2023-08-03T19:11:10Z

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

thesahindia

I couldn't build the app on android. Approving it as it tested well on other platforms and @bernhardoj has already attached the screenshot for android.

bernhardoj · 2023-08-04T04:48:55Z

@thesahindia thanks for the review.

Btw, can we treat this as not a regression? This border issue exists on both default and custom workspace avatars, but in our previous PR, we only handle the default workspace avatar case by fixing the redundant border-radius and removing the background color workaround.

Removing the background color workaround is the reason we can see the gap as shown below.

cc: @danieldoglas

danieldoglas · 2023-08-11T01:10:55Z

@bernhardoj I won't treat this one as a regression because it was not caused by your previous PR, but I'll consider that both should have been fixed in the previous PR so the bounty will stay the same. Is that OK for you?

OSBotify · 2023-08-11T01:15:30Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

bernhardoj · 2023-08-11T02:21:59Z

@danieldoglas yes, that's totally fine. Thanks!

OSBotify · 2023-08-14T20:04:49Z

🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.3.54-0 🚀

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

OSBotify · 2023-08-14T21:05:05Z

🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.3.54-0 🚀

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

OSBotify · 2023-08-17T02:55:41Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.54-13 🚀

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

remove redundant border radius

db1bd76

bernhardoj requested a review from a team as a code owner August 3, 2023 04:42

melvin-bot bot requested review from thesahindia and removed request for a team August 3, 2023 04:43

bernhardoj commented Aug 3, 2023

View reviewed changes

thesahindia approved these changes Aug 3, 2023

View reviewed changes

melvin-bot bot requested a review from danieldoglas August 3, 2023 19:15

danieldoglas approved these changes Aug 11, 2023

View reviewed changes

danieldoglas merged commit 893d943 into Expensify:main Aug 11, 2023
14 of 17 checks passed

danieldoglas mentioned this pull request Aug 11, 2023

[HOLD for payment 2023-08-24] [CHECKLIST TO BE COMPLETED] [$1000] Workspace +N overlay has a smaller border radius than the workspace icon #23426

Closed

6 tasks

OSBotify mentioned this pull request Aug 14, 2023

Deploy Checklist: New Expensify 2023-08-14 #24550

Closed

49 tasks

melvin-bot bot mentioned this pull request Aug 17, 2023

[HOLD for payment 2023-08-24] [$1000] Workspace - The border radius of the workspace icon and the overlay are not the same #24069

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix custom workspace avatar border radius is different #24088

Fix custom workspace avatar border radius is different #24088

bernhardoj commented Aug 3, 2023 •

edited

Loading

melvin-bot bot commented Aug 3, 2023

bernhardoj commented Aug 3, 2023 •

edited

Loading

bernhardoj Aug 3, 2023

bernhardoj Aug 3, 2023

bernhardoj commented Aug 3, 2023

thesahindia commented Aug 3, 2023

thesahindia left a comment

bernhardoj commented Aug 4, 2023

danieldoglas commented Aug 11, 2023

OSBotify commented Aug 11, 2023

bernhardoj commented Aug 11, 2023

OSBotify commented Aug 14, 2023

OSBotify commented Aug 14, 2023

OSBotify commented Aug 17, 2023

	{_.isFunction(props.source) \|\| imageError ? (
	<View style={iconStyle}>
	<Icon
	src={imageError ? fallbackAvatar : props.source}
	height={iconSize}
	width={iconSize}
	fill={imageError ? themeColors.offline : iconFillColor}
	additionalStyles={[
	StyleUtils.getAvatarBorderStyle(props.size, props.type),
	isWorkspace ? StyleUtils.getDefaultWorkspaceAvatarColor(props.name) : {},
	imageError ? StyleUtils.getBackgroundColorStyle(themeColors.fallbackIconColor) : {},
	...props.iconAdditionalStyles,
	]}
	/>
	</View>
	) : (
	<View style={[iconStyle, StyleUtils.getAvatarBorderStyle(props.size, props.type), ...props.iconAdditionalStyles]}>
	<Image
	source={{uri: props.source}}
	style={imageStyle}
	onError={() => setImageError(true)}
	/>
	</View>
	)}

Fix custom workspace avatar border radius is different #24088

Fix custom workspace avatar border radius is different #24088

Conversation

bernhardoj commented Aug 3, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 3, 2023

bernhardoj commented Aug 3, 2023 • edited Loading

bernhardoj Aug 3, 2023

Choose a reason for hiding this comment

bernhardoj Aug 3, 2023

Choose a reason for hiding this comment

bernhardoj commented Aug 3, 2023

thesahindia commented Aug 3, 2023

Reviewer Checklist

Screenshots/Videos

thesahindia left a comment

Choose a reason for hiding this comment

bernhardoj commented Aug 4, 2023

danieldoglas commented Aug 11, 2023

OSBotify commented Aug 11, 2023

bernhardoj commented Aug 11, 2023

OSBotify commented Aug 14, 2023

OSBotify commented Aug 14, 2023

OSBotify commented Aug 17, 2023

bernhardoj commented Aug 3, 2023 •

edited

Loading

bernhardoj commented Aug 3, 2023 •

edited

Loading